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

package/src/JavaScriptSDK/Telemetry/PageViewManager.ts

@@ -5,8 +5,8 @@ import {
     dateTimeUtilsDuration, IPageViewTelemetry, IPageViewTelemetryInternal, IPageViewPerformanceTelemetryInternal
 } from "@microsoft/applicationinsights-common";
 import {
-    IAppInsightsCore, IDiagnosticLogger, LoggingSeverity,
-    _InternalMessageId, getDocument, getLocation, arrForEach, isNullOrUndefined, getExceptionName, dumpObj
+    IAppInsightsCore, IDiagnosticLogger, eLoggingSeverity,
+    _eInternalMessageId, getDocument, getLocation, arrForEach, isNullOrUndefined, getExceptionName, dumpObj, IProcessTelemetryUnloadContext, ITelemetryUnloadState, _throwInternal
 } from "@microsoft/applicationinsights-core-js";
 import { PageViewPerformanceManager } from "./PageViewPerformanceManager";
 import dynamicProto from "@microsoft/dynamicproto-js";
@@ -25,10 +25,10 @@ export interface IAppInsightsInternal {
 export class PageViewManager {
 
     constructor(
-            appInsights: IAppInsightsInternal,
-            overridePageViewDuration: boolean,
-            core: IAppInsightsCore,
-            pageViewPerformanceManager: PageViewPerformanceManager) {
+        appInsights: IAppInsightsInternal,
+        overridePageViewDuration: boolean,
+        core: IAppInsightsCore,
+        pageViewPerformanceManager: PageViewPerformanceManager) {
 
         dynamicProto(PageViewManager, this, (_self) => {
             let intervalHandle: any = null;
@@ -40,11 +40,9 @@ export class PageViewManager {
                 _logger = core.logger;
             }
     
-            function _flushChannels() {
+            function _flushChannels(isAsync: boolean) {
                 if (core) {
-                    arrForEach(core.getTransmissionControls(), queues => {
-                        arrForEach(queues, q => q.flush(true))
-                    });
+                    core.flush(isAsync);
                 }
             }
         
@@ -72,7 +70,7 @@ export class PageViewManager {
     
                         if (doFlush) {
                             // We process at least one item so flush the queue
-                            _flushChannels();
+                            _flushChannels(true);
                         }
                     }), 100);
                 }
@@ -99,12 +97,12 @@ export class PageViewManager {
                         pageView,
                         customProperties
                     );
-                    _flushChannels();
+                    _flushChannels(true);
         
                     // no navigation timing (IE 8, iOS Safari 8.4, Opera Mini 8 - see http://caniuse.com/#feat=nav-timing)
-                    _logger.throwInternal(
-                        LoggingSeverity.WARNING,
-                        _InternalMessageId.NavigationTimingNotSupported,
+                    _throwInternal(_logger,
+                        eLoggingSeverity.WARNING,
+                        _eInternalMessageId.NavigationTimingNotSupported,
                         "trackPageView: navigation timing API used for calculation of page duration is not supported in this browser. This page view will be collected without duration and timing info.");
         
                     return;
@@ -143,7 +141,7 @@ export class PageViewManager {
                         pageView,
                         customProperties
                     );
-                    _flushChannels();
+                    _flushChannels(true);
                     pageViewSent = true;
                 }
         
@@ -198,16 +196,33 @@ export class PageViewManager {
                             }
                         }
                     } catch (e) {
-                        _logger.throwInternal(
-                            LoggingSeverity.CRITICAL,
-                            _InternalMessageId.TrackPVFailedCalc,
+                        _throwInternal(_logger,
+                            eLoggingSeverity.CRITICAL,
+                            _eInternalMessageId.TrackPVFailedCalc,
                             "trackPageView failed on page load calculation: " + getExceptionName(e),
                             { exception: dumpObj(e) });
                     }
         
                     return processed;
                 });
-            }
+            };
+
+            _self.teardown = (unloadCtx?: IProcessTelemetryUnloadContext, unloadState?: ITelemetryUnloadState) => {
+                if (intervalHandle) {
+                    clearInterval(intervalHandle);
+                    intervalHandle = null;
+
+                    let allItems = itemQueue.slice(0);
+                    let doFlush = false;
+                    itemQueue = [];
+                    arrForEach(allItems, (item) => {
+                        if (item()) {
+                            doFlush = true;
+                        }
+                    });
+                }
+            };
+
         });
     }
 
@@ -224,4 +239,8 @@ export class PageViewManager {
     public trackPageView(pageView: IPageViewTelemetry, customProperties?: { [key: string]: any }) {
         // @DynamicProtoStub -- DO NOT add any code as this will be removed during packaging
     }
+
+    public teardown(unloadCtx?: IProcessTelemetryUnloadContext, unloadState?: ITelemetryUnloadState) {
+        // @DynamicProtoStub -- DO NOT add any code as this will be removed during packaging
+    }
 }

package/src/JavaScriptSDK/Telemetry/PageViewPerformanceManager.ts

@@ -5,8 +5,8 @@ import {
     IPageViewPerformanceTelemetryInternal, dateTimeUtilsDuration, msToTimeSpan
 } from "@microsoft/applicationinsights-common";
 import {
-    IAppInsightsCore, IDiagnosticLogger, LoggingSeverity,
-    _InternalMessageId, getNavigator, getPerformance
+    IAppInsightsCore, IDiagnosticLogger, eLoggingSeverity,
+    _eInternalMessageId, getNavigator, getPerformance, _throwInternal
 } from "@microsoft/applicationinsights-core-js";
 
 /**
@@ -74,26 +74,28 @@ export class PageViewPerformanceManager {
                 dom = dateTimeUtilsDuration(timing.responseEnd, timing.loadEventEnd);
             }
 
+            let logger = this._logger;
+
             if (total === 0) {
-                this._logger.throwInternal(
-                    LoggingSeverity.WARNING,
-                    _InternalMessageId.ErrorPVCalc,
+                _throwInternal(logger,
+                    eLoggingSeverity.WARNING,
+                    _eInternalMessageId.ErrorPVCalc,
                     "error calculating page view performance.",
                     { total, network, request, response, dom });
 
             } else if (!this.shouldCollectDuration(total, network, request, response, dom)) {
-                this._logger.throwInternal(
-                    LoggingSeverity.WARNING,
-                    _InternalMessageId.InvalidDurationValue,
+                _throwInternal(logger,
+                    eLoggingSeverity.WARNING,
+                    _eInternalMessageId.InvalidDurationValue,
                     "Invalid page load duration value. Browser perf data won't be sent.",
                     { total, network, request, response, dom });
 
             } else if (total < Math.floor(network) + Math.floor(request) + Math.floor(response) + Math.floor(dom)) {
                 // some browsers may report individual components incorrectly so that the sum of the parts will be bigger than total PLT
                 // in this case, don't report client performance from this page
-                this._logger.throwInternal(
-                    LoggingSeverity.WARNING,
-                    _InternalMessageId.ClientPerformanceMathError,
+                _throwInternal(logger,
+                    eLoggingSeverity.WARNING,
+                    _eInternalMessageId.ClientPerformanceMathError,
                     "client performance math error.",
                     { total, network, request, response, dom });
 
@@ -125,15 +127,15 @@ export class PageViewPerformanceManager {
         return null;
     }
 
-   /**
+    /**
     * Returns true is window PerformanceNavigationTiming API is supported, false otherwise.
     */
-   public isPerformanceNavigationTimingSupported() {
+    public isPerformanceNavigationTimingSupported() {
         let perf = getPerformance();
         return perf && perf.getEntriesByType && perf.getEntriesByType("navigation").length > 0;
-}
+    }
 
-   /**
+    /**
     * Returns true is window performance timing API is supported, false otherwise.
     */
     public isPerformanceTimingSupported() {
@@ -141,7 +143,7 @@ export class PageViewPerformanceManager {
         return perf && perf.timing;
     }
 
-   /**
+    /**
     * As page loads different parts of performance timing numbers get set. When all of them are set we can report it.
     * Returns true if ready, false otherwise.
     */
@@ -160,7 +162,7 @@ export class PageViewPerformanceManager {
             && timing.domLoading > 0;
     }
 
-   /**
+    /**
     * This method tells if given durations should be excluded from collection.
     */
     public shouldCollectDuration(...durations: number[]): boolean {

package/src/JavaScriptSDK/Telemetry/PageVisitTimeManager.ts

@@ -2,7 +2,7 @@
 // Licensed under the MIT License.
 
 import { utlCanUseSessionStorage, utlGetSessionStorage, utlRemoveSessionStorage, utlSetSessionStorage } from "@microsoft/applicationinsights-common";
-import { IDiagnosticLogger, hasJSON, getJSON, dateNow, dumpObj, throwError } from "@microsoft/applicationinsights-core-js";
+import { IDiagnosticLogger, hasJSON, getJSON, dateNow, dumpObj, throwError, _warnToConsole } from "@microsoft/applicationinsights-core-js";
 
 /**
  * Used to track page visit durations
@@ -23,7 +23,7 @@ export class PageVisitTimeManager {
         this._logger = logger;
     }
 
-   /**
+    /**
     * Tracks the previous page visit time telemetry (if exists) and starts timing of new page visit time
     * @param currentPageName Name of page to begin timing for visit duration
     * @param currentPageUrl Url of page to begin timing for visit duration
@@ -39,7 +39,7 @@ export class PageVisitTimeManager {
                 this.pageVisitTimeTrackingHandler(prevPageVisitTimeData.pageName, prevPageVisitTimeData.pageUrl, prevPageVisitTimeData.pageVisitTime);
             }
         } catch (e) {
-            this._logger.warnToConsole("Auto track page visit time failed, metric will not be collected: " + dumpObj(e));
+            _warnToConsole(this._logger, "Auto track page visit time failed, metric will not be collected: " + dumpObj(e));
         }
     }
 
@@ -55,7 +55,7 @@ export class PageVisitTimeManager {
 
             return prevPageVisitData;
         } catch (e) {
-            this._logger.warnToConsole("Call to restart failed: " + dumpObj(e));
+            _warnToConsole(this._logger, "Call to restart failed: " + dumpObj(e));
             return null;
         }
     }
@@ -78,7 +78,7 @@ export class PageVisitTimeManager {
             }
         } catch (e) {
             // TODO: Remove this catch in next phase, since if start is called twice in a row the exception needs to be propagated out
-            this._logger.warnToConsole("Call to start failed: " + dumpObj(e));
+            _warnToConsole(this._logger, "Call to start failed: " + dumpObj(e));
         }
     }
 
@@ -113,7 +113,7 @@ export class PageVisitTimeManager {
             }
             return null;
         } catch (e) {
-            this._logger.warnToConsole("Stop page visit timer failed: " + dumpObj(e));
+            _warnToConsole(this._logger, "Stop page visit timer failed: " + dumpObj(e));
             return null;
         }
     }

package/src/JavaScriptSDK/Timing.ts

@@ -0,0 +1,46 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+import { dateTimeUtilsDuration } from "@microsoft/applicationinsights-common";
+import { IDiagnosticLogger, eLoggingSeverity, _eInternalMessageId, _throwInternal } from "@microsoft/applicationinsights-core-js";
+
+/**
+ * Used to record timed events and page views.
+ */
+export class Timing {
+
+    public action: (name?: string, url?: string, duration?: number, properties?: { [key: string]: string }, measurements?: { [key: string]: number }) => void;
+    public start: (name: string) => void;
+    public stop: (name: string, url: string, properties?: { [key: string]: string }, measurements?: { [key: string]: number }) => void;
+
+    constructor(logger: IDiagnosticLogger, name: string) {
+        let _self = this;
+        let _events: { [key: string]: number; } = {}
+
+        _self.start = (name: string) => {
+            if (typeof _events[name] !== "undefined") {
+                _throwInternal(logger,
+                    eLoggingSeverity.WARNING, _eInternalMessageId.StartCalledMoreThanOnce, "start was called more than once for this event without calling stop.",
+                    { name, key: name }, true);
+            }
+    
+            _events[name] = +new Date;
+        }
+    
+        _self.stop = (name: string, url: string, properties?: { [key: string]: string }, measurements?: { [key: string]: number }) => {
+            const start = _events[name];
+            if (isNaN(start)) {
+                _throwInternal(logger,
+                    eLoggingSeverity.WARNING, _eInternalMessageId.StopCalledWithoutStart, "stop was called without a corresponding start.",
+                    { name, key: name }, true);
+            } else {
+                const end = +new Date;
+                const duration = dateTimeUtilsDuration(start, end);
+                _self.action(name, url, duration, properties, measurements);
+            }
+    
+            delete _events[name];
+            _events[name] = undefined;
+        }
+    }
+}

package/src/applicationinsights-analytics-js.ts

@@ -1,5 +1,5 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
-export { ApplicationInsights } from "./JavaScriptSDK/ApplicationInsights";
+export { AnalyticsPlugin, AnalyticsPlugin as ApplicationInsights } from "./JavaScriptSDK/AnalyticsPlugin";
 export { IAppInsightsInternal } from "./JavaScriptSDK/Telemetry/PageViewManager";

package/types/JavaScriptSDK/{ApplicationInsights.d.ts → AnalyticsPlugin.d.ts}

@@ -3,22 +3,17 @@
  * @copyright Microsoft 2018
  */
 import { IConfig, IAppInsights, IEventTelemetry, IExceptionTelemetry, ITraceTelemetry, IMetricTelemetry, IAutoExceptionTelemetry, IPageViewTelemetryInternal, IPageViewTelemetry, IPageViewPerformanceTelemetry, IPageViewPerformanceTelemetryInternal } from "@microsoft/applicationinsights-common";
-import { IPlugin, IConfiguration, IAppInsightsCore, BaseTelemetryPlugin, ITelemetryItem, IProcessTelemetryContext, ITelemetryPluginChain, ICustomProperties, ICookieMgr } from "@microsoft/applicationinsights-core-js";
-import { PageViewManager, IAppInsightsInternal } from "./Telemetry/PageViewManager";
-import { PageVisitTimeManager } from "./Telemetry/PageVisitTimeManager";
-import { PageViewPerformanceManager } from "./Telemetry/PageViewPerformanceManager";
-export declare class ApplicationInsights extends BaseTelemetryPlugin implements IAppInsights, IAppInsightsInternal {
+import { IPlugin, IConfiguration, IAppInsightsCore, BaseTelemetryPlugin, ITelemetryItem, IProcessTelemetryContext, ITelemetryPluginChain, ICustomProperties, ICookieMgr, ITelemetryInitializerHandler } from "@microsoft/applicationinsights-core-js";
+import { IAppInsightsInternal } from "./Telemetry/PageViewManager";
+declare function _getDefaultConfig(config?: IConfig): IConfig;
+export declare class AnalyticsPlugin extends BaseTelemetryPlugin implements IAppInsights, IAppInsightsInternal {
     static Version: string;
-    static getDefaultConfig(config?: IConfig): IConfig;
+    static getDefaultConfig: typeof _getDefaultConfig;
     identifier: string;
     priority: number;
     config: IConfig;
     queue: Array<() => void>;
     autoRoutePVDelay: number;
-    protected _telemetryInitializers: Array<(envelope: ITelemetryItem) => boolean | void>;
-    protected _pageViewManager: PageViewManager;
-    protected _pageViewPerformanceManager: PageViewPerformanceManager;
-    protected _pageVisitTimeManager: PageVisitTimeManager;
     constructor();
     /**
      * Get the current cookie manager for this instance
@@ -116,11 +111,11 @@ export declare class ApplicationInsights extends BaseTelemetryPlugin implements
         [key: string]: number;
     }): void;
     /**
-     * @ignore INTERNAL ONLY
-     * @param exception
-     * @param properties
-     * @param systemProperties
-     */
+    * @ignore INTERNAL ONLY
+    * @param exception
+    * @param properties
+    * @param systemProperties
+    */
     sendExceptionInternal(exception: IExceptionTelemetry, customProperties?: {
         [key: string]: any;
     }, systemProperties?: {
@@ -142,6 +137,7 @@ export declare class ApplicationInsights extends BaseTelemetryPlugin implements
      * @memberof ApplicationInsights
      */
     _onerror(exception: IAutoExceptionTelemetry): void;
-    addTelemetryInitializer(telemetryInitializer: (item: ITelemetryItem) => boolean | void): void;
+    addTelemetryInitializer(telemetryInitializer: (item: ITelemetryItem) => boolean | void): ITelemetryInitializerHandler | void;
     initialize(config: IConfiguration & IConfig, core: IAppInsightsCore, extensions: IPlugin[], pluginChain?: ITelemetryPluginChain): void;
 }
+export {};

package/types/JavaScriptSDK/Telemetry/PageViewManager.d.ts

@@ -1,5 +1,5 @@
 import { IPageViewTelemetry, IPageViewTelemetryInternal, IPageViewPerformanceTelemetryInternal } from "@microsoft/applicationinsights-common";
-import { IAppInsightsCore } from "@microsoft/applicationinsights-core-js";
+import { IAppInsightsCore, IProcessTelemetryUnloadContext, ITelemetryUnloadState } from "@microsoft/applicationinsights-core-js";
 import { PageViewPerformanceManager } from "./PageViewPerformanceManager";
 /**
  * Internal interface to pass appInsights object to subcomponents without coupling
@@ -26,4 +26,5 @@ export declare class PageViewManager {
     trackPageView(pageView: IPageViewTelemetry, customProperties?: {
         [key: string]: any;
     }): void;
+    teardown(unloadCtx?: IProcessTelemetryUnloadContext, unloadState?: ITelemetryUnloadState): void;
 }

package/types/JavaScriptSDK/Telemetry/PageViewPerformanceManager.d.ts

@@ -11,20 +11,20 @@ export declare class PageViewPerformanceManager {
     getPerformanceTiming(): PerformanceTiming | null;
     getPerformanceNavigationTiming(): PerformanceNavigationTiming | null;
     /**
-     * Returns true is window PerformanceNavigationTiming API is supported, false otherwise.
-     */
+    * Returns true is window PerformanceNavigationTiming API is supported, false otherwise.
+    */
     isPerformanceNavigationTimingSupported(): boolean;
     /**
-     * Returns true is window performance timing API is supported, false otherwise.
-     */
+    * Returns true is window performance timing API is supported, false otherwise.
+    */
     isPerformanceTimingSupported(): PerformanceTiming;
     /**
-     * As page loads different parts of performance timing numbers get set. When all of them are set we can report it.
-     * Returns true if ready, false otherwise.
-     */
+    * As page loads different parts of performance timing numbers get set. When all of them are set we can report it.
+    * Returns true if ready, false otherwise.
+    */
     isPerformanceTimingDataReady(): boolean;
     /**
-     * This method tells if given durations should be excluded from collection.
-     */
+    * This method tells if given durations should be excluded from collection.
+    */
     shouldCollectDuration(...durations: number[]): boolean;
 }

package/types/JavaScriptSDK/Telemetry/PageVisitTimeManager.d.ts

@@ -13,10 +13,10 @@ export declare class PageVisitTimeManager {
      */
     constructor(logger: IDiagnosticLogger, pageVisitTimeTrackingHandler: (pageName: string, pageUrl: string, pageVisitTime: number) => void);
     /**
-     * Tracks the previous page visit time telemetry (if exists) and starts timing of new page visit time
-     * @param currentPageName Name of page to begin timing for visit duration
-     * @param currentPageUrl Url of page to begin timing for visit duration
-     */
+    * Tracks the previous page visit time telemetry (if exists) and starts timing of new page visit time
+    * @param currentPageName Name of page to begin timing for visit duration
+    * @param currentPageUrl Url of page to begin timing for visit duration
+    */
     trackPreviousPageVisit(currentPageName: string, currentPageUrl: string): void;
     /**
      * Stops timing of current page (if exists) and starts timing for duration of visit to pageName

package/types/JavaScriptSDK/Timing.d.ts

@@ -0,0 +1,18 @@
+import { IDiagnosticLogger } from "@microsoft/applicationinsights-core-js";
+/**
+ * Used to record timed events and page views.
+ */
+export declare class Timing {
+    action: (name?: string, url?: string, duration?: number, properties?: {
+        [key: string]: string;
+    }, measurements?: {
+        [key: string]: number;
+    }) => void;
+    start: (name: string) => void;
+    stop: (name: string, url: string, properties?: {
+        [key: string]: string;
+    }, measurements?: {
+        [key: string]: number;
+    }) => void;
+    constructor(logger: IDiagnosticLogger, name: string);
+}

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

@@ -1,2 +1,2 @@
-export { ApplicationInsights } from "./JavaScriptSDK/ApplicationInsights";
+export { AnalyticsPlugin, AnalyticsPlugin as ApplicationInsights } from "./JavaScriptSDK/AnalyticsPlugin";
 export { IAppInsightsInternal } from "./JavaScriptSDK/Telemetry/PageViewManager";

package/types/tsdoc-metadata.json

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