fix upload when serial port is open

Author: Alberto Iannaccone

arduino-ide-extension/src/browser/monitor/monitor-connection.ts

@@ -19,6 +19,7 @@ import { BoardsConfig } from '../boards/boards-config';
 import { MonitorModel } from './monitor-model';
 import { ThemeService } from '@theia/core/lib/browser/theming';
 import { nls } from '@theia/core/lib/browser/nls';
+import { CoreService } from '../../common/protocol';
 
 @injectable()
 export class SerialConnectionManager {
@@ -64,7 +65,8 @@ export class SerialConnectionManager {
     @inject(BoardsServiceProvider)
     protected readonly boardsServiceProvider: BoardsServiceProvider,
     @inject(MessageService) protected messageService: MessageService,
-    @inject(ThemeService) protected readonly themeService: ThemeService
+    @inject(ThemeService) protected readonly themeService: ThemeService,
+    @inject(CoreService) protected readonly core: CoreService
   ) {
     this.monitorServiceClient.onWebSocketChanged(
       this.handleWebSocketChanged.bind(this)
@@ -121,20 +123,25 @@ export class SerialConnectionManager {
    *
    * @param newConfig the porperties of the config that has changed
    */
-  setConfig(newConfig: Partial<MonitorConfig>): void {
+  async setConfig(newConfig: Partial<MonitorConfig>): Promise<void> {
     let configHasChanged = false;
     Object.keys(this.config).forEach((key: keyof MonitorConfig) => {
       if (newConfig[key] !== this.config[key]) {
         configHasChanged = true;
         this.config = { ...this.config, [key]: newConfig[key] };
       }
     });
-    if (configHasChanged && this.isSerialOpen()) {
+    if (
+      configHasChanged &&
+      this.isSerialOpen() &&
+      !(await this.core.isUploading())
+    ) {
       this.monitorService.updateWsConfigParam({
         currentBaudrate: this.config.baudRate,
         serialPort: this.config.port?.address,
       });
-      this.disconnect().then(() => this.connect());
+      await this.disconnect();
+      await this.connect();
     }
   }
 
@@ -176,22 +183,25 @@ export class SerialConnectionManager {
   /**
    * Sets the types of connections needed by the client.
    *
-   * @param s The new types of connections (can be 'Monitor', 'Plotter', none or both).
+   * @param newState The new types of connections (can be 'Monitor', 'Plotter', none or both).
    *          If the previuos state was empty and 's' is not, it tries to reconnect to the serial service
    *          If the provios state was NOT empty and now it is, it disconnects to the serial service
    * @returns The status of the operation
    */
-  protected async setState(s: Serial.State): Promise<Status> {
+  protected async setState(newState: Serial.State): Promise<Status> {
     const oldState = deepClone(this._state);
-    this._state = s;
     let status = Status.OK;
 
-    if (this.isSerialOpen(oldState) && !this.isSerialOpen()) {
+    if (this.isSerialOpen(oldState) && !this.isSerialOpen(newState)) {
       status = await this.disconnect();
-    } else if (!this.isSerialOpen(oldState) && this.isSerialOpen()) {
+    } else if (!this.isSerialOpen(oldState) && this.isSerialOpen(newState)) {
+      if (await this.core.isUploading()) {
+        this.messageService.error(`Cannot open serial port when uploading`);
+        return Status.NOT_CONNECTED;
+      }
       status = await this.connect();
     }
-
+    this._state = newState;
     return status;
   }
 
@@ -226,6 +236,12 @@ export class SerialConnectionManager {
    * @returns the status of the operation
    */
   async openSerial(type: Serial.Type): Promise<Status> {
+    if (!isMonitorConfig(this.config)) {
+      this.messageService.error(
+        `Please select a board and a port to open the serial connection.`
+      );
+      return Status.NOT_CONNECTED;
+    }
     if (this.state.includes(type)) return Status.OK;
     const newState = deepClone(this.state);
     newState.push(type);
@@ -360,12 +376,7 @@ export class SerialConnectionManager {
 
   async connect(): Promise<Status> {
     if (this.connected) return Status.ALREADY_CONNECTED;
-    if (!isMonitorConfig(this.config)) {
-      this.messageService.error(
-        `Please select a board and a port to open the serial connection.`
-      );
-      return Status.NOT_CONNECTED;
-    }
+    if (!isMonitorConfig(this.config)) return Status.NOT_CONNECTED;
 
     console.info(
       `>>> Creating serial connection for ${Board.toString(

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

@@ -9,6 +9,7 @@ export function messagesToLines(
   const linesToAdd: Line[] = prevLines.length
     ? [prevLines[prevLines.length - 1]]
     : [{ message: '', lineLen: 0 }];
+  if (!(Symbol.iterator in Object(messages))) return [prevLines, charCount];
 
   for (const message of messages) {
     const messageLen = message.length;

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

@@ -55,11 +55,6 @@ export class PlotterFrontendContribution extends Contribution {
       }
     });
 
-    this.monitorConnection.onConnectionChanged((connected) => {
-      if (!!this.window) {
-      }
-    });
-
     return super.onStart(app);
   }
 
@@ -78,17 +73,16 @@ export class PlotterFrontendContribution extends Contribution {
   }
 
   async connect(): Promise<void> {
-    if (this.monitorConnection.connected) {
-      if (!!this.window) {
-        this.window.focus();
-        return;
-      }
+    if (!!this.window) {
+      this.window.focus();
+      return;
     }
     const status = await this.monitorConnection.openSerial(Serial.Type.Plotter);
     const wsPort = this.monitorConnection.getWsPort();
     if (Status.isOK(status) && wsPort) {
       this.open(wsPort);
     } else {
+      this.monitorConnection.closeSerial(Serial.Type.Plotter);
       this.messageService.error(`Couldn't open serial plotter`);
     }
   }

arduino-ide-extension/src/common/protocol/core-service.ts

@@ -22,6 +22,7 @@ export interface CoreService {
   upload(options: CoreService.Upload.Options): Promise<void>;
   uploadUsingProgrammer(options: CoreService.Upload.Options): Promise<void>;
   burnBootloader(options: CoreService.Bootloader.Options): Promise<void>;
+  isUploading(): Promise<boolean>;
 }
 
 export namespace CoreService {

arduino-ide-extension/src/node/core-service-impl.ts

@@ -32,6 +32,8 @@ export class CoreServiceImpl extends CoreClientAware implements CoreService {
   @inject(NotificationServiceServer)
   protected readonly notificationService: NotificationServiceServer;
 
+  protected uploading = false;
+
   async compile(
     options: CoreService.Compile.Options & {
       exportBinaries?: boolean;
@@ -110,6 +112,10 @@ export class CoreServiceImpl extends CoreClientAware implements CoreService {
     );
   }
 
+  isUploading(): Promise<boolean> {
+    return Promise.resolve(this.uploading);
+  }
+
   protected async doUpload(
     options: CoreService.Upload.Options,
     requestProvider: () => UploadRequest | UploadUsingProgrammerRequest,
@@ -120,6 +126,7 @@ export class CoreServiceImpl extends CoreClientAware implements CoreService {
     ) => ClientReadableStream<UploadResponse | UploadUsingProgrammerResponse>,
     task = 'upload'
   ): Promise<void> {
+    this.uploading = true;
     await this.compile(Object.assign(options, { exportBinaries: false }));
     const { sketchUri, fqbn, port, programmer } = options;
     const sketchPath = FileUri.fsPath(sketchUri);
@@ -173,6 +180,8 @@ export class CoreServiceImpl extends CoreClientAware implements CoreService {
         severity: 'error',
       });
       throw e;
+    } finally {
+      this.uploading = false;
     }
   }
 

arduino-ide-extension/src/test/browser/serial-connection-manager.test.ts

@@ -11,6 +11,7 @@ import { Emitter, MessageService } from '@theia/core';
 import { BoardsServiceProvider } from '../../browser/boards/boards-service-provider';
 import {
   BoardsService,
+  CoreService,
   MonitorService,
   MonitorServiceClient,
   Status,
@@ -51,6 +52,7 @@ describe.only('SerialConnectionManager', () => {
   let boardsServiceProvider: IMock<BoardsServiceProvider>;
   let messageService: IMock<MessageService>;
   let themeService: IMock<ThemeService>;
+  let core: IMock<CoreService>;
 
   let handleBoardConfigChange: (
     boardsConfig: BoardsConfig.Config
@@ -68,6 +70,7 @@ describe.only('SerialConnectionManager', () => {
     boardsServiceProvider = Mock.ofType<BoardsServiceProvider>();
     messageService = Mock.ofType<MessageService>();
     themeService = Mock.ofType<ThemeService>();
+    core = Mock.ofType<CoreService>();
 
     boardsServiceProvider
       .setup((b) => b.boardsConfig)
@@ -103,14 +106,17 @@ describe.only('SerialConnectionManager', () => {
       .setup((m) => m.disconnect())
       .returns(() => Promise.resolve(Status.OK));
 
+    core.setup((u) => u.isUploading()).returns(() => Promise.resolve(false));
+
     subject = new SerialConnectionManager(
       monitorModel.object,
       monitorService.object,
       monitorServiceClient.object,
       boardsService.object,
       boardsServiceProvider.object,
       messageService.object,
-      themeService.object
+      themeService.object,
+      core.object
     );
   });
 

yarn.lock

@@ -4109,10 +4109,10 @@ archive-type@^4.0.0:
   dependencies:
     file-type "^4.2.0"
 
-[email protected].10:
-  version "0.0.10"
-  resolved "https://registry.yarnpkg.com/arduino-serial-plotter-webapp/-/arduino-serial-plotter-webapp-0.0.10.tgz#1379e91705a0462ae31badffabaea8563ef59a51"
-  integrity sha512-FqFPk2k8iPrMr2vuZfkEbxhbWPy7zn5a9+PMZp2C4akmjdWD6V2ZO89rDOs8ODr0IZgEJxyKpGG212css5vS6g==
+[email protected].11:
+  version "0.0.11"
+  resolved "https://registry.yarnpkg.com/arduino-serial-plotter-webapp/-/arduino-serial-plotter-webapp-0.0.11.tgz#a4197f8b2d005ba782bef57ce1aa9b73398ef8a3"
+  integrity sha512-WcPsCC0S6GefRVdsvFlng4+6ohjiIcTfolr/39zDMV3OjoRPOCqBTEEiYtrymWX9ujaaas1m6aFhTGDjisZwmQ==
 
 are-we-there-yet@~1.1.2:
   version "1.1.5"