@microsoft/applicationinsights-dependencies-js 2.8.10-nightly.2301-28 → 2.8.10

package/package.json

@@ -1,63 +1,61 @@
-{
-    "name": "@microsoft/applicationinsights-dependencies-js",
-    "version": "2.8.10-nightly.2301-28",
-    "description": "Microsoft Application Insights XHR dependencies plugin",
-    "homepage": "https://github.com/microsoft/ApplicationInsights-JS#readme",
-    "author": "Microsoft Application Insights Team",
-    "main": "dist/applicationinsights-dependencies-js.js",
-    "module": "dist-esm/applicationinsights-dependencies-js.js",
-    "types": "types/applicationinsights-dependencies-js.d.ts",
-    "sideEffects": false,
-    "repository": {
-        "type": "git",
-        "url": "https://github.com/microsoft/ApplicationInsights-JS/tree/master/extensions/applicationinsights-dependencies-js"
-    },
-    "scripts": {
-        "build": "npm run build:esm && npm run build:browser && npm run sri && npm run dtsgen",
-        "build:esm": "grunt deps",
-        "build:browser": "rollup -c",
-        "rebuild": "npm run build",
-        "test": "grunt depstest",
-        "mintest": "grunt deps-mintest",
-        "lint": "tslint -p tsconfig.json",
-        "dtsgen": "api-extractor run --local && node ../../scripts/dtsgen.js \"Microsoft Application Insights XHR dependencies plugin\"",
-        "sri": "node ../../tools/subResourceIntegrity/generateIntegrityFile.js",
-        "ai-min": "grunt deps-min",
-        "ai-restore": "grunt deps-restore"
-    },
-    "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.9.3",
-        "tslib": "^2.0.0",
-        "grunt": "^1.5.3",
-        "grunt-cli": "^1.4.3",
-        "grunt-contrib-qunit": "^6.2.1",
-        "@nevware21/grunt-ts-plugin": "^0.4.3",
-        "@nevware21/grunt-eslint-ts": "^0.2.2",
-        "globby": "^11.0.0",
-        "magic-string": "^0.25.7",
-        "@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.7",
-        "@microsoft/applicationinsights-shims": "2.0.2",
-        "@microsoft/applicationinsights-core-js": "2.8.10-nightly.2301-28",
-        "@microsoft/applicationinsights-common": "2.8.10-nightly.2301-28"
-    },
-    "license": "MIT",
-    "publishConfig": {
-        "tag": "nightly"
-    }
-}
+{
+    "name": "@microsoft/applicationinsights-dependencies-js",
+    "version": "2.8.10",
+    "description": "Microsoft Application Insights XHR dependencies plugin",
+    "homepage": "https://github.com/microsoft/ApplicationInsights-JS#readme",
+    "author": "Microsoft Application Insights Team",
+    "main": "dist/applicationinsights-dependencies-js.js",
+    "module": "dist-esm/applicationinsights-dependencies-js.js",
+    "types": "types/applicationinsights-dependencies-js.d.ts",
+    "sideEffects": false,
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/microsoft/ApplicationInsights-JS/tree/master/extensions/applicationinsights-dependencies-js"
+    },
+    "scripts": {
+        "build": "npm run build:esm && npm run build:browser && npm run sri && npm run dtsgen",
+        "build:esm": "grunt deps",
+        "build:browser": "rollup -c",
+        "rebuild": "npm run build",
+        "test": "grunt depstest",
+        "mintest": "grunt deps-mintest",
+        "lint": "tslint -p tsconfig.json",
+        "dtsgen": "api-extractor run --local && node ../../scripts/dtsgen.js \"Microsoft Application Insights XHR dependencies plugin\"",
+        "sri": "node ../../tools/subResourceIntegrity/generateIntegrityFile.js",
+        "ai-min": "grunt deps-min",
+        "ai-restore": "grunt deps-restore"
+    },
+    "devDependencies": {
+        "@nevware21/ts-async": "^0.1.0",
+        "@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.9.3",
+        "tslib": "^2.0.0",
+        "grunt": "^1.5.3",
+        "grunt-cli": "^1.4.3",
+        "grunt-contrib-qunit": "^6.2.1",
+        "@nevware21/grunt-ts-plugin": "^0.4.3",
+        "@nevware21/grunt-eslint-ts": "^0.2.2",
+        "globby": "^11.0.0",
+        "magic-string": "^0.25.7",
+        "@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.7",
+        "@microsoft/applicationinsights-shims": "2.0.2",
+        "@microsoft/applicationinsights-core-js": "2.8.10",
+        "@microsoft/applicationinsights-common": "2.8.10"
+    },
+    "license": "MIT"
+}

package/src/DependencyInitializer.ts

@@ -23,6 +23,11 @@ export interface IDependencyInitializerDetails {
      * The context that the application can assigned via the dependency listener(s)
      */
     context?: { [key: string]: any };
+
+    /**
+     * [Optional] A flag that indicates whether the client request was manually aborted by the `abort()`
+     */
+    aborted?: boolean;
 }
 
 /**

package/src/DependencyListener.ts

@@ -51,6 +51,13 @@ export interface IDependencyListenerDetails {
      * [Optional] Context that the application can assign that will also be passed to any dependency initializer
      */
     context?: { [key: string]: any };
+
+    /**
+     * [Optional] A flag that indicates whether the client request was manually aborted by the `abort()`,
+     * as listeners are called just before the request is sent it is unlikely that an application would have
+     * called `abort` before `send` this is also available in the dependency initializer.
+     */
+    aborted?: boolean;
 }
 
 /**

package/src/__DynamicConstants.ts

@@ -17,6 +17,7 @@ export const _DYN_TRACE_ID = "traceID";  // Count: 9
 export const _DYN_SPAN_ID = "spanID";  // Count: 8
 export const _DYN_TRACE_FLAGS = "traceFlags";  // Count: 13
 export const _DYN_CONTEXT = "context";  // Count: 7
+export const _DYN_ABORTED = "aborted";  // Count: 7
 export const _DYN_TRACE_ID0 = "traceId";  // Count: 5
 export const _DYN_SPAN_ID1 = "spanId";  // Count: 5
 export const _DYN_CORE = "core";  // Count: 8
@@ -40,8 +41,8 @@ export const _DYN_EXCLUDE_REQUEST_FROM11 = "excludeRequestFromAutoTrackingPatter
 export const _DYN_ADD_REQUEST_CONTEXT = "addRequestContext";  // Count: 2
 export const _DYN_DISABLE_AJAX_TRACKIN12 = "disableAjaxTracking";  // Count: 2
 export const _DYN_DISABLE_FETCH_TRACKI13 = "disableFetchTracking";  // Count: 2
-export const _DYN_STATUS = "status";  // Count: 10
-export const _DYN_STATUS_TEXT = "statusText";  // Count: 8
+export const _DYN_STATUS = "status";  // Count: 11
+export const _DYN_STATUS_TEXT = "statusText";  // Count: 9
 export const _DYN_HEADER_MAP = "headerMap";  // Count: 8
 export const _DYN_OPEN_DONE = "openDone";  // Count: 3
 export const _DYN_SEND_DONE = "sendDone";  // Count: 3
@@ -52,7 +53,7 @@ export const _DYN_GET_TRACE_FLAGS = "getTraceFlags";  // Count: 3
 export const _DYN_METHOD = "method";  // Count: 10
 export const _DYN_ERROR_STATUS_TEXT = "errorStatusText";  // Count: 3
 export const _DYN_STATE_CHANGE_ATTACHE14 = "stateChangeAttached";  // Count: 2
-export const _DYN_RESPONSE_TEXT = "responseText";  // Count: 5
+export const _DYN_RESPONSE_TEXT = "responseText";  // Count: 6
 export const _DYN_RESPONSE_FINISHED_TI15 = "responseFinishedTime";  // Count: 7
 export const _DYN__CREATE_TRACK_ITEM = "CreateTrackItem";  // Count: 3
 export const _DYN_RESPONSE = "response";  // Count: 4

package/src/ajax.ts

@@ -23,7 +23,7 @@ import { IAjaxRecordResponse, ajaxRecord } from "./ajaxRecord";
 const AJAX_MONITOR_PREFIX = "ai.ajxmn.";
 const strDiagLog = "diagLog";
 const strAjaxData = "ajaxData";
-const strFetch = "fetch";
+const STR_FETCH = "fetch";
 
 const ERROR_HEADER = "Failed to monitor XMLHttpRequest";
 const ERROR_PREFIX = ", monitoring data for this ajax call ";
@@ -47,11 +47,11 @@ function _supportsFetch(): (input: RequestInfo, init?: RequestInit) => Promise<R
     if (!_global ||
             isNullOrUndefined((_global as any).Request) ||
             isNullOrUndefined((_global as any).Request[strPrototype]) ||
-            isNullOrUndefined(_global[strFetch])) {
+            isNullOrUndefined(_global[STR_FETCH])) {
         return null;
     }
 
-    return _global[strFetch];
+    return _global[STR_FETCH];
 }
 
 /**
@@ -196,7 +196,8 @@ function _processDependencyListeners(listeners: _IInternalDependencyHandler<Depe
             traceId: ajaxData.traceID,
             spanId: ajaxData.spanID,
             traceFlags: ajaxData.traceFlags,
-            context: ajaxData.context || {}
+            context: ajaxData.context || {},
+            aborted: !!ajaxData.aborted
         };
     
         _processDependencyContainer(core, listeners, details, "listener");
@@ -559,7 +560,7 @@ export class AjaxMonitor extends BaseTelemetryPlugin implements IDependenciesPlu
                 let global = getGlobal();
                 let isPolyfill = (fetch as any).polyfill;
                 if (!_disableFetchTracking && !_fetchInitialized) {
-                    _addHook(InstrumentFunc(global, strFetch, {
+                    _addHook(InstrumentFunc(global, STR_FETCH, {
                         ns: _evtNamespace,
                         // Add request hook
                         req: (callDetails: IInstrumentCallDetails, input, init) => {
@@ -585,12 +586,12 @@ export class AjaxMonitor extends BaseTelemetryPlugin implements IDependenciesPlu
                                     callDetails.rslt = callDetails.rslt.then((response: any) => {
                                         _reportFetchMetrics(callDetails, (response||{}).status, input, response, fetchData, () => {
                                             let ajaxResponse:IAjaxRecordResponse = {
-                                                statusText: response.statusText,
+                                                statusText: (response||{}).statusText,
                                                 headerMap: null,
                                                 correlationContext: _getFetchCorrelationContext(response)
                                             };
     
-                                            if (_enableResponseHeaderTracking) {
+                                            if (_enableResponseHeaderTracking && response) {
                                                 const responseHeaderMap = {};
                                                 response.headers.forEach((value: string, name: string) => {     // @skip-minify
                                                     if (_canIncludeHeaders(name)) {
@@ -607,7 +608,7 @@ export class AjaxMonitor extends BaseTelemetryPlugin implements IDependenciesPlu
                                         return response;
                                     })
                                         .catch((reason: any) => {
-                                            _reportFetchMetrics(callDetails, 0, input, null, fetchData, null, { error: reason.message });
+                                            _reportFetchMetrics(callDetails, 0, input, null, fetchData, null, { error: reason.message || dumpObj(reason) });
                                             throw reason;
                                         });
                                 }
@@ -626,7 +627,7 @@ export class AjaxMonitor extends BaseTelemetryPlugin implements IDependenciesPlu
                     // Note: Polyfill implementations that don't support the "poyyfill" tag are not supported
                     // the workaround is to add a polyfill property to your fetch implementation before initializing
                     // App Insights
-                    _addHook(InstrumentFunc(global, strFetch, {
+                    _addHook(InstrumentFunc(global, STR_FETCH, {
                         ns: _evtNamespace,
                         req: (callDetails: IInstrumentCallDetails, input, init) => {
                             // Just call so that we record any disabled URL
@@ -638,7 +639,7 @@ export class AjaxMonitor extends BaseTelemetryPlugin implements IDependenciesPlu
                 if (isPolyfill) {
                     // retag the instrumented fetch with the same polyfill settings this is mostly for testing
                     // But also supports multiple App Insights usages
-                    (global[strFetch] as any).polyfill = isPolyfill;
+                    (global[STR_FETCH] as any).polyfill = isPolyfill;
                 }
             }
 
@@ -1097,7 +1098,7 @@ export class AjaxMonitor extends BaseTelemetryPlugin implements IDependenciesPlu
 
                 ajaxData.requestHeaders = requestHeaders;
 
-                _createMarkId("fetch", ajaxData);
+                _createMarkId(STR_FETCH, ajaxData);
 
                 return ajaxData;
             }
@@ -1143,7 +1144,7 @@ export class AjaxMonitor extends BaseTelemetryPlugin implements IDependenciesPlu
                 ajaxData.responseFinishedTime = dateTimeUtilsNow();
                 ajaxData.status = status;
 
-                _findPerfResourceEntry("fetch", ajaxData, () => {
+                _findPerfResourceEntry(STR_FETCH, ajaxData, () => {
                     const dependency = ajaxData.CreateTrackItem("Fetch", _enableRequestHeaderTracking, getResponse);
                     
                     let properties;
@@ -1209,7 +1210,8 @@ export class AjaxMonitor extends BaseTelemetryPlugin implements IDependenciesPlu
                         item: dependency,
                         properties: properties,
                         sysProperties: systemProperties,
-                        context: ajaxData ? ajaxData.context : null
+                        context: ajaxData ? ajaxData.context : null,
+                        aborted: ajaxData ? !!ajaxData.aborted : false
                     };
                 
                     result = _processDependencyContainer(core, initializers, details, "initializer");

package/src/ajaxRecord.ts

@@ -240,7 +240,7 @@ export class ajaxRecord {
 
     public xhrMonitoringState: XHRMonitoringState;
 
-    // <summary>Determines whether or not JavaScript exception occured in xhr.onreadystatechange code. 1 if occured, otherwise 0.</summary>
+    // <summary>Determines whether or not JavaScript exception occurred in xhr.onreadystatechange code. 1 if occurred, otherwise 0.</summary>
     public clientFailure: number;
 
     /**
@@ -339,6 +339,11 @@ export class ajaxRecord {
                     [STR_PROPERTIES]: { HttpMethod: self.method }
                 } as IDependencyTelemetry;
 
+                let props = dependency[STR_PROPERTIES];
+                if (self.aborted) {
+                    props.aborted = true;
+                }
+
                 if (self.requestSentTime) {
                     // Set the correct dependency start time
                     dependency.startTime = new Date();
@@ -350,7 +355,6 @@ export class ajaxRecord {
         
                 if (enableRequestHeaderTracking) {
                     if (objKeys(self.requestHeaders).length > 0) {
-                        let props = dependency.properties = dependency.properties || {};
                         props.requestHeaders = self.requestHeaders;
                     }
                 }
@@ -367,19 +371,21 @@ export class ajaxRecord {
         
                         if (response.headerMap) {
                             if (objKeys(response.headerMap).length > 0) {
-                                let props = dependency.properties = dependency.properties || {};
                                 props.responseHeaders = response.headerMap;
                             }
                         }
         
-                        if (self.errorStatusText && self.status >= 400) {
-                            const responseType = response.type;
-                            let props = dependency.properties = dependency.properties || {};
-                            if (responseType === "" || responseType === "text") {
-                                props.responseText = response.responseText ? response.statusText + " - " + response[strResponseText] : response.statusText;
-                            }
-                            if (responseType === "json") {
-                                props.responseText = response.response ? response.statusText + " - " + JSON.stringify(response.response) : response.statusText;
+                        if (self.errorStatusText) {
+                            if (self.status >= 400) {
+                                const responseType = response.type;
+                                if (responseType === "" || responseType === "text") {
+                                    props.responseText = response.responseText ? response.statusText + " - " + response[strResponseText] : response.statusText;
+                                }
+                                if (responseType === "json") {
+                                    props.responseText = response.response ? response.statusText + " - " + JSON.stringify(response.response) : response.statusText;
+                                }
+                            } else if (self.status === 0) {
+                                props.responseText = response.statusText || "";
                             }
                         }
                     }

package/types/DependencyInitializer.d.ts

@@ -23,6 +23,10 @@ export interface IDependencyInitializerDetails {
     context?: {
         [key: string]: any;
     };
+    /**
+     * [Optional] A flag that indicates whether the client request was manually aborted by the `abort()`
+     */
+    aborted?: boolean;
 }
 /**
  * The initializer function that will be called, if it returns false the event will be dropped and not reported

package/types/DependencyListener.d.ts

@@ -42,6 +42,12 @@ export interface IDependencyListenerDetails {
     context?: {
         [key: string]: any;
     };
+    /**
+     * [Optional] A flag that indicates whether the client request was manually aborted by the `abort()`,
+     * as listeners are called just before the request is sent it is unlikely that an application would have
+     * called `abort` before `send` this is also available in the dependency initializer.
+     */
+    aborted?: boolean;
 }
 /**
  * The function that will get called when the ajax request is about to occur.

package/types/__DynamicConstants.d.ts

@@ -5,6 +5,7 @@ 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_CONTEXT = "context";
+export declare const _DYN_ABORTED = "aborted";
 export declare const _DYN_TRACE_ID0 = "traceId";
 export declare const _DYN_SPAN_ID1 = "spanId";
 export declare const _DYN_CORE = "core";

package/types/tsdoc-metadata.json

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