roku-debug 0.21.22 → 0.21.23

package/dist/debugSession/BrightScriptDebugSession.js

@@ -49,7 +49,6 @@ class BrightScriptDebugSession extends debugadapter_1.DebugSession {
         this.evaluateRefIdLookup = {};
         this.evaluateRefIdCounter = 1;
         this.variables = {};
-        this.variableHandles = new debugadapter_1.Handles();
         this.tempVarPrefix = '__rokudebug__';
         /**
          * A magic number to represent a fake thread that will be used for showing compile errors in the UI as if they were runtime crashes
@@ -258,7 +257,7 @@ class BrightScriptDebugSession extends debugadapter_1.DebugSession {
      * @returns
      */
     normalizeLaunchConfig(config) {
-        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p;
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q;
         (_a = config.cwd) !== null && _a !== void 0 ? _a : (config.cwd = process.cwd());
         (_b = config.outDir) !== null && _b !== void 0 ? _b : (config.outDir = (0, FileUtils_1.standardizePath) `${config.cwd}/out`);
         (_c = config.stagingDir) !== null && _c !== void 0 ? _c : (config.stagingDir = (0, FileUtils_1.standardizePath) `${config.outDir}/.roku-deploy-staging`);
@@ -273,6 +272,11 @@ class BrightScriptDebugSession extends debugadapter_1.DebugSession {
         (_m = config.rewriteDevicePathsInLogs) !== null && _m !== void 0 ? _m : (config.rewriteDevicePathsInLogs = true);
         (_o = config.autoResolveVirtualVariables) !== null && _o !== void 0 ? _o : (config.autoResolveVirtualVariables = false);
         (_p = config.enhanceREPLCompletions) !== null && _p !== void 0 ? _p : (config.enhanceREPLCompletions = true);
+        // migrate the old `enableVariablesPanel` setting to the new `deferScopeLoading` setting
+        if (typeof config.enableVariablesPanel !== 'boolean') {
+            config.enableVariablesPanel = true;
+        }
+        (_q = config.deferScopeLoading) !== null && _q !== void 0 ? _q : (config.deferScopeLoading = config.enableVariablesPanel === false);
         return config;
     }
     async launchRequest(response, config) {
@@ -990,56 +994,49 @@ class BrightScriptDebugSession extends debugadapter_1.DebugSession {
             this.logger.error('Error getting stacktrace', { error, args });
         }
     }
-    async scopesRequest(response, args) {
+    scopesRequest(response, args) {
         const logger = this.logger.createLogger(`scopesRequest ${this.idCounter}`);
         logger.info('begin', { args });
         try {
             const scopes = new Array();
-            if ((0, DebugProtocolAdapter_1.isDebugProtocolAdapter)(this.rokuAdapter)) {
-                let refId = this.getEvaluateRefId('', args.frameId);
-                let v;
-                //if we already looked this item up, return it
-                if (this.variables[refId]) {
-                    v = this.variables[refId];
-                }
-                else {
-                    let result = await this.rokuAdapter.getLocalVariables(args.frameId);
-                    if (!result) {
-                        throw new Error(`Could not get scopes`);
-                    }
-                    v = await this.getVariableFromResult(result, args.frameId);
-                    //TODO - testing something, remove later
-                    // eslint-disable-next-line camelcase
-                    v.request_seq = response.request_seq;
-                    v.frameId = args.frameId;
-                }
-                scopes.push({
-                    name: 'Local',
-                    variablesReference: v.variablesReference,
-                    expensive: false,
-                    presentationHint: 'locals'
-                });
+            let v;
+            // create the locals scope
+            let localsRefId = this.getEvaluateRefId('$$locals', args.frameId);
+            if (this.variables[localsRefId]) {
+                v = this.variables[localsRefId];
             }
             else {
-                // NOTE: Legacy telnet support
-                scopes.push({
-                    name: 'Local',
-                    variablesReference: this.variableHandles.create('local'),
-                    expensive: false,
-                    presentationHint: 'locals'
-                });
+                v = {
+                    variablesReference: localsRefId,
+                    name: 'Locals',
+                    value: '',
+                    type: '$$Locals',
+                    frameId: args.frameId,
+                    isScope: true,
+                    childVariables: []
+                };
+                this.variables[localsRefId] = v;
             }
-            let refId = this.getEvaluateRefId('$$registry', Infinity);
+            scopes.push({
+                name: 'Local',
+                variablesReference: v.variablesReference,
+                // Flag the locals scope as expensive if the client asked that it be loaded lazily
+                expensive: this.launchConfiguration.deferScopeLoading,
+                presentationHint: 'locals'
+            });
+            // create the registry scope
+            let registryRefId = this.getEvaluateRefId('$$registry', Infinity);
             scopes.push({
                 name: 'Registry',
-                variablesReference: refId,
+                variablesReference: registryRefId,
                 expensive: true
             });
-            this.variables[refId] = {
-                variablesReference: refId,
+            this.variables[registryRefId] = {
+                variablesReference: registryRefId,
                 name: 'Registry',
                 value: '',
                 type: '$$Registry',
+                isScope: true,
                 childVariables: []
             };
             response.body = {
@@ -1160,99 +1157,77 @@ class BrightScriptDebugSession extends debugadapter_1.DebugSession {
                 response.message = 'Debug session is not paused';
                 return this.sendResponse(response);
             }
-            const reference = this.variableHandles.get(args.variablesReference);
-            if (reference) {
-                logger.log('reference', reference);
-                // NOTE: Legacy telnet support for local vars
-                if (this.launchConfiguration.enableVariablesPanel) {
-                    const vars = await this.rokuAdapter.getScopeVariables();
-                    for (const varName of vars) {
-                        let { evalArgs } = await this.evaluateExpressionToTempVar({ expression: varName, frameId: -1 }, util_1.util.getVariablePath(varName));
-                        let result = await this.rokuAdapter.getVariable(evalArgs.expression, -1);
-                        let tempVar = await this.getVariableFromResult(result, -1);
-                        updatedVariables.push(tempVar);
-                    }
-                }
-                else {
-                    updatedVariables.push(new debugadapter_1.Variable('variables disabled by launch.json setting', 'enableVariablesPanel: false'));
-                }
-                this.variables[args.variablesReference] = new debugadapter_1.Variable('', '', args.variablesReference, 0, updatedVariables.length);
-                this.variables[args.variablesReference].childVariables = updatedVariables;
+            //find the variable with this reference
+            let v = this.variables[args.variablesReference];
+            if (!v) {
+                response.success = false;
+                response.message = `Variable reference has expired`;
+                return this.sendResponse(response);
             }
-            else {
-                //find the variable with this reference
-                let v = this.variables[args.variablesReference];
-                if (!v) {
-                    response.success = false;
-                    response.message = `Variable reference has expired`;
-                    return this.sendResponse(response);
-                }
-                logger.log('variable', v);
-                if (v.type === '$$Registry' && v.childVariables.length === 0) {
-                    // This is a special scope variable used to load registry data via an ECP call
-                    // Send the registry ECP call for the `dev` app as side loaded apps are always `dev`
-                    await (0, ecpRegistryUtils_1.populateVariableFromRegistryEcp)({ host: this.launchConfiguration.host, remotePort: this.launchConfiguration.remotePort, appId: 'dev' }, v, this.variables, this.getEvaluateRefId.bind(this));
-                }
-                //query for child vars if we haven't done it yet or DAP is asking to resolve a lazy variable
-                if (v.childVariables.length === 0 || v.isResolved) {
-                    let tempVar;
-                    if (!v.isResolved) {
-                        // Evaluate the variable
-                        try {
-                            let { evalArgs } = await this.evaluateExpressionToTempVar({ expression: v.evaluateName, frameId: v.frameId }, util_1.util.getVariablePath(v.evaluateName));
-                            let result = await this.rokuAdapter.getVariable(evalArgs.expression, v.frameId);
-                            tempVar = await this.getVariableFromResult(result, v.frameId);
-                            tempVar.frameId = v.frameId;
-                            // Determine if the variable has changed
-                            sendInvalidatedEvent = v.type !== tempVar.type || v.indexedVariables !== tempVar.indexedVariables;
-                        }
-                        catch (error) {
-                            logger.error('Error getting variables', error);
-                            tempVar = new debugadapter_1.Variable('Error', `❌ Error: ${error.message}`);
-                            tempVar.type = '';
-                            tempVar.childVariables = [];
-                            sendInvalidatedEvent = true;
-                            response.success = false;
-                            response.message = error.message;
-                        }
-                        // Merge the resulting updates together
-                        v.childVariables = tempVar.childVariables;
-                        v.value = tempVar.value;
-                        v.type = tempVar.type;
-                        v.indexedVariables = tempVar.indexedVariables;
-                        v.namedVariables = tempVar.namedVariables;
+            logger.log('variable', v);
+            // Populate scope level values if needed
+            if (v.isScope) {
+                await this.populateScopeVariables(v, args);
+            }
+            //query for child vars if we haven't done it yet or DAP is asking to resolve a lazy variable
+            if (v.childVariables.length === 0 || v.isResolved) {
+                let tempVar;
+                if (!v.isResolved) {
+                    // Evaluate the variable
+                    try {
+                        let { evalArgs } = await this.evaluateExpressionToTempVar({ expression: v.evaluateName, frameId: v.frameId }, util_1.util.getVariablePath(v.evaluateName));
+                        let result = await this.rokuAdapter.getVariable(evalArgs.expression, v.frameId);
+                        tempVar = await this.getVariableFromResult(result, v.frameId);
+                        tempVar.frameId = v.frameId;
+                        // Determine if the variable has changed
+                        sendInvalidatedEvent = v.type !== tempVar.type || v.indexedVariables !== tempVar.indexedVariables;
                     }
-                    frameId = v.frameId;
-                    if (((_b = v === null || v === void 0 ? void 0 : v.presentationHint) === null || _b === void 0 ? void 0 : _b.lazy) || v.isResolved) {
-                        // If this was a lazy variable we need to respond with the updated variable and not the children
-                        if (v.isResolved && v.childVariables.length > 0) {
-                            updatedVariables = v.childVariables;
-                        }
-                        else {
-                            updatedVariables = [v];
-                        }
-                        v.isResolved = true;
+                    catch (error) {
+                        logger.error('Error getting variables', error);
+                        tempVar = new debugadapter_1.Variable('Error', `❌ Error: ${error.message}`);
+                        tempVar.type = '';
+                        tempVar.childVariables = [];
+                        sendInvalidatedEvent = true;
+                        response.success = false;
+                        response.message = error.message;
                     }
-                    else {
+                    // Merge the resulting updates together
+                    v.childVariables = tempVar.childVariables;
+                    v.value = tempVar.value;
+                    v.type = tempVar.type;
+                    v.indexedVariables = tempVar.indexedVariables;
+                    v.namedVariables = tempVar.namedVariables;
+                }
+                frameId = v.frameId;
+                if (((_b = v === null || v === void 0 ? void 0 : v.presentationHint) === null || _b === void 0 ? void 0 : _b.lazy) || v.isResolved) {
+                    // If this was a lazy variable we need to respond with the updated variable and not the children
+                    if (v.isResolved && v.childVariables.length > 0) {
                         updatedVariables = v.childVariables;
                     }
-                    // If the variable has no children, set the reference to 0
-                    // so it does not look expandable in the Ui
-                    if (v.childVariables.length === 0) {
-                        v.variablesReference = 0;
-                    }
-                    // If the variable was resolve in the past we may not have fetched a new temp var
-                    tempVar !== null && tempVar !== void 0 ? tempVar : (tempVar = v);
-                    if (v === null || v === void 0 ? void 0 : v.presentationHint) {
-                        v.presentationHint.lazy = (_c = tempVar.presentationHint) === null || _c === void 0 ? void 0 : _c.lazy;
-                    }
                     else {
-                        v.presentationHint = tempVar.presentationHint;
+                        updatedVariables = [v];
                     }
+                    v.isResolved = true;
                 }
                 else {
                     updatedVariables = v.childVariables;
                 }
+                // If the variable has no children, set the reference to 0
+                // so it does not look expandable in the Ui
+                if (v.childVariables.length === 0) {
+                    v.variablesReference = 0;
+                }
+                // If the variable was resolve in the past we may not have fetched a new temp var
+                tempVar !== null && tempVar !== void 0 ? tempVar : (tempVar = v);
+                if (v === null || v === void 0 ? void 0 : v.presentationHint) {
+                    v.presentationHint.lazy = (_c = tempVar.presentationHint) === null || _c === void 0 ? void 0 : _c.lazy;
+                }
+                else {
+                    v.presentationHint = tempVar.presentationHint;
+                }
+            }
+            else {
+                updatedVariables = v.childVariables;
             }
             // Only send the updated variables if we are not going to trigger an invalidated event.
             // This is to prevent the UI from updating twice and makes the experience much smoother to the end user.
@@ -1310,6 +1285,79 @@ class BrightScriptDebugSession extends debugadapter_1.DebugSession {
         }
         return filteredUpdatedVariables;
     }
+    /**
+     * Takes a scope variable and populates its child variables based on the scope type and the current adapter type.
+     * @param v scope variable to populate
+     * @param args
+     */
+    async populateScopeVariables(v, args) {
+        if (v.childVariables.length > 0) {
+            // Already populated
+            return;
+        }
+        let tempVar;
+        try {
+            if (v.type === '$$Locals') {
+                if (this.rokuAdapter.isDebugProtocolAdapter()) {
+                    let result = await this.rokuAdapter.getLocalVariables(v.frameId);
+                    tempVar = await this.getVariableFromResult(result, v.frameId);
+                }
+                else if (this.rokuAdapter.isTelnetAdapter()) {
+                    // NOTE: Legacy telnet support
+                    let variables = [];
+                    const varNames = await this.rokuAdapter.getScopeVariables();
+                    // Fetch each variable individually
+                    for (const varName of varNames) {
+                        let { evalArgs } = await this.evaluateExpressionToTempVar({ expression: varName, frameId: -1 }, util_1.util.getVariablePath(varName));
+                        let result = await this.rokuAdapter.getVariable(evalArgs.expression, -1);
+                        let tempLocalsVar = await this.getVariableFromResult(result, -1);
+                        variables.push(tempLocalsVar);
+                    }
+                    tempVar = {
+                        ...v,
+                        childVariables: variables,
+                        namedVariables: variables.length,
+                        indexedVariables: 0
+                    };
+                }
+                // Merge the resulting updates together onto the original variable
+                v.childVariables = tempVar.childVariables;
+                v.namedVariables = tempVar.namedVariables;
+                v.indexedVariables = tempVar.indexedVariables;
+            }
+            else if (v.type === '$$Registry') {
+                // This is a special scope variable used to load registry data via an ECP call
+                // Send the registry ECP call for the `dev` app as side loaded apps are always `dev`
+                await (0, ecpRegistryUtils_1.populateVariableFromRegistryEcp)({ host: this.launchConfiguration.host, remotePort: this.launchConfiguration.remotePort, appId: 'dev' }, v, this.variables, this.getEvaluateRefId.bind(this));
+            }
+        }
+        catch (error) {
+            logging_1.logger.error(`Error getting variables for scope ${v.type}`, error);
+            tempVar = {
+                name: '',
+                value: `❌ Error: ${error.message}`,
+                variablesReference: 0,
+                childVariables: []
+            };
+            v.childVariables = [tempVar];
+            v.namedVariables = 1;
+            v.indexedVariables = 0;
+        }
+        // Mark the scope as resolved so we don't re-fetch the variables
+        v.isResolved = true;
+        // If the scope has no children, add a single child to indicate there are no values
+        if (v.childVariables.length === 0) {
+            tempVar = {
+                name: '',
+                value: `No values for scope '${v.name}'`,
+                variablesReference: 0,
+                childVariables: []
+            };
+            v.childVariables = [tempVar];
+            v.namedVariables = 1;
+            v.indexedVariables = 0;
+        }
+    }
     getNextVarIndex(frameId) {
         if (!this.evaluateVarIndexByFrameId.has(frameId)) {
             this.evaluateVarIndexByFrameId.set(frameId, 0);
@@ -1323,7 +1371,7 @@ class BrightScriptDebugSession extends debugadapter_1.DebugSession {
         //ensure the rokuAdapter is loaded
         await this.getRokuAdapter();
         let deferred = (0, util_1.defer)();
-        if (args.context === 'repl' && !this.enableDebugProtocol && args.expression.trim().startsWith('>')) {
+        if (args.context === 'repl' && this.rokuAdapter.isTelnetAdapter() && args.expression.trim().startsWith('>')) {
             this.clearState();
             this.rokuAdapter.clearCache();
             const expression = args.expression.replace(/^\s*>\s*/, '');
@@ -1893,7 +1941,7 @@ class BrightScriptDebugSession extends debugadapter_1.DebugSession {
         var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
         let v;
         if (result) {
-            if (this.enableDebugProtocol) {
+            if (this.rokuAdapter.isDebugProtocolAdapter()) {
                 let refId = this.getEvaluateRefId(result.evaluateName, frameId);
                 if (result.isCustom && !((_a = result.presentationHint) === null || _a === void 0 ? void 0 : _a.lazy) && result.evaluateNow) {
                     try {
@@ -1953,7 +2001,7 @@ class BrightScriptDebugSession extends debugadapter_1.DebugSession {
                 }
                 this.variables[refId] = v;
             }
-            else {
+            else if (this.rokuAdapter.isTelnetAdapter()) {
                 if (result.highLevelType === 'primative' || result.highLevelType === 'uninitialized') {
                     v = new debugadapter_1.Variable(result.name, `${result.value}`);
                 }