@microsoft/applicationinsights-react-native 2.5.6 → 3.0.0

package/src/Interfaces/INativeDevice.ts

@@ -1,3 +1,6 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
 export interface INativeDevice {
     /**
      * Device type, e.g. Handset, Tablet, Tv

package/src/Interfaces/IReactNativePluginConfig.ts

@@ -1,4 +1,19 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
 export interface IReactNativePluginConfig {
+    /**
+     * Disable automatic device collection
+     */
     disableDeviceCollection?: boolean;
+
+    /**
+     * Disable automatic exception collection
+     */
     disableExceptionCollection?: boolean;
+
+    /**
+     * Timeout value to unblock the processing of events if the DeviceInfoModule
+     * returns a Promise.
+     */
+    uniqueIdPromiseTimeout?: number;
 }

package/src/Interfaces/index.ts

@@ -1,3 +1,6 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
 import { INativeDevice } from "./INativeDevice";
 import { IReactNativePluginConfig } from "./IReactNativePluginConfig";
 

package/src/ReactNativePlugin.ts

@@ -1,39 +1,23 @@
-/**
-* ReactNativePlugin.ts
-* @copyright Microsoft 2019
-*/
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
 
 import dynamicProto from "@microsoft/dynamicproto-js";
-import DeviceInfo from "react-native-device-info";
 import {
     AnalyticsPluginIdentifier, ConfigurationManager, IAppInsights, IDevice, IExceptionTelemetry, eSeverityLevel
 } from "@microsoft/applicationinsights-common";
 import {
     BaseTelemetryPlugin, IAppInsightsCore, IPlugin, IProcessTelemetryContext, IProcessTelemetryUnloadContext, ITelemetryItem,
     ITelemetryPlugin, ITelemetryUnloadState, _eInternalMessageId, _throwInternal, _warnToConsole, arrForEach, dumpObj, eLoggingSeverity,
-    getExceptionName, hasOwnProperty, isObject, isUndefined
+    getExceptionName,  isUndefined, objForEachKey
 } from "@microsoft/applicationinsights-core-js";
 import { getGlobal, strShimUndefined } from "@microsoft/applicationinsights-shims";
 import { INativeDevice, IReactNativePluginConfig } from "./Interfaces";
+import { isPromiseLike, isString } from "@nevware21/ts-utils";
+import { IDeviceInfoModule } from "./Interfaces/IDeviceInfoModule";
+import { getReactNativeDeviceInfo } from "./DeviceInfo/ReactNativeDeviceInfo";
 
 declare var global: Window;
 
-/**
- * This is a helper function for the equivalent of arForEach(objKeys(target), callbackFn), this is a
- * performance optimization to avoid the creation of a new array for large objects
- * @param target The target object to find and process the keys
- * @param callbackfn The function to call with the details
- */
-export function objForEachKey(target: any, callbackfn: (name: string, value: any) => void) {
-    if (target && isObject(target)) {
-        for (let prop in target) {
-            if (hasOwnProperty(target, prop)) {
-                callbackfn.call(target, prop, target[prop]);
-            }
-        }
-    }
-}
-
 export class ReactNativePlugin extends BaseTelemetryPlugin {
 
     identifier: string = "AppInsightsReactNativePlugin";
@@ -51,6 +35,10 @@ export class ReactNativePlugin extends BaseTelemetryPlugin {
         let _config: IReactNativePluginConfig;
         let _analyticsPlugin: IAppInsights;
         let _defaultHandler;
+        let _waitingForId: boolean;
+        let _waitingTimer: number;
+        let _waitingItems: { item: ITelemetryItem, itemCtx?: IProcessTelemetryContext }[] = null;
+        let _deviceInfoModule: IDeviceInfoModule;
     
         dynamicProto(ReactNativePlugin, this, (_self, _base) => {
             _initDefaults();
@@ -78,13 +66,8 @@ export class ReactNativePlugin extends BaseTelemetryPlugin {
                         _self._collectDeviceInfo();
                     }
         
-                    if (extensions) {
-                        arrForEach(extensions, ext => {
-                            const identifier = (ext as ITelemetryPlugin).identifier;
-                            if (identifier === AnalyticsPluginIdentifier) {
-                                _analyticsPlugin = (ext as any) as IAppInsights;
-                            }
-                        });
+                    if (core && core.getPlugin) {
+                        _analyticsPlugin = core.getPlugin<any>(AnalyticsPluginIdentifier)?.plugin as IAppInsights;
                     }
         
                     if (!_config.disableExceptionCollection) {
@@ -94,13 +77,25 @@ export class ReactNativePlugin extends BaseTelemetryPlugin {
             };
 
             _self.processTelemetry = (item: ITelemetryItem, itemCtx?: IProcessTelemetryContext) => {
-                _applyDeviceContext(item);
-                _self.processNext(item, itemCtx);
+                if (!_waitingForId) {
+                    _applyDeviceContext(item);
+                    _self.processNext(item, itemCtx);
+                } else {
+                    // Make sure we have an array for the waiting items
+                    _waitingItems = _waitingItems || [];
+                    _waitingItems.push({
+                        item,
+                        itemCtx
+                    });
+                }
             };
         
-            _self.setDeviceId = (newId: string) => {
-                _device.id = newId;
+            _self.setDeviceInfoModule = (deviceInfoModule: IDeviceInfoModule) => {
+                // Set the configured deviceInfoModule
+                _deviceInfoModule = deviceInfoModule;
             };
+
+            _self.setDeviceId =_setDeviceId;
         
             _self.setDeviceModel = (newModel: string) => {
                 _device.model = newModel;
@@ -115,9 +110,30 @@ export class ReactNativePlugin extends BaseTelemetryPlugin {
              */
             _self._collectDeviceInfo = () => {
                 try {
-                    _device.deviceClass = DeviceInfo.getDeviceType();
-                    _device.id = DeviceInfo.getUniqueId(); // Installation ID
-                    _device.model = DeviceInfo.getModel();
+                    let deviceInfoModule = _deviceInfoModule || getReactNativeDeviceInfo();
+
+                    _device.deviceClass = deviceInfoModule.getDeviceType();
+                    _device.model = deviceInfoModule.getModel();
+                    let uniqueId = deviceInfoModule.getUniqueId(); // Installation ID support different versions which return a promise vs string
+                    if (isPromiseLike(uniqueId)) {
+                        _waitingForId = true;
+                        if (_waitingTimer) {
+                            clearTimeout(_waitingTimer);
+                        }
+                        _waitingTimer = setTimeout(() => {
+                            _waitingTimer = null;
+                            _setDeviceId(_device.id);
+                        });
+                        uniqueId.then((value) => {
+                            _setDeviceId(value);
+                        }, (reason) => {
+                            _warnToConsole(_self.diagLog(), "Failed to get device id: " + dumpObj(reason));
+                            // Just reuse the existing id (if any)
+                            _setDeviceId(_device.id);
+                        });
+                    } else if (isString(uniqueId)) {
+                        _device.id = uniqueId;
+                    }
                 } catch (e) {
                     _warnToConsole(_self.diagLog(), "Failed to get DeviceInfo: " + getExceptionName(e) + " - " + dumpObj(e));
                 }
@@ -133,19 +149,41 @@ export class ReactNativePlugin extends BaseTelemetryPlugin {
                 _config = config || _getDefaultConfig();
                 _analyticsPlugin = null;
                 _defaultHandler = null;
+                _waitingForId = false;
+                _deviceInfoModule = null;
+            }
+
+            function _setDeviceId(newId: string) {
+                _device.id = newId;
+                _waitingForId = false;
+                if (_waitingTimer) {
+                    clearTimeout(_waitingTimer);
+                }
+
+                if (!_waitingForId && _waitingItems && _waitingItems.length > 0 && _self.isInitialized()) {
+                    let items = _waitingItems;
+                    _waitingItems = null;
+                    arrForEach(items, (value) => {
+                        try {
+                            _self.processTelemetry(value.item, value.itemCtx);
+                        } catch (e) {
+                            // Just ignore
+                        }
+                    });
+                }
             }
 
             function _applyDeviceContext(item: ITelemetryItem) {
                 if (_device) {
                     item.ext = item.ext || {};
                     item.ext.device = item.ext.device || ({} as IDevice);
-                    if (typeof _device.id === "string") {
+                    if (isString(_device.id)) {
                         item.ext.device.localId = _device.id;
                     }
-                    if (typeof _device.model === "string") {
+                    if (isString(_device.model)) {
                         item.ext.device.model = _device.model;
                     }
-                    if (typeof _device.deviceClass === "string") {
+                    if (isString(_device.deviceClass)) {
                         item.ext.device.deviceClass = _device.deviceClass;
                     }
                 }
@@ -195,7 +233,7 @@ export class ReactNativePlugin extends BaseTelemetryPlugin {
             // Test Hooks
             (_self as any)._config = _config;
             (_self as any)._getDbgPlgTargets = () => {
-                return [_device];
+                return [_device, _deviceInfoModule];
             }
         });
 
@@ -203,7 +241,8 @@ export class ReactNativePlugin extends BaseTelemetryPlugin {
             return {
                 // enable auto collection by default
                 disableDeviceCollection: false,
-                disableExceptionCollection: false
+                disableExceptionCollection: false,
+                uniqueIdPromiseTimeout: 5000
             };
         }
     }
@@ -220,14 +259,43 @@ export class ReactNativePlugin extends BaseTelemetryPlugin {
         // @DynamicProtoStub -- DO NOT add any code as this will be removed during packaging
     }
 
+    /**
+     * Set the module that will be used during initialization when collecting device is enabled
+     * (the default), automatic collection can be disabled via the `disableDeviceCollection`
+     * config. The `react-native-device-info` module will be used by default if no
+     * `deviceInfoModule` is set and collection is enabled.
+     * @param deviceInfoModule
+     */
+    public setDeviceInfoModule(deviceInfoModule: IDeviceInfoModule) {
+        // @DynamicProtoStub -- DO NOT add any code as this will be removed during packaging
+    }
+
+    /**
+     * Manually set the deviceId, if set before initialization and automatic device info collection
+     * is enabled this value may get overwritten. If you want to keep this value disable auto
+     * collection by setting the `disableDeviceCollection` config to true.
+     * @param newId - The value to use as the device Id.
+     */
     public setDeviceId(newId: string) {
         // @DynamicProtoStub -- DO NOT add any code as this will be removed during packaging
     }
 
+    /**
+     * Manually set the device model, if set before initialization and automatic device info
+     * collection is enabled this value may get overwritten. If you want to keep this value
+     * disable auto collection by setting the `disableDeviceCollection` config to true.
+     * @param newModel - The value to use as the device model.
+     */
     public setDeviceModel(newModel: string) {
         // @DynamicProtoStub -- DO NOT add any code as this will be removed during packaging
     }
 
+    /**
+     * Manually set the device type (class), if set before initialization and automatic device
+     * info collection is enabled this value may get overwritten. If you want to keep this value
+     * disable auto collection by setting the `disableDeviceCollection` config to true.
+     * @param newType - The value to use as the device type
+     */
     public setDeviceType(newType: string) {
         // @DynamicProtoStub -- DO NOT add any code as this will be removed during packaging
     }

package/src/index.ts

@@ -1,4 +1,10 @@
-import {ReactNativePlugin} from "./ReactNativePlugin";
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+import { ReactNativePlugin } from "./ReactNativePlugin";
 import { INativeDevice, IReactNativePluginConfig } from "./Interfaces";
+import { IDeviceInfoModule } from "./Interfaces/IDeviceInfoModule";
+import { getReactNativeDeviceInfo } from "./DeviceInfo/ReactNativeDeviceInfo";
 
-export { ReactNativePlugin, INativeDevice, IReactNativePluginConfig };
+export { ReactNativePlugin, INativeDevice, IReactNativePluginConfig, IDeviceInfoModule };
+export { getReactNativeDeviceInfo };

package/types/DeviceInfo/DeviceModule.d.ts

@@ -0,0 +1,10 @@
+import { IDeviceInfoModule } from "../Interfaces/IDeviceInfoModule";
+export declare const DEVICE_MODEL = "model";
+export declare const DEVICE_TYPE = "type";
+export declare const UNIQUE_ID = "id";
+export declare class DeviceModule implements IDeviceInfoModule {
+    getModel: () => string;
+    getDeviceType: () => string;
+    getUniqueId: () => string | Promise<string>;
+    constructor();
+}

package/types/DeviceInfo/ReactNativeDeviceInfo.d.ts

@@ -0,0 +1,6 @@
+import { IDeviceInfoModule } from "../Interfaces/IDeviceInfoModule";
+/**
+ * Returns the "react-native-device-info" as the Device Info Module
+ * @returns
+ */
+export declare function getReactNativeDeviceInfo(): IDeviceInfoModule;

package/types/Interfaces/IDeviceInfoModule.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Interface to abstract how the plugin can access the Device Info, this is a stripped
+ * down version of the "react-native-device-info" interface and is mostly supplied for
+ * testing.
+ */
+export interface IDeviceInfoModule {
+    /**
+     * Returns the Device Model
+     */
+    getModel: () => string;
+    /**
+     * Returns the device type
+     */
+    getDeviceType: () => string;
+    /**
+     * Returns the unique Id for the device, to support both the current version and previous
+     * versions react-native-device-info, this may return either a `string` or `Promise<string>`,
+     * when a promise is returned the plugin will "wait" for the promise to `resolve` or `reject`
+     * before processing any events. This WILL cause telemetry to be BLOCKED until either of these
+     * states, so when returning a Promise it MUST `resolve` or `reject` it can't just never resolve.
+     * There is a default timeout configured via `uniqueIdPromiseTimeout` to automatically unblock
+     * event processing when this issue occurs.
+     */
+    getUniqueId: () => Promise<string> | string;
+}

package/types/Interfaces/IReactNativePluginConfig.d.ts

@@ -1,4 +1,15 @@
 export interface IReactNativePluginConfig {
+    /**
+     * Disable automatic device collection
+     */
     disableDeviceCollection?: boolean;
+    /**
+     * Disable automatic exception collection
+     */
     disableExceptionCollection?: boolean;
+    /**
+     * Timeout value to unblock the processing of events if the DeviceInfoModule
+     * returns a Promise.
+     */
+    uniqueIdPromiseTimeout?: number;
 }

package/types/ReactNativePlugin.d.ts

@@ -1,16 +1,6 @@
-/**
-* ReactNativePlugin.ts
-* @copyright Microsoft 2019
-*/
 import { BaseTelemetryPlugin, IAppInsightsCore, IPlugin, IProcessTelemetryContext, ITelemetryItem, ITelemetryPlugin } from "@microsoft/applicationinsights-core-js";
 import { IReactNativePluginConfig } from "./Interfaces";
-/**
- * This is a helper function for the equivalent of arForEach(objKeys(target), callbackFn), this is a
- * performance optimization to avoid the creation of a new array for large objects
- * @param target The target object to find and process the keys
- * @param callbackfn The function to call with the details
- */
-export declare function objForEachKey(target: any, callbackfn: (name: string, value: any) => void): void;
+import { IDeviceInfoModule } from "./Interfaces/IDeviceInfoModule";
 export declare class ReactNativePlugin extends BaseTelemetryPlugin {
     identifier: string;
     priority: number;
@@ -21,7 +11,33 @@ export declare class ReactNativePlugin extends BaseTelemetryPlugin {
     initialize(config?: IReactNativePluginConfig | object, // need `| object` to coerce to interface
     core?: IAppInsightsCore, extensions?: IPlugin[]): void;
     processTelemetry(env: ITelemetryItem, itemCtx?: IProcessTelemetryContext): void;
+    /**
+     * Set the module that will be used during initialization when collecting device is enabled
+     * (the default), automatic collection can be disabled via the `disableDeviceCollection`
+     * config. The `react-native-device-info` module will be used by default if no
+     * `deviceInfoModule` is set and collection is enabled.
+     * @param deviceInfoModule
+     */
+    setDeviceInfoModule(deviceInfoModule: IDeviceInfoModule): void;
+    /**
+     * Manually set the deviceId, if set before initialization and automatic device info collection
+     * is enabled this value may get overwritten. If you want to keep this value disable auto
+     * collection by setting the `disableDeviceCollection` config to true.
+     * @param newId - The value to use as the device Id.
+     */
     setDeviceId(newId: string): void;
+    /**
+     * Manually set the device model, if set before initialization and automatic device info
+     * collection is enabled this value may get overwritten. If you want to keep this value
+     * disable auto collection by setting the `disableDeviceCollection` config to true.
+     * @param newModel - The value to use as the device model.
+     */
     setDeviceModel(newModel: string): void;
+    /**
+     * Manually set the device type (class), if set before initialization and automatic device
+     * info collection is enabled this value may get overwritten. If you want to keep this value
+     * disable auto collection by setting the `disableDeviceCollection` config to true.
+     * @param newType - The value to use as the device type
+     */
     setDeviceType(newType: string): void;
 }

package/types/index.d.ts

@@ -1,3 +1,6 @@
 import { ReactNativePlugin } from "./ReactNativePlugin";
 import { INativeDevice, IReactNativePluginConfig } from "./Interfaces";
-export { ReactNativePlugin, INativeDevice, IReactNativePluginConfig };
+import { IDeviceInfoModule } from "./Interfaces/IDeviceInfoModule";
+import { getReactNativeDeviceInfo } from "./DeviceInfo/ReactNativeDeviceInfo";
+export { ReactNativePlugin, INativeDevice, IReactNativePluginConfig, IDeviceInfoModule };
+export { getReactNativeDeviceInfo };

package/types/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.28.6"
+      "packageVersion": "7.28.7"
     }
   ]
 }