@microsoft/applicationinsights-react-native 2.5.6 → 3.0.0

package/README.md

@@ -32,11 +32,53 @@ appInsights.loadAppInsights();
 You must be using a version `>=2.0.0` of `@microsoft/applicationinsights-web`. This plugin will only work in react-native apps, e.g. it will not work with `expo`.
 
 ## Device Information Collected
+
 By default, this plugin automatically collects
  - **Unique Device ID** (also known as Installation ID)
  - **Device Model Name** (iPhone XS, etc.)
  - **Device Type** (Handset, Tablet, etc.)
 
+## IDeviceInfoModule
+
+```typescript
+/**
+ * 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;
+}
+```
+
+If events are getting "blocked" because the `Promise` returned via `getUniqueId` is never resolved / rejected
+you can call `setDeviceId()` on the plugin to "unblock" this waiting state. There is also an automatic timeout
+configured via `uniqueIdPromiseTimeout` (defaults to 5 seconds), which will internally call `setDeviceId()` with
+any previously configured value.
+
+## Compatibility Matrix
+
+The [Compatibility Matrix](https://github.com/microsoft/applicationinsights-react-native#compatibility-maxtrix)
+is tracked and updated on the main project README.md page.
 ## Contributing
 
 This project welcomes contributions and suggestions. Most contributions require you to
@@ -56,11 +98,11 @@ or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any addi
 
 As this SDK is designed to enable applications to perform data collection which is sent to the Microsoft collection endpoints the following is required to identify our privacy statement.
 
-The software may collect information about you and your use of the software and send it to Microsoft. Microsoft may use this information to provide services and improve our products and services. You may turn off the telemetry as described in the repository. There are also some features in the software that may enable you and Microsoft to collect data from users of your applications. If you use these features, you must comply with applicable law, including providing appropriate notices to users of your applications together with a copy of Microsoft�s privacy statement. Our privacy statement is located at https://go.microsoft.com/fwlink/?LinkID=824704. You can learn more about data collection and use in the help documentation and our privacy statement. Your use of the software operates as your consent to these practices.
+The software may collect information about you and your use of the software and send it to Microsoft. Microsoft may use this information to provide services and improve our products and services. You may turn off the telemetry as described in the repository. There are also some features in the software that may enable you and Microsoft to collect data from users of your applications. If you use these features, you must comply with applicable law, including providing appropriate notices to users of your applications together with a copy of Microsoft�s privacy statement. Our privacy statement is located at https://go.microsoft.com/fwlink/?LinkID=824704. You can learn more about data collection and use in the help documentation and our privacy statement. Your use of the software operates as your consent to these practices.
 
 ## Trademarks
 
-This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow [Microsoft�s Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general). Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party�s policies.
+This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow [Microsoft�s Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general). Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party�s policies.
 
 ## License
 

package/browser/applicationinsights-react-native.js

@@ -1,5 +1,5 @@
 /*!
- * Application Insights JavaScript SDK - React Native Plugin, 2.5.6
+ * Application Insights JavaScript SDK - React Native Plugin, 3.0.0
  * Copyright (c) Microsoft and contributors. All rights reserved.
  */
 (function (global, factory) {
@@ -410,18 +410,15 @@
     function isNullOrUndefined(value) {
         return (value === null || isUndefined(value));
     }
-    function hasOwnProperty(obj, prop) {
-        return !!(obj && ObjHasOwnProperty[_DYN_CALL ](obj, prop));
-    }
     function isObject(value) {
         return !!(value && typeof value === strShimObject);
     }
-    function isFunction(value) {
+    function isFunction$1(value) {
         return !!(value && typeof value === strShimFunction);
     }
     function normalizeJsName(name) {
         var value = name;
-        if (value && isString(value)) {
+        if (value && isString$1(value)) {
             value = value[_DYN_REPLACE ](rCamelCase, function (_all, letter) {
                 return letter.toUpperCase();
             });
@@ -432,7 +429,7 @@
         }
         return value;
     }
-    function objForEachKey$1(target, callbackfn) {
+    function objForEachKey(target, callbackfn) {
         if (target) {
             for (var prop in target) {
                 if (ObjHasOwnProperty[_DYN_CALL ](target, prop)) {
@@ -454,7 +451,7 @@
     function isError(obj) {
         return !!(obj && _objToString[_DYN_CALL ](obj) === "[object Error]");
     }
-    function isString(value) {
+    function isString$1(value) {
         return typeof value === "string";
     }
     function isBoolean(value) {
@@ -542,7 +539,7 @@
     function _createProxyFunction(source, funcName) {
         var srcFunc = null;
         var src = null;
-        if (isFunction(source)) {
+        if (isFunction$1(source)) {
             srcFunc = source;
         }
         else {
@@ -716,7 +713,7 @@
             if (theConsole[func]) {
                 logFunc = func;
             }
-            if (isFunction(theConsole[logFunc])) {
+            if (isFunction$1(theConsole[logFunc])) {
                 theConsole[logFunc](message);
             }
         }
@@ -873,10 +870,10 @@
             _self[_DYN_NAME ] = name;
             _self[_DYN_IS_ASYNC ] = isAsync;
             _self[_DYN_IS_CHILD_EVT ] = function () { return false; };
-            if (isFunction(payloadDetails)) {
+            if (isFunction$1(payloadDetails)) {
                 var theDetails_1;
                 accessorDefined = objDefineAccessors(_self, "payload", function () {
-                    if (!theDetails_1 && isFunction(payloadDetails)) {
+                    if (!theDetails_1 && isFunction$1(payloadDetails)) {
                         theDetails_1 = payloadDetails();
                         payloadDetails = null;
                     }
@@ -923,7 +920,7 @@
                 _self[_DYN_TIME ] = dateNow() - _self.start;
                 _self.exTime = _self[_DYN_TIME ] - childTime;
                 _self[_DYN_COMPLETE ] = function () { };
-                if (!accessorDefined && isFunction(payloadDetails)) {
+                if (!accessorDefined && isFunction$1(payloadDetails)) {
                     _self.payload = payloadDetails();
                 }
             };
@@ -1216,7 +1213,7 @@
                 if (mergeDefault !== 0 ) {
                     var newConfig_1 = objExtend(true, defaultValue, theConfig);
                     if (config && mergeDefault === 2 ) {
-                        objForEachKey$1(defaultValue, function (field) {
+                        objForEachKey(defaultValue, function (field) {
                             if (isNullOrUndefined(newConfig_1[field])) {
                                 var cfgValue = config[field];
                                 if (!isNullOrUndefined(cfgValue)) {
@@ -1298,7 +1295,7 @@
         var context = internalContext.ctx;
         function _processNext(updateState) {
             return context.iterate(function (plugin) {
-                if (isFunction(plugin[_DYN_UPDATE ])) {
+                if (isFunction$1(plugin[_DYN_UPDATE ])) {
                     plugin[_DYN_UPDATE ](context, updateState);
                 }
             });
@@ -1323,7 +1320,7 @@
                 if (!add && startAt === thePlugin) {
                     add = true;
                 }
-                if (add && thePlugin && isFunction(thePlugin[STR_PROCESS_TELEMETRY ])) {
+                if (add && thePlugin && isFunction$1(thePlugin[STR_PROCESS_TELEMETRY ])) {
                     var newProxy = createTelemetryPluginProxy(thePlugin, config, core);
                     if (!firstProxy) {
                         firstProxy = newProxy;
@@ -1342,8 +1339,8 @@
     }
     function createTelemetryPluginProxy(plugin, config, core) {
         var nextProxy = null;
-        var hasProcessTelemetry = isFunction(plugin[STR_PROCESS_TELEMETRY ]);
-        var hasSetNext = isFunction(plugin[_DYN_SET_NEXT_PLUGIN ]);
+        var hasProcessTelemetry = isFunction$1(plugin[STR_PROCESS_TELEMETRY ]);
+        var hasSetNext = isFunction$1(plugin[_DYN_SET_NEXT_PLUGIN ]);
         var chainId;
         if (plugin) {
             chainId = plugin[_DYN_IDENTIFIER ] + "-" + plugin[STR_PRIORITY ] + "-" + _chainId++;
@@ -1368,7 +1365,7 @@
         };
         function _getTelCtx() {
             var itemCtx;
-            if (plugin && isFunction(plugin[strGetTelCtx])) {
+            if (plugin && isFunction$1(plugin[strGetTelCtx])) {
                 itemCtx = plugin[strGetTelCtx]();
             }
             if (!itemCtx) {
@@ -1598,7 +1595,7 @@
                 if (itemCtx) {
                     itemCtx[_DYN_PROCESS_NEXT ](env);
                 }
-                else if (_nextPlugin && isFunction(_nextPlugin[STR_PROCESS_TELEMETRY ])) {
+                else if (_nextPlugin && isFunction$1(_nextPlugin[STR_PROCESS_TELEMETRY ])) {
                     _nextPlugin[STR_PROCESS_TELEMETRY ](env, null);
                 }
             };
@@ -1665,15 +1662,24 @@
 
     var AnalyticsPluginIdentifier = "ApplicationInsightsAnalytics";
 
-    function objForEachKey(target, callbackfn) {
-        if (target && isObject(target)) {
-            for (var prop in target) {
-                if (hasOwnProperty(target, prop)) {
-                    callbackfn.call(target, prop, target[prop]);
-                }
-            }
-        }
+    var FUNCTION = "function";
+    var STRING = "string";
+
+    function _createIs(theType) {
+        return function (value) {
+            return typeof value === theType;
+        };
     }
+    var isString = _createIs(STRING);
+    var isFunction = _createIs(FUNCTION);
+    function isPromiseLike(value) {
+        return !!value && isFunction(value.then);
+    }
+
+    function getReactNativeDeviceInfo() {
+        return DeviceInfo__default["default"];
+    }
+
     var ReactNativePlugin = /** @class */ (function (_super) {
         __extendsFn(ReactNativePlugin, _super);
         function ReactNativePlugin(config) {
@@ -1684,10 +1690,15 @@
             var _config;
             var _analyticsPlugin;
             var _defaultHandler;
+            var _waitingForId;
+            var _waitingTimer;
+            var _waitingItems = null;
+            var _deviceInfoModule;
             dynamicProto(ReactNativePlugin, _this, function (_self, _base) {
                 _initDefaults();
                 _self.initialize = function (config,
                 core, extensions) {
+                    var _a;
                     if (!_self.isInitialized()) {
                         _base.initialize(config, core, extensions);
                         var inConfig_1 = config || {};
@@ -1698,13 +1709,8 @@
                         if (!_config.disableDeviceCollection) {
                             _self._collectDeviceInfo();
                         }
-                        if (extensions) {
-                            arrForEach(extensions, function (ext) {
-                                var identifier = ext.identifier;
-                                if (identifier === AnalyticsPluginIdentifier) {
-                                    _analyticsPlugin = ext;
-                                }
-                            });
+                        if (core && core.getPlugin) {
+                            _analyticsPlugin = (_a = core.getPlugin(AnalyticsPluginIdentifier)) === null || _a === void 0 ? void 0 : _a.plugin;
                         }
                         if (!_config.disableExceptionCollection) {
                             _self._setExceptionHandler();
@@ -1712,12 +1718,22 @@
                     }
                 };
                 _self.processTelemetry = function (item, itemCtx) {
-                    _applyDeviceContext(item);
-                    _self.processNext(item, itemCtx);
+                    if (!_waitingForId) {
+                        _applyDeviceContext(item);
+                        _self.processNext(item, itemCtx);
+                    }
+                    else {
+                        _waitingItems = _waitingItems || [];
+                        _waitingItems.push({
+                            item: item,
+                            itemCtx: itemCtx
+                        });
+                    }
                 };
-                _self.setDeviceId = function (newId) {
-                    _device.id = newId;
+                _self.setDeviceInfoModule = function (deviceInfoModule) {
+                    _deviceInfoModule = deviceInfoModule;
                 };
+                _self.setDeviceId = _setDeviceId;
                 _self.setDeviceModel = function (newModel) {
                     _device.model = newModel;
                 };
@@ -1726,9 +1742,29 @@
                 };
                 _self._collectDeviceInfo = function () {
                     try {
-                        _device.deviceClass = DeviceInfo__default["default"].getDeviceType();
-                        _device.id = DeviceInfo__default["default"].getUniqueId();
-                        _device.model = DeviceInfo__default["default"].getModel();
+                        var deviceInfoModule = _deviceInfoModule || getReactNativeDeviceInfo();
+                        _device.deviceClass = deviceInfoModule.getDeviceType();
+                        _device.model = deviceInfoModule.getModel();
+                        var uniqueId = deviceInfoModule.getUniqueId();
+                        if (isPromiseLike(uniqueId)) {
+                            _waitingForId = true;
+                            if (_waitingTimer) {
+                                clearTimeout(_waitingTimer);
+                            }
+                            _waitingTimer = setTimeout(function () {
+                                _waitingTimer = null;
+                                _setDeviceId(_device.id);
+                            });
+                            uniqueId.then(function (value) {
+                                _setDeviceId(value);
+                            }, function (reason) {
+                                _warnToConsole(_self.diagLog(), "Failed to get device id: " + dumpObj(reason));
+                                _setDeviceId(_device.id);
+                            });
+                        }
+                        else if (isString(uniqueId)) {
+                            _device.id = uniqueId;
+                        }
                     }
                     catch (e) {
                         _warnToConsole(_self.diagLog(), "Failed to get DeviceInfo: " + getExceptionName(e) + " - " + dumpObj(e));
@@ -1743,18 +1779,38 @@
                     _config = config || _getDefaultConfig();
                     _analyticsPlugin = null;
                     _defaultHandler = null;
+                    _waitingForId = false;
+                    _deviceInfoModule = null;
+                }
+                function _setDeviceId(newId) {
+                    _device.id = newId;
+                    _waitingForId = false;
+                    if (_waitingTimer) {
+                        clearTimeout(_waitingTimer);
+                    }
+                    if (!_waitingForId && _waitingItems && _waitingItems.length > 0 && _self.isInitialized()) {
+                        var items = _waitingItems;
+                        _waitingItems = null;
+                        arrForEach(items, function (value) {
+                            try {
+                                _self.processTelemetry(value.item, value.itemCtx);
+                            }
+                            catch (e) {
+                            }
+                        });
+                    }
                 }
                 function _applyDeviceContext(item) {
                     if (_device) {
                         item.ext = item.ext || {};
                         item.ext.device = item.ext.device || {};
-                        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;
                         }
                     }
@@ -1792,13 +1848,14 @@
                 }
                 _self._config = _config;
                 _self._getDbgPlgTargets = function () {
-                    return [_device];
+                    return [_device, _deviceInfoModule];
                 };
             });
             function _getDefaultConfig() {
                 return {
                     disableDeviceCollection: false,
-                    disableExceptionCollection: false
+                    disableExceptionCollection: false,
+                    uniqueIdPromiseTimeout: 5000
                 };
             }
             return _this;
@@ -1808,6 +1865,7 @@
     }(BaseTelemetryPlugin));
 
     exports.ReactNativePlugin = ReactNativePlugin;
+    exports.getReactNativeDeviceInfo = getReactNativeDeviceInfo;
 
     Object.defineProperty(exports, '__esModule', { value: true });