feat: add setting to disable automatic board/library update checks (#108)

Author: thelastoutpostworkshop

CHANGELOG.md

@@ -2,13 +2,17 @@
 
 All notable changes to the Arduino Maker Workshop extension will be documented in this file.
 
+## Version 1.1.4
+- Added a setting to disable automatic board/library update checks for offline usage ([issue #108](https://github.com/thelastoutpostworkshop/arduino-maker-workshop/issues/108))
+
 ## Version 1.1.3
 
 - Support for Windows ARM (Serial Monitor not supported) thanks to [jfthuong](https://github.com/jfthuong) ([issue #5](https://github.com/thelastoutpostworkshop/arduino-maker-workshop/issues/5))
 - Arduino CLI 1.4.1
 - Persist upload/monitor ports by address while keeping the label visible (fixes Wi-Fi board uploads like UNO Q; backwards compatible with existing port labels) ([issue #103](https://github.com/thelastoutpostworkshop/arduino-maker-workshop/issues/103))
 - Added a command to clear Arduino CLI caches and refresh board/library data ([issue #102](https://github.com/thelastoutpostworkshop/arduino-maker-workshop/issues/102))
 
+
 ## Version 1.1.2
 
 - Fixed board examples mixed with library examples and board examples not refreshed when a board change ([issue #100](https://github.com/thelastoutpostworkshop/arduino-maker-workshop/issues/100))

README.md

@@ -37,6 +37,7 @@ All the platforms supported by the [Arduino CLI](https://arduino.github.io/ardui
 * You can set the user directory, equivalent of the Arduino IDE's 'sketchbook' directory. Library Manager installations are made to the libraries subdirectory of the user directory
 * You can change the Arduino CLI used (*not recommended*) instead of using the built-in Arduino CLI (*recommended*)
 * You can disable automatic port detection on Windows
+* You can disable automatic board/library update checks (useful for offline usage)
 * You can enable or disable verbose compilation (default is verbose)
 
 ## Features

package.json

@@ -3,7 +3,7 @@
   "displayName": "Arduino Maker Workshop",
   "publisher": "TheLastOutpostWorkshop",
   "description": "The ultimate tool for makers to bring Arduino projects to life!",
-  "version": "1.1.3",
+  "version": "1.1.4",
   "engines": {
     "vscode": "^1.93.0"
   },
@@ -144,6 +144,12 @@
           "scope": "machine",
           "description": "Disable automatic port detection (only applies on Windows)."
         },
+        "arduinoMakerWorkshop.disableAutoUpdateChecks": {
+          "type": "boolean",
+          "default": false,
+          "scope": "machine",
+          "description": "Disable automatic checks for board/library updates (useful for offline use)."
+        },
         "arduinoMakerWorkshop.verboseCompile": {
           "type": "boolean",
           "default": true,

src/VueWebviewPanel.ts

@@ -2,7 +2,7 @@ import { commands, Disposable, Webview, WebviewPanel, window, Uri, ViewColumn, E
 import { getUri } from "./utilities/getUri";
 import { getNonce } from "./utilities/getNonce";
 import { ARDUINO_ERRORS, ARDUINO_MESSAGES, BacktraceDecodeFrame, BacktraceDecodeResult, ESP32_PARTITION_BUILDER_BASE_URL, PROFILES_STATUS, SketchProjectFile, WebviewToExtensionMessage } from './shared/messages';
-import { arduinoCLI, arduinoExtensionChannel, arduinoProject, arduinoYaml, changeTheme, compile, loadArduinoConfiguration, openExample, shouldDetectPorts, updateStateCompileUpload } from "./extension";
+import { arduinoCLI, arduinoExtensionChannel, arduinoProject, arduinoYaml, changeTheme, compile, loadArduinoConfiguration, openExample, shouldCheckForUpdates, shouldDetectPorts, updateStateCompileUpload } from "./extension";
 
 const path = require('path');
 const os = require('os');
@@ -14,6 +14,7 @@ export class VueWebviewPanel {
     private readonly _panel: WebviewPanel;
     private _disposables: Disposable[] = [];
     public static currentPanel: VueWebviewPanel | undefined;
+    private static readonly EMPTY_OUTDATED_PAYLOAD = JSON.stringify({ platforms: [], libraries: [] });
     private usbChange() {
         if (shouldDetectPorts()) {
             VueWebviewPanel.sendMessage({ command: ARDUINO_MESSAGES.REQUEST_BOARD_CONNECTED, errorMessage: "", payload: "" });
@@ -173,12 +174,31 @@ export class VueWebviewPanel {
                         arduinoCLI.setBuildResult(false);
                         break;
                     case ARDUINO_MESSAGES.CLI_UPDATE_INDEX:
-                        arduinoCLI.getCoreUpdate().then(() => {
-                            arduinoCLI.getOutdatedBoardAndLib().then((result) => {
-                                message.payload = result;
+                        {
+                            const forceRefresh = !!message.payload?.force;
+                            if (!forceRefresh && !shouldCheckForUpdates()) {
+                                message.payload = VueWebviewPanel.EMPTY_OUTDATED_PAYLOAD;
+                                message.errorMessage = "";
                                 VueWebviewPanel.sendMessage(message);
-                            });
-                        });
+                                break;
+                            }
+
+                            arduinoCLI.getCoreUpdate()
+                                .catch(() => {
+                                    arduinoExtensionChannel.appendLine("Arduino index update failed.");
+                                })
+                                .then(() => arduinoCLI.getOutdatedBoardAndLib())
+                                .then((result) => {
+                                    message.payload = result;
+                                    message.errorMessage = "";
+                                    VueWebviewPanel.sendMessage(message);
+                                })
+                                .catch(() => {
+                                    message.payload = VueWebviewPanel.EMPTY_OUTDATED_PAYLOAD;
+                                    message.errorMessage = "";
+                                    VueWebviewPanel.sendMessage(message);
+                                });
+                        }
                         break;
                     case ARDUINO_MESSAGES.CLI_INSTALL_CORE_VERSION:
                         const coreToUpdate = message.payload;

src/cli.ts

@@ -1,5 +1,5 @@
 import { commands, OutputChannel, Uri, window, workspace, ExtensionContext, ProgressLocation } from "vscode";
-import { arduinoCLI, arduinoExtensionChannel, arduinoProject, arduinoYaml, compileOutputView, compileStatusBarExecuting, compileStatusBarItem, compileStatusBarNotExecuting, loadArduinoConfiguration, updateStateCompileUpload, uploadStatusBarExecuting, uploadStatusBarItem, uploadStatusBarNotExecuting } from "./extension";
+import { arduinoCLI, arduinoExtensionChannel, arduinoProject, arduinoYaml, compileOutputView, compileStatusBarExecuting, compileStatusBarItem, compileStatusBarNotExecuting, loadArduinoConfiguration, shouldCheckForUpdates, updateStateCompileUpload, uploadStatusBarExecuting, uploadStatusBarItem, uploadStatusBarNotExecuting } from "./extension";
 import { ArduinoCLIStatus, BuildOptions, CompileResult, PROFILES_STATUS } from "./shared/messages";
 import { getSerialMonitorApi, MonitorPortSettings, SerialMonitorApi, Version } from "@microsoft/vscode-serial-monitor-api";
 import { COMPILE_RESULT_FILE, VSCODE_FOLDER } from "./ArduinoProject";
@@ -89,7 +89,13 @@ export class ArduinoCLI {
 			() => this.cliArgs.getVersionArguments(),
 			"CLI: Failed to get Arduino CLI version information", { caching: CacheState.NO, ttl: 0 }
 		);
-		arduinoCLI.getCoreUpdate();
+		if (shouldCheckForUpdates()) {
+			this.getCoreUpdate().catch(() => {
+				arduinoExtensionChannel.appendLine("Automatic board/library update check failed.");
+			});
+		} else {
+			arduinoExtensionChannel.appendLine("Automatic board/library update checks are disabled.");
+		}
 		return (JSON.parse(result));
 	}
 

src/extension.ts

@@ -350,6 +350,12 @@ export function shouldDetectPorts(): boolean {
 	return true; // Proceed with port detection
 }
 
+export function shouldCheckForUpdates(): boolean {
+	const config = workspace.getConfiguration('arduinoMakerWorkshop');
+	const disableAutoUpdateChecks = config.get<boolean>('disableAutoUpdateChecks', false);
+	return !disableAutoUpdateChecks;
+}
+
 function changeUserDirectory() {
 	const config = workspace.getConfiguration('arduinoMakerWorkshop.arduinoCLI');
 	const userDirectory = config.get<string>('userDirectory', '');

vue_webview/src/components/Toolbox.vue

@@ -11,10 +11,10 @@ onMounted(() => {
 });
 
 const libraryToUpdate = computed(() => {
-    return !!store.outdated?.libraries;
+    return Array.isArray(store.outdated?.libraries) && store.outdated.libraries.length > 0;
 });
 const boardToUpdate = computed(() => {
-    return !!store.outdated?.platforms;
+    return Array.isArray(store.outdated?.platforms) && store.outdated.platforms.length > 0;
 });
 
 </script>

vue_webview/src/stores/useVsCodeStore.ts

@@ -292,7 +292,7 @@ export const useVsCodeStore = defineStore('vsCode', {
                     }
                     break;
                 case ARDUINO_MESSAGES.CLI_UPDATE_INDEX:
-                    if (!this.outdated) {
+                    if (message.payload?.force || !this.outdated) {
                         vscode.postMessage(message);
                     }
                     break;