dlog: pretty print multiline only on dev mode (#590)

This PR changes the dlog implementation to print multiline only in dev mode. Hoping to fix the issue with logging services like Datadog where we had each line in a different log Closes #544
river-build · Aug 1, 2024 · 38988a5 · 38988a5
1 parent a5f49a2
commit 38988a5
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 4 deletions.
diff --git a/packages/dlog/src/check.ts b/packages/dlog/src/check.ts
@@ -15,7 +15,7 @@ export class CodeException extends Error {
 
 export function throwWithCode(message?: string, code?: Err, data?: any): never {
     const e = new CodeException(message ?? 'Unknown', code ?? Err.ERR_UNSPECIFIED, data)
-    log('throwWithCode', e.message, e.stack)
+    log('throwWithCode', e)
     throw e
 }
 

diff --git a/packages/dlog/src/dlog.ts b/packages/dlog/src/dlog.ts
@@ -140,6 +140,8 @@ export interface DLogOpts {
 
 const allDlogs: Map<string, DLogger> = new Map()
 
+const isDev = typeof process !== 'undefined' && process.env.NODE_ENV === 'development'
+
 const makeDlog = (d: Debugger, opts?: DLogOpts): DLogger => {
     if (opts?.printStack) {
         // eslint-disable-next-line no-console
@@ -166,14 +168,14 @@ const makeDlog = (d: Debugger, opts?: DLogOpts): DLogger => {
                 newArgs.push(c)
             } else if (typeof c === 'object' && c !== null) {
                 if (c instanceof Error) {
-                    tailArgs.push('\n')
+                    isDev ? fmt.push('%O\n') : fmt.push('%o\n')
                     tailArgs.push(c)
                 } else {
-                    fmt.push('%O\n')
+                    isDev ? fmt.push('%O\n') : fmt.push('%o\n')
                     newArgs.push(cloneAndFormat(c, { shortenHex: true }))
                 }
             } else {
-                fmt.push('%O ')
+                isDev ? fmt.push('%O ') : fmt.push('%o ')
                 newArgs.push(c)
             }
         }

diff --git a/packages/dlog/src/tests/dlog.test.ts b/packages/dlog/src/tests/dlog.test.ts
@@ -5,6 +5,8 @@
 import { dlog, dlogError } from '../dlog'
 import debug from 'debug'
 import { bin_fromHexString } from '../binary'
+import { CodeException } from '../check'
+import { Err } from '@river-build/proto'
 
 describe('dlogTest', () => {
     test('basic', () => {
@@ -211,4 +213,20 @@ describe('dlogTest', () => {
         log = dlog(ns, { defaultEnabled: true, allowJest: true })
         expect(log.enabled).toBeFalsy()
     })
+
+    test('handle error', () => {
+        const e = new CodeException('test', Err.ERR_UNSPECIFIED)
+        const log = dlogError('test:dlog')
+        log.enabled = true
+
+        let output: string = ''
+        log.baseDebug.log = (...args: any[]) => {
+            for (const arg of args) {
+                output += `${arg}`
+            }
+        }
+
+        log('throwWithCode', e)
+        expect(output).toContain('CodeException [Error]: test at Object.<anonymous>')
+    })
 })