Fix vscode ref issue #1768 (#1769)

* make vscode ctrl+click can handle ref with database and schema * fix linter * remove unnecessary comments
dataform-co · Jul 8, 2024 · b322655 · b322655
1 parent f2f6f88
commit b322655
Show file tree

Hide file tree

Showing 3 changed files with 81 additions and 23 deletions.
diff --git a/vscode/BUILD b/vscode/BUILD
@@ -7,6 +7,7 @@ ts_library(
     srcs = glob(["**/*.ts"]),
     deps = [
         "//cli/api",
+        "//core",
         "//protos:ts",
         "@npm//@types/node",
         "@npm//@types/vscode",

diff --git a/vscode/extension.ts b/vscode/extension.ts
@@ -50,6 +50,9 @@ export async function activate(context: vscode.ExtensionContext) {
   client.onNotification("error", errorMessage => {
     vscode.window.showErrorMessage(errorMessage);
   });
+  client.onNotification("info", message => {
+    vscode.window.showInformationMessage(message);
+  });
   client.onNotification("success", message => {
     vscode.window.showInformationMessage(message);
   });

diff --git a/vscode/server.ts b/vscode/server.ts
@@ -1,4 +1,5 @@
 import { ChildProcess, spawn } from "child_process";
+import { ITarget } from "df/core/common";
 import { dataform } from "df/protos/ts";
 import {
   createConnection,
@@ -124,13 +125,12 @@ async function getProcessResult(childProcess: ChildProcess) {
 function gatherAllActions(
   graph = CACHED_COMPILE_GRAPH
 ): Array<dataform.Table | dataform.Declaration | dataform.Operation | dataform.Assertion> {
-  return [].concat(graph.tables, graph.operations, graph.assertions, graph.declarations);
-}
-
-function retrieveLinkedFileName(ref: string) {
-  const allActions = gatherAllActions();
-  const foundCompileAction = allActions.find(action => action.target.name === ref);
-  return foundCompileAction.fileName;
+  return [].concat(
+    graph.tables ?? [],
+    graph.operations ?? [],
+    graph.assertions ?? [],
+    graph.declarations ?? []
+  );
 }
 
 connection.onDefinition(
@@ -141,28 +141,82 @@ connection.onDefinition(
       end: { line: params.position.line + 1, character: 0 }
     });
 
-    const refRegex = new RegExp(/(?<=ref\(\"|'\s*).*?(?=\s*\"|'\))/g); // tslint:disable-line
+    const refRegex = new RegExp(/ref\s*\(\s*(["'].+?["'])\s*\)/g); // tslint:disable-line
     const refContents = lineWithRef.match(refRegex);
     if (!refContents || refContents.length === 0) {
       return null;
     }
 
-    const minPosition = lineWithRef.search(refRegex);
-    const refStatement = refContents[0];
-    const maxPosition = minPosition + refStatement.length;
-
-    if (params.position.character > minPosition && params.position.character < maxPosition) {
-      // TODO: Make this work for multiple refs in one line
-      const linkedFileName = retrieveLinkedFileName(refContents[0]);
-      const fileString = `${WORKSPACE_ROOT_FOLDER}/${linkedFileName}`;
-      return {
-        uri: fileString,
-        range: {
-          start: { line: 0, character: 0 },
-          end: { line: 1, character: 0 }
-        }
-      } as Location;
+    // if not compiled yet, we cannot jump to the definition
+    if (CACHED_COMPILE_GRAPH === null) {
+      connection.sendNotification("info", "Project not compiled yet. Please compile first.");
+      return null;
     }
+
+    // Jump to the one that was clicked or closest
+    const clickedRef = refContents.map(
+      (refContent) => ({
+        refContent,
+        min: lineWithRef.indexOf(refContent),
+        max: lineWithRef.indexOf(refContent) + refContent.length - 1
+      })
+    ).sort((a, b) => {
+      // sort in priority of closest to the clicked position
+      // if position is within the refContent, distance is 0
+      let distanceToA = 0;
+      if (params.position.character < a.min) {
+        distanceToA = a.min - params.position.character;
+      } else if (params.position.character > a.max) {
+        distanceToA = params.position.character - a.max;
+      }
+
+      let distanceToB = 0;
+      if (params.position.character < b.min) {
+        distanceToB = b.min - params.position.character;
+      } else if (params.position.character > b.max) {
+        distanceToB = params.position.character - b.max;
+      }
+
+      return distanceToA - distanceToB;
+    })[0].refContent;
+
+    // split to dataset, schema and name
+    const linkedTable: ITarget = {database: null, schema: null, name: null};
+    const splitMatch = clickedRef.match(/^ref\s*\(\s*(["'](.+?)["'])\s*(,\s*["'](.+?)["']\s*)?(,\s*["'](.+?)["']\s*)?,?\s*\)$/); // tslint:disable-line
+    if (splitMatch[6] !== undefined) {
+      linkedTable.database = splitMatch[2];
+      linkedTable.schema = splitMatch[4];
+      linkedTable.name = splitMatch[6];
+    } else if (splitMatch[4] !== undefined) {
+      linkedTable.schema = splitMatch[2];
+      linkedTable.name = splitMatch[4];
+    } else if (splitMatch[2] !== undefined) {
+      linkedTable.name = splitMatch[2];
+    } else {
+      return null;
+    }
+
+    const foundCompileAction = gatherAllActions().filter(action => (
+      (linkedTable.database === null || action?.target?.database !== undefined && action.target.database === linkedTable.database)
+      && (linkedTable.schema === null || action?.target?.schema !== undefined && action.target.schema === linkedTable.schema)
+      && action?.target?.name !== undefined && action.target.name === linkedTable.name
+    ));
+    if (foundCompileAction.length === 0) {
+      connection.sendNotification("error", `Definition not found for ${clickedRef}`);
+      return null;
+    } else if (foundCompileAction.length > 1) {
+      connection.sendNotification("error", `Multiple definitions found for ${clickedRef}`);
+      return null;
+    }
+
+    const fileString = `${WORKSPACE_ROOT_FOLDER}/${foundCompileAction[0].fileName}`;
+    return {
+      uri: fileString,
+      range: {
+        start: { line: 0, character: 0 },
+        end: { line: 1, character: 0 }
+      }
+    } as Location;
   }
 );