reset serial monitor when port changes

Author: Alberto Iannaccone

arduino-ide-extension/src/browser/arduino-ide-frontend-module.ts

@@ -1,7 +1,10 @@
 import '../../src/browser/style/index.css';
 import { ContainerModule } from 'inversify';
 import { WidgetFactory } from '@theia/core/lib/browser/widget-manager';
-import { CommandContribution } from '@theia/core/lib/common/command';
+import {
+  CommandContribution,
+  CommandRegistry,
+} from '@theia/core/lib/common/command';
 import { bindViewContribution } from '@theia/core/lib/browser/shell/view-contribution';
 import {
   TabBarToolbarContribution,
@@ -152,7 +155,14 @@ import {
   OutputChannelRegistryMainImpl as TheiaOutputChannelRegistryMainImpl,
   OutputChannelRegistryMainImpl,
 } from './theia/plugin-ext/output-channel-registry-main';
-import { ExecutableService, ExecutableServicePath, MonitorManagerProxy, MonitorManagerProxyClient, MonitorManagerProxyFactory, MonitorManagerProxyPath } from '../common/protocol';
+import {
+  ExecutableService,
+  ExecutableServicePath,
+  MonitorManagerProxy,
+  MonitorManagerProxyClient,
+  MonitorManagerProxyFactory,
+  MonitorManagerProxyPath,
+} from '../common/protocol';
 import { MonacoTextModelService as TheiaMonacoTextModelService } from '@theia/monaco/lib/browser/monaco-text-model-service';
 import { MonacoTextModelService } from './theia/monaco/monaco-text-model-service';
 import { ResponseServiceImpl } from './response-service-impl';
@@ -411,21 +421,35 @@ export default new ContainerModule((bind, unbind, isBound, rebind) => {
     createWidget: () => {
       return new MonitorWidget(
         context.container.get<MonitorModel>(MonitorModel),
-        context.container.get<MonitorManagerProxyClient>(MonitorManagerProxyClient),
+        context.container.get<MonitorManagerProxyClient>(
+          MonitorManagerProxyClient
+        ),
         context.container.get<BoardsServiceProvider>(BoardsServiceProvider),
+        context.container.get<CommandRegistry>(CommandRegistry)
       );
-    }
+    },
   }));
 
-  bind(MonitorManagerProxyFactory).toFactory((context) => () => context.container.get<MonitorManagerProxy>(MonitorManagerProxy))
+  bind(MonitorManagerProxyFactory).toFactory(
+    (context) => () =>
+      context.container.get<MonitorManagerProxy>(MonitorManagerProxy)
+  );
 
-  bind(MonitorManagerProxy).toDynamicValue((context) =>
-    WebSocketConnectionProvider.createProxy(context.container, MonitorManagerProxyPath, context.container.get(MonitorManagerProxyClient))
-  ).inSingletonScope();
+  bind(MonitorManagerProxy)
+    .toDynamicValue((context) =>
+      WebSocketConnectionProvider.createProxy(
+        context.container,
+        MonitorManagerProxyPath,
+        context.container.get(MonitorManagerProxyClient)
+      )
+    )
+    .inSingletonScope();
 
   // Monitor manager proxy client to receive and delegate pluggable monitors
   // notifications from the backend
-  bind(MonitorManagerProxyClient).to(MonitorManagerProxyClientImpl).inSingletonScope();
+  bind(MonitorManagerProxyClient)
+    .to(MonitorManagerProxyClientImpl)
+    .inSingletonScope();
 
   bind(WorkspaceService).toSelf().inSingletonScope();
   rebind(TheiaWorkspaceService).toService(WorkspaceService);
@@ -482,11 +506,12 @@ export default new ContainerModule((bind, unbind, isBound, rebind) => {
     .inSingletonScope();
   rebind(TheiaEditorWidgetFactory).to(EditorWidgetFactory).inSingletonScope();
   rebind(TabBarToolbarFactory).toFactory(
-    ({ container: parentContainer }) => () => {
-      const container = parentContainer.createChild();
-      container.bind(TabBarToolbar).toSelf().inSingletonScope();
-      return container.get(TabBarToolbar);
-    }
+    ({ container: parentContainer }) =>
+      () => {
+        const container = parentContainer.createChild();
+        container.bind(TabBarToolbar).toSelf().inSingletonScope();
+        return container.get(TabBarToolbar);
+      }
   );
   bind(OutputWidget).toSelf().inSingletonScope();
   rebind(TheiaOutputWidget).toService(OutputWidget);
@@ -651,15 +676,13 @@ export default new ContainerModule((bind, unbind, isBound, rebind) => {
 
   // Enable the dirty indicator on uncloseable widgets.
   rebind(TabBarRendererFactory).toFactory((context) => () => {
-    const contextMenuRenderer = context.container.get<ContextMenuRenderer>(
-      ContextMenuRenderer
-    );
+    const contextMenuRenderer =
+      context.container.get<ContextMenuRenderer>(ContextMenuRenderer);
     const decoratorService = context.container.get<TabBarDecoratorService>(
       TabBarDecoratorService
     );
-    const iconThemeService = context.container.get<IconThemeService>(
-      IconThemeService
-    );
+    const iconThemeService =
+      context.container.get<IconThemeService>(IconThemeService);
     return new TabBarRenderer(
       contextMenuRenderer,
       decoratorService,

arduino-ide-extension/src/browser/serial/monitor/monitor-view-contribution.tsx

@@ -47,6 +47,7 @@ export class MonitorViewContribution
   static readonly TOGGLE_SERIAL_MONITOR = MonitorWidget.ID + ':toggle';
   static readonly TOGGLE_SERIAL_MONITOR_TOOLBAR =
     MonitorWidget.ID + ':toggle-toolbar';
+  static readonly RESET_SERIAL_MONITOR = MonitorWidget.ID + ':reset';
 
   @inject(MonitorModel)
   protected readonly model: MonitorModel;
@@ -119,6 +120,10 @@ export class MonitorViewContribution
         }
       );
     }
+    commands.registerCommand(
+      { id: MonitorViewContribution.RESET_SERIAL_MONITOR },
+      { execute: () => this.reset() }
+    );
   }
 
   protected async toggle(): Promise<void> {
@@ -130,6 +135,12 @@ export class MonitorViewContribution
     }
   }
 
+  protected async reset(): Promise<void> {
+    const widget = this.tryGetWidget();
+    if (widget) widget.dispose();
+    await this.openView({ activate: true, reveal: true });
+  }
+
   protected renderAutoScrollButton(): React.ReactNode {
     return (
       <React.Fragment key="autoscroll-toolbar-item">

arduino-ide-extension/src/browser/serial/monitor/monitor-widget.tsx

@@ -13,10 +13,12 @@ import { ArduinoSelect } from '../../widgets/arduino-select';
 import { SerialMonitorSendInput } from './serial-monitor-send-input';
 import { SerialMonitorOutput } from './serial-monitor-send-output';
 import { BoardsServiceProvider } from '../../boards/boards-service-provider';
-import { nls } from '@theia/core/lib/common';
+import { CommandRegistry, nls } from '@theia/core/lib/common';
 import { MonitorManagerProxyClient } from '../../../common/protocol';
 import { MonitorModel } from '../../monitor-model';
 import { MonitorSettings } from '../../../node/monitor-settings/monitor-settings-provider';
+import { MonitorViewContribution } from './monitor-view-contribution';
+import { BoardsConfig } from '../../boards/boards-config';
 
 @injectable()
 export class MonitorWidget extends ReactWidget {
@@ -41,6 +43,8 @@ export class MonitorWidget extends ReactWidget {
   protected closing = false;
   protected readonly clearOutputEmitter = new Emitter<void>();
 
+  protected lastConnectedBoard: BoardsConfig.Config;
+
   constructor(
     @inject(MonitorModel)
     protected readonly monitorModel: MonitorModel,
@@ -49,7 +53,10 @@ export class MonitorWidget extends ReactWidget {
     protected readonly monitorManagerProxy: MonitorManagerProxyClient,
 
     @inject(BoardsServiceProvider)
-    protected readonly boardsServiceProvider: BoardsServiceProvider
+    protected readonly boardsServiceProvider: BoardsServiceProvider,
+
+    @inject(CommandRegistry)
+    protected readonly commandRegistry: CommandRegistry
   ) {
     super();
     this.id = MonitorWidget.ID;
@@ -77,6 +84,19 @@ export class MonitorWidget extends ReactWidget {
               selectedBoard,
               selectedPort
             );
+
+            if (
+              selectedBoard.fqbn !==
+                this.lastConnectedBoard?.selectedBoard?.fqbn ||
+              selectedPort.id !== this.lastConnectedBoard?.selectedPort?.id
+            )
+              await this.commandRegistry.executeCommand(
+                MonitorViewContribution.RESET_SERIAL_MONITOR
+              );
+            this.lastConnectedBoard = {
+              selectedBoard,
+              selectedPort,
+            };
             this.update();
           }
         }