refactor to add logs to app model

Author: lopert

packages/app/src/cli/models/app/app.ts

@@ -318,6 +318,7 @@ export interface AppInterface<
   updateHiddenConfig: (values: Partial<AppHiddenConfig>) => Promise<void>
   setDevApplicationURLs: (devApplicationURLs: ApplicationURLs) => void
   generateExtensionTypes(): Promise<void>
+  getLogsDir(): string
 }
 
 type AppConstructor<
@@ -445,6 +446,14 @@ export class App<
     return this._hiddenConfig
   }
 
+  getLogsDir() {
+    // Create directory name using app name + partial client_id for uniqueness
+    const clientId = String(this.configuration.client_id || 'unknown')
+    const shortClientId = clientId.substring(0, 8)
+    const dirName = `${this.name}-${shortClientId}`
+    return joinPath(this.directory, '.shopify', 'logs', dirName)
+  }
+
   async updateHiddenConfig(values: Partial<AppHiddenConfig>) {
     if (!this.configuration.client_id) return
     this._hiddenConfig = deepMergeObjects(this.hiddenConfig, values)

packages/app/src/cli/services/app-logs/dev/poll-app-logs.ts

@@ -23,23 +23,21 @@ import {Writable} from 'stream'
 export const pollAppLogs = async ({
   stdout,
   appLogsFetchInput: {jwtToken, cursor},
-  apiKey,
   developerPlatformClient,
   resubscribeCallback,
   storeName,
   organizationId,
   abortSignal,
-  appDirectory,
+  logsDir,
 }: {
   stdout: Writable
   appLogsFetchInput: AppLogsOptions
-  apiKey: string
   developerPlatformClient: DeveloperPlatformClient
   resubscribeCallback: () => Promise<string>
   storeName: string
   organizationId: string
   abortSignal?: AbortSignal
-  appDirectory: string
+  logsDir: string
 }) => {
   if (abortSignal?.aborted) {
     return
@@ -71,10 +69,9 @@ export const pollAppLogs = async ({
           const logFile = await writeAppLogsToFile({
             appLog: log,
             appLogPayload: payload,
-            apiKey,
             stdout,
             storeName,
-            appDirectory,
+            logsDir,
           })
           stdout.write(
             outputContent`${outputToken.gray('└ ')}${outputToken.link(
@@ -120,13 +117,12 @@ export const pollAppLogs = async ({
           jwtToken: nextJwtToken,
           cursor: responseCursor || cursor,
         },
-        apiKey,
         developerPlatformClient,
         resubscribeCallback,
         storeName,
         organizationId,
         abortSignal,
-        appDirectory,
+        logsDir,
       }).catch((error) => {
         outputDebug(`Unexpected error during polling: ${error}}\n`)
       })
@@ -144,13 +140,12 @@ export const pollAppLogs = async ({
           jwtToken,
           cursor: undefined,
         },
-        apiKey,
         developerPlatformClient,
         resubscribeCallback,
         storeName,
         organizationId,
         abortSignal,
-        appDirectory,
+        logsDir,
       }).catch((error) => {
         outputDebug(`Unexpected error during polling: ${error}}\n`)
       })

packages/app/src/cli/services/app-logs/dev/write-app-logs.ts

@@ -13,27 +13,25 @@ interface AppLogFile {
 export const writeAppLogsToFile = async ({
   appLog,
   appLogPayload,
-  apiKey,
   stdout,
   storeName,
-  appDirectory,
+  logsDir,
 }: {
   appLog: AppLogData
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   appLogPayload: any
-  apiKey: string
   stdout: Writable
   storeName: string
-  appDirectory: string
+  logsDir: string
 }): Promise<AppLogFile> => {
   const identifier = randomUUID().substring(0, 6)
 
   const formattedTimestamp = formatTimestampToFilename(appLog.log_timestamp)
   const fileName = `${formattedTimestamp}_${appLog.source_namespace}_${appLog.source}_${identifier}.json`
   const logContent = toFormattedAppLogJson({appLog, appLogPayload, prettyPrint: true, storeName})
 
-  // Write to app's .shopify/logs directory
-  const fullOutputPath = joinPath(appDirectory, '.shopify', 'logs', apiKey, fileName)
+  // Write to the provided logs directory
+  const fullOutputPath = joinPath(logsDir, fileName)
 
   try {
     // Ensure parent directory exists and write the file

packages/app/src/cli/services/dev/processes/app-logs-polling.ts

@@ -6,7 +6,7 @@ import {subscribeToAppLogs} from '../../app-logs/utils.js'
 import {AppLinkedInterface} from '../../../models/app/app.js'
 import {AppEventWatcher, AppEvent} from '../app-events/app-event-watcher.js'
 
-import {createLogsDir} from '@shopify/cli-kit/node/logs'
+import {mkdir} from '@shopify/cli-kit/node/fs'
 import {outputDebug} from '@shopify/cli-kit/node/output'
 
 function hasFunctionExtensions(app: AppLinkedInterface): boolean {
@@ -76,21 +76,20 @@ export const subscribeAndStartPolling: DevProcessFunction<SubscribeAndStartPolli
       stdout,
     )
 
-    const apiKey = appLogsSubscribeVariables.apiKey
-    await createLogsDir(apiKey)
+    const logsDir = localApp.getLogsDir()
+    await mkdir(logsDir)
 
     await pollAppLogs({
       stdout,
       appLogsFetchInput: {jwtToken},
-      apiKey,
       resubscribeCallback: () => {
         return subscribeToAppLogs(developerPlatformClient, appLogsSubscribeVariables, organizationId)
       },
       developerPlatformClient,
       storeName,
       organizationId,
       abortSignal,
-      appDirectory: localApp.directory,
+      logsDir,
     })
   }
 

packages/app/src/cli/services/function/replay.ts

@@ -52,8 +52,7 @@ export async function replay(options: ReplayOptions) {
   const abortController = new AbortController()
 
   try {
-    const apiKey = options.app.configuration.client_id
-    const functionRunsDir = joinPath(app.directory, '.shopify', 'logs', apiKey)
+    const functionRunsDir = app.getLogsDir()
 
     const selectedRun = options.log
       ? await getRunFromIdentifier(functionRunsDir, extension.handle, options.log)