@microsoft/applicationinsights-properties-js 2.8.4-nightly.2205-08 → 2.8.4

package/package.json

@@ -1,61 +1,58 @@
-{
-    "name": "@microsoft/applicationinsights-properties-js",
-    "version": "2.8.4-nightly.2205-08",
-    "description": "Microsoft Application Insights properties (Part A) plugin",
-    "homepage": "https://github.com/microsoft/ApplicationInsights-JS#readme",
-    "author": "Microsoft Application Insights Team",
-    "main": "dist/applicationinsights-properties-js.js",
-    "module": "dist-esm/applicationinsights-properties-js.js",
-    "types": "types/applicationinsights-properties-js.d.ts",
-    "sideEffects": false,
-    "repository": {
-        "type": "git",
-        "url": "https://github.com/microsoft/ApplicationInsights-JS/tree/master/extensions/applicationinsights-properties-js"
-    },
-    "scripts": {
-        "build": "npm run build:esm && npm run build:browser && npm run sri && npm run dtsgen",
-        "build:esm": "grunt properties",
-        "build:browser": "rollup -c",
-        "rebuild": "npm run build",
-        "test": "grunt propertiestests",
-        "lint": "tslint -p tsconfig.json",
-        "dtsgen": "api-extractor run --local && node ../../scripts/dtsgen.js \"Microsoft Application Insights properties plugin\"",
-        "sri": "node ../../tools/subResourceIntegrity/generateIntegrityFile.js"
-    },
-    "devDependencies": {
-        "@microsoft/ai-test-framework": "0.0.1",
-        "@microsoft/applicationinsights-rollup-plugin-uglify3-js": "1.0.0",
-        "@microsoft/applicationinsights-rollup-es3": "1.1.3",
-        "@microsoft/api-extractor": "^7.18.1",
-        "typescript": "^4.3.4",
-        "tslib": "^2.0.0",
-        "grunt": "^1.5.3",
-        "grunt-cli": "^1.4.3",
-        "grunt-contrib-qunit": "^5.0.1",
-        "@nevware21/grunt-ts-plugin": "^0.4.3",
-        "@nevware21/grunt-eslint-ts": "^0.2.2",
-        "globby": "^11.0.0",
-        "magic-string": "^0.25.7",
-        "pako": "^2.0.3",
-        "@rollup/plugin-commonjs": "^18.0.0",
-        "@rollup/plugin-node-resolve": "^11.2.1",
-        "@rollup/plugin-replace": "^2.3.3",
-        "rollup-plugin-cleanup": "^3.2.1",
-        "rollup": "^2.32.0",
-        "qunit": "^2.11.2",
-        "sinon": "^7.3.1"
-    },
-    "peerDependencies": {
-        "tslib": "*"
-    },
-    "dependencies": {
-        "@microsoft/dynamicproto-js": "^1.1.6",
-        "@microsoft/applicationinsights-shims": "2.0.1",
-        "@microsoft/applicationinsights-core-js": "2.8.4-nightly.2205-08",
-        "@microsoft/applicationinsights-common": "2.8.4-nightly.2205-08"
-    },
-    "license": "MIT",
-    "publishConfig": {
-        "tag": "nightly"
-    }
-}
+{
+    "name": "@microsoft/applicationinsights-properties-js",
+    "version": "2.8.4",
+    "description": "Microsoft Application Insights properties (Part A) plugin",
+    "homepage": "https://github.com/microsoft/ApplicationInsights-JS#readme",
+    "author": "Microsoft Application Insights Team",
+    "main": "dist/applicationinsights-properties-js.js",
+    "module": "dist-esm/applicationinsights-properties-js.js",
+    "types": "types/applicationinsights-properties-js.d.ts",
+    "sideEffects": false,
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/microsoft/ApplicationInsights-JS/tree/master/extensions/applicationinsights-properties-js"
+    },
+    "scripts": {
+        "build": "npm run build:esm && npm run build:browser && npm run sri && npm run dtsgen",
+        "build:esm": "grunt properties",
+        "build:browser": "rollup -c",
+        "rebuild": "npm run build",
+        "test": "grunt propertiestests",
+        "lint": "tslint -p tsconfig.json",
+        "dtsgen": "api-extractor run --local && node ../../scripts/dtsgen.js \"Microsoft Application Insights properties plugin\"",
+        "sri": "node ../../tools/subResourceIntegrity/generateIntegrityFile.js"
+    },
+    "devDependencies": {
+        "@microsoft/ai-test-framework": "0.0.1",
+        "@microsoft/applicationinsights-rollup-plugin-uglify3-js": "1.0.0",
+        "@microsoft/applicationinsights-rollup-es3": "1.1.3",
+        "@microsoft/api-extractor": "^7.18.1",
+        "typescript": "^4.3.4",
+        "tslib": "^2.0.0",
+        "grunt": "^1.5.3",
+        "grunt-cli": "^1.4.3",
+        "grunt-contrib-qunit": "^5.0.1",
+        "@nevware21/grunt-ts-plugin": "^0.4.3",
+        "@nevware21/grunt-eslint-ts": "^0.2.2",
+        "globby": "^11.0.0",
+        "magic-string": "^0.25.7",
+        "pako": "^2.0.3",
+        "@rollup/plugin-commonjs": "^18.0.0",
+        "@rollup/plugin-node-resolve": "^11.2.1",
+        "@rollup/plugin-replace": "^2.3.3",
+        "rollup-plugin-cleanup": "^3.2.1",
+        "rollup": "^2.32.0",
+        "qunit": "^2.11.2",
+        "sinon": "^7.3.1"
+    },
+    "peerDependencies": {
+        "tslib": "*"
+    },
+    "dependencies": {
+        "@microsoft/dynamicproto-js": "^1.1.6",
+        "@microsoft/applicationinsights-shims": "2.0.1",
+        "@microsoft/applicationinsights-core-js": "2.8.4",
+        "@microsoft/applicationinsights-common": "2.8.4"
+    },
+    "license": "MIT"
+}

package/src/Context/Internal.ts

@@ -4,7 +4,7 @@
 import { IInternal } from "@microsoft/applicationinsights-common";
 import { ITelemetryConfig } from "../Interfaces/ITelemetryConfig";
 
-const Version = "2.8.4-nightly.2205-08";
+const Version = "2.8.4";
 
 export class Internal implements IInternal {
 

package/src/Context/TelemetryTrace.ts

@@ -9,18 +9,18 @@ export class TelemetryTrace implements ITelemetryTrace {
     public traceID: string;
     public parentID: string;
     public traceState: ITraceState;
+    public traceFlags: number;
     public name: string;
 
     constructor(id?: string, parentId?: string, name?: string, logger?: IDiagnosticLogger) {
         const _self = this;
         _self.traceID = id || generateW3CId();
         _self.parentID = parentId;
-        _self.name = name;
         let location = getLocation();
         if (!name && location && location.pathname) {
-            _self.name = location.pathname;
+            name = location.pathname;
         }
 
-        _self.name = dataSanitizeString(logger, _self.name);
+        _self.name = dataSanitizeString(logger, name);
     }
 }

package/src/PropertiesPlugin.ts

@@ -7,10 +7,10 @@ import dynamicProto from "@microsoft/dynamicproto-js";
 import {
     BaseTelemetryPlugin, IConfiguration, isNullOrUndefined,
     IAppInsightsCore, IPlugin, ITelemetryItem, IProcessTelemetryContext, _InternalLogMessage, eLoggingSeverity, _eInternalMessageId, getNavigator,
-    ITelemetryPluginChain, objForEachKey, getSetValue, _logInternalMessage
+    ITelemetryPluginChain, objForEachKey, getSetValue, _logInternalMessage, IProcessTelemetryUnloadContext, ITelemetryUnloadState, IDistributedTraceContext
 } from "@microsoft/applicationinsights-core-js";
 import { TelemetryContext } from "./TelemetryContext";
-import { PageView, IConfig, BreezeChannelIdentifier, PropertiesPluginIdentifier, IPropertiesPlugin, getExtensionByName } from "@microsoft/applicationinsights-common";
+import { PageView, IConfig, BreezeChannelIdentifier, PropertiesPluginIdentifier, IPropertiesPlugin, createDistributedTraceContextFromTrace } from "@microsoft/applicationinsights-common";
 import { ITelemetryConfig } from "./Interfaces/ITelemetryConfig";
 import { IPropTelemetryContext } from "./Interfaces/IPropTelemetryContext";
 
@@ -46,11 +46,14 @@ export default class PropertiesPlugin extends BaseTelemetryPlugin implements IPr
     constructor() {
         super();
 
-        let _breezeChannel: IPlugin; // optional. If exists, grab appId from it
         let _extensionConfig: ITelemetryConfig;
+        let _distributedTraceCtx: IDistributedTraceContext;
+        let _previousTraceCtx: IDistributedTraceContext;
 
         dynamicProto(PropertiesPlugin, this, (_self, _base) => {
 
+            _initDefaults();
+
             _self.initialize = (config: IConfiguration & IConfig, core: IAppInsightsCore, extensions: IPlugin[], pluginChain?:ITelemetryPluginChain) => {
                 _base.initialize(config, core, extensions, pluginChain);
                 let ctx = _self._getTelCtx();
@@ -58,12 +61,17 @@ export default class PropertiesPlugin extends BaseTelemetryPlugin implements IPr
                 const defaultConfig: ITelemetryConfig = PropertiesPlugin.getDefaultConfig();
                 _extensionConfig = _extensionConfig || {} as ITelemetryConfig;
                 objForEachKey(defaultConfig, (field, value) => {
-                    _extensionConfig[field] = () => ctx.getConfig(identifier, field, value());
+                    _extensionConfig[field] = () => ctx.getConfig(identifier, field, value() as any);
                 });
     
-                _self.context = new TelemetryContext(core, _extensionConfig);
-                _breezeChannel = getExtensionByName(extensions, BreezeChannelIdentifier);
-                _self.context.appId = () => _breezeChannel ? _breezeChannel["_appId"] : null;
+                _previousTraceCtx = core.getTraceCtx(false);
+                _self.context = new TelemetryContext(core, _extensionConfig, _previousTraceCtx);
+                _distributedTraceCtx = createDistributedTraceContextFromTrace(_self.context.telemetryTrace, _previousTraceCtx);
+                core.setTraceCtx(_distributedTraceCtx);
+                _self.context.appId = () => {
+                    let breezeChannel = core.getPlugin<IPlugin>(BreezeChannelIdentifier);
+                    return breezeChannel ? breezeChannel.plugin["_appId"] : null;
+                };
 
                 // Test hook to allow accessing the internal values -- explicitly not defined as an available property on the class
                 _self["_extConfig"] = _extensionConfig;
@@ -108,7 +116,25 @@ export default class PropertiesPlugin extends BaseTelemetryPlugin implements IPr
                     _self.processNext(event, itemCtx);
                 }
             };
+
+            _self._doTeardown = (unloadCtx?: IProcessTelemetryUnloadContext, unloadState?: ITelemetryUnloadState) => {
+                let core = (unloadCtx || {} as any).core();
+                if (core && core.getTraceCtx) {
+                    let traceCtx = core.getTraceCtx(false);
+                    if (traceCtx === _distributedTraceCtx) {
+                        core.setTraceCtx(_previousTraceCtx);
+                    }
+                }
+
+                _initDefaults();
+            };
     
+            function _initDefaults() {
+                _extensionConfig = null;
+                _distributedTraceCtx = null;
+                _previousTraceCtx = null;
+            }
+
             function _processTelemetryInternal(evt: ITelemetryItem, itemCtx: IProcessTelemetryContext) {
                 // Set Part A fields
                 getSetValue(evt, "tags", []);

package/src/TelemetryContext.ts

@@ -4,7 +4,7 @@
  */
 
 import dynamicProto from "@microsoft/dynamicproto-js";
-import { ITelemetryItem, IProcessTelemetryContext, IAppInsightsCore, isString, objKeys, hasWindow, _InternalLogMessage, setValue, getSetValue } from "@microsoft/applicationinsights-core-js";
+import { ITelemetryItem, IProcessTelemetryContext, IAppInsightsCore, isString, objKeys, hasWindow, _InternalLogMessage, setValue, getSetValue, IDistributedTraceContext } from "@microsoft/applicationinsights-core-js";
 import { Session, _SessionManager } from "./Context/Session";
 import { Extensions, IOperatingSystem, ITelemetryTrace, IWeb, CtxTagKeys, PageView, IApplication, IDevice, ILocation, IUserContext, IInternal, ISession } from "@microsoft/applicationinsights-common";
 import { Application } from "./Context/Application";
@@ -40,7 +40,7 @@ export class TelemetryContext implements IPropTelemetryContext {
     public appId: () => string;
     public getSessionId: () => string;
 
-    constructor(core: IAppInsightsCore, defaultConfig: ITelemetryConfig) {
+    constructor(core: IAppInsightsCore, defaultConfig: ITelemetryConfig, previousTraceCtx?: IDistributedTraceContext) {
         let logger = core.logger
         this.appId = () => null;
         this.getSessionId = () => null;
@@ -53,7 +53,16 @@ export class TelemetryContext implements IPropTelemetryContext {
                 _self.device = new Device();
                 _self.location = new Location();
                 _self.user = new User(defaultConfig, core);
-                _self.telemetryTrace = new TelemetryTrace(undefined, undefined, undefined, logger);
+
+                let traceId: string;
+                let parentId: string;
+                let name: string;
+                if (previousTraceCtx) {
+                    traceId = previousTraceCtx.getTraceId();
+                    parentId = previousTraceCtx.getSpanId();
+                    name = previousTraceCtx.getName();
+                }
+                _self.telemetryTrace = new TelemetryTrace(traceId, parentId, name, logger);
                 _self.session = new Session();
             }
 

package/types/Context/TelemetryTrace.d.ts

@@ -4,6 +4,7 @@ export declare class TelemetryTrace implements ITelemetryTrace {
     traceID: string;
     parentID: string;
     traceState: ITraceState;
+    traceFlags: number;
     name: string;
     constructor(id?: string, parentId?: string, name?: string, logger?: IDiagnosticLogger);
 }

package/types/TelemetryContext.d.ts

@@ -2,7 +2,7 @@
  * TelemetryContext.ts
  * @copyright Microsoft 2018
  */
-import { ITelemetryItem, IProcessTelemetryContext, IAppInsightsCore } from "@microsoft/applicationinsights-core-js";
+import { ITelemetryItem, IProcessTelemetryContext, IAppInsightsCore, IDistributedTraceContext } from "@microsoft/applicationinsights-core-js";
 import { _SessionManager } from "./Context/Session";
 import { IOperatingSystem, ITelemetryTrace, IWeb, IApplication, IDevice, ILocation, IUserContext, IInternal, ISession } from "@microsoft/applicationinsights-common";
 import { ITelemetryConfig } from "./Interfaces/ITelemetryConfig";
@@ -20,7 +20,7 @@ export declare class TelemetryContext implements IPropTelemetryContext {
     web: IWeb;
     appId: () => string;
     getSessionId: () => string;
-    constructor(core: IAppInsightsCore, defaultConfig: ITelemetryConfig);
+    constructor(core: IAppInsightsCore, defaultConfig: ITelemetryConfig, previousTraceCtx?: IDistributedTraceContext);
     applySessionContext(evt: ITelemetryItem, itemCtx?: IProcessTelemetryContext): void;
     applyOperatingSystemContxt(event: ITelemetryItem, itemCtx?: IProcessTelemetryContext): void;
     applyApplicationContext(event: ITelemetryItem, itemCtx?: IProcessTelemetryContext): void;

package/types/tsdoc-metadata.json

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