The minimalistic document archiving platform.
refactor(server,logger): migrate to crowlog logger ecosystem (#135)
Corentin Thomasset0d1be0d3a586
diff --git a/apps/papra-server/package.json b/apps/papra-server/package.jsonindex ee753438..030b47a6 100644--- a/apps/papra-server/package.json+++ b/apps/papra-server/package.json@@ -8,7 +8,7 @@"license": "AGPL-3.0-or-later","keywords": [],"scripts": {- "dev": "tsx watch --env-file-if-exists=.env src/index.ts",+ "dev": "tsx watch --env-file=.env src/index.ts | crowlog-pretty","build": "pnpm esbuild --bundle src/index.ts --platform=node --packages=external --format=esm --outfile=dist/index.js --minify","start": "node dist/index.js","start:with-migrations": "pnpm migrate:up && pnpm start",@@ -31,6 +31,8 @@"@aws-sdk/lib-storage": "^3.722.0","@corentinth/chisels": "^1.1.0","@corentinth/friendly-ids": "^0.0.1",+ "@crowlog/async-context-plugin": "^1.0.0",+ "@crowlog/logger": "^1.1.0","@hono/node-server": "^1.13.7","@hono/oauth-providers": "^0.6.2","@libsql/client": "^0.14.0",@@ -50,6 +52,7 @@},"devDependencies": {"@antfu/eslint-config": "catalog:",+ "@crowlog/pretty": "^1.1.1","@total-typescript/ts-reset": "^0.6.1","@types/lodash-es": "^4.17.12","@types/node": "^22.10.2",diff --git a/apps/papra-server/src/modules/documents/documents.usecases.ts b/apps/papra-server/src/modules/documents/documents.usecases.tsindex 8635396f..92d7c460 100644--- a/apps/papra-server/src/modules/documents/documents.usecases.ts+++ b/apps/papra-server/src/modules/documents/documents.usecases.ts@@ -1,5 +1,5 @@import type { Config } from '../config/config.types';-import type { Logger } from '../shared/logger/logger.types';+import type { Logger } from '../shared/logger/logger';import type { DocumentsRepository } from './documents.repository';import type { DocumentStorageService } from './storage/documents.storage.services';import { safely } from '@corentinth/chisels';diff --git a/apps/papra-server/src/modules/intake-emails/intake-emails.usecases.test.ts b/apps/papra-server/src/modules/intake-emails/intake-emails.usecases.test.tsindex 1afeb5ad..1f55e1a1 100644--- a/apps/papra-server/src/modules/intake-emails/intake-emails.usecases.test.ts+++ b/apps/papra-server/src/modules/intake-emails/intake-emails.usecases.test.ts@@ -1,4 +1,5 @@import type { Config } from '../config/config.types';+import { createInMemoryLoggerTransport } from '@crowlog/logger';import { pick } from 'lodash-es';import { describe, expect, test } from 'vitest';import { createInMemoryDatabase } from '../app/database/database.test-utils';@@ -6,7 +7,6 @@ import { createDocumentsRepository } from '../documents/documents.repository';import { documentsTable } from '../documents/documents.table';import { createDocumentStorageService } from '../documents/storage/documents.storage.services';import { createLogger } from '../shared/logger/logger';-import { createInMemoryLoggerTransport } from '../shared/logger/transports/in-memory.logger-transport';import { createIntakeEmailsRepository } from './intake-emails.repository';import { ingestEmailForRecipient, processIntakeEmailIngestion } from './intake-emails.usecases';diff --git a/apps/papra-server/src/modules/intake-emails/intake-emails.usecases.ts b/apps/papra-server/src/modules/intake-emails/intake-emails.usecases.tsindex b0f622f0..d790de65 100644--- a/apps/papra-server/src/modules/intake-emails/intake-emails.usecases.ts+++ b/apps/papra-server/src/modules/intake-emails/intake-emails.usecases.ts@@ -1,6 +1,6 @@import type { DocumentsRepository } from '../documents/documents.repository';import type { DocumentStorageService } from '../documents/storage/documents.storage.services';-import type { Logger } from '../shared/logger/logger.types';+import type { Logger } from '../shared/logger/logger';import type { IntakeEmailsRepository } from './intake-emails.repository';import { safely } from '@corentinth/chisels';import { createDocument } from '../documents/documents.usecases';diff --git a/apps/papra-server/src/modules/shared/logger/logger.constants.ts b/apps/papra-server/src/modules/shared/logger/logger.constants.tsdeleted file mode 100644index a06523a8..00000000--- a/apps/papra-server/src/modules/shared/logger/logger.constants.ts+++ /dev/null@@ -1 +0,0 @@-export const logLevels = ['debug', 'info', 'warn', 'error'] as const;diff --git a/apps/papra-server/src/modules/shared/logger/logger.ts b/apps/papra-server/src/modules/shared/logger/logger.tsindex 63d1f17a..de642dba 100644--- a/apps/papra-server/src/modules/shared/logger/logger.ts+++ b/apps/papra-server/src/modules/shared/logger/logger.ts@@ -1,56 +1,7 @@-import type { LoggerTransport, LogLevel, LogMethodArguments } from './logger.types';-import { AsyncLocalStorage } from 'node:async_hooks';-import { logLevels } from './logger.constants';-import { createConsoleLoggerTransport } from './transports/console.logger-transport';+import { addLogContext, createAsyncContextPlugin, wrapWithLoggerContext } from '@crowlog/async-context-plugin';+import { createLoggerFactory, type Logger } from '@crowlog/logger';-const asyncLocalStorage = new AsyncLocalStorage<Record<string, unknown>>();+export type { Logger };+export { addLogContext, wrapWithLoggerContext };-export function addLogContext(context: Record<string, unknown>) {- const currentContext = asyncLocalStorage.getStore();-- if (!currentContext) {- console.warn('Trying to add log context outside of logger middleware');- return;- }-- Object.assign(currentContext, context);-}--export function wrapWithLoggerContext<T>(data: Record<string, unknown>, cb: () => T) {- return asyncLocalStorage.run({ ...data }, cb);-}--export function createLogger({- namespace,- transports = [createConsoleLoggerTransport()],-}: {- namespace: string;- transports?: LoggerTransport[];-}) {- const buildLogger = ({ level }: { level: LogLevel }) => {- return (...args: [data: Record<string, unknown>, message: string] | [message: string]) => {- const [data, message] = args.length === 1 ? [{}, args[0]] : args;-- const loggerContext = asyncLocalStorage.getStore();- const timestampMs = Date.now();-- transports.forEach((transport) => {- transport.log({- level,- message,- timestampMs,- namespace,- data: {- ...loggerContext,- ...data,- },- });- });- };- };-- return logLevels.reduce((acc, level) => ({- ...acc,- [level]: buildLogger({ level }),- }), {} as Record<LogLevel, (...args: LogMethodArguments) => void>);-}+export const createLogger = createLoggerFactory({ plugins: [createAsyncContextPlugin()] });diff --git a/apps/papra-server/src/modules/shared/logger/logger.types.ts b/apps/papra-server/src/modules/shared/logger/logger.types.tsdeleted file mode 100644index 43586017..00000000--- a/apps/papra-server/src/modules/shared/logger/logger.types.ts+++ /dev/null@@ -1,19 +0,0 @@-import type { createLogger } from './logger';-import type { logLevels } from './logger.constants';--export type Logger = ReturnType<typeof createLogger>;--export type LogLevel = typeof logLevels[number];-export type LoggerTransportLogArgs = {- level: LogLevel;- message: string;- timestampMs: number;- namespace: string;- data: Record<string, unknown>;-};--export type LoggerTransport = {- log: (args: LoggerTransportLogArgs) => void;-};--export type LogMethodArguments = [data: Record<string, unknown>, message: string] | [message: string];diff --git a/apps/papra-server/src/modules/shared/logger/transports/console.logger-transport.ts b/apps/papra-server/src/modules/shared/logger/transports/console.logger-transport.tsdeleted file mode 100644index b5be3d12..00000000--- a/apps/papra-server/src/modules/shared/logger/transports/console.logger-transport.ts+++ /dev/null@@ -1,19 +0,0 @@-import type { LoggerTransport, LogLevel } from '../logger.types';--export function createConsoleLoggerTransport(): LoggerTransport {- return {- log({ level, data, ...extra }) {- const consoleMethodMap: Record<LogLevel, 'log' | 'warn' | 'error'> = {- debug: 'log',- info: 'log',- warn: 'warn',- error: 'error',- };-- const consoleMethod = consoleMethodMap[level];-- // eslint-disable-next-line no-console- console[consoleMethod]({ ...data, ...extra, level });- },- };-}diff --git a/apps/papra-server/src/modules/shared/logger/transports/in-memory.logger-transport.test.ts b/apps/papra-server/src/modules/shared/logger/transports/in-memory.logger-transport.test.tsdeleted file mode 100644index 087bfcf9..00000000--- a/apps/papra-server/src/modules/shared/logger/transports/in-memory.logger-transport.test.ts+++ /dev/null@@ -1,35 +0,0 @@-import { omit } from 'lodash-es';-import { describe, expect, test } from 'vitest';-import { createLogger } from '../logger';-import { createInMemoryLoggerTransport } from './in-memory.logger-transport';--describe('in-memory logger-transport', () => {- test('logged messages are accessible through getLogs', () => {- const transport = createInMemoryLoggerTransport();-- const logger = createLogger({- namespace: 'test',- transports: [transport],- });-- logger.info('Hello world');- logger.error({ error: new Error('An error occurred') }, 'An error occurred');-- expect(transport.getLogs().map(log => omit(log, 'timestampMs'))).to.eql([- {- level: 'info',- message: 'Hello world',- namespace: 'test',- data: {},- },- {- level: 'error',- message: 'An error occurred',- namespace: 'test',- data: {- error: new Error('An error occurred'),- },- },- ]);- });-});diff --git a/apps/papra-server/src/modules/shared/logger/transports/in-memory.logger-transport.ts b/apps/papra-server/src/modules/shared/logger/transports/in-memory.logger-transport.tsdeleted file mode 100644index 290742db..00000000--- a/apps/papra-server/src/modules/shared/logger/transports/in-memory.logger-transport.ts+++ /dev/null@@ -1,25 +0,0 @@-import type { LoggerTransport, LoggerTransportLogArgs } from '../logger.types';--type LogWithoutTimestamp = Omit<LoggerTransportLogArgs, 'timestampMs'>;--type InMemoryLoggerTransport = LoggerTransport & {- getLogs: ((options: { excludeTimestampMs: true }) => LogWithoutTimestamp[])- & ((options?: { excludeTimestampMs?: false }) => LoggerTransportLogArgs[]);-};--export function createInMemoryLoggerTransport(): InMemoryLoggerTransport {- const logs: LoggerTransportLogArgs[] = [];-- return {- log: (args) => {- logs.push(args);- },- getLogs: (options) => {- if (options?.excludeTimestampMs === true) {- return logs.map(({ timestampMs: _, ...log }) => log) as ReturnType<InMemoryLoggerTransport['getLogs']>;- }-- return logs;- },- };-}diff --git a/apps/papra-server/src/modules/tasks/tasks.models.ts b/apps/papra-server/src/modules/tasks/tasks.models.tsindex ad2060cd..1c74f91c 100644--- a/apps/papra-server/src/modules/tasks/tasks.models.ts+++ b/apps/papra-server/src/modules/tasks/tasks.models.ts@@ -1,6 +1,6 @@import type { Database } from '../app/database/database.types';import type { Config } from '../config/config.types';-import type { Logger } from '../shared/logger/logger.types';+import type { Logger } from '../shared/logger/logger';import { isFunction } from 'lodash-es';import { createLogger } from '../shared/logger/logger';diff --git a/apps/papra-server/src/scripts/commons/run-script.ts b/apps/papra-server/src/scripts/commons/run-script.tsindex 4c44bb08..868cbb02 100644--- a/apps/papra-server/src/scripts/commons/run-script.ts+++ b/apps/papra-server/src/scripts/commons/run-script.ts@@ -1,6 +1,6 @@import type { Database } from '../../modules/app/database/database.types';import type { Config } from '../../modules/config/config.types';-import type { Logger } from '../../modules/shared/logger/logger.types';+import type { Logger } from '../../modules/shared/logger/logger';import process from 'node:process';import { setupDatabase } from '../../modules/app/database/database';import { parseConfig } from '../../modules/config/config';diff --git a/pnpm-lock.yaml b/pnpm-lock.yamlindex 6288475d..ba8d04fd 100644--- a/pnpm-lock.yaml+++ b/pnpm-lock.yaml@@ -217,6 +217,12 @@ importers:'@corentinth/friendly-ids':specifier: ^0.0.1version: 0.0.1+ '@crowlog/async-context-plugin':+ specifier: ^1.0.0+ version: 1.0.0+ '@crowlog/logger':+ specifier: ^1.1.0+ version: 1.1.0'@hono/node-server':specifier: ^1.13.7version: 1.13.8([email protected])@@ -269,6 +275,9 @@ importers:'@antfu/eslint-config':specifier: 'catalog:'version: 3.14.0(@typescript-eslint/[email protected]([email protected]([email protected]))([email protected]))(@vue/[email protected])([email protected]([email protected]))([email protected]([email protected]([email protected]))([email protected]))([email protected]([email protected]))([email protected])([email protected](@types/[email protected])(@types/[email protected])([email protected]))+ '@crowlog/pretty':+ specifier: ^1.1.1+ version: 1.1.1'@total-typescript/ts-reset':specifier: ^0.6.1version: 0.6.1@@ -611,8 +620,8 @@ packages:engines: {node: '>=6.0.0'}hasBin: true- '@babel/[email protected]':- resolution: {integrity: sha512-kEvgGGgEjRUutvdVvZhbn/BxVt+5VSpwXz1j3WYXQbXDo8KzFOPNG2GQbdAiNq8g6wn1yKk7C/qrke03a84V+w==}+ '@babel/[email protected]':+ resolution: {integrity: sha512-TZIQ25pkSoaKEYYaHbbxkfL36GNsQ6iFiBbeuzAkLnXayKR1yP1zFe+NxuZWWsUyvt8icPU9CCq0sgWGXR1GEw==}engines: {node: '>=6.0.0'}hasBin: true@@ -638,8 +647,8 @@ packages:resolution: {integrity: sha512-vN5p+1kl59GVKMvTHt55NzzmYVxprfJD+ql7U9NFIfKCBkYE55LYtS+WtPlaYOyzydrKI8Nezd+aZextrd+FMA==}engines: {node: '>=6.9.0'}- '@babel/[email protected]':- resolution: {integrity: sha512-t8kDRGrKXyp6+tjUh7hw2RLyclsW4TRoRvRHtSyAX9Bb5ldlFh+90YAYY6awRXrlB4G5G2izNeGySpATlFzmOg==}+ '@babel/[email protected]':+ resolution: {integrity: sha512-eUuWapzEGWFEpHFxgEaBG8e3n6S8L3MSu0oda755rOfabWPnh0Our1AozNFVUxGFIhbKgd1ksprsoDGMinTOTA==}engines: {node: '>=6.9.0'}'@bcoe/[email protected]':@@ -669,6 +678,19 @@ packages:peerDependencies:solid-js: ^1.8+ '@crowlog/[email protected]':+ resolution: {integrity: sha512-i35Sd16EJ/4Qkr21EfN+uBFqOm3aHhxkpdA9ZIvxydM+9uA9Da/FtwtxEhxxuj/ZlyONcabmcGqqULpuvUVNvQ==}+ engines: {node: '>=22.0.0'}++ '@crowlog/[email protected]':+ resolution: {integrity: sha512-ofV3BxN468s/b4b1cdzXU103rfloTXHalm6hAU+BMnuXRTg3LHrxqwA42gjO+93efqT6zRCAGKQVi03k7W8MOw==}+ engines: {node: '>=22.0.0'}++ '@crowlog/[email protected]':+ resolution: {integrity: sha512-ZkUXxDdoBXJ2Cl/xybyfqTscGZAhlZIUIMhCRgMFQMuFwir8XblQ8mAom3vlUv/OZdzH8zbGryFLvJPDwGScEw==}+ engines: {node: '>=22.0.0'}+ hasBin: true+'@csstools/[email protected]':resolution: {integrity: sha512-MKtmkA0BX87PKaO1NFRTFH+UnkgnmySQOvNxJubsadusqPEC2aJ9MOQiMceZJJ6oitUl/i0L6u0M1IrmAOmgBA==}engines: {node: '>=18'}@@ -3273,6 +3295,9 @@ packages:resolution: {integrity: sha512-VBBaLc1MgL5XpzgIP7ny5Z6Nx3UrRkIViUkPUdtl9aya5amy3De1gsUUSB1g3+3sExYNjCAsAznmukyxCb1GRA==}+ resolution: {integrity: sha512-8vDa8Qxvr/+d94hSh5P3IJwI5t8/c0KsMp+g8bNw9cY2icONa5aPfvKeieW1WlG0WQYwwhJ7mjui2xtiePQSXw==}+resolution: {integrity: sha512-O8x12RzrUF8xyVcY0KJowWsmaJxQbmy0/EtnNtHRpsOcT7dFk5W598coHqBVpmWo1oQQfsCqfCmkZN5DJrZVdg==}@@ -4364,6 +4389,7 @@ packages:resolution: {integrity: sha512-T9eIRCs6b0J1SHKYIvD8+KCJMcWZ900iZyxdnSCdqxN12Z1ijzT+jY5nrk72Jw4B0HGzms2NgpryArlJqvc3Lw==}+ cpu: [x64, arm64, wasm32]os: [darwin, linux, win32]@@ -5264,6 +5290,11 @@ packages:engines: {node: '>=10'}hasBin: true+ resolution: {integrity: sha512-hlq8tAfn0m/61p4BVRcPzIGr6LKiMwo4VM6dGi6pt4qcRkmNzTcWq6eCEjEh+qXjkMDvPlOFFSGwQjoEa6gyMA==}+ engines: {node: '>=10'}+ hasBin: true+resolution: {integrity: sha512-qNSy1+nUj7hsCOon7AO4wdAIo9P0jrzAMp18XhiOzA6/uO5TKtP7ScozVJ8T293oRIvi5wyCHSM4TrJo/c/GJA==}engines: {node: '>=10'}@@ -5563,10 +5594,17 @@ packages:resolution: {integrity: sha512-RNnIXDB1FD4T9cpQRErEqw6ZpjLlGdMOitdV+0xtbsnwr4YFka1zpc7D4KD+aAn8oSG5JyFrdasZTE04qDE9Yg==}+ resolution: {integrity: sha512-bCaqm24FPk8OgBkM0u/SrEWJgHnhBWYqeBo6yUmcZJDCHt/IfyWBb+14CXdGi4RInMv4v7eUAin15W0DoA+Ytg==}+resolution: {integrity: sha512-/W1YVgYVJd9ZDjey5NXadNh0mJXkiUMUue9Zebd0vpdo1sU+H4zFFTaJ1RKD4N6KFoHfcXy6l+Vu7bh+bdWCzA==}hasBin: true+ resolution: {integrity: sha512-lBpoWgy+kYmuXWQ83+R7LlJCnsd9YW8DGpZSHhrMl4b8Ly/1vzOie3OdtmUJDkKxcgRGOehDu5btKkty+JEe+g==}+ hasBin: true+resolution: {integrity: sha512-65P7iz6X5yEr1cwcgvQxbbIw7Uk3gOy5dIdtZ4rDveLqhrdJP+Li/Hx6tyK0NEb+2GCyneCMJiGqrADCSNk8sQ==}engines: {node: '>=8.0'}@@ -5583,6 +5621,10 @@ packages:resolution: {integrity: sha512-FRKsF7cz96xIIeMZ82ehjC3xW2E+O2+v11udrDYewUbszngYhsGa8z6YUMMzO9QJZzzyd0nGGXnML/TReX6W8Q==}engines: {node: '>=16'}+ resolution: {integrity: sha512-Ek7HndSVkp10hmHP9V4qZO1u+pn1RU5sI0Fw+jCU3lyvuMZcgqsNgc6CmJJZyByK4Vm/qotGRJlfgAX8q+4JiA==}+ engines: {node: '>=16'}+resolution: {integrity: sha512-N3WMsuqV66lT30CrXNbEjx4GEwlow3v6rr4mCcv6prnfwhS01rkgyFdjPNBYd9br7LpXV1+Emh01fHnq2Gdgrw==}@@ -5602,6 +5644,12 @@ packages:peerDependencies:typescript: '>=4.8.4'+ resolution: {integrity: sha512-dnlgjFSVetynI8nzgJ+qF62efpglpWRk8isUEWZGWlJYySCTD6aKvbUDu+zbPeDakk3bg5H4XpitHukgfL1m9w==}+ engines: {node: '>=18.12'}+ peerDependencies:+ typescript: '>=4.8.4'+resolution: {integrity: sha512-d4IxJUXROL5NCa3amvMg6VQW2HVtZYmUTPfvVtO7zJWGYLJ+mry9v2OmYm+z67aniQoQ8/yFNadiEwtNS9qQiw==}@@ -7011,9 +7059,9 @@ snapshots:dependencies:'@babel/types': 7.26.3- '@babel/[email protected]':+ '@babel/[email protected]':dependencies:- '@babel/types': 7.26.7+ '@babel/types': 7.26.8'@babel/[email protected](@babel/[email protected])':dependencies:@@ -7047,7 +7095,7 @@ snapshots:'@babel/helper-string-parser': 7.25.9'@babel/helper-validator-identifier': 7.25.9- '@babel/[email protected]':+ '@babel/[email protected]':dependencies:'@babel/helper-string-parser': 7.25.9'@babel/helper-validator-identifier': 7.25.9@@ -7082,6 +7130,14 @@ snapshots:'@floating-ui/dom': 1.6.13solid-js: 1.9.4+ '@crowlog/[email protected]': {}++ '@crowlog/[email protected]': {}++ '@crowlog/[email protected]':+ dependencies:+ picocolors: 1.1.1+'@csstools/[email protected]': {}'@csstools/[email protected](@csstools/[email protected](@csstools/[email protected]))(@csstools/[email protected])':@@ -8954,8 +9010,8 @@ snapshots:fast-glob: 3.3.3is-glob: 4.0.3minimatch: 9.0.5- semver: 7.7.0- ts-api-utils: 2.0.0([email protected])+ semver: 7.7.1+ ts-api-utils: 2.0.1([email protected])typescript: 5.7.3transitivePeerDependencies:- supports-color@@ -9311,7 +9367,7 @@ snapshots:'@vue/[email protected]':dependencies:- '@babel/parser': 7.26.7+ '@babel/parser': 7.26.8'@vue/shared': 3.5.13entities: 4.5.0estree-walker: 2.0.2@@ -9324,7 +9380,7 @@ snapshots:'@vue/[email protected]':dependencies:- '@babel/parser': 7.26.7+ '@babel/parser': 7.26.8'@vue/compiler-core': 3.5.13'@vue/compiler-dom': 3.5.13'@vue/compiler-ssr': 3.5.13@@ -9940,6 +9996,9 @@ snapshots:+ optional: true+dependencies:character-entities: 2.0.2@@ -11472,7 +11531,7 @@ snapshots:dependencies:cssstyle: 4.2.1data-urls: 5.0.0- decimal.js: 10.4.3+ decimal.js: 10.5.0form-data: 4.0.1html-encoding-sniffer: 4.0.0http-proxy-agent: 7.0.2@@ -11483,7 +11542,7 @@ snapshots:rrweb-cssom: 0.8.0saxes: 6.0.0symbol-tree: 3.2.4- tough-cookie: 5.0.0+ tough-cookie: 5.1.1w3c-xmlserializer: 5.0.0webidl-conversions: 7.0.0whatwg-encoding: 3.1.1@@ -12822,6 +12881,8 @@ snapshots:+ [email protected]: {}+dependencies:seroval: 1.1.1@@ -13192,10 +13253,18 @@ snapshots:+ optional: true+dependencies:tldts-core: 6.1.70+ dependencies:+ tldts-core: 6.1.77+ optional: true+dependencies:is-number: 7.0.0@@ -13210,6 +13279,11 @@ snapshots:dependencies:tldts: 6.1.70+ dependencies:+ tldts: 6.1.77+ optional: true+@@ -13224,6 +13298,10 @@ snapshots:dependencies:typescript: 5.7.3+ dependencies:+ typescript: 5.7.3+