Make backup on flash an option (#4360)

* Make backup on flash an option

* Move initialization to main

* Alternative

* Just ask

* works locally

* Remove console.log

* Set no dialog by default

* Fix it

* Handle cancelling backup

* Make sonar happy

* Improve error handling

* Increase timeout to reduce corruption

Author: haslinghuis

locales/en/messages.json

@@ -56,9 +56,6 @@
     "storageDeviceNotReady": {
         "message": "The storage device is not ready. In the case of a microSD card, make sure it is properly recognised by your flight controller."
     },
-    "options_title": {
-        "message": "Application Options"
-    },
     "connect": {
         "message": "Connect"
     },
@@ -3827,9 +3824,6 @@
     "unstableFirmwareAcknowledgementFlash": {
         "message": "Flash"
     },
-    "firmwareFlasherPreviousDevice": {
-        "message": "Detected: <strong>$1</strong> - previous device still flashing, please replug to try again"
-    },
     "firmwareFlasherRemindBackupTitle": {
         "message": "Wipe out settings",
         "description": "Warning message title before actual flashing takes place"
@@ -3846,6 +3840,15 @@
         "message": "Ignore the risk",
         "description": "Ignore creating a backup before actual flashing takes place"
     },
+    "firmwareBackupEnabled": {
+        "message": "Backup enabled"
+    },
+    "firmwareBackupDisabled": {
+        "message": "Backup disabled"
+    },
+    "firmwareBackupAsk": {
+        "message": "Ask before backup"
+    },
     "ledStripHelp": {
         "message": "The flight controller can control colors and effects of individual LEDs on a strip.<br />Configure LEDs on the grid, configure wiring order then attach LEDs on your aircraft according to grid positions. LEDs without wire ordering number will not be saved.<br />Double-click on a color to edit the HSV values."
     },
@@ -7170,6 +7173,9 @@
     "cliAutoComplete": {
         "message": "Advanced CLI AutoComplete"
     },
+    "firmwareBackupOnFlash": {
+        "message": "Create a backup before flashing new target"
+    },
     "darkTheme": {
         "message": "Enable dark theme"
     },

src/js/FileSystem.js

@@ -19,6 +19,10 @@ class FileSystem {
             ],
         });
 
+        if (!fileHandle) {
+            return null;
+        }
+
         const file = this._createFile(fileHandle);
 
         if (await this.verifyPermission(file, true)) {

src/js/tabs/firmware_flasher.js

@@ -1089,47 +1089,33 @@ firmware_flasher.initialize = function (callback) {
             setTimeout(() => detectBoardElement.toggleClass("disabled", false), 2000);
         });
 
-        $("a.flash_firmware").on("click", function () {
-            self.isFlashing = true;
-            GUI.interval_pause("sponsor");
-            const isFlashOnConnect = $("input.flash_on_connect").is(":checked");
+        function initiateFlashing() {
+            if (self.developmentFirmwareLoaded) {
+                checkShowAcknowledgementDialog();
+            } else {
+                startFlashing();
+            }
+        }
 
-            self.enableFlashButton(false);
-            self.enableDfuExitButton(false);
-            self.enableLoadRemoteFileButton(false);
-            self.enableLoadFileButton(false);
+        // Backup not available in DFU, manual, virtual mode or when using flash on connect
 
-            function initiateFlashing() {
-                if (self.developmentFirmwareLoaded && !isFlashOnConnect) {
-                    checkShowAcknowledgementDialog();
+        function startBackup(callback) {
+            // prevent connection while backup is in progress
+            GUI.connect_lock = true;
+            AutoBackup.execute((result) => {
+                GUI.connect_lock = false;
+                if (result) {
+                    callback();
                 } else {
-                    startFlashing();
+                    self.isFlashing = false;
+                    self.enableFlashButton(true);
+                    self.enableLoadRemoteFileButton(true);
+                    self.enableLoadFileButton(true);
+                    GUI.interval_resume("sponsor");
+                    console.log(`${self.logHead} Backup failed, skipping flashing`);
                 }
-            }
-
-            // Backup not available in DFU, manual or virtual mode.
-            // When flash on connect is enabled, the backup dialog is not shown.
-            if (isFlashOnConnect || !(PortHandler.portAvailable || GUI.connect_lock)) {
-                initiateFlashing();
-            } else {
-                GUI.showYesNoDialog({
-                    title: i18n.getMessage("firmwareFlasherRemindBackupTitle"),
-                    text: i18n.getMessage("firmwareFlasherRemindBackup"),
-                    buttonYesText: i18n.getMessage("firmwareFlasherBackup"),
-                    buttonNoText: i18n.getMessage("firmwareFlasherBackupIgnore"),
-                    buttonYesCallback: () => {
-                        // prevent connection while backup is in progress
-                        GUI.connect_lock = true;
-                        AutoBackup.execute(() => {
-                            GUI.connect_lock = false;
-                            initiateFlashing();
-                        });
-                    },
-
-                    buttonNoCallback: initiateFlashing,
-                });
-            }
-        });
+            });
+        }
 
         function checkShowAcknowledgementDialog() {
             const DAY_MS = 86400 * 1000;
@@ -1216,6 +1202,56 @@ firmware_flasher.initialize = function (callback) {
             }
         }
 
+        $("a.flash_firmware").on("click", function () {
+            if (GUI.connect_lock) {
+                return;
+            }
+
+            self.isFlashing = true;
+            GUI.interval_pause("sponsor");
+
+            self.enableFlashButton(false);
+            self.enableDfuExitButton(false);
+            self.enableLoadRemoteFileButton(false);
+            self.enableLoadFileButton(false);
+
+            const isFlashOnConnect = $("input.flash_on_connect").is(":checked");
+
+            if (isFlashOnConnect || !PortHandler.portAvailable) {
+                startFlashing();
+                return;
+            }
+
+            // backupOnFlash:
+            // 0: disabled (default)
+            // 1: backup without dialog
+            // 2: backup with dialog
+
+            const backupOnFlash = getConfig("backupOnFlash", 1).backupOnFlash;
+
+            switch (backupOnFlash) {
+                case 1:
+                    // prevent connection while backup is in progress
+                    startBackup(initiateFlashing);
+                    break;
+                case 2:
+                    GUI.showYesNoDialog({
+                        title: i18n.getMessage("firmwareFlasherRemindBackupTitle"),
+                        text: i18n.getMessage("firmwareFlasherRemindBackup"),
+                        buttonYesText: i18n.getMessage("firmwareFlasherBackup"),
+                        buttonNoText: i18n.getMessage("firmwareFlasherBackupIgnore"),
+                        buttonYesCallback: () => {
+                            startBackup(initiateFlashing);
+                        },
+                        buttonNoCallback: initiateFlashing,
+                    });
+                    break;
+                default:
+                    initiateFlashing();
+                    break;
+            }
+        });
+
         $("span.progressLabel").on("click", "a.save_firmware", function () {
             FileSystem.pickSaveFile(
                 self.targetDetail.file,

src/js/tabs/options.js

@@ -34,6 +34,7 @@ options.initialize = function (callback) {
         TABS.options.initUserLanguage();
         TABS.options.initShowWarnings();
         TABS.options.initMeteredConnection();
+        TABS.options.initBackupOnFlash();
 
         GUI.content_ready(callback);
     });
@@ -256,6 +257,19 @@ options.initMeteredConnection = function () {
         .trigger("change");
 };
 
+options.initBackupOnFlash = function () {
+    // default to always backup on flash
+    const result = getConfig("backupOnFlash", 1);
+    $("#backupOnFlashSelect").val(result.backupOnFlash);
+    $("#backupOnFlashSelect")
+        .on("change", function () {
+            const value = parseInt($(this).val());
+
+            setConfig({ backupOnFlash: value });
+        })
+        .trigger("change");
+};
+
 options.initUserLanguage = function () {
     const userLanguage = i18n.selectedLanguage;
     const userLanguageElement = $("#userLanguage");

src/js/utils/AutoBackup.js

@@ -56,24 +56,27 @@ class AutoBackup {
         const prefix = "cli_backup";
         const suffix = "txt";
         const filename = generateFilename(prefix, suffix);
+        let result = false;
 
-        FileSystem.pickSaveFile(
-            filename,
-            i18n.getMessage("fileSystemPickerFiles", { typeof: suffix.toUpperCase() }),
-            `.${suffix}`,
-        )
-            .then((file) => {
+        try {
+            const file = await FileSystem.pickSaveFile(
+                filename,
+                i18n.getMessage("fileSystemPickerFiles", { typeof: suffix.toUpperCase() }),
+                `.${suffix}`,
+            );
+
+            if (file) {
                 console.log("Saving config to:", file.name);
-                FileSystem.writeFile(file, data);
-            })
-            .catch((error) => {
-                console.error("Error saving config:", error);
-            })
-            .finally(() => {
-                if (this.callback) {
-                    this.callback();
-                }
-            });
+                await FileSystem.writeFile(file, data);
+                result = true;
+            }
+        } catch (error) {
+            console.error("Error saving config:", error);
+        } finally {
+            if (this.callback) {
+                this.callback(result);
+            }
+        }
     }
 
     async run() {
@@ -102,7 +105,7 @@ class AutoBackup {
             setTimeout(() => {
                 this.outputHistory = "";
                 resolve();
-            }, 500);
+            }, 1000);
         });
     }
 

src/tabs/options.html

@@ -88,6 +88,14 @@
                     </div>
                     <span class="freelabel" i18n="showNotifications"></span>
                 </div>
+                <div class="backupOnFlash margin-bottom">
+                    <select id="backupOnFlashSelect">
+                        <option value="0" i18n="firmwareBackupDisabled"></option>
+                        <option value="1" i18n="firmwareBackupEnabled"></option>
+                        <option value="2" i18n="firmwareBackupAsk"></option>
+                    </select>
+                    <span class="freelabel" i18n="firmwareBackupOnFlash"></span>
+                </div>
                 <div class="userLanguage">
                     <span class="dropdown">
                         <select class="dropdown-select" id="userLanguage"