@microsoft/applicationinsights-common 3.0.0-beta.2303-02 → 3.0.0-beta.2303-03

package/dist/applicationinsights-common.api.json

@@ -13918,7 +13918,7 @@
             {
               "kind": "PropertySignature",
               "canonicalReference": "@microsoft/applicationinsights-common!IThrottleMgrConfig#limit:member",
-              "docComment": "/**\n * Identifies limit number/percentage of items sent per time\n */\n",
+              "docComment": "/**\n * Identifies limit number/percentage of items sent per time Default: sampling percentage 0.01% with one item sent per time\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -13946,11 +13946,11 @@
             {
               "kind": "PropertySignature",
               "canonicalReference": "@microsoft/applicationinsights-common!IThrottleMgrConfig#msgKey:member",
-              "docComment": "/**\n * Identifies message key to be used for local storage key\n */\n",
+              "docComment": "/**\n * Identifies message key to be used for local storage key Default: IThrottleMsgKey.default\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
-                  "text": "msgKey: "
+                  "text": "msgKey?: "
                 },
                 {
                   "kind": "Reference",
@@ -13963,7 +13963,7 @@
                 }
               ],
               "isReadonly": false,
-              "isOptional": false,
+              "isOptional": true,
               "releaseTag": "Public",
               "name": "msgKey",
               "propertyTypeTokenRange": {
@@ -13992,7 +13992,7 @@
             {
               "kind": "EnumMember",
               "canonicalReference": "@microsoft/applicationinsights-common!IThrottleMsgKey.cdnDeprecate:member",
-              "docComment": "",
+              "docComment": "/**\n * Message key for cdn Deprecation\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -14013,7 +14013,7 @@
             {
               "kind": "EnumMember",
               "canonicalReference": "@microsoft/applicationinsights-common!IThrottleMsgKey.default:member",
-              "docComment": "",
+              "docComment": "/**\n * Default Message key for non pre-defined message\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -14034,7 +14034,7 @@
             {
               "kind": "EnumMember",
               "canonicalReference": "@microsoft/applicationinsights-common!IThrottleMsgKey.ikeyDeprecate:member",
-              "docComment": "",
+              "docComment": "/**\n * Message key for ikey Deprecation\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -17895,7 +17895,7 @@
               "excerptTokens": [
                 {
                   "kind": "Content",
-                  "text": "constructor(throttleMgr?: "
+                  "text": "constructor(config?: "
                 },
                 {
                   "kind": "Reference",
@@ -17919,6 +17919,15 @@
                   "kind": "Content",
                   "text": "string"
                 },
+                {
+                  "kind": "Content",
+                  "text": ", unloadHookContainer?: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "IUnloadHookContainer",
+                  "canonicalReference": "@microsoft/applicationinsights-core-js!IUnloadHookContainer:interface"
+                },
                 {
                   "kind": "Content",
                   "text": ");"
@@ -17929,7 +17938,7 @@
               "overloadIndex": 1,
               "parameters": [
                 {
-                  "parameterName": "throttleMgr",
+                  "parameterName": "config",
                   "parameterTypeTokenRange": {
                     "startIndex": 1,
                     "endIndex": 2
@@ -17951,6 +17960,14 @@
                     "endIndex": 6
                   },
                   "isOptional": true
+                },
+                {
+                  "parameterName": "unloadHookContainer",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 7,
+                    "endIndex": 8
+                  },
+                  "isOptional": true
                 }
               ]
             },
@@ -17984,6 +18001,37 @@
               "isProtected": false,
               "isAbstract": false
             },
+            {
+              "kind": "Property",
+              "canonicalReference": "@microsoft/applicationinsights-common!ThrottleMgr#config:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "config: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "IThrottleMgrConfig",
+                  "canonicalReference": "@microsoft/applicationinsights-common!IThrottleMgrConfig:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "config",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            },
             {
               "kind": "Property",
               "canonicalReference": "@microsoft/applicationinsights-common!ThrottleMgr#flush:member",

package/dist/applicationinsights-common.api.md

@@ -25,6 +25,7 @@ import { isValidTraceId } from '@microsoft/applicationinsights-core-js';
 import { isValidTraceParent } from '@microsoft/applicationinsights-core-js';
 import { ITelemetryItem } from '@microsoft/applicationinsights-core-js';
 import { ITraceParent } from '@microsoft/applicationinsights-core-js';
+import { IUnloadHookContainer } from '@microsoft/applicationinsights-core-js';
 import { parseTraceParent } from '@microsoft/applicationinsights-core-js';
 
 // @public
@@ -865,16 +866,13 @@ export interface IThrottleMgrConfig {
     disabled?: boolean;
     interval?: IThrottleInterval;
     limit?: IThrottleLimit;
-    msgKey: IThrottleMsgKey;
+    msgKey?: IThrottleMsgKey;
 }
 
 // @public (undocumented)
 export const enum IThrottleMsgKey {
-    // (undocumented)
     cdnDeprecate = 2,
-    // (undocumented)
     default = 0,
-    // (undocumented)
     ikeyDeprecate = 1
 }
 
@@ -1131,10 +1129,12 @@ export class TelemetryItemCreator {
 
 // @public (undocumented)
 export class ThrottleMgr {
-    constructor(throttleMgr?: IThrottleMgrConfig, core?: IAppInsightsCore, namePrefix?: string);
+    constructor(config?: IThrottleMgrConfig, core?: IAppInsightsCore, namePrefix?: string, unloadHookContainer?: IUnloadHookContainer);
     // (undocumented)
     canThrottle: () => boolean;
     // (undocumented)
+    config: IThrottleMgrConfig;
+    // (undocumented)
     flush: () => boolean;
     // (undocumented)
     getConfig: () => IThrottleMgrConfig;

package/dist/applicationinsights-common.d.ts

@@ -1,5 +1,5 @@
 /*
- * Microsoft Application Insights Common JavaScript Library, 3.0.0-beta.2303-02
+ * Microsoft Application Insights Common JavaScript Library, 3.0.0-beta.2303-03
  * Copyright (c) Microsoft and contributors. All rights reserved.
  *
  * Microsoft Application Insights Team
@@ -28,6 +28,7 @@ declare namespace ApplicationInsights {
     import { isValidTraceParent } from '@microsoft/applicationinsights-core-js';
     import { ITelemetryItem } from '@microsoft/applicationinsights-core-js';
     import { ITraceParent } from '@microsoft/applicationinsights-core-js';
+    import { IUnloadHookContainer } from '@microsoft/applicationinsights-core-js';
     import { parseTraceParent } from '@microsoft/applicationinsights-core-js';
 
     /**
@@ -2022,8 +2023,9 @@ declare namespace ApplicationInsights {
     interface IThrottleMgrConfig {
         /**
          * Identifies message key to be used for local storage key
+         * Default: IThrottleMsgKey.default
          */
-        msgKey: IThrottleMsgKey;
+        msgKey?: IThrottleMsgKey;
         /**
          * Identifies if throttle is disabled
          * Default: false
@@ -2031,6 +2033,7 @@ declare namespace ApplicationInsights {
         disabled?: boolean;
         /**
          * Identifies limit number/percentage of items sent per time
+         * Default: sampling percentage 0.01% with one item sent per time
          */
         limit?: IThrottleLimit;
         /**
@@ -2041,8 +2044,17 @@ declare namespace ApplicationInsights {
     }
 
     const enum IThrottleMsgKey {
+        /**
+         * Default Message key for non pre-defined message
+         */
         default = 0,
+        /**
+         * Message key for ikey Deprecation
+         */
         ikeyDeprecate = 1,
+        /**
+         * Message key for cdn Deprecation
+         */
         cdnDeprecate = 2
     }
 
@@ -2459,7 +2471,8 @@ declare namespace ApplicationInsights {
         isReady: () => boolean;
         onReadyState: (isReady?: boolean) => boolean;
         flush: () => boolean;
-        constructor(throttleMgr?: IThrottleMgrConfig, core?: IAppInsightsCore, namePrefix?: string);
+        config: IThrottleMgrConfig;
+        constructor(config?: IThrottleMgrConfig, core?: IAppInsightsCore, namePrefix?: string, unloadHookContainer?: IUnloadHookContainer);
     }
 
     class Trace implements IMessageData, ISerializable {

package/dist/applicationinsights-common.js

@@ -1,5 +1,5 @@
 /*!
- * Application Insights JavaScript SDK - Common, 3.0.0-beta.2303-02
+ * Application Insights JavaScript SDK - Common, 3.0.0-beta.2303-03
  * Copyright (c) Microsoft and contributors. All rights reserved.
  */
 (function (global, factory) {
@@ -28,6 +28,7 @@
     var POLYFILL_TAG = "_polyfill";
     var INDEX_OF = "indexOf";
     var LENGTH = "length";
+    var DONE = "done";
     var VALUE = "value";
     var NAME = "name";
     var ObjClass$1 = Object;
@@ -403,6 +404,27 @@
         (!_symbolFor || (_globalLazyTestHooks.lzy && !_symbol.b)) && getSymbol();
         return (_symbolFor.v || polySymbolFor)(key);
     }
+    function isIterator(value) {
+        return !!value && isFunction(value.next);
+    }
+    function arrAppend(target, elms) {
+        if (!isUndefined(elms) && target) {
+            if (isArray(elms)) {
+                target.push.apply(target, elms);
+            }
+            else if (isIterator(elms)) {
+                var value = elms.next();
+                while (!value[DONE]) {
+                    target.push(value[VALUE]);
+                    value = elms.next();
+                }
+            }
+            else {
+                target.push(elms);
+            }
+        }
+        return target;
+    }
     function arrForEach(theArray, callbackfn, thisArg) {
         if (theArray) {
             var len = theArray[LENGTH] >>> 0;
@@ -1019,6 +1041,7 @@
     var STR_EMPTY = "";
     var STR_ERROR_TO_CONSOLE = "errorToConsole";
     var STR_WARN_TO_CONSOLE = "warnToConsole";
+    var STR_NOT_DYNAMIC_ERROR = "Not dynamic - ";
 
     var rCamelCase = /-([a-z])/g;
     var rNormalizeInvalid = /([^\w\d_$])/g;
@@ -1217,7 +1240,7 @@
         return result;
     }
 
-    var version = "3.0.0-beta.2303-02";
+    var version = "3.0.0-beta.2303-03";
     var instanceName = "." + newId(6);
     var _dataUid = 0;
     function createUniqueNamespace(name, includeVersion) {
@@ -1722,6 +1745,15 @@
         _makeDynamicObject(theState, newTarget);
         return cfgHandler;
     }
+    function _logInvalidAccess(logger, message) {
+        if (logger) {
+            logger[STR_WARN_TO_CONSOLE ](message);
+            logger[_DYN_THROW_INTERNAL ](2 , 108 , message);
+        }
+        else {
+            throwInvalidAccess(message);
+        }
+    }
     function createDynamicConfig(config, defaultConfig, logger, inPlace) {
         var dynamicHandler = _createDynamicHandler(logger, config || {}, inPlace);
         if (defaultConfig) {
@@ -1729,6 +1761,14 @@
         }
         return dynamicHandler;
     }
+    function onConfigChange(config, configHandler, logger) {
+        var handler = config[CFG_HANDLER_LINK] || config;
+        if (handler.cfg && (handler.cfg === config || handler.cfg[CFG_HANDLER_LINK] === handler)) {
+            return handler[_DYN_WATCH ](configHandler);
+        }
+        _logInvalidAccess(logger, STR_NOT_DYNAMIC_ERROR + dumpObj(config));
+        createDynamicConfig(config, null, logger)[_DYN_WATCH ](configHandler);
+    }
 
     var _aiNamespace = null;
     function _getExtensionNamespace() {
@@ -2044,6 +2084,31 @@
         return traceParent;
     }
 
+    function createUnloadHookContainer() {
+        var _hooks = [];
+        function _doUnload(logger) {
+            var oldHooks = _hooks;
+            _hooks = [];
+            arrForEach(oldHooks, function (fn) {
+                try {
+                    (fn.rm || fn.remove).call(fn);
+                }
+                catch (e) {
+                    _throwInternal(logger, 2 , 73 , "Unloading:" + dumpObj(e));
+                }
+            });
+        }
+        function _addHook(hooks) {
+            if (hooks) {
+                arrAppend(_hooks, hooks);
+            }
+        }
+        return {
+            run: _doUnload,
+            add: _addHook
+        };
+    }
+
     var DisabledPropertyName = "Microsoft_ApplicationInsights_BypassAjaxInstrumentation";
     var SampleRate = "sampleRate";
     var ProcessLegacy = "ProcessLegacy";
@@ -2606,7 +2671,7 @@
 
     var THROTTLE_STORAGE_PREFIX = "appInsightsThrottle";
     var ThrottleMgr = /** @class */ (function () {
-        function ThrottleMgr(throttleMgr, core, namePrefix) {
+        function ThrottleMgr(config, core, namePrefix, unloadHookContainer) {
             var _self = this;
             var _canUseLocalStorage;
             var _logger;
@@ -2619,6 +2684,9 @@
             var _isReady = false;
             var _isSpecificDaysGiven = false;
             _initConfig();
+            _self["_getDbgPlgTargets"] = function () {
+                return [_queue];
+            };
             _self.getConfig = function () {
                 return _config;
             };
@@ -2634,8 +2702,10 @@
             _self.flush = function () {
                 try {
                     if (_isReady && _queue[_DYN_LENGTH ] > 0) {
-                        arrForEach(_queue, function (item) {
-                            _self.sendMessage(item.msgID, item[_DYN_MESSAGE ], item.severity);
+                        var items = _queue.slice(0);
+                        _queue = [];
+                        arrForEach(items, function (item) {
+                            _flushMessage(item.msgID, item[_DYN_MESSAGE ], item.severity, false);
                         });
                         return true;
                     }
@@ -2649,6 +2719,9 @@
                 return _self.flush();
             };
             _self.sendMessage = function (msgID, message, severity) {
+                return _flushMessage(msgID, message, severity, true);
+            };
+            function _flushMessage(msgID, message, severity, saveUnsentMsg) {
                 if (_isReady) {
                     var isSampledIn = _canSampledIn();
                     if (!isSampledIn) {
@@ -2682,40 +2755,47 @@
                     };
                 }
                 else {
-                    _queue.push({
-                        msgID: msgID,
-                        message: message,
-                        severity: severity
-                    });
+                    if (!!saveUnsentMsg) {
+                        _queue.push({
+                            msgID: msgID,
+                            message: message,
+                            severity: severity
+                        });
+                    }
                 }
                 return null;
-            };
+            }
             function _initConfig() {
-                var _a, _b;
-                _canUseLocalStorage = utlCanUseLocalStorage();
                 _logger = safeGetLogger(core);
                 _isTriggered = false;
-                _namePrefix = isNotNullOrUndefined(namePrefix) ? namePrefix : "";
                 _queue = [];
-                var configMgr = throttleMgr;
-                _config = {};
-                _config[_DYN_DISABLED ] = !!configMgr[_DYN_DISABLED ];
-                _config.msgKey = configMgr.msgKey;
-                var configInterval = configMgr[_DYN_INTERVAL ] || {};
-                _isSpecificDaysGiven = (configInterval === null || configInterval === void 0 ? void 0 : configInterval.daysOfMonth) && (configInterval === null || configInterval === void 0 ? void 0 : configInterval.daysOfMonth[_DYN_LENGTH ]) > 0;
-                _config[_DYN_INTERVAL ] = _getIntervalConfig(configInterval);
-                var limit = {
-                    samplingRate: ((_a = configMgr.limit) === null || _a === void 0 ? void 0 : _a.samplingRate) || 100,
-                    maxSendNumber: ((_b = configMgr.limit) === null || _b === void 0 ? void 0 : _b.maxSendNumber) || 1
-                };
-                _config.limit = limit;
-                _localStorageName = _getLocalStorageName(_config.msgKey, _namePrefix);
-                if (_canUseLocalStorage && _localStorageName) {
-                    _localStorageObj = _getLocalStorageObj(utlGetLocalStorage(_logger, _localStorageName), _logger, _localStorageName);
-                }
-                if (_localStorageObj) {
-                    _isTriggered = _isTriggeredOnCurDate(_localStorageObj[_DYN_PRE_TRIGGER_DATE ]);
-                }
+                _namePrefix = isNotNullOrUndefined(namePrefix) ? namePrefix : "";
+                unloadHookContainer = unloadHookContainer || createUnloadHookContainer();
+                config = createDynamicConfig(config || {}, null, _logger).cfg;
+                var unloadHook = onConfigChange((config), function () {
+                    var _a, _b;
+                    _canUseLocalStorage = utlCanUseLocalStorage();
+                    var configMgr = config || {};
+                    _config = {};
+                    _config[_DYN_DISABLED ] = !!configMgr[_DYN_DISABLED ];
+                    _config.msgKey = configMgr.msgKey || 0 ;
+                    var configInterval = configMgr[_DYN_INTERVAL ] || {};
+                    _isSpecificDaysGiven = (configInterval === null || configInterval === void 0 ? void 0 : configInterval.daysOfMonth) && (configInterval === null || configInterval === void 0 ? void 0 : configInterval.daysOfMonth[_DYN_LENGTH ]) > 0;
+                    _config[_DYN_INTERVAL ] = _getIntervalConfig(configInterval);
+                    var limit = {
+                        samplingRate: ((_a = configMgr.limit) === null || _a === void 0 ? void 0 : _a.samplingRate) || 100,
+                        maxSendNumber: ((_b = configMgr.limit) === null || _b === void 0 ? void 0 : _b.maxSendNumber) || 1
+                    };
+                    _config.limit = limit;
+                    _localStorageName = _getLocalStorageName(_config.msgKey, _namePrefix);
+                    if (_canUseLocalStorage && _localStorageName) {
+                        _localStorageObj = _getLocalStorageObj(utlGetLocalStorage(_logger, _localStorageName), _logger, _localStorageName);
+                    }
+                    if (_localStorageObj) {
+                        _isTriggered = _isTriggeredOnCurDate(_localStorageObj[_DYN_PRE_TRIGGER_DATE ]);
+                    }
+                });
+                unloadHookContainer && unloadHookContainer.add(unloadHook);
             }
             function _getIntervalConfig(interval) {
                 interval = interval || {};
@@ -2825,6 +2905,9 @@
                 return false;
             }
             function _checkInterval(interval, start, current) {
+                if (interval <= 0) {
+                    return 1;
+                }
                 return (current >= start) && (current - start) % interval == 0 ? Math.floor((current - start) / interval) + 1 : -1;
             }
             function _sendMessage(msgID, logger, message, severity) {