@nordicsemiconductor/pc-nrfconnect-shared 122.0.0 → 124.0.0

package/scripts/nordic-publish.ts

@@ -14,7 +14,7 @@ import semver from 'semver';
 import calculateShasum from 'shasum';
 
 import { AppInfo, SourceJson } from '../ipc/MetaFiles';
-import { PackageJson } from '../ipc/schema/packageJson';
+import { PackageJsonApp } from '../ipc/schema/packageJson';
 import checkAppProperties from './check-app-properties';
 
 interface LegacyAppInfo {
@@ -41,7 +41,7 @@ interface App {
     releaseNotesFilename: string;
     iconFilename: string;
     isOfficial: boolean;
-    packageJson: PackageJson;
+    packageJson: PackageJsonApp;
 }
 
 const client = new FtpClient();
@@ -113,7 +113,7 @@ const parseOptions = (): Options => {
     };
 };
 
-const readPackageJson = (): PackageJson =>
+const readPackageJson = (): PackageJsonApp =>
     JSON.parse(fs.readFileSync('./package.json', 'utf-8'));
 
 const packPackage = () => {

package/scripts/release-shared.ts

@@ -25,7 +25,7 @@
 */
 import { execSync, spawnSync } from 'node:child_process';
 
-import { PackageJson } from '../ipc/schema/packageJson';
+import { PackageJsonApp } from '../ipc/schema/packageJson';
 
 const logError = (message: string) => {
     console.error(message);
@@ -88,7 +88,7 @@ export const packageJsonIsCorrect = (
     }
 ) => {
     const expectedVersionString = `${expectedVersionNumber}.0.0`;
-    const actualVersionString = parseJson<PackageJson>(packageJson).version;
+    const actualVersionString = parseJson<PackageJsonApp>(packageJson).version;
 
     return equality(
         expectedVersionString,

package/src/About/ApplicationCard.tsx

@@ -6,12 +6,10 @@
 
 import React, { useEffect, useState } from 'react';
 
-import {
-    AppDetailsFromLauncher,
-    inMain as appDetails,
-} from '../../ipc/appDetails';
+import { AppDetailsFromLauncher } from '../../ipc/appDetails';
 import Card from '../Card/Card';
 import FactoryResetButton from '../FactoryReset/FactoryResetButton';
+import appDetails from '../utils/appDetails';
 import AboutButton from './AboutButton';
 import Section from './Section';
 import ShortcutButton from './ShortcutButton';
@@ -20,7 +18,7 @@ export default () => {
     const [appInfo, setAppInfo] = useState<AppDetailsFromLauncher>();
 
     useEffect(() => {
-        appDetails.getAppDetails().then(setAppInfo);
+        appDetails().then(setAppInfo);
     }, [setAppInfo]);
 
     if (appInfo == null) return null;

package/src/App/App.test.tsx

@@ -7,6 +7,7 @@
 import React from 'react';
 import { screen } from '@testing-library/react';
 
+import packageJsonFromShared from '../../package.json';
 import render from '../../test/testrenderer';
 import App, { Pane } from './App';
 
@@ -17,6 +18,12 @@ jest.mock('../Log/LogViewer', () => ({
 
 jest.mock('../logging/index.ts', () => ({
     initialise: () => {},
+    debug: () => {},
+}));
+
+jest.mock('../utils/packageJson', () => ({
+    isLauncher: () => false,
+    packageJson: () => packageJsonFromShared,
 }));
 
 const renderApp = (panes: Pane[]) => {

package/src/App/App.tsx

@@ -30,9 +30,8 @@ import LogViewer from '../Log/LogViewer';
 import logger from '../logging';
 import NavBar from '../NavBar/NavBar';
 import classNames from '../utils/classNames';
-import packageJson from '../utils/packageJson';
 import { getPersistedCurrentPane } from '../utils/persistentStore';
-import { init as usageDataInit, setUsageLogger } from '../utils/usageData';
+import usageData from '../utils/usageData';
 import useHotKey from '../utils/useHotKey';
 import {
     currentPane as currentPaneSelector,
@@ -49,19 +48,6 @@ import './app.scss';
 import './shared.scss';
 import './tailwind.css';
 
-let usageDataAlreadyInitialised = false;
-const initialiseUsageData = () => {
-    if (!usageDataAlreadyInitialised) {
-        usageDataAlreadyInitialised = true;
-        try {
-            usageDataInit(packageJson());
-        } catch (error) {
-            // No need to display the error message for the user
-            console.log(error);
-        }
-    }
-};
-
 export interface PaneProps {
     active: boolean;
 }
@@ -77,7 +63,6 @@ interface ConnectedAppProps {
     panes: Pane[];
     sidePanel?: ReactNode;
     showLogByDefault?: boolean;
-    reportUsageData?: boolean;
     documentation?: ReactNode[];
     feedback?: boolean | FeedbackPaneProps;
     children?: ReactNode;
@@ -89,25 +74,25 @@ const ConnectedApp: FC<ConnectedAppProps> = ({
     panes,
     sidePanel,
     showLogByDefault = true,
-    reportUsageData = false,
     documentation,
     feedback,
     children,
     autoReselectByDefault = false,
 }) => {
-    const initialisedLogger = useRef(false);
+    const initApp = useRef(false);
 
-    if (!initialisedLogger.current) {
+    if (!initApp.current) {
         logger.initialise();
         setNrfutilLogger(logger);
-        setUsageLogger(logger);
-        initialisedLogger.current = true;
+        usageData.setLogger(logger);
+        initApp.current = true;
     }
 
     usePersistedPane();
     const isLogVisible = useSelector(isLogVisibleSelector);
     const currentPane = useSelector(currentPaneSelector);
     const allPanes = useAllPanes(panes, documentation, feedback);
+    const paneName = useRef(allPanes.map(({ name }) => name));
     const dispatch = useDispatch();
 
     useHotKey({
@@ -117,6 +102,14 @@ const ConnectedApp: FC<ConnectedAppProps> = ({
         action: openWindow.openLauncher,
     });
 
+    useEffect(() => {
+        paneName.current = allPanes.map(({ name }) => name);
+    }, [allPanes]);
+
+    useEffect(() => {
+        usageData.sendPageView(paneName.current[currentPane]);
+    }, [currentPane]);
+
     useEffect(() => {
         dispatch(setAutoReselect(autoReselectByDefault));
     }, [dispatch, autoReselectByDefault]);
@@ -134,12 +127,6 @@ const ConnectedApp: FC<ConnectedAppProps> = ({
     const isSidePanelVisible =
         useSelector(isSidePanelVisibleSelector) && currentSidePanel;
 
-    useEffect(() => {
-        if (reportUsageData) {
-            initialiseUsageData();
-        }
-    }, [reportUsageData]);
-
     return (
         <div className="core19-app">
             <NavBar deviceSelect={deviceSelect} />

package/src/Device/DeviceSelector/DeviceList/MoreDeviceInfo.tsx

@@ -44,7 +44,7 @@ const MaybeDeviceName = ({ device }: { device: Device }) => {
 const Serialports = ({ ports }: { ports: SerialPort[] }) =>
     ports.length > 0 ? (
         <Row>
-            <ul className="tw-text-center tw-underline">
+            <ul className="tw-underline">
                 {ports.map(port => (
                     <li key={port.path}>{port.comName}</li>
                 ))}

package/src/Device/DeviceSelector/DeviceSelector.tsx

@@ -10,6 +10,8 @@ import { useDispatch, useSelector } from 'react-redux';
 import { NrfutilDeviceLib } from '../../../nrfutil';
 import { DeviceTraits } from '../../../nrfutil/device/common';
 import logger from '../../logging';
+import usageData from '../../utils/usageData';
+import { simplifyDeviceForLogging } from '../../utils/usageDataCommon';
 import useHotKey from '../../utils/useHotKey';
 import {
     clearWaitForDevice,
@@ -23,6 +25,7 @@ import {
     deselectDevice,
     Device,
     deviceIsSelected as deviceIsSelectedSelector,
+    isDeviceWithSerialNumber,
     selectDevice,
     selectedDevice,
     setSelectedDeviceInfo,
@@ -61,12 +64,22 @@ export default ({
     const waitingToAutoReconnect = useSelector(getWaitingToAutoReselect);
     const showSelectedDevice = deviceIsSelected || waitingToAutoReconnect;
 
-    const doDeselectDevice = useCallback(() => {
-        dispatch(clearWaitForDevice());
-        dispatch(setAutoSelectDevice(undefined));
-        onDeviceDeselected();
-        dispatch(deselectDevice());
-    }, [dispatch, onDeviceDeselected]);
+    const doDeselectDevice = useCallback(
+        (device?: Device) => {
+            if (device) {
+                usageData.sendUsageData(
+                    'device deselected ',
+                    simplifyDeviceForLogging(device)
+                );
+            }
+
+            dispatch(clearWaitForDevice());
+            dispatch(setAutoSelectDevice(undefined));
+            onDeviceDeselected();
+            dispatch(deselectDevice());
+        },
+        [dispatch, onDeviceDeselected]
+    );
 
     const abortController = useRef<AbortController>();
 
@@ -92,8 +105,13 @@ export default ({
             abortController.current = undefined;
             setSelectedDeviceInfo(deviceInfo);
 
+            usageData.sendUsageData('device selected', {
+                device: simplifyDeviceForLogging(device),
+                deviceInfo,
+            });
+
             if (deviceSetupConfig) {
-                if (device.serialNumber) {
+                if (isDeviceWithSerialNumber(device)) {
                     dispatch(
                         setupDevice(
                             device,
@@ -158,7 +176,7 @@ export default ({
         <div className="core19-device-selector">
             {showSelectedDevice ? (
                 <SelectedDevice
-                    doDeselectDevice={doDeselectDevice}
+                    doDeselectDevice={() => doDeselectDevice(currentDevice)}
                     toggleDeviceListVisible={toggleDeviceListVisible}
                 />
             ) : (
@@ -176,7 +194,7 @@ export default ({
                     }
 
                     if (deviceIsSelected) {
-                        doDeselectDevice();
+                        doDeselectDevice(currentDevice);
                     }
 
                     doSelectDevice(device, autoReselected);

package/src/Device/deviceLister.ts

@@ -8,6 +8,8 @@ import { DeviceTraits, NrfutilDevice } from '../../nrfutil/device/common';
 import NrfutilDeviceLib from '../../nrfutil/device/device';
 import logger from '../logging';
 import type { AppThunk, RootState } from '../store';
+import usageData from '../utils/usageData';
+import { simplifyDeviceForLogging } from '../utils/usageDataCommon';
 import {
     clearWaitForDevice,
     clearWaitForDeviceTimeout,
@@ -22,7 +24,6 @@ import { closeDeviceSetupDialog } from './deviceSetupSlice';
 import {
     addDevice,
     Device,
-    getDevice,
     removeDevice,
     selectDevice,
     setSelectedDeviceInfo,
@@ -164,10 +165,16 @@ export const startWatchingDevices =
     (dispatch, getState) => {
         const onDeviceArrived = async (device: NrfutilDevice) => {
             if (hasValidDeviceTraits(device.traits, deviceListing)) {
+                usageData.sendUsageData(
+                    'device connected',
+                    simplifyDeviceForLogging(device)
+                );
                 if (
-                    device.serialNumber &&
                     !getState().device.devices.find(
-                        d => d.serialNumber === device.serialNumber
+                        d =>
+                            d.id === device.id ||
+                            (device.serialNumber && // we want to disregard comparing devices with no sn
+                                d.serialNumber === device.serialNumber)
                     )
                 ) {
                     onDeviceConnected(device);
@@ -294,7 +301,7 @@ export const startWatchingDevices =
                     const waitForDevice =
                         getState().deviceAutoSelect.waitForDevice;
                     if (
-                        device.serialNumber &&
+                        device.serialNumber && // we want to disregard comparing devices with no sn
                         device.serialNumber ===
                             getState().deviceAutoSelect.device?.serialNumber
                     ) {
@@ -341,7 +348,10 @@ export const startWatchingDevices =
         stopWatchingDevices(async () => {
             const operation = await NrfutilDeviceLib.list(
                 deviceListing,
-                d => d.forEach(onDeviceArrived),
+                d => {
+                    d.forEach(onDeviceArrived);
+                    dispatch(autoSelectDeviceCLI(doSelectDevice));
+                },
                 error => {
                     logger.error(error);
                 },
@@ -353,30 +363,63 @@ export const startWatchingDevices =
                     callback?.();
                 });
             };
-
-            if (!autoSelectDeviceCLISerialUsed) {
-                const autoSelectSN = getAutoSelectDeviceCLISerial();
-
-                if (autoSelectSN !== undefined) {
-                    const autoSelectDevice = getDevice(
-                        getState(),
-                        autoSelectSN
-                    );
-
-                    if (autoSelectDevice)
-                        doSelectDevice(autoSelectDevice, true);
-                }
-                autoSelectDeviceCLISerialUsed = true;
-            }
         });
     };
 
-const getAutoSelectDeviceCLISerial = () => {
+const getAutoSelectDeviceCLIProperty = (
+    property: string,
+    findDevice: (value: string) => Device | undefined
+) => {
     const { argv } = process;
-    const serialIndex = argv.findIndex(arg => arg === '--deviceSerial');
-    return serialIndex > -1 ? argv[serialIndex + 1] : undefined;
+    const index = argv.findIndex(arg => arg === property);
+    return index > -1
+        ? { index, device: findDevice(argv[index + 1]) }
+        : undefined;
+};
+
+const getAutoSelectDevice = (devices: Device[]) => {
+    const serialNumber = getAutoSelectDeviceCLIProperty('--deviceSerial', sn =>
+        devices.find(device => device.serialNumber === sn)
+    );
+    const serialPort = getAutoSelectDeviceCLIProperty('--comPort', portPath =>
+        devices.find(device =>
+            device.serialPorts?.find(port => port.comName === portPath)
+        )
+    );
+
+    if (serialNumber && serialPort) {
+        if (serialNumber.index > serialPort.index) {
+            return serialPort.device;
+        }
+
+        return serialNumber.device;
+    }
+
+    if (serialNumber) {
+        return serialNumber.device;
+    }
+
+    if (serialPort) {
+        return serialPort.device;
+    }
 };
 
+const autoSelectDeviceCLI =
+    (
+        doSelectDevice: (device: Device, autoReselected: boolean) => void
+    ): AppThunk<RootState> =>
+    (_, getState) => {
+        if (!autoSelectDeviceCLISerialUsed) {
+            const autoSelectDevice = getAutoSelectDevice(
+                getState().device.devices
+            );
+
+            if (autoSelectDevice) doSelectDevice(autoSelectDevice, true);
+
+            autoSelectDeviceCLISerialUsed = true;
+        }
+    };
+
 export const stopWatchingDevices = (callback?: () => void) => {
     if (stopNrfutilDevice) stopNrfutilDevice(callback);
     else callback?.();

package/src/Device/deviceSetup.ts

@@ -13,7 +13,7 @@ import {
     setDeviceSetupProgress,
     setDeviceSetupProgressMessage,
 } from './deviceSetupSlice';
-import { Device } from './deviceSlice';
+import { Device, DeviceWithSerialNumber } from './deviceSlice';
 import { InitPacket } from './initPacket';
 
 export interface DfuEntry {
@@ -239,10 +239,10 @@ export const prepareDevice =
 
 export const setupDevice =
     (
-        device: Device,
+        device: DeviceWithSerialNumber,
         deviceSetupConfig: DeviceSetupConfig,
         onDeviceIsReady: (device: Device) => void,
-        doDeselectDevice: () => void,
+        doDeselectDevice: (device?: Device) => void,
         deviceInfo: DeviceInfo | undefined
     ): AppThunk<RootState> =>
     (dispatch, getState) =>
@@ -270,7 +270,7 @@ export const setupDevice =
                         `Error while setting up device ${device.serialNumber}`
                     );
                     logger.error(describeError(error));
-                    doDeselectDevice();
+                    doDeselectDevice(getState().device.selectedDevice);
                 },
                 deviceInfo
             )

package/src/Device/deviceSlice.ts

@@ -26,10 +26,19 @@ export interface Device extends NrfutilDevice {
     persistedSerialPortOptions?: SerialPortOpenOptions<AutoDetectTypes>;
 }
 
+export interface DeviceWithSerialNumber extends Device {
+    serialNumber: string;
+}
+
+export const isDeviceWithSerialNumber = (
+    device: Device
+): device is DeviceWithSerialNumber =>
+    !!(device as DeviceWithSerialNumber).serialNumber;
+
 const findDeviceItem = (
     devices: Device[],
     id: number,
-    serialNumber?: string
+    serialNumber?: string | null
 ) => {
     const index = devices.findIndex(
         d => d.id === id || d.serialNumber === serialNumber
@@ -42,7 +51,7 @@ const updateDevice = (
     state: DeviceState,
     updateToMergeIn: Partial<Device>,
     id: number,
-    serialNumber?: string
+    serialNumber?: string | null
 ) => {
     const device = findDeviceItem(state.devices, id, serialNumber).device;
     if (device) {
@@ -147,7 +156,7 @@ const slice = createSlice({
                 );
 
                 if (
-                    selectedDevice.serialNumber &&
+                    selectedDevice.serialNumber && // we want to disregard comparing devices with no sn
                     vComIndex !== undefined &&
                     vComIndex !== -1
                 ) {

package/src/ErrorBoundary/ErrorBoundary.tsx

@@ -13,27 +13,20 @@ import FactoryResetButton from '../FactoryReset/FactoryResetButton';
 import { CollapsibleGroup } from '../SidePanel/Group';
 import Spinner from '../Spinner/Spinner';
 import { openUrl } from '../utils/open';
-import packageJson from '../utils/packageJson';
+import { packageJson } from '../utils/packageJson';
 import { getAppSpecificStore as store } from '../utils/persistentStore';
 import { generateSystemReport } from '../utils/systemReport';
-import {
-    init as initGA,
-    isEnabled,
-    isInitialized as isGAInitialized,
-    sendErrorReport,
-} from '../utils/usageData';
+import usageData from '../utils/usageData';
 import bugIcon from './bug.svg';
 
 import './error-boundary.scss';
 
 const sendGAEvent = (error: string) => {
-    if (!isEnabled()) {
+    if (!usageData.isEnabled()) {
         return;
     }
-    if (!isGAInitialized()) {
-        initGA(packageJson());
-    }
-    sendErrorReport(error);
+
+    usageData.sendErrorReport(error);
 };
 
 interface Props {
@@ -97,7 +90,8 @@ class ErrorBoundary extends React.Component<
             return children;
         }
 
-        const appDisplayName = appName || packageJson().displayName;
+        const appDisplayName =
+            appName || packageJson().displayName || packageJson().name;
 
         return (
             <div className="error-boundary__container">

package/src/Feedback/sendFeedback.ts

@@ -5,18 +5,16 @@
  */
 
 import { isDevelopment } from '../utils/environment';
-import packageJson from '../utils/packageJson';
+import { packageJson } from '../utils/packageJson';
 
 const formURL =
     isDevelopment === true
         ? 'https://formkeep.com/f/87deb409a565'
         : 'https://formkeep.com/f/36b394b92851';
 
-const getAppName = () => packageJson().name;
-
 export default async (feedback: string, category?: string) => {
     const data: Record<string, unknown> = {
-        name: getAppName(),
+        name: packageJson().name,
         feedback,
         platform: process.platform,
     };

package/src/Link/FileLink.tsx

@@ -12,15 +12,18 @@ import { openFile } from '../utils/open';
 export default ({
     label,
     fileLocation,
+    className,
 }: {
     label: string;
     fileLocation: string;
+    className: string;
 }) => (
     <button
         type="button"
         onClick={() => openFile(fileLocation)}
         className={classNames(
-            'tw-preflight tw-text-nordicBlue hover:tw-underline'
+            'tw-preflight tw-overflow-hidden tw-text-ellipsis tw-text-nordicBlue hover:tw-underline',
+            className
         )}
     >
         {label}

package/src/index.ts

@@ -77,6 +77,7 @@ export { openUrl } from './utils/open';
 export { default as systemReport } from './utils/systemReport';
 
 export { default as usageData } from './utils/usageData';
+export { type Metadata as UsageDataMetadata } from './utils/usageDataCommon';
 export { default as classNames } from './utils/classNames';
 export { truncateMiddle } from './utils/truncateMiddle';
 
@@ -97,6 +98,8 @@ export {
     persistApiKey,
 } from './utils/persistentStore';
 
+export { default as launcherConfig } from './utils/launcherConfig';
+
 export { jprogDeviceSetup } from './Device/jprogOperations';
 
 export { sdfuDeviceSetup } from './Device/sdfuOperations';

package/src/logging/sendInitialLogMessages.ts

@@ -4,12 +4,12 @@
  * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
  */
 
-import { inMain as appDetails } from '../../ipc/appDetails';
 import NrfutilDeviceLib from '../../nrfutil/device/device';
 import {
     getExpectedVersion,
     resolveModuleVersion,
 } from '../../nrfutil/moduleVersion';
+import appDetails from '../utils/appDetails';
 import { getAppDataDir } from '../utils/appDirs';
 import logLibVersions from '../utils/logLibVersions';
 import udevInstalled from '../utils/udevInstalled';
@@ -23,8 +23,6 @@ export default async () => {
     logLibVersions();
     logger.debug(`Application data folder: ${getAppDataDir()}`);
 
-    const details = await appDetails.getAppDetails();
-
     const {
         name,
         currentVersion,
@@ -35,7 +33,7 @@ export default async () => {
         homeDir,
         tmpDir,
         source,
-    } = details;
+    } = await appDetails();
 
     logger.debug(`App ${name} v${currentVersion} (${source})`);
     logger.debug(`App path: ${installed.path}`);

package/src/utils/appDetails.ts

@@ -0,0 +1,22 @@
+/*
+ * Copyright (c) 2023 Nordic Semiconductor ASA
+ *
+ * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
+ */
+
+import { type AppDetailsFromLauncher, inMain } from '../../ipc/appDetails';
+import { isLauncher } from './packageJson';
+
+let cached: AppDetailsFromLauncher;
+
+export default async () => {
+    if (isLauncher()) {
+        throw new Error('Must not be called by the launcher.');
+    }
+
+    if (cached == null) {
+        cached = await inMain.getAppDetails();
+    }
+
+    return cached;
+};

package/src/utils/appDirs.ts

@@ -4,12 +4,12 @@
  * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
  */
 
-import { getGlobal } from '@electron/remote';
 import path from 'path';
 
-import packageJson from './packageJson';
+import launcherConfig from './launcherConfig';
+import { packageJsonApp } from './packageJson';
 
-const getUserDataDir = () => getGlobal('userDataDir');
+const getUserDataDir = () => launcherConfig().userDataDir;
 
 /**
  * Get the filesystem path of the currently loaded app.
@@ -17,7 +17,7 @@ const getUserDataDir = () => getGlobal('userDataDir');
  * @returns {string|undefined} Absolute path of current app.
  */
 const getAppDir = () => {
-    const html = packageJson().nrfConnectForDesktop.html;
+    const html = packageJsonApp().nrfConnectForDesktop.html;
     const dir = path.parse(html).dir;
     return path.parse(__filename).dir.replace(dir, '');
 };