fix: restored the plotter app

Signed-off-by: Akos Kitta <a.kitta@arduino.cc>

Author: Akos Kitta

arduino-ide-extension/src/browser/serial/plotter/plotter-frontend-contribution.ts

@@ -1,28 +1,17 @@
+import { Endpoint } from '@theia/core/lib/browser/endpoint';
 import { ThemeService } from '@theia/core/lib/browser/theming';
-import { injectable, inject } from '@theia/core/shared/inversify';
-import {
-  Command,
-  CommandRegistry,
-  MaybePromise,
-  MenuModelRegistry,
-} from '@theia/core';
-import { ArduinoMenus } from '../../menu/arduino-menus';
-import { Contribution } from '../../contributions/contribution';
-import { Endpoint, FrontendApplication } from '@theia/core/lib/browser';
-// import { ipcRenderer } from '@theia/electron/shared/electron';
+import { Command, CommandRegistry } from '@theia/core/lib/common/command';
+import { DisposableCollection } from '@theia/core/lib/common/disposable';
+import type { MenuModelRegistry } from '@theia/core/lib/common/menu';
+import { nls } from '@theia/core/lib/common/nls';
+import { inject, injectable } from '@theia/core/shared/inversify';
+import queryString from 'query-string';
 import { MonitorManagerProxyClient } from '../../../common/protocol';
-import { BoardsServiceProvider } from '../../boards/boards-service-provider';
+import { Contribution } from '../../contributions/contribution';
+import { ArduinoMenus } from '../../menu/arduino-menus';
 import { MonitorModel } from '../../monitor-model';
 import { ArduinoToolbar } from '../../toolbar/arduino-toolbar';
 
-import { nls } from '@theia/core/lib/common/nls';
-// import {
-//   CLOSE_PLOTTER_WINDOW,
-//   SHOW_PLOTTER_WINDOW,
-// } from '../../../common/ipc-communication';
-
-const queryString = require('query-string');
-
 export namespace SerialPlotterContribution {
   export namespace Commands {
     export const OPEN: Command = Command.toLocalizedCommand(
@@ -45,38 +34,31 @@ export namespace SerialPlotterContribution {
 
 @injectable()
 export class PlotterFrontendContribution extends Contribution {
-  protected window: Window | null;
-  protected url: string;
-  protected wsPort: number;
+  private readonly endpointUrl = new Endpoint({ path: '/plotter' })
+    .getRestUrl()
+    .toString();
+  private readonly toDispose = new DisposableCollection();
+  private _plotterUrl: string | undefined;
 
   @inject(MonitorModel)
-  protected readonly model: MonitorModel;
-
+  private readonly model: MonitorModel;
   @inject(ThemeService)
-  protected readonly themeService: ThemeService;
-
+  private readonly themeService: ThemeService;
   @inject(MonitorManagerProxyClient)
-  protected readonly monitorManagerProxy: MonitorManagerProxyClient;
-
-  @inject(BoardsServiceProvider)
-  protected readonly boardsServiceProvider: BoardsServiceProvider;
-
-  override onStart(app: FrontendApplication): MaybePromise<void> {
-    this.url = new Endpoint({ path: '/plotter' }).getRestUrl().toString();
+  private readonly monitorManagerProxy: MonitorManagerProxyClient;
 
-    // ipcRenderer.on(CLOSE_PLOTTER_WINDOW, async () => {
-    //   if (!!this.window) {
-    //     this.window = null;
-    //   }
-    // });
+  override onStart(): void {
+    this.toDispose.push(
+      window.electronArduino.registerPlotterWindowCloseHandler(() => {
+        this._plotterUrl = undefined;
+      })
+    );
     this.monitorManagerProxy.onMonitorShouldReset(() => this.reset());
-
-    return super.onStart(app);
   }
 
   override registerCommands(registry: CommandRegistry): void {
     registry.registerCommand(SerialPlotterContribution.Commands.OPEN, {
-      execute: this.startPlotter.bind(this),
+      execute: () => this.startPlotter(),
     });
     registry.registerCommand(SerialPlotterContribution.Commands.RESET, {
       execute: () => this.reset(),
@@ -86,7 +68,7 @@ export class PlotterFrontendContribution extends Contribution {
       {
         isVisible: (widget) =>
           ArduinoToolbar.is(widget) && widget.side === 'right',
-        execute: this.startPlotter.bind(this),
+        execute: () => this.startPlotter(),
       }
     );
   }
@@ -99,10 +81,13 @@ export class PlotterFrontendContribution extends Contribution {
     });
   }
 
-  async startPlotter(): Promise<void> {
+  private async startPlotter(forceReload = false): Promise<void> {
     await this.monitorManagerProxy.startMonitor();
-    if (!!this.window) {
-      // ipcRenderer.send(SHOW_PLOTTER_WINDOW);
+    if (this._plotterUrl) {
+      window.electronArduino.showPlotterWindow({
+        url: this._plotterUrl,
+        forceReload,
+      });
       return;
     }
     const wsPort = this.monitorManagerProxy.getWebSocketPort();
@@ -118,26 +103,30 @@ export class PlotterFrontendContribution extends Contribution {
     }
   }
 
-  protected async open(wsPort: number): Promise<void> {
+  private open(wsPort: number): void {
     const initConfig = {
-      darkTheme: this.themeService.getCurrentTheme().type === 'dark',
+      darkTheme: this.isDarkTheme,
       wsPort,
       serialPort: this.model.serialPort,
     };
-    const urlWithParams = queryString.stringifyUrl(
+    this._plotterUrl = queryString.stringifyUrl(
       {
-        url: this.url,
+        url: this.endpointUrl,
         query: initConfig,
       },
       { arrayFormat: 'comma' }
     );
-    this.window = window.open(urlWithParams, 'serialPlotter');
+    window.electronArduino.showPlotterWindow({ url: this._plotterUrl });
+  }
+
+  private get isDarkTheme(): boolean {
+    const themeType = this.themeService.getCurrentTheme().type;
+    return themeType === 'dark' || themeType === 'hc';
   }
 
-  protected async reset(): Promise<void> {
-    if (!!this.window) {
-      this.window.close();
-      await this.startPlotter();
+  private async reset(): Promise<void> {
+    if (this._plotterUrl) {
+      await this.startPlotter(true);
     }
   }
 }

arduino-ide-extension/src/browser/utils/dom.ts

@@ -1,4 +1,4 @@
-import { notEmpty } from '@theia/core';
+import { notEmpty } from '@theia/core/lib/common/objects';
 
 /**
  * Finds the closest child HTMLButtonElement representing a Theia button.

arduino-ide-extension/src/common/ipc-communication.ts

@@ -10,11 +10,13 @@ import {
   CHANNEL_APP_VERSION,
   CHANNEL_CLOSE_WINDOW,
   CHANNEL_IS_FIRST_WINDOW,
+  CHANNEL_PLOTTER_WINDOW_DID_CLOSE,
   CHANNEL_QUIT_APP,
   CHANNEL_SCHEDULE_DELETION,
   CHANNEL_SEND_STARTUP_TASKS,
   CHANNEL_SHOW_MESSAGE_BOX,
   CHANNEL_SHOW_OPEN_DIALOG,
+  CHANNEL_SHOW_PLOTTER_WINDOW,
   CHANNEL_SHOW_SAVE_DIALOG,
   ElectronArduino,
   MessageBoxOptions,
@@ -57,9 +59,18 @@ const api: ElectronArduino = {
   },
   scheduleDeletion: (sketch: Sketch) =>
     ipcRenderer.invoke(CHANNEL_SCHEDULE_DELETION, sketch),
+  showPlotterWindow: (params: { url: string; forceReload?: boolean }) =>
+    ipcRenderer.send(CHANNEL_SHOW_PLOTTER_WINDOW, params),
+  registerPlotterWindowCloseHandler: (handler: () => MaybePromise<void>) => {
+    const listener = () => handler();
+    ipcRenderer.on(CHANNEL_PLOTTER_WINDOW_DID_CLOSE, listener);
+    return Disposable.create(() =>
+      ipcRenderer.removeListener(CHANNEL_PLOTTER_WINDOW_DID_CLOSE, listener)
+    );
+  },
 };
 
 export function preload(): void {
-  console.log('Exposing Arduino IDE electron API');
   contextBridge.exposeInMainWorld('electronArduino', api);
+  console.log('Exposed Arduino IDE electron API');
 }

arduino-ide-extension/src/electron-browser/preload.ts

@@ -21,6 +21,21 @@ export type OpenDialogReturnValue = ElectronOpenDialogReturnValue;
 export type SaveDialogOptions = ElectronSaveDialogOptions;
 export type SaveDialogReturnValue = ElectronSaveDialogReturnValue;
 
+export interface ShowPlotterWindowParams {
+  readonly url: string;
+  readonly forceReload?: boolean;
+}
+export function isShowPlotterWindowParams(
+  arg: unknown
+): arg is ShowPlotterWindowParams {
+  return (
+    typeof arg === 'object' &&
+    typeof (<ShowPlotterWindowParams>arg).url === 'string' &&
+    ((<ShowPlotterWindowParams>arg).forceReload === undefined ||
+      typeof (<ShowPlotterWindowParams>arg).forceReload === 'boolean')
+  );
+}
+
 export interface ElectronArduino {
   showMessageBox(options: MessageBoxOptions): Promise<MessageBoxReturnValue>;
   showOpenDialog(options: OpenDialogOptions): Promise<OpenDialogReturnValue>;
@@ -34,6 +49,10 @@ export interface ElectronArduino {
     handler: (tasks: StartupTasks) => MaybePromise<void>
   ): Disposable;
   scheduleDeletion(sketch: Sketch): void;
+  showPlotterWindow(params: { url: string; forceReload?: boolean }): void;
+  registerPlotterWindowCloseHandler(
+    handler: () => MaybePromise<void>
+  ): Disposable;
 }
 
 declare global {
@@ -51,5 +70,7 @@ export const CHANNEL_QUIT_APP = 'Arduino:QuitApp';
 export const CHANNEL_CLOSE_WINDOW = 'Arduino:CloseWindow';
 export const CHANNEL_IS_FIRST_WINDOW = 'Arduino:IsFirstWindow';
 export const CHANNEL_SCHEDULE_DELETION = 'Arduino:ScheduleDeletion';
+export const CHANNEL_SHOW_PLOTTER_WINDOW = 'Arduino:ShowPlotterWindow';
 // main to renderer
 export const CHANNEL_SEND_STARTUP_TASKS = 'Arduino:SendStartupTasks';
+export const CHANNEL_PLOTTER_WINDOW_DID_CLOSE = 'Arduino:PlotterWindowDidClose';