Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

parse nonstring request-context header #521

Merged
merged 3 commits into from
May 28, 2019
Merged

parse nonstring request-context header #521

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f22a833
parse nonstring request-context header
May 23, 2019
21f6c04
refactor header parsing, add try/catch on fallback
May 23, 2019
a516d53
move includeCorrelationHeader to Util
May 23, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
55 changes: 38 additions & 17 deletions AutoCollection/HttpDependencies.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,31 +122,40 @@ 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)
let header: string; // 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
markwolff marked this conversation as resolved.
Show resolved Hide resolved
try {
header = (correlationHeader as any).toString();
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you know if there's any functional or performance differences between header.toString() and '' + header or String(header)?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://stackoverflow.com/questions/3945202/whats-the-difference-between-stringvalue-vs-value-tostring
It seems '' + header and String(header) are equivalent, and they attempt to call toString (and valueOf if that failed). For perf, it seems toString is slightly better, but using either of the other two would cover the scenario of valueOf being properly defined instead of toString for a custom object.

} catch (err) {
Logging.warn("Outgoing request-context header could not be parsed. Correlation of requests may be lost.", err, correlationHeader);
markwolff marked this conversation as resolved.
Show resolved Hide resolved
}
}

if (header) {
AutoCollectHttpDependencies.addRequestCorrelationIdHeaderFromString(client, telemetry, header);
} 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);
if (currentContext && currentContext.operation) {
telemetry.request.setHeader(RequestResponseHeaders.requestIdHeader, uniqueRequestId);
markwolff marked this conversation as resolved.
Show resolved Hide resolved
// 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);
const correlationContextHeader = (<PrivateCustomProperties>currentContext.customProperties).serializeToHeader();
if (correlationContextHeader) {
telemetry.request.setHeader(RequestResponseHeaders.correlationContextHeader, correlationContextHeader);
}
}
}
}
Expand Down Expand Up @@ -185,6 +194,18 @@ class AutoCollectHttpDependencies {
this.enable(false);
this._isInitialized = false;
}

private static addRequestCorrelationIdHeaderFromString(client: TelemetryClient, telemetry: Contracts.NodeHttpDependencyTelemetry, correlationHeader: string) {
const components = correlationHeader.split(",");
const key = `${RequestResponseHeaders.requestContextSourceKey}=`;
const found = components.some(value => value.substring(0,key.length) === key);

if (!found) {
telemetry.request.setHeader(
RequestResponseHeaders.requestContextHeader,
`${correlationHeader},${RequestResponseHeaders.requestContextSourceKey}=${client.config.correlationId}`);
}
}
}

export = AutoCollectHttpDependencies;
35 changes: 27 additions & 8 deletions AutoCollection/HttpRequests.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -232,21 +232,40 @@ class AutoCollectHttpRequests {
}
}

private static addResponseCorrelationIdHeaderFromString(client: TelemetryClient, response: 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}`);
}
}

/**
* Add the target correlationId to the response headers, if not already provided.
*/
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}`);
const correlationHeader = <any>response.getHeader(RequestResponseHeaders.requestContextHeader);
let header: string;
if (typeof correlationHeader === "string") { // string
markwolff marked this conversation as resolved.
Show resolved Hide resolved
header = correlationHeader;
} else if (correlationHeader instanceof Array) { // string[]
header = correlationHeader.join(",");
} else if (correlationHeader && typeof (correlationHeader as any).toString === "function") { // number, anything else
try {
header = (correlationHeader as any).toString();
} catch (err) {
Logging.warn("Incoming request-context header could not be parsed. Correlation of requests may be lost.", err, correlationHeader);
}
}

if (header) {
AutoCollectHttpRequests.addResponseCorrelationIdHeaderFromString(client, response, header);
markwolff marked this conversation as resolved.
Show resolved Hide resolved
} else {
response.setHeader(
RequestResponseHeaders.requestContextHeader,
Expand Down
42 changes: 42 additions & 0 deletions Tests/AutoCollection/HttpDependencies.tests.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
});
});
});
41 changes: 41 additions & 0 deletions Tests/AutoCollection/HttpRequests.tests.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
})
});
});