Merge branch 'main' into patch-1

Author: benmcmorran

.github/workflows/build.yml

@@ -6,14 +6,14 @@ name: CI
 on:
   push:
     branches:
-      - master
-      - dev
+      - main
+      - release
     tags:
       - v*
   pull_request:
     branches:
-      - master
-      - dev
+      - main
+      - release
 
 jobs:
   build:

CHANGELOG.md

@@ -1,6 +1,16 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
+## Version 0.4.9
+
+- Release date: January 12, 2022
+
+### Changed
+
+- vid and pid for Adafruit Grand Central M4 (SAMD51) [#1218](https://github.com/microsoft/vscode-arduino/pull/1218)
+- Add clear output on build option [#1057](https://github.com/microsoft/vscode-arduino/pull/1057)
+- Added buffering to prevent heavy logging issues [#1412](https://github.com/microsoft/vscode-arduino/pull/1412)
+
 ## Version 0.4.8
 
 - Release date: November 9, 2021

CONTRIBUTING.md

@@ -8,9 +8,9 @@ There are many ways that you can contribute, beyond writing code. The goal of th
 
 If you are interested in writing code to fix issues, first look at the issues with the [help-wanted](https://github.com/Microsoft/vscode-arduino/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) label. They should have the context and code pointers needed to get started. If not, then feel free to ask for some, and we will be happy to provide any guidance you need.
 
-When you are doing code fix, please work against [dev](https://github.com/microsoft/vscode-arduino/tree/dev)
-branch and also submit pull request to `dev` branch.
-Changes will be merged into `master` branch after production release.
+When you are doing code fix, please work against [main](https://github.com/microsoft/vscode-arduino/tree/main)
+branch and also submit pull request to `main` branch.
+Changes will be merged into `release` branch after production release.
 
 
 

README.md

@@ -1,7 +1,6 @@
 # Visual Studio Code extension for Arduino
 
 [![Gitter](https://img.shields.io/badge/chat-on%20gitter-blue.svg)](https://gitter.im/Microsoft/vscode-arduino)
-[![Travis CI](https://travis-ci.org/Microsoft/vscode-arduino.svg?branch=master)](https://travis-ci.org/Microsoft/vscode-arduino)
 
 Welcome to the Visual Studio Code extension for **Arduino** <sup>preview</sup> ! The Arduino extension makes it easy to develop, build, deploy and debug your Arduino sketches in Visual Studio Code, with a rich set of functionalities. These include:
 
@@ -121,7 +120,7 @@ The following settings are as per sketch settings of the Arduino extension. You
 - `port` - Name of the serial port connected to the device. Can be set by the `Arduino: Select Serial Port` command. For Mac users could be "/dev/cu.wchusbserial1420".
 - `board` - Currently selected Arduino board alias. Can be set by the `Arduino: Change Board Type` command. Also, you can find the board list there.
 - `output` - Arduino build output path. If not set, Arduino will create a new temporary output folder each time, which means it cannot reuse the intermediate result of the previous build leading to long verify/upload time, so it is recommended to set the field. Arduino requires that the output path should not be the workspace itself or in a subfolder of the workspace, otherwise, it may not work correctly. By default, this option is not set. It's worth noting that the contents of this file could be deleted during the build process, so pick (or create) a directory that will not store files you want to keep.
-- `debugger` - The short name of the debugger that will be used when the board itself does not have a debugger and there is more than one debugger available. You can find the list of debuggers [here](https://github.com/Microsoft/vscode-arduino/blob/master/misc/debuggerUsbMapping.json). By default, this option is not set.
+- `debugger` - The short name of the debugger that will be used when the board itself does not have a debugger and there is more than one debugger available. You can find the list of debuggers [here](https://github.com/Microsoft/vscode-arduino/blob/release/misc/debuggerUsbMapping.json). By default, this option is not set.
 - `prebuild` - External command which will be invoked before any sketch build (verify, upload, ...). For details see the [Pre- and Post-Build Commands](#Pre--and-Post-Build-Commands) section.
 - `postbuild` - External command to be run after the sketch has been built successfully. See the afore mentioned section for more details.
 - `intelliSenseGen` - Override the global setting for auto-generation of the IntelliSense configuration (i.e. `.vscode/c_cpp_properties.json`). Three options are available:
@@ -204,7 +203,7 @@ Steps to start debugging:
 > To learn more about how to debug Arduino code, visit our [team blog](https://blogs.msdn.microsoft.com/iotdev/2017/05/27/debug-your-arduino-code-with-visual-studio-code/).
 
 ## Change Log
-See the [Change log](https://github.com/Microsoft/vscode-arduino/blob/master/CHANGELOG.md) for details about the changes in each version.
+See the [Change log](https://github.com/Microsoft/vscode-arduino/blob/release/CHANGELOG.md) for details about the changes in each version.
 
 ## Supported Operating Systems
 Currently this extension supports the following operating systems:
@@ -242,7 +241,7 @@ This project has adopted the [Microsoft Open Source Code of Conduct](https://ope
 The [Microsoft Enterprise and Developer Privacy Statement](https://www.microsoft.com/en-us/privacystatement/EnterpriseDev/default.aspx) describes the privacy statement of this software.
 
 ## License
-This extension is licensed under the [MIT License](https://github.com/Microsoft/vscode-arduino/blob/master/LICENSE.txt). Please see the [Third Party Notice](https://github.com/Microsoft/vscode-arduino/blob/master/ThirdPartyNotices.txt) file for additional copyright notices and terms.
+This extension is licensed under the [MIT License](https://github.com/Microsoft/vscode-arduino/blob/release/LICENSE.txt). Please see the [Third Party Notice](https://github.com/Microsoft/vscode-arduino/blob/release/ThirdPartyNotices.txt) file for additional copyright notices and terms.
 
 ## Contact Us
 If you would like to help build the best Arduino experience with VS Code, you can reach us directly at [gitter chat room](https://gitter.im/Microsoft/vscode-arduino).

azure-pipelines.yml

@@ -14,14 +14,14 @@ parameters:
       - real
 
 pr:
-  - master
-  - dev
+  - main
+  - release
 
 trigger:
   branches:
     include:
-      - master
-      - dev
+      - main
+      - release
   tags:
     include:
       - v*
@@ -33,12 +33,12 @@ variables:
   # MicroBuild requires TeamName to be set.
   TeamName: C++ Cross Platform and Cloud
   # If the user didn't override the signing type, then only real-sign on tags,
-  # master, or dev.
+  # main, or release.
   ${{ if ne(parameters.SignTypeOverride, 'default') }}:
     SignType: ${{ parameters.SignTypeOverride }}
-  ${{ if and(eq(parameters.SignTypeOverride, 'default'), or(startsWith(variables['Build.SourceBranch'], 'refs/tags'), eq(variables['Build.SourceBranchName'], 'master'), eq(variables['Build.SourceBranchName'], 'dev'))) }}:
+  ${{ if and(eq(parameters.SignTypeOverride, 'default'), or(startsWith(variables['Build.SourceBranch'], 'refs/tags'), eq(variables['Build.SourceBranchName'], 'main'), eq(variables['Build.SourceBranchName'], 'release'))) }}:
     SignType: real
-  ${{ if and(eq(parameters.SignTypeOverride, 'default'), not(or(startsWith(variables['Build.SourceBranch'], 'refs/tags'), eq(variables['Build.SourceBranchName'], 'master'), eq(variables['Build.SourceBranchName'], 'dev')))) }}:
+  ${{ if and(eq(parameters.SignTypeOverride, 'default'), not(or(startsWith(variables['Build.SourceBranch'], 'refs/tags'), eq(variables['Build.SourceBranchName'], 'main'), eq(variables['Build.SourceBranchName'], 'release')))) }}:
     SignType: test
 
 steps:

package-lock.json

@@ -2,7 +2,7 @@
   "name": "vscode-arduino",
   "displayName": "Arduino",
   "description": "Arduino for Visual Studio Code",
-  "version": "0.4.8",
+  "version": "0.4.9",
   "publisher": "vsciot-vscode",
   "aiKey": "83dd2c27-6594-41d3-85a9-bdb22070eb42",
   "preview": true,
@@ -18,7 +18,7 @@
   "bugs": {
     "url": "https://github.com/Microsoft/vscode-arduino/issues"
   },
-  "homepage": "https://github.com/Microsoft/vscode-arduino/blob/master/README.md",
+  "homepage": "https://github.com/Microsoft/vscode-arduino/blob/release/README.md",
   "categories": [
     "Programming Languages",
     "Debuggers",

package.json

@@ -0,0 +1,44 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT license.
+
+import { performance } from "perf_hooks";
+import * as vscode from "vscode";
+
+export class BufferedOutputChannel implements vscode.Disposable {
+    private _buffer: string[];
+    private _timer: NodeJS.Timer;
+    private _lastFlushTime: number;
+
+    public constructor(private readonly outputCallback: (value: string) => void, private readonly flushIntervalMs: number) {
+        this._buffer = [];
+        this._timer = setInterval(() => this.tryFlush(), this.flushIntervalMs);
+        this._lastFlushTime = Number.NEGATIVE_INFINITY;
+    }
+
+    public append(value: string) {
+        this.add(value);
+    }
+
+    public appendLine(value: string) {
+        this.add(value + "\n");
+    }
+
+    public dispose() {
+        this.tryFlush();
+        clearInterval(this._timer);
+    }
+
+    private add(value: string) {
+        this._buffer.push(value);
+        this.tryFlush();
+    }
+
+    private tryFlush() {
+        const currentTime = performance.now();
+        if (this._buffer.length > 0 && currentTime - this._lastFlushTime > this.flushIntervalMs) {
+            this.outputCallback(this._buffer.join(""));
+            this._lastFlushTime = currentTime;
+            this._buffer = [];
+        }
+    }
+}

src/serialmonitor/outputBuffer.ts

@@ -6,6 +6,7 @@ import ArduinoContext from "../arduinoContext";
 import * as constants from "../common/constants";
 import { DeviceContext } from "../deviceContext";
 import * as Logger from "../logger/logger";
+import { BufferedOutputChannel } from "./outputBuffer";
 import { SerialPortCtrl } from "./serialportctrl";
 
 export interface ISerialPortDetail {
@@ -49,6 +50,8 @@ export class SerialMonitor implements vscode.Disposable {
 
     private _outputChannel: vscode.OutputChannel;
 
+    private _bufferedOutputChannel: BufferedOutputChannel;
+
     public initialize() {
         let defaultBaudRate;
         if (ArduinoContext.arduinoApp && ArduinoContext.arduinoApp.settings && ArduinoContext.arduinoApp.settings.defaultBaudRate) {
@@ -57,6 +60,7 @@ export class SerialMonitor implements vscode.Disposable {
             defaultBaudRate = SerialMonitor.DEFAULT_BAUD_RATE;
         }
         this._outputChannel = vscode.window.createOutputChannel(SerialMonitor.SERIAL_MONITOR);
+        this._bufferedOutputChannel = new BufferedOutputChannel(this._outputChannel.append, 300);
         this._currentBaudRate = defaultBaudRate;
         this._portsStatusBar = vscode.window.createStatusBarItem(vscode.StatusBarAlignment.Right, constants.statusBarPriority.PORT);
         this._portsStatusBar.command = "arduino.selectSerialPort";
@@ -88,6 +92,8 @@ export class SerialMonitor implements vscode.Disposable {
         if (this._serialPortCtrl && this._serialPortCtrl.isActive) {
             return this._serialPortCtrl.stop();
         }
+        this._outputChannel.dispose();
+        this._bufferedOutputChannel.dispose();
     }
 
     public async selectSerialPort(vid: string, pid: string) {
@@ -145,7 +151,11 @@ export class SerialMonitor implements vscode.Disposable {
                 return;
             }
         } else {
-            this._serialPortCtrl = new SerialPortCtrl(this._currentPort, this._currentBaudRate, this._outputChannel);
+            this._serialPortCtrl = new SerialPortCtrl(
+                this._currentPort,
+                this._currentBaudRate,
+                this._bufferedOutputChannel,
+                this._outputChannel.show);
         }
 
         if (!this._serialPortCtrl.currentPort) {

src/serialmonitor/serialMonitor.ts

@@ -4,8 +4,8 @@
 import { ChildProcess, execFileSync, spawn  } from "child_process";
 import * as os from "os";
 import * as path from "path";
-import { OutputChannel } from "vscode";
 import { DeviceContext } from "../deviceContext";
+import { BufferedOutputChannel } from "./outputBuffer";
 
 interface ISerialPortDetail {
   port: string;
@@ -63,7 +63,11 @@ export class SerialPortCtrl {
   private _currentBaudRate: number;
   private _currentSerialPort = null;
 
-  public constructor(port: string, baudRate: number, private _outputChannel: OutputChannel) {
+  public constructor(
+      port: string,
+      baudRate: number,
+      private _bufferedOutputChannel: BufferedOutputChannel,
+      private showOutputChannel: (preserveFocus?: boolean) => void) {
     this._currentBaudRate = baudRate;
     this._currentPort = port;
   }
@@ -80,8 +84,8 @@ export class SerialPortCtrl {
   }
 
   public open(): Promise<void> {
-    this._outputChannel.appendLine(`[Starting] Opening the serial port - ${this._currentPort}`);
-    this._outputChannel.show();
+    this._bufferedOutputChannel.appendLine(`[Starting] Opening the serial port - ${this._currentPort}`);
+    this.showOutputChannel();
 
     if (this._child) {
         this.stop();
@@ -96,8 +100,10 @@ export class SerialPortCtrl {
         });
 
         this._child.stdout.on("data", (data) => {
-            const jsonObj = JSON.parse(data.toString())
-            this._outputChannel.append(jsonObj["payload"] + "\n");
+            if (this.isActive) {
+                const jsonObj = JSON.parse(data.toString())
+                this._bufferedOutputChannel.append(jsonObj["payload"] + "\n");
+            }
         });
         // TODO: add message check to ensure _child spawned without errors
         resolve();
@@ -155,8 +161,8 @@ export class SerialPortCtrl {
       }
       try {
         this._child.stdin.write('{"cmd": "close"}\n');
-        if (this._outputChannel) {
-          this._outputChannel.appendLine(`[Done] Closed the serial port ${os.EOL}`);
+        if (this._bufferedOutputChannel) {
+          this._bufferedOutputChannel.appendLine(`[Done] Closed the serial port ${os.EOL}`);
         }
         this._child = null;
         resolve(true);