Merge pull request #4272 from Shopify/1805-unactionable-error

Improved error when storeFromFqdn fails
Shopify · Aug 6, 2024 · 92edac9 · 92edac9
2 parents 11e060f + b07f196
commit 92edac9
Show file tree

Hide file tree

Showing 4 changed files with 31 additions and 25 deletions.
diff --git a/.changeset/gold-waves-agree.md b/.changeset/gold-waves-agree.md
@@ -0,0 +1,6 @@
+---
+'@shopify/cli-kit': patch
+'@shopify/app': patch
+---
+
+Small UI fix when using an invalid shop
diff --git a/packages/app/src/cli/services/context.test.ts b/packages/app/src/cli/services/context.test.ts
@@ -656,11 +656,11 @@ api_version = "2023-04"
  },
  },
  '\n',
- 'You can pass',
+ 'You can pass ',
  {
  command: '--reset',
  },
- 'to your command to reset your app configuration.',
+ ' to your command to reset your app configuration.',
  ],
  headline: 'Using shopify.app.toml:',
  })
@@ -765,11 +765,11 @@ api_version = "2023-04"
  },
  },
  '\n',
- 'You can pass',
+ 'You can pass ',
  {
  command: '--reset',
  },
- 'to your command to reset your app configuration.',
+ ' to your command to reset your app configuration.',
  ],
  headline: 'Using these settings:',
  })
@@ -1268,11 +1268,11 @@ describe('ensureDeployContext', () => {
  },
  },
  '\n',
- 'You can pass',
+ 'You can pass ',
  {
  command: '--reset',
  },
- 'to your command to reset your app configuration.',
+ ' to your command to reset your app configuration.',
  ],
  headline: 'Using shopify.app.toml:',
  })
@@ -1315,11 +1315,11 @@ describe('ensureDeployContext', () => {
  },
  },
  '\n',
- 'You can pass',
+ 'You can pass ',
  {
  command: '--reset',
  },
- 'to your command to reset your app configuration.',
+ ' to your command to reset your app configuration.',
  ],
  headline: 'Using shopify.app.toml:',
  })
@@ -1367,11 +1367,11 @@ describe('ensureDeployContext', () => {
  },
  },
  '\n',
- 'You can pass',
+ 'You can pass ',
  {
  command: '--reset',
  },
- 'to your command to reset your app configuration.',
+ ' to your command to reset your app configuration.',
  ],
  headline: 'Using shopify.app.toml:',
  })
@@ -1419,11 +1419,11 @@ describe('ensureDeployContext', () => {
  },
  },
  '\n',
- 'You can pass',
+ 'You can pass ',
  {
  command: '--reset',
  },
- 'to your command to reset your app configuration.',
+ ' to your command to reset your app configuration.',
  ],
  headline: 'Using shopify.app.toml:',
  })
@@ -1465,11 +1465,11 @@ describe('ensureDeployContext', () => {
  },
  },
  '\n',
- 'You can pass',
+ 'You can pass ',
  {
  command: '--reset',
  },
- 'to your command to reset your app configuration.',
+ ' to your command to reset your app configuration.',
  ],
  headline: 'Using shopify.app.toml:',
  })
@@ -1509,11 +1509,11 @@ describe('ensureDeployContext', () => {
  },
  },
  '\n',
- 'You can pass',
+ 'You can pass ',
  {
  command: '--reset',
  },
- 'to your command to reset your app configuration.',
+ ' to your command to reset your app configuration.',
  ],
  headline: 'Using shopify.app.toml:',
  })

diff --git a/packages/app/src/cli/services/context.ts b/packages/app/src/cli/services/context.ts
@@ -35,7 +35,7 @@ import {
 } from '../api/graphql/development_preview.js'
 import {DeveloperPlatformClient, selectDeveloperPlatformClient} from '../utilities/developer-platform-client.js'
 import {tryParseInt} from '@shopify/cli-kit/common/string'
-import {TokenItem, renderConfirmationPrompt, renderInfo} from '@shopify/cli-kit/node/ui'
+import {Token, TokenItem, renderConfirmationPrompt, renderInfo} from '@shopify/cli-kit/node/ui'
 import {partnersFqdn} from '@shopify/cli-kit/node/context/fqdn'
 import {AbortError} from '@shopify/cli-kit/node/error'
 import {outputContent} from '@shopify/cli-kit/node/output'
@@ -266,7 +266,11 @@ export async function ensureDevContext(options: DevContextOptions): Promise<DevC
  return result
 }
 
-const resetHelpMessage = ['You can pass', {command: '--reset'}, 'to your command to reset your app configuration.']
+const resetHelpMessage: Token[] = [
+ 'You can pass ',
+ {command: '--reset'},
+ ' to your command to reset your app configuration.',
+]
 
 interface AppFromIdOptions {
  apiKey: string
@@ -867,12 +871,7 @@ interface CurrentlyUsedConfigInfoOptions {
  configFile?: string
  appDotEnv?: string
  includeConfigOnDeploy?: boolean
- resetMessage?: (
- | string
- | {
- command: string
- }
- )[]
+ resetMessage?: Token[]
 }
 
 export function renderCurrentlyUsedConfigInfo({

diff --git a/packages/cli-kit/src/public/node/ui.tsx b/packages/cli-kit/src/public/node/ui.tsx
@@ -23,6 +23,7 @@ import {FatalError} from '../../private/node/ui/components/FatalError.js'
 import ScalarDict from '../../private/node/ui/components/Table/ScalarDict.js'
 import {Table, TableColumn, TableProps} from '../../private/node/ui/components/Table/Table.js'
 import {
+ Token,
  tokenItemToString,
  InlineToken,
  LinkToken,
@@ -718,4 +719,4 @@ This usually happens when running a command non-interactively, for example in a
 
 export type Key = InkKey
 export type InfoMessage = InfoMessageProps['message']
-export {Task, TokenItem, InlineToken, LinkToken, TableColumn, InfoTableSection, ListToken, render, handleCtrlC}
+export {Token, Task, TokenItem, InlineToken, LinkToken, TableColumn, InfoTableSection, ListToken, render, handleCtrlC}