Merge pull request #101 from join-com/JOIN-39427

fix: JOIN-39427 fix long message cropping
join-com · Jan 30, 2024 · 72d1027 · 72d1027
2 parents efdcc74 + a41003c
commit 72d1027
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 3 deletions.
diff --git a/packages/gcloud-logger/__tests__/Logger.ts b/packages/gcloud-logger/__tests__/Logger.ts
@@ -1,5 +1,7 @@
 import { Logger } from '../src'
 describe('logger', () => {
+  afterEach(() => jest.resetAllMocks())
+
   it('truncates field over maxFieldLength', () => {
     const stdoutSpy = jest.spyOn(process.stdout, 'write');
 
@@ -17,4 +19,21 @@ describe('logger', () => {
     const log = '{"response":{"some":"[FILTERED]"},"message":"msg","severity":"DEBUG","level":100}\n'
     expect(stdoutSpy).toHaveBeenCalledWith(log);
   })
-})
+
+  it('ignores provided max field length if warning', () => {
+    const stdoutSpy = jest.spyOn(process.stdout, 'write')
+
+    const logger = new Logger(true, 'DEBUG', [], 5)
+    logger.warn('msg', { response: { some: 'longWord' } })
+    const log = '{"response":{"some":"longWord"},"message":"msg","severity":"WARNING","level":400}\n'
+    expect(stdoutSpy).toHaveBeenCalledWith(log)
+  })
+
+  it('truncates field over maxFieldLengthForError if warning', () => {
+    const stdoutSpy = jest.spyOn(process.stdout, 'write')
+
+    const logger = new Logger(true, 'DEBUG', [], 5)
+    logger.warn('msg', { response: { some: 'x'.repeat(8000) } })
+    expect(stdoutSpy.mock.calls[0]?.[0].length).toBeLessThan(4100)
+  })
+ })
diff --git a/packages/gcloud-logger/src/Logger.ts b/packages/gcloud-logger/src/Logger.ts
@@ -168,7 +168,7 @@ export class Logger {
     const replaceCircular = (obj: any, alreadySeen = new WeakSet()): any => {
       if (typeof obj === 'string') {
         if (obj.length > maxLength) {
-          return obj.substring(0, this.maxFieldLength) + '...TRUNCATED'
+          return obj.substring(0, maxLength) + '...TRUNCATED'
         }
       }
       if (typeof obj !== 'object') {

diff --git a/packages/gcloud-logger/src/index.ts b/packages/gcloud-logger/src/index.ts
@@ -2,11 +2,13 @@ import { Logger } from './Logger'
 
 export { Logger, Level } from './Logger'
 
+const DEFAULT_MAX_LENGTH = '1000'
+
 export const logger = new Logger(
   process.env['NODE_ENV'] === 'production',
   process.env['LOG_LEVEL'],
   undefined,
-  parseInt(process.env['LOG_MAX_FIELD_LENGTH'] ?? '', 10),
+  parseInt(process.env['LOG_MAX_FIELD_LENGTH'] ?? DEFAULT_MAX_LENGTH, 10),
 )
 
 export const reportError = (e: unknown) => {