roku-debug 0.9.2 → 0.10.0

package/CHANGELOG.md

@@ -6,20 +6,41 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 
 
-## [0.9.2](https://github.com/rokucommunity/brighterscript/compare/v0.9.1...v0.9.2) - 2022-01-12
+## [0.10.0](https://github.com/rokucommunity/roku-debug/compare/v0.9.4...v0.10.0) - 2022-03-08
+### Added
+ - support for roku debug protocol v3.0.0
+ - support for eval/execute functionality over the debug protocol(v3.0.0+) from the debug console
+### Changed
+ - running `print` statements in the debug console now runs an actual print statement. To do variable evaluation, simply type the name of the variable.
+
+
+
+## [0.9.4](https://github.com/rokucommunity/roku-debug/compare/v0.9.3...v0.9.4) - 2022-02-24
+### Changed
+ - upgrade to [brighterscript@0.5.2](https://github.com/rokucommunity/brighterscript/blob/master/CHANGELOG.md#0452---2022-02-24).
+
+
+
+## [0.9.3](https://github.com/rokucommunity/roku-debug/compare/v0.9.2...v0.9.3) - 2022-01-28
+### Changed
+ - upgrade to [brighterscript@0.43.0](https://github.com/rokucommunity/brighterscript/blob/master/CHANGELOG.md#0430---2022-01-28).
+
+
+
+## [0.9.2](https://github.com/rokucommunity/roku-debug/compare/v0.9.1...v0.9.2) - 2022-01-12
 ### Fixed
  - bug with telnet debug session related to fire-and-forget commands like `step`, `continue`, etc. This was causing the debug session to stall frequently. ([#64](https://github.com/rokucommunity/roku-debug/pull/64))
  - combine telnet output that was split due to buffer sizes ([#64](https://github.com/rokucommunity/roku-debug/pull/64))
 
 
 
-## [0.9.1](https://github.com/rokucommunity/brighterscript/compare/v0.9.0...v0.9.1) - 2022-01-05
+## [0.9.1](https://github.com/rokucommunity/roku-debug/compare/v0.9.0...v0.9.1) - 2022-01-05
 ### Fixed
  - issue where `"consoleOutput": "full"` shows no output when `enableDebugProtocol === true`. ([#65](https://github.com/rokucommunity/roku-debug/pull/65))
 
 
 
-## [0.9.0](https://github.com/rokucommunity/brighterscript/compare/v0.8.7...v0.9.0) - 2021-12-17
+## [0.9.0](https://github.com/rokucommunity/roku-debug/compare/v0.8.7...v0.9.0) - 2021-12-17
 ### Added
  - use @rokucommunity/logger package for logging. Adds many new log messages at various debug levels. ([#61](https://github.com/rokucommunity/roku-debug/pull/61))
     - add `logLevel` launch configuration variable
@@ -30,7 +51,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 
 
-## [0.8.7](https://github.com/rokucommunity/brighterscript/compare/v0.8.6...v0.8.7) - 2021-11-11
+## [0.8.7](https://github.com/rokucommunity/roku-debug/compare/v0.8.6...v0.8.7) - 2021-11-11
 ### Changed
  - added lots of logging for help troubleshooting issues in roku-debug. ([#56](https://github.com/rokucommunity/roku-debug/pull/56))
 ### Fixed
@@ -38,7 +59,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 
 
-## [0.8.6](https://github.com/rokucommunity/brighterscript/compare/v0.8.5...v0.8.6) - 2021-11-04
+## [0.8.6](https://github.com/rokucommunity/roku-debug/compare/v0.8.5...v0.8.6) - 2021-11-04
 ### Changed
  - upgrade to  [roku-deploy@3.5.2](https://github.com/rokucommunity/roku-deploy/blob/master/CHANGELOG.md#352---2021-11-02) which fixed bugs introduced in roku-deploy v3.5.0.
 ### Fixed
@@ -47,8 +68,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 
 
-## [0.8.5] - 2021-10-27
-[0.8.5]: https://github.com/RokuCommunity/roku-debug/compare/v0.8.4...v0.8.5
+## [0.8.7](https://github.com/RokuCommunity/roku-debug/compare/v0.8.4...v0.8.5) - 2021-10-27
 ### Changed
  - additional logging to the "BrightScript Debug Server" output panel
  - upgrade to  [roku-deploy@3.5.0](https://github.com/rokucommunity/roku-deploy/blob/master/CHANGELOG.md#350---2021-10-27)  which adds the ability to use negated non-rootDir top-level 
@@ -59,37 +79,32 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 
 
-## [0.8.4] - 2021-06-01
-[0.8.4]: https://github.com/RokuCommunity/roku-debug/compare/v0.8.3...v0.8.4
+## [0.8.4](https://github.com/RokuCommunity/roku-debug/compare/v0.8.3...v0.8.4) - 2021-06-01
 ### Fixed
  - debugger freeze when debugger prompt split across multiple telnet messages ([#35](https://github.com/rokucommunity/roku-debug/pull/35))
 
 
 
-## [0.8.3] - 2021-06-01
-[0.8.3]: https://github.com/RokuCommunity/roku-debug/compare/v0.8.2...v0.8.3
+## [0.8.3](https://github.com/RokuCommunity/roku-debug/compare/v0.8.2...v0.8.3) - 2021-06-01
 ### Changed
  - upgraded to [roku-deploy@3.4.1](https://github.com/rokucommunity/roku-deploy/blob/master/CHANGELOG.md#341---2021-06-01) which fixes bugs introduced in roku-deploy@3.4.0
 
 
 
-## [0.8.2] - 2021-05-28
-[0.8.2]: https://github.com/RokuCommunity/roku-debug/compare/v0.8.1...v0.8.2
+## [0.8.2](https://github.com/RokuCommunity/roku-debug/compare/v0.8.1...v0.8.2) - 2021-05-28
 ### Changed
  - upgraded to [roku-deploy@3.4.0](https://github.com/rokucommunity/roku-deploy/blob/master/CHANGELOG.md#340---2021-05-28) which brings significant zip speed improvements
 
 
 
-## [0.8.1] - 2021-05-04
-[0.8.1]: https://github.com/RokuCommunity/roku-debug/compare/v0.8.0...v0.8.1
+## [0.8.1](https://github.com/RokuCommunity/roku-debug/compare/v0.8.0...v0.8.1) - 2021-05-04
 ### Fixed
  - Fix incorrect sgnodes shell prompt matching string. ([#31](https://github.com/rokucommunity/roku-debug/pull/31))
  - Increase port 8080 commands max buffer size ([#31](https://github.com/rokucommunity/roku-debug/pull/31))
 
 
 
-## [0.8.0] - 2021-05-03
-[0.8.0]: https://github.com/RokuCommunity/roku-debug/compare/v0.7.0...v0.8.0
+## [0.8.0](https://github.com/RokuCommunity/roku-debug/compare/v0.7.0...v0.8.0) - 2021-05-03
 ### Added
  - port 8080 command support ([#29](https://github.com/rokucommunity/roku-debug/pull/29))
 ### Fixed
@@ -97,30 +112,26 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 
 
-## [0.7.0] - 2021-04-27
-[0.7.0]: https://github.com/RokuCommunity/roku-debug/compare/v0.6.0...v0.7.0
+## [0.7.0](https://github.com/RokuCommunity/roku-debug/compare/v0.6.0...v0.7.0) - 2021-04-27
 ### Added
  - support for inspecting roXmlElement ([#23](https://github.com/rokucommunity/roku-debug/pull/23))
  - support for capturing chanperf events ([#28](https://github.com/rokucommunity/roku-debug/pull/28))
 
 
 
-## [0.6.0] - 2021-03-09
-[0.6.0]: https://github.com/RokuCommunity/roku-debug/compare/v0.5.10...v0.6.0
+## [0.6.0](https://github.com/RokuCommunity/roku-debug/compare/v0.5.10...v0.6.0) - 2021-03-09
 ### Added
  - rdb integration ([#25](https://github.com/rokucommunity/roku-debug/pull/25))
 
 
 
-## [0.5.10] - 2021-02-16
-[0.5.10]: https://github.com/RokuCommunity/roku-debug/compare/v0.5.9...v0.5.10
+## [0.5.10](https://github.com/RokuCommunity/roku-debug/compare/v0.5.9...v0.5.10) - 2021-02-16
 ### Fixed
  - stack trace for brighterscript class methods appearing as `anon`
 
 
 
-## [0.5.9] - 2021-01-19
-[0.5.9]: https://github.com/RokuCommunity/roku-debug/compare/v0.5.8...v0.5.9
+## [0.5.9](https://github.com/RokuCommunity/roku-debug/compare/v0.5.8...v0.5.9) - 2021-01-19
 ### Fixed
  - timing issue when shutting down debug session before the log processor has finish its job
  - off-by-one location of "compile errors" when device validates XML components
@@ -132,44 +143,38 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 
 
-## [0.5.8] - 2020-10-23
-[0.5.8]: https://github.com/RokuCommunity/roku-debug/compare/v0.5.7...v0.5.8
+## [0.5.8](https://github.com/RokuCommunity/roku-debug/compare/v0.5.7...v0.5.8) - 2020-10-23
 ### Fixed
  - bug when converting `$anon_###` function names into original function names that was using the wrong line number to look up the name. ([#21](https://github.com/rokucommunity/roku-debug/pull/21))
 
 
 
-## [0.5.7] - 2020-10-06
-[0.5.7]: https://github.com/RokuCommunity/roku-debug/compare/v0.5.6...v0.5.7
+## [0.5.7](https://github.com/RokuCommunity/roku-debug/compare/v0.5.6...v0.5.7) - 2020-10-06
 ### Fixed
  - bug that was not passing in the `stagingFolderPath` property for the root project, and therefore incorrectly loading that value from `bsconfig.json` if it existed. ([#18](https://github.com/rokucommunity/roku-debug/pull/18))
 
 
 
-## [0.5.6] - 2020-09-30
-[0.5.6]: https://github.com/RokuCommunity/roku-debug/compare/v0.5.5...v0.5.6
+## [0.5.6](https://github.com/RokuCommunity/roku-debug/compare/v0.5.5...v0.5.6) - 2020-09-30
 ### Fixed
  - bug that prevented component library debug sessions from launching.
 
 
 
-## [0.5.5] - 2020-09-28
-[0.5.5]: https://github.com/RokuCommunity/roku-debug/compare/v0.5.4...v0.5.5
+## [0.5.5](https://github.com/RokuCommunity/roku-debug/compare/v0.5.4...v0.5.5) - 2020-09-28
 ### Fixed
  - bug in the component library bundling that was using the `src` instead of `dest` for finding the manifest path ([#15](https://github.com/rokucommunity/roku-debug/pull/15))
 
 
 
-## [0.5.4] - 2020-09-25
-[0.5.4]: https://github.com/RokuCommunity/roku-debug/compare/v0.5.3...v0.5.4
+## [0.5.4](https://github.com/RokuCommunity/roku-debug/compare/v0.5.3...v0.5.4) - 2020-09-25
 ### Changed
  - fixed some false positive detections of `Can't continue` in the TelnetAdapter
  - fixed version comparision links in the changelogs
 
 
 
-## [0.5.3] - 2020-08-14
-[0.5.3]: https://github.com/RokuCommunity/roku-debug/compare/v0.5.2...v0.5.3
+## [0.5.3](https://github.com/RokuCommunity/roku-debug/compare/v0.5.2...v0.5.3) - 2020-08-14
 ### Changed
  - upgraded to [roku-deploy@3.2.3](https://github.com/rokucommunity/roku-deploy/blob/master/CHANGELOG.md#323---2020-08-14)
  - throw exception when copying to staging folder and `rootDir` does not exist in the file system
@@ -177,8 +182,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 
 
-## [0.5.2] - 2020-07-14
-[0.5.2]: https://github.com/RokuCommunity/roku-debug/compare/v0.5.1...v0.5.2
+## [0.5.2](https://github.com/RokuCommunity/roku-debug/compare/v0.5.1...v0.5.2) - 2020-07-14
 ### Changed
  - upgraded to [roku-deploy@3.2.2](https://github.com/rokucommunity/roku-deploy/blob/master/CHANGELOG.md#322---2020-07-14)
 ### Fixed
@@ -186,16 +190,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 
 
-## [0.5.1] - 2020-07-11
-[0.5.1]: https://github.com/RokuCommunity/roku-debug/compare/v0.5.0...v0.5.1
+## [0.5.1](https://github.com/RokuCommunity/roku-debug/compare/v0.5.0...v0.5.1) - 2020-07-11
 ### Fixed
  - Prevent debug session crash if target breakpoint file doesn't exist. [#10](https://github.com/rokucommunity/roku-debug/pull/10)
   -Bug when converting source location to staging locations that incorrectly checked rootDir before sourceDirs. [#10](https://github.com/rokucommunity/roku-debug/pull/10)
 
 
 
-## [0.5.0] - 2020-07-06
-[0.5.0]: https://github.com/RokuCommunity/roku-debug/compare/v0.4.0...v0.5.0
+## [0.5.0](https://github.com/RokuCommunity/roku-debug/compare/v0.4.0...v0.5.0)- 2020-07-06
 ### Added
  - support for inline values during a debug session. [#8](https://github.com/rokucommunity/roku-debug/pull/8)
 ### Fixed
@@ -203,15 +205,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 
 
-## [0.4.0] - 2020-07-02
-[0.4.0]: https://github.com/RokuCommunity/roku-debug/compare/v0.3.7...v0.4.0
+## [0.4.0](https://github.com/RokuCommunity/roku-debug/compare/v0.3.7...v0.4.0)- 2020-07-02
 ### Changed
  - Try to look up original function names for anonymous functions in call stack [#6](https://github.com/rokucommunity/roku-debug/issues/6)
 
 
 
-## [0.3.7] - 2020-05-11
-[0.3.7]: https://github.com/RokuCommunity/roku-debug/compare/v0.3.6...v0.3.7
+## [0.3.7](https://github.com/RokuCommunity/roku-debug/compare/v0.3.6...v0.3.7) - 2020-05-11
 ### Changed
  - upgraded to roku-deploy@3.1.1
  - brightscript debug commands from the debug console in the telnet adapter like `cont` and `step` are now supported (but use at your own risk as there are synchronization issues between the adapter and vscode sometimes)
@@ -225,21 +225,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 
 
-## [0.3.6] - 2020-04-16
-[0.3.6]: https://github.com/RokuCommunity/roku-debug/compare/v0.3.5...v0.3.6
+## [0.3.6](https://github.com/RokuCommunity/roku-debug/compare/v0.3.5...v0.3.6) - 2020-04-16
 ### Fixed
  - bug in socket debugger that would randomly try and run the `verifyHandshake()` method more than once during startup.
 
 
 
-## [0.3.5] - 2020-04-10
-[0.3.5]: https://github.com/RokuCommunity/roku-debug/compare/v0.3.4...v0.3.5
+## [0.3.5](https://github.com/RokuCommunity/roku-debug/compare/v0.3.4...v0.3.5) - 2020-04-10
 ### Changed
  - upgraded to [roku-deploy@3.0.2](https://www.npmjs.com/package/roku-debug/v/0.3.4) which fixed a file copy bug in subdirectories of symlinked folders
 
 
 
-## [0.3.4] - 2020-04-07
+## [0.3.4](https://github.com/RokuCommunity/roku-debug/compare/v0.3.3...v0.3.4) - 2020-04-07
 ### Changed
  - renamed `enableSocketDebugger` to `enableDebugProtocol`
 ### Fixed

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 RokuCommunity
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,12 +1,12 @@
 # roku-debug
 A [Debug Adapter Protocol](https://microsoft.github.io/debug-adapter-protocol/) server (for editors like VSCode) and a socket adapter for Roku's [BrightScript Debug Protocol](https://developer.roku.com/en-ca/docs/developer-program/debugging/socket-based-debugger.md)
 
-
-[![build](https://img.shields.io/github/workflow/status/rokucommunity/roku-debug/build.svg?logo=github)](https://github.com/rokucommunity/roku-debug/actions?query=workflow%3Abuild)
-![main](https://github.com/rokucommunity/roku-debug/workflows/main/badge.svg?branch=master)
-[![Coverage Status](https://coveralls.io/repos/github/rokucommunity/roku-debug/badge.svg?branch=master)](https://coveralls.io/github/rokucommunity/roku-debug?branch=master)
-[![NPM Version](https://badge.fury.io/js/roku-debug.svg?style=flat)](https://npmjs.org/package/roku-debug)
-
+[![build status](https://img.shields.io/github/workflow/status/rokucommunity/roku-debug/build.svg?logo=github)](https://github.com/rokucommunity/roku-debug/actions?query=workflow%3Abuild)
+[![coverage status](https://img.shields.io/coveralls/github/rokucommunity/roku-debug?logo=coveralls)](https://coveralls.io/github/rokucommunity/roku-debug?branch=master)
+[![monthly downloads](https://img.shields.io/npm/dm/roku-debug.svg?sanitize=true&logo=npm&logoColor=)](https://npmcharts.com/compare/roku-debug?minimal=true)
+[![npm version](https://img.shields.io/npm/v/roku-debug.svg?logo=npm)](https://www.npmjs.com/package/roku-debug)
+[![license](https://img.shields.io/github/license/rokucommunity/roku-debug.svg)](LICENSE)
+[![Slack](https://img.shields.io/badge/Slack-RokuCommunity-4A154B?logo=slack)](https://join.slack.com/t/rokudevelopers/shared_invite/zt-4vw7rg6v-NH46oY7hTktpRIBM_zGvwA)
 
 ## Contributors
 [![](https://sourcerer.io/fame/TwitchBronBron/rokucommunity/roku-debug/images/0)](https://sourcerer.io/fame/TwitchBronBron/rokucommunity/roku-debug/links/0)[![](https://sourcerer.io/fame/TwitchBronBron/rokucommunity/roku-debug/images/1)](https://sourcerer.io/fame/TwitchBronBron/rokucommunity/roku-debug/links/1)[![](https://sourcerer.io/fame/TwitchBronBron/rokucommunity/roku-debug/images/2)](https://sourcerer.io/fame/TwitchBronBron/rokucommunity/roku-debug/links/2)[![](https://sourcerer.io/fame/TwitchBronBron/rokucommunity/roku-debug/images/3)](https://sourcerer.io/fame/TwitchBronBron/rokucommunity/roku-debug/links/3)[![](https://sourcerer.io/fame/TwitchBronBron/rokucommunity/roku-debug/images/4)](https://sourcerer.io/fame/TwitchBronBron/rokucommunity/roku-debug/links/4)[![](https://sourcerer.io/fame/TwitchBronBron/rokucommunity/roku-debug/images/5)](https://sourcerer.io/fame/TwitchBronBron/rokucommunity/roku-debug/links/5)[![](https://sourcerer.io/fame/TwitchBronBron/rokucommunity/roku-debug/images/6)](https://sourcerer.io/fame/TwitchBronBron/rokucommunity/roku-debug/links/6)[![](https://sourcerer.io/fame/TwitchBronBron/rokucommunity/roku-debug/images/7)](https://sourcerer.io/fame/TwitchBronBron/rokucommunity/roku-debug/links/7)

package/dist/adapters/DebugProtocolAdapter.d.ts

@@ -2,7 +2,7 @@ import type { ProtocolVersionDetails } from '../debugProtocol/Debugger';
 import type { RendezvousHistory } from '../RendezvousTracker';
 import type { ChanperfData } from '../ChanperfTracker';
 import type { SourceLocation } from '../managers/LocationManager';
-import type { HighLevelType } from '../interfaces';
+import type { HighLevelType, RokuAdapterEvaluateResponse } from '../interfaces';
 /**
  * A class that connects to a Roku device over telnet debugger port and provides a standardized way of interacting with it.
  */
@@ -12,6 +12,12 @@ export declare class DebugProtocolAdapter {
     constructor(host: string, stopOnEntry?: boolean);
     private logger;
     connected: boolean;
+    /**
+     *  Due to casing issues with the variables request on some versions of the debug protocol, we first need to try the request in the supplied case.
+     * If that fails we retry in lower case. This flag is used to drive that logic switching
+     */
+    private enableVariablesLowerCaseRetry;
+    private supportsExecuteCommand;
     private compileClient;
     private compileErrorProcessor;
     private emitter;
@@ -21,6 +27,10 @@ export declare class DebugProtocolAdapter {
     private nextFrameId;
     private stackFramesCache;
     private cache;
+    /**
+     * Get the version of the protocol for the Roku device we're currently connected to.
+     */
+    get activeProtocolVersion(): string;
     readonly supportsMultipleRuns = false;
     /**
      * Subscribe to various events
@@ -73,9 +83,9 @@ export declare class DebugProtocolAdapter {
     /**
      * Send command to step over
      */
-    stepOver(threadId: number): Promise<import("..").Response>;
-    stepInto(threadId: number): Promise<import("..").Response>;
-    stepOut(threadId: number): Promise<import("..").Response>;
+    stepOver(threadId: number): Promise<import("..").ProtocolEvent>;
+    stepInto(threadId: number): Promise<import("..").ProtocolEvent>;
+    stepOut(threadId: number): Promise<import("..").ProtocolEvent>;
     /**
      * Tell the brightscript program to continue (i.e. resume program)
      */
@@ -83,7 +93,7 @@ export declare class DebugProtocolAdapter {
     /**
      * Tell the brightscript program to pause (fall into debug mode)
      */
-    pause(): Promise<import("..").Response>;
+    pause(): Promise<import("..").ProtocolEvent>;
     /**
      * Clears the state, which means that everything will be retrieved fresh next time it is requested
      */
@@ -91,17 +101,17 @@ export declare class DebugProtocolAdapter {
     /**
      * Execute a command directly on the roku. Returns the output of the command
      * @param command
+     * @returns the output of the command (if possible)
      */
-    evaluate(command: string, frameId?: number): Promise<EvaluateContainer>;
+    evaluate(command: string, frameId?: number): Promise<RokuAdapterEvaluateResponse>;
     getStackTrace(threadId?: number): Promise<StackFrame[]>;
-    private getStackTraceById;
+    private getStackFrameById;
     private cleanUpFunctionName;
     /**
      * Given an expression, evaluate that statement ON the roku
      * @param expression
      */
     getVariable(expression: string, frameId: number, withChildren?: boolean): Promise<EvaluateContainer>;
-    getVariablePath(expression: string): string[];
     /**
      * Cache items by a unique key
      * @param expression