From e80f1757320592e812b040c4e312988da40f6164 Mon Sep 17 00:00:00 2001
From: Mark Wiemer <7833360+mark-wiemer@users.noreply.github.com>
Date: Thu, 7 Nov 2024 18:58:15 -0800
Subject: [PATCH] Fix go to definition for AHK v1, other misc work (#562)

---
 ahk2                                          |  2 +-
 .../definitionProvider/included.ahk1          |  9 +++++
 .../manualTests/definitionProvider/main.ahk1  | 10 +++++
 package-lock.json                             | 14 +++----
 package.json                                  |  2 +-
 src/parser/parser.ts                          |  5 ++-
 src/providers/defProvider.e2e.ts              | 15 ++++++++
 src/providers/defProvider.ts                  | 37 ++++++++++++++-----
 src/providers/defProvider.utils.ts            |  2 +
 9 files changed, 75 insertions(+), 21 deletions(-)
 create mode 100644 demos/manualTests/definitionProvider/included.ahk1
 create mode 100644 demos/manualTests/definitionProvider/main.ahk1
 create mode 100644 src/providers/defProvider.e2e.ts

diff --git a/ahk2 b/ahk2
index 53d6b48f..cec559a9 160000
--- a/ahk2
+++ b/ahk2
@@ -1 +1 @@
-Subproject commit 53d6b48fb1c037dc7aced039dd27e53dc5aaf356
+Subproject commit cec559a9d0b6698c3b33f3ac88701e1d375a096f
diff --git a/demos/manualTests/definitionProvider/included.ahk1 b/demos/manualTests/definitionProvider/included.ahk1
new file mode 100644
index 00000000..3c3cbf77
--- /dev/null
+++ b/demos/manualTests/definitionProvider/included.ahk1
@@ -0,0 +1,9 @@
+#NoEnv
+#SingleInstance, Force
+SendMode, Input
+SetBatchLines, -1
+SetWorkingDir, %A_ScriptDir%
+
+MyDefProviderFunc() {
+    MsgBox % "Hi from MyDefProviderFunc"
+}
\ No newline at end of file
diff --git a/demos/manualTests/definitionProvider/main.ahk1 b/demos/manualTests/definitionProvider/main.ahk1
new file mode 100644
index 00000000..f5b5a0bd
--- /dev/null
+++ b/demos/manualTests/definitionProvider/main.ahk1
@@ -0,0 +1,10 @@
+#NoEnv
+#SingleInstance, Force
+SendMode, Input
+SetBatchLines, -1
+SetWorkingDir, %A_ScriptDir%
+
+#Include ./included.ahk1
+
+;* Should be able to ctrl+click to jump to `included.ahk1` 
+MyDefProviderFunc()
\ No newline at end of file
diff --git a/package-lock.json b/package-lock.json
index b8651f3d..96add50f 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -29,7 +29,7 @@
                 "@types/xml2js": "^0.4.11",
                 "@vscode/test-cli": "^0.0.10",
                 "@vscode/test-electron": "^2.3.10",
-                "@vscode/vsce": "^3.1.1",
+                "@vscode/vsce": "^3.2.1",
                 "del-cli": "^6.0.0",
                 "esbuild": "0.24.0",
                 "eslint": "^9.9.0",
@@ -1642,9 +1642,9 @@
             }
         },
         "node_modules/@vscode/vsce": {
-            "version": "3.2.0",
-            "resolved": "https://registry.npmmirror.com/@vscode/vsce/-/vsce-3.2.0.tgz",
-            "integrity": "sha512-c/AId5Lp50HTszCBDfXfD/Go2djm6qO/WfedP2Y3BpRP+V+ttr8T0mTvZ8WEyTiBp2EfrYnzYUCx0ocB9mHy4Q==",
+            "version": "3.2.1",
+            "resolved": "https://registry.npmmirror.com/@vscode/vsce/-/vsce-3.2.1.tgz",
+            "integrity": "sha512-AY9vBjwExakK1c0cI/3NN2Ey0EgiKLBye/fxl/ue+o4q6RZ7N+xzd1jAD6eI6eBeMVANi617+V2rxIAkDPco2Q==",
             "dev": true,
             "license": "MIT",
             "dependencies": {
@@ -7203,9 +7203,9 @@
             }
         },
         "@vscode/vsce": {
-            "version": "3.2.0",
-            "resolved": "https://registry.npmmirror.com/@vscode/vsce/-/vsce-3.2.0.tgz",
-            "integrity": "sha512-c/AId5Lp50HTszCBDfXfD/Go2djm6qO/WfedP2Y3BpRP+V+ttr8T0mTvZ8WEyTiBp2EfrYnzYUCx0ocB9mHy4Q==",
+            "version": "3.2.1",
+            "resolved": "https://registry.npmmirror.com/@vscode/vsce/-/vsce-3.2.1.tgz",
+            "integrity": "sha512-AY9vBjwExakK1c0cI/3NN2Ey0EgiKLBye/fxl/ue+o4q6RZ7N+xzd1jAD6eI6eBeMVANi617+V2rxIAkDPco2Q==",
             "dev": true,
             "requires": {
                 "@azure/identity": "^4.1.0",
diff --git a/package.json b/package.json
index f2fe8372..f27bd1d0 100644
--- a/package.json
+++ b/package.json
@@ -1167,7 +1167,7 @@
         "@types/xml2js": "^0.4.11",
         "@vscode/test-cli": "^0.0.10",
         "@vscode/test-electron": "^2.3.10",
-        "@vscode/vsce": "^3.1.1",
+        "@vscode/vsce": "^3.2.1",
         "del-cli": "^6.0.0",
         "esbuild": "0.24.0",
         "eslint": "^9.9.0",
diff --git a/src/parser/parser.ts b/src/parser/parser.ts
index 873b3d01..ef15c20f 100644
--- a/src/parser/parser.ts
+++ b/src/parser/parser.ts
@@ -54,8 +54,9 @@ export class Parser {
         options: BuildScriptOptions = {},
     ): Promise<Script> {
         const funcName = 'buildScript';
-        if (options.usingCache && documentCache.get(document.uri.path)) {
-            return documentCache.get(document.uri.path);
+        const cachedDocument = documentCache.get(document.uri.path);
+        if (options.usingCache && cachedDocument) {
+            return cachedDocument;
         }
 
         const maxParseLength =
diff --git a/src/providers/defProvider.e2e.ts b/src/providers/defProvider.e2e.ts
new file mode 100644
index 00000000..430d8542
--- /dev/null
+++ b/src/providers/defProvider.e2e.ts
@@ -0,0 +1,15 @@
+import assert from 'assert';
+import { tryGetFileLink } from './defProvider';
+
+suite(tryGetFileLink.name, () => {
+    const tests: [
+        name: string,
+        args: Parameters<typeof tryGetFileLink>,
+        expected: ReturnType<typeof tryGetFileLink>,
+    ][] = [['non-match', ['/c:/path/to/file.ahk', 'foo'], undefined]];
+    tests.forEach(([name, args, expected]) =>
+        test(name, async () => {
+            assert.strictEqual(await tryGetFileLink(...args), expected);
+        }),
+    );
+});
diff --git a/src/providers/defProvider.ts b/src/providers/defProvider.ts
index 1af0bef9..f7215d3a 100644
--- a/src/providers/defProvider.ts
+++ b/src/providers/defProvider.ts
@@ -1,22 +1,32 @@
 import * as vscode from 'vscode';
 import { Parser } from '../parser/parser';
 import { resolveIncludedPath } from './defProvider.utils';
-import { Out } from 'src/common/out';
+import { Out } from '../common/out';
 import { stat } from 'fs/promises';
 
 export class DefProvider implements vscode.DefinitionProvider {
     public async provideDefinition(
         document: vscode.TextDocument,
         position: vscode.Position,
-    ): Promise<vscode.Location | vscode.Location[] | vscode.LocationLink[]> {
-        const fileLink = await tryGetFileLink(document, position);
+    ): Promise<
+        vscode.Location | vscode.Location[] | vscode.LocationLink[] | null
+    > {
+        const funcName = 'provideDefinition';
+        Out.debug(funcName);
+
+        const docPath = document.uri.path;
+        const { text } = document.lineAt(position.line);
+        const fileLink = await tryGetFileLink(docPath, text);
         if (fileLink) {
+            Out.debug(`${funcName} returning fileLink`);
             return fileLink;
         }
+        Out.debug(`${funcName} after tryGetFileLink`);
 
         const word = document.getText(
             document.getWordRangeAtPosition(position),
         );
+        Out.debug(`${funcName} word: ${word}`);
 
         // get method
         if (
@@ -24,7 +34,9 @@ export class DefProvider implements vscode.DefinitionProvider {
                 document.lineAt(position.line).text,
             )
         ) {
+            Out.debug(`${funcName} calling getMethodByName for word: ${word}`);
             const method = await Parser.getMethodByName(document, word);
+            Out.debug(`${funcName} method.name: ${method?.name}`);
             if (method) {
                 return new vscode.Location(
                     vscode.Uri.parse(method.uriString),
@@ -100,17 +112,22 @@ export class DefProvider implements vscode.DefinitionProvider {
  ** Currently assumes the working directory is the script path and
  * does not respect previous `#include dir` directives
  */
-async function tryGetFileLink(
-    document: vscode.TextDocument,
-    position: vscode.Position,
-): Promise<vscode.Location> | undefined {
+export async function tryGetFileLink(
     /** @example '/c:/path/to/file.ahk' */
-    const docPath = document.uri.path;
-    const { text } = document.lineAt(position.line);
+    docPath: string,
+    text: string,
+): Promise<vscode.Location | undefined> {
+    const funcName = 'tryGetFileLink';
+    Out.debug(`${funcName}('${docPath}', '${text}')`);
+
     /** @example 'c:/path/to/included.ahk' */
     const resolvedPath = resolveIncludedPath(docPath, text);
-    Out.debug(`resolvedPath: ${resolvedPath}`);
+    Out.debug(`${funcName} resolvedPath: ${resolvedPath}`);
+    if (!resolvedPath) return undefined;
+
     const fsStat = await stat(resolvedPath);
+    const isFile = fsStat.isFile();
+    Out.debug(`${funcName} isFile: ${isFile}`);
     return fsStat.isFile()
         ? new vscode.Location(
               vscode.Uri.file(resolvedPath),
diff --git a/src/providers/defProvider.utils.ts b/src/providers/defProvider.utils.ts
index f657caaa..2256cdeb 100644
--- a/src/providers/defProvider.utils.ts
+++ b/src/providers/defProvider.utils.ts
@@ -55,6 +55,8 @@ export const resolveIncludedPath = (
     ahkLine: string,
 ): string | undefined => {
     const includedPath = getIncludedPath(ahkLine);
+    if (!includedPath) return undefined;
+
     /** @example 'c:/path/to' */
     const parentGoodPath = basePath.substring(1, basePath.lastIndexOf('/'));
     const normalizedPath = normalizeIncludedPath(