@microsoft/applicationinsights-core-js 2.8.0-nightly.2202-06 → 2.8.0-nightly.2204-06

package/types/JavaScriptSDK.Interfaces/ITelemetryPlugin.d.ts

@@ -1,12 +1,11 @@
 import { ITelemetryItem } from "./ITelemetryItem";
 import { IConfiguration } from "./IConfiguration";
 import { IAppInsightsCore } from "./IAppInsightsCore";
-import { IProcessTelemetryContext } from "./IProcessTelemetryContext";
+import { IProcessTelemetryContext, IProcessTelemetryUnloadContext, IProcessTelemetryUpdateContext } from "./IProcessTelemetryContext";
 import { ITelemetryPluginChain } from "./ITelemetryPluginChain";
-/**
- * Configuration provided to SDK core
- */
-export interface ITelemetryPlugin extends IPlugin {
+import { ITelemetryUnloadState } from "./ITelemetryUnloadState";
+import { ITelemetryUpdateState } from "./ITelemetryUpdateState";
+export interface ITelemetryProcessor {
     /**
      * Call back for telemetry processing before it it is sent
      * @param env - This is the current event being reported
@@ -15,6 +14,20 @@ export interface ITelemetryPlugin extends IPlugin {
      * to later plugins (vs appending items to the telemetry item)
      */
     processTelemetry: (env: ITelemetryItem, itemCtx?: IProcessTelemetryContext) => void;
+    /**
+     * The the plugin should re-evaluate configuration and update any cached configuration settings or
+     * plugins. If implemented this method will be called whenever a plugin is added or removed and if
+     * the configuration has bee updated.
+     * @param updateCtx - This is the context that should be used during updating.
+     * @param updateState - The details / state of the update process, it holds details like the current and previous configuration.
+     * @returns boolean - true if the plugin has or will call updateCtx.processNext(), this allows the plugin to perform any asynchronous operations.
+     */
+    update?: (updateCtx: IProcessTelemetryUpdateContext, updateState: ITelemetryUpdateState) => void | boolean;
+}
+/**
+ * Configuration provided to SDK core
+ */
+export interface ITelemetryPlugin extends ITelemetryProcessor, IPlugin {
     /**
      * Set next extension for telemetry processing, this is not optional as plugins should use the
      * processNext() function of the passed IProcessTelemetryContext instead. It is being kept for
@@ -42,10 +55,14 @@ export interface IPlugin {
      */
     isInitialized?: () => boolean;
     /**
-     * Tear down the plugin and remove any hooked value, the plugin should remove that it is no longer initialized and
-     * therefore can be re-initialized after being torn down.
+     * Tear down the plugin and remove any hooked value, the plugin should be removed so that it is no longer initialized and
+     * therefore could be re-initialized after being torn down. The plugin should ensure that once this has been called any further
+     * processTelemetry calls are ignored and it just calls the processNext() with the provided context.
+     * @param unloadCtx - This is the context that should be used during unloading.
+     * @param unloadState - The details / state of the unload process, it holds details like whether it should be unloaded synchronously or asynchronously and the reason for the unload.
+     * @returns boolean - true if the plugin has or will call processNext(), this for backward compatibility as previously teardown was synchronous and returned nothing.
      */
-    teardown?: () => void;
+    teardown?: (unloadCtx: IProcessTelemetryUnloadContext, unloadState?: ITelemetryUnloadState) => void | boolean;
     /**
      * Extension name
      */

package/types/JavaScriptSDK.Interfaces/ITelemetryPluginChain.d.ts

@@ -1,10 +1,10 @@
-import { ITelemetryItem } from "./ITelemetryItem";
-import { IProcessTelemetryContext } from "./IProcessTelemetryContext";
-import { ITelemetryPlugin } from "./ITelemetryPlugin";
+import { IProcessTelemetryUnloadContext } from "./IProcessTelemetryContext";
+import { ITelemetryPlugin, ITelemetryProcessor } from "./ITelemetryPlugin";
+import { ITelemetryUnloadState } from "./ITelemetryUnloadState";
 /**
  * Configuration provided to SDK core
  */
-export interface ITelemetryPluginChain {
+export interface ITelemetryPluginChain extends ITelemetryProcessor {
     /**
      * Returns the underlying plugin that is being proxied for the processTelemetry call
      */
@@ -14,11 +14,10 @@ export interface ITelemetryPluginChain {
      */
     getNext: () => ITelemetryPluginChain;
     /**
-     * Call back for telemetry processing before it it is sent
-     * @param env - This is the current event being reported
-     * @param itemCtx - This is the context for the current request, ITelemetryPlugin instances
-     * can optionally use this to access the current core instance or define / pass additional information
-     * to later plugins (vs appending items to the telemetry item)
+     * This plugin is being unloaded and should remove any hooked events and cleanup any global/scoped values, after this
+     * call the plugin will be removed from the telemetry processing chain and will no longer receive any events..
+     * @param unloadCtx - The unload context to use for this call.
+     * @param unloadState - The details of the unload operation
      */
-    processTelemetry: (env: ITelemetryItem, itemCtx: IProcessTelemetryContext) => void;
+    unload?: (unloadCtx: IProcessTelemetryUnloadContext, unloadState: ITelemetryUnloadState) => void;
 }

package/types/JavaScriptSDK.Interfaces/ITelemetryUnloadState.d.ts

@@ -0,0 +1,6 @@
+import { TelemetryUnloadReason } from "../JavaScriptSDK.Enums/TelemetryUnloadReason";
+export interface ITelemetryUnloadState {
+    reason: TelemetryUnloadReason;
+    isAsync: boolean;
+    flushComplete?: boolean;
+}

package/types/JavaScriptSDK.Interfaces/ITelemetryUpdateState.d.ts

@@ -0,0 +1,22 @@
+import { TelemetryUpdateReason } from "../JavaScriptSDK.Enums/TelemetryUpdateReason";
+import { IPlugin } from "./ITelemetryPlugin";
+export interface ITelemetryUpdateState {
+    /**
+     * Identifies the reason for the update notification, this is a bitwise numeric value
+     */
+    reason: TelemetryUpdateReason;
+    /**
+     * If this is a configuration update this was the previous configuration that was used
+     */
+    /**
+     * If this is a configuration update is the new configuration that is being used
+     */
+    /**
+     * This holds a collection of plugins that have been added (if the reason identifies that one or more plugins have been added)
+     */
+    added?: IPlugin[];
+    /**
+     * This holds a collection of plugins that have been removed (if the reason identifies that one or more plugins have been removed)
+     */
+    removed?: IPlugin[];
+}

package/types/JavaScriptSDK.Interfaces/IUnloadableComponent.d.ts

@@ -0,0 +1,13 @@
+import { IProcessTelemetryUnloadContext } from "./IProcessTelemetryContext";
+import { ITelemetryUnloadState } from "./ITelemetryUnloadState";
+export interface IUnloadableComponent {
+    /**
+    * Teardown / Unload hook to allow implementations to perform some additional unload operations before the BaseTelemetryPlugin
+    * finishes it's removal.
+    * @param unloadCtx - This is the context that should be used during unloading.
+    * @param unloadState - The details / state of the unload process, it holds details like whether it should be unloaded synchronously or asynchronously and the reason for the unload.
+    * @param asyncCallback - An optional callback that the plugin must call if it returns true to inform the caller that it has completed any async unload/teardown operations.
+    * @returns boolean - true if the plugin has or will call asyncCallback, this allows the plugin to perform any asynchronous operations.
+    */
+    _doUnload?: (unloadCtx?: IProcessTelemetryUnloadContext, unloadState?: ITelemetryUnloadState, asyncCallback?: () => void) => void | boolean;
+}

package/types/applicationinsights-core-js.d.ts

@@ -1,21 +1,26 @@
 export { IConfiguration } from "./JavaScriptSDK.Interfaces/IConfiguration";
 export { IChannelControls, MinChannelPriorty } from "./JavaScriptSDK.Interfaces/IChannelControls";
 export { ITelemetryPlugin, IPlugin } from "./JavaScriptSDK.Interfaces/ITelemetryPlugin";
-export { IAppInsightsCore } from "./JavaScriptSDK.Interfaces/IAppInsightsCore";
+export { IAppInsightsCore, ILoadedPlugin } from "./JavaScriptSDK.Interfaces/IAppInsightsCore";
 export { ITelemetryItem, ICustomProperties, Tags } from "./JavaScriptSDK.Interfaces/ITelemetryItem";
-export { IProcessTelemetryContext } from "./JavaScriptSDK.Interfaces/IProcessTelemetryContext";
+export { IBaseProcessingContext, IProcessTelemetryContext, IProcessTelemetryUnloadContext, IProcessTelemetryUpdateContext, GetExtCfgMergeType } from "./JavaScriptSDK.Interfaces/IProcessTelemetryContext";
 export { INotificationListener } from "./JavaScriptSDK.Interfaces/INotificationListener";
 export { ITelemetryPluginChain } from "./JavaScriptSDK.Interfaces/ITelemetryPluginChain";
 export { IDiagnosticLogger } from "./JavaScriptSDK.Interfaces/IDiagnosticLogger";
 export { InstrumentorHooksCallback, IInstrumentHooksCallbacks, IInstrumentHooks, IInstrumentHook, IInstrumentCallDetails } from "./JavaScriptSDK.Interfaces/IInstrumentHooks";
-export { EventsDiscardedReason } from "./JavaScriptSDK.Enums/EventsDiscardedReason";
+export { IUnloadableComponent } from "./JavaScriptSDK.Interfaces/IUnloadableComponent";
+export { eEventsDiscardedReason, EventsDiscardedReason } from "./JavaScriptSDK.Enums/EventsDiscardedReason";
 export { SendRequestReason } from "./JavaScriptSDK.Enums/SendRequestReason";
+export { TelemetryUpdateReason } from "./JavaScriptSDK.Enums/TelemetryUpdateReason";
+export { TelemetryUnloadReason } from "./JavaScriptSDK.Enums/TelemetryUnloadReason";
 export { AppInsightsCore } from "./JavaScriptSDK/AppInsightsCore";
 export { BaseCore } from "./JavaScriptSDK/BaseCore";
 export { BaseTelemetryPlugin } from "./JavaScriptSDK/BaseTelemetryPlugin";
-export { randomValue, random32, mwcRandomSeed, mwcRandom32 } from "./JavaScriptSDK/RandomHelper";
-export { CoreUtils, ICoreUtils, EventHelper, IEventHelper, Undefined, addEventHandler, newGuid, perfNow, newId, generateW3CId, disableCookies, canUseCookies, getCookie, setCookie, deleteCookie, _legacyCookieMgr, addEventListeners, addPageUnloadEventListener, addPageHideEventListener, addPageShowEventListener } from "./JavaScriptSDK/CoreUtils";
-export { isTypeof, isUndefined, isNullOrUndefined, hasOwnProperty, isObject, isFunction, attachEvent, detachEvent, normalizeJsName, objForEachKey, strEndsWith, strStartsWith, isDate, isArray, isError, isString, isNumber, isBoolean, toISOString, arrForEach, arrIndexOf, arrMap, arrReduce, strTrim, objKeys, objDefineAccessors, dateNow, getExceptionName, throwError, strContains, isSymbol, setValue, getSetValue, isNotTruthy, isTruthy, proxyAssign, createClassFromInterface, optimizeObject, isNotUndefined, isNotNullOrUndefined, objFreeze, objSeal } from "./JavaScriptSDK/HelperFuncs";
+export { randomValue, random32, mwcRandomSeed, mwcRandom32, newId } from "./JavaScriptSDK/RandomHelper";
+export { CoreUtils, ICoreUtils, EventHelper, IEventHelper, Undefined, newGuid, perfNow, generateW3CId, disableCookies, canUseCookies, getCookie, setCookie, deleteCookie, _legacyCookieMgr } from "./JavaScriptSDK/CoreUtils";
+export { isTypeof, isUndefined, isNullOrUndefined, hasOwnProperty, isObject, isFunction, normalizeJsName, objForEachKey, strEndsWith, strStartsWith, isDate, isArray, isError, isString, isNumber, isBoolean, toISOString, arrForEach, arrIndexOf, arrMap, arrReduce, strTrim, objKeys, objDefineAccessors, dateNow, getExceptionName, throwError, strContains, isSymbol, setValue, getSetValue, isNotTruthy, isTruthy, proxyAssign, proxyFunctions, proxyFunctionAs, createClassFromInterface, optimizeObject, isNotUndefined, isNotNullOrUndefined, objFreeze, objSeal, objExtend, objToString } from "./JavaScriptSDK/HelperFuncs";
+export { EnumValue, createEnumStyle, EnumMap, createEnumMap, createValueMap } from "./JavaScriptSDK.Enums/EnumHelperFuncs";
+export { attachEvent, detachEvent, addEventHandler, addEventListeners, addPageUnloadEventListener, addPageHideEventListener, addPageShowEventListener, removeEventHandler, removeEventListeners, removePageUnloadEventListener, removePageHideEventListener, removePageShowEventListener, eventOn, eventOff, mergeEvtNamespace, _IRegisteredEvents, __getRegisteredEvents } from "./JavaScriptSDK/EventHelpers";
 export { getGlobalInst, hasWindow, getWindow, hasDocument, getDocument, getCrypto, getMsCrypto, hasNavigator, getNavigator, hasHistory, getHistory, getLocation, getPerformance, hasJSON, getJSON, isReactNative, getConsole, dumpObj, isIE, getIEVersion, isSafari, setEnableEnvMocks, isBeaconsSupported, isFetchSupported, useXDomainRequest, isXhrSupported } from "./JavaScriptSDK/EnvUtils";
 export { getGlobal, objCreateFn as objCreate, strShimPrototype as strPrototype, strShimFunction as strFunction, strShimUndefined as strUndefined, strShimObject as strObject } from "@microsoft/applicationinsights-shims";
 export { NotificationManager } from "./JavaScriptSDK/NotificationManager";
@@ -23,13 +28,18 @@ export { INotificationManager } from "./JavaScriptSDK.Interfaces/INotificationMa
 export { IPerfEvent } from "./JavaScriptSDK.Interfaces/IPerfEvent";
 export { IPerfManager, IPerfManagerProvider } from "./JavaScriptSDK.Interfaces/IPerfManager";
 export { PerfEvent, PerfManager, doPerf, getGblPerfMgr, setGblPerfMgr } from "./JavaScriptSDK/PerfManager";
-export { safeGetLogger, DiagnosticLogger, _InternalLogMessage } from "./JavaScriptSDK/DiagnosticLogger";
-export { ProcessTelemetryContext } from "./JavaScriptSDK/ProcessTelemetryContext";
-export { initializePlugins, sortPlugins } from "./JavaScriptSDK/TelemetryHelpers";
-export { _InternalMessageId, LoggingSeverity } from "./JavaScriptSDK.Enums/LoggingEnums";
+export { safeGetLogger, DiagnosticLogger, _InternalLogMessage, _throwInternal, _warnToConsole, _logInternalMessage } from "./JavaScriptSDK/DiagnosticLogger";
+export { ProcessTelemetryContext, createProcessTelemetryContext } from "./JavaScriptSDK/ProcessTelemetryContext";
+export { initializePlugins, sortPlugins, unloadComponents } from "./JavaScriptSDK/TelemetryHelpers";
+export { _InternalMessageId, _eInternalMessageId, LoggingSeverity, eLoggingSeverity } from "./JavaScriptSDK.Enums/LoggingEnums";
 export { InstrumentProto, InstrumentProtos, InstrumentFunc, InstrumentFuncs } from "./JavaScriptSDK/InstrumentHooks";
 export { ICookieMgr, ICookieMgrConfig } from "./JavaScriptSDK.Interfaces/ICookieMgr";
 export { createCookieMgr, safeGetCookieMgr, uaDisallowsSameSiteNone, areCookiesSupported } from "./JavaScriptSDK/CookieMgr";
 export { strIKey, strExtensionConfig } from "./JavaScriptSDK/Constants";
 export { IDbgExtension } from "./JavaScriptSDK.Interfaces/IDbgExtension";
 export { getDebugListener, getDebugExt } from "./JavaScriptSDK/DbgExtensionUtils";
+export { TelemetryInitializerFunction, ITelemetryInitializerHandler, ITelemetryInitializerContainer } from "./JavaScriptSDK.Interfaces/ITelemetryInitializers";
+export { createUniqueNamespace } from "./JavaScriptSDK/DataCacheHelper";
+export { UnloadHandler, IUnloadHandlerContainer, createUnloadHandlerContainer } from "./JavaScriptSDK/UnloadHandlerContainer";
+export { ITelemetryUpdateState } from "./JavaScriptSDK.Interfaces/ITelemetryUpdateState";
+export { ITelemetryUnloadState } from "./JavaScriptSDK.Interfaces/ITelemetryUnloadState";

package/types/tsdoc-metadata.json

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

package/dist-esm/JavaScriptSDK/TelemetryPluginChain.js

@@ -1,76 +0,0 @@
-/*
- * Application Insights JavaScript SDK - Core, 2.8.0-nightly.2202-06
- * Copyright (c) Microsoft and contributors. All rights reserved.
- */
-
-
-"use strict";
-import { doPerf } from "./PerfManager";
-import { LoggingSeverity, _InternalMessageId } from "../JavaScriptSDK.Enums/LoggingEnums";
-import { isFunction } from "./HelperFuncs";
-import { dumpObj } from "./EnvUtils";
-var TelemetryPluginChain = /** @class */ (function () {
-    function TelemetryPluginChain(plugin, defItemCtx) {
-        var _self = this;
-        var _nextProxy = null;
-        var _hasProcessTelemetry = isFunction(plugin.processTelemetry);
-        var _hasSetNext = isFunction(plugin.setNextPlugin);
-        _self._hasRun = false;
-        _self.getPlugin = function () {
-            return plugin;
-        };
-        _self.getNext = function () {
-            return _nextProxy;
-        };
-        _self.setNext = function (nextPlugin) {
-            _nextProxy = nextPlugin;
-        };
-        _self.processTelemetry = function (env, itemCtx) {
-            if (!itemCtx) {
-                // Looks like a plugin didn't pass the (optional) context, so restore to the default
-                itemCtx = defItemCtx;
-            }
-            var identifier = plugin ? plugin.identifier : "TelemetryPluginChain";
-            doPerf(itemCtx ? itemCtx.core() : null, function () { return identifier + ":processTelemetry"; }, function () {
-                if (plugin && _hasProcessTelemetry) {
-                    _self._hasRun = true;
-                    try {
-                        // Ensure that we keep the context in sync (for processNext()), just in case a plugin
-                        // doesn't calls processTelemetry() instead of itemContext.processNext() or some
-                        // other form of error occurred
-                        itemCtx.setNext(_nextProxy);
-                        if (_hasSetNext) {
-                            // Backward compatibility setting the next plugin on the instance
-                            plugin.setNextPlugin(_nextProxy);
-                        }
-                        // Set a flag on the next plugin so we know if it was attempted to be executed
-                        _nextProxy && (_nextProxy._hasRun = false);
-                        plugin.processTelemetry(env, itemCtx);
-                    }
-                    catch (error) {
-                        var hasRun = _nextProxy && _nextProxy._hasRun;
-                        if (!_nextProxy || !hasRun) {
-                            // Either we have no next plugin or the current one did not attempt to call the next plugin
-                            // Which means the current one is the root of the failure so log/report this failure
-                            itemCtx.diagLog().throwInternal(LoggingSeverity.CRITICAL, _InternalMessageId.PluginException, "Plugin [" + plugin.identifier + "] failed during processTelemetry - " + dumpObj(error));
-                        }
-                        if (_nextProxy && !hasRun) {
-                            // As part of the failure the current plugin did not attempt to call the next plugin in the cahin
-                            // So rather than leave the pipeline dead in the water we call the next plugin
-                            _nextProxy.processTelemetry(env, itemCtx);
-                        }
-                    }
-                }
-                else if (_nextProxy) {
-                    _self._hasRun = true;
-                    // The underlying plugin is either not defined or does not have a processTelemetry implementation
-                    // so we still want the next plugin to be executed.
-                    _nextProxy.processTelemetry(env, itemCtx);
-                }
-            }, function () { return ({ item: env }); }, !(env.sync));
-        };
-    }
-    return TelemetryPluginChain;
-}());
-export { TelemetryPluginChain };
-//# sourceMappingURL=TelemetryPluginChain.js.map

package/dist-esm/JavaScriptSDK/TelemetryPluginChain.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"TelemetryPluginChain.js.map","sources":["TelemetryPluginChain.js"],"sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved.\r\n// Licensed under the MIT License.\r\n\"use strict\";\r\nimport { doPerf } from \"./PerfManager\";\r\nimport { LoggingSeverity, _InternalMessageId } from \"../JavaScriptSDK.Enums/LoggingEnums\";\r\nimport { isFunction } from \"./HelperFuncs\";\r\nimport { dumpObj } from \"./EnvUtils\";\r\nvar TelemetryPluginChain = /** @class */ (function () {\r\n    function TelemetryPluginChain(plugin, defItemCtx) {\r\n        var _self = this;\r\n        var _nextProxy = null;\r\n        var _hasProcessTelemetry = isFunction(plugin.processTelemetry);\r\n        var _hasSetNext = isFunction(plugin.setNextPlugin);\r\n        _self._hasRun = false;\r\n        _self.getPlugin = function () {\r\n            return plugin;\r\n        };\r\n        _self.getNext = function () {\r\n            return _nextProxy;\r\n        };\r\n        _self.setNext = function (nextPlugin) {\r\n            _nextProxy = nextPlugin;\r\n        };\r\n        _self.processTelemetry = function (env, itemCtx) {\r\n            if (!itemCtx) {\r\n                // Looks like a plugin didn't pass the (optional) context, so restore to the default\r\n                itemCtx = defItemCtx;\r\n            }\r\n            var identifier = plugin ? plugin.identifier : \"TelemetryPluginChain\";\r\n            doPerf(itemCtx ? itemCtx.core() : null, function () { return identifier + \":processTelemetry\"; }, function () {\r\n                if (plugin && _hasProcessTelemetry) {\r\n                    _self._hasRun = true;\r\n                    try {\r\n                        // Ensure that we keep the context in sync (for processNext()), just in case a plugin\r\n                        // doesn't calls processTelemetry() instead of itemContext.processNext() or some\r\n                        // other form of error occurred\r\n                        itemCtx.setNext(_nextProxy);\r\n                        if (_hasSetNext) {\r\n                            // Backward compatibility setting the next plugin on the instance\r\n                            plugin.setNextPlugin(_nextProxy);\r\n                        }\r\n                        // Set a flag on the next plugin so we know if it was attempted to be executed\r\n                        _nextProxy && (_nextProxy._hasRun = false);\r\n                        plugin.processTelemetry(env, itemCtx);\r\n                    }\r\n                    catch (error) {\r\n                        var hasRun = _nextProxy && _nextProxy._hasRun;\r\n                        if (!_nextProxy || !hasRun) {\r\n                            // Either we have no next plugin or the current one did not attempt to call the next plugin\r\n                            // Which means the current one is the root of the failure so log/report this failure\r\n                            itemCtx.diagLog().throwInternal(LoggingSeverity.CRITICAL, _InternalMessageId.PluginException, \"Plugin [\" + plugin.identifier + \"] failed during processTelemetry - \" + dumpObj(error));\r\n                        }\r\n                        if (_nextProxy && !hasRun) {\r\n                            // As part of the failure the current plugin did not attempt to call the next plugin in the cahin\r\n                            // So rather than leave the pipeline dead in the water we call the next plugin\r\n                            _nextProxy.processTelemetry(env, itemCtx);\r\n                        }\r\n                    }\r\n                }\r\n                else if (_nextProxy) {\r\n                    _self._hasRun = true;\r\n                    // The underlying plugin is either not defined or does not have a processTelemetry implementation\r\n                    // so we still want the next plugin to be executed.\r\n                    _nextProxy.processTelemetry(env, itemCtx);\r\n                }\r\n            }, function () { return ({ item: env }); }, !(env.sync));\r\n        };\r\n    }\r\n    return TelemetryPluginChain;\r\n}());\r\nexport { TelemetryPluginChain };\r\n//# sourceMappingURL=TelemetryPluginChain.js.map"],"names":[],"mappings":";;;;AAA4D;AAC1B;AAClC;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA"}

package/src/JavaScriptSDK/TelemetryPluginChain.ts

@@ -1,120 +0,0 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
-// Licensed under the MIT License.
-"use strict";
-
-import { ITelemetryItem } from "../JavaScriptSDK.Interfaces/ITelemetryItem";
-import { IProcessTelemetryContext } from "../JavaScriptSDK.Interfaces/IProcessTelemetryContext";
-import { ITelemetryPluginChain } from "../JavaScriptSDK.Interfaces/ITelemetryPluginChain";
-import { ITelemetryPlugin } from "../JavaScriptSDK.Interfaces/ITelemetryPlugin";
-import { _InternalLogMessage } from "./DiagnosticLogger";
-import { doPerf } from "./PerfManager";
-import { LoggingSeverity, _InternalMessageId } from "../JavaScriptSDK.Enums/LoggingEnums";
-import { isFunction } from "./HelperFuncs";
-import { dumpObj } from "./EnvUtils";
-
-export class TelemetryPluginChain implements ITelemetryPluginChain {
-
-    /**
-     * Returns the underlying plugin that is being proxied for the processTelemetry call
-     */
-    getPlugin: () => ITelemetryPlugin;
-
-    /**
-     * Returns the next plugin
-     */
-    getNext: () => ITelemetryPluginChain;
-
-    /**
-     * Sets the next proxy to be executed as the next plugin
-     * (Should only be used during initialization, which is why it's not defined on the interface)
-     */
-    setNext: (nextPlugin:ITelemetryPluginChain) => void;
-
-    /**
-     * Call back for telemetry processing before it it is sent
-     * @param env - This is the current event being reported
-     * @param itemCtx - This is the context for the current request, ITelemetryPlugin instances
-     * can optionally use this to access the current core instance or define / pass additional information
-     * to later plugins (vs appending items to the telemetry item)
-     */
-    processTelemetry: (env: ITelemetryItem, itemCtx: IProcessTelemetryContext) => void;
-
-    /**
-     * Internal flag used to try and identify root cause failures
-     */
-    private _hasRun: boolean;
-
-    constructor(plugin:ITelemetryPlugin, defItemCtx:IProcessTelemetryContext) {
-        let _self = this;
-        let _nextProxy:ITelemetryPluginChain = null;
-        let _hasProcessTelemetry = isFunction(plugin.processTelemetry);
-        let _hasSetNext = isFunction(plugin.setNextPlugin);
-
-        _self._hasRun = false;
-
-        _self.getPlugin = () => {
-            return plugin;
-        };
-
-        _self.getNext = () => {
-            return _nextProxy;
-        };
-
-        _self.setNext = (nextPlugin:ITelemetryPluginChain) => {
-            _nextProxy = nextPlugin;
-        }
-
-        _self.processTelemetry = (env: ITelemetryItem, itemCtx:IProcessTelemetryContext) => {
-            if (!itemCtx) {
-                // Looks like a plugin didn't pass the (optional) context, so restore to the default
-                itemCtx = defItemCtx;
-            }
-
-            let identifier = plugin ? plugin.identifier : "TelemetryPluginChain";
-
-            doPerf(itemCtx ? itemCtx.core() : null, () => identifier + ":processTelemetry", () => {
-                if (plugin && _hasProcessTelemetry) {
-                    _self._hasRun = true;
-                    try {
-    
-                        // Ensure that we keep the context in sync (for processNext()), just in case a plugin
-                        // doesn't calls processTelemetry() instead of itemContext.processNext() or some
-                        // other form of error occurred
-                        itemCtx.setNext(_nextProxy);
-                        if (_hasSetNext) {
-                            // Backward compatibility setting the next plugin on the instance
-                            plugin.setNextPlugin(_nextProxy);
-                        }
-    
-                        // Set a flag on the next plugin so we know if it was attempted to be executed
-                        _nextProxy && ((_nextProxy as TelemetryPluginChain)._hasRun = false);
-    
-                        plugin.processTelemetry(env, itemCtx);
-                    } catch (error) {
-                        let hasRun = _nextProxy && (_nextProxy as TelemetryPluginChain)._hasRun;
-                        if (!_nextProxy || !hasRun) {
-                            // Either we have no next plugin or the current one did not attempt to call the next plugin
-                            // Which means the current one is the root of the failure so log/report this failure
-                            itemCtx.diagLog().throwInternal(
-                                LoggingSeverity.CRITICAL,
-                                _InternalMessageId.PluginException,
-                                "Plugin [" + plugin.identifier + "] failed during processTelemetry - " + dumpObj(error));
-                        }
-    
-                        if (_nextProxy && !hasRun) {
-                            // As part of the failure the current plugin did not attempt to call the next plugin in the cahin
-                            // So rather than leave the pipeline dead in the water we call the next plugin
-                            _nextProxy.processTelemetry(env, itemCtx);
-                        }
-                    }
-                } else if (_nextProxy) {
-                    _self._hasRun = true;
-    
-                    // The underlying plugin is either not defined or does not have a processTelemetry implementation
-                    // so we still want the next plugin to be executed.
-                    _nextProxy.processTelemetry(env, itemCtx);
-                }
-            }, () => ({ item: env }), !((env as any).sync));
-        };
-    }
-}

package/types/JavaScriptSDK/TelemetryPluginChain.d.ts

@@ -1,32 +0,0 @@
-import { ITelemetryItem } from "../JavaScriptSDK.Interfaces/ITelemetryItem";
-import { IProcessTelemetryContext } from "../JavaScriptSDK.Interfaces/IProcessTelemetryContext";
-import { ITelemetryPluginChain } from "../JavaScriptSDK.Interfaces/ITelemetryPluginChain";
-import { ITelemetryPlugin } from "../JavaScriptSDK.Interfaces/ITelemetryPlugin";
-export declare class TelemetryPluginChain implements ITelemetryPluginChain {
-    /**
-     * Returns the underlying plugin that is being proxied for the processTelemetry call
-     */
-    getPlugin: () => ITelemetryPlugin;
-    /**
-     * Returns the next plugin
-     */
-    getNext: () => ITelemetryPluginChain;
-    /**
-     * Sets the next proxy to be executed as the next plugin
-     * (Should only be used during initialization, which is why it's not defined on the interface)
-     */
-    setNext: (nextPlugin: ITelemetryPluginChain) => void;
-    /**
-     * Call back for telemetry processing before it it is sent
-     * @param env - This is the current event being reported
-     * @param itemCtx - This is the context for the current request, ITelemetryPlugin instances
-     * can optionally use this to access the current core instance or define / pass additional information
-     * to later plugins (vs appending items to the telemetry item)
-     */
-    processTelemetry: (env: ITelemetryItem, itemCtx: IProcessTelemetryContext) => void;
-    /**
-     * Internal flag used to try and identify root cause failures
-     */
-    private _hasRun;
-    constructor(plugin: ITelemetryPlugin, defItemCtx: IProcessTelemetryContext);
-}