roku-debug 0.23.7 → 0.23.9

package/dist/debugProtocol/client/ProtocolCapabilities.js

@@ -0,0 +1,106 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProtocolCapabilities = void 0;
+const semver = require("semver");
+/**
+ * Encapsulates the version-based capability checks for the BrightScript debug protocol.
+ * Used by `DebugProtocolClient` for the live session (version set during the handshake),
+ * and by `DebugProtocolAdapter` as a standalone fallback seeded from the device-info
+ * `brightscript-debugger-version` when no client has connected yet.
+ */
+class ProtocolCapabilities {
+    constructor(protocolVersion, osVersion) {
+        this.protocolVersion = ProtocolCapabilities.resolveProtocolVersion(protocolVersion, osVersion);
+    }
+    /**
+     * Some Roku firmware versions support the debug protocol but omit `brightscript-debugger-version`
+     * from device-info, so fall back to deriving the protocol version from the OS version when the
+     * caller didn't get one from the device.
+     */
+    static resolveProtocolVersion(protocolVersion, osVersion) {
+        if (semver.valid(protocolVersion)) {
+            return protocolVersion;
+        }
+        const coercedOs = osVersion ? semver.coerce(osVersion) : null;
+        if (!coercedOs) {
+            return protocolVersion;
+        }
+        for (const entry of ProtocolCapabilities.osToProtocolVersions) {
+            if (semver.gte(coercedOs, entry.os)) {
+                return entry.protocol;
+            }
+        }
+        return protocolVersion;
+    }
+    /**
+     * Prior to protocol v3.1.0, the Roku device would regularly set the wrong thread as "active",
+     * so this flag lets us know if we should use our better-than-nothing workaround
+     */
+    get enableThreadHoppingWorkaround() {
+        return semver.satisfies(this.protocolVersion, '<3.1.0');
+    }
+    /**
+     * Starting in protocol v3.1.0, component library breakpoints must be added in the format
+     * `lib:/<library_name>/<filepath>`, but prior they didn't require this.
+     */
+    get enableComponentLibrarySpecificBreakpoints() {
+        return semver.satisfies(this.protocolVersion, '>=3.1.0');
+    }
+    /**
+     * Starting in protocol v3.1.0, breakpoints can support conditional expressions.
+     */
+    get supportsConditionalBreakpoints() {
+        return semver.satisfies(this.protocolVersion, '>=3.1.0');
+    }
+    /**
+     * Starting in protocol v3.1.0, breakpoints can carry a hit count (ignoreCount).
+     */
+    get supportsHitConditionalBreakpoints() {
+        return semver.satisfies(this.protocolVersion, '>=3.1.0');
+    }
+    get supportsBreakpointRegistrationWhileRunning() {
+        return semver.satisfies(this.protocolVersion, '>=3.2.0');
+    }
+    get supportsBreakpointVerification() {
+        return semver.satisfies(this.protocolVersion, '>=3.2.0');
+    }
+    get supportsVirtualVariables() {
+        return semver.satisfies(this.protocolVersion, '>=3.3.0');
+    }
+    get supportsExceptionBreakpoints() {
+        return semver.satisfies(this.protocolVersion, '>=3.3.0');
+    }
+    /**
+     * Due to casing issues with the variables request on older protocols, we first try the
+     * request in the supplied case and retry in lower case on failure.
+     */
+    get enableVariablesLowerCaseRetry() {
+        return semver.satisfies(this.protocolVersion, '<3.1.0');
+    }
+    /**
+     * The `execute` command was unreliable before protocol v3.0.0.
+     */
+    get supportsExecuteCommand() {
+        return semver.satisfies(this.protocolVersion, '>=3.0.0');
+    }
+    /**
+     * The device emits compile-error update events starting in protocol v3.1.0.
+     */
+    get supportsCompileErrorReporting() {
+        return semver.satisfies(this.protocolVersion, '>=3.1.0');
+    }
+}
+exports.ProtocolCapabilities = ProtocolCapabilities;
+/**
+ * Roku OS versions that introduced each debug protocol version, ordered newest-first so
+ * we can pick the highest protocol whose OS floor the device meets.
+ */
+ProtocolCapabilities.osToProtocolVersions = [
+    { os: '14.1.0', protocol: '3.3.0' },
+    { os: '12.0.0', protocol: '3.2.0' },
+    { os: '11.5.0', protocol: '3.1.0' },
+    { os: '11.0.0', protocol: '3.0.0' },
+    { os: '9.3.0', protocol: '2.0.0' },
+    { os: '9.2.0', protocol: '1.0.1' }
+];
+//# sourceMappingURL=ProtocolCapabilities.js.map

package/dist/debugProtocol/client/ProtocolCapabilities.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ProtocolCapabilities.js","sourceRoot":"","sources":["../../../src/debugProtocol/client/ProtocolCapabilities.ts"],"names":[],"mappings":";;;AAAA,iCAAiC;AAEjC;;;;;GAKG;AACH,MAAa,oBAAoB;IAC7B,YAAY,eAAmC,EAAE,SAAkB;QAC/D,IAAI,CAAC,eAAe,GAAG,oBAAoB,CAAC,sBAAsB,CAAC,eAAe,EAAE,SAAS,CAAC,CAAC;IACnG,CAAC;IAiBD;;;;OAIG;IACK,MAAM,CAAC,sBAAsB,CAAC,eAAmC,EAAE,SAA6B;QACpG,IAAI,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,EAAE;YAC/B,OAAO,eAAe,CAAC;SAC1B;QACD,MAAM,SAAS,GAAG,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QAC9D,IAAI,CAAC,SAAS,EAAE;YACZ,OAAO,eAAe,CAAC;SAC1B;QACD,KAAK,MAAM,KAAK,IAAI,oBAAoB,CAAC,oBAAoB,EAAE;YAC3D,IAAI,MAAM,CAAC,GAAG,CAAC,SAAS,EAAE,KAAK,CAAC,EAAE,CAAC,EAAE;gBACjC,OAAO,KAAK,CAAC,QAAQ,CAAC;aACzB;SACJ;QACD,OAAO,eAAe,CAAC;IAC3B,CAAC;IAED;;;OAGG;IACH,IAAW,6BAA6B;QACpC,OAAO,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,eAAe,EAAE,QAAQ,CAAC,CAAC;IAC5D,CAAC;IAED;;;OAGG;IACH,IAAW,yCAAyC;QAChD,OAAO,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,eAAe,EAAE,SAAS,CAAC,CAAC;IAC7D,CAAC;IAED;;OAEG;IACH,IAAW,8BAA8B;QACrC,OAAO,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,eAAe,EAAE,SAAS,CAAC,CAAC;IAC7D,CAAC;IAED;;OAEG;IACH,IAAW,iCAAiC;QACxC,OAAO,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,eAAe,EAAE,SAAS,CAAC,CAAC;IAC7D,CAAC;IAED,IAAW,0CAA0C;QACjD,OAAO,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,eAAe,EAAE,SAAS,CAAC,CAAC;IAC7D,CAAC;IAED,IAAW,8BAA8B;QACrC,OAAO,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,eAAe,EAAE,SAAS,CAAC,CAAC;IAC7D,CAAC;IAED,IAAW,wBAAwB;QAC/B,OAAO,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,eAAe,EAAE,SAAS,CAAC,CAAC;IAC7D,CAAC;IAED,IAAW,4BAA4B;QACnC,OAAO,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,eAAe,EAAE,SAAS,CAAC,CAAC;IAC7D,CAAC;IAED;;;OAGG;IACH,IAAW,6BAA6B;QACpC,OAAO,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,eAAe,EAAE,QAAQ,CAAC,CAAC;IAC5D,CAAC;IAED;;OAEG;IACH,IAAW,sBAAsB;QAC7B,OAAO,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,eAAe,EAAE,SAAS,CAAC,CAAC;IAC7D,CAAC;IAED;;OAEG;IACH,IAAW,6BAA6B;QACpC,OAAO,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,eAAe,EAAE,SAAS,CAAC,CAAC;IAC7D,CAAC;;AA3GL,oDA4GC;AArGG;;;GAGG;AACqB,yCAAoB,GAAoD;IAC5F,EAAE,EAAE,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE;IACnC,EAAE,EAAE,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE;IACnC,EAAE,EAAE,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE;IACnC,EAAE,EAAE,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE;IACnC,EAAE,EAAE,EAAE,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE;IAClC,EAAE,EAAE,EAAE,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE;CACrC,CAAC"}

package/dist/debugSession/BrightScriptDebugSession.d.ts

@@ -96,6 +96,7 @@ export declare class BrightScriptDebugSession extends LoggingDebugSession {
      */
     private normalizeLaunchConfig;
     launchRequest(response: DebugProtocol.LaunchResponse, config: LaunchConfiguration): Promise<void>;
+    protected configurationDoneRequest(response: DebugProtocol.ConfigurationDoneResponse, args: DebugProtocol.ConfigurationDoneArguments): Promise<void>;
     /**
      * Activate all required functionality for profiling
      */
@@ -117,6 +118,7 @@ export declare class BrightScriptDebugSession extends LoggingDebugSession {
      * Anytime a roku adapter emits diagnostics, this method is called to handle it.
      */
     private handleDiagnostics;
+    private publishTimeout;
     private publish;
     private pendingSendLogPromise;
     /**
@@ -147,6 +149,12 @@ export declare class BrightScriptDebugSession extends LoggingDebugSession {
      * Stage, insert breakpoints, and package the main project
      */
     prepareMainProject(): Promise<void>;
+    /**
+     * Inject breakpoint STOP statements into the staged main project and create the zip package.
+     * Runs after the DAP `InitializedEvent` so client-side `setBreakpoints` requests have landed
+     * before any STOPs are written to the staged .brs files (telnet path) and before the zip is sealed.
+     */
+    private packageMainProject;
     /**
      * Accepts custom events and requests from the extension
      * @param command name of the command to execute
@@ -155,9 +163,15 @@ export declare class BrightScriptDebugSession extends LoggingDebugSession {
     /**
      * Stores the path to the staging folder for each component library
      */
-    protected prepareAndHostComponentLibraries(componentLibraries: ComponentLibraryConfiguration[], port: number): Promise<void>;
+    protected prepareComponentLibraries(componentLibraries: ComponentLibraryConfiguration[]): Promise<void>;
+    /**
+     * Inject breakpoint STOPs into the staged complibs, seal their zips, install installable ones,
+     * and start static file hosting. Runs in `configurationDoneRequest` (after `InitializedEvent`)
+     * so client-side `setBreakpoints` requests have landed before the staged .brs files are written
+     * and the zips are sealed.
+     */
+    protected packageAndHostComponentLibraries(componentLibraries: ComponentLibraryConfiguration[], port: number): Promise<void>;
     protected sourceRequest(response: DebugProtocol.SourceResponse, args: DebugProtocol.SourceArguments): void;
-    protected configurationDoneRequest(response: DebugProtocol.ConfigurationDoneResponse, args: DebugProtocol.ConfigurationDoneArguments): void;
     /**
      * Called every time a breakpoint is created, modified, or deleted, for each file. This receives the entire list of breakpoints every time.
      */