Added new settings for deferred scope loading and updated telemetry w…

…ith some missing settings (#620)
rokucommunity · Feb 19, 2025 · be2945d · be2945d
2 parents 6370cf0 + 8e1e60f
commit be2945d
Show file tree

Hide file tree

Showing 5 changed files with 29 additions and 5 deletions.
diff --git a/docs/extension-settings.md b/docs/extension-settings.md
@@ -73,7 +73,11 @@ pkg:/source/main.brs(10:20)
 ...ce/main.brs(10:20)
 ```
 ### `brightscript.debug.enableVariablesPanel`
+_(deprecated) Use `deferScopeLoading` instead._
+
 Defaults to `true`. Enables automatic population of the debug variable panel on a breakpoint or runtime errors
+### `brightscript.debug.deferScopeLoading`
+Defaults to `false`. Will defer the population of the `Local` scope variables until the user expands it in the variables panel.
 ### `brightscript.debug.autoResolveVirtualVariables` (Experimental)
 Defaults to `false`. Enables automatic population of the virtual variables.
 ### `brightscript.debug.enhanceREPLCompletions`

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -79,7 +79,7 @@
         "postman-request": "^2.88.1-postman.32",
         "pretty-bytes": "^5.6.0",
         "resolve": "^1.22.8",
-        "roku-debug": "^0.21.22",
+        "roku-debug": "^0.21.23",
         "roku-deploy": "^3.12.4",
         "roku-test-automation": "^2.0.10",
         "semver": "^7.1.3",
@@ -790,8 +790,14 @@
                             "enableVariablesPanel": {
                                 "type": "boolean",
                                 "description": "Enables automatic population of the debug variable panel on a breakpoint or runtime errors.",
+                                "deprecationMessage": "Use 'deferScopeLoading' instead.",
                                 "default": true
                             },
+                            "deferScopeLoading": {
+                                "type": "boolean",
+                                "description": "Will defer the population of the 'Local' scope variables until the user expands it in the variables panel.",
+                                "default": false
+                            },
                             "autoResolveVirtualVariables": {
                                 "type": "boolean",
                                 "description": "(Experimental) Enables automatic population of the virtual variables.",
@@ -2241,9 +2247,16 @@
                     "brightscript.debug.enableVariablesPanel": {
                         "type": "boolean",
                         "description": "Enables automatic population of the debug variable panel on a breakpoint or runtime errors.",
+                        "deprecationMessage": "Use 'deferScopeLoading' instead.",
                         "default": true,
                         "scope": "resource"
                     },
+                    "brightscript.debug.deferScopeLoading": {
+                        "type": "boolean",
+                        "description": "Will defer the population of the 'Local' scope variables until the user expands it in the variables panel.",
+                        "default": false,
+                        "scope": "resource"
+                    },
                     "brightscript.debug.autoResolveVirtualVariables": {
                         "type": "boolean",
                         "description": "(Experimental) Enables automatic population of the virtual variables.",

diff --git a/src/DebugConfigurationProvider.ts b/src/DebugConfigurationProvider.ts
@@ -55,6 +55,7 @@ export class BrightScriptDebugConfigurationProvider implements DebugConfiguratio
         disableScreenSaver: true,
         retainStagingFolder: false,
         enableVariablesPanel: true,
+        deferScopeLoading: false,
         autoResolveVirtualVariables: false,
         enhanceREPLCompletions: false,
         showHiddenVariables: false,

diff --git a/src/managers/TelemetryManager.ts b/src/managers/TelemetryManager.ts
@@ -45,6 +45,12 @@ export class TelemetryManager implements Disposable {
 
         this.reporter.sendTelemetryEvent('startDebugSession', {
             enableDebugProtocol: boolToString(initialConfig.enableDebugProtocol),
+            enableVariablesPanel: boolToString(initialConfig.enableVariablesPanel),
+            deferScopeLoading: boolToString(initialConfig.deferScopeLoading),
+            autoResolveVirtualVariables: boolToString(initialConfig.autoResolveVirtualVariables),
+            enhanceREPLCompletions: boolToString(initialConfig.enhanceREPLCompletions),
+            rewriteDevicePathsInLogs: boolToString(initialConfig.rewriteDevicePathsInLogs),
+            showHiddenVariables: boolToString(initialConfig.showHiddenVariables),
             debugConnectionType: debugConnectionType?.toString(),
             retainDeploymentArchive: boolToString(initialConfig.retainDeploymentArchive),
             retainStagingFolder: boolToString(initialConfig.retainStagingFolder),