roku-debug 0.22.5 → 0.22.7

package/dist/debugSession/BrightScriptDebugSession.js

@@ -4,6 +4,7 @@ exports.BrightScriptDebugSession = void 0;
 const fsExtra = require("fs-extra");
 const natural_orderby_1 = require("natural-orderby");
 const path = require("path");
+const semver = require("semver");
 const roku_deploy_1 = require("roku-deploy");
 const debugadapter_1 = require("@vscode/debugadapter");
 const SceneGraphDebugCommandController_1 = require("../SceneGraphDebugCommandController");
@@ -19,6 +20,7 @@ const FileManager_1 = require("../managers/FileManager");
 const SourceMapManager_1 = require("../managers/SourceMapManager");
 const LocationManager_1 = require("../managers/LocationManager");
 const BreakpointManager_1 = require("../managers/BreakpointManager");
+const PerfettoManager_1 = require("../PerfettoManager");
 const logging_1 = require("../logging");
 const VariablesResponse_1 = require("../debugProtocol/events/responses/VariablesResponse");
 const brighterscript_1 = require("brighterscript");
@@ -106,6 +108,14 @@ class BrightScriptDebugSession extends debugadapter_1.DebugSession {
     get enableDebugProtocol() {
         return this.launchConfiguration.enableDebugProtocol;
     }
+    /**
+     * Check if the Roku firmware supports Perfetto tracing (requires OS 15.2 or higher)
+     */
+    get supportsPerfettoTracing() {
+        var _a, _b;
+        this.logger.log('Checking if device supports Perfetto tracing', this.deviceInfo.softwareVersion);
+        return semver.satisfies((_b = (_a = this.deviceInfo) === null || _a === void 0 ? void 0 : _a.softwareVersion) !== null && _b !== void 0 ? _b : '0.0', '>= 15.2');
+    }
     /**
      * Get a promise that resolves when the roku adapter is ready to be used
      */
@@ -121,7 +131,7 @@ class BrightScriptDebugSession extends debugadapter_1.DebugSession {
     initializeRequest(response, args) {
         this.initRequestArgs = args;
         this.logger.log('initializeRequest');
-        response.body = response.body || {};
+        response.body || (response.body = {});
         // This debug adapter implements the configurationDoneRequest.
         response.body.supportsConfigurationDoneRequest = true;
         // The debug adapter supports the 'restart' request. In this case a client should not implement 'restart' by terminating and relaunching the adapter but by calling the RestartRequest.
@@ -258,7 +268,8 @@ class BrightScriptDebugSession extends debugadapter_1.DebugSession {
      * @returns
      */
     normalizeLaunchConfig(config) {
-        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r;
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u, _v;
+        var _w, _x;
         (_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`);
@@ -274,11 +285,16 @@ class BrightScriptDebugSession extends debugadapter_1.DebugSession {
         (_o = config.autoResolveVirtualVariables) !== null && _o !== void 0 ? _o : (config.autoResolveVirtualVariables = false);
         (_p = config.enhanceREPLCompletions) !== null && _p !== void 0 ? _p : (config.enhanceREPLCompletions = true);
         (_q = config.username) !== null && _q !== void 0 ? _q : (config.username = 'rokudev');
+        if ((_s = (_r = config.profiling) === null || _r === void 0 ? void 0 : _r.tracing) === null || _s === void 0 ? void 0 : _s.enable) {
+            (_t = (_w = config.profiling.tracing).dir) !== null && _t !== void 0 ? _t : (_w.dir = (0, FileUtils_1.standardizePath) `${config.cwd}/traces/`);
+            // eslint-disable-next-line no-template-curly-in-string
+            (_u = (_x = config.profiling.tracing).filename) !== null && _u !== void 0 ? _u : (_x.filename = '${appTitle}_${timestamp}.perfetto-trace');
+        }
         // migrate the old `enableVariablesPanel` setting to the new `deferScopeLoading` setting
         if (typeof config.enableVariablesPanel !== 'boolean') {
             config.enableVariablesPanel = true;
         }
-        (_r = config.deferScopeLoading) !== null && _r !== void 0 ? _r : (config.deferScopeLoading = config.enableVariablesPanel === false);
+        (_v = config.deferScopeLoading) !== null && _v !== void 0 ? _v : (config.deferScopeLoading = config.enableVariablesPanel === false);
         return config;
     }
     async launchRequest(response, config) {
@@ -304,13 +320,20 @@ class BrightScriptDebugSession extends debugadapter_1.DebugSession {
         // fetches the device info and parses the xml data to JSON object
         try {
             this.deviceInfo = await roku_deploy_1.rokuDeploy.getDeviceInfo({ host: this.launchConfiguration.host, remotePort: this.launchConfiguration.remotePort, enhance: true, timeout: 4000 });
+            if (this.deviceInfo.ecpSettingMode === 'limited') {
+                return await this.shutdown(`ECP access is limited on this Roku. Please change it to 'permissive' or 'enabled' and try again. (device: ${this.launchConfiguration.host})`);
+            }
         }
         catch (e) {
+            if (e instanceof roku_deploy_1.EcpNetworkAccessModeDisabledError) {
+                return this.shutdown(`ECP access is disabled on this Roku. Please change it to 'permissive' or 'enabled' and try again. (device: ${this.launchConfiguration.host})`);
+            }
             return this.shutdown(`Unable to connect to roku at '${this.launchConfiguration.host}'. Verify the IP address is correct and that the device is powered on and connected to same network as this computer.`);
         }
         if (this.deviceInfo && !this.deviceInfo.developerEnabled) {
             return this.shutdown(`Developer mode is not enabled for host '${this.launchConfiguration.host}'.`);
         }
+        await this.initializeProfiling();
         //initialize all file logging (rokuDevice, debugger, etc)
         this.fileLoggingManager.activate((_d = this.launchConfiguration) === null || _d === void 0 ? void 0 : _d.fileLogging, this.cwd);
         this.projectManager.launchConfiguration = this.launchConfiguration;
@@ -320,6 +343,7 @@ class BrightScriptDebugSession extends debugadapter_1.DebugSession {
         this.logger.log('[launchRequest] Packaging and deploying to roku');
         try {
             const packageEnd = this.logger.timeStart('log', 'Packaging');
+            this.sendLaunchProgress('start', 'Packaging');
             //build the main project and all component libraries at the same time
             await Promise.all([
                 this.prepareMainProject(),
@@ -353,12 +377,12 @@ class BrightScriptDebugSession extends debugadapter_1.DebugSession {
             //pass along the console output
             if (this.launchConfiguration.consoleOutput === 'full') {
                 this.rokuAdapter.on('console-output', (data) => {
-                    void this.sendLogOutput(data);
+                    this.sendLogOutput(data).catch(e => this.logger.error('Failed to send log output', e));
                 });
             }
             else {
                 this.rokuAdapter.on('unhandled-console-output', (data) => {
-                    void this.sendLogOutput(data);
+                    this.sendLogOutput(data).catch(e => this.logger.error('Failed to send log output', e));
                 });
             }
             this.rokuAdapter.on('device-unresponsive', async (data) => {
@@ -386,7 +410,7 @@ class BrightScriptDebugSession extends debugadapter_1.DebugSession {
             });
             // handle any compile errors
             this.rokuAdapter.on('diagnostics', (diagnostics) => {
-                void this.handleDiagnostics(diagnostics);
+                this.handleDiagnostics(diagnostics).catch(e => this.logger.error('Failed to handle diagnostics', e));
             });
             // close disconnect if required when the app is exited
             // eslint-disable-next-line @typescript-eslint/no-misused-promises
@@ -403,17 +427,21 @@ class BrightScriptDebugSession extends debugadapter_1.DebugSession {
                     const message = 'App exit detected; but launchConfiguration.stopDebuggerOnAppExit is set to false, so keeping debug session running.';
                     this.logger.log('[launchRequest]', message);
                     this.sendEvent(new Events_1.LogOutputEvent(message));
-                    void this.rokuAdapter.once('connected').then(async () => {
+                    this.rokuAdapter.once('connected').then(async () => {
                         await this.rokuAdapter.setExceptionBreakpoints(this.exceptionBreakpoints);
-                    });
+                    }).catch(e => this.logger.error('Failed to set exception breakpoints after reconnect', e));
                 }
             });
+            //profiling supports connecting to the socket BEFORE a channel is published, so go ahead and connect now
+            await this.tryProfilingConnectOnStart();
+            this.sendLaunchProgress('update', 'Uploading to Roku');
             await this.publish();
             //hack for certain roku devices that lock up when this event is emitted (no idea why!).
             if (this.launchConfiguration.emitChannelPublishedEvent) {
                 this.sendEvent(new Events_1.ChannelPublishedEvent(this.launchConfiguration));
             }
             //tell the adapter adapter that the channel has been launched.
+            this.sendLaunchProgress('update', 'Waiting on application');
             await this.rokuAdapter.activate();
             if (this.rokuAdapter.isDestroyed) {
                 throw new Error('Debug session encountered an error');
@@ -436,7 +464,7 @@ class BrightScriptDebugSession extends debugadapter_1.DebugSession {
                 throw error;
             }
             //at this point, the project has been deployed. If we need to use a deep link, launch it now.
-            if (this.launchConfiguration.deepLinkUrl) {
+            if (this.launchConfiguration.deepLinkUrl && !this.enableDebugProtocol) {
                 //wait until the first entry breakpoint has been hit
                 await this.firstRunDeferred.promise;
                 //if we are at a breakpoint, continue
@@ -459,9 +487,80 @@ class BrightScriptDebugSession extends debugadapter_1.DebugSession {
                 const message = (e instanceof Exceptions_1.SocketConnectionInUseError) ? e.message : ((_f = e === null || e === void 0 ? void 0 : e.stack) !== null && _f !== void 0 ? _f : e);
                 await this.shutdown(message, true);
             }
+            else {
+                this.sendLaunchProgress('end', 'Aborted (compile error)');
+            }
         }
         logEnd();
     }
+    /**
+     * Activate all required functionality for profiling
+     */
+    async initializeProfiling() {
+        var _a, _b, _c, _d, _e;
+        // Initialize PerfettoManager
+        this.perfettoManager = new PerfettoManager_1.PerfettoManager({
+            host: this.launchConfiguration.host,
+            rootDir: this.launchConfiguration.rootDir,
+            remotePort: this.launchConfiguration.remotePort,
+            ...(_a = this.launchConfiguration.profiling) === null || _a === void 0 ? void 0 : _a.tracing
+        });
+        //send certain profiling events back to the client
+        this.perfettoManager.on('enable', (event) => {
+            this.sendEvent(new Events_1.ProfilingEnabledEvent({
+                types: event.types
+            }));
+        });
+        this.perfettoManager.on('start', (event) => {
+            this.sendEvent(new Events_1.ProfilingStartEvent({
+                type: event.type
+            }));
+        });
+        this.perfettoManager.on('stop', (event) => {
+            this.sendEvent(new Events_1.ProfilingStopEvent({
+                type: event.type,
+                result: event.result
+            }));
+        });
+        this.perfettoManager.on('error', (event) => {
+            this.sendEvent(new Events_1.ProfilingErrorEvent({
+                error: event.error
+            }));
+        });
+        //tracing is explicitly enabled. Turn it on
+        if (((_c = (_b = this.launchConfiguration.profiling) === null || _b === void 0 ? void 0 : _b.tracing) === null || _c === void 0 ? void 0 : _c.enable) && this.supportsPerfettoTracing) {
+            this.logger.info('Enabling perfetto tracing because it is supported by the device and enabled in the launch configuration');
+            try {
+                await this.perfettoManager.enableTracing();
+            }
+            catch (e) {
+                this.logger.error('Failed to enable perfetto tracing', e);
+            }
+            //tracing is expicitly DISabled. turn it off
+        }
+        else if (((_e = (_d = this.launchConfiguration.profiling) === null || _d === void 0 ? void 0 : _d.tracing) === null || _e === void 0 ? void 0 : _e.enable) === false && this.supportsPerfettoTracing) {
+            this.logger.info('Disabling perfetto tracing because it is disabled in the launch configuration');
+            //TODO implement a way to disable perfetto tracing on the device
+            //profiling.tracing.enabled is set to `undefined`, which means we should do nothing
+        }
+        else {
+            this.logger.info('Skipping perfetto initalization because `profiling.tracing.enable` is not defined in the launch configuration');
+        }
+    }
+    /**
+     * If profiling was marked "connectOnStart", try connecting right away
+     */
+    async tryProfilingConnectOnStart() {
+        var _a, _b;
+        if (((_b = (_a = this.launchConfiguration.profiling) === null || _a === void 0 ? void 0 : _a.tracing) === null || _b === void 0 ? void 0 : _b.connectOnStart) && this.supportsPerfettoTracing) {
+            try {
+                await this.perfettoManager.startTracing();
+            }
+            catch (e) {
+                this.logger.error('Failed to start perfetto tracing on start', e);
+            }
+        }
+    }
     /**
      * Clear certain properties that need reset whenever a debug session is restarted (via vscode or launched from the Roku home screen)
      */
@@ -528,6 +627,7 @@ class BrightScriptDebugSession extends debugadapter_1.DebugSession {
         //find the first compile error (i.e. first DiagnosticSeverity.Error) if there is one
         this.compileError = diagnostics.find(x => x.severity === brighterscript_1.DiagnosticSeverity.Error);
         if (this.compileError) {
+            this.sendLaunchProgress('end', 'Aborted (compile error)');
             this.sendEvent(new debugadapter_1.StoppedEvent(Events_1.StoppedEventReason.exception, this.COMPILE_ERROR_THREAD_ID, `CompileError: ${this.compileError.message}`));
         }
         this.sendEvent(new Events_1.DiagnosticsEvent(diagnostics));
@@ -832,7 +932,7 @@ class BrightScriptDebugSession extends debugadapter_1.DebugSession {
      * Accepts custom events and requests from the extension
      * @param command name of the command to execute
      */
-    customRequest(command, response, args) {
+    async customRequest(command, response, args) {
         if (command === 'rendezvous.clearHistory') {
             this.rokuAdapter.clearRendezvousHistory();
         }
@@ -845,6 +945,27 @@ class BrightScriptDebugSession extends debugadapter_1.DebugSession {
         else if (command === 'popupMessageEventResponse') {
             this.emit('popupMessageEventResponse', args);
         }
+        else if (command === 'captureHeapSnapshot') {
+            this.perfettoManager.captureHeapSnapshot().catch((e) => this.logger.error('Failed to capture heap snapshot', e));
+        }
+        else if (command === 'startPerfettoTracing') {
+            try {
+                await this.perfettoManager.startTracing();
+            }
+            catch (e) {
+                response.success = false;
+                response.body = { message: (e === null || e === void 0 ? void 0 : e.message) || String(e) };
+            }
+        }
+        else if (command === 'stopPerfettoTracing') {
+            try {
+                await this.perfettoManager.stopTracing();
+            }
+            catch (e) {
+                response.success = false;
+                response.body = { message: (e === null || e === void 0 ? void 0 : e.message) || String(e) };
+            }
+        }
         this.sendResponse(response);
     }
     /**
@@ -1931,10 +2052,14 @@ class BrightScriptDebugSession extends debugadapter_1.DebugSession {
      */
     async connectRokuAdapter() {
         this.rokuAdapter.on('start', () => {
+            this.sendLaunchProgress('end', 'Complete');
             if (!this.firstRunDeferred.isCompleted) {
                 this.firstRunDeferred.resolve();
             }
         });
+        this.rokuAdapter.on('launch-status', (message) => {
+            this.sendLaunchProgress('update', message);
+        });
         //when the debugger suspends (pauses for debugger input)
         // eslint-disable-next-line @typescript-eslint/no-misused-promises
         this.rokuAdapter.on('suspend', async () => {
@@ -1951,7 +2076,7 @@ class BrightScriptDebugSession extends debugadapter_1.DebugSession {
         });
         // If the roku says it can't continue, we are no longer able to debug, so kill the debug session
         this.rokuAdapter.on('cannot-continue', () => {
-            void this.shutdown();
+            this.shutdown().catch(e => this.logger.error(e));
         });
         //make the connection
         await this.rokuAdapter.connect();
@@ -2191,6 +2316,35 @@ class BrightScriptDebugSession extends debugadapter_1.DebugSession {
         //erase all cached variables
         this.variables = {};
     }
+    /**
+     * Sends a launch progress event to the client if the client supports progress reporting.
+     * - `'start'`: begins a new progress bar with the given message. Assigns a new progressId.
+     * - `'update'`: updates the message on the active progress bar.
+     * - `'end'`: dismisses the active progress bar with an optional final message.
+     */
+    sendLaunchProgress(type, message) {
+        var _a;
+        if (!((_a = this.initRequestArgs) === null || _a === void 0 ? void 0 : _a.supportsProgressReporting)) {
+            return;
+        }
+        if (type === 'start') {
+            this.launchProgressId = `rokudebug-launch-${this.idCounter++}`;
+            this.sendEvent(new debugadapter_1.ProgressStartEvent(this.launchProgressId, 'Launching', `${message}...`));
+        }
+        else if (this.launchProgressId) {
+            if (type === 'update') {
+                this.sendEvent(new debugadapter_1.ProgressUpdateEvent(this.launchProgressId, `${message}...`));
+            }
+            else {
+                const lastId = this.launchProgressId;
+                this.sendEvent(new debugadapter_1.ProgressUpdateEvent(lastId, message));
+                setTimeout(() => {
+                    this.sendEvent(new debugadapter_1.ProgressEndEvent(lastId, message));
+                }, 1000); // add a slight delay before ending the progress to improve UX
+                this.launchProgressId = undefined;
+            }
+        }
+    }
     /**
      * Tells the client to re-request all variables because we've invalidated them
      * @param threadId
@@ -2274,7 +2428,9 @@ class BrightScriptDebugSession extends debugadapter_1.DebugSession {
         return this.shutdownPromise;
     }
     async _shutdown(errorMessage, modal = false) {
-        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o;
+        // Ensure any active launch progress bar is dismissed before showing error messages or the terminated event.
+        this.sendLaunchProgress('end', 'Complete');
         //send the message FIRST before anything else. This improves the chances that the message will be displayed to the user
         try {
             if (errorMessage) {
@@ -2287,10 +2443,23 @@ class BrightScriptDebugSession extends debugadapter_1.DebugSession {
         catch (e) {
             this.logger.error(e);
         }
+        // stop perfetto tracing if it's running
+        try {
+            await this.perfettoManager.stopTracing();
+        }
+        catch (e) {
+            this.logger.error('Error stopping perfetto tracing', e);
+        }
+        try {
+            await ((_b = (_a = this.perfettoManager) === null || _a === void 0 ? void 0 : _a.dispose) === null || _b === void 0 ? void 0 : _b.call(_a));
+        }
+        catch (e) {
+            this.logger.error('Error disposing perfetto manager', e);
+        }
         //close the debugger connection
         try {
             this.logger.log('Destroy rokuAdapter');
-            await ((_b = (_a = this.rokuAdapter) === null || _a === void 0 ? void 0 : _a.destroy) === null || _b === void 0 ? void 0 : _b.call(_a));
+            await ((_d = (_c = this.rokuAdapter) === null || _c === void 0 ? void 0 : _c.destroy) === null || _d === void 0 ? void 0 : _d.call(_c));
             //press the home button to return to the home screen
             try {
                 this.logger.log('Press home button');
@@ -2304,25 +2473,25 @@ class BrightScriptDebugSession extends debugadapter_1.DebugSession {
             this.logger.error(e);
         }
         try {
-            (_d = (_c = this.projectManager) === null || _c === void 0 ? void 0 : _c.dispose) === null || _d === void 0 ? void 0 : _d.call(_c);
+            (_f = (_e = this.projectManager) === null || _e === void 0 ? void 0 : _e.dispose) === null || _f === void 0 ? void 0 : _f.call(_e);
         }
         catch (e) {
             this.logger.error(e);
         }
         try {
-            (_e = this.componentLibraryServer) === null || _e === void 0 ? void 0 : _e.stop();
+            (_g = this.componentLibraryServer) === null || _g === void 0 ? void 0 : _g.stop();
         }
         catch (e) {
             this.logger.error(e);
         }
         try {
-            await ((_g = (_f = this.rendezvousTracker) === null || _f === void 0 ? void 0 : _f.destroy) === null || _g === void 0 ? void 0 : _g.call(_f));
+            await ((_j = (_h = this.rendezvousTracker) === null || _h === void 0 ? void 0 : _h.destroy) === null || _j === void 0 ? void 0 : _j.call(_h));
         }
         catch (e) {
             this.logger.error(e);
         }
         try {
-            await ((_j = (_h = this.sourceMapManager) === null || _h === void 0 ? void 0 : _h.destroy) === null || _j === void 0 ? void 0 : _j.call(_h));
+            await ((_l = (_k = this.sourceMapManager) === null || _k === void 0 ? void 0 : _k.destroy) === null || _l === void 0 ? void 0 : _l.call(_k));
         }
         catch (e) {
             this.logger.error(e);
@@ -2330,7 +2499,7 @@ class BrightScriptDebugSession extends debugadapter_1.DebugSession {
         try {
             //if configured, delete the staging directory
             if (!this.launchConfiguration.retainStagingFolder) {
-                const stagingDirs = (_l = (_k = this.projectManager) === null || _k === void 0 ? void 0 : _k.getStagingDirs()) !== null && _l !== void 0 ? _l : [];
+                const stagingDirs = (_o = (_m = this.projectManager) === null || _m === void 0 ? void 0 : _m.getStagingDirs()) !== null && _o !== void 0 ? _o : [];
                 this.logger.info('deleting staging folders', stagingDirs);
                 for (let stagingDir of stagingDirs) {
                     try {