@nordicsemiconductor/pc-nrfconnect-shared 150.0.0 → 152.0.0

package/Changelog.md

@@ -7,6 +7,36 @@ This project does _not_ adhere to
 [Semantic Versioning](https://semver.org/spec/v2.0.0.html) but contrary to it
 every new version is a new major version.
 
+## 152.0.0 - 2024-01-26
+
+### Updated
+
+-   Electron version to `28.1.4`
+-   @electron/remote to `2.1.1`
+
+## 151.0.0 - 2024-01-23
+
+### Changed
+
+-   Renamed exported object `usageData` to `telemetry` and type
+    `UsageDataMetadata` to `TelemetryMetadata`.
+-   Renamed several function in the `telemetry` object:
+    -   `enable()` → `setUsersAgreedToTelemetry(true)`
+    -   `disable()` → `setUsersAgreedToTelemetry(false)`
+    -   `reset()` → `setUsersWithdrewTelemetryAgreement()`
+    -   `isEnabled()` → `getIsSendingTelemetry()` (which now does not log
+        anymore)
+    -   `sendUsageData()` → `sendEvent()`
+-   In the component `ErrorBoundary` the property `sendUsageData` is renamed to
+    `sendTelemetryEvent`.
+
+### Steps to upgrade when using this package
+
+-   If they are imported from shared, rename `usageData` and `UsageDataMetadata`
+    as well as the renamed functions mentioned above.
+-   In usages of the component `ErrorBoundary`, rename the property
+    `sendUsageData` to `sendTelemetryEvent`.
+
 ## 150.0.0 - 2024-01-18
 
 ### Removed
@@ -216,7 +246,7 @@ every new version is a new major version.
 
 ### Fixed
 
--   Telemtry: Metadata was not removed on request, when being in the main
+-   Telemetry: Metadata was not removed on request, when being in the main
     process. This is not critical because this code isn't yet executed in real
     life.
 

package/nrfutil/sandbox.ts

@@ -11,8 +11,8 @@ import path from 'path';
 import treeKill from 'tree-kill';
 
 import describeError from '../src/logging/describeError';
+import telemetry from '../src/telemetry/telemetry';
 import { isDevelopment } from '../src/utils/environment';
-import usageData from '../src/utils/usageData';
 import { versionToInstall } from './moduleVersion';
 import { getNrfutilLogger } from './nrfutilLogger';
 import {
@@ -313,7 +313,7 @@ export class NrfutilSandbox {
             }
 
             error.message = error.message.replaceAll('Error: ', '');
-            usageData.sendErrorReport(
+            telemetry.sendErrorReport(
                 `${
                     pid && this.logLevel === 'trace' ? `[PID:${pid}] ` : ''
                 }${describeError(error)}`
@@ -332,7 +332,7 @@ export class NrfutilSandbox {
     ) =>
         new Promise<void>((resolve, reject) => {
             let aborting = false;
-            usageData.sendUsageData(`running nrfutil ${this.module}`, {
+            telemetry.sendEvent(`running nrfutil ${this.module}`, {
                 args,
                 exec: command,
             });
@@ -494,7 +494,7 @@ export class NrfutilSandbox {
             }
 
             error.message = error.message.replaceAll('Error: ', '');
-            usageData.sendErrorReport(
+            telemetry.sendErrorReport(
                 `${
                     pid && this.logLevel === 'trace' ? `[PID:${pid}] ` : ''
                 }${describeError(error)}`
@@ -513,7 +513,7 @@ export class NrfutilSandbox {
     ) =>
         new Promise<void>((resolve, reject) => {
             let aborting = false;
-            usageData.sendUsageData(`running nrfutil ${this.module}`, {
+            telemetry.sendEvent(`running nrfutil ${this.module}`, {
                 args,
                 exec: command,
             });
@@ -611,7 +611,7 @@ export class NrfutilSandbox {
                 closedHandlers.forEach(callback => callback());
             })
             .catch(error => {
-                usageData.sendErrorReport(describeError(error));
+                telemetry.sendErrorReport(describeError(error));
                 running = false;
                 closedHandlers.forEach(callback => callback(error));
             });

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@nordicsemiconductor/pc-nrfconnect-shared",
-    "version": "150.0.0",
+    "version": "152.0.0",
     "description": "Shared commodities for developing pc-nrfconnect-* packages",
     "repository": {
         "type": "git",
@@ -25,11 +25,11 @@
         "prepare": "ts-node scripts/installHusky.ts",
         "release-shared": "ts-node scripts/release-shared.ts",
         "prepare-shared-release": "ts-node scripts/prepare-shared-release.ts",
-        "clean": "rimraf dist typings/generated dist scripts/nordic-publish.js",
+        "clean": "rimraf dist typings/generated scripts/nordic-publish.js",
         "postinstall": "ts-node scripts/postinstall.ts"
     },
     "dependencies": {
-        "@electron/remote": "^2.0.4",
+        "@electron/remote": "^2.1.1",
         "@mdi/font": "7.2.96",
         "@mdi/js": "^7.2.96",
         "@mdi/react": "^1.6.1",
@@ -62,7 +62,7 @@
         "bootstrap": "4.6.2",
         "commander": "10.0.0",
         "date-fns": "2.29.3",
-        "electron": "22.3.5",
+        "electron": "^28.1.4",
         "electron-store": "8.1.0",
         "esbuild": "0.19.2",
         "esbuild-sass-plugin": "2.13.0",

package/src/App/App.test.tsx

@@ -5,8 +5,9 @@
  */
 
 import React from 'react';
-import { screen } from '@testing-library/react';
+import { act, screen } from '@testing-library/react';
 
+import { OFFICIAL } from '../../ipc/sources';
 import packageJsonFromShared from '../../package.json';
 import render from '../../test/testrenderer';
 import App, { Pane } from './App';
@@ -26,6 +27,12 @@ jest.mock('../utils/packageJson', () => ({
     packageJson: () => packageJsonFromShared,
 }));
 
+const appDetails = Promise.resolve({ source: OFFICIAL });
+jest.mock('../utils/appDetails', () => ({
+    __esModule: true,
+    default: () => appDetails,
+}));
+
 const renderApp = (panes: Pane[]) => {
     const dummyReducer = (s = null) => s;
     const dummyNode = <div />;
@@ -50,9 +57,11 @@ const anotherPane = {
 };
 
 describe('App', () => {
-    it('automatically gets an About pane attached', () => {
+    it('automatically gets an About pane attached', async () => {
         renderApp([aPane, anotherPane]);
 
         expect(screen.getByText('About')).toBeInTheDocument();
+
+        await act(() => appDetails);
     });
 });

package/src/App/App.tsx

@@ -29,12 +29,12 @@ import FlashMessages from '../FlashMessage/FlashMessage';
 import LogViewer from '../Log/LogViewer';
 import logger from '../logging';
 import NavBar from '../NavBar/NavBar';
+import telemetry from '../telemetry/telemetry';
 import classNames from '../utils/classNames';
 import {
     getPersistedCurrentPane,
     getPersistedLogVisible,
 } from '../utils/persistentStore';
-import usageData from '../utils/usageData';
 import useHotKey from '../utils/useHotKey';
 import {
     currentPane as currentPaneSelector,
@@ -87,7 +87,7 @@ const ConnectedApp: FC<ConnectedAppProps> = ({
     if (!initApp.current) {
         logger.initialise();
         setNrfutilLogger(logger);
-        usageData.setLogger(logger);
+        telemetry.setLogger(logger);
         initApp.current = true;
     }
 
@@ -110,7 +110,7 @@ const ConnectedApp: FC<ConnectedAppProps> = ({
     }, [allPanes]);
 
     useEffect(() => {
-        usageData.sendPageView(paneName.current[currentPane]);
+        telemetry.sendPageView(paneName.current[currentPane]);
     }, [currentPane]);
 
     useEffect(() => {

package/src/Device/DeviceSelector/DeviceSelector.test.tsx

@@ -7,6 +7,8 @@
 import React from 'react';
 import { act, fireEvent, screen, waitFor } from '@testing-library/react';
 
+import { OFFICIAL } from '../../../ipc/sources';
+import packageJsonFromShared from '../../../package.json';
 import render from '../../../test/testrenderer';
 import { addDevice, Device, removeDevice } from '../deviceSlice';
 import { jprogDeviceSetup } from '../jprogOperations';
@@ -14,6 +16,17 @@ import DeviceSelector from './DeviceSelector';
 
 jest.mock('../../../nrfutil/device/device');
 
+jest.mock('../../utils/packageJson', () => ({
+    isLauncher: () => false,
+    packageJson: () => packageJsonFromShared,
+}));
+
+const appDetails = Promise.resolve({ source: OFFICIAL });
+jest.mock('../../utils/appDetails', () => ({
+    __esModule: true,
+    default: () => appDetails,
+}));
+
 const DEVICE_SERIAL_NUMBER = '000000001';
 
 const testDevice: Device = {

package/src/Device/DeviceSelector/DeviceSelector.tsx

@@ -10,8 +10,8 @@ import { useDispatch, useSelector } from 'react-redux';
 import { NrfutilDeviceLib } from '../../../nrfutil/device';
 import { DeviceTraits } from '../../../nrfutil/device/common';
 import logger from '../../logging';
-import usageData from '../../utils/usageData';
-import { simplifyDeviceForLogging } from '../../utils/usageDataCommon';
+import simplifyDevice from '../../telemetry/simplifyDevice';
+import telemetry from '../../telemetry/telemetry';
 import useHotKey from '../../utils/useHotKey';
 import {
     clearWaitForDevice,
@@ -71,9 +71,9 @@ export default ({
     const doDeselectDevice = useCallback(
         (device?: Device) => {
             if (device) {
-                usageData.sendUsageData(
+                telemetry.sendEvent(
                     'device deselected ',
-                    simplifyDeviceForLogging(device)
+                    simplifyDevice(device)
                 );
             }
 
@@ -120,8 +120,8 @@ export default ({
             dispatch(setSelectedDeviceInfo(deviceInfo));
             onDeviceSelected(device, autoReselected);
 
-            usageData.sendUsageData('device selected', {
-                device: simplifyDeviceForLogging(device),
+            telemetry.sendEvent('device selected', {
+                device: simplifyDevice(device),
                 deviceInfo,
             });
 

package/src/Device/deviceLister.ts

@@ -9,8 +9,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 simplifyDevice from '../telemetry/simplifyDevice';
+import telemetry from '../telemetry/telemetry';
 import {
     clearWaitForDevice,
     clearWaitForDeviceTimeout,
@@ -180,9 +180,9 @@ export const startWatchingDevices =
 
             const action = async (device: Device) => {
                 if (hasValidDeviceTraits(device.traits, deviceListing)) {
-                    usageData.sendUsageData(
+                    telemetry.sendEvent(
                         'device connected',
-                        simplifyDeviceForLogging(device)
+                        simplifyDevice(device)
                     );
                     if (
                         !getState().device.devices.find(

package/src/ErrorBoundary/ErrorBoundary.test.tsx

@@ -13,8 +13,8 @@ import { generateSystemReport } from '../utils/systemReport';
 import ErrorBoundary from './ErrorBoundary';
 
 jest.mock('../utils/systemReport');
-jest.mock('../utils/usageData', () => ({
-    ...jest.requireActual('../utils/usageData'),
+jest.mock('../telemetry/telemetry', () => ({
+    ...jest.requireActual('../telemetry/telemetry'),
     sendErrorReport: jest.fn(),
     isEnabled: () => true,
 }));
@@ -44,14 +44,14 @@ describe('ErrorBoundary', () => {
     });
 
     it('can take custom reporting functions', () => {
-        const sendUsageData = jest.fn();
+        const sendTelemetryEvent = jest.fn();
 
         render(
-            <ErrorBoundary sendUsageData={sendUsageData}>
+            <ErrorBoundary sendTelemetryEvent={sendTelemetryEvent}>
                 <Child />
             </ErrorBoundary>
         );
-        expect(sendUsageData).toHaveBeenCalled();
+        expect(sendTelemetryEvent).toHaveBeenCalled();
     });
 
     it('should render error boundary component when there is an error', () => {

package/src/ErrorBoundary/ErrorBoundary.tsx

@@ -12,21 +12,17 @@ import { Device } from '../Device/deviceSlice';
 import FactoryResetButton from '../FactoryReset/FactoryResetButton';
 import { CollapsibleGroup } from '../SidePanel/Group';
 import Spinner from '../Spinner/Spinner';
+import telemetry from '../telemetry/telemetry';
 import { openUrl } from '../utils/open';
 import { packageJson } from '../utils/packageJson';
 import { getAppSpecificStore as store } from '../utils/persistentStore';
 import { generateSystemReport } from '../utils/systemReport';
-import usageData from '../utils/usageData';
 import bugIcon from './bug.svg';
 
 import './error-boundary.scss';
 
-const sendGAEvent = (error: string) => {
-    if (!usageData.isEnabled()) {
-        return;
-    }
-
-    usageData.sendErrorReport(error);
+const sendErrorReport = (error: string) => {
+    telemetry.sendErrorReport(error);
 };
 
 interface Props {
@@ -36,7 +32,7 @@ interface Props {
     devices?: Device[];
     appName?: string;
     restoreDefaults?: () => void;
-    sendUsageData?: (message: string) => void;
+    sendTelemetryEvent?: (message: string) => void;
 }
 
 const genericRestoreDefaults = () => {
@@ -65,11 +61,16 @@ class ErrorBoundary extends React.Component<
     }
 
     componentDidCatch(error: Error) {
-        const { devices, selectedDevice, selectedSerialNumber, sendUsageData } =
-            this.props;
-        sendUsageData != null
-            ? sendUsageData(error.message)
-            : sendGAEvent(error.message);
+        const {
+            devices,
+            selectedDevice,
+            selectedSerialNumber,
+            sendTelemetryEvent,
+        } = this.props;
+
+        sendTelemetryEvent != null
+            ? sendTelemetryEvent(error.message)
+            : sendErrorReport(error.message);
 
         generateSystemReport(
             new Date().toISOString().replace(/:/g, '-'),

package/src/Parsers/shellParser.ts

@@ -39,15 +39,15 @@ export type XTerminalShellParser = ReturnType<
 
 export const xTerminalShellParserWrapper = (terminal: Terminal) => ({
     getTerminalData: () => {
-        let out = '';
+        let result = '';
         for (let i = 0; i <= terminal.buffer.active.cursorY; i += 1) {
             const line = terminal.buffer.active.getLine(i);
             if (typeof line !== 'undefined') {
-                out += `\r\n${line.translateToString()}`;
+                result += `\r\n${line.translateToString()}`;
             }
         }
 
-        return out.trim();
+        return result.trim();
     },
     clear: () => terminal.clear(),
     getLastLine: () => {

package/src/index.ts

@@ -77,8 +77,8 @@ export {
 export { openUrl, openFile } 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 telemetry } from './telemetry/telemetry';
+export { type default as TelemetryMetadata } from './telemetry/TelemetryMetadata';
 export { default as classNames } from './utils/classNames';
 export { truncateMiddle } from './utils/truncateMiddle';
 

package/src/telemetry/TelemetryMetadata.ts

@@ -0,0 +1,9 @@
+/*
+ * Copyright (c) 2023 Nordic Semiconductor ASA
+ *
+ * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
+ */
+
+export default interface TelemetryMetadata {
+    [key: string]: unknown;
+}

package/src/telemetry/TelemetrySender.ts

@@ -0,0 +1,80 @@
+/*
+ * Copyright (c) 2023 Nordic Semiconductor ASA
+ *
+ * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
+ */
+
+import si from 'systeminformation';
+import { Logger } from 'winston';
+
+import {
+    deleteHasUserAgreedToTelemetry,
+    getHasUserAgreedToTelemetry,
+    persistHasUserAgreedToTelemetry,
+} from '../utils/persistentStore';
+import TelemetryMetadata from './TelemetryMetadata';
+
+type MaybePromise<T> = T | Promise<T>;
+
+export default abstract class TelemetrySender {
+    readonly INSTRUMENTATION_KEY = '4b8b1a39-37c7-479e-a684-d4763c7c647c';
+
+    logger?: Logger;
+    setLogger = (logger: Logger) => {
+        this.logger = logger;
+    };
+
+    isTelemetryAllowedForCurrentApp = false;
+    allowTelemetryForCurrentApp = () => {
+        this.isTelemetryAllowedForCurrentApp = true;
+    };
+
+    getIsSendingTelemetry = () =>
+        this.isTelemetryAllowedForCurrentApp &&
+        getHasUserAgreedToTelemetry() === true;
+
+    async sendAgreementEvent() {
+        this.sendEvent('Telemetry Opt-In');
+
+        const { platform, arch } = await si.osInfo();
+        this.sendEvent('Report OS info', { platform, arch });
+    }
+
+    sendDisagreementEvent() {
+        this.sendMinimalEvent('Telemetry Opt-Out');
+    }
+
+    async setUsersAgreedToTelemetry(hasAgreed: boolean) {
+        persistHasUserAgreedToTelemetry(hasAgreed);
+
+        if (hasAgreed) {
+            await this.sendAgreementEvent();
+        } else {
+            this.sendDisagreementEvent();
+        }
+
+        this.logger?.debug(
+            `Telemetry has been ${hasAgreed ? 'enabled' : 'disabled'}`
+        );
+    }
+
+    setUsersWithdrewTelemetryAgreement() {
+        deleteHasUserAgreedToTelemetry();
+        this.sendMinimalEvent('Telemetry Opt-Reset');
+        this.logger?.debug('Telemetry has been reset');
+    }
+
+    sendMinimalEvent(action: string) {
+        this.sendEvent(action, { removeAllMetadata: true });
+    }
+
+    abstract sendEvent(
+        action: string,
+        metadata?: TelemetryMetadata
+    ): MaybePromise<void>;
+    abstract sendPageView(pageName: string): MaybePromise<void>;
+    abstract sendMetric(name: string, average: number): MaybePromise<void>;
+    abstract sendTrace(message: string): MaybePromise<void>;
+    abstract sendErrorReport(error: Error): MaybePromise<void>;
+    abstract flush(): MaybePromise<void>;
+}

package/src/telemetry/TelemetrySenderInMain.ts

@@ -0,0 +1,80 @@
+/*
+ * Copyright (c) 2023 Nordic Semiconductor ASA
+ *
+ * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
+ */
+
+import { TelemetryClient } from 'applicationinsights';
+
+import { isDevelopment } from '../utils/environment';
+import { packageJson } from '../utils/packageJson';
+import TelemetryMetadata from './TelemetryMetadata';
+import TelemetrySender from './TelemetrySender';
+
+export default class TelemetrySenderInMain extends TelemetrySender {
+    client?: TelemetryClient;
+
+    initClient() {
+        const appPackageJson = packageJson();
+        const applicationName = appPackageJson.name;
+        const applicationVersion = appPackageJson.version;
+
+        this.client = new TelemetryClient(this.INSTRUMENTATION_KEY);
+        this.client.config.enableAutoCollectConsole = false;
+        this.client.config.enableAutoCollectDependencies = false;
+        this.client.config.enableAutoCollectExceptions = false;
+        this.client.config.enableAutoCollectIncomingRequestAzureFunctions =
+            false;
+        this.client.config.enableAutoCollectHeartbeat = false;
+        this.client.config.enableAutoCollectPerformance = false;
+        this.client.config.enableAutoCollectPreAggregatedMetrics = false;
+        this.client.config.enableAutoCollectRequests = false;
+        this.client.config.enableAutoDependencyCorrelation = false;
+
+        // Add app name and version to every event
+        this.client.addTelemetryProcessor(envelope => {
+            if (envelope.data.baseData?.properties.removeAllMetadata) {
+                envelope.tags = [];
+                envelope.data.baseData = {
+                    name: envelope.data?.baseData.name,
+                };
+            } else {
+                envelope.tags['ai.cloud.roleInstance'] = undefined; // remove PC name
+                if (envelope.data.baseData) {
+                    envelope.data.baseData.properties = {
+                        applicationName,
+                        applicationVersion,
+                        isDevelopment,
+                        ...envelope.data.baseData.properties,
+                    };
+                }
+            }
+
+            return true;
+        });
+
+        return this.client;
+    }
+
+    getClient = () => this.client ?? this.initClient();
+
+    sendEvent = (action: string, metadata?: TelemetryMetadata) => {
+        this.getClient().trackEvent({ name: action, properties: metadata });
+        this.logger?.debug(`Sending event ${JSON.stringify(action)}`);
+    };
+
+    sendPageView = (pageName: string) =>
+        this.getClient().trackPageView({ name: pageName });
+
+    sendMetric = (name: string, value: number) =>
+        this.getClient().trackMetric({ name, value });
+
+    sendTrace = (message: string) => this.getClient().trackTrace({ message });
+
+    sendErrorReport = (error: Error) => {
+        this.getClient().trackException({ exception: error });
+        this.logger?.error(error);
+    };
+
+    flush = () => this.getClient().flush();
+}

package/src/telemetry/TelemetrySenderInRenderer.ts

@@ -0,0 +1,86 @@
+/*
+ * Copyright (c) 2023 Nordic Semiconductor ASA
+ *
+ * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
+ */
+
+import { ApplicationInsights } from '@microsoft/applicationinsights-web';
+
+import appDetails from '../utils/appDetails';
+import { isDevelopment } from '../utils/environment';
+import { isLauncher, packageJson } from '../utils/packageJson';
+import { getTelemetryClientId } from '../utils/persistentStore';
+import TelemetryMetadata from './TelemetryMetadata';
+import TelemetrySender from './TelemetrySender';
+
+export default class TelemetrySenderInRenderer extends TelemetrySender {
+    client?: ApplicationInsights;
+
+    async initClient() {
+        const source = isLauncher() ? undefined : (await appDetails()).source;
+
+        const applicationName = packageJson().name;
+        const applicationVersion = packageJson().version;
+
+        const accountId = getTelemetryClientId();
+
+        this.client = new ApplicationInsights({
+            config: {
+                instrumentationKey: this.INSTRUMENTATION_KEY,
+                accountId, // to hide with removeAllMetadata
+                isStorageUseDisabled: true, // fix issue with duplicate events being sent https://github.com/microsoft/ApplicationInsights-JS/issues/796
+                namePrefix: applicationName, // fix issue with duplicate events being sent https://github.com/microsoft/ApplicationInsights-JS/issues/796
+            },
+        });
+
+        this.client.loadAppInsights();
+
+        // Add app name and version to every event
+        this.client.addTelemetryInitializer(envelope => {
+            if (envelope.data?.removeAllMetadata) {
+                envelope.data = {};
+                envelope.baseData = { name: envelope.baseData?.name };
+                envelope.ext = {};
+                envelope.tags = [];
+            } else {
+                const trace = {
+                    ...(envelope.ext?.trace ?? {}),
+                    name: applicationName,
+                };
+                envelope.ext = { ...envelope.ext, trace };
+                envelope.data = {
+                    ...envelope.data,
+                    applicationName,
+                    applicationVersion,
+                    isDevelopment,
+                    source,
+                };
+            }
+        });
+
+        return this.client;
+    }
+
+    getClient = () => this.client ?? this.initClient();
+
+    sendEvent = async (action: string, metadata?: TelemetryMetadata) => {
+        (await this.getClient()).trackEvent({ name: action }, metadata);
+        this.logger?.debug(`Sending event ${JSON.stringify(action)}`);
+    };
+
+    sendPageView = async (pageName: string) =>
+        (await this.getClient()).trackPageView({ name: pageName });
+
+    sendMetric = async (name: string, average: number) =>
+        (await this.getClient()).trackMetric({ name, average });
+
+    sendTrace = async (message: string) =>
+        (await this.getClient()).trackTrace({ message });
+
+    sendErrorReport = async (error: Error) => {
+        (await this.getClient()).trackException({ exception: error });
+        this.logger?.error(error);
+    };
+
+    flush = async () => (await this.getClient()).flush();
+}