Merge pull request #794 from NordicSemiconductor/feat/improve-azure-analytics

Feat/improve azure analytics

Author: kylebonnici

Changelog.md

@@ -7,17 +7,44 @@ 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.
 
-## 123 - UNRELEASED
+## 123 - 2023-11-07
 
 ### Added
 
--   PID to `nrfutil device` logs when trace is enabled
+-   PID to `nrfutil device` logs when trace is enabled.
+-   `launcherConfig` to retrieve the launcher config in any renderer process.
+
+### Changed
+
+-   Analytic events names are now distinct with a prefix of the app name
+    `<AppName>:` e.g `npm:` or `ppk:`.
+-   `<App` component no longer provides property `reportUsageData` and for app
+    to enable telemetry they must now use `usageData.enableTelemetry()`
+-   The function to send telemetry data in `usageData` became async. If you have
+    to be sure they completed, you now have to await them.
 
 ### Fixed
 
 -   Serial port in the device list where not aligned correctly
 -   Auto select device when `--deviceSerial` is provided
 
+### Steps to upgrade when using this package
+
+-   In `package.json` bump `engines.nrfconnect` to at least `>=4.2.2`.
+-   Remove `reportUsageData` property if it is set in project. If this was set
+    to true add `usageData.enableTelemetry()` as shown below. For projects like
+    launcher add `usageData.enableTelemetry()` to main and renderer window.
+
+```tsx
+import React from 'react';
+import { App, render } from '@nordicsemiconductor/pc-nrfconnect-shared';
+import usageData from '@nordicsemiconductor/pc-nrfconnect-shared/src/utils/usageData';
+
+usageData.enableTelemetry();
+
+render(<App panes={[]} />);
+```
+
 ## 122 - 2023-11-02
 
 ### Changed

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 };

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,34 +45,29 @@ 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({
             type: z.string(),
             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);

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,10 +39,10 @@ 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';

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',
 });

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}`);

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 {
@@ -266,7 +267,7 @@ export class NrfutilSandbox {
             }
 
             error.message = error.message.replaceAll('Error: ', '');
-            getNrfutilLogger()?.error(
+            usageData.sendErrorReport(
                 `${
                     pid && this.logLevel === 'trace' ? `[PID:${pid}] ` : ''
                 }${describeError(error)}`
@@ -301,6 +302,7 @@ export class NrfutilSandbox {
     ) =>
         new Promise<void>((resolve, reject) => {
             let aborting = false;
+            usageData.sendUsageData(`running nrfutil ${command}`, { args });
             const nrfutil = spawn(
                 path.join(this.baseDir, 'nrfutil'),
                 [
@@ -407,6 +409,7 @@ export class NrfutilSandbox {
                 closedHandlers.forEach(callback => callback());
             })
             .catch(error => {
+                usageData.sendErrorReport(describeError(error));
                 running = false;
                 closedHandlers.forEach(callback => callback(error));
             });