roku-debug 0.21.17 → 0.21.19

package/dist/debugSession/BrightScriptDebugSession.js

@@ -23,6 +23,9 @@ const logging_1 = require("../logging");
 const VariablesResponse_1 = require("../debugProtocol/events/responses/VariablesResponse");
 const brighterscript_1 = require("brighterscript");
 const debounce_1 = require("debounce");
+const roku_types_1 = require("brighterscript/dist/roku-types");
+const globalCallables_1 = require("brighterscript/dist/globalCallables");
+const BscProjectWorkerPool_1 = require("../bsc/threading/BscProjectWorkerPool");
 const diagnosticSource = 'roku-debug';
 class BrightScriptDebugSession extends debugadapter_1.DebugSession {
     constructor() {
@@ -73,7 +76,10 @@ class BrightScriptDebugSession extends debugadapter_1.DebugSession {
         this.breakpointManager = new BreakpointManager_1.BreakpointManager(this.sourceMapManager, this.locationManager);
         //send newly-verified breakpoints to vscode
         this.breakpointManager.on('breakpoints-verified', (data) => this.onDeviceBreakpointsChanged('changed', data));
-        this.projectManager = new ProjectManager_1.ProjectManager(this.breakpointManager, this.locationManager);
+        this.projectManager = new ProjectManager_1.ProjectManager({
+            breakpointManager: this.breakpointManager,
+            locationManager: this.locationManager
+        });
         this.fileLoggingManager = new logging_1.FileLoggingManager();
     }
     onDeviceBreakpointsChanged(eventName, data) {
@@ -143,6 +149,8 @@ class BrightScriptDebugSession extends debugadapter_1.DebugSession {
         response.body.supportsHitConditionalBreakpoints = true;
         // This debug adapter supports log points by interpreting the 'logMessage' attribute of the SourceBreakpoint
         response.body.supportsLogPoints = true;
+        response.body.supportsCompletionsRequest = true;
+        response.body.completionTriggerCharacters = ['.', '(', '{', ',', ' '];
         this.sendResponse(response);
         //register the debug output log transport writer
         logging_1.debugServerLogOutputEventTransport.setWriter((message) => {
@@ -245,7 +253,7 @@ class BrightScriptDebugSession extends debugadapter_1.DebugSession {
      * @returns
      */
     normalizeLaunchConfig(config) {
-        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o;
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p;
         (_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`);
@@ -259,14 +267,17 @@ class BrightScriptDebugSession extends debugadapter_1.DebugSession {
         (_l = config.emitChannelPublishedEvent) !== null && _l !== void 0 ? _l : (config.emitChannelPublishedEvent = true);
         (_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);
         return config;
     }
     async launchRequest(response, config) {
-        var _a, _b;
-        this.logger.log('[launchRequest] begin');
+        var _a, _b, _c, _d, _e;
+        const logEnd = this.logger.timeStart('log', '[launchRequest] launch');
         //send the response right away so the UI immediately shows the debugger toolbar
         this.sendResponse(response);
         this.launchConfiguration = this.normalizeLaunchConfig(config);
+        //prebake some threads for our ProjectManager to use later on (1 for the main project, and 1 for every complib)
+        BscProjectWorkerPool_1.bscProjectWorkerPool.preload(1 + ((_c = (_b = (_a = this.launchConfiguration) === null || _a === void 0 ? void 0 : _a.componentLibraries) === null || _b === void 0 ? void 0 : _b.length) !== null && _c !== void 0 ? _c : 0));
         //set the logLevel provided by the launch config
         if (this.launchConfiguration.logLevel) {
             logging_1.logger.logLevel = this.launchConfiguration.logLevel;
@@ -289,7 +300,7 @@ class BrightScriptDebugSession extends debugadapter_1.DebugSession {
             return this.shutdown(`Developer mode is not enabled for host '${this.launchConfiguration.host}'.`);
         }
         //initialize all file logging (rokuDevice, debugger, etc)
-        this.fileLoggingManager.activate((_a = this.launchConfiguration) === null || _a === void 0 ? void 0 : _a.fileLogging, this.cwd);
+        this.fileLoggingManager.activate((_d = this.launchConfiguration) === null || _d === void 0 ? void 0 : _d.fileLogging, this.cwd);
         this.projectManager.launchConfiguration = this.launchConfiguration;
         this.breakpointManager.launchConfiguration = this.launchConfiguration;
         this.sendEvent(new Events_1.LaunchStartEvent(this.launchConfiguration));
@@ -309,7 +320,13 @@ class BrightScriptDebugSession extends debugadapter_1.DebugSession {
             else {
                 util_1.util.log(`Connecting to Roku via telnet at ${this.launchConfiguration.host}:${this.launchConfiguration.brightScriptConsolePort}`);
             }
-            await this.initRendezvousTracking();
+            //activate rendezvous tracking (if enabled). Log the error and move on if it crashes, this shouldn't bring down the session.
+            try {
+                await this.initRendezvousTracking();
+            }
+            catch (e) {
+                this.logger.error('Failed to initialize rendezvous tracking', e);
+            }
             this.createRokuAdapter(this.rendezvousTracker);
             await this.connectRokuAdapter();
             await this.runAutomaticSceneGraphCommands(this.launchConfiguration.autoRunSgDebugCommands);
@@ -401,9 +418,10 @@ class BrightScriptDebugSession extends debugadapter_1.DebugSession {
                 util_1.util.log(e === null || e === void 0 ? void 0 : e.stack);
                 this.sendErrorResponse(response, -1, e === null || e === void 0 ? void 0 : e.stack);
                 //send any compile errors to the client
-                await ((_b = this.rokuAdapter) === null || _b === void 0 ? void 0 : _b.sendErrors());
+                await ((_e = this.rokuAdapter) === null || _e === void 0 ? void 0 : _e.sendErrors());
             }
         }
+        logEnd();
         //at this point, the project has been deployed. If we need to use a deep link, launch it now.
         if (this.launchConfiguration.deepLinkUrl) {
             //wait until the first entry breakpoint has been hit
@@ -733,7 +751,8 @@ class BrightScriptDebugSession extends debugadapter_1.DebugSession {
             injectRdbOnDeviceComponent: this.launchConfiguration.injectRdbOnDeviceComponent,
             rdbFilesBasePath: this.launchConfiguration.rdbFilesBasePath,
             stagingDir: this.launchConfiguration.stagingDir,
-            packagePath: this.launchConfiguration.packagePath
+            packagePath: this.launchConfiguration.packagePath,
+            enhanceREPLCompletions: this.launchConfiguration.enhanceREPLCompletions
         });
         util_1.util.log('Moving selected files to staging area');
         await this.projectManager.mainProject.stage();
@@ -804,7 +823,8 @@ class BrightScriptDebugSession extends debugadapter_1.DebugSession {
                     bsConst: componentLibrary.bsConst,
                     injectRaleTrackerTask: componentLibrary.injectRaleTrackerTask,
                     raleTrackerTaskFileLocation: componentLibrary.raleTrackerTaskFileLocation,
-                    libraryIndex: libraryIndex
+                    libraryIndex: libraryIndex,
+                    enhanceREPLCompletions: this.launchConfiguration.enhanceREPLCompletions
                 }));
             }
             //prepare all of the libraries in parallel
@@ -1430,6 +1450,246 @@ class BrightScriptDebugSession extends debugadapter_1.DebugSession {
         }
         return results;
     }
+    async completionsRequest(response, args, request) {
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+        this.logger.log('completionsRequest', args, request);
+        // this.sendEvent(new LogOutputEvent(`completionsRequest: ${args.text}`));
+        // this.sendEvent(new OutputEvent(`completionsRequest: ${args.text}\n`, 'stderr'));
+        try {
+            let supplyLocalScopeCompletions = false;
+            let closestCompletionDetails = this.getClosestCompletionDetails(args);
+            if (!closestCompletionDetails) {
+                // If the cursor is not at the end of the line, then we should not supply completions at this time
+                response.body = {
+                    targets: []
+                };
+                return this.sendResponse(response);
+            }
+            let completions = new Map();
+            let parentVariablePath = closestCompletionDetails.parentVariablePath;
+            // Get the completions if the variable path was valid
+            if (parentVariablePath) {
+                // If the parent variable path is an empty string, then we are looking up the local scope variables and global functions
+                if (parentVariablePath.length === 1 && parentVariablePath[0] === '') {
+                    supplyLocalScopeCompletions = true;
+                }
+                // Look up the parent variable
+                let parentVariable = this.findVariableByPath(Object.values(this.variables), parentVariablePath, args.frameId);
+                if (!parentVariable || parentVariable.childVariables.length === 0) {
+                    // We did not find the parent variable, so try to look it up from the device
+                    try {
+                        let { evalArgs } = await this.evaluateExpressionToTempVar({ expression: parentVariablePath.join('.'), frameId: args.frameId }, parentVariablePath);
+                        let result = await this.rokuAdapter.getVariable(evalArgs.expression, args.frameId);
+                        parentVariable = await this.getVariableFromResult(result, args.frameId);
+                    }
+                    catch (error) {
+                        this.logger.error('Error looking up parent completions', error, { parentVariablePath });
+                    }
+                }
+                // provide completions for the parent variable if one was found
+                if (parentVariable) {
+                    let possibleFieldsAndMethods = [];
+                    // Filter out virtual variables
+                    possibleFieldsAndMethods = parentVariable.childVariables.filter((v) => { var _a; return ((_a = v.presentationHint) === null || _a === void 0 ? void 0 : _a.kind) !== 'virtual'; });
+                    for (let v of possibleFieldsAndMethods) {
+                        // Default completion type should be variable
+                        let completionType = 'variable';
+                        if (!supplyLocalScopeCompletions) {
+                            // We are not supplying local scope completions, so we need to determine the completion type relative to the parent variable
+                            if (parentVariable.type === 'roSGNode' || parentVariable.type === VariablesResponse_1.VariableType.AssociativeArray || parentVariable.type === VariablesResponse_1.VariableType.Object) {
+                                completionType = 'field';
+                            }
+                            switch (v.type) {
+                                case VariablesResponse_1.VariableType.Function:
+                                case VariablesResponse_1.VariableType.Subroutine:
+                                    completionType = 'method';
+                                    break;
+                                default:
+                                    break;
+                            }
+                        }
+                        let label = v.name;
+                        if (parentVariable.type === VariablesResponse_1.VariableType.Array ||
+                            parentVariable.type === VariablesResponse_1.VariableType.List ||
+                            parentVariable.type === 'roXMLList' ||
+                            parentVariable.type === 'roByteArray') {
+                            label = `[${v.name}]`;
+                        }
+                        completions.set(`${completionType}-${v.name}`, {
+                            label: label,
+                            type: completionType,
+                            sortText: '000000'
+                        });
+                    }
+                    let parentComponentType = this.debuggerVarTypeToRoType(parentVariable.type).toLowerCase();
+                    //assemble a list of all methods on the parent component
+                    const methods = [
+                        //if the parent variable is an actual interface (if applicable) Ex: `ifString` or `ifArray`
+                        ...(_b = (_a = roku_types_1.interfaces[parentComponentType]) === null || _a === void 0 ? void 0 : _a.methods) !== null && _b !== void 0 ? _b : [],
+                        //interfaces from component of this name (if applicable) Ex: `roSGNode` or `roDateTime`
+                        ...(_d = (_c = roku_types_1.components[parentComponentType]) === null || _c === void 0 ? void 0 : _c.interfaces.map((i) => { var _a; return (_a = roku_types_1.interfaces[i.name.toLowerCase()]) === null || _a === void 0 ? void 0 : _a.methods; })) !== null && _d !== void 0 ? _d : [],
+                        // Add parent event function completions (if applicable) Ex: `roSGNodeEvent` or `roDeviceInfoEvent`
+                        ...(_f = (_e = roku_types_1.events[parentComponentType]) === null || _e === void 0 ? void 0 : _e.methods) !== null && _f !== void 0 ? _f : []
+                    ].flat();
+                    // Based on the results of interface, component, and event looks up, add all the methods to the completions
+                    for (const method of methods) {
+                        completions.set(`method-${method.name}`, {
+                            label: method.name,
+                            type: 'method',
+                            detail: (_g = method.description) !== null && _g !== void 0 ? _g : '',
+                            sortText: '000000'
+                        });
+                    }
+                    // Add the global functions to the completions results
+                    if (supplyLocalScopeCompletions) {
+                        for (let globalCallable of globalCallables_1.globalCallables) {
+                            completions.set(`function-${globalCallable.name.toLocaleLowerCase()}`, {
+                                label: globalCallable.name,
+                                type: 'function',
+                                detail: (_j = (_h = globalCallable.shortDescription) !== null && _h !== void 0 ? _h : globalCallable.documentation) !== null && _j !== void 0 ? _j : '',
+                                sortText: '000000'
+                            });
+                        }
+                        const frame = this.rokuAdapter.getStackFrameById(args.frameId);
+                        let scopeFunctions = await this.projectManager.getScopeFunctionsForFile(frame.filePath);
+                        for (let scopeFunction of scopeFunctions) {
+                            if (!completions.has(`${scopeFunction.completionItemKind}-${scopeFunction.name.toLocaleLowerCase()}`)) {
+                                completions.set(`${scopeFunction.completionItemKind}-${scopeFunction.name.toLocaleLowerCase()}`, {
+                                    label: scopeFunction.name,
+                                    type: scopeFunction.completionItemKind,
+                                    sortText: '000000'
+                                });
+                            }
+                        }
+                    }
+                }
+            }
+            // this.sendEvent(new LogOutputEvent(`text: ${args.text} | completions: ${completions.map(v => v.label).join(', ')}`));
+            // this.sendEvent(new OutputEvent(`text: ${args.text} | completions: ${completions.map(v => v.label).join(', ')}\n`, 'stderr'));
+            response.body = {
+                targets: [...completions.values()]
+            };
+        }
+        catch (error) {
+            // this.sendEvent(new LogOutputEvent(`text: ${args.text} | ${error}`));
+            // this.sendEvent(new OutputEvent(`text: ${args.text} | ${error}\n`, 'stderr'));
+            this.logger.error('Error during completionsRequest', error, { args });
+        }
+        this.sendResponse(response);
+    }
+    /**
+     * Gets the closest completion details the incoming completion request.
+     */
+    getClosestCompletionDetails(args) {
+        var _a;
+        const incomingText = args.text;
+        const lines = incomingText.split('\n');
+        let lineNumber = (_a = args.line) !== null && _a !== void 0 ? _a : (this.initRequestArgs.linesStartAt1 ? 1 : 0);
+        let column = args.column;
+        // Make sure to correct the line and column to 0-based
+        // if they are being sent as 1-based from the client
+        if (this.initRequestArgs.linesStartAt1) {
+            lineNumber--;
+        }
+        if (this.initRequestArgs.columnsStartAt1) {
+            column--;
+        }
+        const targetLine = lines[lineNumber];
+        let variablePathString = '';
+        let i = column - 1;
+        const variableChars = /[a-z0-9_\.]/i;
+        // If the character at immediate to the right of the cursor is a variable character, then we are not at the end of the variable path.
+        if (targetLine.length - 1 > i && variableChars.test(targetLine[i + 1])) {
+            return undefined;
+        }
+        // Find the start of the variable path by looking for the first non-alphanumeric or non_underscore character before the cursor
+        while (i >= 0 && (variableChars.test(targetLine[i]))) {
+            i--;
+        }
+        // Pull the variable path string from the line
+        variablePathString = targetLine.slice(i + 1, column);
+        // Attempted dot access something unexpected
+        // Example: `getPerson().name` where `getPerson()` is not a valid variable
+        // and results in `.name` being the variable path string
+        if (variablePathString.startsWith('.')) {
+            return undefined;
+        }
+        // Get the variable path from the text
+        let variablePath = [];
+        if (!variablePathString.trim()) {
+            // The text was empty so assume via '' that we are looking up the local scope variables and global functions
+            variablePath = [''];
+        }
+        else if (variablePathString.endsWith('.')) {
+            // supplied text ends with a period, so strip it off to create a valid variable path
+            variablePath = util_1.util.getVariablePath(variablePathString.slice(0, -1));
+        }
+        else {
+            variablePath = util_1.util.getVariablePath(variablePathString);
+        }
+        // the target string is not a valid variable path
+        if (!variablePath) {
+            return undefined;
+        }
+        let parentVariablePath;
+        // If the last character is a period, then pull completions for the parent variable before the period
+        if (variablePathString.endsWith('.')) {
+            parentVariablePath = variablePath;
+        }
+        else {
+            // Otherwise, pull completions for the parent variable
+            parentVariablePath = variablePath.slice(0, variablePath.length - 1);
+        }
+        // If the parent variable path is empty or an empty string, then we are looking up the local scope variables and global functions
+        if (parentVariablePath.length === 0) {
+            parentVariablePath = [''];
+        }
+        return { parentVariablePath: parentVariablePath };
+    }
+    findVariableByPath(variables, path, frameId) {
+        var _a;
+        let current = null;
+        for (const name of path) {
+            // Find the object matching the current name in the data
+            current = (_a = (Array.isArray(variables) ? variables : current === null || current === void 0 ? void 0 : current.childVariables)) === null || _a === void 0 ? void 0 : _a.find(obj => {
+                return obj.name === name && obj.frameId === frameId;
+            });
+            // If no match is found, return null
+            if (!current) {
+                return null;
+            }
+            // Move to the children for the next iteration
+            variables = current.childVariables;
+        }
+        return current;
+    }
+    debuggerVarTypeToRoType(type) {
+        switch (type) {
+            case VariablesResponse_1.VariableType.Function:
+            case VariablesResponse_1.VariableType.Subroutine:
+                return 'roFunction';
+            case VariablesResponse_1.VariableType.AssociativeArray:
+                return 'roAssociativeArray';
+            case VariablesResponse_1.VariableType.List:
+                return 'roList';
+            case VariablesResponse_1.VariableType.Array:
+                return 'roArray';
+            case VariablesResponse_1.VariableType.Boolean:
+                return 'roBoolean';
+            case VariablesResponse_1.VariableType.Double:
+                return 'roDouble';
+            case VariablesResponse_1.VariableType.Float:
+                return 'roFloat';
+            case VariablesResponse_1.VariableType.Integer:
+                return 'roInteger';
+            case VariablesResponse_1.VariableType.LongInteger:
+                return 'roLongInteger';
+            case VariablesResponse_1.VariableType.String:
+                return 'roString';
+            default:
+                return type;
+        }
+    }
     /**
      * Called when the host stops debugging
      * @param response
@@ -1762,19 +2022,35 @@ class BrightScriptDebugSession extends debugadapter_1.DebugSession {
         return this.shutdownPromise;
     }
     async _shutdown(errorMessage, modal = false) {
-        var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
+        try {
+            (_b = (_a = this.projectManager) === null || _a === void 0 ? void 0 : _a.dispose) === null || _b === void 0 ? void 0 : _b.call(_a);
+        }
+        catch (e) {
+            this.logger.error(e);
+        }
+        try {
+            (_c = this.componentLibraryServer) === null || _c === void 0 ? void 0 : _c.stop();
+        }
+        catch (e) {
+            this.logger.error(e);
+        }
+        try {
+            void ((_e = (_d = this.rendezvousTracker) === null || _d === void 0 ? void 0 : _d.destroy) === null || _e === void 0 ? void 0 : _e.call(_d));
+        }
+        catch (e) {
+            this.logger.error(e);
+        }
+        try {
+            (_g = (_f = this.sourceMapManager) === null || _f === void 0 ? void 0 : _f.destroy) === null || _g === void 0 ? void 0 : _g.call(_f);
+        }
+        catch (e) {
+            this.logger.error(e);
+        }
         try {
-            (_a = this.componentLibraryServer) === null || _a === void 0 ? void 0 : _a.stop();
-            void ((_c = (_b = this.rendezvousTracker) === null || _b === void 0 ? void 0 : _b.destroy) === null || _c === void 0 ? void 0 : _c.call(_b));
-            try {
-                (_e = (_d = this.sourceMapManager) === null || _d === void 0 ? void 0 : _d.destroy) === null || _e === void 0 ? void 0 : _e.call(_d);
-            }
-            catch (e) {
-                this.logger.error(e);
-            }
             //if configured, delete the staging directory
             if (!this.launchConfiguration.retainStagingFolder) {
-                const stagingDirs = (_g = (_f = this.projectManager) === null || _f === void 0 ? void 0 : _f.getStagingDirs()) !== null && _g !== void 0 ? _g : [];
+                const stagingDirs = (_j = (_h = this.projectManager) === null || _h === void 0 ? void 0 : _h.getStagingDirs()) !== null && _j !== void 0 ? _j : [];
                 this.logger.info('deleting staging folders', stagingDirs);
                 for (let stagingDir of stagingDirs) {
                     try {
@@ -1786,13 +2062,23 @@ class BrightScriptDebugSession extends debugadapter_1.DebugSession {
                     }
                 }
             }
+        }
+        catch (e) {
+            this.logger.error(e);
+        }
+        try {
             //if there was an error message, display it to the user
             if (errorMessage) {
                 this.logger.error(errorMessage);
                 this.showPopupMessage(errorMessage, 'error', modal);
             }
+        }
+        catch (e) {
+            this.logger.error(e);
+        }
+        try {
             this.logger.log('Destroy rokuAdapter');
-            await ((_j = (_h = this.rokuAdapter) === null || _h === void 0 ? void 0 : _h.destroy) === null || _j === void 0 ? void 0 : _j.call(_h));
+            await ((_l = (_k = this.rokuAdapter) === null || _k === void 0 ? void 0 : _k.destroy) === null || _l === void 0 ? void 0 : _l.call(_k));
             //press the home button to return to the home screen
             try {
                 this.logger.log('Press home button');
@@ -1801,6 +2087,11 @@ class BrightScriptDebugSession extends debugadapter_1.DebugSession {
             catch (e) {
                 this.logger.error(e);
             }
+        }
+        catch (e) {
+            this.logger.error(e);
+        }
+        try {
             this.logger.log('Send terminated event');
             this.sendEvent(new debugadapter_1.TerminatedEvent());
             //shut down the process