@microsoft/applicationinsights-core-js 2.8.0-beta.2202-06 → 2.8.0-beta.2203-02

package/src/JavaScriptSDK/TelemetryHelpers.ts

@@ -6,11 +6,22 @@ import { IPlugin, ITelemetryPlugin } from "../JavaScriptSDK.Interfaces/ITelemetr
 import { IProcessTelemetryContext } from "../JavaScriptSDK.Interfaces/IProcessTelemetryContext";
 import { ITelemetryPluginChain } from "../JavaScriptSDK.Interfaces/ITelemetryPluginChain";
 import { arrForEach, isFunction } from "./HelperFuncs";
+import { strCore, strIsInitialized, strPriority, strProcessTelemetry, strSetNextPlugin, strTeardown } from "./InternalConstants";
+import { createElmNodeData } from "./DataCacheHelper";
+import { IAppInsightsCore } from "../JavaScriptSDK.Interfaces/IAppInsightsCore";
 
-let processTelemetry = "processTelemetry";
-let priority = "priority";
-let setNextPlugin = "setNextPlugin";
-let isInitialized = "isInitialized";
+export interface IPluginState {
+    core?: IAppInsightsCore;
+    isInitialized?: boolean;
+    tearDown?: boolean;
+    disabled?: boolean;
+}
+
+const pluginStateData = createElmNodeData("plugin");
+
+export function _getPluginState(plugin: IPlugin): IPluginState {
+    return pluginStateData.get<IPluginState>(plugin, "state", {}, true)
+}
 
 /**
  * Initialize the queue of plugins
@@ -22,20 +33,29 @@ let isInitialized = "isInitialized";
 export function initializePlugins(processContext: IProcessTelemetryContext, extensions: IPlugin[]) {
 
     // Set the next plugin and identified the uninitialized plugins
-    let initPlugins:ITelemetryPlugin[] = [];
-    let lastPlugin:ITelemetryPlugin = null;
-    let proxy:ITelemetryPluginChain = processContext.getNext();
+    let initPlugins: ITelemetryPlugin[] = [];
+    let lastPlugin: ITelemetryPlugin = null;
+    let proxy: ITelemetryPluginChain = processContext.getNext();
+    let pluginState: IPluginState;
     while (proxy) {
         let thePlugin = proxy.getPlugin();
         if (thePlugin) {
             if (lastPlugin &&
-                    isFunction(lastPlugin[setNextPlugin]) &&
-                    isFunction(thePlugin[processTelemetry])) {
+                    isFunction(lastPlugin[strSetNextPlugin]) &&
+                    isFunction(thePlugin[strProcessTelemetry])) {
                 // Set this plugin as the next for the previous one
-                lastPlugin[setNextPlugin](thePlugin);
+                lastPlugin[strSetNextPlugin](thePlugin);
+            }
+
+            let isInitialized = false;
+            if (isFunction(thePlugin[strIsInitialized])) {
+                isInitialized = thePlugin[strIsInitialized]();
+            } else {
+                pluginState = _getPluginState(thePlugin);
+                isInitialized = pluginState[strIsInitialized];
             }
 
-            if (!isFunction(thePlugin[isInitialized]) || !thePlugin[isInitialized]()) {
+            if (!isInitialized) {
                 initPlugins.push(thePlugin);
             }
 
@@ -46,11 +66,23 @@ export function initializePlugins(processContext: IProcessTelemetryContext, exte
 
     // Now initialize the plugins
     arrForEach(initPlugins, thePlugin => {
+        let core = processContext.core();
+
         thePlugin.initialize(
             processContext.getCfg(),
-            processContext.core(),
+            core,
             extensions,
             processContext.getNext());
+
+        pluginState = _getPluginState(thePlugin);
+
+        // Only add the core to the state if the plugin didn't set it (doesn't extent from BaseTelemetryPlugin)
+        if (!thePlugin[strCore] && !pluginState[strCore]) {
+            pluginState[strCore] = core;
+        }
+
+        pluginState[strIsInitialized] = true;
+        delete pluginState[strTeardown];
     });
 }
 
@@ -58,9 +90,9 @@ export function sortPlugins<T = IPlugin>(plugins:T[]) {
     // Sort by priority
     return plugins.sort((extA, extB) => {
         let result = 0;
-        let bHasProcess = isFunction(extB[processTelemetry]);
-        if (isFunction(extA[processTelemetry])) {
-            result = bHasProcess ? extA[priority] - extB[priority] : 1;
+        let bHasProcess = isFunction(extB[strProcessTelemetry]);
+        if (isFunction(extA[strProcessTelemetry])) {
+            result = bHasProcess ? extA[strPriority] - extB[strPriority] : 1;
         } else if (bHasProcess) {
             result = -1;
         }

package/src/JavaScriptSDK/TelemetryInitializerPlugin.ts

@@ -2,13 +2,14 @@
 // // Licensed under the MIT License.
 
 import dynamicProto from "@microsoft/dynamicproto-js";
-import { LoggingSeverity, _InternalMessageId } from "../JavaScriptSDK.Enums/LoggingEnums";
+import { eLoggingSeverity, _eInternalMessageId } from "../JavaScriptSDK.Enums/LoggingEnums";
 import { IProcessTelemetryContext } from "../JavaScriptSDK.Interfaces/IProcessTelemetryContext";
 import { ITelemetryInitializerContainer, ITelemetryInitializerHandler, TelemetryInitializerFunction } from "../JavaScriptSDK.Interfaces/ITelemetryInitializers";
 import { ITelemetryItem } from "../JavaScriptSDK.Interfaces/ITelemetryItem";
 import { BaseTelemetryPlugin } from "./BaseTelemetryPlugin";
 import { dumpObj } from "./EnvUtils";
 import { arrForEach, getExceptionName } from "./HelperFuncs";
+import { strDoTeardown } from "./InternalConstants";
 
 interface _IInternalTelemetryInitializerHandler {
     id: number;
@@ -68,8 +69,8 @@ export class TelemetryInitializerPlugin extends BaseTelemetryPlugin implements I
                             // log error but dont stop executing rest of the telemetry initializers
                             // doNotSendItem = true;
                             itemCtx.diagLog().throwInternal(
-                                LoggingSeverity.CRITICAL,
-                                _InternalMessageId.TelemetryInitializerFailed,
+                                eLoggingSeverity.CRITICAL,
+                                _eInternalMessageId.TelemetryInitializerFailed,
                                 "One of telemetry initializers failed, telemetry item will not be sent: " + getExceptionName(e),
                                 { exception: dumpObj(e) }, true);
                         }
@@ -81,8 +82,7 @@ export class TelemetryInitializerPlugin extends BaseTelemetryPlugin implements I
                 }
             };
 
-            _self.unload = (itemCtx: IProcessTelemetryContext, isAsync: boolean): void => {
-                _base.unload(itemCtx, isAsync);
+            _self[strDoTeardown] = () => {
                 _initDefaults();
             };
         });
@@ -106,14 +106,4 @@ export class TelemetryInitializerPlugin extends BaseTelemetryPlugin implements I
     public processTelemetry(env: ITelemetryItem, itemCtx?: IProcessTelemetryContext): void {
         // @DynamicProtoStub -- DO NOT add any code as this will be removed during packaging
     }
-
-    /**
-     * 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 itemCtx - This is the context that should be used during unloading if required to flush any cached events.
-     * @param isAsync - Should the plugin attempt to unload synchronously or can it complete asynchronously
-     */
-     public unload(itemCtx: IProcessTelemetryContext, isAsync: boolean): void {
-        // @DynamicProtoStub -- DO NOT add any code as this will be removed during packaging
-    }
 }

package/src/JavaScriptSDK.Enums/LoggingEnums.ts

@@ -1,6 +1,9 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
-export enum LoggingSeverity {
+
+import { createEnumStyle } from "../JavaScriptSDK/HelperFuncs";
+
+export const enum eLoggingSeverity {
     /**
      * Error will be sent as internal telemetry
      */
@@ -9,97 +12,191 @@ export enum LoggingSeverity {
     /**
      * Error will NOT be sent as internal telemetry, and will only be shown in browser console
      */
-    WARNING = 2,
+    WARNING = 2
+}
+
+
+export const LoggingSeverity = createEnumStyle<{ [key in (keyof typeof eLoggingSeverity)]: number; }>({
+    CRITICAL: eLoggingSeverity.CRITICAL,
+    WARNING: eLoggingSeverity.WARNING
+});
+export type LoggingSeverity = number | eLoggingSeverity;
+
+export const enum _eInternalMessageId {
+    BrowserDoesNotSupportLocalStorage = 0,
+    BrowserCannotReadLocalStorage = 1,
+    BrowserCannotReadSessionStorage = 2,
+    BrowserCannotWriteLocalStorage = 3,
+    BrowserCannotWriteSessionStorage = 4,
+    BrowserFailedRemovalFromLocalStorage = 5,
+    BrowserFailedRemovalFromSessionStorage = 6,
+    CannotSendEmptyTelemetry = 7,
+    ClientPerformanceMathError = 8,
+    ErrorParsingAISessionCookie = 9,
+    ErrorPVCalc = 10,
+    ExceptionWhileLoggingError = 11,
+    FailedAddingTelemetryToBuffer = 12,
+    FailedMonitorAjaxAbort = 13,
+    FailedMonitorAjaxDur = 14,
+    FailedMonitorAjaxOpen = 15,
+    FailedMonitorAjaxRSC = 16,
+    FailedMonitorAjaxSend = 17,
+    FailedMonitorAjaxGetCorrelationHeader = 18,
+    FailedToAddHandlerForOnBeforeUnload = 19,
+    FailedToSendQueuedTelemetry = 20,
+    FailedToReportDataLoss = 21,
+    FlushFailed = 22,
+    MessageLimitPerPVExceeded = 23,
+    MissingRequiredFieldSpecification = 24,
+    NavigationTimingNotSupported = 25,
+    OnError = 26,
+    SessionRenewalDateIsZero = 27,
+    SenderNotInitialized = 28,
+    StartTrackEventFailed = 29,
+    StopTrackEventFailed = 30,
+    StartTrackFailed = 31,
+    StopTrackFailed = 32,
+    TelemetrySampledAndNotSent = 33,
+    TrackEventFailed = 34,
+    TrackExceptionFailed = 35,
+    TrackMetricFailed = 36,
+    TrackPVFailed = 37,
+    TrackPVFailedCalc = 38,
+    TrackTraceFailed = 39,
+    TransmissionFailed = 40,
+    FailedToSetStorageBuffer = 41,
+    FailedToRestoreStorageBuffer = 42,
+    InvalidBackendResponse = 43,
+    FailedToFixDepricatedValues = 44,
+    InvalidDurationValue = 45,
+    TelemetryEnvelopeInvalid = 46,
+    CreateEnvelopeError = 47,
+
+    // User actionable
+    CannotSerializeObject = 48,
+    CannotSerializeObjectNonSerializable = 49,
+    CircularReferenceDetected = 50,
+    ClearAuthContextFailed = 51,
+    ExceptionTruncated = 52,
+    IllegalCharsInName = 53,
+    ItemNotInArray = 54,
+    MaxAjaxPerPVExceeded = 55,
+    MessageTruncated = 56,
+    NameTooLong = 57,
+    SampleRateOutOfRange = 58,
+    SetAuthContextFailed = 59,
+    SetAuthContextFailedAccountName = 60,
+    StringValueTooLong = 61,
+    StartCalledMoreThanOnce = 62,
+    StopCalledWithoutStart = 63,
+    TelemetryInitializerFailed = 64,
+    TrackArgumentsNotSpecified = 65,
+    UrlTooLong = 66,
+    SessionStorageBufferFull = 67,
+    CannotAccessCookie = 68,
+    IdTooLong = 69,
+    InvalidEvent = 70,
+    FailedMonitorAjaxSetRequestHeader = 71,
+    SendBrowserInfoOnUserInit = 72,
+    PluginException = 73,
+    NotificationException = 74,
+    SnippetScriptLoadFailure = 99,
+    InvalidInstrumentationKey = 100,
+    CannotParseAiBlobValue = 101,
+    InvalidContentBlob = 102,
+    TrackPageActionEventFailed = 103,
+    FailedAddingCustomDefinedRequestContext = 104,
+    InMemoryStorageBufferFull = 105
 }
 
 /**
  * Internal message ID. Please create a new one for every conceptually different message. Please keep alphabetically ordered
  */
-export const _InternalMessageId = {
+export const _InternalMessageId = createEnumStyle<{ [key in (keyof typeof _eInternalMessageId)]: number; }>({
     // Non user actionable
-    BrowserDoesNotSupportLocalStorage: 0,
-    BrowserCannotReadLocalStorage: 1,
-    BrowserCannotReadSessionStorage: 2,
-    BrowserCannotWriteLocalStorage: 3,
-    BrowserCannotWriteSessionStorage: 4,
-    BrowserFailedRemovalFromLocalStorage: 5,
-    BrowserFailedRemovalFromSessionStorage: 6,
-    CannotSendEmptyTelemetry: 7,
-    ClientPerformanceMathError: 8,
-    ErrorParsingAISessionCookie: 9,
-    ErrorPVCalc: 10,
-    ExceptionWhileLoggingError: 11,
-    FailedAddingTelemetryToBuffer: 12,
-    FailedMonitorAjaxAbort: 13,
-    FailedMonitorAjaxDur: 14,
-    FailedMonitorAjaxOpen: 15,
-    FailedMonitorAjaxRSC: 16,
-    FailedMonitorAjaxSend: 17,
-    FailedMonitorAjaxGetCorrelationHeader: 18,
-    FailedToAddHandlerForOnBeforeUnload: 19,
-    FailedToSendQueuedTelemetry: 20,
-    FailedToReportDataLoss: 21,
-    FlushFailed: 22,
-    MessageLimitPerPVExceeded: 23,
-    MissingRequiredFieldSpecification: 24,
-    NavigationTimingNotSupported: 25,
-    OnError: 26,
-    SessionRenewalDateIsZero: 27,
-    SenderNotInitialized: 28,
-    StartTrackEventFailed: 29,
-    StopTrackEventFailed: 30,
-    StartTrackFailed: 31,
-    StopTrackFailed: 32,
-    TelemetrySampledAndNotSent: 33,
-    TrackEventFailed: 34,
-    TrackExceptionFailed: 35,
-    TrackMetricFailed: 36,
-    TrackPVFailed: 37,
-    TrackPVFailedCalc: 38,
-    TrackTraceFailed: 39,
-    TransmissionFailed: 40,
-    FailedToSetStorageBuffer: 41,
-    FailedToRestoreStorageBuffer: 42,
-    InvalidBackendResponse: 43,
-    FailedToFixDepricatedValues: 44,
-    InvalidDurationValue: 45,
-    TelemetryEnvelopeInvalid: 46,
-    CreateEnvelopeError: 47,
+    BrowserDoesNotSupportLocalStorage: _eInternalMessageId.BrowserDoesNotSupportLocalStorage,
+    BrowserCannotReadLocalStorage: _eInternalMessageId.BrowserCannotReadLocalStorage,
+    BrowserCannotReadSessionStorage: _eInternalMessageId.BrowserCannotReadSessionStorage,
+    BrowserCannotWriteLocalStorage: _eInternalMessageId.BrowserCannotWriteLocalStorage,
+    BrowserCannotWriteSessionStorage: _eInternalMessageId.BrowserCannotWriteSessionStorage,
+    BrowserFailedRemovalFromLocalStorage: _eInternalMessageId.BrowserFailedRemovalFromLocalStorage,
+    BrowserFailedRemovalFromSessionStorage: _eInternalMessageId.BrowserFailedRemovalFromSessionStorage,
+    CannotSendEmptyTelemetry: _eInternalMessageId.CannotSendEmptyTelemetry,
+    ClientPerformanceMathError: _eInternalMessageId.ClientPerformanceMathError,
+    ErrorParsingAISessionCookie: _eInternalMessageId.ErrorParsingAISessionCookie,
+    ErrorPVCalc: _eInternalMessageId.ErrorPVCalc,
+    ExceptionWhileLoggingError: _eInternalMessageId.ExceptionWhileLoggingError,
+    FailedAddingTelemetryToBuffer: _eInternalMessageId.FailedAddingTelemetryToBuffer,
+    FailedMonitorAjaxAbort: _eInternalMessageId.FailedMonitorAjaxAbort,
+    FailedMonitorAjaxDur: _eInternalMessageId.FailedMonitorAjaxDur,
+    FailedMonitorAjaxOpen: _eInternalMessageId.FailedMonitorAjaxOpen,
+    FailedMonitorAjaxRSC: _eInternalMessageId.FailedMonitorAjaxRSC,
+    FailedMonitorAjaxSend: _eInternalMessageId.FailedMonitorAjaxSend,
+    FailedMonitorAjaxGetCorrelationHeader: _eInternalMessageId.FailedMonitorAjaxGetCorrelationHeader,
+    FailedToAddHandlerForOnBeforeUnload: _eInternalMessageId.FailedToAddHandlerForOnBeforeUnload,
+    FailedToSendQueuedTelemetry: _eInternalMessageId.FailedToSendQueuedTelemetry,
+    FailedToReportDataLoss: _eInternalMessageId.FailedToReportDataLoss,
+    FlushFailed: _eInternalMessageId.FlushFailed,
+    MessageLimitPerPVExceeded: _eInternalMessageId.MessageLimitPerPVExceeded,
+    MissingRequiredFieldSpecification: _eInternalMessageId.MissingRequiredFieldSpecification,
+    NavigationTimingNotSupported: _eInternalMessageId.NavigationTimingNotSupported,
+    OnError: _eInternalMessageId.OnError,
+    SessionRenewalDateIsZero: _eInternalMessageId.SessionRenewalDateIsZero,
+    SenderNotInitialized: _eInternalMessageId.SenderNotInitialized,
+    StartTrackEventFailed: _eInternalMessageId.StartTrackEventFailed,
+    StopTrackEventFailed: _eInternalMessageId.StopTrackEventFailed,
+    StartTrackFailed: _eInternalMessageId.StartTrackFailed,
+    StopTrackFailed: _eInternalMessageId.StopTrackFailed,
+    TelemetrySampledAndNotSent: _eInternalMessageId.TelemetrySampledAndNotSent,
+    TrackEventFailed: _eInternalMessageId.TrackEventFailed,
+    TrackExceptionFailed: _eInternalMessageId.TrackExceptionFailed,
+    TrackMetricFailed: _eInternalMessageId.TrackMetricFailed,
+    TrackPVFailed: _eInternalMessageId.TrackPVFailed,
+    TrackPVFailedCalc: _eInternalMessageId.TrackPVFailedCalc,
+    TrackTraceFailed: _eInternalMessageId.TrackTraceFailed,
+    TransmissionFailed: _eInternalMessageId.TransmissionFailed,
+    FailedToSetStorageBuffer: _eInternalMessageId.FailedToSetStorageBuffer,
+    FailedToRestoreStorageBuffer: _eInternalMessageId.FailedToRestoreStorageBuffer,
+    InvalidBackendResponse: _eInternalMessageId.InvalidBackendResponse,
+    FailedToFixDepricatedValues: _eInternalMessageId.FailedToFixDepricatedValues,
+    InvalidDurationValue: _eInternalMessageId.InvalidDurationValue,
+    TelemetryEnvelopeInvalid: _eInternalMessageId.TelemetryEnvelopeInvalid,
+    CreateEnvelopeError: _eInternalMessageId.CreateEnvelopeError,
 
     // User actionable
-    CannotSerializeObject: 48,
-    CannotSerializeObjectNonSerializable: 49,
-    CircularReferenceDetected: 50,
-    ClearAuthContextFailed: 51,
-    ExceptionTruncated: 52,
-    IllegalCharsInName: 53,
-    ItemNotInArray: 54,
-    MaxAjaxPerPVExceeded: 55,
-    MessageTruncated: 56,
-    NameTooLong: 57,
-    SampleRateOutOfRange: 58,
-    SetAuthContextFailed: 59,
-    SetAuthContextFailedAccountName: 60,
-    StringValueTooLong: 61,
-    StartCalledMoreThanOnce: 62,
-    StopCalledWithoutStart: 63,
-    TelemetryInitializerFailed: 64,
-    TrackArgumentsNotSpecified: 65,
-    UrlTooLong: 66,
-    SessionStorageBufferFull: 67,
-    CannotAccessCookie: 68,
-    IdTooLong: 69,
-    InvalidEvent: 70,
-    FailedMonitorAjaxSetRequestHeader: 71,
-    SendBrowserInfoOnUserInit: 72,
-    PluginException: 73,
-    NotificationException: 74,
-    SnippetScriptLoadFailure: 99,
-    InvalidInstrumentationKey:100,
-    CannotParseAiBlobValue: 101,
-    InvalidContentBlob: 102,
-    TrackPageActionEventFailed: 103,
-    FailedAddingCustomDefinedRequestContext: 104,
-    InMemoryStorageBufferFull: 105
-};
-export type _InternalMessageId = number | typeof _InternalMessageId;
+    CannotSerializeObject: _eInternalMessageId.CannotSerializeObject,
+    CannotSerializeObjectNonSerializable: _eInternalMessageId.CannotSerializeObjectNonSerializable,
+    CircularReferenceDetected: _eInternalMessageId.CircularReferenceDetected,
+    ClearAuthContextFailed: _eInternalMessageId.ClearAuthContextFailed,
+    ExceptionTruncated: _eInternalMessageId.ExceptionTruncated,
+    IllegalCharsInName: _eInternalMessageId.IllegalCharsInName,
+    ItemNotInArray: _eInternalMessageId.ItemNotInArray,
+    MaxAjaxPerPVExceeded: _eInternalMessageId.MaxAjaxPerPVExceeded,
+    MessageTruncated: _eInternalMessageId.MessageTruncated,
+    NameTooLong: _eInternalMessageId.NameTooLong,
+    SampleRateOutOfRange: _eInternalMessageId.SampleRateOutOfRange,
+    SetAuthContextFailed: _eInternalMessageId.SetAuthContextFailed,
+    SetAuthContextFailedAccountName: _eInternalMessageId.SetAuthContextFailedAccountName,
+    StringValueTooLong: _eInternalMessageId.StringValueTooLong,
+    StartCalledMoreThanOnce: _eInternalMessageId.StartCalledMoreThanOnce,
+    StopCalledWithoutStart: _eInternalMessageId.StopCalledWithoutStart,
+    TelemetryInitializerFailed: _eInternalMessageId.TelemetryInitializerFailed,
+    TrackArgumentsNotSpecified: _eInternalMessageId.TrackArgumentsNotSpecified,
+    UrlTooLong: _eInternalMessageId.UrlTooLong,
+    SessionStorageBufferFull: _eInternalMessageId.SessionStorageBufferFull,
+    CannotAccessCookie: _eInternalMessageId.CannotAccessCookie,
+    IdTooLong: _eInternalMessageId.IdTooLong,
+    InvalidEvent: _eInternalMessageId.InvalidEvent,
+    FailedMonitorAjaxSetRequestHeader: _eInternalMessageId.FailedMonitorAjaxSetRequestHeader,
+    SendBrowserInfoOnUserInit: _eInternalMessageId.SendBrowserInfoOnUserInit,
+    PluginException: _eInternalMessageId.PluginException,
+    NotificationException: _eInternalMessageId.NotificationException,
+    SnippetScriptLoadFailure: _eInternalMessageId.SnippetScriptLoadFailure,
+    InvalidInstrumentationKey: _eInternalMessageId.InvalidInstrumentationKey,
+    CannotParseAiBlobValue: _eInternalMessageId.CannotParseAiBlobValue,
+    InvalidContentBlob: _eInternalMessageId.InvalidContentBlob,
+    TrackPageActionEventFailed: _eInternalMessageId.TrackPageActionEventFailed,
+    FailedAddingCustomDefinedRequestContext: _eInternalMessageId.FailedAddingCustomDefinedRequestContext,
+    InMemoryStorageBufferFull: _eInternalMessageId.InMemoryStorageBufferFull
+});
+export type _InternalMessageId = number | _eInternalMessageId;

package/src/JavaScriptSDK.Enums/TelemetryUnloadReason.ts

@@ -0,0 +1,27 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+/**
+ * The TelemetryUnloadReason enumeration contains the possible reasons for why a plugin is being unloaded / torndown().
+ */
+ export const enum TelemetryUnloadReason {
+    /**
+     * Teardown has been called without any context.
+     */
+    ManualTeardown = 0,
+
+    /**
+     * Just this plugin is being removed
+     */
+    //PluginUnload = 1,
+
+    /**
+     * This instance of the plugin is being removed and replaced
+     */
+    //PluginReplace = 2,
+
+    /**
+     * The entire SDK is being unloaded
+     */
+    //SdkUnload = 50
+}

package/src/JavaScriptSDK.Interfaces/IAppInsightsCore.ts

@@ -14,6 +14,21 @@ import { ITelemetryInitializerHandler, TelemetryInitializerFunction } from "./IT
 
 export interface ILoadedPlugin<T extends IPlugin> {
     plugin: T;
+
+    /**
+     * Identifies whether the plugin is enabled and can process events. This is slightly different from isInitialized as the plugin may be initialized but disabled
+     * via the setEnabled() or it may be a shared plugin which has had it's teardown function called from another instance..
+     * @returns boolean = true if the plugin is in a state where it is operational.
+     */
+    isEnabled: () => boolean;
+
+    /**
+     * You can optionally enable / disable a plugin from processing events.
+     * Setting enabled to true will not necessarily cause the `isEnabled()` to also return true
+     * as the plugin must also have been successfully initialized and not had it's `teardown` method called
+     * (unless it's also been re-initialized)
+     */
+    setEnabled: (isEnabled: boolean) => void;
 }
 
 export interface IAppInsightsCore extends IPerfManagerProvider {
@@ -96,4 +111,9 @@ export interface IAppInsightsCore extends IPerfManagerProvider {
      * @param pluginIdentifier
      */
     getPlugin<T extends IPlugin = IPlugin>(pluginIdentifier: string): ILoadedPlugin<T>;
+  
+    /**
+     * Returns the unique event namespace that should be used when registering events
+     */
+    evtNamespace(): string;
 }

package/src/JavaScriptSDK.Interfaces/IChannelControls.ts

@@ -1,7 +1,9 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 import { SendRequestReason } from "../JavaScriptSDK.Enums/SendRequestReason";
+import { IProcessTelemetryUnloadContext } from "./IProcessTelemetryContext";
 import { ITelemetryPlugin } from "./ITelemetryPlugin";
+import { ITelemetryUnloadState } from "./ITelemetryUnloadState";
 
 "use strict";
 
@@ -21,9 +23,14 @@ export interface IChannelControls extends ITelemetryPlugin {
     resume(): void;
 
     /**
-     * Tear down transmission pipeline
+     * 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;
 
     /**
      * Flush to send data immediately; channel should default to sending data asynchronously

package/src/JavaScriptSDK.Interfaces/IProcessTelemetryContext.ts

@@ -3,11 +3,12 @@
 "use strict";
 
 import { IAppInsightsCore } from "./IAppInsightsCore";
-import { IDiagnosticLogger } from "./IDiagnosticLogger";
 import { IConfiguration } from "./IConfiguration";
+import { IDiagnosticLogger } from "./IDiagnosticLogger";
 import { ITelemetryItem } from "./ITelemetryItem";
 import { IPlugin, ITelemetryPlugin } from "./ITelemetryPlugin";
 import { ITelemetryPluginChain } from "./ITelemetryPluginChain";
+import { ITelemetryUnloadState } from "./ITelemetryUnloadState";
 
 export const enum GetExtCfgMergeType {
     None = 0,
@@ -15,11 +16,7 @@ export const enum GetExtCfgMergeType {
     MergeDefaultFromRootOrDefault = 2,
 }
 
-/**
- * The current context for the current call to processTelemetry(), used to support sharing the same plugin instance
- * between multiple AppInsights instances
- */
-export interface IProcessTelemetryContext {
+export interface IBaseProcessingContext {
     /**
      * The current core instance for the request
      */
@@ -65,12 +62,6 @@ export interface IProcessTelemetryContext {
      */
     setNext: (nextCtx: ITelemetryPluginChain) => void;
 
-    /**
-     * Call back for telemetry processing before it it is sent
-     * @param env - This is the current event being reported
-     */
-    processNext: (env: ITelemetryItem) => void;
-
     /**
      * Synchronously iterate over the context chain running the callback for each plugin, once
      * every plugin has been executed via the callback, any associated onComplete will be called.
@@ -79,16 +70,64 @@ export interface IProcessTelemetryContext {
     iterate: <T extends ITelemetryPlugin = ITelemetryPlugin>(callback: (plugin: T) => void) => void;
 
     /**
-     * Create a new context using the core and config from the current instance
+     * Set the function to call when the current chain has executed all processNext or unloadNext items.
+     * @param onComplete - The onComplete to call
+     * @param that - The "this" value to use for the onComplete call, if not provided or undefined defaults to the current context
+     * @param args - Any additional arguments to pass to the onComplete function
+     */
+    onComplete: (onComplete: Function, that?: any, ...args: any[]) => void;
+
+    /**
+     * Create a new context using the core and config from the current instance, returns a new instance of the same type
      * @param plugins - The execution order to process the plugins, if null or not supplied
      *                  then the current execution order will be copied.
      * @param startAt - The plugin to start processing from, if missing from the execution
      *                  order then the next plugin will be NOT set.
      */
-    createNew: (plugins?:IPlugin[]|ITelemetryPluginChain, startAt?:IPlugin) => IProcessTelemetryContext;
+    createNew: (plugins?: IPlugin[] | ITelemetryPluginChain, startAt?: IPlugin) => IBaseProcessingContext;
+}
 
+/**
+ * The current context for the current call to processTelemetry(), used to support sharing the same plugin instance
+ * between multiple AppInsights instances
+ */
+export interface IProcessTelemetryContext extends IBaseProcessingContext {
     /**
-     * Set the function to call when the current chain has executed all processNext or unloadNext items.
+     * Call back for telemetry processing before it it is sent
+     * @param env - This is the current event being reported
+     * @returns boolean (true) if there is no more plugins to process otherwise false or undefined (void)
+     */
+    processNext: (env: ITelemetryItem) => boolean | void;
+
+    /**
+     * Create a new context using the core and config from the current instance, returns a new instance of the same type
+     * @param plugins - The execution order to process the plugins, if null or not supplied
+     *                  then the current execution order will be copied.
+     * @param startAt - The plugin to start processing from, if missing from the execution
+     *                  order then the next plugin will be NOT set.
+     */
+     createNew: (plugins?: IPlugin[] | ITelemetryPluginChain, startAt?: IPlugin) => IProcessTelemetryContext;
+}
+
+/**
+ * The current context for the current call to processTelemetry(), used to support sharing the same plugin instance
+ * between multiple AppInsights instances
+ */
+export interface IProcessTelemetryUnloadContext extends IBaseProcessingContext {
+
+    /**
+     * This Plugin has finished unloading, so unload the next one
+     * @param uploadState - The state of the unload process
+     * @returns boolean (true) if there is no more plugins to process otherwise false or undefined (void)
+     */
+    processNext: (unloadState: ITelemetryUnloadState) => boolean | void;
+
+    /**
+     * Create a new context using the core and config from the current instance, returns a new instance of the same type
+     * @param plugins - The execution order to process the plugins, if null or not supplied
+     *                  then the current execution order will be copied.
+     * @param startAt - The plugin to start processing from, if missing from the execution
+     *                  order then the next plugin will be NOT set.
      */
-    onComplete: (onComplete: () => void) => void;
+     createNew: (plugins?: IPlugin[] | ITelemetryPluginChain, startAt?: IPlugin) => IProcessTelemetryUnloadContext;
 }