Skip to content

A local-first personal finance app

add logging middleware (#434)

Tom Crasset6a41d284043a
diff --git a/package.json b/package.json
index 2197ea5edf..056770496c 100644
--- a/package.json
+++ b/package.json
@@ -32,10 +32,12 @@
"express-actuator": "1.8.4",
"express-rate-limit": "^6.7.0",
"express-response-size": "^0.0.3",
+ "express-winston": "^4.2.0",
"jws": "^4.0.0",
"migrate": "^2.0.1",
"nordigen-node": "^1.4.0",
- "uuid": "^9.0.0"
+ "uuid": "^9.0.0",
+ "winston": "^3.14.2"
},
"devDependencies": {
"@babel/preset-typescript": "^7.20.2",
diff --git a/src/app-account.js b/src/app-account.js
index ed9ee636c4..cc18ea32ec 100644
--- a/src/app-account.js
+++ b/src/app-account.js
@@ -1,5 +1,8 @@
import express from 'express';
-import { errorMiddleware } from './util/middlewares.js';
+import {
+ errorMiddleware,
+ requestLoggerMiddleware,
+} from './util/middlewares.js';
import validateUser, { validateAuthHeader } from './util/validate-user.js';
import {
bootstrap,
@@ -11,7 +14,7 @@ import {
let app = express();
app.use(errorMiddleware);
-
+app.use(requestLoggerMiddleware);
export { app as handlers };
// Non-authenticated endpoints:
diff --git a/src/app-gocardless/app-gocardless.js b/src/app-gocardless/app-gocardless.js
index ce6f2081f2..fd6fbc3e9b 100644
--- a/src/app-gocardless/app-gocardless.js
+++ b/src/app-gocardless/app-gocardless.js
@@ -11,9 +11,14 @@ import {
} from './errors.js';
import { handleError } from './util/handle-error.js';
import { sha256String } from '../util/hash.js';
-import { validateUserMiddleware } from '../util/middlewares.js';
+import {
+ requestLoggerMiddleware,
+ validateUserMiddleware,
+} from '../util/middlewares.js';
const app = express();
+app.use(requestLoggerMiddleware);
+
app.get('/link', function (req, res) {
res.sendFile('link.html', { root: path.resolve('./src/app-gocardless') });
});
diff --git a/src/app-secrets.js b/src/app-secrets.js
index 0fc9461d33..3f842d8cb7 100644
--- a/src/app-secrets.js
+++ b/src/app-secrets.js
@@ -1,11 +1,15 @@
import express from 'express';
import { secretsService } from './services/secrets-service.js';
-import { validateUserMiddleware } from './util/middlewares.js';
+import {
+ requestLoggerMiddleware,
+ validateUserMiddleware,
+} from './util/middlewares.js';
const app = express();
export { app as handlers };
app.use(express.json());
+app.use(requestLoggerMiddleware);
app.use(validateUserMiddleware);
diff --git a/src/app-simplefin/app-simplefin.js b/src/app-simplefin/app-simplefin.js
index fbe4b2135c..8e119ed74d 100644
--- a/src/app-simplefin/app-simplefin.js
+++ b/src/app-simplefin/app-simplefin.js
@@ -3,10 +3,12 @@ import { inspect } from 'util';
import https from 'https';
import { SecretName, secretsService } from '../services/secrets-service.js';
import { handleError } from '../app-gocardless/util/handle-error.js';
+import { requestLoggerMiddleware } from '../util/middlewares.js';
const app = express();
export { app as handlers };
app.use(express.json());
+app.use(requestLoggerMiddleware);
app.post(
'/status',
diff --git a/src/app-sync.js b/src/app-sync.js
index 47a818d6bf..447f9d9661 100644
--- a/src/app-sync.js
+++ b/src/app-sync.js
@@ -2,7 +2,11 @@ import fs from 'node:fs/promises';
import { Buffer } from 'node:buffer';
import express from 'express';
import * as uuid from 'uuid';
-import { errorMiddleware, validateUserMiddleware } from './util/middlewares.js';
+import {
+ errorMiddleware,
+ requestLoggerMiddleware,
+ validateUserMiddleware,
+} from './util/middlewares.js';
import getAccountDb from './account-db.js';
import { getPathForUserFile, getPathForGroupFile } from './util/paths.js';
@@ -12,7 +16,7 @@ import { SyncProtoBuf } from '@actual-app/crdt';
const app = express();
app.use(errorMiddleware);
-app.use(express.json());
+app.use(requestLoggerMiddleware);
app.use(express.raw({ type: 'application/actual-sync' }));
app.use(express.raw({ type: 'application/encrypted-file' }));
app.use(express.json());
diff --git a/src/util/middlewares.js b/src/util/middlewares.js
index 43b7402ba8..14e6e4dc14 100644
--- a/src/util/middlewares.js
+++ b/src/util/middlewares.js
@@ -1,5 +1,8 @@
import validateUser from './validate-user.js';
+import * as winston from 'winston';
+import * as expressWinston from 'express-winston';
+
/**
* @param {Error} err
* @param {import('express').Request} req
@@ -24,4 +27,18 @@ const validateUserMiddleware = async (req, res, next) => {
next();
};
-export { validateUserMiddleware, errorMiddleware };
+const requestLoggerMiddleware = expressWinston.logger({
+ transports: [new winston.transports.Console()],
+ format: winston.format.combine(
+ winston.format.colorize(),
+ winston.format.timestamp(),
+ winston.format.printf((args) => {
+ const { timestamp, level, meta } = args;
+ const { res, req } = meta;
+
+ return `${timestamp} ${level}: ${req.method} ${res.statusCode} ${req.url}`;
+ }),
+ ),
+});
+
+export { validateUserMiddleware, errorMiddleware, requestLoggerMiddleware };
diff --git a/upcoming-release-notes/434.md b/upcoming-release-notes/434.md
new file mode 100644
index 0000000000..91f1ac5b40
--- /dev/null
+++ b/upcoming-release-notes/434.md
@@ -0,0 +1,6 @@
+---
+category: Maintenance
+authors: [tcrasset]
+---
+
+Add logging middleware
diff --git a/yarn.lock b/yarn.lock
index e8e69a1cdc..fdd531af39 100644
--- a/yarn.lock
+++ b/yarn.lock
@@ -551,6 +551,24 @@ __metadata:
languageName: node
linkType: hard
+"@colors/colors@npm:1.6.0, @colors/colors@npm:^1.6.0":
+ version: 1.6.0
+ resolution: "@colors/colors@npm:1.6.0"
+ checksum: 10c0/9328a0778a5b0db243af54455b79a69e3fb21122d6c15ef9e9fcc94881d8d17352d8b2b2590f9bdd46fac5c2d6c1636dcfc14358a20c70e22daf89e1a759b629
+ languageName: node
+ linkType: hard
+
+"@dabh/diagnostics@npm:^2.0.2":
+ version: 2.0.3
+ resolution: "@dabh/diagnostics@npm:2.0.3"
+ dependencies:
+ colorspace: "npm:1.1.x"
+ enabled: "npm:2.0.x"
+ kuler: "npm:^2.0.0"
+ checksum: 10c0/a5133df8492802465ed01f2f0a5784585241a1030c362d54a602ed1839816d6c93d71dde05cf2ddb4fd0796238c19774406bd62fa2564b637907b495f52425fe
+ languageName: node
+ linkType: hard
+
"@eslint-community/eslint-utils@npm:^4.2.0":
version: 4.4.0
resolution: "@eslint-community/eslint-utils@npm:4.4.0"
@@ -1308,6 +1326,13 @@ __metadata:
languageName: node
linkType: hard
+"@types/triple-beam@npm:^1.3.2":
+ version: 1.3.5
+ resolution: "@types/triple-beam@npm:1.3.5"
+ checksum: 10c0/d5d7f25da612f6d79266f4f1bb9c1ef8f1684e9f60abab251e1261170631062b656ba26ff22631f2760caeafd372abc41e64867cde27fba54fafb73a35b9056a
+ languageName: node
+ linkType: hard
+
"@types/uuid@npm:^9.0.0":
version: 9.0.8
resolution: "@types/uuid@npm:9.0.8"
@@ -1531,6 +1556,7 @@ __metadata:
express-actuator: "npm:1.8.4"
express-rate-limit: "npm:^6.7.0"
express-response-size: "npm:^0.0.3"
+ express-winston: "npm:^4.2.0"
jest: "npm:^29.3.1"
jws: "npm:^4.0.0"
migrate: "npm:^2.0.1"
@@ -1539,6 +1565,7 @@ __metadata:
supertest: "npm:^6.3.1"
typescript: "npm:^4.9.5"
uuid: "npm:^9.0.0"
+ winston: "npm:^3.14.2"
languageName: unknown
linkType: soft
@@ -1701,6 +1728,13 @@ __metadata:
languageName: node
linkType: hard
+"async@npm:^3.2.3":
+ version: 3.2.5
+ resolution: "async@npm:3.2.5"
+ checksum: 10c0/1408287b26c6db67d45cb346e34892cee555b8b59e6c68e6f8c3e495cad5ca13b4f218180e871f3c2ca30df4ab52693b66f2f6ff43644760cab0b2198bda79c1
+ languageName: node
+ linkType: hard
+
"asynckit@npm:^0.4.0":
version: 0.4.0
resolution: "asynckit@npm:0.4.0"
@@ -2101,7 +2135,7 @@ __metadata:
languageName: node
linkType: hard
-"color-convert@npm:^1.9.0":
+"color-convert@npm:^1.9.0, color-convert@npm:^1.9.3":
version: 1.9.3
resolution: "color-convert@npm:1.9.3"
dependencies:
@@ -2126,13 +2160,23 @@ __metadata:
languageName: node
linkType: hard
-"color-name@npm:~1.1.4":
+"color-name@npm:^1.0.0, color-name@npm:~1.1.4":
version: 1.1.4
resolution: "color-name@npm:1.1.4"
checksum: 10c0/a1a3f914156960902f46f7f56bc62effc6c94e84b2cae157a526b1c1f74b677a47ec602bf68a61abfa2b42d15b7c5651c6dbe72a43af720bc588dff885b10f95
languageName: node
linkType: hard
+"color-string@npm:^1.6.0":
+ version: 1.9.1
+ resolution: "color-string@npm:1.9.1"
+ dependencies:
+ color-name: "npm:^1.0.0"
+ simple-swizzle: "npm:^0.2.2"
+ checksum: 10c0/b0bfd74c03b1f837f543898b512f5ea353f71630ccdd0d66f83028d1f0924a7d4272deb278b9aef376cacf1289b522ac3fb175e99895283645a2dc3a33af2404
+ languageName: node
+ linkType: hard
+
"color-support@npm:^1.1.2":
version: 1.1.3
resolution: "color-support@npm:1.1.3"
@@ -2142,6 +2186,26 @@ __metadata:
languageName: node
linkType: hard
+"color@npm:^3.1.3":
+ version: 3.2.1
+ resolution: "color@npm:3.2.1"
+ dependencies:
+ color-convert: "npm:^1.9.3"
+ color-string: "npm:^1.6.0"
+ checksum: 10c0/39345d55825884c32a88b95127d417a2c24681d8b57069413596d9fcbb721459ef9d9ec24ce3e65527b5373ce171b73e38dbcd9c830a52a6487e7f37bf00e83c
+ languageName: node
+ linkType: hard
+
+"colorspace@npm:1.1.x":
+ version: 1.1.4
+ resolution: "colorspace@npm:1.1.4"
+ dependencies:
+ color: "npm:^3.1.3"
+ text-hex: "npm:1.0.x"
+ checksum: 10c0/af5f91ff7f8e146b96e439ac20ed79b197210193bde721b47380a75b21751d90fa56390c773bb67c0aedd34ff85091883a437ab56861c779bd507d639ba7e123
+ languageName: node
+ linkType: hard
+
"combined-stream@npm:^1.0.8":
version: 1.0.8
resolution: "combined-stream@npm:1.0.8"
@@ -2500,6 +2564,13 @@ __metadata:
languageName: node
linkType: hard
+"enabled@npm:2.0.x":
+ version: 2.0.0
+ resolution: "enabled@npm:2.0.0"
+ checksum: 10c0/3b2c2af9bc7f8b9e291610f2dde4a75cf6ee52a68f4dd585482fbdf9a55d65388940e024e56d40bb03e05ef6671f5f53021fa8b72a20e954d7066ec28166713f
+ languageName: node
+ linkType: hard
+
"encodeurl@npm:~1.0.2":
version: 1.0.2
resolution: "encodeurl@npm:1.0.2"
@@ -2835,6 +2906,18 @@ __metadata:
languageName: node
linkType: hard
+"express-winston@npm:^4.2.0":
+ version: 4.2.0
+ resolution: "express-winston@npm:4.2.0"
+ dependencies:
+ chalk: "npm:^2.4.2"
+ lodash: "npm:^4.17.21"
+ peerDependencies:
+ winston: ">=3.x <4"
+ checksum: 10c0/8f80993e7d7696b22a12c68ffb72ea0cd3ad980d8394073fd972162cdca116b8f506974dd504987e350cddfdbf55402871762dcb9c69f2f7feaef2df6d93ef09
+ languageName: node
+ linkType: hard
+
"express@npm:4.19.2":
version: 4.19.2
resolution: "express@npm:4.19.2"
@@ -2940,6 +3023,13 @@ __metadata:
languageName: node
linkType: hard
+"fecha@npm:^4.2.0":
+ version: 4.2.3
+ resolution: "fecha@npm:4.2.3"
+ checksum: 10c0/0e895965959cf6a22bb7b00f0bf546f2783836310f510ddf63f463e1518d4c96dec61ab33fdfd8e79a71b4856a7c865478ce2ee8498d560fe125947703c9b1cf
+ languageName: node
+ linkType: hard
+
"file-entry-cache@npm:^6.0.1":
version: 6.0.1
resolution: "file-entry-cache@npm:6.0.1"
@@ -3018,6 +3108,13 @@ __metadata:
languageName: node
linkType: hard
+"fn.name@npm:1.x.x":
+ version: 1.1.0
+ resolution: "fn.name@npm:1.1.0"
+ checksum: 10c0/8ad62aa2d4f0b2a76d09dba36cfec61c540c13a0fd72e5d94164e430f987a7ce6a743112bbeb14877c810ef500d1f73d7f56e76d029d2e3413f20d79e3460a9a
+ languageName: node
+ linkType: hard
+
"follow-redirects@npm:^1.15.6":
version: 1.15.6
resolution: "follow-redirects@npm:1.15.6"
@@ -3545,6 +3642,13 @@ __metadata:
languageName: node
linkType: hard
+"is-arrayish@npm:^0.3.1":
+ version: 0.3.2
+ resolution: "is-arrayish@npm:0.3.2"
+ checksum: 10c0/f59b43dc1d129edb6f0e282595e56477f98c40278a2acdc8b0a5c57097c9eff8fe55470493df5775478cf32a4dc8eaf6d3a749f07ceee5bc263a78b2434f6a54
+ languageName: node
+ linkType: hard
+
"is-core-module@npm:^2.13.0":
version: 2.13.1
resolution: "is-core-module@npm:2.13.1"
@@ -4263,6 +4367,13 @@ __metadata:
languageName: node
linkType: hard
+"kuler@npm:^2.0.0":
+ version: 2.0.0
+ resolution: "kuler@npm:2.0.0"
+ checksum: 10c0/0a4e99d92ca373f8f74d1dc37931909c4d0d82aebc94cf2ba265771160fc12c8df34eaaac80805efbda367e2795cb1f1dd4c3d404b6b1cf38aec94035b503d2d
+ languageName: node
+ linkType: hard
+
"leven@npm:^3.1.0":
version: 3.1.0
resolution: "leven@npm:3.1.0"
@@ -4312,6 +4423,27 @@ __metadata:
languageName: node
linkType: hard
+"lodash@npm:^4.17.21":
+ version: 4.17.21
+ resolution: "lodash@npm:4.17.21"
+ checksum: 10c0/d8cbea072bb08655bb4c989da418994b073a608dffa608b09ac04b43a791b12aeae7cd7ad919aa4c925f33b48490b5cfe6c1f71d827956071dae2e7bb3a6b74c
+ languageName: node
+ linkType: hard
+
+"logform@npm:^2.6.0, logform@npm:^2.6.1":
+ version: 2.6.1
+ resolution: "logform@npm:2.6.1"
+ dependencies:
+ "@colors/colors": "npm:1.6.0"
+ "@types/triple-beam": "npm:^1.3.2"
+ fecha: "npm:^4.2.0"
+ ms: "npm:^2.1.1"
+ safe-stable-stringify: "npm:^2.3.1"
+ triple-beam: "npm:^1.3.0"
+ checksum: 10c0/c20019336b1da8c08adea67dd7de2b0effdc6e35289c0156722924b571df94ba9f900ef55620c56bceb07cae7cc46057c9859accdee37a131251ba34d6789bce
+ languageName: node
+ linkType: hard
+
"lru-cache@npm:^10.0.1, lru-cache@npm:^10.2.0":
version: 10.2.2
resolution: "lru-cache@npm:10.2.2"
@@ -4639,7 +4771,7 @@ __metadata:
languageName: node
linkType: hard
-"ms@npm:2.1.3":
+"ms@npm:2.1.3, ms@npm:^2.1.1":
version: 2.1.3
resolution: "ms@npm:2.1.3"
checksum: 10c0/d924b57e7312b3b63ad21fc5b3dc0af5e78d61a1fc7cfb5457edaf26326bf62be5307cc87ffb6862ef1c2b33b0233cdb5d4f01c4c958cc0d660948b65a287a48
@@ -4846,6 +4978,15 @@ __metadata:
languageName: node
linkType: hard
+"one-time@npm:^1.0.0":
+ version: 1.0.0
+ resolution: "one-time@npm:1.0.0"
+ dependencies:
+ fn.name: "npm:1.x.x"
+ checksum: 10c0/6e4887b331edbb954f4e915831cbec0a7b9956c36f4feb5f6de98c448ac02ff881fd8d9b55a6b1b55030af184c6b648f340a76eb211812f4ad8c9b4b8692fdaa
+ languageName: node
+ linkType: hard
+
"onetime@npm:^5.1.2":
version: 5.1.2
resolution: "onetime@npm:5.1.2"
@@ -5238,7 +5379,7 @@ __metadata:
languageName: node
linkType: hard
-"readable-stream@npm:^3.1.1, readable-stream@npm:^3.4.0, readable-stream@npm:^3.6.0":
+"readable-stream@npm:^3.1.1, readable-stream@npm:^3.4.0, readable-stream@npm:^3.6.0, readable-stream@npm:^3.6.2":
version: 3.6.2
resolution: "readable-stream@npm:3.6.2"
dependencies:
@@ -5360,6 +5501,13 @@ __metadata:
languageName: node
linkType: hard
+"safe-stable-stringify@npm:^2.3.1":
+ version: 2.4.3
+ resolution: "safe-stable-stringify@npm:2.4.3"
+ checksum: 10c0/81dede06b8f2ae794efd868b1e281e3c9000e57b39801c6c162267eb9efda17bd7a9eafa7379e1f1cacd528d4ced7c80d7460ad26f62ada7c9e01dec61b2e768
+ languageName: node
+ linkType: hard
+
"safer-buffer@npm:>= 2.1.2 < 3, safer-buffer@npm:>= 2.1.2 < 3.0.0":
version: 2.1.2
resolution: "safer-buffer@npm:2.1.2"
@@ -5506,6 +5654,15 @@ __metadata:
languageName: node
linkType: hard
+"simple-swizzle@npm:^0.2.2":
+ version: 0.2.2
+ resolution: "simple-swizzle@npm:0.2.2"
+ dependencies:
+ is-arrayish: "npm:^0.3.1"
+ checksum: 10c0/df5e4662a8c750bdba69af4e8263c5d96fe4cd0f9fe4bdfa3cbdeb45d2e869dff640beaaeb1ef0e99db4d8d2ec92f85508c269f50c972174851bc1ae5bd64308
+ languageName: node
+ linkType: hard
+
"sisteransi@npm:^1.0.5":
version: 1.0.5
resolution: "sisteransi@npm:1.0.5"
@@ -5597,6 +5754,13 @@ __metadata:
languageName: node
linkType: hard
+"stack-trace@npm:0.0.x":
+ version: 0.0.10
+ resolution: "stack-trace@npm:0.0.10"
+ checksum: 10c0/9ff3dabfad4049b635a85456f927a075c9d0c210e3ea336412d18220b2a86cbb9b13ec46d6c37b70a302a4ea4d49e30e5d4944dd60ae784073f1cde778ac8f4b
+ languageName: node
+ linkType: hard
+
"stack-utils@npm:^2.0.3":
version: 2.0.6
resolution: "stack-utils@npm:2.0.6"
@@ -5812,6 +5976,13 @@ __metadata:
languageName: node
linkType: hard
+"text-hex@npm:1.0.x":
+ version: 1.0.0
+ resolution: "text-hex@npm:1.0.0"
+ checksum: 10c0/57d8d320d92c79d7c03ffb8339b825bb9637c2cbccf14304309f51d8950015c44464b6fd1b6820a3d4821241c68825634f09f5a2d9d501e84f7c6fd14376860d
+ languageName: node
+ linkType: hard
+
"text-table@npm:^0.2.0":
version: 0.2.0
resolution: "text-table@npm:0.2.0"
@@ -5856,6 +6027,13 @@ __metadata:
languageName: node
linkType: hard
+"triple-beam@npm:^1.3.0":
+ version: 1.4.1
+ resolution: "triple-beam@npm:1.4.1"
+ checksum: 10c0/4bf1db71e14fe3ff1c3adbe3c302f1fdb553b74d7591a37323a7badb32dc8e9c290738996cbb64f8b10dc5a3833645b5d8c26221aaaaa12e50d1251c9aba2fea
+ languageName: node
+ linkType: hard
+
"tslib@npm:^1.8.1":
version: 1.14.1
resolution: "tslib@npm:1.14.1"
@@ -6096,6 +6274,36 @@ __metadata:
languageName: node
linkType: hard
+"winston-transport@npm:^4.7.0":
+ version: 4.7.1
+ resolution: "winston-transport@npm:4.7.1"
+ dependencies:
+ logform: "npm:^2.6.1"
+ readable-stream: "npm:^3.6.2"
+ triple-beam: "npm:^1.3.0"
+ checksum: 10c0/99b7b55cc2ef7f38988ab1717e7fd946c81b856b42a9530aef8ee725490ef2f2811f9cb06d63aa2f76a85fe99ae15b3bef10a54afde3be8b5059ce325e78481f
+ languageName: node
+ linkType: hard
+
+"winston@npm:^3.14.2":
+ version: 3.14.2
+ resolution: "winston@npm:3.14.2"
+ dependencies:
+ "@colors/colors": "npm:^1.6.0"
+ "@dabh/diagnostics": "npm:^2.0.2"
+ async: "npm:^3.2.3"
+ is-stream: "npm:^2.0.0"
+ logform: "npm:^2.6.0"
+ one-time: "npm:^1.0.0"
+ readable-stream: "npm:^3.4.0"
+ safe-stable-stringify: "npm:^2.3.1"
+ stack-trace: "npm:0.0.x"
+ triple-beam: "npm:^1.3.0"
+ winston-transport: "npm:^4.7.0"
+ checksum: 10c0/3f8fe505ea18310982e60452f335dd2b22fdbc9b25839b6ad882971b2416d5adc94a1f1a46e24cb37d967ad01dfe5499adaf5e53575626b5ebb2a25ff30f4e1d
+ languageName: node
+ linkType: hard
+
"word-wrap@npm:^1.2.5":
version: 1.2.5
resolution: "word-wrap@npm:1.2.5"