Merge pull request #6407 from Shopify/gg-fail-on-missing-path

Abort theme command if path doesn't exist

Author: graygilmore

.changeset/big-ducks-joke.md

@@ -0,0 +1,5 @@
+---
+'@shopify/theme': minor
+---
+
+Abort theme commands if path doesn't exist

packages/theme/src/cli/flags.test.ts

@@ -0,0 +1,45 @@
+import {themeFlags} from './flags.js'
+import {describe, expect, test} from 'vitest'
+import Command from '@shopify/cli-kit/node/base-command'
+import {inTemporaryDirectory} from '@shopify/cli-kit/node/fs'
+import {cwd, resolvePath} from '@shopify/cli-kit/node/path'
+import {mockAndCaptureOutput} from '@shopify/cli-kit/node/testing/output'
+
+class MockCommand extends Command {
+  static flags = {
+    ...themeFlags,
+  }
+
+  async run(): Promise<{[flag: string]: unknown}> {
+    const {flags} = await this.parse(MockCommand)
+    return flags
+  }
+
+  async catch(): Promise<void> {}
+}
+
+describe('themeFlags', () => {
+  describe('path', () => {
+    test('defaults to the current working directory', async () => {
+      const flags = await MockCommand.run([])
+
+      expect(flags.path).toEqual(cwd())
+    })
+
+    test('can be expclitly provided', async () => {
+      await inTemporaryDirectory(async (tmpDir) => {
+        const flags = await MockCommand.run(['--path', tmpDir])
+
+        expect(flags.path).toEqual(resolvePath(tmpDir))
+      })
+    })
+
+    test("renders an error message and exists when the path doesn't exist", async () => {
+      const mockOutput = mockAndCaptureOutput()
+
+      await MockCommand.run(['--path', 'boom'])
+
+      expect(mockOutput.error()).toMatch("A path was explicitly provided but doesn't exist")
+    })
+  })
+})

packages/theme/src/cli/flags.ts

@@ -1,6 +1,8 @@
 import {Flags} from '@oclif/core'
 import {normalizeStoreFqdn} from '@shopify/cli-kit/node/context/fqdn'
 import {resolvePath, cwd} from '@shopify/cli-kit/node/path'
+import {fileExistsSync} from '@shopify/cli-kit/node/fs'
+import {renderError} from '@shopify/cli-kit/node/ui'
 
 /**
  * An object that contains the flags that
@@ -10,7 +12,21 @@ export const themeFlags = {
   path: Flags.string({
     description: 'The path where you want to run the command. Defaults to the current working directory.',
     env: 'SHOPIFY_FLAG_PATH',
-    parse: async (input) => resolvePath(input),
+    parse: async (input) => {
+      const resolvedPath = resolvePath(input)
+
+      if (fileExistsSync(resolvedPath)) {
+        return resolvedPath
+      }
+
+      // We can't use AbortError because oclif catches it and adds its own
+      // messaging that breaks our UI
+      renderError({
+        headline: "A path was explicitly provided but doesn't exist.",
+        body: [`Please check the path and try again: ${resolvedPath}`],
+      })
+      process.exit(1)
+    },
     default: async () => cwd(),
     noCacheDefault: true,
   }),

packages/theme/src/cli/index.test.ts

@@ -6,6 +6,7 @@ import {AdminSession, ensureAuthenticatedThemes} from '@shopify/cli-kit/node/ses
 import {loadEnvironment} from '@shopify/cli-kit/node/environments'
 import {renderConcurrent, renderConfirmationPrompt, renderError} from '@shopify/cli-kit/node/ui'
 import {fileExistsSync} from '@shopify/cli-kit/node/fs'
+import {AbortError} from '@shopify/cli-kit/node/error'
 import type {Writable} from 'stream'
 
 vi.mock('@shopify/cli-kit/node/session')
@@ -121,6 +122,7 @@ describe('ThemeCommand', () => {
     }
     vi.mocked(ensureThemeStore).mockReturnValue('test-store.myshopify.com')
     vi.mocked(ensureAuthenticatedThemes).mockResolvedValue(mockSession)
+    vi.mocked(fileExistsSync).mockReturnValue(true)
   })
 
   describe('run', () => {
@@ -207,6 +209,16 @@ describe('ThemeCommand', () => {
         }),
       )
     })
+
+    test("throws an AbortError if the path doesn't exist", async () => {
+      await CommandConfig.load()
+      const command = new TestThemeCommand([], CommandConfig)
+
+      vi.mocked(fileExistsSync).mockReturnValue(false)
+
+      await expect(command.run()).rejects.toThrow(AbortError)
+      expect(fileExistsSync).toHaveBeenCalledWith('current/working/directory')
+    })
   })
 
   describe('multi environment', () => {
@@ -483,7 +495,6 @@ describe('ThemeCommand', () => {
       const environmentConfig = {store: 'store.myshopify.com'}
       vi.mocked(loadEnvironment).mockResolvedValue(environmentConfig)
       vi.mocked(renderConfirmationPrompt).mockResolvedValue(true)
-      vi.mocked(fileExistsSync).mockReturnValue(true)
 
       await CommandConfig.load()
       const command = new TestThemeCommand(

packages/theme/src/cli/utilities/theme-command.test.ts

@@ -14,6 +14,7 @@ import {
   renderError,
 } from '@shopify/cli-kit/node/ui'
 import {AbortController} from '@shopify/cli-kit/node/abort'
+import {AbortError} from '@shopify/cli-kit/node/error'
 import {recordEvent, compileData} from '@shopify/cli-kit/node/analytics'
 import {addPublicMetadata, addSensitiveMetadata} from '@shopify/cli-kit/node/metadata'
 import {cwd, joinPath} from '@shopify/cli-kit/node/path'
@@ -100,6 +101,10 @@ export default abstract class ThemeCommand extends Command {
 
       recordEvent(`theme-command:${commandName}:single-env:authenticated`)
 
+      if (flags.path && !fileExistsSync(flags.path)) {
+        throw new AbortError(`Path does not exist: ${flags.path}`)
+      }
+
       await this.command(flags, session)
       await this.logAnalyticsData(session)
       return