feat(backend): add jsonOutput option to logger

Author: johaven

backend/src/applications/comments/services/comments-manager.service.spec.ts

@@ -177,7 +177,7 @@ describe(CommentsManager.name, () => {
       expect(notificationsManager.create).not.toHaveBeenCalled()
       expect(res).toEqual({ id: 777, fileId: 555, content: 'hello' })
       // Verify that the catch of createComment logged the error
-      expect(loggerSpy).toHaveBeenCalledWith(expect.stringContaining('createComment'))
+      expect(loggerSpy).toHaveBeenCalledWith(expect.objectContaining({ tag: 'createComment' }))
       loggerSpy.mockRestore()
     })
 
@@ -196,7 +196,7 @@ describe(CommentsManager.name, () => {
 
       expect(notificationsManager.create).toHaveBeenCalledTimes(1)
       notificationsManager.create.mockClear()
-      expect(loggerSpy).toHaveBeenCalledWith(expect.stringContaining('notify'))
+      expect(loggerSpy).toHaveBeenCalledWith(expect.objectContaining({ tag: 'notify' }))
       loggerSpy.mockRestore()
 
       const space = makeSpace()
@@ -235,7 +235,7 @@ describe(CommentsManager.name, () => {
       await new Promise((r) => setImmediate(r))
 
       expect(notificationsManager.create).toHaveBeenCalledTimes(1)
-      expect(loggerSpy).toHaveBeenCalledWith(expect.stringContaining('notify'))
+      expect(loggerSpy).toHaveBeenCalledWith(expect.objectContaining({ tag: 'notify' }))
       loggerSpy.mockRestore()
     })
 

backend/src/applications/notifications/services/notifications-manager.service.spec.ts

@@ -126,7 +126,7 @@ describe(NotificationsManager.name, () => {
       await service.create([1], { app: NOTIFICATION_APP.LINKS } as any)
       await flushPromises()
       expect(loggerSpy).toHaveBeenCalled()
-      expect(loggerSpy.mock.calls[0]?.[0] as string).toMatch(/create/i)
+      expect(loggerSpy.mock.calls[0]?.[0]).toMatchObject({ tag: 'storeNotification' })
     })
 
     it('logs error when storeNotification promise rejects (create catch)', async () => {
@@ -135,7 +135,7 @@ describe(NotificationsManager.name, () => {
       await service.create([1, 2], { app: NOTIFICATION_APP.SYNC } as any, { author: { id: 5, login: 'xx' } } as any)
       await flushPromises()
       expect(loggerSpy).toHaveBeenCalled()
-      expect(loggerSpy.mock.calls[0]?.[0] as string).toMatch(/create/i)
+      expect(loggerSpy.mock.calls[0]?.[0]).toMatchObject({ tag: 'create' })
     })
 
     it('logs error when sendEmailNotification rejects (create catch)', async () => {
@@ -145,7 +145,7 @@ describe(NotificationsManager.name, () => {
       await service.create([1], { app: NOTIFICATION_APP.COMMENTS } as any)
       await flushPromises()
       expect(loggerSpy).toHaveBeenCalled()
-      expect(loggerSpy.mock.calls[0]?.[0] as string).toMatch(/create/i)
+      expect(loggerSpy.mock.calls[0]?.[0]).toMatchObject({ tag: 'create' })
     })
   })
 
@@ -158,7 +158,7 @@ describe(NotificationsManager.name, () => {
       service.wasRead({ id: 8 } as any, undefined)
       await flushPromises()
       expect(loggerSpy).toHaveBeenCalled()
-      expect(loggerSpy.mock.calls[0]?.[0] as string).toMatch(/wasRead/i)
+      expect(loggerSpy.mock.calls[0]?.[0]).toMatchObject({ tag: 'wasRead' })
     })
   })
 
@@ -206,7 +206,7 @@ describe(NotificationsManager.name, () => {
       const loggerSpy = spyLogger()
       await service.sendEmailNotification([{ id: 1, email: 'a@test', language: 'en' }] as any, { app: NOTIFICATION_APP.SYNC } as any, {} as any)
       expect(loggerSpy).toHaveBeenCalled()
-      expect(loggerSpy.mock.calls[0]?.[0] as string).toMatch(/sendEmailNotification/i)
+      expect(loggerSpy.mock.calls[0]?.[0]).toMatchObject({ tag: 'sendEmailNotification' })
     })
   })
 
@@ -249,7 +249,7 @@ describe(NotificationsManager.name, () => {
       const result = (service as any).genMail('en', { app: 99999 } as any, {} as any)
       expect(result).toBeUndefined()
       expect(loggerSpy).toHaveBeenCalled()
-      expect(loggerSpy.mock.calls[0]?.[0] as string).toMatch(/case not handled/i)
+      expect(loggerSpy.mock.calls[0]?.[0]).toMatchObject({ tag: 'genMail', msg: expect.stringContaining('case not handled') })
     })
   })
 })

backend/src/applications/sync/services/sync-paths-manager.service.spec.ts

@@ -411,7 +411,7 @@ describe(SyncPathsManager.name, () => {
       await flush()
 
       expect(loggerSpy).toHaveBeenCalled()
-      expect(loggerSpy.mock.calls.some(([msg]) => String(msg).includes('updatePaths'))).toBe(true)
+      expect(loggerSpy.mock.calls.some(([payload]: { tag: string }[]) => payload?.tag === 'updatePaths')).toBe(true)
     })
 
     it('should catch notify failure at updatePaths level when building notification fails', async () => {
@@ -427,7 +427,7 @@ describe(SyncPathsManager.name, () => {
 
       expect(res.delete).toEqual([1])
       expect(loggerSpy).toHaveBeenCalled()
-      expect(loggerSpy.mock.calls.some(([msg]) => String(msg).includes('updatePaths'))).toBe(true)
+      expect(loggerSpy.mock.calls.some(([payload]: { tag: string }[]) => payload?.tag === 'updatePaths')).toBe(true)
       // create not called because we failed before reaching it
       expect(notificationsManager.create).not.toHaveBeenCalled()
     })
@@ -446,7 +446,7 @@ describe(SyncPathsManager.name, () => {
       expect(res.delete).toEqual([2])
       expect(loggerSpy).toHaveBeenCalled()
       // error comes from notify() catch
-      expect(loggerSpy.mock.calls.some(([msg]) => String(msg).includes('notify'))).toBe(true)
+      expect(loggerSpy.mock.calls.some(([payload]: { tag: string }[]) => payload?.tag === 'notify')).toBe(true)
     })
   })
 

backend/src/applications/users/services/users-manager.service.spec.ts

@@ -174,7 +174,7 @@ describe(UsersManager.name, () => {
     const updSpy1 = jest.spyOn(usersManager, 'updateAccesses').mockRejectedValue(new Error('reject-locked'))
     await expect(usersManager.logUser(uLocked, 'pwd', 'ip')).rejects.toThrow('Account locked')
     await flush()
-    expect(errSpy).toHaveBeenCalledWith(expect.stringContaining('reject-locked'))
+    expect(errSpy.mock.calls.some(([payload]: { msg: string }[]) => payload?.msg?.includes('reject-locked'))).toBe(true)
     expect(updSpy1).toHaveBeenCalledWith(uLocked, 'ip', false)
     ;(comparePassword as jest.Mock).mockResolvedValue(false)
     const uBad = new UserModel({ ...generateUserTest(), isActive: true, passwordAttempts: 0 }, false)
@@ -183,7 +183,7 @@ describe(UsersManager.name, () => {
     const out = await usersManager.logUser(uBad, 'bad', '1.1.1.1')
     expect(out).toBeNull()
     await flush()
-    expect(errSpy2).toHaveBeenCalledWith(expect.stringContaining('reject-auth'))
+    expect(errSpy2.mock.calls.some(([payload]: { msg: string }[]) => payload?.msg?.includes('reject-auth'))).toBe(true)
     expect(updSpy2).toHaveBeenCalledWith(uBad, '1.1.1.1', false)
     ;(comparePassword as jest.Mock).mockResolvedValue(true)
     const uGood = new UserModel({ ...generateUserTest(), isActive: true, passwordAttempts: 0 }, false)
@@ -487,7 +487,7 @@ describe(UsersManager.name, () => {
     const lSpy = jest.spyOn((usersManager as any)['logger'], 'log').mockImplementation(() => undefined as any)
     usersQueriesService.updateGroupMembers = jest.fn().mockResolvedValue(undefined)
     await expect(usersManager.leavePersonalGroup(userTest, 1)).resolves.toBeUndefined()
-    expect(lSpy).toHaveBeenCalledWith(expect.stringMatching(/has left group/))
+    expect(lSpy).toHaveBeenCalledWith(expect.objectContaining({ msg: expect.stringMatching(/has left group/) }))
     usersQueriesService.updateGroupMembers = jest.fn().mockRejectedValue(new Error('DB'))
     await expect(usersManager.leavePersonalGroup(userTest, 1)).rejects.toThrow('DB')
     usersQueriesService.getGroupWithMembers = jest.fn().mockResolvedValue({
@@ -507,11 +507,11 @@ describe(UsersManager.name, () => {
     const wSpy = jest.spyOn((usersManager as any)['logger'], 'warn').mockImplementation(() => undefined as any)
     usersQueriesService.deletePersonalGroup = jest.fn().mockResolvedValue(false)
     await expect(usersManager.deletePersonalGroup(userTest, 7)).rejects.toThrow('Unable to delete group')
-    expect(wSpy).toHaveBeenCalledWith(expect.stringMatching(/does not exist/))
+    expect(wSpy).toHaveBeenCalledWith(expect.objectContaining({ msg: expect.stringMatching(/does not exist/) }))
     const lgSpy = jest.spyOn((usersManager as any)['logger'], 'log').mockImplementation(() => undefined as any)
     usersQueriesService.deletePersonalGroup = jest.fn().mockResolvedValue(true)
     await expect(usersManager.deletePersonalGroup(userTest, 7)).resolves.toBeUndefined()
-    expect(lgSpy).toHaveBeenCalledWith(expect.stringMatching(/was deleted/))
+    expect(lgSpy).toHaveBeenCalledWith(expect.objectContaining({ msg: expect.stringMatching(/was deleted/) }))
   })
 
   it('guests + proxies', async () => {

backend/src/applications/webdav/services/webdav-methods.service.spec.ts

@@ -1447,7 +1447,7 @@ describe('WebDAVMethods', () => {
           // Expected to throw
         }
 
-        expect(logSpy).toHaveBeenCalledWith(expect.stringContaining(' -> /webdav/test/dest.txt'))
+        expect(logSpy.mock.calls.some(([payload]: { msg: string }[]) => payload?.msg?.includes(' -> /webdav/test/dest.txt'))).toBe(true)
       })
     })
   })
@@ -2037,8 +2037,8 @@ describe('WebDAVMethods', () => {
           // Expected to throw
         }
 
-        expect(logSpy).toHaveBeenCalledWith(expect.stringContaining('PUT'))
-        expect(logSpy).toHaveBeenCalledWith(expect.stringContaining('/webdav/test.txt'))
+        expect(logSpy.mock.calls.some(([payload]: { msg: string }[]) => payload?.msg?.includes('PUT'))).toBe(true)
+        expect(logSpy.mock.calls.some(([payload]: { msg: string }[]) => payload?.msg?.includes('/webdav/test.txt'))).toBe(true)
       })
 
       it('should include destination URL in log when provided', () => {
@@ -2053,7 +2053,7 @@ describe('WebDAVMethods', () => {
           // Expected to throw
         }
 
-        expect(logSpy).toHaveBeenCalledWith(expect.stringContaining(' -> /webdav/destination.txt'))
+        expect(logSpy.mock.calls.some(([payload]: { msg: string }[]) => payload?.msg?.includes(' -> /webdav/destination.txt'))).toBe(true)
       })
     })
   })

backend/src/authentication/guards/auth-basic.guard.spec.ts

@@ -126,7 +126,7 @@ describe(AuthBasicGuard.name, () => {
       .mockImplementation(() => undefined)
     await expect(authBasicGuard.canActivate(context)).rejects.toThrow()
     expect(loggerSpy).toHaveBeenCalled()
-    expect(loggerSpy.mock.calls[0][0]).toEqual(expect.stringContaining('cache failed'))
+    expect(loggerSpy.mock.calls[0][0]).toEqual(expect.objectContaining({ tag: 'validate', msg: expect.stringContaining('cache failed') }))
   })
 
   it('should not validate the user authentication', async () => {

backend/src/configuration/config.logger.ts

@@ -39,21 +39,23 @@ export const configLogger = (loggerConfig: LoggerConfig) =>
         return undefined
       }
     },
-    transport: {
-      target: 'pino-pretty',
-      options: {
-        ignore: 'hostname,context,reqId,req,res,user,userAgent,responseTime,tag',
-        hideObject: false,
-        singleLine: false,
-        colorize: loggerConfig.colorize,
-        colorizeObjects: false,
-        translateTime: 'SYS:yyyy-mm-dd HH:MM:ss',
-        messageFormat: `[{context}]{if tag} [{tag}] {end}{if user} <{user}> {end} ${
-          loggerConfig.colorize ? '\x1b[37m' : ''
-        }{msg}{if res} ({res.contentLength} bytes in {responseTime}ms) {userAgent}{end}{if reqId} | {reqId}{end}`,
-        destination: loggerConfig.stdout ? 1 : loggerConfig.filePath,
-        mkdir: true,
-        sync: false
-      }
-    }
+    transport: loggerConfig.jsonOutput
+      ? null
+      : {
+          target: 'pino-pretty',
+          options: {
+            ignore: 'hostname,context,reqId,req,res,user,userAgent,responseTime,tag',
+            hideObject: false,
+            singleLine: false,
+            colorize: loggerConfig.colorize,
+            colorizeObjects: false,
+            translateTime: 'SYS:yyyy-mm-dd HH:MM:ss',
+            messageFormat: `[{context}]{if tag} [{tag}] {end}{if user} <{user}> {end} ${
+              loggerConfig.colorize ? '\x1b[37m' : ''
+            }{msg}{if res} ({res.contentLength} bytes in {responseTime}ms) {userAgent}{end}{if reqId} | {reqId}{end}`,
+            destination: loggerConfig.stdout ? 1 : loggerConfig.filePath,
+            mkdir: true,
+            sync: false
+          }
+        }
   }) satisfies Options

backend/src/configuration/config.validation.ts

@@ -59,6 +59,10 @@ export class LoggerConfig {
   @IsString()
   @Transform(({ value }) => value || DEFAULT_LOG_FILE_PATH)
   filePath: string = DEFAULT_LOG_FILE_PATH
+
+  @IsOptional()
+  @IsBoolean()
+  jsonOutput: boolean = false
 }
 
 export class GlobalConfig {

environment/environment.dist.yaml

@@ -22,6 +22,9 @@ logger:
   # Colorize output.
   # default: `true`
   colorize: true
+  # JSON output. When enabled, `colorize` is ignored.
+  # default: `false`
+  jsonOutput: false
   # Path to the log file used when stdout is set to false
   filePath:
 mysql: