@nordicsemiconductor/pc-nrfconnect-shared 149.0.0 → 151.0.0

package/src/utils/usageData.ts

@@ -1,117 +0,0 @@
-/*
- * Copyright (c) 2105 Nordic Semiconductor ASA
- *
- * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
- */
-
-import si from 'systeminformation';
-
-import { packageJson } from './packageJson';
-import {
-    deleteIsSendingUsageData,
-    persistIsSendingUsageData,
-} from './persistentStore';
-import usageDataCommon, { Metadata } from './usageDataCommon';
-import usageDataMain from './usageDataMain';
-import usageDataRenderer from './usageDataRenderer';
-
-const getFriendlyAppName = () =>
-    packageJson().name.replace('pc-nrfconnect-', '');
-
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-const flattenObject = (obj?: any, parentKey?: string) => {
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    let result: any = {};
-
-    if (!obj) return result;
-
-    Object.keys(obj).forEach(key => {
-        const value = obj[key];
-        const newKey = parentKey ? `${parentKey}.${key}` : key;
-        if (typeof value === 'object') {
-            result = { ...result, ...flattenObject(value, newKey) };
-        } else {
-            result[newKey] = value;
-        }
-    });
-
-    return result;
-};
-
-const enable = () => {
-    persistIsSendingUsageData(true);
-    si.osInfo().then(({ platform, arch }) =>
-        getUsageData().sendUsageData('Report OS info', { platform, arch })
-    );
-    getUsageData().sendUsageData('Data Usage Opt-In', undefined);
-    usageDataCommon.getLogger()?.debug('Usage data has been enabled');
-};
-
-const disable = () => {
-    getUsageData().sendUsageData('Data Usage Opt-Out', undefined, true);
-    persistIsSendingUsageData(false);
-    usageDataCommon.getLogger()?.debug('Usage data has been disabled');
-};
-
-const reset = () => {
-    getUsageData().sendUsageData('Data Usage Opt-Reset', undefined, true);
-    deleteIsSendingUsageData();
-    usageDataCommon.getLogger()?.debug('Usage data setting has been reset');
-};
-
-const isRenderer = process && process.type === 'renderer';
-
-const getUsageData = () => {
-    if (isRenderer) {
-        return usageDataRenderer;
-    }
-
-    return usageDataMain;
-};
-
-const sendUsageData = async (
-    action: string,
-    metadata?: Metadata,
-    forceSend?: boolean
-) => {
-    if (
-        await getUsageData().sendUsageData(
-            `${getFriendlyAppName()}: ${action}`,
-            flattenObject(metadata),
-            forceSend
-        )
-    ) {
-        usageDataCommon
-            .getLogger()
-            ?.debug(`Sending usage data ${JSON.stringify(action)}`);
-    }
-};
-
-const sendPageView = (pageName: string) =>
-    getUsageData().sendPageView(`${getFriendlyAppName()} - ${pageName}`);
-
-const sendMetric = (name: string, average: number) =>
-    getUsageData().sendMetric(name, average);
-
-const sendTrace = (message: string) => getUsageData().sendTrace(message);
-
-const sendErrorReport = (error: string | Error) => {
-    usageDataCommon.getLogger()?.error(error);
-    return getUsageData().sendErrorReport(
-        typeof error === 'string' ? new Error(error) : error
-    );
-};
-
-export default {
-    setLogger: usageDataCommon.setLogger,
-    disable,
-    enable,
-    isEnabled: usageDataCommon.isEnabled,
-    reset,
-    sendErrorReport,
-    sendUsageData,
-    sendPageView,
-    sendMetric,
-    sendTrace,
-    enableTelemetry: usageDataCommon.enableTelemetry,
-};

package/src/utils/usageDataCommon.ts

@@ -1,59 +0,0 @@
-/*
- * Copyright (c) 2105 Nordic Semiconductor ASA
- *
- * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
- */
-
-import winston from 'winston';
-
-import { type Device } from '../Device/deviceSlice';
-import { getIsSendingUsageData } from './persistentStore';
-
-export const INSTRUMENTATION_KEY = '4b8b1a39-37c7-479e-a684-d4763c7c647c';
-
-let telemetryEnabled = false;
-
-const enableTelemetry = () => {
-    telemetryEnabled = true;
-};
-
-let logger: winston.Logger | undefined;
-const setLogger = (log: winston.Logger) => {
-    logger = log;
-};
-
-const getLogger = () => logger;
-
-export interface Metadata {
-    [key: string]: unknown;
-}
-
-export const simplifyDeviceForLogging = (device: Device) => ({
-    devkit: device.devkit,
-    serialPorts: device.serialPorts,
-    traits: device.traits,
-    serialNumber: device.serialNumber,
-    enumerationID: device.id,
-    usb: {
-        product: device.usb?.product,
-        manufacturer: device.usb?.manufacturer,
-        deviceDescriptor: device.usb?.device.descriptor,
-    },
-});
-
-const isEnabled = () => {
-    const isSendingUsageData = getShouldSendTelemetry();
-    logger?.debug(`Usage data is ${isSendingUsageData}`);
-    return isSendingUsageData;
-};
-
-const getShouldSendTelemetry = (forceSend?: boolean) =>
-    (forceSend || getIsSendingUsageData()) && telemetryEnabled;
-
-export default {
-    setLogger,
-    getLogger,
-    isEnabled,
-    getShouldSendTelemetry,
-    enableTelemetry,
-};

package/src/utils/usageDataMain.ts

@@ -1,119 +0,0 @@
-/*
- * Copyright (c) 2105 Nordic Semiconductor ASA
- *
- * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
- */
-
-import { TelemetryClient } from 'applicationinsights';
-
-import { isDevelopment } from './environment';
-import { packageJson } from './packageJson';
-import usageDataCommon, {
-    INSTRUMENTATION_KEY,
-    Metadata,
-} from './usageDataCommon';
-
-let cachedInsights: TelemetryClient | undefined;
-
-const getInsights = (forceSend?: boolean) => {
-    if (!usageDataCommon.getShouldSendTelemetry(forceSend)) return;
-
-    if (cachedInsights) {
-        return cachedInsights;
-    }
-
-    if (!cachedInsights) {
-        cachedInsights = init();
-    }
-
-    return cachedInsights;
-};
-
-const init = () => {
-    const appPackageJson = packageJson();
-    const applicationName = appPackageJson.name;
-    const applicationVersion = appPackageJson.version;
-
-    const out = new TelemetryClient(INSTRUMENTATION_KEY);
-    out.config.enableAutoCollectConsole = false;
-    out.config.enableAutoCollectDependencies = false;
-    out.config.enableAutoCollectExceptions = false;
-    out.config.enableAutoCollectIncomingRequestAzureFunctions = false;
-    out.config.enableAutoCollectHeartbeat = false;
-    out.config.enableAutoCollectPerformance = false;
-    out.config.enableAutoCollectPreAggregatedMetrics = false;
-    out.config.enableAutoCollectRequests = false;
-    out.config.enableAutoDependencyCorrelation = false;
-
-    // Add app name and version to every event
-    out.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 out;
-};
-
-const sendUsageData = (
-    action: string,
-    metadata?: Metadata,
-    forceSend?: boolean
-) => {
-    const result = getInsights(forceSend);
-    if (result !== undefined) {
-        result.trackEvent({
-            name: action,
-            properties: forceSend ? { removeAllMetadata: true } : metadata,
-        });
-        return true;
-    }
-
-    return false;
-};
-
-const sendPageView = (pageName: string) => {
-    getInsights()?.trackPageView({
-        name: pageName,
-    });
-};
-
-const sendMetric = (name: string, value: number) => {
-    getInsights()?.trackMetric({
-        name,
-        value,
-    });
-};
-
-const sendTrace = (message: string) => {
-    getInsights()?.trackTrace({
-        message,
-    });
-};
-
-const sendErrorReport = (error: Error) => {
-    getInsights()?.trackException({
-        exception: error,
-    });
-};
-
-export default {
-    sendErrorReport,
-    sendUsageData,
-    sendPageView,
-    sendMetric,
-    sendTrace,
-};

package/src/utils/usageDataRenderer.ts

@@ -1,137 +0,0 @@
-/*
- * Copyright (c) 2105 Nordic Semiconductor ASA
- *
- * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
- */
-
-import { ApplicationInsights } from '@microsoft/applicationinsights-web';
-
-import appDetails from './appDetails';
-import { isDevelopment } from './environment';
-import { isLauncher, packageJson } from './packageJson';
-import { getUsageDataClientId } from './persistentStore';
-import usageDataCommon, {
-    INSTRUMENTATION_KEY,
-    Metadata,
-} from './usageDataCommon';
-
-let cachedInsights: ApplicationInsights | undefined;
-
-const getInsights = async (forceSend?: boolean) => {
-    if (!usageDataCommon.getShouldSendTelemetry(forceSend)) return;
-
-    if (cachedInsights) {
-        return cachedInsights;
-    }
-
-    if (!cachedInsights) {
-        cachedInsights = await init();
-    }
-
-    return cachedInsights;
-};
-
-// We experienced that apps sometimes freeze when closing the window
-// until the telemetry events are sent.
-const isRenderer = process && process.type === 'renderer';
-if (isRenderer) {
-    window.addEventListener('beforeunload', async () => {
-        (await getInsights())?.flush();
-    });
-}
-
-const init = async () => {
-    const applicationName = packageJson().name;
-    const applicationVersion = packageJson().version;
-    const source = isLauncher() ? undefined : (await appDetails()).source;
-
-    const accountId = getUsageDataClientId();
-
-    const out = new ApplicationInsights({
-        config: {
-            instrumentationKey: 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
-        },
-    });
-
-    out.loadAppInsights();
-
-    // Add app name and version to every event
-    out.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 out;
-};
-
-const sendUsageData = async (
-    action: string,
-    metadata?: Metadata,
-    forceSend?: boolean
-) => {
-    const result = await getInsights(forceSend);
-    if (result !== undefined) {
-        result.trackEvent(
-            {
-                name: action,
-            },
-            forceSend ? { removeAllMetadata: true } : metadata
-        );
-        return true;
-    }
-
-    return false;
-};
-
-const sendPageView = async (pageName: string) => {
-    (await getInsights())?.trackPageView({
-        name: pageName,
-    });
-};
-
-const sendMetric = async (name: string, average: number) => {
-    (await getInsights())?.trackMetric({
-        name,
-        average,
-    });
-};
-
-const sendTrace = async (message: string) => {
-    (await getInsights())?.trackTrace({
-        message,
-    });
-};
-
-const sendErrorReport = async (error: Error) => {
-    (await getInsights())?.trackException({
-        exception: error,
-    });
-};
-
-export default {
-    sendErrorReport,
-    sendUsageData,
-    sendPageView,
-    sendMetric,
-    sendTrace,
-};

package/typings/generated/src/utils/usageData.d.ts

@@ -1,16 +0,0 @@
-import { Metadata } from './usageDataCommon';
-declare const _default: {
-    setLogger: (log: import("winston").Logger) => void;
-    disable: () => void;
-    enable: () => void;
-    isEnabled: () => boolean | undefined;
-    reset: () => void;
-    sendErrorReport: (error: string | Error) => void | Promise<void>;
-    sendUsageData: (action: string, metadata?: Metadata | undefined, forceSend?: boolean | undefined) => Promise<void>;
-    sendPageView: (pageName: string) => void | Promise<void>;
-    sendMetric: (name: string, average: number) => void | Promise<void>;
-    sendTrace: (message: string) => void | Promise<void>;
-    enableTelemetry: () => void;
-};
-export default _default;
-//# sourceMappingURL=usageData.d.ts.map

package/typings/generated/src/utils/usageData.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"usageData.d.ts","sourceRoot":"","sources":["../../../../src/utils/usageData.ts"],"names":[],"mappings":"AAaA,OAAwB,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;;;;;;;;;;;;;;AA2F9D,wBAYE"}

package/typings/generated/src/utils/usageDataCommon.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"usageDataCommon.d.ts","sourceRoot":"","sources":["../../../../src/utils/usageDataCommon.ts"],"names":[],"mappings":"AAMA,OAAO,OAAO,MAAM,SAAS,CAAC;AAE9B,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,uBAAuB,CAAC;AAGpD,eAAO,MAAM,mBAAmB,yCAAyC,CAAC;AAe1E,MAAM,WAAW,QAAQ;IACrB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CAC1B;AAED,eAAO,MAAM,wBAAwB,WAAY,MAAM;;;;;;;;;;;CAWrD,CAAC;;;;;;;;AAWH,wBAME"}

package/typings/generated/src/utils/usageDataMain.d.ts

@@ -1,10 +0,0 @@
-import { Metadata } from './usageDataCommon';
-declare const _default: {
-    sendErrorReport: (error: Error) => void;
-    sendUsageData: (action: string, metadata?: Metadata | undefined, forceSend?: boolean | undefined) => boolean;
-    sendPageView: (pageName: string) => void;
-    sendMetric: (name: string, value: number) => void;
-    sendTrace: (message: string) => void;
-};
-export default _default;
-//# sourceMappingURL=usageDataMain.d.ts.map

package/typings/generated/src/utils/usageDataMain.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"usageDataMain.d.ts","sourceRoot":"","sources":["../../../../src/utils/usageDataMain.ts"],"names":[],"mappings":"AAUA,OAAwB,EAEpB,QAAQ,EACX,MAAM,mBAAmB,CAAC;;;;;;;;AAmG3B,wBAME"}

package/typings/generated/src/utils/usageDataRenderer.d.ts

@@ -1,10 +0,0 @@
-import { Metadata } from './usageDataCommon';
-declare const _default: {
-    sendErrorReport: (error: Error) => Promise<void>;
-    sendUsageData: (action: string, metadata?: Metadata | undefined, forceSend?: boolean | undefined) => Promise<boolean>;
-    sendPageView: (pageName: string) => Promise<void>;
-    sendMetric: (name: string, average: number) => Promise<void>;
-    sendTrace: (message: string) => Promise<void>;
-};
-export default _default;
-//# sourceMappingURL=usageDataRenderer.d.ts.map

package/typings/generated/src/utils/usageDataRenderer.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"usageDataRenderer.d.ts","sourceRoot":"","sources":["../../../../src/utils/usageDataRenderer.ts"],"names":[],"mappings":"AAYA,OAAwB,EAEpB,QAAQ,EACX,MAAM,mBAAmB,CAAC;;;;;;;;AAmH3B,wBAME"}