Merge pull request #1421 from microsoft/main

Bump to v0.4.10

Author: benmcmorran

.github/workflows/fixed-issues.yml

@@ -0,0 +1,22 @@
+name: Close fixed issues
+
+on:
+  push:
+    tags:
+      - "v[0-9]+.[0-9]+.[0-9]+"
+  workflow_dispatch:
+
+jobs:
+  fixed:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/[email protected]
+      with:
+        days-before-stale: 0
+        days-before-close: 0
+        ignore-updates: true
+        close-issue-message: >-
+          This issue has been fixed in the latest release of this extension,
+          which is available in the VS Code extension marketplace.
+        stale-issue-label: fixed-pending-release
+        only-labels: fixed-pending-release

README.md

@@ -71,7 +71,7 @@ This extension provides several commands in the Command Palette (<kbd>F1</kbd> o
 | --- | --- |
 | `arduino.path`  | Path to Arduino, you can use a custom version of Arduino by modifying this setting to include the full path. Example: `C:\\Program Files\\Arduino` for Windows, `/Applications` for Mac, `/home/<username>/Downloads/arduino-1.8.1` for Linux. (Requires a restart after change). The default value is automatically detected from your Arduino IDE installation path. |
 | `arduino.commandPath` | Path to an executable (or script) relative to `arduino.path`. The default value is `arduino_debug.exe` for Windows, `Contents/MacOS/Arduino` for Mac and `arduino` for Linux, You also can use a custom launch script to run Arduino by modifying this setting. (Requires a restart after change) Example: `run-arduino.bat` for Windows, `Contents/MacOS/run-arduino.sh` for Mac and `bin/run-arduino.sh` for Linux. |
-| `arduino.additionalUrls` | Additional Boards Manager URLs for 3rd party packages. You can have multiple URLs in one string with a comma(`,`) as separator, or have a string array. The default value is empty. |
+| `arduino.additionalUrls` | Additional Boards Manager URLs for 3rd party packages as a string array. The default value is empty. |
 | `arduino.logLevel` | CLI output log level. Could be info or verbose. The default value is `"info"`. |
 | `arduino.clearOutputOnBuild` | Clear the output logs before uploading or verifying. Default value is `false`. |
 | `arduino.allowPDEFiletype` | Allow the VSCode Arduino extension to open .pde files from pre-1.0.0 versions of Arduino. Note that this will break Processing code. Default value is `false`. | 

azure-pipelines.yml

@@ -115,13 +115,21 @@ steps:
       includeRootFolder: false
       archiveType: zip
       archiveFile: $(Build.StagingDirectory)\vscode-arduino.vsix
+  - script: python .\build\markExecutableFiles.py
+    displayName: Make serial monitor executable
   - task: MSBuild@1
     displayName: Sign VSIX
     inputs:
       solution: .\build\SignVsix.proj
       msbuildArguments: /p:SignType=$(SignType)
     # MicroBuild signing will always fail on public PRs.
-    condition: ne(variables['Build.Reason'], 'PullRequest')
+    # TODO: Signing the VSIX strips out the "main" executables for
+    # serial-monitor-cli on Mac and Linux, completely breaking serial
+    # functionality in the extension on these platforms. For now we disable VSIX
+    # signing because it's not a strict requirement, but we should investigate
+    # if we can either add extensions to these files or support extensionless
+    # files in VSIX signing.
+    condition: and(false, ne(variables['Build.Reason'], 'PullRequest'))
   - publish: $(Build.StagingDirectory)\vscode-arduino.vsix
     artifact: VS Code extension VSIX
     displayName: Publish extension VSIX as artifact

build/markExecutableFiles.py

@@ -0,0 +1,31 @@
+import os
+import zipfile
+
+staging_directory = os.getenv('BUILD_STAGINGDIRECTORY')
+input_archive_path = f"{staging_directory}/vscode-arduino.vsix"
+output_archive_path = f"{staging_directory}/vscode-arduino-out.vsix"
+
+filenames = [
+    "extension/out/serial-monitor-cli/darwin/main",
+    "extension/out/serial-monitor-cli/linux/main"
+]
+
+input_archive = zipfile.ZipFile(input_archive_path, 'r')
+output_archive = zipfile.ZipFile(output_archive_path, 'w')
+
+executable_count = 0
+for info in input_archive.infolist():
+    data = input_archive.read(info)
+    if info.filename in filenames:
+        # Magic number from from https://stackoverflow.com/a/48435482
+        info.external_attr = 0o100755 << 16
+        executable_count += 1
+    output_archive.writestr(info, data)
+
+if executable_count != len(filenames):
+    raise Exception(f'Expected to find {len(filenames)} executables but only found {executable_count}')
+
+input_archive.close()
+output_archive.close()
+
+os.replace(output_archive_path, input_archive_path)

package.json

@@ -482,11 +482,9 @@
           "description": "Path to a script relative to 'arduino.path', you can use a custom launch script to run Arduino by modifying this setting. Example: 'run-arduino.bat' for Windows, 'Contents/MacOS/run-arduino.sh' for Mac, 'bin/run-arduino.sh' for Linux. (Requires a restart after change)"
         },
         "arduino.additionalUrls": {
-          "type": [
-            "string",
-            "array"
-          ],
-          "description": "Additional URLs for 3-rd party packages. You can have multiple URLs in one string with comma(,) as separator, or have a string array."
+          "type": "array",
+          "items": { "type": "string" },
+          "description": "Additional URLs for 3rd party packages."
         },
         "arduino.logLevel": {
           "type": "string",

src/arduino/arduino.ts

@@ -495,6 +495,15 @@ export class ArduinoApp {
         // return VscodeSettings.getInstance().useArduinoCli;
     }
 
+    /**
+     * Checks if the line contains memory usage information
+     * @param line output line to check
+     * @returns {bool} true if line contains memory usage information
+     */
+    private isMemoryUsageInformation(line: string) {
+        return line.startsWith("Sketch uses ") || line.startsWith("Global variables use ");
+    }
+
     /**
      * Private implementation. Not to be called directly. The wrapper build()
      * manages the build state.
@@ -596,13 +605,10 @@ export class ArduinoApp {
             } else {
                 args.push("--upload",
                     "--useprogrammer",
-                    "--pref", `programmer=arduino:${programmer}`);
+                    "--pref", `programmer=${programmer}`);
             }
 
             args.push("--port", dc.port);
-            if (!this.useArduinoCli()) {
-                args.push("--verify");
-            }
         } else if (buildMode === BuildMode.CliUploadProgrammer) {
             const programmer = this.programmerManager.currentProgrammer;
             if (!programmer) {
@@ -735,6 +741,11 @@ export class ArduinoApp {
             }
             if (verbose) {
                 arduinoChannel.channel.append(line);
+            } else {
+                // Output sketch memory usage in non-verbose mode
+                if (this.isMemoryUsageInformation(line)) {
+                    arduinoChannel.channel.append(line);
+                }
             }
         }
         const stderrcb = (line: string) => {

src/arduino/arduinoContentProvider.ts

@@ -155,11 +155,19 @@ export class ArduinoContentProvider implements vscode.TextDocumentContentProvide
         }
     }
 
-    public openSettings(req, res) {
-        vscode.commands.executeCommand("workbench.action.openGlobalSettings");
-        return res.json({
-            status: "OK",
-        });
+    public async openSettings(req, res) {
+        if (!req.body.query) {
+            return res.status(400).send("BAD Request! Missing { query } parameter!");
+        } else {
+            try {
+                await vscode.commands.executeCommand("workbench.action.openGlobalSettings", { query: req.body.query });
+                return res.json({
+                    status: "OK",
+                });
+            } catch (error) {
+                return res.status(500).send(`Cannot open the setting with error message "${error}"`);
+            }
+        }
     }
 
     public async getLibraries(req, res) {

src/arduino/boardManager.ts

@@ -518,26 +518,12 @@ export class BoardManager {
     }
 
     private getAdditionalUrls(): string[] {
-        function formatUrls(urls): string[] {
-            if (urls) {
-                let _urls: string[];
-
-                if (!Array.isArray(urls) && typeof urls === "string") {
-                    _urls = (<string>urls).split(",");
-                } else {
-                    _urls = <string[]>urls;
-                }
-
-                return util.trim(_urls);
-            }
-            return [];
-        }
         // For better compatibility, merge urls both in user settings and arduino IDE preferences.
-        const settingsUrls = formatUrls(VscodeSettings.getInstance().additionalUrls);
+        const settingsUrls = VscodeSettings.getInstance().additionalUrls;
         let preferencesUrls = [];
         const preferences = this._settings.preferences;
         if (preferences && preferences.has("boardsmanager.additional.urls")) {
-            preferencesUrls = formatUrls(preferences.get("boardsmanager.additional.urls"));
+            preferencesUrls = util.toStringArray(preferences.get("boardsmanager.additional.urls"));
         }
         return util.union(settingsUrls, preferencesUrls);
     }

src/arduino/vscodeSettings.ts

@@ -2,6 +2,7 @@
 // Licensed under the MIT license.
 
 import * as vscode from "vscode";
+import { toStringArray } from "../common/util";
 
 const configKeys = {
     ARDUINO_PATH: "arduino.path",
@@ -23,7 +24,7 @@ const configKeys = {
 export interface IVscodeSettings {
     arduinoPath: string;
     commandPath: string;
-    additionalUrls: string | string[];
+    additionalUrls: string[];
     logLevel: string;
     clearOutputOnBuild: boolean;
     allowPDEFiletype: boolean;
@@ -34,7 +35,7 @@ export interface IVscodeSettings {
     defaultBaudRate: number;
     useArduinoCli: boolean;
     disableIntelliSenseAutoGen: boolean;
-    updateAdditionalUrls(urls: string | string[]): void;
+    updateAdditionalUrls(urls: string[]): void;
 }
 
 export class VscodeSettings implements IVscodeSettings {
@@ -57,8 +58,20 @@ export class VscodeSettings implements IVscodeSettings {
         return this.getConfigValue<string>(configKeys.ARDUINO_COMMAND_PATH);
     }
 
-    public get additionalUrls(): string | string[] {
-        return this.getConfigValue<string | string[]>(configKeys.ADDITIONAL_URLS);
+    public get additionalUrls(): string[] {
+        const value = this.getConfigValue<string | string[]>(configKeys.ADDITIONAL_URLS);
+
+        // Even though the schema says value must be a string array, version
+        // 0.4.9 and earlier also allowed a single comma delimeted string. We
+        // continue to unofficially support that format to avoid breaking
+        // existing settings, but we immediately write back the correctly
+        // formatted version.
+        const split = toStringArray(value);
+        if (typeof value === "string") {
+            this.updateAdditionalUrls(split);
+        }
+
+        return split;
     }
 
     public get logLevel(): string {

src/common/util.ts

@@ -207,13 +207,16 @@ export function spawn(
 
         let codepage = "65001";
         if (os.platform() === "win32") {
-            try {
-                const chcp = child_process.execSync("chcp.com");
-                codepage = chcp.toString().split(":").pop().trim();
-            } catch (error) {
-                arduinoChannel.warning(`Defaulting to code page 850 because chcp.com failed.\
-                \rEnsure your path includes %SystemRoot%\\system32\r${error.message}`);
-                codepage = "850";
+            codepage = getArduinoL4jCodepage(command.replace(/.exe$/i, ".l4j.ini"));
+            if (!codepage) {
+                try {
+                    const chcp = child_process.execSync("chcp.com");
+                    codepage = chcp.toString().split(":").pop().trim();
+                } catch (error) {
+                    arduinoChannel.warning(`Defaulting to code page 850 because chcp.com failed.\
+                    \rEnsure your path includes %SystemRoot%\\system32\r${error.message}`);
+                    codepage = "850";
+                }
             }
         }
 
@@ -253,6 +256,16 @@ export function spawn(
     });
 }
 
+export function getArduinoL4jCodepage(filePath: string): string | undefined {
+    const encoding = parseConfigFile(filePath).get("-Dfile.encoding");
+    if (encoding === "UTF8") {
+        return "65001";
+    }
+    return Object.keys(encodingMapping).reduce((r, key) => {
+        return encodingMapping[key] === encoding ? key : r;
+    }, undefined);
+}
+
 export function decodeData(data: Buffer, codepage: string): string {
     if (Object.prototype.hasOwnProperty.call(encodingMapping, codepage)) {
         return iconv.decode(data, encodingMapping[codepage]);
@@ -433,3 +446,25 @@ export function resolveMacArduinoAppPath(arduinoPath: string, useArduinoCli = fa
         return path.join(arduinoPath, "Arduino.app");
     }
 }
+
+/**
+ * If given an string, splits the string on commas. If given an array, returns
+ * the array. All strings in the output are trimmed.
+ * @param value String or string array to convert.
+ * @returns Array of strings split from the input.
+ */
+export function toStringArray(value: string | string[]): string[] {
+    if (value) {
+        let result: string[];
+
+        if (typeof value === "string") {
+            result = value.split(",");
+        } else {
+            result = <string[]>value;
+        }
+
+        return trim(result);
+    }
+
+    return [];
+}