File size: 5,162 Bytes
1e92f2d |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 |
import EventEmitter from 'events';
import config from '@automattic/calypso-config';
import loggerMiddleware from '../logger';
const requestLogger = {
info: jest.fn(),
};
const mockRootLogger = {
child: jest.fn( () => requestLogger ),
};
jest.mock( 'calypso/server/lib/logger', () => ( {
getLogger: () => mockRootLogger,
} ) );
jest.mock( '@automattic/calypso-config', () => jest.fn() );
jest.mock( 'crypto', () => ( {
randomUUID: () => '00000000-0000-0000-0000-000000000000',
} ) );
const fakeRequest = ( { method, url, ip, httpVersion, headers = {} } = {} ) => {
const req = new EventEmitter();
req.method = method;
req.originalUrl = url;
req.ip = ip;
req.get = ( header ) => headers[ header.toLowerCase() ];
req.httpVersion = httpVersion;
return req;
};
const fakeResponse = ( { statusCode, headers = {} } = {} ) => {
const res = new EventEmitter();
res.headersSent = true;
res.get = ( header ) => headers[ header.toLowerCase() ];
res.statusCode = statusCode;
return res;
};
const withCommitSha = ( sha ) => {
const current = process.env.COMMIT_SHA;
process.env.COMMIT_SHA = sha;
afterAll( () => {
process.env.COMMIT_SHA = current;
} );
};
const withEnv = ( env ) => {
config.mockImplementation( ( key ) => {
if ( key === 'env_id' ) {
return env;
}
} );
afterAll( () => {
config.mockReset();
} );
};
const simulateRequest = ( { req, res, delay, finished = true } ) => {
loggerMiddleware()( req, res, () => {} );
jest.advanceTimersByTime( delay );
res.finished = finished;
res.emit( 'close' );
};
describe( 'Logger middleware', () => {
withEnv( 'production' );
withCommitSha( 'abcd1234' );
beforeEach( () => {
jest.useFakeTimers();
} );
afterEach( () => {
jest.useRealTimers();
jest.clearAllMocks();
} );
it( 'Adds a `logger` property to the request with the request id', () => {
const req = fakeRequest( {
headers: {
'user-agent': 'A random browser',
},
url: '/example.html',
} );
simulateRequest( {
req,
res: fakeResponse(),
} );
expect( req.logger ).toBe( requestLogger );
expect( mockRootLogger.child ).toHaveBeenCalledWith( {
reqId: '00000000-0000-0000-0000-000000000000',
appVersion: 'abcd1234',
env: 'production',
path: undefined,
url: '/example.html',
userAgent: 'A random browser',
} );
} );
it( 'Logs info about the request', () => {
simulateRequest( {
req: fakeRequest( {
method: 'GET',
httpVersion: '2.0',
headers: {
'user-agent':
'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/85.0.4183.121 Safari/537.36',
referer: 'https://wordpress.com',
},
url: '/example.html',
ip: '127.0.0.1',
} ),
res: fakeResponse( {
statusCode: '200',
headers: {
'content-length': 123,
},
} ),
delay: 100,
} );
expect( requestLogger.info ).toHaveBeenCalledWith(
expect.objectContaining( {
length: 123,
duration: 100,
status: '200',
method: 'GET',
httpVersion: '2.0',
rawUserAgent:
'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/85.0.4183.121 Safari/537.36',
remoteAddr: '127.0.0.1',
referrer: 'https://wordpress.com',
} ),
'request finished'
);
} );
it( 'Logs closed requests', () => {
simulateRequest( {
req: fakeRequest(),
res: fakeResponse(),
finished: false,
} );
expect( requestLogger.info ).toHaveBeenCalledWith( expect.anything(), 'request closed' );
} );
it( "Logs raw UserAgent if it can't be parsed", () => {
simulateRequest( {
req: fakeRequest( {
headers: {
'user-agent': 'A random browser',
},
} ),
res: fakeResponse(),
} );
expect( requestLogger.info ).toHaveBeenCalledWith(
expect.objectContaining( {
rawUserAgent: 'A random browser',
} ),
expect.anything()
);
} );
it( 'Adds the COMMIT_SHA as version', () => {
simulateRequest( {
req: fakeRequest(),
res: fakeResponse(),
} );
expect( mockRootLogger.child ).toHaveBeenCalledWith(
expect.objectContaining( {
appVersion: 'abcd1234',
} )
);
} );
it( 'Does not log static requests in dev mode', () => {
const oldNodeEnv = process.env.NODE_ENV;
process.env.NODE_ENV = 'development';
simulateRequest( {
req: fakeRequest( {
url: '/calypso/abc',
} ),
res: fakeResponse(),
} );
process.env.NODE_ENV = oldNodeEnv;
expect( requestLogger.info ).not.toHaveBeenCalled();
} );
it( 'Does not log non-static requests in dev mode', () => {
const oldNodeEnv = process.env.NODE_ENV;
process.env.NODE_ENV = 'development';
simulateRequest( {
req: fakeRequest( {
url: '/home',
} ),
res: fakeResponse(),
} );
process.env.NODE_ENV = oldNodeEnv;
expect( requestLogger.info ).toHaveBeenCalled();
} );
it( 'Does log static requests in non-dev mode', () => {
const oldNodeEnv = process.env.NODE_ENV;
process.env.NODE_ENV = 'foo';
simulateRequest( {
req: fakeRequest( {
url: '/calypso/abc',
} ),
res: fakeResponse(),
} );
process.env.NODE_ENV = oldNodeEnv;
expect( requestLogger.info ).toHaveBeenCalled();
} );
} );
|