Improved build request management, enabling user to cancel and indica…

…ting whether processing has commenced.
betaflight · Jan 7, 2024 · 1d42316 · 1d42316
1 parent 842194f
commit 1d42316
Show file tree

Hide file tree

Showing 16 changed files with 84 additions and 52 deletions.
diff --git a/locales/ca/messages.json b/locales/ca/messages.json
@@ -3335,10 +3335,10 @@
     "firmwareFlasherCloudBuildSuccess": {
         "message": "èxit"
     },
-    "firmwareFlasherCloudBuildTimedOut": {
+    "firmwareFlasherCloudBuildFailTimeOut": {
         "message": "s'ha esgotat el temps d'espera (torneu-ho a provar)"
     },
-    "firmwareFlasherCloudBuildFailed": {
+    "firmwareFlasherCloudBuildFail": {
         "message": "ha fallat (comproveu el registre)"
     },
     "firmwareFlasherReleaseFileUrl": {

diff --git a/locales/da/messages.json b/locales/da/messages.json
@@ -3331,10 +3331,10 @@
     "firmwareFlasherCloudBuildSuccess": {
         "message": "succes"
     },
-    "firmwareFlasherCloudBuildTimedOut": {
+    "firmwareFlasherCloudBuildFailTimeOut": {
         "message": "timeout (prøv igen)"
     },
-    "firmwareFlasherCloudBuildFailed": {
+    "firmwareFlasherCloudBuildFail": {
         "message": "mislykkedes (tjek log)"
     },
     "firmwareFlasherReleaseFileUrl": {

diff --git a/locales/de/messages.json b/locales/de/messages.json
@@ -2970,10 +2970,10 @@
     "firmwareFlasherCloudBuildSuccess": {
         "message": "Erfolgreich"
     },
-    "firmwareFlasherCloudBuildTimedOut": {
+    "firmwareFlasherCloudBuildFailTimeOut": {
         "message": "Zeitüberschreitung (bitte erneut versuchen)"
     },
-    "firmwareFlasherCloudBuildFailed": {
+    "firmwareFlasherCloudBuildFail": {
         "message": "Fehlgeschlagen (bitte Log prüfen)"
     },
     "firmwareFlasherReleaseFileUrl": {

diff --git a/locales/en/messages.json b/locales/en/messages.json
@@ -1397,7 +1397,7 @@
     },
     "configurationMotorIdleRpmHelp" : {
         "message": "This is the dynamic idle value from the active PID profile. When Dynamic Idle is set to zero, only static motor idle will apply. Change the Dynamic Idle settings on the PID tuning tab.",
-        "description": "Help text for dynamic idle setting" 
+        "description": "Help text for dynamic idle setting"
     },
     "configurationThrottleMinimum": {
         "message": "Minimum Throttle (Lowest ESC value when armed)"
@@ -3415,10 +3415,13 @@
     "firmwareFlasherCloudBuildSuccess": {
         "message": "success"
     },
-    "firmwareFlasherCloudBuildTimedOut": {
+    "firmwareFlasherCloudBuildFailCancel": {
+        "message": "cancelled"
+    },
+    "firmwareFlasherCloudBuildFailTimeOut": {
         "message": "timed out (please retry)"
     },
-    "firmwareFlasherCloudBuildFailed": {
+    "firmwareFlasherCloudBuildFail": {
         "message": "failed (please check log)"
     },
     "firmwareFlasherReleaseFileUrl": {

diff --git a/locales/es/messages.json b/locales/es/messages.json
@@ -3327,10 +3327,10 @@
     "firmwareFlasherCloudBuildSuccess": {
         "message": "éxito"
     },
-    "firmwareFlasherCloudBuildTimedOut": {
+    "firmwareFlasherCloudBuildFailTimeOut": {
         "message": "tiempo agotado (vuelve a intentarlo)"
     },
-    "firmwareFlasherCloudBuildFailed": {
+    "firmwareFlasherCloudBuildFail": {
         "message": "error (revisa el registro)"
     },
     "firmwareFlasherReleaseFileUrl": {

diff --git a/locales/fr/messages.json b/locales/fr/messages.json
@@ -2894,10 +2894,10 @@
     "firmwareFlasherCloudBuildSuccess": {
         "message": "succès"
     },
-    "firmwareFlasherCloudBuildTimedOut": {
+    "firmwareFlasherCloudBuildFailTimeOut": {
         "message": "temps expiré (veuillez réessayer)"
     },
-    "firmwareFlasherCloudBuildFailed": {
+    "firmwareFlasherCloudBuildFail": {
         "message": "échec (veuillez vérifier le log)"
     },
     "firmwareFlasherReleaseFileUrl": {

diff --git a/locales/gl/messages.json b/locales/gl/messages.json
@@ -3330,10 +3330,10 @@
     "firmwareFlasherCloudBuildSuccess": {
         "message": "éxito"
     },
-    "firmwareFlasherCloudBuildTimedOut": {
+    "firmwareFlasherCloudBuildFailTimeOut": {
         "message": "tempo esgotado (volva a intentalo)"
     },
-    "firmwareFlasherCloudBuildFailed": {
+    "firmwareFlasherCloudBuildFail": {
         "message": "fallou (verifique o rexistro)"
     },
     "firmwareFlasherReleaseFileUrl": {

diff --git a/locales/it/messages.json b/locales/it/messages.json
@@ -3327,10 +3327,10 @@
     "firmwareFlasherCloudBuildSuccess": {
         "message": "successo"
     },
-    "firmwareFlasherCloudBuildTimedOut": {
+    "firmwareFlasherCloudBuildFailTimeOut": {
         "message": "timeout (riprova)"
     },
-    "firmwareFlasherCloudBuildFailed": {
+    "firmwareFlasherCloudBuildFail": {
         "message": "fallito (si prega di controllare il log)"
     },
     "firmwareFlasherReleaseFileUrl": {

diff --git a/locales/ja/messages.json b/locales/ja/messages.json
@@ -3327,10 +3327,10 @@
     "firmwareFlasherCloudBuildSuccess": {
         "message": "成功しました"
     },
-    "firmwareFlasherCloudBuildTimedOut": {
+    "firmwareFlasherCloudBuildFailTimeOut": {
         "message": "タイムアウトしました (再試行してください)"
     },
-    "firmwareFlasherCloudBuildFailed": {
+    "firmwareFlasherCloudBuildFail": {
         "message": "失敗しました (ログを確認してください)"
     },
     "firmwareFlasherReleaseFileUrl": {

diff --git a/locales/ko/messages.json b/locales/ko/messages.json
@@ -3331,10 +3331,10 @@
     "firmwareFlasherCloudBuildSuccess": {
         "message": "성공"
     },
-    "firmwareFlasherCloudBuildTimedOut": {
+    "firmwareFlasherCloudBuildFailTimeOut": {
         "message": "시간 초과됨 (재시도하세요)"
     },
-    "firmwareFlasherCloudBuildFailed": {
+    "firmwareFlasherCloudBuildFail": {
         "message": "실패 (로그기록을 확인하세요)"
     },
     "firmwareFlasherReleaseFileUrl": {

diff --git a/locales/pl/messages.json b/locales/pl/messages.json
@@ -3331,10 +3331,10 @@
     "firmwareFlasherCloudBuildSuccess": {
         "message": "ukończono"
     },
-    "firmwareFlasherCloudBuildTimedOut": {
+    "firmwareFlasherCloudBuildFailTimeOut": {
         "message": "przekroczono limit czasu (spróbuj ponownie)"
     },
-    "firmwareFlasherCloudBuildFailed": {
+    "firmwareFlasherCloudBuildFail": {
         "message": "nie powiodło się (proszę sprawdzić logi)"
     },
     "firmwareFlasherReleaseFileUrl": {

diff --git a/locales/pt/messages.json b/locales/pt/messages.json
@@ -3327,10 +3327,10 @@
     "firmwareFlasherCloudBuildSuccess": {
         "message": "sucesso"
     },
-    "firmwareFlasherCloudBuildTimedOut": {
+    "firmwareFlasherCloudBuildFailTimeOut": {
         "message": "tempo expirou (pf tente novamente)"
     },
-    "firmwareFlasherCloudBuildFailed": {
+    "firmwareFlasherCloudBuildFail": {
         "message": "falhou (pf verifique o log)"
     },
     "firmwareFlasherReleaseFileUrl": {

diff --git a/locales/pt_BR/messages.json b/locales/pt_BR/messages.json
@@ -3124,10 +3124,10 @@
     "firmwareFlasherCloudBuildSuccess": {
         "message": "sucesso"
     },
-    "firmwareFlasherCloudBuildTimedOut": {
+    "firmwareFlasherCloudBuildFailTimeOut": {
         "message": "tempo esgotado (tente novamente)"
     },
-    "firmwareFlasherCloudBuildFailed": {
+    "firmwareFlasherCloudBuildFail": {
         "message": "falhou (por favor, verifique o log)"
     },
     "firmwareFlasherReleaseFileUrl": {

diff --git a/locales/uk/messages.json b/locales/uk/messages.json
@@ -3327,10 +3327,10 @@
     "firmwareFlasherCloudBuildSuccess": {
         "message": "успішно"
     },
-    "firmwareFlasherCloudBuildTimedOut": {
+    "firmwareFlasherCloudBuildFailTimeOut": {
         "message": "час вийшов (спробуйте ще раз)"
     },
-    "firmwareFlasherCloudBuildFailed": {
+    "firmwareFlasherCloudBuildFail": {
         "message": "не вдалося (перевірте журнал)"
     },
     "firmwareFlasherReleaseFileUrl": {

diff --git a/src/js/tabs/firmware_flasher.js b/src/js/tabs/firmware_flasher.js
@@ -23,7 +23,7 @@ import Sponsor from '../Sponsor';
 
 const firmware_flasher = {
     targets: null,
-    releaseLoader: new BuildApi(),
+    buildApi: new BuildApi(),
     sponsor: new Sponsor(),
     localFirmwareLoaded: false,
     selectedBoard: undefined,
@@ -39,6 +39,7 @@ const firmware_flasher = {
     configFilename: null,
     config: {},
     developmentFirmwareLoaded: false, // Is the firmware to be flashed from the development branch?
+    cancelBuild: false,
 };
 
 firmware_flasher.initialize = function (callback) {
@@ -325,7 +326,7 @@ firmware_flasher.initialize = function (callback) {
 
             if (!GUI.connect_lock) {
                 try {
-                    self.releaseLoader.loadTargets(loadTargetList);
+                    self.buildApi.loadTargets(loadTargetList);
                 } catch (err) {
                     console.error(err);
                 }
@@ -360,7 +361,7 @@ firmware_flasher.initialize = function (callback) {
                     const expertMode = expertMode_e.is(':checked');
                     if (expertMode) {
                         if (response.releaseType === 'Unstable') {
-                            self.releaseLoader.loadCommits(response.release, (commits) => {
+                            self.buildApi.loadCommits(response.release, (commits) => {
                                 const select_e = $('select[name="commits"]');
                                 select_e.empty();
                                 commits.forEach((commit) => {
@@ -384,12 +385,12 @@ firmware_flasher.initialize = function (callback) {
                 self.enableLoadRemoteFileButton(true);
             }
 
-            self.releaseLoader.loadTarget(target, release, onTargetDetail);
+            self.buildApi.loadTarget(target, release, onTargetDetail);
 
             if (self.validateBuildKey() && navigator.onLine) {
-                self.releaseLoader.loadOptionsByBuildKey(release, self.cloudBuildKey, buildOptions);
+                self.buildApi.loadOptionsByBuildKey(release, self.cloudBuildKey, buildOptions);
             } else {
-                self.releaseLoader.loadOptions(release, buildOptions);
+                self.buildApi.loadOptions(release, buildOptions);
             }
         }
 
@@ -514,7 +515,7 @@ firmware_flasher.initialize = function (callback) {
                         ),
                     );
 
-                    self.releaseLoader.loadTargetReleases(target, (data) => populateReleases(versions_e, data));
+                    self.buildApi.loadTargetReleases(target, (data) => populateReleases(versions_e, data));
                 }
             }
         });
@@ -761,6 +762,11 @@ firmware_flasher.initialize = function (callback) {
             },
         );
 
+        $('a.cloud_build_cancel').on('click', function (evt) {
+            $('a.cloud_build_cancel').toggleClass('disabled', true);
+            self.cancelBuild = true;
+        });
+
         $('a.load_remote_file').on('click', function (evt) {
             if (!self.selectedBoard) {
                 return;
@@ -791,15 +797,15 @@ firmware_flasher.initialize = function (callback) {
                 $('.buildProgress').val(val);
             }
 
-            function processBuildStatus(response, statusResponse, retries) {
+            function processBuildStatus(response, statusResponse, suffix) {
                 if (statusResponse.status === 'success') {
-                    updateStatus(retries <= 0 ? 'SuccessCached' : "Success", response.key, 100, true);
+                    updateStatus(`Success${suffix}`, response.key, 100, true);
                     if (statusResponse.configuration !== undefined && !self.isConfigLocal) {
                         setBoardConfig(statusResponse.configuration);
                     }
-                    self.releaseLoader.loadTargetHex(response.url, (hex) => onLoadSuccess(hex, response.file), onLoadFailed);
+                    self.buildApi.loadTargetHex(response.url, (hex) => onLoadSuccess(hex, response.file), onLoadFailed);
                 } else {
-                    updateStatus(retries > 10 ? 'TimedOut' : "Failed", response.key, 0, true);
+                    updateStatus(`Fail${suffix}`, response.key, 0, true);
                     onLoadFailed();
                 }
             }
@@ -844,40 +850,60 @@ firmware_flasher.initialize = function (callback) {
                 }
 
                 console.info("Build request:", request);
-                self.releaseLoader.requestBuild(request, (response) => {
+                self.buildApi.requestBuild(request, (response) => {
                     console.info("Build response:", response);
 
                     // Complete the summary object to be used later
                     self.targetDetail.file = response.file;
 
                     if (!targetDetail.cloudBuild) {
                         // it is a previous release, so simply load the hex
-                        self.releaseLoader.loadTargetHex(response.url, (hex) => onLoadSuccess(hex, response.file), onLoadFailed);
+                        self.buildApi.loadTargetHex(response.url, (hex) => onLoadSuccess(hex, response.file), onLoadFailed);
                         return;
                     }
 
                     updateStatus('Pending', response.key, 0, false);
+                    self.cancelBuild = false;
 
                     let retries = 1;
-                    self.releaseLoader.requestBuildStatus(response.key, (statusResponse) => {
+                    self.buildApi.requestBuildStatus(response.key, (statusResponse) => {
                         if (statusResponse.status !== "queued") {
                             // will be cached already, no need to wait.
-                            processBuildStatus(response, statusResponse, 0);
+                            processBuildStatus(response, statusResponse, "Cached");
                             return;
                         }
 
+                        $('a.cloud_build_cancel').toggleClass('disabled', false);
+                        const retrySeconds = 5;
                         const timer = setInterval(() => {
-                            self.releaseLoader.requestBuildStatus(response.key, (statusResponse) => {
-                                if (statusResponse.status !== 'queued' || retries > 10) {
+                            self.buildApi.requestBuildStatus(response.key, (statusResponse) => {
+                                const timeout = statusResponse.timeOut !== undefined ? statusResponse.timeOut : 60;
+                                const retryTotal = timeout / retrySeconds;
+
+                                if (statusResponse.status !== 'queued' || retries > retryTotal || self.cancelBuild) {
+                                    let suffix = "";
+                                    if (retries > retryTotal) {
+                                        suffix = "TimeOut";
+                                    }
+
+                                    if (self.cancelBuild) {
+                                        suffix = "Cancel";
+                                    }
+
+                                    $('a.cloud_build_cancel').toggleClass('disabled', true);
+                                    self.cancelBuild = false;
                                     clearInterval(timer);
-                                    processBuildStatus(response, statusResponse, retries);
+
+                                    processBuildStatus(response, statusResponse, suffix);
                                     return;
                                 }
 
-                                updateStatus('Processing', response.key, retries * 10, false);
-                                retries++;
+                                updateStatus('Processing', response.key, retries * (100 / retryTotal), false);
+                                if (statusResponse.timeOut !== undefined) {
+                                    retries++;
+                                }
                             });
-                        }, 5000);
+                        }, retrySeconds * 1000);
                     });
                 }, onLoadFailed);
             }
@@ -1159,7 +1185,7 @@ firmware_flasher.initialize = function (callback) {
         GUI.content_ready(callback);
     }
 
-    self.releaseLoader.loadTargets(() => {
+    self.buildApi.loadTargets(() => {
        $('#content').load("./tabs/firmware_flasher.html", onDocumentLoad);
     });
 };
@@ -1267,7 +1293,7 @@ firmware_flasher.verifyBoard = function() {
                     self.cloudBuildKey = FC.CONFIG.buildKey;
 
                     if (self.validateBuildKey()) {
-                        self.releaseLoader.requestBuildOptions(self.cloudBuildKey, getCloudBuildOptions, getBoardInfo);
+                        self.buildApi.requestBuildOptions(self.cloudBuildKey, getCloudBuildOptions, getBoardInfo);
                     } else {
                         getBoardInfo();
                     }

diff --git a/src/tabs/firmware_flasher.html b/src/tabs/firmware_flasher.html
@@ -254,6 +254,9 @@
                     <progress class="buildProgress" value="0" min="0" max="100"></progress>
                     <span id="cloudTargetStatus"></span>
                     <br />
+                    <div class="btn default_btn">
+                        <a class="cloud_build_cancel disabled" href="#" i18n="cancel"></a>
+                    </div>
                 </div>
             </div>
         </div>