change output buffer to setTimeout

Author: davegarthsimpson

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

@@ -76,10 +76,11 @@ export class CoreServiceImpl extends CoreClientAware implements CoreService {
                 .filter(notEmpty)
                 .shift() ?? error.details
             );
-            this.sendResponse(
-              error.details + '\n\n' + message,
-              OutputMessage.Severity.Error
+            const chunk = new TextEncoder().encode(
+              `${error.details}'\n\n'${message}`
             );
+            handler.addChunk(chunk, OutputMessage.Severity.Error);
+
             reject(CoreError.VerifyFailed(message, compilerErrors));
           }
         })
@@ -181,7 +182,8 @@ export class CoreServiceImpl extends CoreClientAware implements CoreService {
                 firstToUpperCase(task),
                 error.details
               );
-              this.sendResponse(error.details, OutputMessage.Severity.Error);
+              const chunk = new TextEncoder().encode(error.details);
+              handler.addChunk(chunk, OutputMessage.Severity.Error);
               reject(
                 errorHandler(
                   message,
@@ -245,7 +247,8 @@ export class CoreServiceImpl extends CoreClientAware implements CoreService {
               );
               reject(error);
             } else {
-              this.sendResponse(error.details, OutputMessage.Severity.Error);
+              const chunk = new TextEncoder().encode(error.details);
+              handler.addChunk(chunk, OutputMessage.Severity.Error);
               reject(
                 CoreError.BurnBootloaderFailed(
                   nls.localize(
@@ -288,6 +291,7 @@ export class CoreServiceImpl extends CoreClientAware implements CoreService {
   private createOnDataHandler<R extends StreamingResponse>(): Disposable & {
     stderr: Buffer[];
     onData: (response: R) => void;
+    addChunk: (chunk: Uint8Array, severity?: OutputMessage.Severity) => void;
   } {
     const stderr: Buffer[] = [];
     const buffer = new SimpleBuffer((chunks) => {
@@ -301,10 +305,14 @@ export class CoreServiceImpl extends CoreClientAware implements CoreService {
       buffer.addChunk(out);
       buffer.addChunk(err, OutputMessage.Severity.Error);
     });
+    const addChunk = (chunk: Uint8Array, severity?: OutputMessage.Severity) =>
+      buffer.addChunk(chunk, severity);
+
     return {
       dispose: () => buffer.dispose(),
       stderr,
       onData,
+      addChunk,
     };
   }
 

arduino-ide-extension/src/node/utils/simple-buffer.ts

@@ -6,7 +6,8 @@ const DEFAULT_FLUS_TIMEOUT_MS = 32;
 export class SimpleBuffer implements Disposable {
   private readonly chunks = Chunks.create();
   private readonly flush: () => void;
-  private flushInterval?: NodeJS.Timeout;
+  private flushTimeout?: NodeJS.Timeout;
+  private disposed = false;
 
   constructor(
     onFlush: (chunks: Map<OutputMessage.Severity, string | undefined>) => void,
@@ -19,7 +20,8 @@ export class SimpleBuffer implements Disposable {
         onFlush(chunks);
       }
     };
-    this.flushInterval = setInterval(this.flush, flushTimeout);
+
+    this.setTimeoutVariable(flushTimeout);
   }
 
   addChunk(
@@ -33,11 +35,40 @@ export class SimpleBuffer implements Disposable {
     Chunks.clear(this.chunks);
   }
 
+  private setTimeoutVariable(flushTimeout: number): void {
+    let isDisposed = this.disposed;
+    if (isDisposed) {
+      // once "isDisposed" is true we stop
+      // creating timeouts and do one more
+      // flush AFTER any setTimeout
+      // callback that may be in progress
+      this.flush();
+      isDisposed = false;
+      return;
+    }
+
+    if (!this.flushTimeout) {
+      const onTimeout = () => {
+        this.flush();
+        this.clearTimeoutVariable();
+      };
+
+      this.flushTimeout = setTimeout(() => {
+        onTimeout();
+        this.setTimeoutVariable(flushTimeout);
+      }, flushTimeout);
+    }
+  }
+
+  private clearTimeoutVariable(): void {
+    if (this.flushTimeout) {
+      clearTimeout(this.flushTimeout);
+      this.flushTimeout = undefined;
+    }
+  }
+
   dispose(): void {
-    this.flush();
-    clearInterval(this.flushInterval);
-    this.clearChunks();
-    this.flushInterval = undefined;
+    this.disposed = true;
   }
 }