@microsoft/applicationinsights-core-js 3.0.0-beta.2210-21 → 3.0.0-beta.2211-03

package/src/JavaScriptSDK/AppInsightsCore.ts

@@ -4,8 +4,8 @@
 
 import dynamicProto from "@microsoft/dynamicproto-js";
 import {
-    arrAppend, arrForEach, arrIndexOf, deepExtend, dumpObj, isFunction, isNullOrUndefined, isPlainObject, objDeepFreeze, objDefineProp,
-    objForEachKey, objFreeze, objHasOwn, throwError
+    ITimerHandler, arrAppend, arrForEach, arrIndexOf, deepExtend, dumpObj, hasDocument, isFunction, isNullOrUndefined, isPlainObject,
+    objDeepFreeze, objDefineProp, objForEachKey, objFreeze, objHasOwn, scheduleInterval, throwError
 } from "@nevware21/ts-utils";
 import { createDynamicConfig, onConfigChange } from "../Config/DynamicConfig";
 import { IConfigDefaults } from "../Config/IConfigDefaults";
@@ -43,7 +43,7 @@ import { getDebugListener } from "./DbgExtensionUtils";
 import { DiagnosticLogger, _InternalLogMessage, _throwInternal, _warnToConsole } from "./DiagnosticLogger";
 import { getSetValue, proxyFunctionAs, proxyFunctions, toISOString } from "./HelperFuncs";
 import {
-    STR_CHANNELS, STR_CREATE_PERF_MGR, STR_DISABLED, STR_EXTENSIONS, STR_EXTENSION_CONFIG, UNDEFINED_VALUE
+    STR_CHANNELS, STR_CREATE_PERF_MGR, STR_DISABLED, STR_EMPTY, STR_EXTENSIONS, STR_EXTENSION_CONFIG, UNDEFINED_VALUE
 } from "./InternalConstants";
 import { NotificationManager } from "./NotificationManager";
 import { PerfManager, doPerf, getGblPerfMgr } from "./PerfManager";
@@ -172,6 +172,7 @@ function _findWatcher(listeners: { rm: () => void, w: WatcherFunction<IConfigura
 
     return { i: idx, l: theListener };
 }
+
 function _addDelayedCfgListener(listeners: { rm: () => void, w: WatcherFunction<IConfiguration>}[], newWatcher: WatcherFunction<IConfiguration>) {
     let theListener = _findWatcher(listeners, newWatcher).l;
 
@@ -207,9 +208,26 @@ export class AppInsightsCore implements IAppInsightsCore {
     public config: IConfiguration;
     public logger: IDiagnosticLogger;
 
-    public _extensions: IPlugin[];
+    /**
+     * An array of the installed plugins that provide a version
+     */
+     public readonly pluginVersionStringArr: string[];
+    
+    /**
+     * The formatted string of the installed plugins that contain a version number
+     */
+    public readonly pluginVersionString: string;
+
+    /**
+     * Returns a value that indicates whether the instance has already been previously initialized.
+     */
     public isInitialized: () => boolean;
 
+    /**
+     * Function used to identify the get w parameter used to identify status bit to some channels
+     */
+    public getWParam: () => number;
+
     constructor() {
         // NOTE!: DON'T set default values here, instead set them in the _initDefaults() function as it is also called during teardown()
         let _configHandler: IDynamicConfigHandler<IConfiguration>;
@@ -235,17 +253,26 @@ export class AppInsightsCore implements IAppInsightsCore {
         let _traceCtx: IDistributedTraceContext | null;
         let _instrumentationKey: string | null;
         let _cfgListeners: { rm: () => void, w: WatcherFunction<IConfiguration>}[];
-
+        let _extensions: IPlugin[];
+        let _pluginVersionStringArr: string[];
+        let _pluginVersionString: string;
+    
         /**
          * Internal log poller
          */
-        let _internalLogPoller: number = 0;
+        let _internalLogPoller: ITimerHandler;
+        let _internalLogPollerListening: boolean;
 
         dynamicProto(AppInsightsCore, this, (_self) => {
 
             // Set the default values (also called during teardown)
             _initDefaults();
 
+            // Special internal method to allow the unit tests and DebugPlugin to hook embedded objects
+            _self["_getDbgPlgTargets"] = () => {
+                return [_extensions];
+            };
+
             _self.isInitialized = () => _isInitialized;
 
             // Creating the self.initialize = ()
@@ -299,6 +326,8 @@ export class AppInsightsCore implements IAppInsightsCore {
 
                 _isInitialized = true;
                 _self.releaseQueue();
+
+                _self.pollInternalLogs();
             };
         
             _self.getTransmissionControls = (): IChannelControls[][] => {
@@ -430,22 +459,31 @@ export class AppInsightsCore implements IAppInsightsCore {
             /**
              * Periodically check logger.queue for log messages to be flushed
              */
-            _self.pollInternalLogs = (eventName?: string): number => {
+            _self.pollInternalLogs = (eventName?: string): ITimerHandler => {
                 _internalLogsEventName = eventName || null;
 
-                _addUnloadHook(_configHandler.watch((details) => {
-                    let interval: number = details.cfg.diagnosticLogInterval;
+                function _startLogPoller(config: IConfiguration) {
+                    let interval: number = config.diagnosticLogInterval;
                     if (!interval || !(interval > 0)) {
                         interval = 10000;
                     }
 
-                    if(_internalLogPoller) {
-                        clearInterval(_internalLogPoller);
-                    }
-                    _internalLogPoller = setInterval(() => {
+                    _internalLogPoller && _internalLogPoller.cancel();
+                    _internalLogPoller = scheduleInterval(() => {
                         _flushInternalLogs();
                     }, interval) as any;
-                }));
+                }
+
+                if (!_internalLogPollerListening) {
+                    _internalLogPollerListening = true;
+                    // listen to the configuration
+                    _addUnloadHook(_configHandler.watch((details) => {
+                        _startLogPoller(details.cfg);
+                    }));
+                } else {
+                    // We are being called again, so make sure the poller is running
+                    _startLogPoller(_configHandler.cfg);
+                }
 
                 return _internalLogPoller;
             }
@@ -454,9 +492,9 @@ export class AppInsightsCore implements IAppInsightsCore {
              * Stop polling log messages from logger.queue
              */
             _self.stopPollingInternalLogs = (): void => {
-                if(_internalLogPoller) {
-                    clearInterval(_internalLogPoller);
-                    _internalLogPoller = 0;
+                if (_internalLogPoller) {
+                    _internalLogPoller.cancel();
+                    _internalLogPoller = null;
                     _flushInternalLogs();
                 }
             }
@@ -661,6 +699,36 @@ export class AppInsightsCore implements IAppInsightsCore {
                 }
             };
 
+            _self.getWParam = () => {
+                return (hasDocument() || !!_configHandler.cfg.enableWParam) ? 0 : -1;
+            };
+
+            function _setPluginVersions() {
+                _pluginVersionStringArr = [];
+
+                if (_channelConfig) {
+                    arrForEach(_channelConfig, (channels) => {
+                        if (channels) {
+                            arrForEach(channels, (channel) => {
+                                if (channel.identifier && channel.version) {
+                                    let ver = channel.identifier + "=" + channel.version;
+                                    _pluginVersionStringArr.push(ver);
+                                }
+                            });
+                        }
+                    });
+                }
+
+                if (_configExtensions) {
+                    arrForEach(_configExtensions, (ext) => {
+                        if (ext && ext.identifier && ext.version) {
+                            let ver = ext.identifier + "=" + ext.version;
+                            _pluginVersionStringArr.push(ver);
+                        }
+                    });
+                }
+            }
+
             function _initDefaults() {
                 _isInitialized = false;
 
@@ -680,8 +748,36 @@ export class AppInsightsCore implements IAppInsightsCore {
                     }
                 });
 
+                objDefineProp(_self, "pluginVersionStringArr", {
+                    configurable: true,
+                    enumerable: true,
+                    get: () => {
+                        if (!_pluginVersionStringArr) {
+                            _setPluginVersions();
+                        }
+
+                        return _pluginVersionStringArr;
+                    }
+                });
+
+                objDefineProp(_self, "pluginVersionString", {
+                    configurable: true,
+                    enumerable: true,
+                    get: () => {
+                        if (!_pluginVersionString) {
+                            if (!_pluginVersionStringArr) {
+                                _setPluginVersions();
+                            }
+
+                            _pluginVersionString = _pluginVersionStringArr.join(";");
+                        }
+
+                        return _pluginVersionString || STR_EMPTY;
+                    }
+                });
+
                 _self.logger = new DiagnosticLogger(_configHandler.cfg);
-                _self._extensions = [];
+                _extensions = [];
 
                 _telemetryInitializerPlugin = new TelemetryInitializerPlugin();
                 _eventQueue = [];
@@ -703,6 +799,8 @@ export class AppInsightsCore implements IAppInsightsCore {
                 _instrumentationKey = null;
                 _hooks = [];
                 _cfgListeners = [];
+                _pluginVersionString = null;
+                _pluginVersionStringArr = null;
             }
 
             function _createTelCtx(): IProcessTelemetryContext {
@@ -716,7 +814,9 @@ export class AppInsightsCore implements IAppInsightsCore {
             
                 _coreExtensions = theExtensions.core;
                 _pluginChain = null;
-            
+                _pluginVersionString = null;
+                _pluginVersionStringArr = null;
+    
                 // Sort the complete set of extensions by priority
                 let allExtensions = theExtensions.all;
 
@@ -747,7 +847,7 @@ export class AppInsightsCore implements IAppInsightsCore {
                 _coreExtensions.push(_channelControl);
 
                 // Required to allow plugins to call core.getPlugin() during their own initialization
-                _self._extensions = sortPlugins(allExtensions);
+                _extensions = sortPlugins(allExtensions);
 
                 // Initialize the controls
                 _channelControl.initialize(_configHandler.cfg, _self, allExtensions);
@@ -755,7 +855,7 @@ export class AppInsightsCore implements IAppInsightsCore {
                 initializePlugins(_createTelCtx(), allExtensions);
 
                 // Now reset the extensions to just those being managed by AppInsightsCore
-                _self._extensions = objFreeze(sortPlugins(_coreExtensions || [])).slice();
+                _extensions = objFreeze(sortPlugins(_coreExtensions || [])).slice();
 
                 if (updateState) {
                     _doUpdate(updateState);
@@ -766,7 +866,7 @@ export class AppInsightsCore implements IAppInsightsCore {
                 let theExt: ILoadedPlugin<T> = null;
                 let thePlugin: IPlugin = null;
 
-                arrForEach(_self._extensions, (ext: any) => {
+                arrForEach(_extensions, (ext: any) => {
                     if (ext.identifier === pluginIdentifier && ext !== _channelControl && ext !== _telemetryInitializerPlugin) {
                         thePlugin = ext;
                         return -1;
@@ -849,6 +949,8 @@ export class AppInsightsCore implements IAppInsightsCore {
                         });
 
                         _configExtensions = newConfigExtensions;
+                        _pluginVersionString = null;
+                        _pluginVersionStringArr = null;
 
                         // Re-Create the channel config
                         let newChannelConfig: IChannelControls[][] = [];
@@ -1050,9 +1152,9 @@ export class AppInsightsCore implements IAppInsightsCore {
     /**
      * Periodically check logger.queue for
      */
-    public pollInternalLogs(eventName?: string): number {
+    public pollInternalLogs(eventName?: string): ITimerHandler {
         // @DynamicProtoStub -- DO NOT add any code as this will be removed during packaging
-        return 0;
+        return null;
     }
 
     /**

package/src/JavaScriptSDK.Interfaces/IAppInsightsCore.ts

@@ -17,6 +17,7 @@ import { SendRequestReason } from "../JavaScriptSDK.Enums/SendRequestReason";
 import { IDistributedTraceContext } from "./IDistributedTraceContext";
 import { ILegacyUnloadHook, IUnloadHook } from "./IUnloadHook";
 import { WatcherFunction } from "../Config/IDynamicWatcher";
+import { ITimerHandler } from "@nevware21/ts-utils";
 
 export interface ILoadedPlugin<T extends IPlugin> {
     plugin: T;
@@ -48,6 +49,16 @@ export interface IAppInsightsCore extends IPerfManagerProvider {
 
     logger: IDiagnosticLogger;
 
+    /**
+     * An array of the installed plugins that provide a version
+     */
+    readonly pluginVersionStringArr: string[];
+    
+    /**
+     * The formatted string of the installed plugins that contain a version number
+     */
+    readonly pluginVersionString: string;
+ 
     /**
      * Returns a value that indicates whether the instance has already been previously initialized.
      */
@@ -105,7 +116,7 @@ export interface IAppInsightsCore extends IPerfManagerProvider {
      */
     addTelemetryInitializer(telemetryInitializer: TelemetryInitializerFunction): ITelemetryInitializerHandler;
 
-    pollInternalLogs?(eventName?: string): number;
+    pollInternalLogs?(eventName?: string): ITimerHandler;
 
     stopPollingInternalLogs?(): void;
 
@@ -197,4 +208,9 @@ export interface IAppInsightsCore extends IPerfManagerProvider {
      * @returns A watcher handler instance that can be used to remove itself when being unloaded
      */
     onCfgChange<T extends IConfiguration = IConfiguration>(handler: WatcherFunction<T>): IUnloadHook;
+
+    /**
+     * Function used to identify the get w parameter used to identify status bit to some channels
+     */
+    getWParam: () => number;
 }

package/src/JavaScriptSDK.Interfaces/IConfiguration.ts

@@ -167,4 +167,10 @@ export interface IConfiguration {
      * this will not send any notifications.
      */
     disableDbgExt?: boolean;
+
+    /**
+     * Add "&w=0" parameter to support UA Parsing when web-workers don't have access to Document.
+     * Default is false
+     */
+    enableWParam?: boolean;
 }

package/types/JavaScriptSDK/AppInsightsCore.d.ts

@@ -1,3 +1,4 @@
+import { ITimerHandler } from "@nevware21/ts-utils";
 import { WatcherFunction } from "../Config/IDynamicWatcher";
 import { SendRequestReason } from "../JavaScriptSDK.Enums/SendRequestReason";
 import { IAppInsightsCore, ILoadedPlugin } from "../JavaScriptSDK.Interfaces/IAppInsightsCore";
@@ -21,8 +22,22 @@ export declare class AppInsightsCore implements IAppInsightsCore {
     static defaultConfig: IConfiguration;
     config: IConfiguration;
     logger: IDiagnosticLogger;
-    _extensions: IPlugin[];
+    /**
+     * An array of the installed plugins that provide a version
+     */
+    readonly pluginVersionStringArr: string[];
+    /**
+     * The formatted string of the installed plugins that contain a version number
+     */
+    readonly pluginVersionString: string;
+    /**
+     * Returns a value that indicates whether the instance has already been previously initialized.
+     */
     isInitialized: () => boolean;
+    /**
+     * Function used to identify the get w parameter used to identify status bit to some channels
+     */
+    getWParam: () => number;
     constructor();
     initialize(config: IConfiguration, extensions: IPlugin[], logger?: IDiagnosticLogger, notificationManager?: INotificationManager): void;
     getTransmissionControls(): IChannelControls[][];
@@ -56,7 +71,7 @@ export declare class AppInsightsCore implements IAppInsightsCore {
     /**
      * Periodically check logger.queue for
      */
-    pollInternalLogs(eventName?: string): number;
+    pollInternalLogs(eventName?: string): ITimerHandler;
     /**
      * Periodically check logger.queue for
      */

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

@@ -15,6 +15,7 @@ import { SendRequestReason } from "../JavaScriptSDK.Enums/SendRequestReason";
 import { IDistributedTraceContext } from "./IDistributedTraceContext";
 import { ILegacyUnloadHook, IUnloadHook } from "./IUnloadHook";
 import { WatcherFunction } from "../Config/IDynamicWatcher";
+import { ITimerHandler } from "@nevware21/ts-utils";
 export interface ILoadedPlugin<T extends IPlugin> {
     plugin: T;
     /**
@@ -35,6 +36,14 @@ export interface ILoadedPlugin<T extends IPlugin> {
 export interface IAppInsightsCore extends IPerfManagerProvider {
     config: IConfiguration;
     logger: IDiagnosticLogger;
+    /**
+     * An array of the installed plugins that provide a version
+     */
+    readonly pluginVersionStringArr: string[];
+    /**
+     * The formatted string of the installed plugins that contain a version number
+     */
+    readonly pluginVersionString: string;
     /**
      * Returns a value that indicates whether the instance has already been previously initialized.
      */
@@ -73,7 +82,7 @@ export interface IAppInsightsCore extends IPerfManagerProvider {
      * @returns - A ITelemetryInitializerHandler to enable the initializer to be removed
      */
     addTelemetryInitializer(telemetryInitializer: TelemetryInitializerFunction): ITelemetryInitializerHandler;
-    pollInternalLogs?(eventName?: string): number;
+    pollInternalLogs?(eventName?: string): ITimerHandler;
     stopPollingInternalLogs?(): void;
     /**
      * Return a new instance of the IProcessTelemetryContext for processing events
@@ -152,4 +161,8 @@ export interface IAppInsightsCore extends IPerfManagerProvider {
      * @returns A watcher handler instance that can be used to remove itself when being unloaded
      */
     onCfgChange<T extends IConfiguration = IConfiguration>(handler: WatcherFunction<T>): IUnloadHook;
+    /**
+     * Function used to identify the get w parameter used to identify status bit to some channels
+     */
+    getWParam: () => number;
 }

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

@@ -142,4 +142,9 @@ export interface IConfiguration {
      * this will not send any notifications.
      */
     disableDbgExt?: boolean;
+    /**
+     * Add "&w=0" parameter to support UA Parsing when web-workers don't have access to Document.
+     * Default is false
+     */
+    enableWParam?: boolean;
 }

package/types/__DynamicConstants.d.ts

@@ -9,9 +9,11 @@ export declare const _DYN_ENUMERABLE = "enumerable";
 export declare const _DYN_APPLY = "apply";
 export declare const _DYN_PUSH = "push";
 export declare const _DYN_SPLICE = "splice";
+export declare const _DYN_CANCEL = "cancel";
 export declare const _DYN_INITIALIZE = "initialize";
 export declare const _DYN_IDENTIFIER = "identifier";
 export declare const _DYN_IS_INITIALIZED = "isInitialized";
+export declare const _DYN_POLL_INTERNAL_LOGS = "pollInternalLogs";
 export declare const _DYN_NAME = "name";
 export declare const _DYN_TIME = "time";
 export declare const _DYN_PROCESS_NEXT = "processNext";
@@ -24,8 +26,8 @@ export declare const _DYN_ON_COMPLETE = "onComplete";
 export declare const _DYN_CALL = "call";
 export declare const _DYN_GET_PLUGIN = "getPlugin";
 export declare const _DYN_FLUSH = "flush";
+export declare const _DYN_VERSION = "version";
 export declare const _DYN_LOGGING_LEVEL_CONSOL4 = "loggingLevelConsole";
-export declare const _DYN__EXTENSIONS = "_extensions";
 export declare const _DYN_TEARDOWN = "teardown";
 export declare const _DYN_MESSAGE_ID = "messageId";
 export declare const _DYN_MESSAGE = "message";
@@ -54,4 +56,3 @@ export declare const _DYN_COMPLETE = "complete";
 export declare const _DYN_TRACE_ID = "traceId";
 export declare const _DYN_SPAN_ID = "spanId";
 export declare const _DYN_TRACE_FLAGS = "traceFlags";
-export declare const _DYN_VERSION = "version";

package/types/tsdoc-metadata.json

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