Fixed ordering of out/err chunks received from CLI

Signed-off-by: Akos Kitta <[email protected]>

Author: Akos Kitta

arduino-ide-extension/src/node/cli-error-parser.ts

@@ -105,7 +105,7 @@ function range(line: number, column?: number): Range {
   };
 }
 
-export function tryParse(content: string): ParseResult[] {
+function tryParse(content: string): ParseResult[] {
   // Shamelessly stolen from the Java IDE: https://github.com/arduino/Arduino/blob/43b0818f7fa8073301db1b80ac832b7b7596b828/arduino-core/src/cc/arduino/Compiler.java#L137
   const re = new RegExp(
     '(.+\\.\\w+):(\\d+)(:\\d+)*:\\s*((fatal)?\\s*error:\\s*)(.*)\\s*',

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

@@ -347,11 +347,7 @@ export class CoreServiceImpl extends CoreClientAware implements CoreService {
   } {
     const content: Buffer[] = [];
     const buffer = new AutoFlushingBuffer((chunks) => {
-      Array.from(chunks.entries()).forEach(([severity, chunk]) => {
-        if (chunk) {
-          this.sendResponse(chunk, severity);
-        }
-      });
+      chunks.forEach(([severity, chunk]) => this.sendResponse(chunk, severity));
     });
     const onData = StreamingResponse.createOnDataHandler({
       content,

arduino-ide-extension/src/node/utils/buffers.ts

@@ -3,13 +3,13 @@ import { Disposable } from '@theia/core/shared/vscode-languageserver-protocol';
 import { OutputMessage } from '../../common/protocol';
 
 export class AutoFlushingBuffer implements Disposable {
-  private readonly chunks = Chunks.create();
+  private readonly chunks: Array<[OutputMessage.Severity, Uint8Array]> = [];
   private readonly toDispose;
   private timer?: NodeJS.Timeout;
   private disposed = false;
 
   constructor(
-    onFlush: (chunks: Map<OutputMessage.Severity, string | undefined>) => void,
+    onFlush: (chunks: Array<[OutputMessage.Severity, string]>) => void,
     taskTimeout: number = AutoFlushingBuffer.DEFAULT_FLUSH_TIMEOUT_MS
   ) {
     const task = () => {
@@ -34,7 +34,9 @@ export class AutoFlushingBuffer implements Disposable {
     chunk: Uint8Array,
     severity: OutputMessage.Severity = OutputMessage.Severity.Info
   ): void {
-    this.chunks.get(severity)?.push(chunk);
+    if (chunk.length) {
+      this.chunks.push([severity, chunk]);
+    }
   }
 
   dispose(): void {
@@ -49,32 +51,46 @@ export namespace AutoFlushingBuffer {
   export const DEFAULT_FLUSH_TIMEOUT_MS = 32;
 }
 
-type Chunks = Map<OutputMessage.Severity, Uint8Array[]>;
+type Chunks = Array<[OutputMessage.Severity, Uint8Array]>;
 namespace Chunks {
-  export function create(): Chunks {
-    return new Map([
-      [OutputMessage.Severity.Error, []],
-      [OutputMessage.Severity.Warning, []],
-      [OutputMessage.Severity.Info, []],
-    ]);
-  }
   export function clear(chunks: Chunks): Chunks {
-    for (const chunk of chunks.values()) {
-      chunk.length = 0;
-    }
+    chunks.length = 0;
     return chunks;
   }
   export function isEmpty(chunks: Chunks): boolean {
     return ![...chunks.values()].some((chunk) => Boolean(chunk.length));
   }
   export function toString(
     chunks: Chunks
-  ): Map<OutputMessage.Severity, string | undefined> {
-    return new Map(
-      Array.from(chunks.entries()).map(([severity, buffers]) => [
-        severity,
-        buffers.length ? Buffer.concat(buffers).toString() : undefined,
-      ])
-    );
+  ): Array<[OutputMessage.Severity, string]> {
+    const result: Array<[OutputMessage.Severity, string]> = [];
+    let current:
+      | { severity: OutputMessage.Severity; buffers: Uint8Array[] }
+      | undefined = undefined;
+    const appendToResult = () => {
+      if (current && current.buffers) {
+        result.push([
+          current.severity,
+          Buffer.concat(current.buffers).toString('utf-8'),
+        ]);
+      }
+    };
+    for (const [severity, buffer] of chunks) {
+      if (!buffer.length) {
+        continue;
+      }
+      if (!current) {
+        current = { severity, buffers: [buffer] };
+      } else {
+        if (current.severity === severity) {
+          current.buffers.push(buffer);
+        } else {
+          appendToResult();
+          current = { severity, buffers: [buffer] };
+        }
+      }
+    }
+    appendToResult();
+    return result;
   }
 }