From 3fffd8a2cbcd3ea45f1ec2ed7ebb6ed13f695a0b Mon Sep 17 00:00:00 2001 From: Patrik Oldsberg Date: Mon, 19 Feb 2024 13:24:48 +0100 Subject: [PATCH] backend-app-api: include logId in filtered error log Signed-off-by: Patrik Oldsberg --- .../src/http/MiddlewareFactory.test.ts | 15 +++++++++++---- .../src/http/applyInternalErrorFilter.ts | 7 +++---- 2 files changed, 14 insertions(+), 8 deletions(-) diff --git a/packages/backend-app-api/src/http/MiddlewareFactory.test.ts b/packages/backend-app-api/src/http/MiddlewareFactory.test.ts index f0506f11de..418d170365 100644 --- a/packages/backend-app-api/src/http/MiddlewareFactory.test.ts +++ b/packages/backend-app-api/src/http/MiddlewareFactory.test.ts @@ -195,6 +195,11 @@ describe('MiddlewareFactory', () => { it('should filter out internal errors', async () => { const app = express(); + const grandChildLogger = { + error: jest.fn(), + }; + childLogger.child.mockReturnValue(grandChildLogger); + class DatabaseError extends Error {} const thrownError = new DatabaseError('some error'); @@ -205,18 +210,20 @@ describe('MiddlewareFactory', () => { await request(app).get('/breaks'); - expect(childLogger.error).toHaveBeenCalledTimes(2); + const [{ logId }] = childLogger.child.mock.calls[0]; + + expect(logId).toMatch(/^[0-9a-f]+$/); expect(childLogger.error).toHaveBeenCalledWith( 'Request failed with status 500', expect.objectContaining({ message: expect.stringMatching( - /^An internal error occurred logId=[0-9a-f]+$/, + `An internal error occurred logId=${logId}`, ), }), ); - expect(childLogger.error).toHaveBeenCalledWith( + expect(grandChildLogger.error).toHaveBeenCalledWith( expect.stringMatching( - /^Filtered internal error with logId=[0-9a-f]+ from response$/, + `Filtered internal error with logId=${logId} from response`, ), thrownError, ); diff --git a/packages/backend-app-api/src/http/applyInternalErrorFilter.ts b/packages/backend-app-api/src/http/applyInternalErrorFilter.ts index e2e2f60e73..d1d1e0e4d9 100644 --- a/packages/backend-app-api/src/http/applyInternalErrorFilter.ts +++ b/packages/backend-app-api/src/http/applyInternalErrorFilter.ts @@ -20,10 +20,9 @@ import { randomBytes } from 'crypto'; function handleBadError(error: Error, logger: LoggerService) { const logId = randomBytes(10).toString('hex'); - logger.error( - `Filtered internal error with logId=${logId} from response`, - error, - ); + logger + .child({ logId }) + .error(`Filtered internal error with logId=${logId} from response`, error); const newError = new Error(`An internal error occurred logId=${logId}`); delete newError.stack; // Trim the stack since it's not particularly useful return newError;