@nordicsemiconductor/pc-nrfconnect-shared 122.0.0 → 123.0.0

package/ipc/launcherConfig.ts

@@ -0,0 +1,25 @@
+/*
+ * Copyright (c) 2023 Nordic Semiconductor ASA
+ *
+ * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
+ */
+
+import { ipcMain, ipcRenderer } from 'electron';
+
+export interface Configuration {
+    isRunningLauncherFromSource: boolean;
+    isSkipUpdateApps: boolean;
+    isSkipUpdateLauncher: boolean;
+    launcherVersion: string;
+    userDataDir: string;
+}
+const channel = 'get-config';
+
+const getConfig = (): Configuration => ipcRenderer.sendSync(channel);
+const registerGetConfig = (config: Configuration) =>
+    ipcMain.on(channel, event => {
+        event.returnValue = config;
+    });
+
+export const forRenderer = { registerGetConfig };
+export const inMain = { getConfig };

package/ipc/openWindow.ts

@@ -12,8 +12,24 @@ const channel = {
     launcher: 'open-app-launcher', // It would be nice to call this `open:launcher` but we have to stick to the current name, because that is used by supported apps.
 };
 
+export const isOpenAppOptionsDeviceSN = (
+    device: OpenAppOptionsDevice
+): device is OpenAppOptionsDeviceSN =>
+    (device as OpenAppOptionsDeviceSN).serialNumber !== undefined;
+
+export const isOpenAppOptionsDevicePort = (
+    device: OpenAppOptionsDevice
+): device is OpenAppOptionsDevicePort =>
+    (device as OpenAppOptionsDevicePort).serialPortPath !== undefined;
+
+type OpenAppOptionsDeviceSN = { serialNumber: string };
+
+type OpenAppOptionsDevicePort = { serialPortPath: string };
+
+type OpenAppOptionsDevice = OpenAppOptionsDeviceSN | OpenAppOptionsDevicePort;
+
 export interface OpenAppOptions {
-    device?: { serialNumber: string; serialPortPath?: string };
+    device?: OpenAppOptionsDevice;
 }
 
 type OpenApp = (app: AppSpec, openAppOptions?: OpenAppOptions) => void;

package/ipc/schema/packageJson.ts

@@ -10,6 +10,20 @@ import { knownDevicePcas } from '../device';
 import { nrfModules, semver } from '../MetaFiles';
 import { parseWithPrettifiedErrorMessage } from './parseJson';
 
+const packageJson = z.object({
+    name: z.string(),
+    version: semver,
+
+    displayName: z.string().optional(),
+});
+
+export type PackageJson = z.infer<typeof packageJson>;
+
+export const parsePackageJson =
+    parseWithPrettifiedErrorMessage<PackageJson>(packageJson);
+
+// Apps have more required fields in their package.json
+
 const nrfConnectForDesktop = z.object({
     supportedDevices: z.enum(knownDevicePcas).array().nonempty().optional(),
     nrfutil: nrfModules.optional(),
@@ -22,12 +36,7 @@ const engines = recordOfOptionalStrings.and(
     z.object({ nrfconnect: z.string() })
 );
 
-const packageJson = z.object({
-    name: z.string(),
-    version: semver,
-
-    author: z.string().optional(),
-    bin: z.string().or(recordOfOptionalStrings).optional(),
+const packageJsonApp = packageJson.extend({
     dependencies: recordOfOptionalStrings.optional(),
     description: z.string(),
     homepage: z.string().url().optional(),
@@ -36,8 +45,6 @@ const packageJson = z.object({
     engines,
     nrfConnectForDesktop,
     files: z.string().array().optional(),
-    license: z.string().optional(),
-    main: z.string().optional(),
     peerDependencies: recordOfOptionalStrings.optional(),
     repository: z
         .object({
@@ -45,25 +52,22 @@ const packageJson = z.object({
             url: z.string().url(),
         })
         .optional(),
-    scripts: recordOfOptionalStrings.optional(),
 });
 
-export type PackageJson = z.infer<typeof packageJson>;
+export type PackageJsonApp = z.infer<typeof packageJsonApp>;
 
-export const parsePackageJson =
-    parseWithPrettifiedErrorMessage<PackageJson>(packageJson);
+export const parsePackageJsonApp =
+    parseWithPrettifiedErrorMessage<PackageJsonApp>(packageJsonApp);
 
 // In the launcher we want to handle that the whole nrfConnectForDesktop may be missing
 // and the html in it can also be undefined, so there we need to use this legacy variant
-const legacyPackageJson = packageJson.merge(
-    z.object({
-        nrfConnectForDesktop: nrfConnectForDesktop
-            .partial({ html: true })
-            .optional(),
-    })
-);
+const packageJsonLegacyApp = packageJsonApp.extend({
+    nrfConnectForDesktop: nrfConnectForDesktop
+        .partial({ html: true })
+        .optional(),
+});
 
-export type LegacyPackageJson = z.infer<typeof legacyPackageJson>;
+export type PackageJsonLegacyApp = z.infer<typeof packageJsonLegacyApp>;
 
-export const parseLegacyPackageJson =
-    parseWithPrettifiedErrorMessage<LegacyPackageJson>(legacyPackageJson);
+export const parsePackageJsonLegacyApp =
+    parseWithPrettifiedErrorMessage<PackageJsonLegacyApp>(packageJsonLegacyApp);

package/main/index.ts

@@ -6,6 +6,7 @@
 
 import { forRenderer as forRendererAppDetails } from '../ipc/appDetails';
 import { forRenderer as forRendererApps } from '../ipc/apps';
+import { forRenderer as forRendererLauncherConfig } from '../ipc/launcherConfig';
 import { forRenderer as forRendererOpenWindow } from '../ipc/openWindow';
 import { forRenderer as forRendererPreventSleep } from '../ipc/preventSleep';
 import { forRenderer as forRendererSafeStorage } from '../ipc/safeStorage';
@@ -18,6 +19,7 @@ export { registerLauncherWindowFromMain } from '../ipc/infrastructure/mainToRend
 
 export const appDetails = { forRenderer: forRendererAppDetails };
 export const apps = { forRenderer: forRendererApps };
+export const launcherConfig = { forRenderer: forRendererLauncherConfig };
 export const openWindow = { forRenderer: forRendererOpenWindow };
 export const preventSleep = { forRenderer: forRendererPreventSleep };
 export const safeStorage = {
@@ -37,11 +39,15 @@ export {
     type WithdrawnJson,
 } from '../ipc/MetaFiles';
 export {
-    type LegacyPackageJson,
-    type PackageJson,
-    parseLegacyPackageJson,
-    parsePackageJson,
+    type PackageJsonLegacyApp,
+    type PackageJsonApp,
+    parsePackageJsonLegacyApp,
+    parsePackageJsonApp,
 } from '../ipc/schema/packageJson';
 
 export { type OverwriteOptions } from '../ipc/serialPort';
-export { type OpenAppOptions } from '../ipc/openWindow';
+export type { OpenAppOptions } from '../ipc/openWindow';
+export {
+    isOpenAppOptionsDevicePort,
+    isOpenAppOptionsDeviceSN,
+} from '../ipc/openWindow';

package/mocks/packageJsonMock.ts

@@ -4,7 +4,7 @@
  * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
  */
 
-export default () => ({
+export const packageJson = () => ({
     name: 'mocked-test-app',
     version: '27.6.72',
 });

package/nrfutil/device/batch.ts

@@ -55,13 +55,7 @@ export class Batch {
                 await box.singleInfoOperationOptionalData<object>(
                     command,
                     undefined,
-                    [
-                        '--serial-number', // this is a workaround this param should now be needed with --generate
-                        '123',
-                        '--generate',
-                        '--core',
-                        core,
-                    ].concat(args)
+                    ['--generate', '--core', core].concat(args)
                 );
 
             return {

package/nrfutil/device/common.ts

@@ -50,7 +50,7 @@ export interface NordicDevKit {
 export interface NrfutilDevice {
     id: number;
     devkit?: NordicDevKit;
-    serialNumber?: string; // undefined in case udev is not installed
+    serialNumber?: string | null; // undefined in case udev is not installed
     traits: DeviceTraits;
     usb?: USB;
     // non-Nordic devices may not have serialPorts property at all
@@ -172,26 +172,33 @@ export const getDeviceSandbox = async () => {
         );
         deviceSandbox = await promiseDeviceSandbox;
 
-        deviceSandbox.onLogging(evt => {
+        deviceSandbox.onLogging((evt, pid) => {
             const deviceLogger = getNrfutilLogger();
+            const formatMsg = (msg: string) =>
+                `${
+                    pid && deviceSandbox?.logLevel === 'trace'
+                        ? `[PID:${pid}] `
+                        : ''
+                }${msg}`;
+
             switch (evt.level) {
                 case 'TRACE':
-                    deviceLogger?.verbose(evt.message);
+                    deviceLogger?.verbose(formatMsg(evt.message));
                     break;
                 case 'DEBUG':
-                    deviceLogger?.debug(evt.message);
+                    deviceLogger?.debug(formatMsg(evt.message));
                     break;
                 case 'INFO':
-                    deviceLogger?.info(evt.message);
+                    deviceLogger?.info(formatMsg(evt.message));
                     break;
                 case 'WARN':
-                    deviceLogger?.warn(evt.message);
+                    deviceLogger?.warn(formatMsg(evt.message));
                     break;
                 case 'ERROR':
-                    deviceLogger?.error(evt.message);
+                    deviceLogger?.error(formatMsg(evt.message));
                     break;
                 case 'CRITICAL':
-                    deviceLogger?.error(evt.message);
+                    deviceLogger?.error(formatMsg(evt.message));
                     break;
                 case 'OFF':
                 default:

package/nrfutil/device/list.ts

@@ -31,7 +31,7 @@ const isHotplugEvent = (
 export default async (
     traits: DeviceTraits,
     onEnumerated: (devices: NrfutilDevice[]) => void,
-    onError: (error: Error) => void,
+    onError: (error: Error, pid?: number) => void,
     onHotplugEvent?: {
         onDeviceArrived: (device: NrfutilDevice) => void;
         onDeviceLeft: (id: number) => void;

package/nrfutil/moduleVersion.ts

@@ -4,7 +4,7 @@
  * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
  */
 
-import packageJson from '../src/utils/packageJson';
+import { packageJsonApp } from '../src/utils/packageJson';
 import {
     Dependency,
     isIncrementalVersion,
@@ -89,7 +89,7 @@ const overriddenVersion = (module: string) => {
 };
 
 const versionFromPackageJson = (module: string) =>
-    packageJson().nrfConnectForDesktop.nrfutil?.[module][0];
+    packageJsonApp().nrfConnectForDesktop.nrfutil?.[module][0];
 
 const failToDetermineVersion = (module: string) => {
     throw new Error(`No version specified for nrfutil-${module}`);

package/nrfutil/sandbox.ts

@@ -10,6 +10,7 @@ import os from 'os';
 import path from 'path';
 
 import describeError from '../src/logging/describeError';
+import usageData from '../src/utils/usageData';
 import { versionToInstall } from './moduleVersion';
 import { getNrfutilLogger } from './nrfutilLogger';
 import {
@@ -67,8 +68,9 @@ const commonParser = <Result>(
         onInfo?: (info: Result) => void;
         onTaskBegin?: (taskEnd: TaskBegin) => void;
         onTaskEnd?: (taskEnd: TaskEnd<Result>) => void;
-        onLogging?: (logging: LogMessage) => void;
-    }
+        onLogging?: (logging: LogMessage, pid?: number) => void;
+    },
+    pid?: number
 ): Buffer | undefined => {
     const parsedData: NrfutilJson<Result>[] | undefined =
         parseJsonBuffers(data);
@@ -95,7 +97,7 @@ const commonParser = <Result>(
                 callbacks.onInfo?.(item.data);
                 break;
             case 'log':
-                callbacks.onLogging?.(item.data);
+                callbacks.onLogging?.(item.data, pid);
                 break;
             case 'batch_update':
                 processItem(item.data.data);
@@ -110,7 +112,7 @@ export class NrfutilSandbox {
     baseDir: string;
     module: string;
     version: string;
-    onLoggingHandlers: ((logging: LogMessage) => void)[] = [];
+    onLoggingHandlers: ((logging: LogMessage, pid?: number) => void)[] = [];
     logLevel: LogLevel = 'info';
     env: ReturnType<typeof prepareEnv>;
 
@@ -122,9 +124,11 @@ export class NrfutilSandbox {
         this.env = prepareEnv(baseDir, module, version);
     }
 
-    private processLoggingData = (data: NrfutilJson) => {
+    private processLoggingData = (data: NrfutilJson, pid?: number) => {
         if (data.type === 'log') {
-            this.onLoggingHandlers.forEach(onLogging => onLogging(data.data));
+            this.onLoggingHandlers.forEach(onLogging =>
+                onLogging(data.data, pid)
+            );
             return true;
         }
 
@@ -200,28 +204,35 @@ export class NrfutilSandbox {
         const info: Result[] = [];
         const taskEnd: TaskEnd<Result>[] = [];
         let stdErr: string | undefined;
+        let pid: number | undefined;
+
         try {
             await this.execCommand(
                 command,
                 args,
-                data =>
-                    commonParser<Result>(data, {
-                        onProgress,
-                        onTaskBegin,
-                        onTaskEnd: end => {
-                            taskEnd.push(end);
-                            onTaskEnd?.(end);
-                        },
-                        onInfo: i => {
-                            info.push(i);
+                (data, processId) =>
+                    commonParser<Result>(
+                        data,
+                        {
+                            onProgress,
+                            onTaskBegin,
+                            onTaskEnd: end => {
+                                taskEnd.push(end);
+                                onTaskEnd?.(end);
+                            },
+                            onInfo: i => {
+                                info.push(i);
+                            },
+                            onLogging: logging => {
+                                this.onLoggingHandlers.forEach(onLogging => {
+                                    onLogging(logging, processId);
+                                });
+                            },
                         },
-                        onLogging: logging => {
-                            this.onLoggingHandlers.forEach(onLogging => {
-                                onLogging(logging);
-                            });
-                        },
-                    }),
-                data => {
+                        processId
+                    ),
+                (data, processId) => {
+                    pid = processId;
                     stdErr = (stdErr ?? '') + data.toString();
                 },
                 controller
@@ -256,6 +267,11 @@ export class NrfutilSandbox {
             }
 
             error.message = error.message.replaceAll('Error: ', '');
+            usageData.sendErrorReport(
+                `${
+                    pid && this.logLevel === 'trace' ? `[PID:${pid}] ` : ''
+                }${describeError(error)}`
+            );
             throw error;
         }
     };
@@ -280,12 +296,13 @@ export class NrfutilSandbox {
     private execCommand = (
         command: string,
         args: string[],
-        parser: (data: Buffer) => Buffer | undefined,
-        onStdError: (data: Buffer) => void,
+        parser: (data: Buffer, pid?: number) => Buffer | undefined,
+        onStdError: (data: Buffer, pid?: number) => void,
         controller?: AbortController
     ) =>
         new Promise<void>((resolve, reject) => {
             let aborting = false;
+            usageData.sendUsageData(`running nrfutil ${command}`, { args });
             const nrfutil = spawn(
                 path.join(this.baseDir, 'nrfutil'),
                 [
@@ -319,7 +336,7 @@ export class NrfutilSandbox {
                 if (controller?.signal.aborted) return;
 
                 buffer = Buffer.concat([buffer, data]);
-                const remainingBytes = parser(buffer);
+                const remainingBytes = parser(buffer, nrfutil.pid);
                 if (remainingBytes) {
                     buffer = remainingBytes;
                 } else {
@@ -328,7 +345,7 @@ export class NrfutilSandbox {
             });
 
             nrfutil.stderr.on('data', (data: Buffer) => {
-                onStdError(data);
+                onStdError(data, nrfutil.pid);
             });
 
             nrfutil.on('close', code => {
@@ -364,7 +381,7 @@ export class NrfutilSandbox {
         const operation = this.execCommand(
             this.module,
             [command, ...args],
-            data => {
+            (data, pid) => {
                 const parsedData: NrfutilJson<Result>[] | undefined =
                     parseJsonBuffers(data);
 
@@ -373,15 +390,15 @@ export class NrfutilSandbox {
                 }
 
                 parsedData.forEach(item => {
-                    if (!this.processLoggingData(item)) {
+                    if (!this.processLoggingData(item, pid)) {
                         if (item.type === 'info') {
                             processors.onData(item.data);
                         }
                     }
                 });
             },
-            data => {
-                processors.onError(new Error(data.toString()));
+            (data, pid) => {
+                processors.onError(new Error(data.toString()), pid);
             },
             controller
         );
@@ -392,6 +409,7 @@ export class NrfutilSandbox {
                 closedHandlers.forEach(callback => callback());
             })
             .catch(error => {
+                usageData.sendErrorReport(describeError(error));
                 running = false;
                 closedHandlers.forEach(callback => callback(error));
             });
@@ -471,7 +489,9 @@ export class NrfutilSandbox {
         throw new Error('Unexpected result');
     };
 
-    public onLogging = (handler: (logging: LogMessage) => void) => {
+    public onLogging = (
+        handler: (logging: LogMessage, pid?: number) => void
+    ) => {
         this.onLoggingHandlers.push(handler);
 
         return () =>

package/nrfutil/sandboxTypes.ts

@@ -5,7 +5,7 @@
  */
 
 export interface BackgroundTask<T> {
-    onError: (error: Error) => void;
+    onError: (error: Error, pid?: number) => void;
     onData: (data: T) => void;
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@nordicsemiconductor/pc-nrfconnect-shared",
-    "version": "122.0.0",
+    "version": "123.0.0",
     "description": "Shared commodities for developing pc-nrfconnect-* packages",
     "repository": {
         "type": "git",
@@ -33,7 +33,7 @@
         "@mdi/font": "7.2.96",
         "@mdi/js": "^7.2.96",
         "@mdi/react": "^1.6.1",
-        "@microsoft/applicationinsights-web": "^3.0.2",
+        "@microsoft/applicationinsights-web": "^3.0.4",
         "@reduxjs/toolkit": "1.9.3",
         "@svgr/core": "^7.0.0",
         "@svgr/plugin-jsx": "7.0.0",
@@ -57,6 +57,7 @@
         "@typescript-eslint/eslint-plugin": "5.57.1",
         "@typescript-eslint/parser": "5.57.1",
         "adm-zip": "^0.5.5",
+        "applicationinsights": "^2.9.0",
         "autoprefixer": "10.4.14",
         "bootstrap": "4.6.2",
         "commander": "10.0.0",

package/scripts/check-app-properties.ts

@@ -10,7 +10,7 @@ import { execSync } from 'child_process';
 import { existsSync, readdirSync, readFileSync } from 'fs';
 import property from 'lodash/property';
 
-import { PackageJson, parsePackageJson } from '../ipc/schema/packageJson';
+import { PackageJsonApp, parsePackageJsonApp } from '../ipc/schema/packageJson';
 
 const format = (strings: string[]) =>
     strings.map(string => `\`${string}\``).join(', ');
@@ -61,7 +61,7 @@ const mustContainOneOf = (
     }
 };
 
-const checkRepoUrl = (packageJson: PackageJson) => {
+const checkRepoUrl = (packageJson: PackageJsonApp) => {
     if (!existsSync('./.git')) {
         return;
     }
@@ -88,7 +88,7 @@ const checkRepoUrl = (packageJson: PackageJson) => {
     }
 };
 
-const checkOptionalProperties = (packageJson: PackageJson) => {
+const checkOptionalProperties = (packageJson: PackageJsonApp) => {
     if (propertyIsMissing(packageJson)('homepage')) {
         warn('Please provide a property `homepage` in package.json.');
     }
@@ -100,7 +100,7 @@ const checkOptionalProperties = (packageJson: PackageJson) => {
     }
 };
 
-const checkFileProperty = (packageJson: PackageJson) => {
+const checkFileProperty = (packageJson: PackageJsonApp) => {
     mustContain(
         packageJson.files ?? [],
         ['LICENSE', 'dist/', 'Changelog.md'],
@@ -115,7 +115,7 @@ const checkFileProperty = (packageJson: PackageJson) => {
 };
 
 const readAndCheckPackageJson = () => {
-    const packageJsonResult = parsePackageJson(
+    const packageJsonResult = parsePackageJsonApp(
         readFileSync('./package.json', 'utf8')
     );
 
@@ -136,7 +136,7 @@ const changelogEntryRegexp = (version?: string) =>
     new RegExp(`^## ${version}`, 'mi');
 
 const checkChangelog = (
-    packageJson: PackageJson,
+    packageJson: PackageJsonApp,
     checkChangelogHasCurrentEntry: boolean
 ) => {
     if (!existsSync('./Changelog.md')) {

package/scripts/esbuild.ts

@@ -8,11 +8,11 @@
 import * as fs from 'node:fs';
 import * as path from 'node:path';
 
-import { parsePackageJson } from '../ipc/schema/packageJson';
+import { parsePackageJsonApp } from '../ipc/schema/packageJson';
 import { build } from './esbuild-renderer';
 
 const validate = (packageJson: string) => {
-    const result = parsePackageJson(packageJson);
+    const result = parsePackageJsonApp(packageJson);
 
     if (!result.success) {
         console.log(result.error.message);
@@ -42,7 +42,7 @@ const bundle = () => {
 
     build({
         define: {
-            'process.env.PACKAGE_JSON_OF_APP': JSON.stringify(packageJson),
+            'process.env.PACKAGE_JSON': JSON.stringify(packageJson),
         },
         entryPoints: [entry()],
     });