Fix upload and serial (#661)

* get serial connection status from BE

* handle serial connect in the BE

* allow breakpoints on vscode (windows)

* Timeout on config change to prevent serial busy

* serial-service tests

Author: fstasi

.vscode/launch.json

@@ -8,10 +8,6 @@
       "runtimeExecutable": "${workspaceRoot}/node_modules/.bin/electron",
       "windows": {
         "runtimeExecutable": "${workspaceRoot}/node_modules/.bin/electron.cmd",
-        "env": {
-          "NODE_ENV": "development",
-          "NODE_PRESERVE_SYMLINKS": "1"
-        }
       },
       "cwd": "${workspaceFolder}/electron-app",
       "protocol": "inspector",

arduino-ide-extension/package.json

@@ -19,12 +19,11 @@
     "test:watch": "mocha --watch --watch-files lib \"./lib/test/**/*.test.js\""
   },
   "dependencies": {
-    "arduino-serial-plotter-webapp": "0.0.15",   
     "@grpc/grpc-js": "^1.3.7",
     "@theia/application-package": "1.19.0",
     "@theia/core": "1.19.0",
     "@theia/editor": "1.19.0",
-		"@theia/editor-preview": "1.19.0",
+    "@theia/editor-preview": "1.19.0",
     "@theia/filesystem": "1.19.0",
     "@theia/git": "1.19.0",
     "@theia/keymaps": "1.19.0",
@@ -53,10 +52,10 @@
     "@types/ps-tree": "^1.1.0",
     "@types/react-select": "^3.0.0",
     "@types/react-tabs": "^2.3.2",
-    "@types/sinon": "^7.5.2",
     "@types/temp": "^0.8.34",
     "@types/which": "^1.3.1",
     "ajv": "^6.5.3",
+    "arduino-serial-plotter-webapp": "0.0.15",
     "async-mutex": "^0.3.0",
     "atob": "^2.1.2",
     "auth0-js": "^9.14.0",
@@ -97,6 +96,8 @@
     "@types/chai-string": "^1.4.2",
     "@types/mocha": "^5.2.7",
     "@types/react-window": "^1.8.5",
+    "@types/sinon": "^10.0.6",
+    "@types/sinon-chai": "^3.2.6",
     "chai": "^4.2.0",
     "chai-string": "^1.5.0",
     "decompress": "^4.2.0",
@@ -109,7 +110,8 @@
     "moment": "^2.24.0",
     "protoc": "^1.0.4",
     "shelljs": "^0.8.3",
-    "sinon": "^9.0.1",
+    "sinon": "^12.0.1",
+    "sinon-chai": "^3.7.0",
     "typemoq": "^2.1.0",
     "uuid": "^3.2.1",
     "yargs": "^11.1.0"

arduino-ide-extension/src/browser/contributions/burn-bootloader.ts

@@ -48,7 +48,6 @@ export class BurnBootloader extends SketchContribution {
   }
 
   async burnBootloader(): Promise<void> {
-    await this.serialConnection.disconnect();
     try {
       const { boardsConfig } = this.boardsServiceClientImpl;
       const port = boardsConfig.selectedPort;
@@ -87,9 +86,7 @@ export class BurnBootloader extends SketchContribution {
       }
       this.messageService.error(errorMessage);
     } finally {
-      if (this.serialConnection.isSerialOpen()) {
-        await this.serialConnection.connect();
-      }
+      await this.serialConnection.reconnectAfterUpload();
     }
   }
 }

arduino-ide-extension/src/browser/contributions/upload-sketch.ts

@@ -210,7 +210,7 @@ export class UploadSketch extends SketchContribution {
     if (!sketch) {
       return;
     }
-    await this.serialConnection.disconnect();
+
     try {
       const { boardsConfig } = this.boardsServiceClientImpl;
       const [fqbn, { selectedProgrammer }, verify, verbose, sourceOverride] =
@@ -288,27 +288,7 @@ export class UploadSketch extends SketchContribution {
       this.uploadInProgress = false;
       this.onDidChangeEmitter.fire();
 
-      if (
-        this.serialConnection.isSerialOpen() &&
-        this.serialConnection.serialConfig
-      ) {
-        const { board, port } = this.serialConnection.serialConfig;
-        try {
-          await this.boardsServiceClientImpl.waitUntilAvailable(
-            Object.assign(board, { port }),
-            10_000
-          );
-          await this.serialConnection.connect();
-        } catch (waitError) {
-          this.messageService.error(
-            nls.localize(
-              'arduino/sketch/couldNotConnectToSerial',
-              'Could not reconnect to serial port. {0}',
-              waitError.toString()
-            )
-          );
-        }
-      }
+      setTimeout(() => this.serialConnection.reconnectAfterUpload(), 5000);
     }
   }
 }

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

@@ -12,7 +12,7 @@ import {
 import { SerialConfig } from '../../../common/protocol/serial-service';
 import { ArduinoSelect } from '../../widgets/arduino-select';
 import { SerialModel } from '../serial-model';
-import { Serial, SerialConnectionManager } from '../serial-connection-manager';
+import { SerialConnectionManager } from '../serial-connection-manager';
 import { SerialMonitorSendInput } from './serial-monitor-send-input';
 import { SerialMonitorOutput } from './serial-monitor-send-output';
 import { BoardsServiceProvider } from '../../boards/boards-service-provider';
@@ -57,9 +57,7 @@ export class MonitorWidget extends ReactWidget {
     this.scrollOptions = undefined;
     this.toDispose.push(this.clearOutputEmitter);
     this.toDispose.push(
-      Disposable.create(() =>
-        this.serialConnection.closeSerial(Serial.Type.Monitor)
-      )
+      Disposable.create(() => this.serialConnection.closeWStoBE())
     );
   }
 
@@ -83,7 +81,7 @@ export class MonitorWidget extends ReactWidget {
 
   protected onAfterAttach(msg: Message): void {
     super.onAfterAttach(msg);
-    this.serialConnection.openSerial(Serial.Type.Monitor);
+    this.serialConnection.openWSToBE();
   }
 
   onCloseRequest(msg: Message): void {
@@ -171,7 +169,7 @@ export class MonitorWidget extends ReactWidget {
         <div className="head">
           <div className="send">
             <SerialMonitorSendInput
-              serialConfig={this.serialConnection.serialConfig}
+              serialConnection={this.serialConnection}
               resolveFocus={this.onFocusResolved}
               onSend={this.onSend}
             />

arduino-ide-extension/src/browser/serial/monitor/serial-monitor-send-input.tsx

@@ -1,39 +1,66 @@
 import * as React from 'react';
 import { Key, KeyCode } from '@theia/core/lib/browser/keys';
 import { Board, Port } from '../../../common/protocol/boards-service';
-import { SerialConfig } from '../../../common/protocol/serial-service';
 import { isOSX } from '@theia/core/lib/common/os';
-import { nls } from '@theia/core/lib/common';
+import { DisposableCollection, nls } from '@theia/core/lib/common';
+import { SerialConnectionManager } from '../serial-connection-manager';
+import { SerialPlotter } from '../plotter/protocol';
 
 export namespace SerialMonitorSendInput {
   export interface Props {
-    readonly serialConfig?: SerialConfig;
+    readonly serialConnection: SerialConnectionManager;
     readonly onSend: (text: string) => void;
     readonly resolveFocus: (element: HTMLElement | undefined) => void;
   }
   export interface State {
     text: string;
+    connected: boolean;
   }
 }
 
 export class SerialMonitorSendInput extends React.Component<
   SerialMonitorSendInput.Props,
   SerialMonitorSendInput.State
 > {
+  protected toDisposeBeforeUnmount = new DisposableCollection();
+
   constructor(props: Readonly<SerialMonitorSendInput.Props>) {
     super(props);
-    this.state = { text: '' };
+    this.state = { text: '', connected: false };
     this.onChange = this.onChange.bind(this);
     this.onSend = this.onSend.bind(this);
     this.onKeyDown = this.onKeyDown.bind(this);
   }
 
+  componentDidMount(): void {
+    this.props.serialConnection.isBESerialConnected().then((connected) => {
+      this.setState({ connected });
+    });
+
+    this.toDisposeBeforeUnmount.pushAll([
+      this.props.serialConnection.onRead(({ messages }) => {
+        if (
+          messages.command ===
+            SerialPlotter.Protocol.Command.MIDDLEWARE_CONFIG_CHANGED &&
+          'connected' in messages.data
+        ) {
+          this.setState({ connected: messages.data.connected });
+        }
+      }),
+    ]);
+  }
+
+  componentWillUnmount(): void {
+    // TODO: "Your preferred browser's local storage is almost full." Discard `content` before saving layout?
+    this.toDisposeBeforeUnmount.dispose();
+  }
+
   render(): React.ReactNode {
     return (
       <input
         ref={this.setRef}
         type="text"
-        className={`theia-input ${this.props.serialConfig ? '' : 'warning'}`}
+        className={`theia-input ${this.state.connected ? '' : 'warning'}`}
         placeholder={this.placeholder}
         value={this.state.text}
         onChange={this.onChange}
@@ -43,8 +70,8 @@ export class SerialMonitorSendInput extends React.Component<
   }
 
   protected get placeholder(): string {
-    const { serialConfig } = this.props;
-    if (!serialConfig) {
+    const serialConfig = this.props.serialConnection.getConfig();
+    if (!this.state.connected || !serialConfig) {
       return nls.localize(
         'arduino/serial/notConnected',
         'Not connected. Select a board and a port to connect automatically.'
@@ -55,10 +82,12 @@ export class SerialMonitorSendInput extends React.Component<
       'arduino/serial/message',
       "Message ({0} + Enter to send message to '{1}' on '{2}'",
       isOSX ? '⌘' : nls.localize('vscode/keybindingLabels/ctrlKey', 'Ctrl'),
-      Board.toString(board, {
-        useFqbn: false,
-      }),
-      Port.toString(port)
+      board
+        ? Board.toString(board, {
+            useFqbn: false,
+          })
+        : 'unknown',
+      port ? Port.toString(port) : 'unknown'
     );
   }
 

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

@@ -11,8 +11,8 @@ import { ArduinoMenus } from '../../menu/arduino-menus';
 import { Contribution } from '../../contributions/contribution';
 import { Endpoint, FrontendApplication } from '@theia/core/lib/browser';
 import { ipcRenderer } from '@theia/core/shared/electron';
-import { SerialConfig, Status } from '../../../common/protocol';
-import { Serial, SerialConnectionManager } from '../serial-connection-manager';
+import { SerialConfig } from '../../../common/protocol';
+import { SerialConnectionManager } from '../serial-connection-manager';
 import { SerialPlotter } from './protocol';
 import { BoardsServiceProvider } from '../../boards/boards-service-provider';
 const queryString = require('query-string');
@@ -51,10 +51,8 @@ export class PlotterFrontendContribution extends Contribution {
     ipcRenderer.on('CLOSE_CHILD_WINDOW', async () => {
       if (!!this.window) {
         this.window = null;
-        await this.serialConnection.closeSerial(Serial.Type.Plotter);
       }
     });
-
     return super.onStart(app);
   }
 
@@ -77,25 +75,23 @@ export class PlotterFrontendContribution extends Contribution {
       this.window.focus();
       return;
     }
-    const status = await this.serialConnection.openSerial(Serial.Type.Plotter);
     const wsPort = this.serialConnection.getWsPort();
-    if (Status.isOK(status) && wsPort) {
+    if (wsPort) {
       this.open(wsPort);
     } else {
-      this.serialConnection.closeSerial(Serial.Type.Plotter);
       this.messageService.error(`Couldn't open serial plotter`);
     }
   }
 
-  protected open(wsPort: number): void {
+  protected async open(wsPort: number): Promise<void> {
     const initConfig: Partial<SerialPlotter.Config> = {
       baudrates: SerialConfig.BaudRates.map((b) => b),
       currentBaudrate: this.model.baudRate,
       currentLineEnding: this.model.lineEnding,
       darkTheme: this.themeService.getCurrentTheme().type === 'dark',
       wsPort,
       interpolate: this.model.interpolate,
-      connected: this.serialConnection.connected,
+      connected: await this.serialConnection.isBESerialConnected(),
       serialPort: this.boardsServiceProvider.boardsConfig.selectedPort?.address,
     };
     const urlWithParams = queryString.stringifyUrl(