Debugger QOL improvements and small fixes (#944)

* Stale variables fix
* Introduced by #848
* Fixes #935

* Debugger QOL improvements and fixes
* Property rename to match expected behavior:
** members now do not have a prefix in object instances: Member/Foo -> Foo
** Inherited properties now do have a prefix: Parent1/Foo, ParentOfParent1/Boo
** Categories are properly treated and not displayed as property
* __repr__ support
** If the class contains __repr__ member, value of it will be used as a display name for it's instances representations. That works for Dictionary keys too.

Smaller changes and fixes:
* Arrays to display actual values for more complex types in preview (Vectors/Rects/etc)
* Strings are 'quoted' (similar to other DAPs)
* Rect2i fix (parse as int, not float)
* StrnigName better representation in values and dict keys: &'StringName'
* tasks discoverabilty: Added tasks for test and package to tasks.json.

* code cleanup & array support

* fix

* missed vscode_id for ObjectId

* some linter fixes

* CI: Godot version bump to 4.5.1
Test project: update test proj

* handling unset Godot Objects

* make sure to stop prev client

* test project to 4.6 update

Author: MichaelXt

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -18,7 +18,7 @@ body:
     description: >
       Specify the Git commit hash if using a development or non-official build.
       If you use a custom build, please test if your issue is reproducible in official builds too.
-    placeholder: 4.3.stable, 4.4.dev1 (28a72fa43)
+    placeholder: 4.5.1.stable, 4.6.dev0 (6fd949a)
   validations:
     required: true
 

.github/workflows/ci.yml

@@ -21,25 +21,25 @@ jobs:
       - name: Install Godot (Ubuntu)
         if: matrix.os == 'ubuntu-latest'
         run: |
-          wget https://github.com/godotengine/godot/releases/download/4.3-stable/Godot_v4.3-stable_linux.x86_64.zip
-          unzip Godot_v4.3-stable_linux.x86_64.zip
-          sudo mv Godot_v4.3-stable_linux.x86_64 /usr/local/bin/godot
+          wget https://github.com/godotengine/godot/releases/download/4.5.1-stable/Godot_v4.5.1-stable_linux.x86_64.zip
+          unzip Godot_v4.5.1-stable_linux.x86_64.zip
+          sudo mv Godot_v4.5.1-stable_linux.x86_64 /usr/local/bin/godot
           chmod +x /usr/local/bin/godot
 
       - name: Install Godot (macOS)
         if: matrix.os == 'macos-latest'
         run: |
-          curl -L -o Godot.zip https://github.com/godotengine/godot/releases/download/4.3-stable/Godot_v4.3-stable_macos.universal.zip
+          curl -L -o Godot.zip https://github.com/godotengine/godot/releases/download/4.5.1-stable/Godot_v4.5.1-stable_macos.universal.zip
           unzip Godot.zip
           sudo mv Godot.app /Applications/Godot.app
           sudo ln -s /Applications/Godot.app/Contents/MacOS/Godot /usr/local/bin/godot
 
       - name: Install Godot (Windows)
         if: matrix.os == 'windows-latest'
         run: |
-          Invoke-WebRequest -Uri "https://github.com/godotengine/godot/releases/download/4.3-stable/Godot_v4.3-stable_win64.exe.zip" -OutFile "Godot.zip"
-          Expand-Archive -Path "Godot.zip" -DestinationPath "C:\Godot43"
-          "C:\Godot43\Godot_v4.3-stable_win64.exe %*" | Out-File -Encoding ascii -FilePath ([Environment]::SystemDirectory+"\godot.cmd")
+          Invoke-WebRequest -Uri "https://github.com/godotengine/godot/releases/download/4.5.1-stable/Godot_v4.5.1-stable_win64.exe.zip" -OutFile "Godot.zip"
+          Expand-Archive -Path "Godot.zip" -DestinationPath "C:\Godot451"
+          "C:\Godot451\Godot_v4.5.1-stable_win64.exe %*" | Out-File -Encoding ascii -FilePath ([Environment]::SystemDirectory+"\godot.cmd")
 
       - name: Install dependencies
         run: npm install

.vscode/tasks.json

@@ -15,6 +15,23 @@
 				"kind": "build",
 				"isDefault": true
 			}
-		}
+		},
+		{
+			"type": "npm",
+			"script": "test",
+			"group": {
+				"kind": "test",
+				"isDefault": true
+			}
+		},
+		{
+			"type": "npm",
+			"script": "package",
+			"label": "Package extension (vsix)",
+			"group": {
+				"kind": "build",
+				"isDefault": false
+			}
+		},
 	]
 }

CONTRIBUTING.md

@@ -12,6 +12,7 @@
 2. Download dependencies by using the command `npm install`
 3. When done, package a VSIX file by using the command `npm run package`.
 4. Install it by opening Visual Studio Code, opening the Extensions tab, clicking on the More actions (**...**) button in the top right, and choose **Install from VSIX...** and find the compiled VSIX file.
+5. Testing: `npm run test` to execute tests.
 
 When developing for the extension, you can open this project in Visual Studio Code and debug the extension by using the **Run Extension** launch configuration instead of going through steps 3 and 4. It will launch a new instance of Visual Studio Code that has the extension running. You can then open a Godot project folder and debug the extension or GDScript debugger.
 
@@ -32,8 +33,8 @@ An example `workspace.code-workspace` file:
 		"godotTools.editorPath.godot3": "godot3.dev.exe",
 		"godotTools.editorPath.godot4": "godot4.dev.exe",
 		// "godotTools.editorPath.godot4": "godot4.custom.exe"
-        // "godotTools.editorPath.godot4": "Godot_v4.1.1-stable_win64.exe",
-        "godotTools.lsp.headless": false
+		// "godotTools.editorPath.godot4": "Godot_v4.1.1-stable_win64.exe",
+		"godotTools.lsp.headless": false
 	}
 }
 ```

src/debugger/godot4/debug_session.ts

@@ -27,7 +27,7 @@ export class GodotDebugSession extends LoggingDebugSession {
 	private configuration_done: Subject = new Subject();
 	private mode: "launch" | "attach" | "" = "";
 
-	public variables_manager = new VariablesManager(this.controller);
+	public variables_manager: VariablesManager;
 
 	public constructor(projectVersion: string) {
 		super();

src/debugger/godot4/helpers.ts

@@ -1,6 +1,7 @@
 import { GodotVariable } from "../debug_runtime";
 import { SceneNode } from "../scene_tree_provider";
-import { ObjectId } from "./variables/variants";
+import { VariablesManager } from "./variables/variables_manager";
+import { ObjectId, StringName } from "./variables/variants";
 
 export function parse_next_scene_node(params: any[], ofs: { offset: number } = { offset: 0 }): SceneNode {
 	const childCount: number = params[ofs.offset++];
@@ -32,23 +33,29 @@ export function split_buffers(buffer: Buffer) {
 	return buffers;
 }
 
-export function get_sub_values(value: any): GodotVariable[] {
+export async function get_sub_values(value: any, variables_manager: VariablesManager): Promise<GodotVariable[]> {
 	let subValues: GodotVariable[] = undefined;
 
 	if (value) {
 		if (Array.isArray(value)) {
-			subValues = value.map((va, i) => {
-				return { name: `${i}`, value: va } as GodotVariable;
+			subValues = value.map((val, i) => {
+				const godot_id = val instanceof ObjectId ? val.id : undefined;
+				return { id: godot_id, name: `${i}`, value: val } as GodotVariable;
 			});
 		} else if (value instanceof Map) {
 			subValues = [];
 			for (const [key, val] of value.entries()) {
-				const name =
-					typeof key.stringify_value === "function"
-						? `${key.type_name()}${key.stringify_value()}`
-						: `${key}`;
+				let key_name = "";
+				if (typeof key?.get_rendered_value === "function") { //  (key instanceof ObjectId), (key instanceof StringName)
+					key_name = await key.get_rendered_value(variables_manager);
+				} else {
+					key_name =
+						typeof key.stringify_value === "function"
+							? `${key.type_name()}${key.stringify_value()}`
+							: `${key}`;
+				}
 				const godot_id = val instanceof ObjectId ? val.id : undefined;
-				subValues.push({ id: godot_id, name, value: val } as GodotVariable);
+				subValues.push({ id: godot_id, name: key_name, value: val } as GodotVariable);
 			}
 		} else if (typeof value.sub_values === "function") {
 			subValues = value.sub_values()?.map((sva) => {
@@ -58,7 +65,7 @@ export function get_sub_values(value: any): GodotVariable[] {
 	}
 
 	for (let i = 0; i < subValues?.length; i++) {
-		subValues[i].sub_values = get_sub_values(subValues[i].value);
+		subValues[i].sub_values = await get_sub_values(subValues[i].value, variables_manager);
 	}
 
 	return subValues;