Update shared to 191

Author: datenreisender

package-lock.json

@@ -96,7 +96,7 @@
     },
     "devDependencies": {
         "@electron/notarize": "^2.2.0",
-        "@nordicsemiconductor/pc-nrfconnect-shared": "^188.0.0",
+        "@nordicsemiconductor/pc-nrfconnect-shared": "^191.0.0",
         "@playwright/test": "^1.16.3",
         "@testing-library/user-event": "^14.4.3",
         "@types/chmodr": "1.0.0",

package.json

@@ -4,8 +4,10 @@
  * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
  */
 
-import { NrfutilSandbox } from '@nordicsemiconductor/pc-nrfconnect-shared/nrfutil';
-import { resolveModuleVersion } from '@nordicsemiconductor/pc-nrfconnect-shared/nrfutil/moduleVersion';
+import {
+    getJlinkCompatibility,
+    prepareSandbox,
+} from '@nordicsemiconductor/pc-nrfconnect-shared/nrfutil';
 import { inspect } from 'util';
 
 import { LaunchableApp } from '../../ipc/apps';
@@ -30,13 +32,7 @@ const undecidedCheck = {
     isDecided: false,
 };
 
-jest.mock('@nordicsemiconductor/pc-nrfconnect-shared/nrfutil/sandbox', () => ({
-    __esModule: true,
-    default: () =>
-        Promise.resolve({
-            getModuleVersion: () => Promise.resolve([]),
-        } as unknown as NrfutilSandbox),
-}));
+jest.mock('@nordicsemiconductor/pc-nrfconnect-shared/nrfutil');
 
 jest.mock('@nordicsemiconductor/pc-nrfconnect-shared', () => ({
     ...jest.requireActual('@nordicsemiconductor/pc-nrfconnect-shared'),
@@ -109,65 +105,20 @@ describe('check compatibility of an app with the launcher', () => {
     describe('Check if the tested version of J-Link is installed', () => {
         const app = (nrfutilDeviceVersion: string) =>
             createDownloadableTestApp(undefined, {
-                // @ts-expect-error -- Needs to be added to Installed in shared as `nrfutil?: NrfutilModules;`
                 nrfutil: { device: [nrfutilDeviceVersion] },
             });
 
-        it(`No installed J-Link as reported before nrfutil-device 2.7`, async () => {
-            jest.mocked(resolveModuleVersion).mockReturnValue(undefined);
-
-            expect(
-                await checkJLinkRequirements(app('2.0.0'), '5.0.0')
-            ).toMatchObject(
-                failingCheck(
-                    'Required SEGGER J-Link not found: expected version V7.88j'
-                )
-            );
-        });
-
-        it(`No installed J-Link as reported since nrfutil-device 2.7`, async () => {
-            // @ts-expect-error -- The type for dependencies still needs to be updated in shared
-            jest.mocked(resolveModuleVersion).mockReturnValue({
-                expectedVersion: {
-                    versionFormat: 'string',
-                    version: 'JLink_V7.94i',
-                },
-                name: 'JlinkARM',
-            });
-
-            expect(
-                await checkJLinkRequirements(app('2.0.1'), '5.0.0')
-            ).toMatchObject(
-                failingCheck(
-                    'Required SEGGER J-Link not found: expected version V7.88j'
-                )
-            );
-        });
-
-        it(`Wrong JLink version`, async () => {
-            jest.mocked(resolveModuleVersion).mockReturnValue({
-                expectedVersion: {
-                    versionFormat: 'string',
-                    version: 'JLink_V7.94i',
-                },
-                name: 'JlinkARM',
-                versionFormat: 'string',
-                version: 'JLink_V7.94e',
+        it('Calls resolveModuleVersion exactly once per version of nrfutil-device', async () => {
+            jest.mocked(prepareSandbox).mockResolvedValue({
+                // @ts-expect-error -- I do not understand et how to fix this TypeScript error, but this is only a test, test ¯\_(ツ)_/¯
+                getModuleVersion: () => [],
             });
 
-            expect(
-                await checkJLinkRequirements(app('2.0.2'), '5.0.0')
-            ).toMatchObject(
-                failingCheck(
-                    'Untested version V7.94e of SEGGER J-Link found: expected at least version V7.94i'
-                )
-            );
-        });
-
-        it('Calls resolveModuleVersion exactly once per version of nrfutil-device', async () => {
             const mockedGetSandbox = jest
-                .mocked(resolveModuleVersion)
-                .mockReset();
+                .mocked(getJlinkCompatibility)
+                .mockClear()
+                // @ts-expect-error -- As above
+                .mockResolvedValue({});
 
             await checkJLinkRequirements(app('3.0.0'), '5.0.0');
             await checkJLinkRequirements(app('3.0.0'), '5.0.0');

src/launcher/util/appCompatibilityWarning.test.ts

@@ -9,9 +9,10 @@ import {
     getUserDataDir,
     launcherConfig,
 } from '@nordicsemiconductor/pc-nrfconnect-shared';
-import type { NrfutilModules } from '@nordicsemiconductor/pc-nrfconnect-shared/ipc/MetaFiles';
-import { resolveModuleVersion } from '@nordicsemiconductor/pc-nrfconnect-shared/nrfutil/moduleVersion';
-import getSandbox from '@nordicsemiconductor/pc-nrfconnect-shared/nrfutil/sandbox';
+import {
+    getJlinkCompatibility as getJlinkCompatibilityFromModuleVersion,
+    prepareSandbox,
+} from '@nordicsemiconductor/pc-nrfconnect-shared/nrfutil';
 import { memoize } from 'lodash';
 import semver from 'semver';
 
@@ -21,10 +22,6 @@ import {
     isWithdrawn,
     LaunchableApp,
 } from '../../ipc/apps';
-import {
-    existingIsOlderThanExpected,
-    strippedVersionName,
-} from './jlinkVersion';
 import Link from './Link';
 import minimalRequiredAppVersions from './minimalRequiredAppVersions';
 
@@ -169,36 +166,17 @@ const checkMinimalRequiredAppVersions: AppCompatibilityChecker = app => {
           );
 };
 
-const nrfutilDeviceToJLink = (device: string) => {
-    // According to https://docs.nordicsemi.com/bundle/nrfutil/page/guides/installing.html#prerequisites
-    if (semver.lt(device, '2.0.0')) {
-        return 'V7.80c';
-    }
-
-    if (semver.lt(device, '2.1.0')) {
-        return 'V7.88j';
-    }
-
-    if (semver.lt(device, '2.5.4')) {
-        return 'V7.94e';
-    }
-
-    return 'V7.94i';
-};
-
-const getJlinkVersionDependency = memoize(
-    async (nrfutilDeviceVersion: string) => {
-        const userDir = getUserDataDir();
-        const sandbox = await getSandbox(
-            userDir,
-            'device',
-            nrfutilDeviceVersion
-        );
-        const moduleVersion = await sandbox.getModuleVersion();
+const getJlinkCompatibility = memoize(async (nrfutilDeviceVersion: string) => {
+    const userDir = getUserDataDir();
+    const sandbox = await prepareSandbox(
+        userDir,
+        'device',
+        nrfutilDeviceVersion
+    );
+    const moduleVersion = await sandbox.getModuleVersion();
 
-        return resolveModuleVersion('JlinkARM', moduleVersion.dependencies);
-    }
-);
+    return getJlinkCompatibilityFromModuleVersion(moduleVersion);
+});
 
 export const checkJLinkRequirements: AppCompatibilityChecker = async (
     app: LaunchableApp
@@ -207,80 +185,67 @@ export const checkJLinkRequirements: AppCompatibilityChecker = async (
         return undecided;
     }
 
-    const deviceVersion =
-        // @ts-expect-error -- Needs to be added to Installed in shared as `nrfutil?: NrfutilModules;`. Then the typecast should also be removed.
-        (app.nrfutil as NrfutilModules | undefined)?.device?.at(0);
+    const deviceVersion = app.nrfutil?.device?.at(0);
 
     if (!deviceVersion) {
         return undecided;
     }
 
-    const jlinkVersionDependency = await getJlinkVersionDependency(
-        deviceVersion
-    );
-    const noJlinkInstalled = jlinkVersionDependency?.version == null;
-    if (noJlinkInstalled) {
-        const requiredVersion = nrfutilDeviceToJLink(deviceVersion);
+    const jlinkCompatibility = await getJlinkCompatibility(deviceVersion);
+
+    if (jlinkCompatibility.kind === 'No J-Link installed') {
+        const { requiredJlink } = jlinkCompatibility;
 
         return incompatible(
             'Missing dependency',
-            `Required SEGGER J-Link not found: expected version ${requiredVersion}`,
+            `Required SEGGER J-Link not found: expected version V${requiredJlink}`,
             <div className="tw-flex tw-flex-col tw-gap-2">
-                <div>This app requires SEGGER J-Link {requiredVersion}.</div>
+                <div>This app requires SEGGER J-Link V{requiredJlink}.</div>
                 <div>
                     <Link href="https://www.segger.com/downloads/jlink/">
                         Download
                     </Link>{' '}
                     and install the SEGGER J-Link Software and Documentation
-                    pack {requiredVersion}. Restart nRF Connect for Desktop
+                    pack V{requiredJlink}. Restart nRF Connect for Desktop
                     afterwards.
                 </div>
             </div>,
             {
                 warningKind: WarningKind.JLINK,
                 app: app.name,
                 nrfutilDevice: deviceVersion,
-                requiredJlink: requiredVersion,
-                actualJlink: 'none',
+                ...jlinkCompatibility,
             }
         );
     }
 
-    if (
-        jlinkVersionDependency.expectedVersion &&
-        existingIsOlderThanExpected(jlinkVersionDependency)
-    ) {
-        const expectedVersionNumber = strippedVersionName(
-            jlinkVersionDependency.expectedVersion
-        );
-        const actualVersionNumber = strippedVersionName(jlinkVersionDependency);
+    if (jlinkCompatibility.kind === 'Outdated J-Link') {
+        const { actualJlink, requiredJlink } = jlinkCompatibility;
 
         return incompatible(
             'Outdated dependency',
-            `Untested version V${actualVersionNumber} of SEGGER J-Link found: ` +
-                `expected at least version V${expectedVersionNumber}`,
+            `Untested version V${actualJlink} of SEGGER J-Link found: ` +
+                `expected at least version V${requiredJlink}`,
             <div className="tw-flex tw-flex-col tw-gap-2">
                 <div>
-                    This app was tested with SEGGER J-Link V
-                    {expectedVersionNumber} but version V{actualVersionNumber}{' '}
-                    was found on your system.
+                    This app was tested with SEGGER J-Link V{requiredJlink} but
+                    version V{actualJlink} was found on your system.
                 </div>
                 <div>This app might not work as expected!</div>
                 <div>
                     <Link href="https://www.segger.com/downloads/jlink/">
                         Download
                     </Link>{' '}
                     and install the SEGGER J-Link Software and Documentation
-                    pack V{expectedVersionNumber}. Restart nRF Connect for
-                    Desktop afterwards.
+                    pack V{requiredJlink}. Restart nRF Connect for Desktop
+                    afterwards.
                 </div>
             </div>,
             {
                 warningKind: WarningKind.JLINK,
                 app: app.name,
                 nrfutilDevice: deviceVersion,
-                requiredJlink: jlinkVersionDependency.expectedVersion.version,
-                actualJlink: jlinkVersionDependency.version,
+                ...jlinkCompatibility,
             }
         );
     }