Skip to content

Checking if the request object url is a graph url #357

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

Merged
merged 4 commits into from
Nov 18, 2020
Merged

Checking if the request object url is a graph url #357

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e556eff
Checking if the request object url is a graph url
nikithauc Nov 18, 2020
ac0a025
removing ununsed const
nikithauc Nov 18, 2020
8d8e234
Merge branch 'dev' into nikithauc/remove-headers-requestObject
nikithauc Nov 18, 2020
067d8d8
Update src/middleware/TelemetryHandler.ts
nikithauc Nov 18, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 36 additions & 1 deletion spec/middleware/TelemetryHandler.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,14 @@ describe("TelemetryHandler.ts", () => {
this.timeout(20 * 1000);
const telemetryHandler = new TelemetryHandler();
const dummyHTTPHandler = new DummyHTTPMessageHandler();
const uuid = "dummy_uuid";
const sdkVersion = "dummy_version";
telemetryHandler.setNext(dummyHTTPHandler);
const okayResponse = new Response("", {
status: 200,
statusText: "OK",
});
it("Should not disturb client-request-id in the header", async () => {
const uuid = "dummy_uuid";
const context: Context = {
request: GRAPH_BASE_URL,
options: {
Expand Down Expand Up @@ -102,6 +103,40 @@ describe("TelemetryHandler.ts", () => {
assert.equal(context.options.headers["SdkVersion"], undefined);
assert.equal(context.options.headers["setFeatureUsage"], undefined);
});

it("Should not disturb client-request-id in the header when Request object is passed with Graph URL", async () => {
const request = new Request(GRAPH_BASE_URL);
const context: Context = {
request,
options: {
headers: {
"client-request-id": uuid,
SdkVersion: sdkVersion,
},
},
};
dummyHTTPHandler.setResponses([okayResponse]);
await telemetryHandler.execute(context);
assert.equal(context.options.headers["client-request-id"], uuid);
assert.equal(context.options.headers["SdkVersion"], sdkVersion);
});

it("Should delete Telemetry in the header when Request object is passed with non Graph URL", async () => {
const request = new Request("test_url");
const context: Context = {
request,
options: {
headers: {
"client-request-id": uuid,
SdkVersion: "test_version",
},
},
};
dummyHTTPHandler.setResponses([okayResponse]);
await telemetryHandler.execute(context);
assert.equal(context.options.headers["client-request-id"], undefined);
assert.equal(context.options.headers["SdkVersion"], undefined);
});
});
/* tslint:enable: no-string-literal */
});
45 changes: 22 additions & 23 deletions src/middleware/TelemetryHandler.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,30 +66,29 @@ export class TelemetryHandler implements Middleware {
*/
public async execute(context: Context): Promise<void> {
try {
if (typeof context.request === "string") {
if (isGraphURL(context.request)) {
// Add telemetry only if the request url is a Graph URL.
// Errors are reported as in issue #265 if headers are present when redirecting to a non Graph URL
let clientRequestId: string = getRequestHeader(context.request, context.options, TelemetryHandler.CLIENT_REQUEST_ID_HEADER);
if (clientRequestId === null) {
clientRequestId = generateUUID();
setRequestHeader(context.request, context.options, TelemetryHandler.CLIENT_REQUEST_ID_HEADER, clientRequestId);
}
let sdkVersionValue: string = `${TelemetryHandler.PRODUCT_NAME}/${PACKAGE_VERSION}`;
let options: TelemetryHandlerOptions;
if (context.middlewareControl instanceof MiddlewareControl) {
options = context.middlewareControl.getMiddlewareOptions(TelemetryHandlerOptions) as TelemetryHandlerOptions;
}
if (options) {
const featureUsage: string = options.getFeatureUsage();
sdkVersionValue += ` (${TelemetryHandler.FEATURE_USAGE_STRING}=${featureUsage})`;
}
appendRequestHeader(context.request, context.options, TelemetryHandler.SDK_VERSION_HEADER, sdkVersionValue);
} else {
// Remove telemetry headers if present during redirection.
delete context.options.headers[TelemetryHandler.CLIENT_REQUEST_ID_HEADER];
delete context.options.headers[TelemetryHandler.SDK_VERSION_HEADER];
const url = typeof context.request === "string" ? context.request : context.request.url;
if (isGraphURL(url)) {
// Add telemetry only if the request url is a Graph URL.
// Errors are reported as in issue #265 if headers are present when redirecting to a non Graph URL
let clientRequestId: string = getRequestHeader(context.request, context.options, TelemetryHandler.CLIENT_REQUEST_ID_HEADER);
if (!clientRequestId) {
clientRequestId = generateUUID();
setRequestHeader(context.request, context.options, TelemetryHandler.CLIENT_REQUEST_ID_HEADER, clientRequestId);
}
let sdkVersionValue: string = `${TelemetryHandler.PRODUCT_NAME}/${PACKAGE_VERSION}`;
let options: TelemetryHandlerOptions;
if (context.middlewareControl instanceof MiddlewareControl) {
options = context.middlewareControl.getMiddlewareOptions(TelemetryHandlerOptions) as TelemetryHandlerOptions;
}
if (options) {
const featureUsage: string = options.getFeatureUsage();
sdkVersionValue += ` (${TelemetryHandler.FEATURE_USAGE_STRING}=${featureUsage})`;
}
appendRequestHeader(context.request, context.options, TelemetryHandler.SDK_VERSION_HEADER, sdkVersionValue);
} else {
// Remove telemetry headers if present during redirection.
delete context.options.headers[TelemetryHandler.CLIENT_REQUEST_ID_HEADER];
delete context.options.headers[TelemetryHandler.SDK_VERSION_HEADER];
}
return await this.nextMiddleware.execute(context);
} catch (error) {
Expand Down