@nordicsemiconductor/pc-nrfconnect-shared 230.0.0 → 232.0.0

package/nrfutil/sandbox.ts

@@ -8,6 +8,7 @@ import { exec, spawn } from 'child_process';
 import fs from 'fs';
 import os from 'os';
 import path from 'path';
+import process from 'process';
 import treeKill from 'tree-kill';
 
 import describeError from '../src/logging/describeError';
@@ -19,6 +20,7 @@ import {
     convertNrfutilProgress,
     parseJsonBuffers,
 } from './common';
+import { createDisposableTempDir } from './fs';
 import { getNrfutilLogger } from './nrfutilLogger';
 import type {
     BackgroundTask,
@@ -37,10 +39,27 @@ import {
 
 const CORE_VERSION_FOR_LEGACY_APPS = '8.1.1';
 
+export const getTriplet = () => {
+    switch (process.platform) {
+        case 'darwin':
+            return process.arch === 'arm64'
+                ? 'aarch64-apple-darwin'
+                : 'x86_64-apple-darwin';
+        case 'linux':
+            return process.arch === 'arm64'
+                ? 'aarch64-unknown-linux-gnu'
+                : 'x86_64-unknown-linux-gnu';
+        case 'win32':
+            return 'x86_64-pc-windows-msvc';
+        default:
+            throw new Error(`Unsupported platform: ${process.platform}`);
+    }
+};
+
 export class NrfutilSandbox {
     private readonly onLoggingHandlers: ((
         logging: LogMessage,
-        pid?: number
+        pid?: number,
     ) => void)[] = [];
     private logLevel: LogLevel = isDevelopment ? 'error' : 'off';
 
@@ -53,13 +72,13 @@ export class NrfutilSandbox {
         module: string,
         version?: string,
         coreVersion?: string,
-        onProgress?: OnProgress
+        onProgress?: OnProgress,
     ) {
         const sandbox = new NrfutilSandbox(
             baseDir,
             module,
             versionToInstall(module, version),
-            coreVersionsToInstall(coreVersion)
+            coreVersionsToInstall(coreVersion),
         );
 
         onProgress?.(convertNrfutilProgress({ progressPercentage: 0 }));
@@ -77,7 +96,7 @@ export class NrfutilSandbox {
         private readonly baseDir: string,
         private readonly module: string,
         private readonly version: string,
-        coreVersion?: string // Must only be undefined when the launcher creates a sandbox for a legacy app, which does not specify the required core version
+        coreVersion?: string, // Must only be undefined when the launcher creates a sandbox for a legacy app, which does not specify the required core version
     ) {
         this.sandboxPath = path.join(
             this.baseDir,
@@ -87,7 +106,7 @@ export class NrfutilSandbox {
                 : []),
             ...(coreVersion != null ? [coreVersion] : []),
             this.module,
-            this.version
+            this.version,
         );
 
         this.coreVersion = coreVersion ?? CORE_VERSION_FOR_LEGACY_APPS;
@@ -153,8 +172,8 @@ export class NrfutilSandbox {
                 'bin',
                 `nrfutil-${this.module}${
                     os.platform() === 'win32' ? '.exe' : ''
-                }`
-            )
+                }`,
+            ),
         );
     }
 
@@ -186,14 +205,43 @@ export class NrfutilSandbox {
         }
     };
 
-    private installNrfUtilCore = (onProgress?: OnProgress) =>
-        this.install(
+    private installNrfUtilCore = async (onProgress?: OnProgress) => {
+        using tmpDir = createDisposableTempDir();
+
+        const nrfutilTarGzFile = await this.downloadNrfutilTarGz(tmpDir.path);
+
+        await this.install(
             'core',
             this.coreVersion,
-            'self-upgrade',
-            ['--to-version', this.coreVersion],
-            onProgress
+            '--version',
+            [],
+            onProgress,
+            undefined,
+            undefined,
+            undefined,
+            env => ({
+                ...env,
+                NRFUTIL_BOOTSTRAP_TARBALL_PATH: nrfutilTarGzFile,
+            }),
         );
+    };
+
+    private downloadNrfutilTarGz = async (folder: string) => {
+        const baseUrl =
+            'https://files.nordicsemi.com/ui/api/v1/download?isNativeBrowsing=true&repoKey=swtools&path=external/nrfutil/packages/nrfutil/';
+        const fileName = `nrfutil-${getTriplet()}-${this.coreVersion}.tar.gz`;
+        const url = baseUrl + fileName;
+
+        const response = await fetch(url);
+        if (!response.ok) {
+            throw new Error(`Failed to fetch ${url}: ${response.statusText}`);
+        }
+
+        const filePath = path.join(folder, fileName);
+        fs.writeFileSync(filePath, new DataView(await response.arrayBuffer()));
+
+        return filePath;
+    };
 
     public installNrfUtilCommand = (onProgress?: OnProgress) =>
         this.install(
@@ -201,7 +249,7 @@ export class NrfutilSandbox {
             this.version,
             'install',
             [`${this.module}=${this.version}`, '--force'],
-            onProgress
+            onProgress,
         );
 
     public install = async (
@@ -212,11 +260,11 @@ export class NrfutilSandbox {
         try {
             await this.spawnNrfutil(...args);
             getNrfutilLogger()?.info(
-                `Successfully installed nrfutil ${module} version: ${version}`
+                `Successfully installed nrfutil ${module} version: ${version}`,
             );
         } catch (error) {
             const errorMessage = `Error while installing nrfutil ${module} version ${version}: ${describeError(
-                error
+                error,
             )}`;
 
             getNrfutilLogger()?.error(errorMessage);
@@ -233,7 +281,7 @@ export class NrfutilSandbox {
         onTaskBegin?: OnTaskBegin,
         onTaskEnd?: OnTaskEnd<Result>,
         controller?: AbortController,
-        editEnv?: (env: NodeJS.ProcessEnv) => NodeJS.ProcessEnv
+        editEnv?: (env: NodeJS.ProcessEnv) => NodeJS.ProcessEnv,
     ) =>
         this.spawnNrfutil<Result>(
             this.module,
@@ -242,7 +290,7 @@ export class NrfutilSandbox {
             onTaskBegin,
             onTaskEnd,
             controller,
-            editEnv
+            editEnv,
         );
 
     private spawnNrfutilCommand = (
@@ -251,7 +299,7 @@ export class NrfutilSandbox {
         parser: (data: Buffer, pid?: number) => Buffer | undefined,
         onStdError: (data: Buffer, pid?: number) => void,
         controller?: AbortController,
-        editEnv?: (env: NodeJS.ProcessEnv) => NodeJS.ProcessEnv
+        editEnv?: (env: NodeJS.ProcessEnv) => NodeJS.ProcessEnv,
     ) =>
         this.spawnCommand(
             this.getNrfutilExePath(),
@@ -266,7 +314,7 @@ export class NrfutilSandbox {
             parser,
             onStdError,
             controller,
-            editEnv
+            editEnv,
         );
 
     private spawnNrfutil = async <Result>(
@@ -276,7 +324,7 @@ export class NrfutilSandbox {
         onTaskBegin?: OnTaskBegin,
         onTaskEnd?: OnTaskEnd<Result>,
         controller?: AbortController,
-        editEnv?: (env: NodeJS.ProcessEnv) => NodeJS.ProcessEnv
+        editEnv?: (env: NodeJS.ProcessEnv) => NodeJS.ProcessEnv,
     ) => {
         let stdErr: string | undefined;
         let pid: number | undefined;
@@ -285,7 +333,7 @@ export class NrfutilSandbox {
             this.log,
             onProgress,
             onTaskBegin,
-            onTaskEnd
+            onTaskEnd,
         );
 
         try {
@@ -298,7 +346,7 @@ export class NrfutilSandbox {
                     stdErr = (stdErr ?? '') + data.toString();
                 },
                 controller,
-                editEnv
+                editEnv,
             );
 
             if (stdErr || parser.hasFailures()) throw new Error('Task failed.');
@@ -310,11 +358,11 @@ export class NrfutilSandbox {
             error.message = collectErrorMessages(
                 error.message,
                 stdErr,
-                parser.errorMessage()
+                parser.errorMessage(),
             );
 
             telemetry.sendErrorReport(
-                `${this.pidIfTraceLogging(pid)}${describeError(error)}`
+                `${this.pidIfTraceLogging(pid)}${describeError(error)}`,
             );
             throw error;
         }
@@ -326,16 +374,16 @@ export class NrfutilSandbox {
         parser: (data: Buffer, pid?: number) => Buffer | undefined,
         onStdError: (data: Buffer, pid?: number) => void,
         controller?: AbortController,
-        editEnv: (env: NodeJS.ProcessEnv) => NodeJS.ProcessEnv = env => env
+        editEnv: (env: NodeJS.ProcessEnv) => NodeJS.ProcessEnv = env => env,
     ) =>
         new Promise<void>((resolve, reject) => {
             if (controller?.signal.aborted) {
                 reject(
                     new Error(
                         `Aborted before start executing ${path.basename(
-                            command
-                        )} ${JSON.stringify(args)}`
-                    )
+                            command,
+                        )} ${JSON.stringify(args)}`,
+                    ),
                 );
                 return;
             }
@@ -359,7 +407,7 @@ export class NrfutilSandbox {
 
             controller?.signal.addEventListener('abort', listener);
 
-            let buffer = Buffer.from('');
+            let buffer: Buffer<ArrayBufferLike> = Buffer.from('');
 
             nrfutil.stdout.on('data', (data: Buffer) => {
                 if (controller?.signal.aborted) return;
@@ -387,9 +435,9 @@ export class NrfutilSandbox {
                     reject(
                         new Error(
                             `Aborted ongoing ${path.basename(
-                                command
-                            )} ${JSON.stringify(args)}`
-                        )
+                                command,
+                            )} ${JSON.stringify(args)}`,
+                        ),
                     );
                     return;
                 }
@@ -409,7 +457,7 @@ export class NrfutilSandbox {
         onTaskBegin?: OnTaskBegin,
         onTaskEnd?: OnTaskEnd<Result>,
         controller?: AbortController,
-        editEnv?: (env: NodeJS.ProcessEnv) => NodeJS.ProcessEnv
+        editEnv?: (env: NodeJS.ProcessEnv) => NodeJS.ProcessEnv,
     ) =>
         this.execNrfutilCommand<Result>(
             this.module,
@@ -418,7 +466,7 @@ export class NrfutilSandbox {
             onTaskBegin,
             onTaskEnd,
             controller,
-            editEnv
+            editEnv,
         );
 
     private execNrfutilCommand = async <Result>(
@@ -428,7 +476,7 @@ export class NrfutilSandbox {
         onTaskBegin?: OnTaskBegin,
         onTaskEnd?: OnTaskEnd<Result>,
         controller?: AbortController,
-        editEnv?: (env: NodeJS.ProcessEnv) => NodeJS.ProcessEnv
+        editEnv?: (env: NodeJS.ProcessEnv) => NodeJS.ProcessEnv,
     ) => {
         let stdErr: string | undefined;
         let pid: number | undefined;
@@ -437,7 +485,7 @@ export class NrfutilSandbox {
             this.log,
             onProgress,
             onTaskBegin,
-            onTaskEnd
+            onTaskEnd,
         );
 
         try {
@@ -450,7 +498,7 @@ export class NrfutilSandbox {
                     stdErr = (stdErr ?? '') + data.toString();
                 },
                 controller,
-                editEnv
+                editEnv,
             );
 
             if (stdErr || parser.hasFailures()) throw new Error('Task failed.');
@@ -462,11 +510,11 @@ export class NrfutilSandbox {
             error.message = collectErrorMessages(
                 error.message,
                 stdErr,
-                parser.errorMessage()
+                parser.errorMessage(),
             );
 
             telemetry.sendErrorReport(
-                `${this.pidIfTraceLogging(pid)}${describeError(error)}`
+                `${this.pidIfTraceLogging(pid)}${describeError(error)}`,
             );
             throw error;
         }
@@ -478,7 +526,7 @@ export class NrfutilSandbox {
         onData: (data: Buffer, pid?: number) => void,
         onStdError: (data: Buffer, pid?: number) => void,
         controller?: AbortController,
-        editEnv: (env: NodeJS.ProcessEnv) => NodeJS.ProcessEnv = env => env
+        editEnv: (env: NodeJS.ProcessEnv) => NodeJS.ProcessEnv = env => env,
     ) =>
         new Promise<void>((resolve, reject) => {
             let aborting = false;
@@ -495,7 +543,7 @@ export class NrfutilSandbox {
                 getNrfutilLogger()?.info(
                     `Aborting the ongoing command nrfutil ${
                         this.module
-                    } ${command} ${JSON.stringify(args)}`
+                    } ${command} ${JSON.stringify(args)}`,
                 );
                 aborting = true;
                 if (nrfutil.pid) {
@@ -524,8 +572,8 @@ export class NrfutilSandbox {
                         new Error(
                             `Aborted ongoing ${path.basename(command)} ${
                                 args[0] ?? ''
-                            }`
-                        )
+                            }`,
+                        ),
                     );
                     return;
                 }
@@ -542,7 +590,7 @@ export class NrfutilSandbox {
         command: string,
         args: string[],
         processors: BackgroundTask<Result>,
-        editEnv?: (env: NodeJS.ProcessEnv) => NodeJS.ProcessEnv
+        editEnv?: (env: NodeJS.ProcessEnv) => NodeJS.ProcessEnv,
     ) => {
         const controller = new AbortController();
         let running = true;
@@ -573,7 +621,7 @@ export class NrfutilSandbox {
                 processors.onError(new Error(data.toString()), pid);
             },
             controller,
-            editEnv
+            editEnv,
         );
 
         operation
@@ -606,13 +654,13 @@ export class NrfutilSandbox {
         command: string,
         onProgress?: OnProgress,
         controller?: AbortController,
-        args: string[] = []
+        args: string[] = [],
     ) => {
         const data = await this.singleTaskEndOperationOptionalData<T>(
             command,
             onProgress,
             controller,
-            args
+            args,
         );
 
         if (data != null) {
@@ -625,7 +673,7 @@ export class NrfutilSandbox {
         command: string,
         onProgress?: OnProgress,
         controller?: AbortController,
-        args: string[] = []
+        args: string[] = [],
     ) => {
         const results = await this.spawnNrfutilSubcommand<T>(
             command,
@@ -633,7 +681,7 @@ export class NrfutilSandbox {
             onProgress,
             undefined,
             undefined,
-            controller
+            controller,
         );
 
         if (results.taskEnd.length === 1) {
@@ -645,7 +693,7 @@ export class NrfutilSandbox {
     public singleInfoOperationOptionalData = async <T = void>(
         command: string,
         controller?: AbortController,
-        args: string[] = []
+        args: string[] = [],
     ) => {
         const results = await this.spawnNrfutilSubcommand<T>(
             command,
@@ -653,7 +701,7 @@ export class NrfutilSandbox {
             undefined,
             undefined,
             undefined,
-            controller
+            controller,
         );
 
         if (results.info.length === 1) {
@@ -663,14 +711,14 @@ export class NrfutilSandbox {
     };
 
     public onLogging = (
-        handler: (logging: LogMessage, pid?: number) => void
+        handler: (logging: LogMessage, pid?: number) => void,
     ) => {
         this.onLoggingHandlers.push(handler);
 
         return () =>
             this.onLoggingHandlers.splice(
                 this.onLoggingHandlers.indexOf(handler),
-                1
+                1,
             );
     };
 

package/nrfutil/version/jlinkVersion.test.ts

@@ -21,13 +21,13 @@ test('strippedVersionName', () => {
         strippedVersionName({
             version: '7.94i',
             versionFormat: 'string',
-        })
+        }),
     ).toBe('7.94i');
     expect(
         strippedVersionName({
             version: '7.96 ',
             versionFormat: 'string',
-        })
+        }),
     ).toBe('7.96');
 });
 
@@ -39,8 +39,8 @@ describe('expectedFormat', () => {
                     version: 18,
                     versionFormat: 'incremental',
                 },
-                false
-            )
+                false,
+            ),
         ).toBe(false);
 
         expect(
@@ -49,8 +49,8 @@ describe('expectedFormat', () => {
                     version: { major: 1, minor: 2, patch: 3 },
                     versionFormat: 'semantic',
                 },
-                false
-            )
+                false,
+            ),
         ).toBe(false);
     });
 
@@ -81,8 +81,8 @@ describe('expectedFormat', () => {
                     version: 'JLink_V7.94i',
                     versionFormat: 'string',
                 },
-                false
-            )
+                false,
+            ),
         ).toBe(true);
         expect(
             hasExpectedVersionFormat(
@@ -90,8 +90,8 @@ describe('expectedFormat', () => {
                     version: 'JLink_V7.96 ',
                     versionFormat: 'string',
                 },
-                false
-            )
+                false,
+            ),
         ).toBe(true);
         expect(
             hasExpectedVersionFormat(
@@ -99,24 +99,24 @@ describe('expectedFormat', () => {
                     version: 'JLink_V8.10',
                     versionFormat: 'string',
                 },
-                false
-            )
+                false,
+            ),
         ).toBe(true);
     });
 });
 
 test('convertToSemver', () => {
     expect(
-        convertToSemver({ version: 'JLink_V7.94', versionFormat: 'string' })
+        convertToSemver({ version: 'JLink_V7.94', versionFormat: 'string' }),
     ).toBe('7.94.0');
     expect(
-        convertToSemver({ version: 'JLink_V7.96 ', versionFormat: 'string' })
+        convertToSemver({ version: 'JLink_V7.96 ', versionFormat: 'string' }),
     ).toBe('7.96.0');
     expect(
-        convertToSemver({ version: 'JLink_V7.98a', versionFormat: 'string' })
+        convertToSemver({ version: 'JLink_V7.98a', versionFormat: 'string' }),
     ).toBe('7.98.1');
     expect(
-        convertToSemver({ version: 'JLink_V8.10b', versionFormat: 'string' })
+        convertToSemver({ version: 'JLink_V8.10b', versionFormat: 'string' }),
     ).toBe('8.10.2');
 });
 
@@ -140,7 +140,7 @@ describe('existingIsOlderThanExpected', () => {
 
     it('is false if no expected is specified', () => {
         expect(
-            existingIsOlderThanExpected({ ...version794i, name: 'JlinkARM' })
+            existingIsOlderThanExpected({ ...version794i, name: 'JlinkARM' }),
         ).toBe(false);
     });
     it('is false if the actual is equal the expected', () => {
@@ -149,7 +149,7 @@ describe('existingIsOlderThanExpected', () => {
                 ...version794i,
                 name: 'JlinkARM',
                 expectedVersion: version794i,
-            })
+            }),
         ).toBe(false);
     });
     it('is false if the actual is newer than the expected', () => {
@@ -158,21 +158,21 @@ describe('existingIsOlderThanExpected', () => {
                 ...version794k,
                 name: 'JlinkARM',
                 expectedVersion: version794i,
-            })
+            }),
         ).toBe(false);
         expect(
             existingIsOlderThanExpected({
                 ...version796,
                 name: 'JlinkARM',
                 expectedVersion: version794i,
-            })
+            }),
         ).toBe(false);
         expect(
             existingIsOlderThanExpected({
                 ...version810b,
                 name: 'JlinkARM',
                 expectedVersion: version794i,
-            })
+            }),
         ).toBe(false);
     });
 
@@ -182,21 +182,21 @@ describe('existingIsOlderThanExpected', () => {
                 ...version794i,
                 name: 'JlinkARM',
                 expectedVersion: version794k,
-            })
+            }),
         ).toBe(true);
         expect(
             existingIsOlderThanExpected({
                 ...version794i,
                 name: 'JlinkARM',
                 expectedVersion: version796,
-            })
+            }),
         ).toBe(true);
         expect(
             existingIsOlderThanExpected({
                 ...version794i,
                 name: 'JlinkARM',
                 expectedVersion: version810b,
-            })
+            }),
         ).toBe(true);
     });
 });
@@ -244,8 +244,8 @@ describe('getJlinkCompatibility', () => {
                         versionFormat: 'string',
                         version: 'JLink_V8.10f',
                     },
-                })
-            )
+                }),
+            ),
         ).toEqual({
             kind: 'No SEGGER J-Link installed',
             requiredJlink: '8.10f',
@@ -264,8 +264,8 @@ describe('getJlinkCompatibility', () => {
                         version: 'JLink_V7.94i',
                         versionFormat: 'string',
                     },
-                })
-            )
+                }),
+            ),
         ).toEqual({
             kind: 'Outdated SEGGER J-Link',
             requiredJlink: '7.94i',
@@ -284,8 +284,8 @@ describe('getJlinkCompatibility', () => {
                         version: 'JLink_V7.94i',
                         versionFormat: 'string',
                     },
-                })
-            )
+                }),
+            ),
         ).toEqual({
             kind: 'Newer SEGGER J-Link is used',
             requiredJlink: '7.94i',
@@ -304,8 +304,8 @@ describe('getJlinkCompatibility', () => {
                         version: 'JLink_V7.94i',
                         versionFormat: 'string',
                     },
-                })
-            )
+                }),
+            ),
         ).toEqual({ kind: 'Tested SEGGER J-Link is used' });
     });
 
@@ -316,8 +316,8 @@ describe('getJlinkCompatibility', () => {
                     name: 'JlinkARM',
                     version: 'JLink_V7.94i',
                     versionFormat: 'string',
-                })
-            )
+                }),
+            ),
         ).toEqual({ kind: 'Tested SEGGER J-Link is used' });
     });
 });