Device disconnect support and other improvements

package.json

@@ -264,31 +264,39 @@
                     "when": "debugType == 'brightscript' && view == rendezvousView",
                     "group": "navigation"
                 },
+
                 {
                     "command": "extension.brightscript.refreshDeviceList",
                     "when": "view == onlineDevicesView",
                     "group": "navigation"
                 },
+
                 {
                     "command": "extension.brightscript.rokuRegistry.refreshRegistry",
                     "when": "view == rokuRegistryView && brightscript.isOnDeviceComponentAvailable",
-                    "group": "navigation"
+                    "group": "navigation@1"
                 },
                 {
                     "command": "extension.brightscript.rokuRegistry.importRegistry",
                     "when": "view == rokuRegistryView && brightscript.isOnDeviceComponentAvailable",
-                    "group": "navigation"
+                    "group": "navigation@2"
                 },
                 {
                     "command": "extension.brightscript.rokuRegistry.exportRegistry",
                     "when": "view == rokuRegistryView && brightscript.isOnDeviceComponentAvailable",
-                    "group": "navigation"
+                    "group": "navigation@3"
                 },
                 {
                     "command": "extension.brightscript.rokuRegistry.clearRegistry",
                     "when": "view == rokuRegistryView && brightscript.isOnDeviceComponentAvailable",
-                    "group": "navigation"
+                    "group": "navigation@4"
                 },
+                {
+                    "command": "extension.brightscript.disconnectFromDevice",
+                    "when": "view == rokuRegistryView && brightscript.isOnDeviceComponentAvailable",
+                    "group": "navigation@5"
+                },
+
                 {
                     "command": "extension.brightscript.rokuDeviceView.refreshScreenshot",
                     "when": "view == rokuDeviceView && !brightscript.rokuDeviceView.enableScreenshotCapture",
@@ -319,6 +327,12 @@
                     "when": "view == rokuDeviceView",
                     "group": "navigation@4"
                 },
+                {
+                    "command": "extension.brightscript.disconnectFromDevice",
+                    "when": "view == rokuDeviceView && brightscript.rokuDeviceView.isOnDeviceComponentAvailable",
+                    "group": "navigation@5"
+                },
+
                 {
                     "command": "extension.brightscript.rokuAutomationView.startRecording",
                     "when": "view == rokuAutomationView && !brightscript.rokuAutomationView.isRecording",
@@ -344,6 +358,12 @@
                     "when": "view == rokuFileSystemView && brightscript.isOnDeviceComponentAvailable",
                     "group": "navigation@1"
                 },
+                {
+                    "command": "extension.brightscript.disconnectFromDevice",
+                    "when": "view == rokuFileSystemView && brightscript.isOnDeviceComponentAvailable",
+                    "group": "navigation@2"
+                },
+
                 {
                     "command": "extension.brightscript.rokuAppOverlaysView.addNewOverlay",
                     "when": "view == rokuAppOverlaysView && brightscript.isOnDeviceComponentAvailable",
@@ -353,6 +373,23 @@
                     "command": "extension.brightscript.rokuAppOverlaysView.removeAllOverlays",
                     "when": "view == rokuAppOverlaysView && brightscript.isOnDeviceComponentAvailable",
                     "group": "navigation@2"
+                },
+                {
+                    "command": "extension.brightscript.disconnectFromDevice",
+                    "when": "view == rokuAppOverlaysView && brightscript.isOnDeviceComponentAvailable",
+                    "group": "navigation@3"
+                },
+
+                {
+                    "command": "extension.brightscript.disconnectFromDevice",
+                    "when": "view == rokuCommandsView && brightscript.isOnDeviceComponentAvailable",
+                    "group": "navigation@1"
+                },
+
+                {
+                    "command": "extension.brightscript.disconnectFromDevice",
+                    "when": "view == sceneGraphInspectorView && brightscript.isOnDeviceComponentAvailable",
+                    "group": "navigation@1"
                 }
             ],
             "webview/context": [
@@ -2901,6 +2938,12 @@
                 "title": "Refresh Nodetree",
                 "category": "BrighterScript",
                 "icon": "$(refresh)"
+            },
+            {
+                "command": "extension.brightscript.disconnectFromDevice",
+                "title": "Disconnect From Roku Device",
+                "category": "BrighterScript",
+                "icon": "$(debug-disconnect)"
             }
         ],
         "keybindings": [

src/commands/VscodeCommand.ts

@@ -17,5 +17,6 @@ export enum VscodeCommand {
     disableRemoteControlMode = 'extension.brightscript.disableRemoteControlMode',
     rokuAppOverlaysViewAddNewOverlay = 'extension.brightscript.rokuAppOverlaysView.addNewOverlay',
     rokuAppOverlaysViewRemoveAllOverlays = 'extension.brightscript.rokuAppOverlaysView.removeAllOverlays',
-    rokuFileSystemViewRefresh = 'extension.brightscript.rokuFileSystemView.refresh'
+    rokuFileSystemViewRefresh = 'extension.brightscript.rokuFileSystemView.refresh',
+    disconnectFromDevice = 'extension.brightscript.disconnectFromDevice'
 }

src/extension.ts

@@ -77,7 +77,7 @@ export class Extension {
             userInputManager
         );
 
-        this.rtaManager = new RtaManager();
+        this.rtaManager = new RtaManager(context);
         this.webviewViewProviderManager = new WebviewViewProviderManager(context, this.rtaManager, this.brightScriptCommands);
         this.rtaManager.setWebviewViewProviderManager(this.webviewViewProviderManager);
 
@@ -177,6 +177,7 @@ export class Extension {
             //if this is a brightscript debug session
             if (e.type === 'brightscript') {
                 logOutputManager.onDidStartDebugSession();
+                this.webviewViewProviderManager.onDidStartDebugSession(e);
             }
             this.diagnosticManager.clear();
         });

src/managers/RtaManager.ts

@@ -1,12 +1,25 @@
 import * as fs from 'fs';
 import * as path from 'path';
 import * as rta from 'roku-test-automation';
+import * as vscode from 'vscode';
 import { ViewProviderEvent } from '../viewProviders/ViewProviderEvent';
 import { ViewProviderId } from '../viewProviders/ViewProviderId';
 import { vscodeContextManager } from './VscodeContextManager';
 import type { WebviewViewProviderManager } from './WebviewViewProviderManager';
+import { VscodeCommand } from '../commands/VscodeCommand';
 
 export class RtaManager {
+    constructor(
+        context: vscode.ExtensionContext
+    ) {
+        context.subscriptions.push(vscode.commands.registerCommand(VscodeCommand.disconnectFromDevice, () => {
+            void this.onDeviceComponent?.shutdown();
+            this.onDeviceComponent = undefined;
+            void vscodeContextManager.set('brightscript.isOnDeviceComponentAvailable', false);
+            this.updateDeviceAvailabilityOnWebViewProviders();
+        }));
+    }
+
     public onDeviceComponent?: rta.OnDeviceComponent;
     public device?: rta.RokuDevice;
 
@@ -44,11 +57,7 @@ export class RtaManager {
         }
         void vscodeContextManager.set('brightscript.isOnDeviceComponentAvailable', !!this.onDeviceComponent);
 
-        for (const webviewProvider of this.webviewViewProviderManager.getWebviewViewProviders()) {
-            if (typeof webviewProvider.updateDeviceAvailability === 'function') {
-                webviewProvider.updateDeviceAvailability();
-            }
-        }
+        this.updateDeviceAvailabilityOnWebViewProviders();
 
         if (config.disableScreenSaver) {
             void this.onDeviceComponent?.disableScreenSaver({ disableScreensaver: true });
@@ -95,4 +104,12 @@ export class RtaManager {
     public getStoredNodeReferences() {
         return this.lastStoreNodesResponse;
     }
+
+    private updateDeviceAvailabilityOnWebViewProviders() {
+        for (const webviewProvider of this.webviewViewProviderManager.getWebviewViewProviders()) {
+            if (typeof webviewProvider.updateDeviceAvailability === 'function') {
+                webviewProvider.updateDeviceAvailability();
+            }
+        }
+    }
 }

src/managers/WebviewViewProviderManager.spec.ts

@@ -47,7 +47,7 @@ describe('WebviewViewProviderManager', () => {
         let spy;
         before(() => {
             spy = sinon.spy(vscode.window, 'registerWebviewViewProvider');
-            rtaManager = new RtaManager();
+            rtaManager = new RtaManager(context);
             webviewViewProviderManager = new WebviewViewProviderManager(context, rtaManager, brightScriptCommands);
         });
 
@@ -76,7 +76,7 @@ describe('WebviewViewProviderManager', () => {
                 }
             };
 
-            rtaManager = new RtaManager();
+            rtaManager = new RtaManager(context);
             webviewViewProviderManager = new WebviewViewProviderManager(context, rtaManager, brightScriptCommands);
             rtaManager.setWebviewViewProviderManager(webviewViewProviderManager);
         });

src/managers/WebviewViewProviderManager.ts

@@ -61,6 +61,12 @@ export class WebviewViewProviderManager {
         return providers;
     }
 
+    public onDidStartDebugSession(e: vscode.DebugSession) {
+        for (const webview of this.webviewViews) {
+            webview.provider.onDidStartDebugSession(e);
+        }
+    }
+
     // Notification from extension
     public onChannelPublishedEvent(e: ChannelPublishedEvent) {
         const config = e.body.launchConfiguration as BrightScriptLaunchConfiguration;

src/viewProviders/BaseWebviewViewProvider.ts

@@ -47,6 +47,10 @@ export abstract class BaseWebviewViewProvider implements vscode.WebviewViewProvi
         this.webviewViewProviderManager = manager;
     }
 
+    public onDidStartDebugSession(e: vscode.DebugSession) {
+        // Can be overwritten in a child to notify on channel publish
+    }
+
     public onChannelPublishedEvent(e: ChannelPublishedEvent) {
         // Can be overwritten in a child to notify on channel publish
     }

src/viewProviders/RokuDeviceViewViewProvider.ts

@@ -1,4 +1,5 @@
 import type * as vscode from 'vscode';
+import type { ChannelPublishedEvent } from 'roku-debug';
 import { VscodeCommand } from '../commands/VscodeCommand';
 import { BaseRdbViewProvider } from './BaseRdbViewProvider';
 import { ViewProviderId } from './ViewProviderId';
@@ -7,6 +8,8 @@ import { ViewProviderCommand } from './ViewProviderCommand';
 export class RokuDeviceViewViewProvider extends BaseRdbViewProvider {
     public readonly id = ViewProviderId.rokuDeviceView;
 
+    private temporarilyDisableScreenshotCapture = false;
+
     constructor(context: vscode.ExtensionContext, dependencies) {
         super(context, dependencies);
 
@@ -23,6 +26,10 @@ export class RokuDeviceViewViewProvider extends BaseRdbViewProvider {
 
         this.addMessageCommandCallback(ViewProviderCommand.getScreenshot, async (message) => {
             try {
+                if (this.temporarilyDisableScreenshotCapture) {
+                    // Sometimes we need to temporarily stop screenshot capture as it can prevent successful package deployment to the device
+                    return;
+                }
                 const result = await this.dependencies.rtaManager.device.getScreenshot();
                 this.postOrQueueMessage({
                     ...message,
@@ -42,4 +49,12 @@ export class RokuDeviceViewViewProvider extends BaseRdbViewProvider {
             return true;
         });
     }
+
+    public onDidStartDebugSession(e: vscode.DebugSession) {
+        this.temporarilyDisableScreenshotCapture = true;
+    }
+
+    public onChannelPublishedEvent(e: ChannelPublishedEvent) {
+        this.temporarilyDisableScreenshotCapture = false;
+    }
 }

src/viewProviders/RokuRegistryViewProvider.spec.ts

@@ -24,7 +24,7 @@ afterEach(() => {
 });
 
 describe('RokuRegistryViewProvider', () => {
-    const rtaManager = new RtaManager();
+    const rtaManager = new RtaManager(vscode.context);
     const provider = new RokuRegistryViewProvider(vscode.context, {
         rtaManager: rtaManager
     });

webviews/src/views/SceneGraphInspectorView/NodeDetailPage.svelte

@@ -1,3 +1,4 @@
+
 <script lang="ts">
     import throttle from 'just-throttle';
     import type { TreeNode, BaseKeyPath } from 'roku-test-automation';
@@ -6,7 +7,7 @@
     import ColorField from './ColorField.svelte';
     import NumberField from '../../shared/NumberField.svelte';
     import Chevron from '../../shared/Chevron.svelte';
-    import { Refresh, Discard, ArrowLeft, Move, Key } from 'svelte-codicons';
+    import { Refresh, Discard, ArrowLeft, Move, Key, Clippy } from 'svelte-codicons';
 
     export let inspectNodeSubtype: string;
     // Key path for pulling info
@@ -43,6 +44,8 @@
 
     let numberInputsStep = '1';
 
+    let nodeInfoResponse;
+
     let fields = {} as {
         [key: string]: {
             fieldType: string;
@@ -79,9 +82,9 @@
                 request: inspectNodeBaseKeyPath
             }
         });
-        const node = results.request;
-        fields = node.fields;
-        children = node.children;
+        nodeInfoResponse = results.request;
+        fields = nodeInfoResponse.fields;
+        children = nodeInfoResponse.children;
     }
     refresh();
 
@@ -291,6 +294,10 @@
 
         return output;
     }
+
+    function copyNodeInfoJson() {
+        navigator.clipboard.writeText(JSON.stringify(nodeInfoResponse, undefined, 4))
+    }
 </script>
 
 <style>
@@ -413,6 +420,13 @@
                     <Key />
                 </vscode-button>
             {/if}
+
+            <vscode-button
+                appearance="icon"
+                title="Copy Node Info Response JSON"
+                on:click={copyNodeInfoJson}>
+                <Clippy />
+            </vscode-button>
         </section>
     </div>
 {#if showKeyPathInfo && persistentBaseKeyPath}