Cleaned up the scopes flows and added the ability to defer the loading of the local scope

src/LaunchConfiguration.ts

@@ -161,9 +161,16 @@ export interface LaunchConfiguration extends DebugProtocol.LaunchRequestArgument
 
     /**
      * Enables automatic population of the debug variable panel on a breakpoint or runtime errors.
+     * @deprecated Use `deferScopeLoading` instead
      */
     enableVariablesPanel: boolean;
 
+    /**
+     * Will defer the population of the 'Local' scope variables until the user expands it in the variables panel.
+     * @default false
+     */
+    deferScopeLoading: boolean;
+
     /**
      * Enables automatic population of the virtual variables.
      */

src/adapters/DebugProtocolAdapter.ts

@@ -581,7 +581,6 @@ export class DebugProtocolAdapter {
      * @param expression the expression for the specified variable (i.e. `m`, `someVar.value`, `arr[1][2].three`). If empty string/undefined is specified, all local variables are retrieved instead
      */
     private async getVariablesResponse(expression: string, frameId: number) {
-        const isScopesRequest = expression === '';
         const logger = this.logger.createLogger('[getVariable]');
         logger.info('begin', { expression });
         if (!this.isAtDebuggerPrompt) {
@@ -1012,6 +1011,14 @@ export class DebugProtocolAdapter {
             }
         }
     }
+
+    public isTelnetAdapter(): this is TelnetAdapter {
+        return false;
+    }
+
+    public isDebugProtocolAdapter(): this is DebugProtocolAdapter {
+        return true;
+    }
 }
 
 export interface StackFrame {
@@ -1064,7 +1071,3 @@ interface BrightScriptRuntimeError {
     message: string;
     errorCode: string;
 }
-
-export function isDebugProtocolAdapter(adapter: TelnetAdapter | DebugProtocolAdapter): adapter is DebugProtocolAdapter {
-    return adapter?.constructor.name === DebugProtocolAdapter.name;
-}

src/adapters/TelnetAdapter.ts

@@ -588,8 +588,9 @@ export class TelnetAdapter {
     /**
      * Given an expression, evaluate that statement ON the roku
      * @param expression
+     * @param frameId unused but added to match signature of DebugProtocolAdapter
      */
-    public async getVariable(expression: string) {
+    public async getVariable(expression: string, frameId = -1) {
         const logger = this.logger.createLogger('[getVariable]');
         logger.info('begin', { expression });
         if (!this.isAtDebuggerPrompt) {
@@ -1112,6 +1113,14 @@ export class TelnetAdapter {
     public async syncBreakpoints() {
         //we can't send dynamic breakpoints to the server...so just do nothing
     }
+
+    public isTelnetAdapter(): this is TelnetAdapter {
+        return true;
+    }
+
+    public isDebugProtocolAdapter(): this is DebugProtocolAdapter {
+        return true;
+    }
 }
 
 export interface StackFrame {
@@ -1166,7 +1175,3 @@ interface BrightScriptRuntimeError {
     message: string;
     errorCode: string;
 }
-
-export function isTelnetAdapterAdapter(adapter: TelnetAdapter | DebugProtocolAdapter): adapter is TelnetAdapter {
-    return adapter?.constructor.name === TelnetAdapter.name;
-}

src/debugSession/BrightScriptDebugSession.spec.ts

@@ -22,6 +22,7 @@ import { RendezvousTracker } from '../RendezvousTracker';
 import { ClientToServerCustomEventName, isCustomRequestEvent, LogOutputEvent } from './Events';
 import { EventEmitter } from 'eventemitter3';
 import type { EvaluateContainer } from '../adapters/DebugProtocolAdapter';
+import { VariableType } from '../debugProtocol/events/responses/VariablesResponse';
 
 const sinon = sinonActual.createSandbox();
 const tempDir = s`${__dirname}/../../.tmp`;
@@ -117,6 +118,8 @@ describe('BrightScriptDebugSession', () => {
             getScopeVariables: (a) => { },
             setExceptionBreakpoints: (a) => { },
             isScrapableContainObject: () => { },
+            isTelnetAdapter: () => false,
+            isDebugProtocolAdapter: () => true,
             getThreads: () => {
                 return [];
             },
@@ -334,6 +337,21 @@ describe('BrightScriptDebugSession', () => {
             sinon.stub(rokuAdapter, 'getScopeVariables').callsFake(() => {
                 return Promise.resolve(['m', 'top', `${session.tempVarPrefix}eval`]);
             });
+            sinon.stub(session as any, 'populateScopeVariables').callsFake((v: AugmentedVariable, args: DebugProtocol.VariablesArguments) => {
+                v.childVariables = [{
+                    name: `${session.tempVarPrefix}eval`,
+                    value: 'true',
+                    variablesReference: 0
+                }, {
+                    name: 'top',
+                    value: 'roSGNode:GetSubReddit',
+                    variablesReference: 3
+                }, {
+                    name: 'm',
+                    value: VariableType.AssociativeArray,
+                    variablesReference: 0
+                }];
+            });
             sinon.stub(rokuAdapter, 'getVariable').callsFake(x => {
                 return Promise.resolve(
                     {
@@ -359,7 +377,7 @@ describe('BrightScriptDebugSession', () => {
             session['dispatchRequest']({ command: 'scopes', arguments: { frameId: 0 }, type: 'request', seq: 8 });
             await session.variablesRequest(
                 response,
-                { variablesReference: 1000, filter: 'named', start: 0, count: 0, format: '' } as DebugProtocol.VariablesArguments
+                { variablesReference: 1, filter: 'named', start: 0, count: 0, format: '' } as DebugProtocol.VariablesArguments
             );
 
             expect(
@@ -369,7 +387,7 @@ describe('BrightScriptDebugSession', () => {
             session['launchConfiguration'].showHiddenVariables = true;
             await session.variablesRequest(
                 response,
-                { variablesReference: 1000, filter: 'named', start: 0, count: 0, format: '' } as DebugProtocol.VariablesArguments
+                { variablesReference: 1, filter: 'named', start: 0, count: 0, format: '' } as DebugProtocol.VariablesArguments
             );
             expect(
                 response.body.variables.find(x => x.name.startsWith(session.tempVarPrefix))
@@ -654,6 +672,8 @@ describe('BrightScriptDebugSession', () => {
 
         it('returns the correct boolean variable', async () => {
             session['rokuAdapterDeferred'].resolve(session['rokuAdapter']);
+            sinon.stub(session['rokuAdapter'], 'isTelnetAdapter').callsFake(() => true);
+            sinon.stub(session['rokuAdapter'], 'isDebugProtocolAdapter').callsFake(() => false);
 
             let expression = 'someBool';
             getVariableValue = getBooleanEvaluateContainer(expression);
@@ -673,6 +693,8 @@ describe('BrightScriptDebugSession', () => {
         //this fails on TravisCI for some reason. TODO - fix this
         it('returns the correct indexed variables count', async () => {
             session['rokuAdapterDeferred'].resolve(session['rokuAdapter']);
+            sinon.stub(session['rokuAdapter'], 'isTelnetAdapter').callsFake(() => true);
+            sinon.stub(session['rokuAdapter'], 'isDebugProtocolAdapter').callsFake(() => false);
 
             let expression = 'someArray';
             getVariableValue = <EvaluateContainer>{
@@ -699,6 +721,8 @@ describe('BrightScriptDebugSession', () => {
 
         it('returns the correct named variables count', async () => {
             session['rokuAdapterDeferred'].resolve(session['rokuAdapter']);
+            sinon.stub(session['rokuAdapter'], 'isTelnetAdapter').callsFake(() => true);
+            sinon.stub(session['rokuAdapter'], 'isDebugProtocolAdapter').callsFake(() => false);
 
             let expression = 'someObject';
             getVariableValue = <EvaluateContainer>{
@@ -1020,6 +1044,8 @@ describe('BrightScriptDebugSession', () => {
 
         beforeEach(() => {
             session['rokuAdapterDeferred'].resolve(session['rokuAdapter']);
+            sinon.stub(session['rokuAdapter'], 'isTelnetAdapter').callsFake(() => true);
+            sinon.stub(session['rokuAdapter'], 'isDebugProtocolAdapter').callsFake(() => false);
 
             rokuAdapter.isAtDebuggerPrompt = true;
             evalStub = sinon.stub(rokuAdapter, 'evaluate').callsFake((args) => {