test monitor utils

Author: Alberto Iannaccone

arduino-ide-extension/package.json

@@ -102,6 +102,7 @@
     "download": "^7.1.0",
     "grpc_tools_node_protoc_ts": "^4.1.0",
     "mocha": "^7.0.0",
+    "mockdate": "^3.0.5",
     "moment": "^2.24.0",
     "protoc": "^1.0.4",
     "shelljs": "^0.8.3",

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

@@ -1,14 +1,14 @@
 import { Line, SerialMonitorOutput } from './serial-monitor-send-output';
 
-export function messageToLines(
+export function messagesToLines(
   messages: string[],
-  prevLines: Line[],
+  prevLines: Line[] = [],
+  charCount = 0,
   separator = '\n'
 ): [Line[], number] {
   const linesToAdd: Line[] = prevLines.length
     ? [prevLines[prevLines.length - 1]]
-    : [{ message: '', lineLen: 0 }];
-  let charCount = 0;
+    : [{ message: '' }];
 
   for (const message of messages) {
     const messageLen = message.length;
@@ -20,12 +20,10 @@ export function messageToLines(
       linesToAdd.push({
         message,
         timestamp: new Date(),
-        lineLen: messageLen,
       });
     } else {
       // concatenate to the last line
       linesToAdd[linesToAdd.length - 1].message += message;
-      linesToAdd[linesToAdd.length - 1].lineLen += messageLen;
       if (!linesToAdd[linesToAdd.length - 1].timestamp) {
         linesToAdd[linesToAdd.length - 1].timestamp = new Date();
       }
@@ -38,12 +36,13 @@ export function messageToLines(
 
 export function truncateLines(
   lines: Line[],
-  charCount: number
+  charCount: number,
+  maxCharacters: number = SerialMonitorOutput.MAX_CHARACTERS
 ): [Line[], number] {
-  let charsToDelete = charCount - SerialMonitorOutput.MAX_CHARACTERS;
+  let charsToDelete = charCount - maxCharacters;
   let lineIndex = 0;
-  while (charsToDelete > 0) {
-    const firstLineLength = lines[lineIndex]?.lineLen;
+  while (charsToDelete > 0 || lineIndex > 0) {
+    const firstLineLength = lines[lineIndex]?.message.length || 0;
 
     if (charsToDelete >= firstLineLength) {
       // every time a full line to delete is found, move the index.
@@ -55,6 +54,7 @@ export function truncateLines(
 
     // delete all previous lines
     lines.splice(0, lineIndex);
+    lineIndex = 0;
 
     const newFirstLine = lines[0]?.message?.substring(charsToDelete);
     const deletedCharsCount = firstLineLength - newFirstLine.length;

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

@@ -6,9 +6,9 @@ import AutoSizer from 'react-virtualized-auto-sizer';
 import { MonitorModel } from './monitor-model';
 import { MonitorConnection } from './monitor-connection';
 import dateFormat = require('dateformat');
-import { messageToLines, truncateLines } from './monitor-utils';
+import { messagesToLines, truncateLines } from './monitor-utils';
 
-export type Line = { message: string; timestamp?: Date; lineLen: number };
+export type Line = { message: string; timestamp?: Date };
 
 export class SerialMonitorOutput extends React.Component<
   SerialMonitorOutput.Props,
@@ -66,14 +66,12 @@ export class SerialMonitorOutput extends React.Component<
     this.scrollToBottom();
     this.toDisposeBeforeUnmount.pushAll([
       this.props.monitorConnection.onRead(({ messages }) => {
-        const [newLines, charsToAddCount] = messageToLines(
+        const [newLines, totalCharCount] = messagesToLines(
           messages,
-          this.state.lines
-        );
-        const [lines, charCount] = truncateLines(
-          newLines,
-          this.state.charCount + charsToAddCount
+          this.state.lines,
+          this.state.charCount
         );
+        const [lines, charCount] = truncateLines(newLines, totalCharCount);
 
         this.setState({
           lines,
@@ -119,7 +117,7 @@ const Row = ({
       `${dateFormat(data.lines[index].timestamp, 'H:M:ss.l')} -> `) ||
     '';
   return (
-    (data.lines[index].lineLen && (
+    (data.lines[index].message?.length && (
       <div style={style}>
         {timestamp}
         {data.lines[index].message}

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

@@ -0,0 +1,153 @@
+import { expect } from 'chai';
+import {
+  messagesToLines,
+  truncateLines,
+} from '../../browser/monitor/monitor-utils';
+import { Line } from '../../browser/monitor/serial-monitor-send-output';
+import { set, reset } from 'mockdate';
+
+type TestLine = {
+  messages: string[];
+  prevLines?: { lines: Line[]; charCount: number };
+  expected: { lines: Line[]; charCount: number };
+  expectedTruncated?: {
+    lines: Line[];
+    charCount: number;
+    maxCharacters?: number;
+  };
+};
+
+const date = new Date();
+const testLines: TestLine[] = [
+  {
+    messages: ['Hello'],
+    expected: { lines: [{ message: 'Hello' }], charCount: 5 },
+  },
+  {
+    messages: ['Hello', 'Dog!'],
+    expected: { lines: [{ message: 'HelloDog!' }], charCount: 9 },
+  },
+  {
+    messages: ['Hello\n', 'Dog!'],
+    expected: {
+      lines: [{ message: 'Hello\n' }, { message: 'Dog!' }],
+      charCount: 10,
+    },
+  },
+  {
+    messages: ['Dog!'],
+    prevLines: { lines: [{ message: 'Hello\n' }], charCount: 6 },
+    expected: {
+      lines: [{ message: 'Hello\n' }, { message: 'Dog!' }],
+      charCount: 10,
+    },
+  },
+  {
+    messages: [' Dog!\n', " Who's a good ", 'boy?\n', "You're a good boy!"],
+    prevLines: { lines: [{ message: 'Hello' }], charCount: 5 },
+    expected: {
+      lines: [
+        { message: 'Hello Dog!\n' },
+        { message: " Who's a good boy?\n" },
+        { message: "You're a good boy!" },
+      ],
+      charCount: 48,
+    },
+    expectedTruncated: {
+      maxCharacters: 20,
+      charCount: 20,
+      lines: [{ message: '?\n' }, { message: "You're a good boy!" }],
+    },
+  },
+  {
+    messages: ['boy?\n', "You're a good boy!"],
+    prevLines: {
+      lines: [{ message: 'Hello Dog!\n' }, { message: " Who's a good " }],
+      charCount: 25,
+    },
+    expected: {
+      lines: [
+        { message: 'Hello Dog!\n' },
+        { message: " Who's a good boy?\n" },
+        { message: "You're a good boy!" },
+      ],
+      charCount: 48,
+    },
+    expectedTruncated: {
+      maxCharacters: 20,
+      charCount: 20,
+      lines: [{ message: '?\n' }, { message: "You're a good boy!" }],
+    },
+  },
+  {
+    messages: ["Who's a good boy?\n", 'Yo'],
+    prevLines: {
+      lines: [{ message: 'Hello Dog!\n' }],
+      charCount: 11,
+    },
+    expected: {
+      lines: [
+        { message: 'Hello Dog!\n' },
+        { message: "Who's a good boy?\n" },
+        { message: 'Yo' },
+      ],
+      charCount: 31,
+    },
+    expectedTruncated: {
+      maxCharacters: 20,
+      charCount: 20,
+      lines: [{ message: "Who's a good boy?\n" }, { message: 'Yo' }],
+    },
+  },
+];
+
+testLines.forEach((t) =>
+  [...t.expected.lines, ...(t.prevLines?.lines || [])].forEach(
+    (l) => (l.timestamp = date)
+  )
+);
+
+describe.only('Monitor Utils', () => {
+  beforeEach(() => {
+    set(date);
+  });
+
+  afterEach(() => {
+    reset();
+  });
+
+  testLines.forEach((testLine) => {
+    context('when converting messages', () => {
+      it('should give the right result', () => {
+        const [newLines, addedCharCount] = messagesToLines(
+          testLine.messages,
+          testLine.prevLines?.lines,
+          testLine.prevLines?.charCount
+        );
+        newLines.forEach((line, index) => {
+          expect(line.message).to.equal(testLine.expected.lines[index].message);
+          expect(line.timestamp).to.deep.equal(
+            testLine.expected.lines[index].timestamp
+          );
+        });
+        expect(addedCharCount).to.equal(testLine.expected.charCount);
+
+        const [truncatedLines, totalCharCount] = truncateLines(
+          newLines,
+          addedCharCount,
+          testLine.expectedTruncated?.maxCharacters
+        );
+        let charCount = 0;
+        if (testLine.expectedTruncated) {
+          truncatedLines.forEach((line, index) => {
+            expect(line.message).to.equal(
+              testLine.expectedTruncated?.lines[index].message
+            );
+            charCount += line.message.length;
+          });
+          expect(totalCharCount).to.equal(charCount);
+        }
+      });
+    });
+  });
+});

yarn.lock

@@ -11743,6 +11743,11 @@ mocha@^7.0.0:
     yargs-parser "13.1.2"
     yargs-unparser "1.6.0"
 
+mockdate@^3.0.5:
+  version "3.0.5"
+  resolved "https://registry.yarnpkg.com/mockdate/-/mockdate-3.0.5.tgz#789be686deb3149e7df2b663d2bc4392bc3284fb"
+  integrity sha512-iniQP4rj1FhBdBYS/+eQv7j1tadJ9lJtdzgOpvsOHng/GbcDh2Fhdeq+ZRldrPYdXvCyfFUmFeEwEGXZB5I/AQ==
+
 modify-values@^1.0.0:
   version "1.0.1"
   resolved "https://registry.yarnpkg.com/modify-values/-/modify-values-1.0.1.tgz#b3939fa605546474e3e3e3c63d64bd43b4ee6022"