Feat: Handle hover on second parameter for Python functions accessing…

… the datastore
yoctoproject · Jan 5, 2024 · 323260e · 323260e
1 parent 92accaf
commit 323260e
Show file tree

Hide file tree

Showing 3 changed files with 65 additions and 13 deletions.
diff --git a/server/src/__tests__/fixtures/hover.bb b/server/src/__tests__/fixtures/hover.bb
@@ -33,8 +33,9 @@ include dummy.inc
 require dummy.inc
 
 python (){
-    d.getVar("DESCRIPTION")
+    d.getVar("DESCRIPTION", "DESCRIPTION")
     d.setVar('DESCRIPTION', 'value')
+    d.renameVar("DESCRIPTION", "DESCRIPTION")
     b.getVar('DESCRIPTION')
     d.test('DESCRIPTION')
     d.getVar("FOO")

diff --git a/server/src/__tests__/hover.test.ts b/server/src/__tests__/hover.test.ts
@@ -351,8 +351,8 @@ describe('on hover', () => {
         uri: DUMMY_URI
       },
       position: {
-        line: 40,
-        character: 19
+        line: 37,
+        character: 37
       }
     })
 
@@ -361,8 +361,8 @@ describe('on hover', () => {
         uri: DUMMY_URI
       },
       position: {
-        line: 46,
-        character: 20
+        line: 41,
+        character: 19
       }
     })
 
@@ -371,7 +371,17 @@ describe('on hover', () => {
         uri: DUMMY_URI
       },
       position: {
-        line: 44,
+        line: 47,
+        character: 20
+      }
+    })
+
+    const shouldShow6 = await onHoverHandler({
+      textDocument: {
+        uri: DUMMY_URI
+      },
+      position: {
+        line: 45,
         character: 14
       }
     })
@@ -381,8 +391,8 @@ describe('on hover', () => {
         uri: DUMMY_URI
       },
       position: {
-        line: 37,
-        character: 14
+        line: 35,
+        character: 33
       }
     })
 
@@ -392,7 +402,7 @@ describe('on hover', () => {
       },
       position: {
         line: 38,
-        character: 12
+        character: 14
       }
     })
 
@@ -402,7 +412,7 @@ describe('on hover', () => {
       },
       position: {
         line: 39,
-        character: 19
+        character: 12
       }
     })
 
@@ -411,7 +421,17 @@ describe('on hover', () => {
         uri: DUMMY_URI
       },
       position: {
-        line: 48,
+        line: 40,
+        character: 19
+      }
+    })
+
+    const shouldNotShow5 = await onHoverHandler({
+      textDocument: {
+        uri: DUMMY_URI
+      },
+      position: {
+        line: 49,
         character: 10
       }
     })
@@ -451,10 +471,18 @@ describe('on hover', () => {
       }
     })
 
+    expect(shouldShow6).toEqual({
+      contents: {
+        kind: 'markdown',
+        value: '**DESCRIPTION**\n___\n   A long description for the recipe.\n\n'
+      }
+    })
+
     expect(shouldNotShow1).toBe(null)
     expect(shouldNotShow2).toBe(null)
     expect(shouldNotShow3).toBe(null)
     expect(shouldNotShow4).toBe(null)
+    expect(shouldNotShow5).toBe(null)
   })
 
   it('should show comments above the global declarations', async () => {

diff --git a/server/src/tree-sitter/analyzer.ts b/server/src/tree-sitter/analyzer.ts
@@ -313,8 +313,31 @@ export default class Analyzer {
     if (functionName === undefined || !(bitBakeDocScanner.pythonDatastoreFunction.includes(functionName))) {
       return false
     }
-    const variable = match?.groups?.params?.split(',')[0]?.trim().replace(/('|")/g, '')
-    return variable === n?.text
+
+    // Example for d.getVar('FOO'):
+    // n.text: FOO
+    // n.parent.text: 'FOO'
+    // n.parent.previousSibling.text: (
+    const isFirstParameter = n?.parent?.previousSibling?.text === '('
+    if (isFirstParameter) {
+      const firstParameter = match?.groups?.params?.split(',')[0]?.trim().replace(/('|")/g, '')
+      return firstParameter === n?.text
+    }
+
+    // Example for d.renameVar('FOO', 'BAR'):
+    // n.text: BAR
+    // n.parent.text: 'BAR'
+    // n.parent.previousSibling.text: ,
+    // n.parent.previousSibling.previousSibling.text: 'FOO'
+    // n.parent.previousSibling.previousSibling.previousSibling.text: (
+    const isSecondParameter = n?.parent?.previousSibling?.previousSibling?.previousSibling?.text === '('
+    // d.renameVar is the only function for which the second parameter could be a Yocto defined variable
+    if (functionName === 'renameVar' && isSecondParameter) {
+      const secondParameter = match?.groups?.params?.split(',')[1]?.trim().replace(/('|")/g, '')
+      return secondParameter === n?.text
+    }
+
+    return false
   }
 
   /**