tabletcommand-logger 3.1.0 → 3.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/middleware/logger.js +26 -1
- package/build/middleware/logger.js.map +1 -1
- package/build/middleware/status-logger.js +13 -0
- package/build/middleware/status-logger.js.map +1 -1
- package/build/test/middleware-logger.js +29 -0
- package/build/test/middleware-logger.js.map +1 -0
- package/build/test/middleware-metrics.js +1 -0
- package/build/test/middleware-metrics.js.map +1 -1
- package/definitions/middleware/logger.d.ts +1 -0
- package/definitions/middleware/logger.d.ts.map +1 -1
- package/definitions/middleware/status-logger.d.ts +5 -0
- package/definitions/middleware/status-logger.d.ts.map +1 -1
- package/definitions/test/middleware-logger.d.ts +2 -0
- package/definitions/test/middleware-logger.d.ts.map +1 -0
- package/definitions/test/middleware-metrics.d.ts +1 -1
- package/definitions/test/middleware-metrics.d.ts.map +1 -1
- package/package.json +2 -1
- package/src/middleware/logger.ts +23 -1
- package/src/middleware/status-logger.ts +15 -2
- package/src/test/middleware-logger.ts +29 -0
- package/src/test/middleware-metrics.ts +1 -0
|
@@ -1,5 +1,30 @@
|
|
|
1
1
|
"use strict";
|
|
2
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
3
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
4
|
+
};
|
|
2
5
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
+
exports.redactOriginalURL = void 0;
|
|
7
|
+
const lodash_1 = __importDefault(require("lodash"));
|
|
8
|
+
function redactOriginalURL(maybeURL) {
|
|
9
|
+
if (!maybeURL) {
|
|
10
|
+
return "";
|
|
11
|
+
}
|
|
12
|
+
try {
|
|
13
|
+
// Attempt to keep first 7 chars of the api key
|
|
14
|
+
const href = new URL(maybeURL);
|
|
15
|
+
const prevApiKey = href.searchParams.get("apikey");
|
|
16
|
+
if (prevApiKey && lodash_1.default.isString(prevApiKey)) {
|
|
17
|
+
href.searchParams.set("apikey", prevApiKey.substring(0, 7));
|
|
18
|
+
return href.toString();
|
|
19
|
+
}
|
|
20
|
+
}
|
|
21
|
+
catch (_error) {
|
|
22
|
+
//
|
|
23
|
+
}
|
|
24
|
+
// Fallback
|
|
25
|
+
return maybeURL.replace(/apikey=.*?(&|$)/, "apikey=xxx&");
|
|
26
|
+
}
|
|
27
|
+
exports.redactOriginalURL = redactOriginalURL;
|
|
3
28
|
function loggerMiddleware(logger) {
|
|
4
29
|
return function accessLogMiddleware(req, res, next) {
|
|
5
30
|
// This doesn't fire the log immediately, but waits until the response is finished
|
|
@@ -12,7 +37,7 @@ function loggerMiddleware(logger) {
|
|
|
12
37
|
logger.info({
|
|
13
38
|
remoteAddress: req.ip,
|
|
14
39
|
method: req.method,
|
|
15
|
-
url: req.originalUrl,
|
|
40
|
+
url: redactOriginalURL(req.originalUrl),
|
|
16
41
|
protocol: req.protocol,
|
|
17
42
|
hostname: req.hostname,
|
|
18
43
|
httpVersion: `${req.httpVersionMajor}.${req.httpVersionMinor}`,
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"logger.js","sourceRoot":"","sources":["../../src/middleware/logger.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"logger.js","sourceRoot":"","sources":["../../src/middleware/logger.ts"],"names":[],"mappings":";;;;;;AAAA,oDAAuB;AAQvB,SAAgB,iBAAiB,CAAC,QAAiB;IACjD,IAAI,CAAC,QAAQ,EAAE;QACb,OAAO,EAAE,CAAC;KACX;IAED,IAAI;QACF,+CAA+C;QAC/C,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,QAAQ,CAAC,CAAC;QAC/B,MAAM,UAAU,GAAG,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QACnD,IAAI,UAAU,IAAI,gBAAC,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE;YACxC,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,QAAQ,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;YAC5D,OAAO,IAAI,CAAC,QAAQ,EAAE,CAAC;SACxB;KACF;IAAC,OAAO,MAAM,EAAE;QACf,EAAE;KACH;IAED,WAAW;IACX,OAAO,QAAQ,CAAC,OAAO,CAAC,iBAAiB,EAAE,aAAa,CAAC,CAAC;AAC5D,CAAC;AAnBD,8CAmBC;AAED,SAAwB,gBAAgB,CAAC,MAAe;IACtD,OAAO,SAAS,mBAAmB,CAAC,GAAY,EAAE,GAAa,EAAE,IAAkB;QACjF,kFAAkF;QAClF,2DAA2D;QAC3D,GAAG,CAAC,EAAE,CAAC,QAAQ,EAAE,GAAG,EAAE;YACpB,gCAAgC;YAChC,IAAI,CAAC,MAAM,EAAE;gBACX,OAAO;aACR;YACD,MAAM,CAAC,IAAI,CAAC;gBACV,aAAa,EAAE,GAAG,CAAC,EAAE;gBACrB,MAAM,EAAE,GAAG,CAAC,MAAM;gBAClB,GAAG,EAAE,iBAAiB,CAAC,GAAG,CAAC,WAAW,CAAC;gBACvC,QAAQ,EAAE,GAAG,CAAC,QAAQ;gBACtB,QAAQ,EAAE,GAAG,CAAC,QAAQ;gBACtB,WAAW,EAAE,GAAG,GAAG,CAAC,gBAAgB,IAAI,GAAG,CAAC,gBAAgB,EAAE;gBAC9D,SAAS,EAAE,GAAG,CAAC,OAAO,CAAC,YAAY,CAAC;gBACpC,yBAAyB;gBACzB,GAAG,EAAE;oBACH,IAAI,EAAE,GAAG,CAAC,IAAe;oBACzB,OAAO,EAAE,GAAG,CAAC,OAAO;oBACpB,MAAM,EAAE,GAAG,CAAC,MAAM;oBAClB,WAAW,EAAE,GAAG,CAAC,WAAW;iBAC7B;gBACD,MAAM,EAAE,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;aAC5C,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QACH,OAAO,IAAI,EAAE,CAAC;IAChB,CAAC,CAAC;AACJ,CAAC;AA7BD,mCA6BC"}
|
|
@@ -3,7 +3,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
|
3
3
|
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
4
4
|
};
|
|
5
5
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
+
exports.redactQuery = exports.requestDuration = exports.shouldIgnore = void 0;
|
|
6
7
|
const lodash_1 = __importDefault(require("lodash"));
|
|
8
|
+
const logger_1 = require("./logger");
|
|
7
9
|
const allowedMethods = ["POST"];
|
|
8
10
|
function shouldIgnore(req, res) {
|
|
9
11
|
var _a;
|
|
@@ -22,12 +24,21 @@ function shouldIgnore(req, res) {
|
|
|
22
24
|
}
|
|
23
25
|
return false;
|
|
24
26
|
}
|
|
27
|
+
exports.shouldIgnore = shouldIgnore;
|
|
25
28
|
function requestDuration(endTime, startTime) {
|
|
26
29
|
if (!lodash_1.default.isObject(startTime) || !lodash_1.default.isDate(startTime)) {
|
|
27
30
|
return 0;
|
|
28
31
|
}
|
|
29
32
|
return endTime.valueOf() - startTime.valueOf();
|
|
30
33
|
}
|
|
34
|
+
exports.requestDuration = requestDuration;
|
|
35
|
+
function redactQuery(q) {
|
|
36
|
+
if (lodash_1.default.isString(q.apikey)) {
|
|
37
|
+
q.apikey = q.apikey.substring(0, 7);
|
|
38
|
+
}
|
|
39
|
+
return q;
|
|
40
|
+
}
|
|
41
|
+
exports.redactQuery = redactQuery;
|
|
31
42
|
function statusLogger(logger) {
|
|
32
43
|
return function requestLogger(req, res, next) {
|
|
33
44
|
if (!lodash_1.default.isObject(req._startTime)) {
|
|
@@ -69,6 +80,8 @@ function statusLogger(logger) {
|
|
|
69
80
|
"path",
|
|
70
81
|
"query",
|
|
71
82
|
]);
|
|
83
|
+
cleanReq.originalUrl = (0, logger_1.redactOriginalURL)(req.originalUrl);
|
|
84
|
+
cleanReq.query = redactQuery(req.query);
|
|
72
85
|
const cleanRes = lodash_1.default.pick(res, [
|
|
73
86
|
"bodyCopy",
|
|
74
87
|
"responseTime",
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"status-logger.js","sourceRoot":"","sources":["../../src/middleware/status-logger.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"status-logger.js","sourceRoot":"","sources":["../../src/middleware/status-logger.ts"],"names":[],"mappings":";;;;;;AAQA,oDAAuB;AAEvB,qCAA6C;AAE7C,MAAM,cAAc,GAAG,CAAC,MAAM,CAAC,CAAC;AAEhC,SAAgB,YAAY,CAAC,GAAY,EAAE,GAAa;;IACtD,IAAI,gBAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,UAAU,KAAK,GAAG,EAAE;QAC7C,OAAO,IAAI,CAAC;KACb;IAED,6CAA6C;IAC7C,MAAM,CAAC,GAAG,CAAC,MAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,MAAM,mCAAI,SAAS,CAAC,CAAC,WAAW,EAAE,CAAC;IACnD,MAAM,SAAS,GAAG,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IACjD,IAAI,CAAC,SAAS,EAAE;QACd,OAAO,IAAI,CAAC;KACb;IAED,MAAM,SAAS,GAAY,gBAAC,CAAC,GAAG,CAAC,GAAG,EAAE,oBAAoB,CAAC,CAAC;IAC5D,IAAI,gBAAC,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE;QACvD,OAAO,IAAI,CAAC;KACb;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAlBD,oCAkBC;AAED,SAAgB,eAAe,CAAC,OAAa,EAAE,SAAgB;IAC7D,IAAI,CAAC,gBAAC,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,CAAC,gBAAC,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE;QAClD,OAAO,CAAC,CAAC;KACV;IAED,OAAO,OAAO,CAAC,OAAO,EAAE,GAAG,SAAS,CAAC,OAAO,EAAE,CAAC;AACjD,CAAC;AAND,0CAMC;AAED,SAAgB,WAAW,CAAC,CAAQ;IAClC,IAAI,gBAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE;QACxB,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;KACrC;IAED,OAAO,CAAC,CAAC;AACX,CAAC;AAND,kCAMC;AAED,SAAwB,YAAY,CAAC,MAAe;IAClD,OAAO,SAAS,aAAa,CAAC,GAAY,EAAE,GAAa,EAAE,IAAkB;QAC3E,IAAI,CAAC,gBAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE;YAC/B,GAAG,CAAC,UAAU,GAAG,IAAI,IAAI,EAAE,CAAC;SAC7B;QAED,GAAG,CAAC,QAAQ,GAAG,IAAI,CAAC;QAEpB,mCAAmC;QACnC,MAAM,OAAO,GAAG,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAEnC,kCAAkC;QAClC,GAAG,CAAC,IAAI,GAAG,SAAS,OAAO,CAAC,IAAa;YACvC,IAAI,gBAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE;gBACpB,IAAI;oBACF,GAAG,CAAC,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;iBACjC;gBAAC,OAAO,CAAC,EAAE;oBACV,GAAG,CAAC,QAAQ,GAAG,IAAI,CAAC;iBACrB;aACF;iBAAM;gBACL,GAAG,CAAC,QAAQ,GAAG,IAAI,CAAC;aACrB;YACD,OAAO,CAAC,IAAI,CAAC,CAAC;YACd,GAAG,CAAC,YAAY,GAAG,eAAe,CAAC,IAAI,IAAI,EAAE,EAAE,GAAG,CAAC,UAAU,CAAC,CAAC;YAC/D,OAAO,GAAG,CAAC;QACb,CAAC,CAAC;QAEF,SAAS,UAAU;YACjB,GAAG,CAAC,cAAc,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;YACzC,GAAG,CAAC,cAAc,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;YAExC,IAAI,YAAY,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,CAAC,MAAM,EAAE;gBACrC,OAAO;aACR;YAED,MAAM,QAAQ,GAAG,gBAAC,CAAC,IAAI,CAAC,GAAG,EAAE;gBAC3B,MAAM;gBACN,eAAe;gBACf,SAAS;gBACT,aAAa;gBACb,QAAQ;gBACR,aAAa;gBACb,MAAM;gBACN,OAAO;aACR,CAAC,CAAC;YACH,QAAQ,CAAC,WAAW,GAAG,IAAA,0BAAiB,EAAC,GAAG,CAAC,WAAW,CAAC,CAAC;YAC1D,QAAQ,CAAC,KAAK,GAAG,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;YAExC,MAAM,QAAQ,GAAG,gBAAC,CAAC,IAAI,CAAC,GAAG,EAAE;gBAC3B,UAAU;gBACV,cAAc;gBACd,YAAY;aACb,CAAC,CAAC;YAEH,MAAM,CAAC,IAAI,CAAC;gBACV,GAAG,EAAE,QAAQ;gBACb,GAAG,EAAE,QAAQ;aACd,CAAC,CAAC;QACL,CAAC;QAED,GAAG,CAAC,EAAE,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;QAC7B,GAAG,CAAC,EAAE,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;QAE5B,OAAO,IAAI,EAAE,CAAC;IAChB,CAAC,CAAC;AACJ,CAAC;AAjED,+BAiEC"}
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
require("mocha");
|
|
4
|
+
const chai_1 = require("chai");
|
|
5
|
+
const logger_1 = require("../middleware/logger");
|
|
6
|
+
describe("Logger Middleware", function () {
|
|
7
|
+
context("Redact Original URL", () => {
|
|
8
|
+
const url = "http://local:3442/incident?";
|
|
9
|
+
it("apikey is last", function () {
|
|
10
|
+
const prevApiKey = "apikey=abcdef1234567";
|
|
11
|
+
const expApiKey = "apikey=abcdef1";
|
|
12
|
+
const redacted = (0, logger_1.redactOriginalURL)(url + prevApiKey);
|
|
13
|
+
chai_1.assert.equal(redacted, url + expApiKey);
|
|
14
|
+
});
|
|
15
|
+
it("apikey is middle of url", function () {
|
|
16
|
+
const prevApiKey = "apikey=abcdef1234567&k=1";
|
|
17
|
+
const expApiKey = "apikey=abcdef1&k=1";
|
|
18
|
+
const redacted = (0, logger_1.redactOriginalURL)(url + prevApiKey);
|
|
19
|
+
chai_1.assert.equal(redacted, url + expApiKey);
|
|
20
|
+
});
|
|
21
|
+
it("apikey is short", function () {
|
|
22
|
+
const prevApiKey = "apikey=1&";
|
|
23
|
+
const expApiKey = "apikey=1";
|
|
24
|
+
const redacted = (0, logger_1.redactOriginalURL)(url + prevApiKey);
|
|
25
|
+
chai_1.assert.equal(redacted, url + expApiKey);
|
|
26
|
+
});
|
|
27
|
+
});
|
|
28
|
+
});
|
|
29
|
+
//# sourceMappingURL=middleware-logger.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"middleware-logger.js","sourceRoot":"","sources":["../../src/test/middleware-logger.ts"],"names":[],"mappings":";;AAAA,iBAAe;AACf,+BAA8B;AAC9B,iDAAyD;AAEzD,QAAQ,CAAC,mBAAmB,EAAE;IAC5B,OAAO,CAAC,qBAAqB,EAAE,GAAG,EAAE;QAClC,MAAM,GAAG,GAAG,6BAA6B,CAAC;QAC1C,EAAE,CAAC,gBAAgB,EAAE;YACnB,MAAM,UAAU,GAAG,sBAAsB,CAAC;YAC1C,MAAM,SAAS,GAAG,gBAAgB,CAAC;YACnC,MAAM,QAAQ,GAAG,IAAA,0BAAiB,EAAC,GAAG,GAAG,UAAU,CAAC,CAAC;YACrD,aAAM,CAAC,KAAK,CAAC,QAAQ,EAAE,GAAG,GAAG,SAAS,CAAC,CAAC;QAC1C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,yBAAyB,EAAE;YAC5B,MAAM,UAAU,GAAG,0BAA0B,CAAC;YAC9C,MAAM,SAAS,GAAG,oBAAoB,CAAC;YACvC,MAAM,QAAQ,GAAG,IAAA,0BAAiB,EAAC,GAAG,GAAG,UAAU,CAAC,CAAC;YACrD,aAAM,CAAC,KAAK,CAAC,QAAQ,EAAE,GAAG,GAAG,SAAS,CAAC,CAAC;QAC1C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,iBAAiB,EAAE;YACpB,MAAM,UAAU,GAAG,WAAW,CAAC;YAC/B,MAAM,SAAS,GAAG,UAAU,CAAC;YAC7B,MAAM,QAAQ,GAAG,IAAA,0BAAiB,EAAC,GAAG,GAAG,UAAU,CAAC,CAAC;YACrD,aAAM,CAAC,KAAK,CAAC,QAAQ,EAAE,GAAG,GAAG,SAAS,CAAC,CAAC;QAC1C,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
|
|
@@ -3,6 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
|
3
3
|
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
4
4
|
};
|
|
5
5
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
+
require("mocha");
|
|
6
7
|
const chai_1 = require("chai");
|
|
7
8
|
const metrics_1 = __importDefault(require("../middleware/metrics"));
|
|
8
9
|
const metrics_2 = require("../middleware/metrics");
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"middleware-metrics.js","sourceRoot":"","sources":["../../src/test/middleware-metrics.ts"],"names":[],"mappings":";;;;;AAAA,+BAA8B;AAE9B,oEAAkD;AAClD,mDAAsD;AACtD,MAAM,OAAO,GAAG,IAAA,iBAAa,GAAE,CAAC;AAEhC,QAAQ,CAAC,oBAAoB,EAAE;IAC7B,OAAO,CAAC,gBAAgB,EAAE,GAAG,EAAE;QAC7B,EAAE,CAAC,gCAAgC,EAAE;YACnC,MAAM,IAAI,GAAG,+CAA+C,CAAC;YAC7D,MAAM,SAAS,GAAG,OAAO,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;YAC9C,aAAM,CAAC,KAAK,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;QACtC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,mCAAmC,EAAE;YACtC,MAAM,IAAI,GAAG,oDAAoD,CAAC;YAClE,MAAM,SAAS,GAAG,OAAO,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;YAC9C,aAAM,CAAC,KAAK,CAAC,SAAS,EAAE,eAAe,CAAC,CAAC;QAC3C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,uCAAuC,EAAE;YAC1C,MAAM,IAAI,GAAG,4CAA4C,CAAC;YAC1D,MAAM,SAAS,GAAG,OAAO,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;YAC9C,aAAM,CAAC,KAAK,CAAC,SAAS,EAAE,mBAAmB,CAAC,CAAC;QAC/C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,0BAA0B,EAAE;YAC7B,MAAM,IAAI,GAAG,kBAAkB,CAAC;YAChC,MAAM,SAAS,GAAG,OAAO,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;YAC9C,aAAM,CAAC,KAAK,CAAC,SAAS,EAAE,kBAAkB,CAAC,CAAC;QAC9C,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,OAAO,CAAC,cAAc,EAAE,GAAG,EAAE;QAC3B,EAAE,CAAC,wCAAwC,EAAE,GAAG,EAAE;YAChD,MAAM,SAAS,GAAG,8CAA8C,CAAC;YACjE,MAAM,GAAG,GAAqB;gBAC5B,MAAM,EAAE,MAAM;gBACd,GAAG,EAAE,SAAS;aACf,CAAC;YACF,MAAM,QAAQ,GAAG,GAAG,CAAC;YACrB,MAAM,GAAG,GAAG,GAAG,CAAC;YAChB,OAAO,CAAC,YAAY,CAAC,GAAc,EAAE,QAAQ,EAAE,GAAG,CAAC,CAAC;YACpD,MAAM,iBAAiB,GAAG,yCAAyC,CAAC;YACpE,aAAM,CAAC,KAAK,CAAC,GAAG,CAAC,SAAS,EAAE,iBAAiB,CAAC,CAAC;QACjD,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,eAAe,EAAE,GAAG,EAAE;IAC7B,EAAE,CAAC,kBAAkB,EAAE,GAAG,EAAE;QAC1B,MAAM,GAAG,GAAqB;YAC5B,SAAS,EAAE,8BAA8B;YACzC,MAAM,EAAE;gBACN,YAAY,EAAE,MAAM;gBACpB,IAAI,EAAE,OAAO;aACd;SACF,CAAC;QACF,IAAA,uBAAa,EAAC,GAAG,CAAC,CAAC;QACnB,aAAM,CAAC,WAAW,CAAC,GAAG,CAAC,SAAS,EAAE,qCAAqC,CAAC,CAAC,CAAC,6BAA6B;IACzG,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,4CAA4C,EAAE,GAAG,EAAE;QACpD,MAAM,GAAG,GAAqB;YAC5B,SAAS,EAAE,yBAAyB;YACpC,MAAM,EAAE;gBACN,YAAY,EAAE,SAAkB;gBAChC,IAAI,EAAE,OAAO;aACd;SACF,CAAC;QACF,IAAA,uBAAa,EAAC,GAAG,CAAC,CAAC;QACnB,aAAM,CAAC,WAAW,CAAC,GAAG,CAAC,SAAS,EAAE,wBAAwB,CAAC,CAAC;IAC9D,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
|
|
1
|
+
{"version":3,"file":"middleware-metrics.js","sourceRoot":"","sources":["../../src/test/middleware-metrics.ts"],"names":[],"mappings":";;;;;AAAA,iBAAe;AACf,+BAA8B;AAE9B,oEAAkD;AAClD,mDAAsD;AACtD,MAAM,OAAO,GAAG,IAAA,iBAAa,GAAE,CAAC;AAEhC,QAAQ,CAAC,oBAAoB,EAAE;IAC7B,OAAO,CAAC,gBAAgB,EAAE,GAAG,EAAE;QAC7B,EAAE,CAAC,gCAAgC,EAAE;YACnC,MAAM,IAAI,GAAG,+CAA+C,CAAC;YAC7D,MAAM,SAAS,GAAG,OAAO,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;YAC9C,aAAM,CAAC,KAAK,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;QACtC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,mCAAmC,EAAE;YACtC,MAAM,IAAI,GAAG,oDAAoD,CAAC;YAClE,MAAM,SAAS,GAAG,OAAO,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;YAC9C,aAAM,CAAC,KAAK,CAAC,SAAS,EAAE,eAAe,CAAC,CAAC;QAC3C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,uCAAuC,EAAE;YAC1C,MAAM,IAAI,GAAG,4CAA4C,CAAC;YAC1D,MAAM,SAAS,GAAG,OAAO,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;YAC9C,aAAM,CAAC,KAAK,CAAC,SAAS,EAAE,mBAAmB,CAAC,CAAC;QAC/C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,0BAA0B,EAAE;YAC7B,MAAM,IAAI,GAAG,kBAAkB,CAAC;YAChC,MAAM,SAAS,GAAG,OAAO,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;YAC9C,aAAM,CAAC,KAAK,CAAC,SAAS,EAAE,kBAAkB,CAAC,CAAC;QAC9C,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,OAAO,CAAC,cAAc,EAAE,GAAG,EAAE;QAC3B,EAAE,CAAC,wCAAwC,EAAE,GAAG,EAAE;YAChD,MAAM,SAAS,GAAG,8CAA8C,CAAC;YACjE,MAAM,GAAG,GAAqB;gBAC5B,MAAM,EAAE,MAAM;gBACd,GAAG,EAAE,SAAS;aACf,CAAC;YACF,MAAM,QAAQ,GAAG,GAAG,CAAC;YACrB,MAAM,GAAG,GAAG,GAAG,CAAC;YAChB,OAAO,CAAC,YAAY,CAAC,GAAc,EAAE,QAAQ,EAAE,GAAG,CAAC,CAAC;YACpD,MAAM,iBAAiB,GAAG,yCAAyC,CAAC;YACpE,aAAM,CAAC,KAAK,CAAC,GAAG,CAAC,SAAS,EAAE,iBAAiB,CAAC,CAAC;QACjD,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,eAAe,EAAE,GAAG,EAAE;IAC7B,EAAE,CAAC,kBAAkB,EAAE,GAAG,EAAE;QAC1B,MAAM,GAAG,GAAqB;YAC5B,SAAS,EAAE,8BAA8B;YACzC,MAAM,EAAE;gBACN,YAAY,EAAE,MAAM;gBACpB,IAAI,EAAE,OAAO;aACd;SACF,CAAC;QACF,IAAA,uBAAa,EAAC,GAAG,CAAC,CAAC;QACnB,aAAM,CAAC,WAAW,CAAC,GAAG,CAAC,SAAS,EAAE,qCAAqC,CAAC,CAAC,CAAC,6BAA6B;IACzG,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,4CAA4C,EAAE,GAAG,EAAE;QACpD,MAAM,GAAG,GAAqB;YAC5B,SAAS,EAAE,yBAAyB;YACpC,MAAM,EAAE;gBACN,YAAY,EAAE,SAAkB;gBAChC,IAAI,EAAE,OAAO;aACd;SACF,CAAC;QACF,IAAA,uBAAa,EAAC,GAAG,CAAC,CAAC;QACnB,aAAM,CAAC,WAAW,CAAC,GAAG,CAAC,SAAS,EAAE,wBAAwB,CAAC,CAAC;IAC9D,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import { Logger } from "winston";
|
|
2
2
|
import { NextFunction, Request, Response } from "express";
|
|
3
|
+
export declare function redactOriginalURL(maybeURL?: string): string;
|
|
3
4
|
export default function loggerMiddleware(logger?: Logger): (req: Request, res: Response, next: NextFunction) => void;
|
|
4
5
|
//# sourceMappingURL=logger.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../../src/middleware/logger.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../../src/middleware/logger.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AACjC,OAAO,EACL,YAAY,EACZ,OAAO,EACP,QAAQ,EACT,MAAM,SAAS,CAAC;AAEjB,wBAAgB,iBAAiB,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,CAmB3D;AAED,MAAM,CAAC,OAAO,UAAU,gBAAgB,CAAC,MAAM,CAAC,EAAE,MAAM,SACb,OAAO,OAAO,QAAQ,QAAQ,YAAY,UA4BpF"}
|
|
@@ -1,5 +1,10 @@
|
|
|
1
|
+
/// <reference types="qs" />
|
|
1
2
|
import { Logger } from "winston";
|
|
2
3
|
import { NextFunction, Request, Response } from "express";
|
|
4
|
+
import { Query } from "express-serve-static-core";
|
|
5
|
+
export declare function shouldIgnore(req: Request, res: Response): boolean;
|
|
6
|
+
export declare function requestDuration(endTime: Date, startTime?: Date): number;
|
|
7
|
+
export declare function redactQuery(q: Query): import("qs").ParsedQs;
|
|
3
8
|
export default function statusLogger(logger?: Logger): (req: Request, res: Response, next: NextFunction) => void;
|
|
4
9
|
export type StatusLoggerModule = ReturnType<typeof statusLogger>;
|
|
5
10
|
//# sourceMappingURL=status-logger.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"status-logger.d.ts","sourceRoot":"","sources":["../../src/middleware/status-logger.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AAEjC,OAAO,EACL,YAAY,EACZ,OAAO,EACP,QAAQ,EACT,MAAM,SAAS,CAAC;
|
|
1
|
+
{"version":3,"file":"status-logger.d.ts","sourceRoot":"","sources":["../../src/middleware/status-logger.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AAEjC,OAAO,EACL,YAAY,EACZ,OAAO,EACP,QAAQ,EACT,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,KAAK,EAAE,MAAM,2BAA2B,CAAC;AAOlD,wBAAgB,YAAY,CAAC,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,GAAG,OAAO,CAkBjE;AAED,wBAAgB,eAAe,CAAC,OAAO,EAAE,IAAI,EAAE,SAAS,CAAC,EAAE,IAAI,GAAG,MAAM,CAMvE;AAED,wBAAgB,WAAW,CAAC,CAAC,EAAE,KAAK,yBAMnC;AAED,MAAM,CAAC,OAAO,UAAU,YAAY,CAAC,MAAM,CAAC,EAAE,MAAM,SACf,OAAO,OAAO,QAAQ,QAAQ,YAAY,UAgE9E;AAED,MAAM,MAAM,kBAAkB,GAAG,UAAU,CAAC,OAAO,YAAY,CAAC,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"middleware-logger.d.ts","sourceRoot":"","sources":["../../src/test/middleware-logger.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,CAAC"}
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
|
|
1
|
+
import "mocha";
|
|
2
2
|
//# sourceMappingURL=middleware-metrics.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"middleware-metrics.d.ts","sourceRoot":"","sources":["../../src/test/middleware-metrics.ts"],"names":[],"mappings":""}
|
|
1
|
+
{"version":3,"file":"middleware-metrics.d.ts","sourceRoot":"","sources":["../../src/test/middleware-metrics.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "tabletcommand-logger",
|
|
3
|
-
"version": "3.1
|
|
3
|
+
"version": "3.2.1",
|
|
4
4
|
"description": "Tablet Command Logging Configuration",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "gulp ts",
|
|
@@ -52,6 +52,7 @@
|
|
|
52
52
|
"gulp-mocha": "^8.0.0",
|
|
53
53
|
"gulp-shell": "^0.8.0",
|
|
54
54
|
"mocha": "^10.8.2",
|
|
55
|
+
"ts-node": "^10.9.2",
|
|
55
56
|
"typescript": "~4.9.5"
|
|
56
57
|
}
|
|
57
58
|
}
|
package/src/middleware/logger.ts
CHANGED
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import _ from "lodash";
|
|
1
2
|
import { Logger } from "winston";
|
|
2
3
|
import {
|
|
3
4
|
NextFunction,
|
|
@@ -5,6 +6,27 @@ import {
|
|
|
5
6
|
Response,
|
|
6
7
|
} from "express";
|
|
7
8
|
|
|
9
|
+
export function redactOriginalURL(maybeURL?: string): string {
|
|
10
|
+
if (!maybeURL) {
|
|
11
|
+
return "";
|
|
12
|
+
}
|
|
13
|
+
|
|
14
|
+
try {
|
|
15
|
+
// Attempt to keep first 7 chars of the api key
|
|
16
|
+
const href = new URL(maybeURL);
|
|
17
|
+
const prevApiKey = href.searchParams.get("apikey");
|
|
18
|
+
if (prevApiKey && _.isString(prevApiKey)) {
|
|
19
|
+
href.searchParams.set("apikey", prevApiKey.substring(0, 7));
|
|
20
|
+
return href.toString();
|
|
21
|
+
}
|
|
22
|
+
} catch (_error) {
|
|
23
|
+
//
|
|
24
|
+
}
|
|
25
|
+
|
|
26
|
+
// Fallback
|
|
27
|
+
return maybeURL.replace(/apikey=.*?(&|$)/, "apikey=xxx&");
|
|
28
|
+
}
|
|
29
|
+
|
|
8
30
|
export default function loggerMiddleware(logger?: Logger) {
|
|
9
31
|
return function accessLogMiddleware(req: Request, res: Response, next: NextFunction) {
|
|
10
32
|
// This doesn't fire the log immediately, but waits until the response is finished
|
|
@@ -17,7 +39,7 @@ export default function loggerMiddleware(logger?: Logger) {
|
|
|
17
39
|
logger.info({
|
|
18
40
|
remoteAddress: req.ip,
|
|
19
41
|
method: req.method,
|
|
20
|
-
url: req.originalUrl,
|
|
42
|
+
url: redactOriginalURL(req.originalUrl),
|
|
21
43
|
protocol: req.protocol,
|
|
22
44
|
hostname: req.hostname,
|
|
23
45
|
httpVersion: `${req.httpVersionMajor}.${req.httpVersionMinor}`,
|
|
@@ -5,11 +5,14 @@ import {
|
|
|
5
5
|
Request,
|
|
6
6
|
Response,
|
|
7
7
|
} from "express";
|
|
8
|
+
import { Query } from "express-serve-static-core";
|
|
8
9
|
import _ from "lodash";
|
|
9
10
|
|
|
11
|
+
import { redactOriginalURL } from "./logger";
|
|
12
|
+
|
|
10
13
|
const allowedMethods = ["POST"];
|
|
11
14
|
|
|
12
|
-
function shouldIgnore(req: Request, res: Response): boolean {
|
|
15
|
+
export function shouldIgnore(req: Request, res: Response): boolean {
|
|
13
16
|
if (_.isObject(res) && res.statusCode === 304) {
|
|
14
17
|
return true;
|
|
15
18
|
}
|
|
@@ -29,7 +32,7 @@ function shouldIgnore(req: Request, res: Response): boolean {
|
|
|
29
32
|
return false;
|
|
30
33
|
}
|
|
31
34
|
|
|
32
|
-
function requestDuration(endTime: Date, startTime?: Date): number {
|
|
35
|
+
export function requestDuration(endTime: Date, startTime?: Date): number {
|
|
33
36
|
if (!_.isObject(startTime) || !_.isDate(startTime)) {
|
|
34
37
|
return 0;
|
|
35
38
|
}
|
|
@@ -37,6 +40,14 @@ function requestDuration(endTime: Date, startTime?: Date): number {
|
|
|
37
40
|
return endTime.valueOf() - startTime.valueOf();
|
|
38
41
|
}
|
|
39
42
|
|
|
43
|
+
export function redactQuery(q: Query) {
|
|
44
|
+
if (_.isString(q.apikey)) {
|
|
45
|
+
q.apikey = q.apikey.substring(0, 7);
|
|
46
|
+
}
|
|
47
|
+
|
|
48
|
+
return q;
|
|
49
|
+
}
|
|
50
|
+
|
|
40
51
|
export default function statusLogger(logger?: Logger) {
|
|
41
52
|
return function requestLogger(req: Request, res: Response, next: NextFunction) {
|
|
42
53
|
if (!_.isObject(req._startTime)) {
|
|
@@ -82,6 +93,8 @@ export default function statusLogger(logger?: Logger) {
|
|
|
82
93
|
"path",
|
|
83
94
|
"query",
|
|
84
95
|
]);
|
|
96
|
+
cleanReq.originalUrl = redactOriginalURL(req.originalUrl);
|
|
97
|
+
cleanReq.query = redactQuery(req.query);
|
|
85
98
|
|
|
86
99
|
const cleanRes = _.pick(res, [
|
|
87
100
|
"bodyCopy",
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
import "mocha";
|
|
2
|
+
import { assert } from "chai";
|
|
3
|
+
import { redactOriginalURL } from "../middleware/logger";
|
|
4
|
+
|
|
5
|
+
describe("Logger Middleware", function() {
|
|
6
|
+
context("Redact Original URL", () => {
|
|
7
|
+
const url = "http://local:3442/incident?";
|
|
8
|
+
it("apikey is last", function() {
|
|
9
|
+
const prevApiKey = "apikey=abcdef1234567";
|
|
10
|
+
const expApiKey = "apikey=abcdef1";
|
|
11
|
+
const redacted = redactOriginalURL(url + prevApiKey);
|
|
12
|
+
assert.equal(redacted, url + expApiKey);
|
|
13
|
+
});
|
|
14
|
+
|
|
15
|
+
it("apikey is middle of url", function() {
|
|
16
|
+
const prevApiKey = "apikey=abcdef1234567&k=1";
|
|
17
|
+
const expApiKey = "apikey=abcdef1&k=1";
|
|
18
|
+
const redacted = redactOriginalURL(url + prevApiKey);
|
|
19
|
+
assert.equal(redacted, url + expApiKey);
|
|
20
|
+
});
|
|
21
|
+
|
|
22
|
+
it("apikey is short", function() {
|
|
23
|
+
const prevApiKey = "apikey=1&";
|
|
24
|
+
const expApiKey = "apikey=1";
|
|
25
|
+
const redacted = redactOriginalURL(url + prevApiKey);
|
|
26
|
+
assert.equal(redacted, url + expApiKey);
|
|
27
|
+
});
|
|
28
|
+
});
|
|
29
|
+
});
|