parse nonstring request-context header

AutoCollection/HttpDependencies.ts

@@ -122,31 +122,24 @@ class AutoCollectHttpDependencies {
         // methods exist before invoking them.
         if (Util.canIncludeCorrelationHeader(client, requestParser.getUrl()) && telemetry.request.getHeader && telemetry.request.setHeader) {
             if (client.config && client.config.correlationId) {
-                const correlationHeader = telemetry.request.getHeader(RequestResponseHeaders.requestContextHeader);
-                if (correlationHeader) {
-                    const components = correlationHeader.split(",");
-                    const key = `${RequestResponseHeaders.requestContextSourceKey}=`;
-                    if (!components.some((value) => value.substring(0,key.length) === key)) {
-                        telemetry.request.setHeader(
-                            RequestResponseHeaders.requestContextHeader,
-                            `${correlationHeader},${RequestResponseHeaders.requestContextSourceKey}=${client.config.correlationId}`);
+                // getHeader returns "any" type in newer versions of node. In basic scenarios, this will be <string | string[] | number>, but could be modified to anything else via middleware
+                const correlationHeader = <any>telemetry.request.getHeader(RequestResponseHeaders.requestContextHeader)
+                Util.safeIncludeCorrelationHeader(client, telemetry.request, correlationHeader);
+
+                if (currentContext && currentContext.operation) {
+                    try {
+                        telemetry.request.setHeader(RequestResponseHeaders.requestIdHeader, uniqueRequestId);
+                        // Also set legacy headers
+                        telemetry.request.setHeader(RequestResponseHeaders.parentIdHeader, currentContext.operation.id);
+                        telemetry.request.setHeader(RequestResponseHeaders.rootIdHeader, uniqueRequestId);
+
+                        const correlationContextHeader = (<PrivateCustomProperties>currentContext.customProperties).serializeToHeader();
+                        if (correlationContextHeader) {
+                            telemetry.request.setHeader(RequestResponseHeaders.correlationContextHeader, correlationContextHeader);
+                        }
+                    } catch (err) {
+                        Logging.warn("Correlation headers could not be set. Correlation of requests may be lost.", err);
                     }
-                } else {
-                    telemetry.request.setHeader(
-                        RequestResponseHeaders.requestContextHeader,
-                        `${RequestResponseHeaders.requestContextSourceKey}=${client.config.correlationId}`);
-                }
-            }
-
-            if (currentContext && currentContext.operation) {
-                telemetry.request.setHeader(RequestResponseHeaders.requestIdHeader, uniqueRequestId);
-                // Also set legacy headers
-                telemetry.request.setHeader(RequestResponseHeaders.parentIdHeader, currentContext.operation.id);
-                telemetry.request.setHeader(RequestResponseHeaders.rootIdHeader, uniqueRequestId);
-
-                const correlationContextHeader = (<PrivateCustomProperties>currentContext.customProperties).serializeToHeader();
-                if (correlationContextHeader) {
-                    telemetry.request.setHeader(RequestResponseHeaders.correlationContextHeader, correlationContextHeader);
                 }
             }
         }

AutoCollection/HttpRequests.ts

@@ -238,20 +238,8 @@ class AutoCollectHttpRequests {
     private static addResponseCorrelationIdHeader(client: TelemetryClient, response:http.ServerResponse) {
         if (client.config && client.config.correlationId &&
             response.getHeader && response.setHeader && !(<any>response).headersSent) {
-            const correlationHeader = response.getHeader(RequestResponseHeaders.requestContextHeader);
-            if (correlationHeader) {
-                const components = correlationHeader.split(",");
-                const key = `${RequestResponseHeaders.requestContextSourceKey}=`;
-                if (!components.some((value) => value.substring(0,key.length) === key)) {
-                    response.setHeader(
-                        RequestResponseHeaders.requestContextHeader,
-                        `${correlationHeader},${RequestResponseHeaders.requestContextSourceKey}=${client.config.correlationId}`);
-                }
-            } else {
-                response.setHeader(
-                    RequestResponseHeaders.requestContextHeader,
-                    `${RequestResponseHeaders.requestContextSourceKey}=${client.config.correlationId}`);
-            }
+            const correlationHeader = <any>response.getHeader(RequestResponseHeaders.requestContextHeader);
+            Util.safeIncludeCorrelationHeader(client, response, correlationHeader);
         }
     }
 

Library/Util.ts

@@ -255,6 +255,7 @@ class Util {
         }
     }
 
+
     /**
      * Generate request
      *
@@ -331,5 +332,44 @@ class Util {
         }
 
     };
+
+    /**
+     * Parse standard <string | string[] | number> request-context header
+     */
+    public static safeIncludeCorrelationHeader(client: TelemetryClient, request: http.ClientRequest | http.ServerResponse, correlationHeader: any) {
+        let header: string; // attempt to cast correlationHeader to string
+        if (typeof correlationHeader === "string") {
+            header = correlationHeader;
+        } else if (correlationHeader instanceof Array) { // string[]
+            header = correlationHeader.join(",");
+        } else if (correlationHeader && typeof (correlationHeader as any).toString === "function") {
+            // best effort attempt: requires well-defined toString
+            try {
+                header = (correlationHeader as any).toString();
+            } catch (err) {
+                Logging.warn("Outgoing request-context header could not be read. Correlation of requests may be lost.", err, correlationHeader);
+            }
+        }
+
+        if (header) {
+            Util.addCorrelationIdHeaderFromString(client, request, header);
+        } else {
+            request.setHeader(
+                RequestResponseHeaders.requestContextHeader,
+                `${RequestResponseHeaders.requestContextSourceKey}=${client.config.correlationId}`);
+        }
+    }
+
+    private static addCorrelationIdHeaderFromString(client: TelemetryClient, response: http.ClientRequest | http.ServerResponse, correlationHeader: string) {
+        const components = correlationHeader.split(",");
+        const key = `${RequestResponseHeaders.requestContextSourceKey}=`;
+        const found = components.some(value => value.substring(0,key.length) === key);
+
+        if (!found) {
+            response.setHeader(
+                RequestResponseHeaders.requestContextHeader,
+                `${correlationHeader},${RequestResponseHeaders.requestContextSourceKey}=${client.config.correlationId}`);
+        }
+    }
 }
 export = Util;

Tests/AutoCollection/HttpDependencies.tests.ts

@@ -22,4 +22,46 @@ describe("AutoCollection/HttpDependencies", () => {
             assert.equal(enableHttpDependenciesSpy.getCall(1).args[0], false);
         });
     });
+    describe("#trackRequest", () => {
+        var telemetry = {
+            options: {},
+            request: {
+                headers: <{[key: string]: any} >{},
+                getHeader: function (name: string) { return this.headers[name] },
+                setHeader: function (name: string, value: any) { this.headers[name] = value },
+                clearHeaders: function() { this.headers = {} }
+            }
+        }
+
+        afterEach(() => {
+            AppInsights.dispose();
+            telemetry.request.clearHeaders();
+        });
+        it("should accept string request-context", () => {
+            var appInsights = AppInsights.setup("key").setAutoCollectDependencies(true);
+            AppInsights.defaultClient.config.correlationId = "abcdefg";
+            appInsights.start();
+
+            telemetry.request.setHeader("request-context", "appId=cid-v1:aaaaed48-297a-4ea2-af46-0a5a5d26aaaa");
+            assert.doesNotThrow(() => HttpDependencies.trackRequest(AppInsights.defaultClient, telemetry as any));
+        });
+
+        it ("should accept nonstring request-context", () => {
+            var appInsights = AppInsights.setup("key").setAutoCollectDependencies(true);
+            AppInsights.defaultClient.config.correlationId = "abcdefg";
+            appInsights.start();
+
+            telemetry.request.setHeader("request-context", ["appId=cid-v1:aaaaed48-297a-4ea2-af46-0a5a5d26aaaa"]);
+            assert.doesNotThrow(() => HttpDependencies.trackRequest(AppInsights.defaultClient, telemetry as any));
+            assert.deepEqual(telemetry.request.getHeader("request-context"), ["appId=cid-v1:aaaaed48-297a-4ea2-af46-0a5a5d26aaaa"], "does not modify valid appId header")
+
+            telemetry.request.setHeader("request-context", 123);
+            assert.doesNotThrow(() => HttpDependencies.trackRequest(AppInsights.defaultClient, telemetry as any));
+            assert.ok(telemetry.request.getHeader("request-context").indexOf("abcdefg") !== -1)
+
+            telemetry.request.setHeader("request-context", {foo: 'bar'});
+            assert.doesNotThrow(() => HttpDependencies.trackRequest(AppInsights.defaultClient, telemetry as any));
+            assert.ok(telemetry.request.getHeader("request-context").indexOf("abcdefg") !== -1)
+        });
+    });
 });

Tests/AutoCollection/HttpRequests.tests.ts

@@ -21,4 +21,45 @@ describe("AutoCollection/HttpRequests", () => {
             assert.equal(enableHttpRequestsSpy.getCall(1).args[0], false);
         });
     });
+
+    describe("#addResponseCorrelationIdHeader", () => {
+        var response = {
+            headers: <{[key: string]: any} >{},
+            getHeader: function (name: string) { return this.headers[name] },
+            setHeader: function (name: string, value: any) { this.headers[name] = value },
+            clearHeaders: function() { this.headers = {} }
+        }
+
+        afterEach(() => {
+            AppInsights.dispose();
+            response.clearHeaders();
+        });
+
+        it("should accept string request-context", () => {
+            var appInsights = AppInsights.setup("key").setAutoCollectRequests(true);
+            AppInsights.defaultClient.config.correlationId = "abcdefg";
+            appInsights.start();
+
+            response.setHeader("request-context", "appId=cid-v1:aaaaed48-297a-4ea2-af46-0a5a5d26aaaa");
+            assert.doesNotThrow(() => HttpRequests["addResponseCorrelationIdHeader"](AppInsights.defaultClient, response as any))
+        });
+
+        it("should accept nonstring request-context", () => {
+            var appInsights = AppInsights.setup("key").setAutoCollectDependencies(true);
+            AppInsights.defaultClient.config.correlationId = "abcdefg";
+            appInsights.start();
+
+            response.setHeader("request-context", ["appId=cid-v1:aaaaed48-297a-4ea2-af46-0a5a5d26aaaa"]);
+            assert.doesNotThrow(() => HttpRequests["addResponseCorrelationIdHeader"](AppInsights.defaultClient, response as any));
+            assert.deepEqual(response.getHeader("request-context"), ["appId=cid-v1:aaaaed48-297a-4ea2-af46-0a5a5d26aaaa"], "does not modify valid appId")
+
+            response.setHeader("request-context", 123);
+            assert.doesNotThrow(() => HttpRequests["addResponseCorrelationIdHeader"](AppInsights.defaultClient, response as any));
+            assert.ok(response.getHeader("request-context").indexOf("abcdefg") !== -1)
+
+            response.setHeader("request-context", {foo: 'bar'});
+            assert.doesNotThrow(() => HttpRequests["addResponseCorrelationIdHeader"](AppInsights.defaultClient, response as any));
+            assert.ok(response.getHeader("request-context").indexOf("abcdefg") !== -1)
+        })
+    });
 });