-
Notifications
You must be signed in to change notification settings - Fork 29
/
express.ts
70 lines (62 loc) · 2.52 KB
/
express.ts
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
// Copyright 2016 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
import * as express from 'express';
import * as is from 'is';
import {RequestInformationContainer} from '../classes/request-information-container';
/**
* This function checks for the presence of an `x-forwarded-for` header on the
* request to check for remote address forwards, if that is header is not
* present in the request then the function will attempt to extract the remote
* address from the express request object.
* @function extractRemoteAddressFromRequest
* @param {Object} req - the express request object
* @returns {String} - the remote address or, if one cannot be found, an empty
* string
*/
function extractRemoteAddressFromRequest(req: express.Request) {
if (typeof req.header('x-forwarded-for') !== 'undefined') {
return req.header('x-forwarded-for');
} else if (is.object(req.connection)) {
return req.connection.remoteAddress;
}
return '';
}
/**
* The expressRequestInformationExtractor is a function which is made to extract
* request information from a express request object. This function will do a
* basic check for type and method presence but will not check for the presence
* of properties on the request object.
* @function expressRequestInformationExtractor
* @param {Object} req - the express request object
* @param {Object} res - the express response object
* @returns {RequestInformationContainer} - an object containing the request
* information in a standardized format
*/
export function expressRequestInformationExtractor(
req: express.Request,
res: express.Response
) {
const returnObject = new RequestInformationContainer();
if (!is.object(req) || !is.function(req.header) || !is.object(res)) {
return returnObject;
}
returnObject
.setMethod(req.method)
.setUrl(req.url)
.setUserAgent(req.header('user-agent'))
.setReferrer(req.header('referrer'))
.setStatusCode(res.statusCode)
.setRemoteAddress(extractRemoteAddressFromRequest(req));
return returnObject;
}