roku-debug 0.20.6 → 0.20.8

package/dist/debugProtocol/server/DebugProtocolServer.js

@@ -0,0 +1,306 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DebugProtocolServer = exports.DEBUGGER_MAGIC = void 0;
+const eventemitter3_1 = require("eventemitter3");
+const Net = require("net");
+const ActionQueue_1 = require("../../managers/ActionQueue");
+const Constants_1 = require("../Constants");
+const AddBreakpointsRequest_1 = require("../events/requests/AddBreakpointsRequest");
+const AddConditionalBreakpointsRequest_1 = require("../events/requests/AddConditionalBreakpointsRequest");
+const ContinueRequest_1 = require("../events/requests/ContinueRequest");
+const ExecuteRequest_1 = require("../events/requests/ExecuteRequest");
+const ExitChannelRequest_1 = require("../events/requests/ExitChannelRequest");
+const HandshakeRequest_1 = require("../events/requests/HandshakeRequest");
+const ListBreakpointsRequest_1 = require("../events/requests/ListBreakpointsRequest");
+const RemoveBreakpointsRequest_1 = require("../events/requests/RemoveBreakpointsRequest");
+const StackTraceRequest_1 = require("../events/requests/StackTraceRequest");
+const StepRequest_1 = require("../events/requests/StepRequest");
+const StopRequest_1 = require("../events/requests/StopRequest");
+const ThreadsRequest_1 = require("../events/requests/ThreadsRequest");
+const VariablesRequest_1 = require("../events/requests/VariablesRequest");
+const HandshakeResponse_1 = require("../events/responses/HandshakeResponse");
+const HandshakeV3Response_1 = require("../events/responses/HandshakeV3Response");
+const PluginInterface_1 = require("../PluginInterface");
+const logging_1 = require("../../logging");
+const util_1 = require("../../util");
+const ProtocolUtil_1 = require("../ProtocolUtil");
+const smart_buffer_1 = require("smart-buffer");
+exports.DEBUGGER_MAGIC = 'bsdebug';
+/**
+ * A class that emulates the way a Roku's DebugProtocol debug session/server works. This is mostly useful for unit testing,
+ * but might eventually be helpful for an off-device emulator as well
+ */
+class DebugProtocolServer {
+    constructor(options) {
+        this.options = options;
+        this.logger = logging_1.logger.createLogger(`[${DebugProtocolServer.name}]`);
+        /**
+         * Indicates whether the client has sent the magic string to kick off the debug session.
+         */
+        this.isHandshakeComplete = false;
+        this.buffer = Buffer.alloc(0);
+        /**
+         * A collection of plugins that can interact with the server at lifecycle points
+         */
+        this.plugins = new PluginInterface_1.default();
+        /**
+         * A queue for processing the incoming buffer, every transmission at a time
+         */
+        this.bufferQueue = new ActionQueue_1.ActionQueue();
+        /**
+         * An event emitter used for all of the events this server emitts
+         */
+        this.emitter = new eventemitter3_1.EventEmitter();
+    }
+    get controlPort() {
+        var _a;
+        return (_a = this.options.controlPort) !== null && _a !== void 0 ? _a : this._port;
+    }
+    /**
+     * Run the server. This opens a socket and listens for a connection.
+     * The promise resolves when the server has started listening. It does NOT wait for a client to connect
+     */
+    async start() {
+        var _a, _b, _c;
+        const deferred = (0, util_1.defer)();
+        try {
+            this.server = new Net.Server({});
+            //Roku only allows 1 connection, so we should too.
+            this.server.maxConnections = 1;
+            //whenever a client makes a connection
+            // eslint-disable-next-line @typescript-eslint/no-misused-promises
+            this.server.on('connection', async (socket) => {
+                const event = await this.plugins.emit('onClientConnected', {
+                    server: this,
+                    client: socket
+                });
+                this.client = event.client;
+                //anytime we receive incoming data from the client
+                this.client.on('data', (data) => {
+                    //queue up processing the new data, chunk by chunk
+                    void this.bufferQueue.run(async () => {
+                        this.buffer = Buffer.concat([this.buffer, data]);
+                        while (this.buffer.length > 0 && await this.process()) {
+                            //the loop condition is the actual work
+                        }
+                        return true;
+                    });
+                });
+                //handle connection errors
+                this.client.on('error', (e) => {
+                    this.logger.error(e);
+                });
+            });
+            this._port = (_a = this.controlPort) !== null && _a !== void 0 ? _a : await util_1.util.getPort();
+            //handle connection errors
+            this.server.on('error', (e) => {
+                this.logger.error(e);
+            });
+            this.server.listen({
+                port: (_b = this.options.controlPort) !== null && _b !== void 0 ? _b : 8081,
+                hostName: (_c = this.options.host) !== null && _c !== void 0 ? _c : '0.0.0.0'
+            }, () => {
+                void this.plugins.emit('onServerStart', { server: this });
+                deferred.resolve();
+            });
+        }
+        catch (e) {
+            deferred.reject(e);
+        }
+        return deferred.promise;
+    }
+    async stop() {
+        var _a, _b, _c;
+        //close the client socket
+        (_a = this.client) === null || _a === void 0 ? void 0 : _a.destroy();
+        //now close the server
+        try {
+            await new Promise((resolve, reject) => {
+                this.server.close((err) => {
+                    if (err) {
+                        reject(err);
+                    }
+                    else {
+                        resolve();
+                    }
+                });
+            });
+        }
+        finally {
+            (_b = this.client) === null || _b === void 0 ? void 0 : _b.removeAllListeners();
+            delete this.client;
+            (_c = this.server) === null || _c === void 0 ? void 0 : _c.removeAllListeners();
+            delete this.server;
+        }
+    }
+    async destroy() {
+        await this.stop();
+    }
+    /**
+     * Given a buffer, find the request that matches it
+     */
+    static getRequest(buffer, allowHandshake) {
+        //when enabled, look at the start of the buffer for the exact DEBUGGER_MAGIC text. This is a boolean because
+        //there could be cases where binary data looks similar to this structure, so the caller must opt-in to this logic
+        if (allowHandshake && buffer.length >= 8 && ProtocolUtil_1.protocolUtil.readStringNT(smart_buffer_1.SmartBuffer.fromBuffer(buffer)) === exports.DEBUGGER_MAGIC) {
+            return HandshakeRequest_1.HandshakeRequest.fromBuffer(buffer);
+        }
+        // if we don't have enough buffer data, skip this
+        if (buffer.length < 12) {
+            return;
+        }
+        //the client may only send commands to the server, so extract the command type from the known byte position
+        const command = Constants_1.CommandCode[buffer.readUInt32LE(8)]; // command_code
+        switch (command) {
+            case Constants_1.Command.AddBreakpoints:
+                return AddBreakpointsRequest_1.AddBreakpointsRequest.fromBuffer(buffer);
+            case Constants_1.Command.Stop:
+                return StopRequest_1.StopRequest.fromBuffer(buffer);
+            case Constants_1.Command.Continue:
+                return ContinueRequest_1.ContinueRequest.fromBuffer(buffer);
+            case Constants_1.Command.Threads:
+                return ThreadsRequest_1.ThreadsRequest.fromBuffer(buffer);
+            case Constants_1.Command.StackTrace:
+                return StackTraceRequest_1.StackTraceRequest.fromBuffer(buffer);
+            case Constants_1.Command.Variables:
+                return VariablesRequest_1.VariablesRequest.fromBuffer(buffer);
+            case Constants_1.Command.Step:
+                return StepRequest_1.StepRequest.fromBuffer(buffer);
+            case Constants_1.Command.ListBreakpoints:
+                return ListBreakpointsRequest_1.ListBreakpointsRequest.fromBuffer(buffer);
+            case Constants_1.Command.RemoveBreakpoints:
+                return RemoveBreakpointsRequest_1.RemoveBreakpointsRequest.fromBuffer(buffer);
+            case Constants_1.Command.Execute:
+                return ExecuteRequest_1.ExecuteRequest.fromBuffer(buffer);
+            case Constants_1.Command.AddConditionalBreakpoints:
+                return AddConditionalBreakpointsRequest_1.AddConditionalBreakpointsRequest.fromBuffer(buffer);
+            case Constants_1.Command.ExitChannel:
+                return ExitChannelRequest_1.ExitChannelRequest.fromBuffer(buffer);
+        }
+    }
+    getResponse(request) {
+        if (request instanceof HandshakeRequest_1.HandshakeRequest) {
+            return HandshakeV3Response_1.HandshakeV3Response.fromJson({
+                magic: this.magic,
+                protocolVersion: '3.1.0',
+                //TODO update this to an actual date from the device
+                revisionTimestamp: new Date(2022, 1, 1)
+            });
+        }
+    }
+    /**
+     * Process a single request.
+     * @returns true if successfully processed a request, and false if not
+     */
+    async process() {
+        try {
+            this.logger.log('process() start', { buffer: this.buffer.toJSON() });
+            //at this point, there is an active debug session. The plugin must provide us all the real-world data
+            let { buffer, request } = await this.plugins.emit('provideRequest', {
+                server: this,
+                buffer: this.buffer,
+                request: undefined
+            });
+            //we must build the request if the plugin didn't supply one (most plugins won't provide a request...)
+            if (!request) {
+                //if we haven't seen the handshake yet, look for the handshake first
+                if (!this.isHandshakeComplete) {
+                    request = HandshakeRequest_1.HandshakeRequest.fromBuffer(buffer);
+                }
+                else {
+                    request = DebugProtocolServer.getRequest(buffer, false);
+                }
+            }
+            //if we couldn't construct a request this request, hard-fail
+            if (!request || !request.success) {
+                this.logger.error('process() invalid request', { request });
+                throw new Error(`Unable to parse request: ${JSON.stringify(this.buffer.toJSON().data)}`);
+            }
+            this.logger.log('process() constructed request', { request });
+            //trim the buffer now that the request has been processed
+            this.buffer = buffer.slice(request.readOffset);
+            this.logger.log('process() buffer sliced', { buffer: this.buffer.toJSON() });
+            //now ask the plugin to provide a response for the given request
+            let { response } = await this.plugins.emit('provideResponse', {
+                server: this,
+                request: request,
+                response: undefined
+            });
+            //if the plugin didn't provide a response, we need to try our best to make one (we only support a few...plugins should provide most of them)
+            if (!response) {
+                response = this.getResponse(request);
+            }
+            if (!response) {
+                this.logger.error('process() invalid response', { request, response });
+                throw new Error(`Server was unable to provide a response for ${JSON.stringify(request.data)}`);
+            }
+            //if this is part of the handshake flow, the client should have sent a magic string to kick off the debugger. If it matches, set `isHandshakeComplete = true`
+            if ((response instanceof HandshakeResponse_1.HandshakeResponse || response instanceof HandshakeV3Response_1.HandshakeV3Response) && response.data.magic === this.magic) {
+                this.isHandshakeComplete = true;
+            }
+            //send the response to the client. (TODO handle when the response is missing)
+            await this.sendResponse(response);
+            return true;
+        }
+        catch (e) {
+            this.logger.error('process() error', e);
+        }
+        return false;
+    }
+    /**
+     * Send a response from the server to the client. This involves writing the response buffer to the client socket
+     */
+    async sendResponse(response) {
+        const event = await this.plugins.emit('beforeSendResponse', {
+            server: this,
+            response: response
+        });
+        this.logger.log('sendResponse()', { response });
+        this.client.write(event.response.toBuffer());
+        await this.plugins.emit('afterSendResponse', {
+            server: this,
+            response: event.response
+        });
+        return event.response;
+    }
+    /**
+     * Send an update from the server to the client. This can be things like ALL_THREADS_STOPPED
+     */
+    sendUpdate(update) {
+        return this.sendResponse(update);
+    }
+    on(eventName, callback) {
+        this.emitter.on(eventName, callback);
+        return () => {
+            var _a;
+            (_a = this.emitter) === null || _a === void 0 ? void 0 : _a.removeListener(eventName, callback);
+        };
+    }
+    /**
+     * Subscribe to an event exactly one time. This will fire the very next time an event happens,
+     * and then immediately unsubscribe
+     */
+    once(eventName) {
+        return new Promise((resolve) => {
+            const off = this.on(eventName, (event) => {
+                off();
+                resolve(event);
+            });
+        });
+    }
+    emit(eventName, event) {
+        var _a;
+        (_a = this.emitter) === null || _a === void 0 ? void 0 : _a.emit(eventName, event);
+        return event;
+    }
+    /**
+     * The magic string used to kick off the debug session.
+     * @default "bsdebug"
+     */
+    get magic() {
+        var _a;
+        return (_a = this.options.magic) !== null && _a !== void 0 ? _a : exports.DEBUGGER_MAGIC;
+    }
+}
+exports.DebugProtocolServer = DebugProtocolServer;
+//# sourceMappingURL=DebugProtocolServer.js.map

package/dist/debugProtocol/server/DebugProtocolServer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DebugProtocolServer.js","sourceRoot":"","sources":["../../../src/debugProtocol/server/DebugProtocolServer.ts"],"names":[],"mappings":";;;AAAA,iDAA6C;AAC7C,2BAA2B;AAC3B,4DAAyD;AACzD,4CAAoD;AAEpD,oFAAiF;AACjF,0GAAuG;AACvG,wEAAqE;AACrE,sEAAmE;AACnE,8EAA2E;AAC3E,0EAAuE;AACvE,sFAAmF;AACnF,0FAAuF;AACvF,4EAAyE;AACzE,gEAA6D;AAC7D,gEAA6D;AAC7D,sEAAmE;AACnE,0EAAuE;AACvE,6EAA0E;AAC1E,iFAA8E;AAC9E,wDAAiD;AAEjD,2CAAuC;AACvC,qCAAyC;AACzC,kDAA+C;AAC/C,+CAA2C;AAE9B,QAAA,cAAc,GAAG,SAAS,CAAC;AAExC;;;GAGG;AACH,MAAa,mBAAmB;IAC5B,YACW,OAAoC;QAApC,YAAO,GAAP,OAAO,CAA6B;QAKvC,WAAM,GAAG,gBAAM,CAAC,YAAY,CAAC,IAAI,mBAAmB,CAAC,IAAI,GAAG,CAAC,CAAC;QAEtE;;WAEG;QACK,wBAAmB,GAAG,KAAK,CAAC;QAE5B,WAAM,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAWjC;;WAEG;QACI,YAAO,GAAG,IAAI,yBAAe,EAAwB,CAAC;QAE7D;;WAEG;QACK,gBAAW,GAAG,IAAI,yBAAW,EAAE,CAAC;QAiPxC;;WAEG;QACK,YAAO,GAAG,IAAI,4BAAY,EAAE,CAAC;IAhRrC,CAAC;IA8BD,IAAW,WAAW;;QAClB,OAAO,MAAA,IAAI,CAAC,OAAO,CAAC,WAAW,mCAAI,IAAI,CAAC,KAAK,CAAC;IAClD,CAAC;IAGD;;;OAGG;IACI,KAAK,CAAC,KAAK;;QACd,MAAM,QAAQ,GAAG,IAAA,YAAK,GAAE,CAAC;QACzB,IAAI;YACA,IAAI,CAAC,MAAM,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;YACjC,kDAAkD;YAClD,IAAI,CAAC,MAAM,CAAC,cAAc,GAAG,CAAC,CAAC;YAE/B,sCAAsC;YACtC,kEAAkE;YAClE,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,YAAY,EAAE,KAAK,EAAE,MAAkB,EAAE,EAAE;gBACtD,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,EAAE;oBACvD,MAAM,EAAE,IAAI;oBACZ,MAAM,EAAE,MAAM;iBACjB,CAAC,CAAC;gBACH,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;gBAE3B,kDAAkD;gBAClD,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE;oBAC5B,kDAAkD;oBAClD,KAAK,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,KAAK,IAAI,EAAE;wBACjC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC;wBACjD,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,IAAI,MAAM,IAAI,CAAC,OAAO,EAAE,EAAE;4BACnD,uCAAuC;yBAC1C;wBACD,OAAO,IAAI,CAAC;oBAChB,CAAC,CAAC,CAAC;gBACP,CAAC,CAAC,CAAC;gBACH,0BAA0B;gBAC1B,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC,EAAE,EAAE;oBAC1B,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;gBACzB,CAAC,CAAC,CAAC;YACP,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,KAAK,GAAG,MAAA,IAAI,CAAC,WAAW,mCAAI,MAAM,WAAI,CAAC,OAAO,EAAE,CAAC;YAEtD,0BAA0B;YAC1B,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC,EAAE,EAAE;gBAC1B,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YACzB,CAAC,CAAC,CAAC;YAEH,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC;gBACf,IAAI,EAAE,MAAA,IAAI,CAAC,OAAO,CAAC,WAAW,mCAAI,IAAI;gBACtC,QAAQ,EAAE,MAAA,IAAI,CAAC,OAAO,CAAC,IAAI,mCAAI,SAAS;aAC3C,EAAE,GAAG,EAAE;gBACJ,KAAK,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,eAAe,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;gBAC1D,QAAQ,CAAC,OAAO,EAAE,CAAC;YACvB,CAAC,CAAC,CAAC;SACN;QAAC,OAAO,CAAC,EAAE;YACR,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;SACtB;QACD,OAAO,QAAQ,CAAC,OAAO,CAAC;IAC5B,CAAC;IAEM,KAAK,CAAC,IAAI;;QACb,yBAAyB;QACzB,MAAA,IAAI,CAAC,MAAM,0CAAE,OAAO,EAAE,CAAC;QAEvB,sBAAsB;QACtB,IAAI;YACA,MAAM,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;gBACxC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;oBACtB,IAAI,GAAG,EAAE;wBACL,MAAM,CAAC,GAAG,CAAC,CAAC;qBACf;yBAAM;wBACH,OAAO,EAAE,CAAC;qBACb;gBACL,CAAC,CAAC,CAAC;YACP,CAAC,CAAC,CAAC;SACN;gBAAS;YACN,MAAA,IAAI,CAAC,MAAM,0CAAE,kBAAkB,EAAE,CAAC;YAClC,OAAO,IAAI,CAAC,MAAM,CAAC;YACnB,MAAA,IAAI,CAAC,MAAM,0CAAE,kBAAkB,EAAE,CAAC;YAClC,OAAO,IAAI,CAAC,MAAM,CAAC;SACtB;IACL,CAAC;IAEM,KAAK,CAAC,OAAO;QAChB,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC;IACtB,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,UAAU,CAAC,MAAc,EAAE,cAAuB;QAC5D,4GAA4G;QAC5G,iHAAiH;QACjH,IAAI,cAAc,IAAI,MAAM,CAAC,MAAM,IAAI,CAAC,IAAI,2BAAY,CAAC,YAAY,CAAC,0BAAW,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,KAAK,sBAAc,EAAE;YACtH,OAAO,mCAAgB,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;SAC9C;QACD,iDAAiD;QACjD,IAAI,MAAM,CAAC,MAAM,GAAG,EAAE,EAAE;YACpB,OAAO;SACV;QACD,2GAA2G;QAC3G,MAAM,OAAO,GAAG,uBAAW,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,CAAY,CAAC,CAAC,eAAe;QAC/E,QAAQ,OAAO,EAAE;YACb,KAAK,mBAAO,CAAC,cAAc;gBACvB,OAAO,6CAAqB,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;YACpD,KAAK,mBAAO,CAAC,IAAI;gBACb,OAAO,yBAAW,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;YAC1C,KAAK,mBAAO,CAAC,QAAQ;gBACjB,OAAO,iCAAe,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;YAC9C,KAAK,mBAAO,CAAC,OAAO;gBAChB,OAAO,+BAAc,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;YAC7C,KAAK,mBAAO,CAAC,UAAU;gBACnB,OAAO,qCAAiB,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;YAChD,KAAK,mBAAO,CAAC,SAAS;gBAClB,OAAO,mCAAgB,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;YAC/C,KAAK,mBAAO,CAAC,IAAI;gBACb,OAAO,yBAAW,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;YAC1C,KAAK,mBAAO,CAAC,eAAe;gBACxB,OAAO,+CAAsB,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;YACrD,KAAK,mBAAO,CAAC,iBAAiB;gBAC1B,OAAO,mDAAwB,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;YACvD,KAAK,mBAAO,CAAC,OAAO;gBAChB,OAAO,+BAAc,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;YAC7C,KAAK,mBAAO,CAAC,yBAAyB;gBAClC,OAAO,mEAAgC,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;YAC/D,KAAK,mBAAO,CAAC,WAAW;gBACpB,OAAO,uCAAkB,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;SACpD;IACL,CAAC;IAEO,WAAW,CAAC,OAAwB;QACxC,IAAI,OAAO,YAAY,mCAAgB,EAAE;YACrC,OAAO,yCAAmB,CAAC,QAAQ,CAAC;gBAChC,KAAK,EAAE,IAAI,CAAC,KAAK;gBACjB,eAAe,EAAE,OAAO;gBACxB,oDAAoD;gBACpD,iBAAiB,EAAE,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC,CAAC;aAC1C,CAAC,CAAC;SACN;IACL,CAAC;IAED;;;OAGG;IACK,KAAK,CAAC,OAAO;QACjB,IAAI;YACA,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,iBAAiB,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;YAErE,qGAAqG;YACrG,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE;gBAChE,MAAM,EAAE,IAAI;gBACZ,MAAM,EAAE,IAAI,CAAC,MAAM;gBACnB,OAAO,EAAE,SAAS;aACrB,CAAC,CAAC;YAEH,qGAAqG;YACrG,IAAI,CAAC,OAAO,EAAE;gBACV,oEAAoE;gBACpE,IAAI,CAAC,IAAI,CAAC,mBAAmB,EAAE;oBAC3B,OAAO,GAAG,mCAAgB,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;iBACjD;qBAAM;oBACH,OAAO,GAAG,mBAAmB,CAAC,UAAU,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;iBAC3D;aACJ;YAED,4DAA4D;YAC5D,IAAI,CAAC,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE;gBAC9B,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,2BAA2B,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;gBAC5D,MAAM,IAAI,KAAK,CAAC,4BAA4B,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;aAC5F;YAED,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,+BAA+B,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;YAE9D,yDAAyD;YACzD,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;YAE/C,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,yBAAyB,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;YAE7E,gEAAgE;YAChE,IAAI,EAAE,QAAQ,EAAE,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,iBAAiB,EAAE;gBAC1D,MAAM,EAAE,IAAI;gBACZ,OAAO,EAAE,OAAO;gBAChB,QAAQ,EAAE,SAAS;aACtB,CAAC,CAAC;YAGH,4IAA4I;YAC5I,IAAI,CAAC,QAAQ,EAAE;gBACX,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;aACxC;YAED,IAAI,CAAC,QAAQ,EAAE;gBACX,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,4BAA4B,EAAE,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,CAAC;gBACvE,MAAM,IAAI,KAAK,CAAC,+CAA+C,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;aAClG;YAGD,6JAA6J;YAC7J,IAAI,CAAC,QAAQ,YAAY,qCAAiB,IAAI,QAAQ,YAAY,yCAAmB,CAAC,IAAI,QAAQ,CAAC,IAAI,CAAC,KAAK,KAAK,IAAI,CAAC,KAAK,EAAE;gBAC1H,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC;aACnC;YAED,6EAA6E;YAC7E,MAAM,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;YAClC,OAAO,IAAI,CAAC;SACf;QAAC,OAAO,CAAC,EAAE;YACR,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,iBAAiB,EAAE,CAAC,CAAC,CAAC;SAC3C;QACD,OAAO,KAAK,CAAC;IACjB,CAAC;IAED;;OAEG;IACK,KAAK,CAAC,YAAY,CAAC,QAA0B;QACjD,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,oBAAoB,EAAE;YACxD,MAAM,EAAE,IAAI;YACZ,QAAQ,EAAE,QAAQ;SACrB,CAAC,CAAC;QAEH,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,gBAAgB,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC;QAChD,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC,CAAC;QAE7C,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,EAAE;YACzC,MAAM,EAAE,IAAI;YACZ,QAAQ,EAAE,KAAK,CAAC,QAAQ;SAC3B,CAAC,CAAC;QACH,OAAO,KAAK,CAAC,QAAQ,CAAC;IAC1B,CAAC;IAED;;OAEG;IACI,UAAU,CAAC,MAAwB;QACtC,OAAO,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;IACrC,CAAC;IAWM,EAAE,CAAU,SAAiB,EAAE,QAA2B;QAC7D,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;QACrC,OAAO,GAAG,EAAE;;YACR,MAAA,IAAI,CAAC,OAAO,0CAAE,cAAc,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;QACtD,CAAC,CAAC;IACN,CAAC;IAED;;;OAGG;IACI,IAAI,CAAI,SAAiB;QAC5B,OAAO,IAAI,OAAO,CAAI,CAAC,OAAO,EAAE,EAAE;YAC9B,MAAM,GAAG,GAAG,IAAI,CAAC,EAAE,CAAI,SAAS,EAAE,CAAC,KAAK,EAAE,EAAE;gBACxC,GAAG,EAAE,CAAC;gBACN,OAAO,CAAC,KAAK,CAAC,CAAC;YACnB,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;IACP,CAAC;IAKM,IAAI,CAAI,SAAiB,EAAE,KAAU;;QACxC,MAAA,IAAI,CAAC,OAAO,0CAAE,IAAI,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;QACrC,OAAO,KAAK,CAAC;IACjB,CAAC;IAED;;;OAGG;IACH,IAAY,KAAK;;QACb,OAAO,MAAA,IAAI,CAAC,OAAO,CAAC,KAAK,mCAAI,sBAAc,CAAC;IAChD,CAAC;CACJ;AA9TD,kDA8TC"}

package/dist/debugProtocol/server/DebugProtocolServerPlugin.d.ts

@@ -0,0 +1,41 @@
+/// <reference types="node" />
+import type { DebugProtocolServer } from './DebugProtocolServer';
+import type { Socket } from 'net';
+import type { ProtocolRequest, ProtocolResponse } from '../events/ProtocolEvent';
+export interface ProtocolServerPlugin {
+    onServerStart?: Handler<OnServerStartEvent>;
+    onClientConnected?: Handler<OnClientConnectedEvent>;
+    provideRequest?: Handler<ProvideRequestEvent>;
+    provideResponse?: Handler<ProvideResponseEvent>;
+    beforeSendResponse?: Handler<BeforeSendResponseEvent>;
+    afterSendResponse?: Handler<AfterSendResponseEvent>;
+}
+export interface OnServerStartEvent {
+    server: DebugProtocolServer;
+}
+export interface OnClientConnectedEvent {
+    server: DebugProtocolServer;
+    client: Socket;
+}
+export interface ProvideRequestEvent {
+    server: DebugProtocolServer;
+    buffer: Buffer;
+    /**
+     * The plugin should provide this property
+     */
+    request?: ProtocolRequest;
+}
+export interface ProvideResponseEvent {
+    server: DebugProtocolServer;
+    request: ProtocolRequest;
+    /**
+     * The plugin should provide this property
+     */
+    response?: ProtocolResponse;
+}
+export interface BeforeSendResponseEvent {
+    server: DebugProtocolServer;
+    response: ProtocolResponse;
+}
+export declare type AfterSendResponseEvent = BeforeSendResponseEvent;
+export declare type Handler<T, R = void> = (event: T) => R;

package/dist/debugProtocol/server/DebugProtocolServerPlugin.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=DebugProtocolServerPlugin.js.map

package/dist/debugProtocol/server/DebugProtocolServerPlugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DebugProtocolServerPlugin.js","sourceRoot":"","sources":["../../../src/debugProtocol/server/DebugProtocolServerPlugin.ts"],"names":[],"mappings":""}

package/dist/debugSession/BrightScriptDebugSession.d.ts

@@ -11,7 +11,7 @@ import { FileLoggingManager } from '../logging';
 import type { DeviceInfo } from '../DeviceInfo';
 export declare class BrightScriptDebugSession extends BaseDebugSession {
     constructor();
-    private onDeviceVerifiedBreakpoints;
+    private onDeviceBreakpointsChanged;
     logger: import("@rokucommunity/logger/dist/Logger").Logger;
     /**
      * A sequence used to help identify log statements for requests
@@ -37,6 +37,14 @@ export declare class BrightScriptDebugSession extends BaseDebugSession {
     private rokuAdapter;
     private rendezvousTracker;
     tempVarPrefix: string;
+    /**
+     * The first encountered compile error, will be used to send to the client as a runtime error (nicer UI presentation)
+     */
+    private compileError;
+    /**
+     * 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
+     */
+    private COMPILE_ERROR_THREAD_ID;
     private get enableDebugProtocol();
     private getRokuAdapter;
     private launchConfiguration;