Merge pull request #4322 from Shopify/dunk.jsonl-tty

Don't pretty print --json output for logs
Shopify · Aug 14, 2024 · 9b0a43c · 9b0a43c
2 parents a953300 + bae0acf
commit 9b0a43c
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 6 deletions.
diff --git a/packages/app/src/cli/services/app-logs/logs-command/render-json-logs.test.ts b/packages/app/src/cli/services/app-logs/logs-command/render-json-logs.test.ts
@@ -41,8 +41,8 @@ describe('renderJsonLogs', () => {
       },
     })
 
-    expect(outputInfo).toHaveBeenNthCalledWith(1, JSON.stringify({payload: {message: 'Log 1'}}, null, 2))
-    expect(outputInfo).toHaveBeenNthCalledWith(2, JSON.stringify({payload: {message: 'Log 2'}}, null, 2))
+    expect(outputInfo).toHaveBeenNthCalledWith(1, JSON.stringify({payload: {message: 'Log 1'}}))
+    expect(outputInfo).toHaveBeenNthCalledWith(2, JSON.stringify({payload: {message: 'Log 2'}}))
     expect(pollAppLogs).toHaveBeenCalled()
     expect(vi.getTimerCount()).toEqual(1)
   })

diff --git a/packages/app/src/cli/services/app-logs/logs-command/render-json-logs.ts b/packages/app/src/cli/services/app-logs/logs-command/render-json-logs.ts
@@ -46,7 +46,7 @@ export async function renderJsonLogs({
 
   if (appLogs) {
     appLogs.forEach((log) => {
-      outputInfo(toFormattedAppLogJson(log, parseAppLogPayload(log.payload, log.log_type)))
+      outputInfo(toFormattedAppLogJson(log, parseAppLogPayload(log.payload, log.log_type), false))
     })
   }
 

diff --git a/packages/app/src/cli/services/app-logs/utils.ts b/packages/app/src/cli/services/app-logs/utils.ts
@@ -164,8 +164,11 @@ export const handleFetchAppLogsError = async (
   return {retryIntervalMs, nextJwtToken}
 }
 
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-export const toFormattedAppLogJson = (appLog: AppLogData, appLogPayload: AppLogPayload | any): string => {
+export const toFormattedAppLogJson = (
+  appLog: AppLogData,
+  appLogPayload: AppLogPayload | unknown,
+  prettyPrint = true,
+): string => {
   const {cursor: _, ...appLogWithoutCursor} = appLog
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   const toSaveData: any = camelcaseKeys(
@@ -180,7 +183,11 @@ export const toFormattedAppLogJson = (appLog: AppLogData, appLogPayload: AppLogP
     toSaveData.payload.logs = appLogPayload.logs.split('\n').filter(Boolean)
   }
 
-  return JSON.stringify(toSaveData, null, 2)
+  if (prettyPrint) {
+    return JSON.stringify(toSaveData, null, 2)
+  } else {
+    return JSON.stringify(toSaveData)
+  }
 }
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any