serial-service tests

Author: fstasi

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/serial/serial-connection-manager.ts

@@ -169,7 +169,6 @@ export class SerialConnectionManager {
       this.messageService.error(
         `Please select a board and a port to open the serial connection.`
       );
-      return;
     }
 
     if (!this.webSocket && this.wsPort) {

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

@@ -63,16 +63,6 @@ namespace ErrorWithCode {
 
 @injectable()
 export class SerialServiceImpl implements SerialService {
-  @named(SerialServiceName)
-  @inject(ILogger)
-  protected readonly logger: ILogger;
-
-  @inject(MonitorClientProvider)
-  protected readonly serialClientProvider: MonitorClientProvider;
-
-  @inject(WebSocketService)
-  protected readonly webSocketService: WebSocketService;
-
   protected theiaFEClient?: SerialServiceClient;
   protected serialConfig?: SerialConfig;
 
@@ -88,6 +78,18 @@ export class SerialServiceImpl implements SerialService {
 
   uploadInProgress = false;
 
+  constructor(
+    @inject(ILogger)
+    @named(SerialServiceName)
+    protected readonly logger: ILogger,
+
+    @inject(MonitorClientProvider)
+    protected readonly serialClientProvider: MonitorClientProvider,
+
+    @inject(WebSocketService)
+    protected readonly webSocketService: WebSocketService
+  ) {}
+
   async isSerialPortOpen(): Promise<boolean> {
     return !!this.serialConnection;
   }
@@ -115,7 +117,6 @@ export class SerialServiceImpl implements SerialService {
   public async connectSerialIfRequired(): Promise<void> {
     if (this.uploadInProgress) return;
     const clients = await this.clientsAttached();
-    this.logger.info(`WS clients: ${clients}`);
     clients > 0 ? await this.connect() : await this.disconnect();
   }
 
@@ -144,7 +145,7 @@ export class SerialServiceImpl implements SerialService {
     this.webSocketService.sendMessage(JSON.stringify(msg));
   }
 
-  async connect(): Promise<Status> {
+  private async connect(): Promise<Status> {
     if (!this.serialConfig) {
       return Status.CONFIG_MISSING;
     }
@@ -155,8 +156,6 @@ export class SerialServiceImpl implements SerialService {
       )} on port ${Port.toString(this.serialConfig.port)}...`
     );
 
-    // check if the board/port is available
-
     if (this.serialConnection) {
       return Status.ALREADY_CONNECTED;
     }
@@ -187,7 +186,6 @@ export class SerialServiceImpl implements SerialService {
           // Log the original, unexpected error.
           this.logger.error(error);
         }
-        // });
       }).bind(this)
     );
 
@@ -259,9 +257,19 @@ export class SerialServiceImpl implements SerialService {
     }
     req.setConfig(monitorConfig);
 
-    return new Promise<Status>((resolve) => {
-      if (this.serialConnection) {
-        this.serialConnection.duplex.write(req, () => {
+    if (!this.serialConnection) {
+      return await this.disconnect();
+    }
+
+    const writeTimeout = new Promise<Status>((resolve) => {
+      setTimeout(async () => {
+        resolve(Status.NOT_CONNECTED);
+      }, 1000);
+    });
+
+    const writePromise = (serialConnection: any) => {
+      return new Promise<Status>((resolve) => {
+        serialConnection.duplex.write(req, () => {
           const boardName = this.serialConfig?.board
             ? Board.toString(this.serialConfig.board, {
                 useFqbn: false,
@@ -276,14 +284,23 @@ export class SerialServiceImpl implements SerialService {
           );
           resolve(Status.OK);
         });
-        return;
-      }
-      this.disconnect().then(() => resolve(Status.NOT_CONNECTED));
-    });
+      });
+    };
+
+    const status = await Promise.race([
+      writeTimeout,
+      writePromise(this.serialConnection),
+    ]);
+
+    if (status === Status.NOT_CONNECTED) {
+      this.disconnect();
+    }
+
+    return status;
   }
 
   public async disconnect(reason?: SerialError): Promise<Status> {
-    return new Promise<Status>((resolve, reject) => {
+    return new Promise<Status>((resolve) => {
       try {
         if (this.onMessageReceived) {
           this.onMessageReceived.dispose();
@@ -299,12 +316,14 @@ export class SerialServiceImpl implements SerialService {
           reason &&
           reason.code === SerialError.ErrorCodes.CLIENT_CANCEL
         ) {
-          return Status.OK;
+          resolve(Status.OK);
+          return;
         }
         this.logger.info('>>> Disposing serial connection...');
         if (!this.serialConnection) {
           this.logger.warn('<<< Not connected. Nothing to dispose.');
-          return Status.NOT_CONNECTED;
+          resolve(Status.NOT_CONNECTED);
+          return;
         }
         const { duplex, config } = this.serialConnection;