Merge pull request #5292 from Shopify/js.show-error-message-when-no-logs-available

show error message in replay command when no logs available

Author: jacobsteves

.changeset/lemon-eggs-exist.md

@@ -0,0 +1,5 @@
+---
+'@shopify/app': patch
+---
+
+Improve error message in function replay command when log directory doesnt exist

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

@@ -10,7 +10,9 @@ import {readFile} from '@shopify/cli-kit/node/fs'
 import {describe, expect, beforeAll, test, vi} from 'vitest'
 import {AbortError} from '@shopify/cli-kit/node/error'
 import {outputInfo} from '@shopify/cli-kit/node/output'
-import {readdirSync} from 'fs'
+import {getLogsDir} from '@shopify/cli-kit/node/logs'
+
+import {existsSync, readdirSync} from 'fs'
 
 vi.mock('fs')
 vi.mock('@shopify/cli-kit/node/fs')
@@ -111,6 +113,24 @@ describe('replay', () => {
 
   test('throws error if no logs available', async () => {
     // Given
+    mockFileOperations([])
+
+    // When/Then
+    await expect(async () => {
+      await replay({
+        app: testAppLinked(),
+        extension,
+        stdout: false,
+        path: 'test-path',
+        json: true,
+        watch: false,
+      })
+    }).rejects.toThrow(new AbortError(`No logs found in ${getLogsDir()}`))
+  })
+
+  test('throws error if log directory does not exist', async () => {
+    // Given
+    vi.mocked(existsSync).mockReturnValue(false)
 
     // When/Then
     await expect(async () => {
@@ -122,7 +142,7 @@ describe('replay', () => {
         json: true,
         watch: false,
       })
-    }).rejects.toThrow()
+    }).rejects.toThrow(new AbortError(`No logs found in ${getLogsDir()}`))
   })
 
   test('delegates to renderReplay when watch is true', async () => {
@@ -285,6 +305,7 @@ function expectFunctionRun(functionExtension: ExtensionInstance<FunctionConfigTy
 }
 
 function mockFileOperations(data: {run: FunctionRunData; path: string}[]) {
+  vi.mocked(existsSync).mockReturnValue(true)
   vi.mocked(readdirSync).mockReturnValue([...data].reverse().map(({path}) => path) as any)
   vi.mocked(readFile).mockImplementation((path) => {
     const run = data.find((file) => path.endsWith(file.path))

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

@@ -12,7 +12,7 @@ import {getLogsDir} from '@shopify/cli-kit/node/logs'
 import {AbortError} from '@shopify/cli-kit/node/error'
 import {AbortController} from '@shopify/cli-kit/node/abort'
 
-import {readdirSync} from 'fs'
+import {existsSync, readdirSync} from 'fs'
 
 const LOG_SELECTOR_LIMIT = 100
 
@@ -124,7 +124,7 @@ async function findFunctionRun(
   functionHandle: string,
   identifier: string,
 ): Promise<string | undefined> {
-  const fileName = readdirSync(functionRunsDir).find((filename) => {
+  const fileName = getAllFunctionRunFileNames(functionRunsDir).find((filename) => {
     const fileMetadata = parseLogFilename(filename)
     return (
       fileMetadata?.namespace === 'extensions' &&
@@ -147,7 +147,7 @@ async function getRunFromSelector(functionRunsDir: string, functionHandle: strin
 }
 
 async function getFunctionRunData(functionRunsDir: string, functionHandle: string): Promise<FunctionRunData[]> {
-  const allFunctionRunFileNames = readdirSync(functionRunsDir)
+  const allFunctionRunFileNames = getAllFunctionRunFileNames(functionRunsDir)
     .filter((filename) => {
       // Expected format: 20240522_150641_827Z_extensions_my-function_abcdef.json
       const fileMetadata = parseLogFilename(filename)
@@ -191,3 +191,7 @@ async function getFunctionRunData(functionRunsDir: string, functionHandle: strin
 function getIdentifierFromFilename(fileName: string): string {
   return fileName.split('_').pop()!.substring(0, 6)
 }
+
+function getAllFunctionRunFileNames(functionRunsDir: string): string[] {
+  return existsSync(functionRunsDir) ? readdirSync(functionRunsDir) : []
+}