Fix: issue from older nrfutil core (#1030)

* Fix: issue from older nrfutil core * Update Changelog.md * Update Changelog.md * Update Changelog.md * Update Changelog.md * eslint fix --------- Co-authored-by: Sviatoslav Svitlychnyi <[email protected]>
NordicSemiconductor · Jul 24, 2024 · 09b17eb · 09b17eb
1 parent 70bb102
commit 09b17eb
Show file tree

Hide file tree

Showing 4 changed files with 69 additions and 19 deletions.
diff --git a/Changelog.md b/Changelog.md
@@ -1,3 +1,12 @@
+## 5.0.2 - 2024-07-24
+
+### Fixed
+
+-   Implemented recovery from invalid nRF Util module installations.
+-   Corrected the progress bar behavior to accurately reflect the installation
+    progress when multiple applications relying on the same nRF Util are being
+    installed simultaneously.
+
 ## 5.0.1 - 2024-07-09
 
 ### Fixed

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
     "name": "nrfconnect",
-    "version": "5.0.1",
+    "version": "5.0.2",
     "description": "nRF Connect for Desktop",
     "repository": {
         "type": "git",
@@ -96,7 +96,7 @@
     },
     "devDependencies": {
         "@electron/notarize": "^2.2.0",
-        "@nordicsemiconductor/pc-nrfconnect-shared": "^180.0.0",
+        "@nordicsemiconductor/pc-nrfconnect-shared": "^181.0.0",
         "@playwright/test": "^1.16.3",
         "@testing-library/user-event": "^14.4.3",
         "@types/chmodr": "1.0.0",

diff --git a/src/main/nrfutilModules.ts b/src/main/nrfutilModules.ts
@@ -9,6 +9,7 @@ import {
     NrfutilModules,
     NrfutilModuleVersion,
 } from '@nordicsemiconductor/pc-nrfconnect-shared/main';
+import { Progress } from '@nordicsemiconductor/pc-nrfconnect-shared/nrfutil';
 import { setNrfutilLogger } from '@nordicsemiconductor/pc-nrfconnect-shared/nrfutil/nrfutilLogger';
 import getSandbox, {
     NrfutilSandbox,
@@ -19,16 +20,40 @@ import { inRenderer as downloadProgress } from '../ipc/downloadProgress';
 import { getUserDataDir } from './config';
 import { logger } from './log';
 
+type SandboxesCacheKeyType = `${NrfutilModuleName}-${NrfutilModuleVersion}`;
+type SandboxesCacheType = {
+    sandbox?: Promise<NrfutilSandbox>;
+    progressCallbacks: ((progress: Progress) => void)[];
+    lastProgress?: Progress;
+};
 const sandboxesCache: {
-    [
-        index: `${NrfutilModuleName}-${NrfutilModuleVersion}`
-    ]: Promise<NrfutilSandbox>;
+    [index: SandboxesCacheKeyType]: SandboxesCacheType;
 } = {};
 
 const cachedSandbox = (
+    app: AppSpec,
     moduleName: string,
     moduleVersion: NrfutilModuleVersion
-) => sandboxesCache[`${moduleName}-${moduleVersion}`];
+) => {
+    const cached = sandboxesCache[`${moduleName}-${moduleVersion}`];
+
+    if (cached) {
+        const progressCallback = (progress: Progress) => {
+            downloadProgress.reportDownloadProgress({
+                app,
+                progressFraction: progress.totalProgressPercentage,
+                fractionName: moduleName,
+            });
+        };
+
+        if (cached.lastProgress) {
+            progressCallback(cached.lastProgress);
+        }
+
+        cached.progressCallbacks.push(progressCallback);
+        return cached.sandbox;
+    }
+};
 
 const preparedSandbox = (
     app: AppSpec,
@@ -37,20 +62,36 @@ const preparedSandbox = (
 ) => {
     setNrfutilLogger(logger);
 
+    const key: SandboxesCacheKeyType = `${moduleName}-${moduleVersion}`;
+    sandboxesCache[key] = {
+        progressCallbacks: [
+            progress => {
+                downloadProgress.reportDownloadProgress({
+                    app,
+                    progressFraction: progress.totalProgressPercentage,
+                    fractionName: moduleName,
+                });
+            },
+        ],
+    };
+
     const sandbox = getSandbox(
         getUserDataDir(),
         moduleName,
         moduleVersion,
         progress => {
-            downloadProgress.reportDownloadProgress({
-                app,
-                progressFraction: progress.totalProgressPercentage,
-                fractionName: moduleName,
-            });
+            if (sandboxesCache[key]) {
+                sandboxesCache[key].progressCallbacks.forEach(fn =>
+                    fn(progress)
+                );
+                sandboxesCache[key].lastProgress = progress;
+            }
         }
     );
 
-    sandboxesCache[`${moduleName}-${moduleVersion}`] = sandbox;
+    sandbox.finally(() => delete sandboxesCache[key]);
+    sandboxesCache[key].sandbox = sandbox;
+
     return sandbox;
 };
 export const assertPreparedNrfutilModules = (
@@ -59,6 +100,6 @@ export const assertPreparedNrfutilModules = (
 ) =>
     Object.entries(nrfutilModules).map(
         ([moduleName, [moduleVersion]]) =>
-            cachedSandbox(moduleName, moduleVersion) ??
+            cachedSandbox(app, moduleName, moduleVersion) ??
             preparedSandbox(app, moduleName, moduleVersion)
     );