AutoCollection/HttpDependencies.ts

@@ -1,17 +1,14 @@
 import http = require("http");
 import https = require("https");
-import url = require("url");
-
 import Contracts = require("../Declarations/Contracts");
 import TelemetryClient = require("../Library/TelemetryClient");
 import Logging = require("../Library/Logging");
 import Util = require("../Library/Util");
 import RequestResponseHeaders = require("../Library/RequestResponseHeaders");
 import HttpDependencyParser = require("./HttpDependencyParser");
-import { CorrelationContextManager, CorrelationContext, PrivateCustomProperties } from "./CorrelationContextManager";
+import { CorrelationContextManager, PrivateCustomProperties } from "./CorrelationContextManager";
 import CorrelationIdManager = require("../Library/CorrelationIdManager");
 import Traceparent = require("../Library/Traceparent");
-
 import * as DiagChannel from "./diagnostic-channel/initialization";
 
 class AutoCollectHttpDependencies {
@@ -221,10 +218,12 @@ class AutoCollectHttpDependencies {
         // Collect dependency telemetry about the request when it finishes.
         if (telemetry.request.on) {
             telemetry.request.on("response", (response: http.ClientResponse) => {
+                if (telemetry.isProcessed) {
+                    return;
+                }
+                telemetry.isProcessed = true;
                 requestParser.onResponse(response);
-
                 var dependencyTelemetry = requestParser.getDependencyTelemetry(telemetry, uniqueRequestId);
-
                 dependencyTelemetry.contextObjects = dependencyTelemetry.contextObjects || {};
                 dependencyTelemetry.contextObjects["http.RequestOptions"] = telemetry.options;
                 dependencyTelemetry.contextObjects["http.ClientRequest"] = telemetry.request;
@@ -233,10 +232,12 @@ class AutoCollectHttpDependencies {
                 client.trackDependency(dependencyTelemetry);
             });
             telemetry.request.on("error", (error: Error) => {
+                if (telemetry.isProcessed) {
+                    return;
+                }
+                telemetry.isProcessed = true;
                 requestParser.onError(error);
-
                 var dependencyTelemetry = requestParser.getDependencyTelemetry(telemetry, uniqueRequestId);
-
                 dependencyTelemetry.contextObjects = dependencyTelemetry.contextObjects || {};
                 dependencyTelemetry.contextObjects["http.RequestOptions"] = telemetry.options;
                 dependencyTelemetry.contextObjects["http.ClientRequest"] = telemetry.request;
@@ -245,10 +246,12 @@ class AutoCollectHttpDependencies {
                 client.trackDependency(dependencyTelemetry);
             });
             telemetry.request.on("abort", () => {
-                requestParser.onError(new Error());
-
+                if (telemetry.isProcessed) {
+                    return;
+                }
+                telemetry.isProcessed = true;
+                requestParser.onError(new Error("The request has been aborted and the network socket has closed."));
                 var dependencyTelemetry = requestParser.getDependencyTelemetry(telemetry, uniqueRequestId);
-
                 dependencyTelemetry.contextObjects = dependencyTelemetry.contextObjects || {};
                 dependencyTelemetry.contextObjects["http.RequestOptions"] = telemetry.options;
                 dependencyTelemetry.contextObjects["http.ClientRequest"] = telemetry.request;

AutoCollection/HttpRequests.ts

@@ -192,7 +192,7 @@ class AutoCollectHttpRequests {
             Logging.info("AutoCollectHttpRequests.trackRequestSync was called with invalid parameters: ", !telemetry.request, !telemetry.response, !client);
             return;
         }
-
+        telemetry.isProcessed = false;
         AutoCollectHttpRequests.addResponseCorrelationIdHeader(client, telemetry.response);
 
         // store data about the request
@@ -218,7 +218,7 @@ class AutoCollectHttpRequests {
             Logging.info("AutoCollectHttpRequests.trackRequest was called with invalid parameters: ", !telemetry.request, !telemetry.response, !client);
             return;
         }
-
+        telemetry.isProcessed = false;
         // store data about the request
         var correlationContext = CorrelationContextManager.getCurrentContext();
         var requestParser = _requestParser || new HttpRequestParser(telemetry.request, correlationContext && correlationContext.operation.parentId);
@@ -250,6 +250,7 @@ class AutoCollectHttpRequests {
         }
 
         // track an aborted request if an aborted event is emitted
+        // Newer versions of Node.js runtime will trigger error event as well, we need to ensure telemetry is not generated multiple times
         if (telemetry.request.on) {
             telemetry.request.on("aborted", () => {
                 const errorMessage = "The request has been aborted and the network socket has closed.";
@@ -270,6 +271,10 @@ class AutoCollectHttpRequests {
     }
 
     private static endRequest(client: TelemetryClient, requestParser: HttpRequestParser, telemetry: Contracts.NodeHttpRequestTelemetry, ellapsedMilliseconds?: number, error?: any) {
+        if (telemetry.isProcessed) {
+            return;
+        }
+        telemetry.isProcessed = true;
         if (error) {
             requestParser.onError(error, ellapsedMilliseconds);
         } else {

AutoCollection/WebSnippet.ts

@@ -5,10 +5,13 @@ import zlib = require("zlib");
 import Logging = require("../Library/Logging");
 import TelemetryClient = require("../Library/TelemetryClient");
 import snippetInjectionHelper = require("../Library/SnippetInjectionHelper");
+import prefixHelper = require("../Library/PrefixHelper");
 import Statsbeat = require("./Statsbeat");
 import Constants = require("../Declarations/Constants");
 import ConnectionStringParser = require("../Library/ConnectionStringParser");
 import {webSnippet} from "@microsoft/applicationinsights-web-snippet";
+import {IWebInstrumentationConfig} from "../Declarations/Interfaces";
+
 
 class WebSnippet {
 
@@ -21,7 +24,9 @@ class WebSnippet {
     private _isInitialized: boolean;
     private _isIkeyValid: boolean = true;
     private _statsbeat: Statsbeat;
-
+    private _webInstrumentationIkey: string;
+    private _clientWebInstrumentationConfig: IWebInstrumentationConfig[];
+    private _clientWebInstrumentationSrc: string;
 
     constructor(client: TelemetryClient) {
         if (!!WebSnippet.INSTANCE) {
@@ -30,27 +35,22 @@ class WebSnippet {
 
         WebSnippet.INSTANCE = this;
         // AI URL used to validate if snippet already included
-        WebSnippet._aiUrl = "https://js.monitor.azure.com/scripts/b/ai";
-        WebSnippet._aiDeprecatedUrl = "https://az416426.vo.msecnd.net/scripts/b/ai";
-
-        let clientSnippetConnectionString = client.config.webSnippetConnectionString;
-        let defaultIkey = client.config.instrumentationKey;
-        if (!!clientSnippetConnectionString) {
-            let clientSnippetIkey = this._getWebSnippetIkey(client.config.webSnippetConnectionString);
-            defaultIkey = clientSnippetIkey;
-        }
+        WebSnippet._aiUrl = Constants.WEB_INSTRUMENTATION_DEFAULT_SOURCE;
+        WebSnippet._aiDeprecatedUrl = Constants.WEB_INSTRUMENTATION_DEPRECATED_SOURCE;
+
+        let clientWebIkey = this._getWebSnippetIkey(client.config?.webInstrumentationConnectionString);
+        this._webInstrumentationIkey = clientWebIkey || client.config.instrumentationKey;
+        this._clientWebInstrumentationConfig = client.config.webInstrumentationConfig;
+        this._clientWebInstrumentationSrc = client.config.webInstrumentationSrc;
 
-        WebSnippet._snippet = webSnippet.replace("INSTRUMENTATION_KEY", defaultIkey);
         this._statsbeat = client.getStatsbeat();
-
     }
 
-    public enable(isEnabled: boolean, webSnippetConnectionString?: string ) {
+    public enable(isEnabled: boolean, webInstrumentationConnectionString?: string ) {
         this._isEnabled = isEnabled;
-        if (!!webSnippetConnectionString) {
-            let iKey = this._getWebSnippetIkey(webSnippetConnectionString);
-            WebSnippet._snippet = webSnippet.replace("INSTRUMENTATION_KEY", iKey);
-        }
+        this._webInstrumentationIkey = this._getWebSnippetIkey(webInstrumentationConnectionString) || this._webInstrumentationIkey;
+        WebSnippet._snippet = this._getWebInstrumentationReplacedStr();
+
         if (this._isEnabled && !this._isInitialized && this._isIkeyValid) {
             if (this._statsbeat) {
                 this._statsbeat.addFeature(Constants.StatsbeatFeature.WEB_SNIPPET);
@@ -68,13 +68,78 @@ class WebSnippet {
     }
 
     private _getWebSnippetIkey(connectionString: string) {
-        const csCode = ConnectionStringParser.parse(connectionString);
-        const iKeyCode = csCode.instrumentationkey || "";
-        if (!ConnectionStringParser.isIkeyValid(iKeyCode)) {
-            this._isIkeyValid = false;
-            Logging.info("Invalid web snippet connection string, web snippet will not be injected.");
+        let iKey = null;
+        try {
+            const csCode = ConnectionStringParser.parse(connectionString);
+            const iKeyCode = csCode.instrumentationkey || "";
+            if (!ConnectionStringParser.isIkeyValid(iKeyCode)) {
+                this._isIkeyValid = false;
+                Logging.info("Invalid web Instrumentation connection string, web Instrumentation is not enabled.");
+            } else {
+                this._isIkeyValid = true;
+                iKey = iKeyCode;
+            }
+        } catch (err) {
+            Logging.info("get web snippet ikey error: " + err);
         }
-        return iKeyCode;
+        return iKey;
+    }
+
+    private _getWebInstrumentationReplacedStr() {
+        let configStr = this._getClientWebInstrumentationConfigStr(this._clientWebInstrumentationConfig);
+        let osStr = prefixHelper.getOsPrefix();
+        let rpStr = prefixHelper.getResourceProvider();
+        let snippetReplacedStr = `${this._webInstrumentationIkey}\",\r\n${configStr} disableIkeyDeprecationMessage: true,\r\n sdkExtension: \"${rpStr}${osStr}d_n_`;
+        let replacedSnippet = webSnippet.replace("INSTRUMENTATION_KEY", snippetReplacedStr);
+        if (this._clientWebInstrumentationSrc) {
+            return replacedSnippet.replace(`${Constants.WEB_INSTRUMENTATION_DEFAULT_SOURCE}.2.min.js`,this._clientWebInstrumentationSrc);
+        }
+        return replacedSnippet;
+    }
+
+    // Do not use string replace here, because double quote should be kept.
+    // we want to transfer all values of config to the web snippet in the following way:
+    // cfg: {
+    //      config1: "config1 string value",
+    //      config2: true,
+    //      config3: 1,
+    //      ...
+    //}});
+    private _getClientWebInstrumentationConfigStr(config: IWebInstrumentationConfig[]) {
+        let configStr = "";
+        try {
+            if (config != undefined && config.length > 0) {
+                config.forEach((item) =>{
+                    let key = item.name;
+                    if (key === undefined) return;
+                    let val = item.value;
+                    let entry = "";
+                    // NOTE: users should convert object/function to string themselves
+                    // Type "function" and "object" will be skipped!
+                    switch(typeof val) {
+                        case "function":
+                            break;
+                        case "object":
+                            break;
+                        case "string":
+                            entry = ` ${key}: \"${val}\",\r\n`;
+                            configStr += entry;
+                            break;
+                        default:
+                            entry = ` ${key}: ${val},\r\n`;
+                            configStr += entry;
+                            break;
+                    }
+
+                });
+            }
+
+        } catch (e) {
+            // if has any errors here, web Instrumentation will be disabled.
+            this._isEnabled = false;
+            Logging.info("Parse client web instrumentation error. Web Instrumentation is disabled");
+        }
+        return configStr;
     }
 
     private _initialize() {
@@ -215,16 +280,19 @@ class WebSnippet {
      * Validate response and try to inject Web snippet
      */
     public ValidateInjection(response: http.ServerResponse, input: string | Buffer): boolean {
-
-        if (!response || !input || response.statusCode != 200) return false;
-        let isContentHtml =  snippetInjectionHelper.isContentTypeHeaderHtml(response);
-        if (!isContentHtml) return false;
-        let inputStr = input.slice().toString();
-        if (inputStr.indexOf("<head>") >= 0 && inputStr.indexOf("</head>") >= 0) {
-            // Check if snippet not already present looking for AI Web SDK URL
-            if (inputStr.indexOf(WebSnippet._aiUrl) < 0 && inputStr.indexOf(WebSnippet._aiDeprecatedUrl) < 0) {
-                return true;
+        try {
+            if (!response || !input || response.statusCode != 200) return false;
+            let isContentHtml =  snippetInjectionHelper.isContentTypeHeaderHtml(response);
+            if (!isContentHtml) return false;
+            let inputStr = input.slice().toString();
+            if (inputStr.indexOf("<head>") >= 0 && inputStr.indexOf("</head>") >= 0) {
+                // Check if snippet not already present looking for AI Web SDK URL
+                if (inputStr.indexOf(WebSnippet._aiUrl) < 0 && inputStr.indexOf(WebSnippet._aiDeprecatedUrl) < 0) {
+                    return true;
+                }
             }
+        } catch (err) {
+            Logging.info("validate injections error: " + err);
         }
         return false;
     }
@@ -273,34 +341,39 @@ class WebSnippet {
     // and also this function do not support partial compression as well
     // need more investigation
     private _getInjectedCompressBuffer(response: http.ServerResponse, input: Buffer, encodeType: snippetInjectionHelper.contentEncodingMethod): Buffer {
-        switch (encodeType) {
-            case snippetInjectionHelper.contentEncodingMethod.GZIP:
-                let gunzipBuffer = zlib.gunzipSync(input);
-                if (this.ValidateInjection(response,gunzipBuffer)) {
-                    let injectedGunzipBuffer = this.InjectWebSnippet(response, gunzipBuffer);
-                    input = zlib.gzipSync(injectedGunzipBuffer);
-                 }
-                 break;
-            case snippetInjectionHelper.contentEncodingMethod.DEFLATE:
-                let inflateBuffer = zlib.inflateSync(input);
-                if (this.ValidateInjection(response,inflateBuffer)) {
-                    let injectedInflateBuffer = this.InjectWebSnippet(response, inflateBuffer);
-                    input = zlib.deflateSync(injectedInflateBuffer);
-                 }
-                 break;
-            case snippetInjectionHelper.contentEncodingMethod.BR:
-                let BrotliDecompressSync = snippetInjectionHelper.getBrotliDecompressSync(zlib);
-                let BrotliCompressSync = snippetInjectionHelper.getBrotliCompressSync(zlib);
-                if (BrotliDecompressSync && BrotliCompressSync) {
-                    let decompressBuffer = BrotliDecompressSync(input);
-                    if (this.ValidateInjection(response,decompressBuffer)) {
-                        let injectedDecompressBuffer = this.InjectWebSnippet(response, decompressBuffer);
-                        input = BrotliCompressSync(injectedDecompressBuffer);
+        try {
+            switch (encodeType) {
+                case snippetInjectionHelper.contentEncodingMethod.GZIP:
+                    let gunzipBuffer = zlib.gunzipSync(input);
+                    if (this.ValidateInjection(response,gunzipBuffer)) {
+                        let injectedGunzipBuffer = this.InjectWebSnippet(response, gunzipBuffer);
+                        input = zlib.gzipSync(injectedGunzipBuffer);
                      }
                      break;
-                }
-        }
+                case snippetInjectionHelper.contentEncodingMethod.DEFLATE:
+                    let inflateBuffer = zlib.inflateSync(input);
+                    if (this.ValidateInjection(response,inflateBuffer)) {
+                        let injectedInflateBuffer = this.InjectWebSnippet(response, inflateBuffer);
+                        input = zlib.deflateSync(injectedInflateBuffer);
+                     }
+                     break;
+                case snippetInjectionHelper.contentEncodingMethod.BR:
+                    let BrotliDecompressSync = snippetInjectionHelper.getBrotliDecompressSync(zlib);
+                    let BrotliCompressSync = snippetInjectionHelper.getBrotliCompressSync(zlib);
+                    if (BrotliDecompressSync && BrotliCompressSync) {
+                        let decompressBuffer = BrotliDecompressSync(input);
+                        if (this.ValidateInjection(response,decompressBuffer)) {
+                            let injectedDecompressBuffer = this.InjectWebSnippet(response, decompressBuffer);
+                            input = BrotliCompressSync(injectedDecompressBuffer);
+                         }
+                         break;
+                    }
+            }
 
+        } catch (err) {
+            Logging.info("get web injection compress buffer error: " + err);
+        }
+
         return input;
     }
 

Declarations/Constants.ts

@@ -1,6 +1,6 @@
 import Contracts = require("./Contracts")
 
-export const APPLICATION_INSIGHTS_SDK_VERSION = "2.3.5";
+export const APPLICATION_INSIGHTS_SDK_VERSION = "2.3.6";
 export const DEFAULT_BREEZE_ENDPOINT = "https://dc.services.visualstudio.com";
 export const DEFAULT_LIVEMETRICS_ENDPOINT = "https://rt.services.visualstudio.com";
 export const DEFAULT_LIVEMETRICS_HOST = "rt.services.visualstudio.com";
@@ -199,4 +199,7 @@ export const MessageBusDestination = "message_bus.destination";
   * AI time since enqueued attribute.
   * @internal
   */
- export const TIME_SINCE_ENQUEUED = "timeSinceEnqueued";
+ export const TIME_SINCE_ENQUEUED = "timeSinceEnqueued";
+
+ export const WEB_INSTRUMENTATION_DEFAULT_SOURCE= "https://js.monitor.azure.com/scripts/b/ai";
+ export const WEB_INSTRUMENTATION_DEPRECATED_SOURCE= "https://az416426.vo.msecnd.net/scripts/b/ai";

Declarations/Contracts/TelemetryTypes/NodeHttpDependencyTelemetry.ts

@@ -16,4 +16,10 @@ export interface NodeHttpDependencyTelemetry extends Telemetry
      * Outgoing HTTP request object
      */
     request: http.ClientRequest;
+
+    /**
+     * Flag to determine if telemetry had been processed.
+     */
+     isProcessed?: boolean;
+
 }