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

use originalUrl for Express middleware's request url #476

Merged
merged 6 commits into from
May 14, 2019
Merged

use originalUrl for Express middleware's request url #476

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
9fc952a
use originalUrl for express routes
hgiasac May 8, 2019
b47d429
use originalUrl for express routes
hgiasac May 8, 2019
e2afd56
merge master
hgiasac May 9, 2019
048c84c
merge master
hgiasac May 9, 2019
7a50343
Merge branch 'master' into express-middleware-original-url
JustinBeckwith May 11, 2019
af3fc43
Merge branch 'master' into express-middleware-original-url
bcoe May 14, 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
8 changes: 6 additions & 2 deletions src/middleware/express/make-http-request.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,18 @@ import * as http from 'http';

import {StackdriverHttpRequest} from '../../http-request';

export interface ServerRequest extends http.IncomingMessage {
originalUrl: string;
}

export function makeHttpRequestData(
req: http.IncomingMessage,
req: ServerRequest,
Copy link
Contributor

Choose a reason for hiding this comment

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

strictly speaking this change is breaking for existing typescript users. However, given that the middleware is marked experimental, this is okay to ship as a non-major.

res: http.ServerResponse,
latencyMilliseconds: number
): StackdriverHttpRequest {
return {
status: res.statusCode,
requestUrl: req.url,
requestUrl: req.originalUrl,
requestMethod: req.method,
userAgent: req.headers['user-agent'],
responseSize:
Expand Down
10 changes: 3 additions & 7 deletions src/middleware/express/make-middleware.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,10 @@ import * as http from 'http';
import onFinished = require('on-finished');
import {getOrInjectContext, makeHeaderWrapper} from '../context';

import {makeHttpRequestData} from './make-http-request';
import {makeHttpRequestData, ServerRequest} from './make-http-request';
import {StackdriverHttpRequest} from '../../http-request';

interface AnnotatedRequestType<LoggerType> extends http.IncomingMessage {
interface AnnotatedRequestType<LoggerType> extends ServerRequest {
log: LoggerType;
}

Expand All @@ -46,11 +46,7 @@ export function makeMiddleware<LoggerType>(
makeChildLogger: (trace: string) => LoggerType,
emitRequestLog?: (httpRequest: StackdriverHttpRequest, trace: string) => void
) {
return (
req: http.IncomingMessage,
res: http.ServerResponse,
next: Function
) => {
return (req: ServerRequest, res: http.ServerResponse, next: Function) => {
// TODO(ofrobots): use high-resolution timer.
const requestStartMs = Date.now();

Expand Down
13 changes: 8 additions & 5 deletions test/middleware/express/test-make-http-request.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,31 +15,34 @@
*/

import * as assert from 'assert';
import {IncomingMessage, ServerResponse} from 'http';
import {makeHttpRequestData} from '../../../src/middleware/express/make-http-request';
import {ServerResponse} from 'http';
import {
makeHttpRequestData,
ServerRequest,
} from '../../../src/middleware/express/make-http-request';

describe('middleware/express/make-http-request', () => {
it('should convert latency to proto Duration', () => {
const fakeRequest = {headers: {}};
const fakeResponse = {};

const h1 = makeHttpRequestData(
fakeRequest as IncomingMessage,
fakeRequest as ServerRequest,
fakeResponse as ServerResponse,
1003
);
assert.deepStrictEqual(h1.latency, {seconds: 1, nanos: 3e6});

const h2 = makeHttpRequestData(
fakeRequest as IncomingMessage,
fakeRequest as ServerRequest,
fakeResponse as ServerResponse,
9003.1
);
assert.deepStrictEqual(h2.latency, {seconds: 9, nanos: 3.1e6});

// Make sure we nanos is uint32.
const h3 = makeHttpRequestData(
fakeRequest as IncomingMessage,
fakeRequest as ServerRequest,
fakeResponse as ServerResponse,
1.0000000001
);
Expand Down