Merge pull request #5155 from Shopify/catlee/theme_notfound

Handle missing themes in fetchTheme()

Author: catlee

packages/cli-kit/src/public/node/themes/api.test.ts

@@ -1,6 +1,7 @@
 import {
   createTheme,
   themeDelete,
+  fetchTheme,
   fetchThemes,
   ThemeParams,
   themeUpdate,
@@ -18,9 +19,11 @@ import {GetThemeFileChecksums} from '../../../cli/api/graphql/admin/generated/ge
 import {ThemeFilesUpsert} from '../../../cli/api/graphql/admin/generated/theme_files_upsert.js'
 import {OnlineStoreThemeFileBodyInputType} from '../../../cli/api/graphql/admin/generated/types.js'
 import {GetThemes} from '../../../cli/api/graphql/admin/generated/get_themes.js'
+import {GetTheme} from '../../../cli/api/graphql/admin/generated/get_theme.js'
 import {test, vi, expect, describe} from 'vitest'
 import {adminRequestDoc, restRequest, supportedApiVersions} from '@shopify/cli-kit/node/api/admin'
 import {AbortError} from '@shopify/cli-kit/node/error'
+import {ClientError} from 'graphql-request'
 
 vi.mock('@shopify/cli-kit/node/api/admin')
 vi.mock('@shopify/cli-kit/node/system')
@@ -29,6 +32,52 @@ const session = {token: 'token', storeFqdn: 'my-shop.myshopify.com', refresh: as
 const themeAccessSession = {...session, token: 'shptka_token'}
 const sessions = {CLI: session, 'Theme Access': themeAccessSession}
 
+describe('fetchTheme', () => {
+  test('returns a store theme', async () => {
+    vi.mocked(adminRequestDoc).mockResolvedValue({
+      theme: {id: 'gid://shopify/OnlineStoreTheme/123', name: 'store theme 1', role: 'MAIN', processing: false},
+    })
+
+    // When
+    const theme = await fetchTheme(123, session)
+
+    // Then
+    expect(adminRequestDoc).toHaveBeenCalledWith(
+      GetTheme,
+      session,
+      {id: 'gid://shopify/OnlineStoreTheme/123'},
+      undefined,
+      {handleErrors: false},
+    )
+
+    expect(theme).not.toBeNull()
+    expect(theme!.id).toEqual(123)
+    expect(theme!.name).toEqual('store theme 1')
+    expect(theme!.processing).toBeFalsy()
+  })
+
+  test('returns undefined when a theme is not found', async () => {
+    const errorResponse = {
+      status: 200,
+      errors: [{message: 'Theme does not exist'} as any],
+    }
+    vi.mocked(adminRequestDoc).mockRejectedValue(new ClientError(errorResponse, {query: ''}))
+
+    // When
+    const theme = await fetchTheme(123, session)
+
+    // Then
+    expect(theme).toBeUndefined()
+    expect(adminRequestDoc).toHaveBeenCalledWith(
+      GetTheme,
+      session,
+      {id: 'gid://shopify/OnlineStoreTheme/123'},
+      undefined,
+      {handleErrors: false},
+    )
+  })
+})
+
 describe('fetchThemes', () => {
   test('returns store themes', async () => {
     // Given

packages/cli-kit/src/public/node/themes/api.ts

@@ -25,23 +25,34 @@ import {buildTheme} from '@shopify/cli-kit/node/themes/factories'
 import {Result, Checksum, Key, Theme, ThemeAsset, Operation} from '@shopify/cli-kit/node/themes/types'
 import {outputDebug} from '@shopify/cli-kit/node/output'
 import {sleep} from '@shopify/cli-kit/node/system'
+import {ClientError} from 'graphql-request'
 
 export type ThemeParams = Partial<Pick<Theme, 'name' | 'role' | 'processing' | 'src'>>
 export type AssetParams = Pick<ThemeAsset, 'key'> & Partial<Pick<ThemeAsset, 'value' | 'attachment'>>
 
 export async function fetchTheme(id: number, session: AdminSession): Promise<Theme | undefined> {
-  const response = await adminRequestDoc(GetTheme, session, {id: composeThemeGid(id)})
-
-  const {theme} = response
-  if (!theme) {
-    return undefined
+  try {
+    const response = await adminRequestDoc(GetTheme, session, {id: composeThemeGid(id)}, undefined, {
+      handleErrors: false,
+    })
+    const {theme} = response
+    if (!theme) {
+      return undefined
+    }
+    return buildTheme({
+      id: parseGid(theme.id),
+      processing: theme.processing,
+      role: theme.role.toLowerCase(),
+      name: theme.name,
+    })
+  } catch (error) {
+    if (error instanceof ClientError) {
+      if (error.response?.errors?.[0]?.message === 'Theme does not exist') {
+        return undefined
+      }
+    }
+    throw new AbortError(`Failed to fetch theme: ${id}`)
   }
-  return buildTheme({
-    id: parseGid(theme.id),
-    processing: theme.processing,
-    role: theme.role.toLowerCase(),
-    name: theme.name,
-  })
 }
 
 export async function fetchThemes(session: AdminSession): Promise<Theme[]> {