Clean up messaging around unlinked storefronts when running CLI commands

.changeset/breezy-jokes-pump.md

@@ -0,0 +1,9 @@
+---
+'@shopify/cli-hydrogen': patch
+---
+
+Clean up messaging around unlinked storefronts when running CLI commands
+
+- When you run `env list`, `env pull`, or `deploy` against a storefront that isn't linked, it will show a warning message instead of an error message.
+- If you don't have a storefront to link to on Admin, we will just ask you to create a storefront instead of displaying an option list of size 1.
+- If you deleted a storefront on Admin, we will try to relink your storefront when running `env list`, `env pull`, or `deploy`.

packages/cli/src/commands/hydrogen/deploy.test.ts

@@ -708,6 +708,111 @@ describe('deploy', () => {
     }
   });
 
+  describe('user confirmation', () => {
+    beforeEach(() => {
+      vi.mocked(getOxygenDeploymentData).mockResolvedValue({
+        oxygenDeploymentToken: 'some-encoded-token',
+        environments: [
+          {
+            name: 'Production',
+            handle: 'production',
+            branch: 'main',
+            type: 'PRODUCTION',
+          },
+          {name: 'Preview', handle: 'preview', branch: null, type: 'PREVIEW'},
+          {
+            name: 'Staging',
+            handle: 'staging',
+            branch: 'stage-1',
+            type: 'CUSTOM',
+          },
+        ],
+      });
+    });
+
+    describe('user provides a non-preview environment', () => {
+      it('renders a user confirmation on deploy when production environment is selected', async () => {
+        vi.mocked(renderSelectPrompt).mockResolvedValue('main');
+
+        await runDeploy(deployParams);
+
+        expect(renderConfirmationPrompt).toHaveBeenCalledWith({
+          confirmationMessage: 'Yes, confirm deploy',
+          cancellationMessage: 'No, cancel deploy',
+          message: expect.any(String),
+        });
+      });
+
+      it('renders a user confirmation on deploy when production environment handle is provided', async () => {
+        await runDeploy({
+          ...deployParams,
+          env: 'production',
+        });
+
+        expect(renderConfirmationPrompt).toHaveBeenCalledWith({
+          confirmationMessage: 'Yes, confirm deploy',
+          cancellationMessage: 'No, cancel deploy',
+          message: expect.any(String),
+        });
+      });
+
+      it('renders a user confirmation on deploy when production environment branch is provided', async () => {
+        await runDeploy({
+          ...deployParams,
+          envBranch: 'main',
+        });
+
+        expect(renderConfirmationPrompt).toHaveBeenCalledWith({
+          confirmationMessage: 'Yes, confirm deploy',
+          cancellationMessage: 'No, cancel deploy',
+          message: expect.any(String),
+        });
+      });
+    });
+
+    describe('user provides a preview environment', () => {
+      it("doesn't render a user confirmation on deploy when preview environment is selected", async () => {
+        vi.mocked(renderSelectPrompt).mockResolvedValue(
+          'shopify-preview-environment.',
+        );
+
+        await runDeploy(deployParams);
+
+        expect(renderConfirmationPrompt).not.toHaveBeenCalledWith({
+          confirmationMessage: 'Yes, confirm deploy',
+          cancellationMessage: 'No, cancel deploy',
+          message: expect.any(String),
+        });
+      });
+
+      it("doesn't render a user confirmation on deploy when preview environment handle is provided", async () => {
+        await runDeploy({
+          ...deployParams,
+          env: 'preview',
+        });
+
+        expect(renderConfirmationPrompt).not.toHaveBeenCalledWith({
+          confirmationMessage: 'Yes, confirm deploy',
+          cancellationMessage: 'No, cancel deploy',
+          message: expect.any(String),
+        });
+      });
+
+      it("doesn't render a user confirmation on deploy when preview environment flag is provided", async () => {
+        await runDeploy({
+          ...deployParams,
+          defaultEnvironment: true,
+        });
+
+        expect(renderConfirmationPrompt).not.toHaveBeenCalledWith({
+          confirmationMessage: 'Yes, confirm deploy',
+          cancellationMessage: 'No, cancel deploy',
+          message: expect.any(String),
+        });
+      });
+    });
+  });
+
   describe('next steps', () => {
     it('renders a link to the deployment', async () => {
       vi.mocked(createDeploy).mockResolvedValue({

packages/cli/src/commands/hydrogen/deploy.ts

@@ -475,37 +475,19 @@ export async function runDeploy(
 
   if (
     !isCI &&
-    (userProvidedEnvironmentTag ||
-      userChosenEnvironmentTag ||
-      config.defaultEnvironment)
+    !config.defaultEnvironment &&
+    (userProvidedEnvironmentTag || userChosenEnvironmentTag)
   ) {
-    let chosenEnvironment: {
-      name: string;
-      branch: string | null;
-      handle: string;
-    } | null = null;
-
-    if (config.defaultEnvironment) {
-      chosenEnvironment = findEnvironmentOrThrow(
-        deploymentData!.environments!,
-        'preview',
-      );
-    } else if (config.environmentTag) {
-      chosenEnvironment = findEnvironmentByBranchOrThrow(
-        deploymentData!.environments!,
-        config.environmentTag,
-      );
-    }
-
-    let confirmationMessage = 'Creating a deployment';
+    let chosenEnvironment = findEnvironmentByBranchOrThrow(
+      deploymentData!.environments!,
+      config.environmentTag!,
+    );
 
-    if (chosenEnvironment) {
-      confirmationMessage += ` against ${createEnvironmentCliChoiceLabel(
-        chosenEnvironment.name,
-        chosenEnvironment.handle,
-        chosenEnvironment.branch,
-      )}`;
-    }
+    let confirmationMessage = `Creating a deployment against ${createEnvironmentCliChoiceLabel(
+      chosenEnvironment.name,
+      chosenEnvironment.handle,
+      chosenEnvironment.branch,
+    )}`;
 
     const confirmPush = await renderConfirmationPrompt({
       confirmationMessage: 'Yes, confirm deploy',

packages/cli/src/commands/hydrogen/env/list.test.ts

@@ -1,17 +1,13 @@
 import {describe, it, expect, vi, beforeEach, afterEach} from 'vitest';
 import {mockAndCaptureOutput} from '@shopify/cli-kit/node/testing/output';
 import {inTemporaryDirectory} from '@shopify/cli-kit/node/fs';
-import {renderConfirmationPrompt} from '@shopify/cli-kit/node/ui';
 
 import {getStorefrontEnvironments} from '../../../lib/graphql/admin/list-environments.js';
 import {dummyListEnvironments} from '../../../lib/graphql/admin/test-helper.js';
 import {type AdminSession, login} from '../../../lib/auth.js';
-import {
-  renderMissingLink,
-  renderMissingStorefront,
-} from '../../../lib/render-errors.js';
-import {linkStorefront} from '../link.js';
+import {renderMissingStorefront} from '../../../lib/render-errors.js';
 import {runEnvList} from './list.js';
+import {verifyLinkedStorefront} from '../../../lib/verify-linked-storefront.js';
 
 const SHOP = 'my-shop';
 
@@ -29,6 +25,7 @@ vi.mock('../../../lib/auth.js');
 vi.mock('../../../lib/shopify-config.js');
 vi.mock('../../../lib/render-errors.js');
 vi.mock('../../../lib/graphql/admin/list-environments.js');
+vi.mock('../../../lib/verify-linked-storefront.js');
 vi.mock('../../../lib/shell.js', () => ({getCliCommand: () => 'h2'}));
 
 describe('listEnvironments', () => {
@@ -53,6 +50,12 @@ describe('listEnvironments', () => {
       config: SHOPIFY_CONFIG,
     });
 
+    vi.mocked(verifyLinkedStorefront).mockResolvedValue({
+      id: SHOPIFY_CONFIG.storefront.id,
+      title: SHOPIFY_CONFIG.storefront.title,
+      productionUrl: 'https://my-shop.myshopify.com',
+    });
+
     vi.mocked(getStorefrontEnvironments).mockResolvedValue(
       dummyListEnvironments(SHOPIFY_CONFIG.storefront.id),
     );
@@ -98,39 +101,16 @@ describe('listEnvironments', () => {
 
   describe('when there is no linked storefront', () => {
     beforeEach(() => {
-      vi.mocked(login).mockResolvedValue({
-        session: ADMIN_SESSION,
-        config: {
-          ...SHOPIFY_CONFIG,
-          storefront: undefined,
-        },
-      });
+      vi.mocked(verifyLinkedStorefront).mockResolvedValue(undefined);
     });
 
-    it('calls renderMissingLink', async () => {
+    it("doesn't list any environments", async () => {
       await inTemporaryDirectory(async (tmpDir) => {
-        await runEnvList({path: tmpDir});
-
-        expect(renderMissingLink).toHaveBeenCalledOnce();
-      });
-    });
-
-    it('prompts the user to create a link', async () => {
-      vi.mocked(renderConfirmationPrompt).mockResolvedValue(true);
+        const output = mockAndCaptureOutput();
 
-      await inTemporaryDirectory(async (tmpDir) => {
         await runEnvList({path: tmpDir});
 
-        expect(renderConfirmationPrompt).toHaveBeenCalledWith({
-          message: expect.arrayContaining([{command: 'h2 link'}]),
-        });
-
-        expect(linkStorefront).toHaveBeenCalledWith(
-          tmpDir,
-          ADMIN_SESSION,
-          {...SHOPIFY_CONFIG, storefront: undefined},
-          expect.anything(),
-        );
+        expect(output.info()).toBe('');
       });
     });
   });

packages/cli/src/commands/hydrogen/env/list.ts

@@ -1,23 +1,18 @@
 import {Flags} from '@oclif/core';
 import Command from '@shopify/cli-kit/node/base-command';
-import {renderConfirmationPrompt} from '@shopify/cli-kit/node/ui';
 import {pluralize} from '@shopify/cli-kit/common/string';
-import colors from '@shopify/cli-kit/node/colors';
 import {
   outputContent,
   outputInfo,
   outputNewline,
 } from '@shopify/cli-kit/node/output';
-import {linkStorefront} from '../link.js';
 import {commonFlags} from '../../../lib/flags.js';
 import {getStorefrontEnvironments} from '../../../lib/graphql/admin/list-environments.js';
 import {createEnvironmentCliChoiceLabel} from '../../../lib/common.js';
-import {
-  renderMissingLink,
-  renderMissingStorefront,
-} from '../../../lib/render-errors.js';
+import {renderMissingStorefront} from '../../../lib/render-errors.js';
 import {login} from '../../../lib/auth.js';
 import {getCliCommand} from '../../../lib/shell.js';
+import {verifyLinkedStorefront} from '../../../lib/verify-linked-storefront.js';
 
 export default class EnvList extends Command {
   static descriptionWithMarkdown =
@@ -46,35 +41,26 @@ export async function runEnvList({path: root = process.cwd()}: Flags) {
     getCliCommand(),
   ]);
 
-  let configStorefront = config.storefront;
-
-  if (!configStorefront?.id) {
-    renderMissingLink({session, cliCommand});
-
-    const runLink = await renderConfirmationPrompt({
-      message: ['Run', {command: `${cliCommand} link`}, '?'],
-    });
-
-    if (!runLink) {
-      return;
-    }
+  const linkedStorefront = await verifyLinkedStorefront({
+    root,
+    session,
+    config,
+    cliCommand,
+  });
 
-    configStorefront = await linkStorefront(root, session, config, {
-      cliCommand,
-    });
-  }
+  if (!linkedStorefront) return;
 
-  if (!configStorefront) return;
+  config.storefront = linkedStorefront;
 
   const storefront = await getStorefrontEnvironments(
     session,
-    configStorefront.id,
+    config.storefront.id,
   );
 
   if (!storefront) {
     renderMissingStorefront({
       session,
-      storefront: configStorefront,
+      storefront: config.storefront,
       cliCommand,
     });
 
@@ -95,7 +81,7 @@ export async function runEnvList({path: root = process.cwd()}: Flags) {
   outputInfo(
     pluralizedEnvironments({
       environments: storefront.environments,
-      storefrontTitle: configStorefront.title,
+      storefrontTitle: config.storefront.title,
     }).toString(),
   );