@shopify/cli-hydrogen 6.1.0 → 6.1.1

package/dist/commands/hydrogen/deploy.js

@@ -1,17 +1,8 @@
 import { Flags } from '@oclif/core';
 import Command from '@shopify/cli-kit/node/base-command';
-import colors from '@shopify/cli-kit/node/colors';
-import { outputWarn, outputInfo, outputContent } from '@shopify/cli-kit/node/output';
-import { AbortError } from '@shopify/cli-kit/node/error';
-import { writeFile } from '@shopify/cli-kit/node/fs';
-import { ensureIsClean, getLatestGitCommit, GitDirectoryNotCleanError } from '@shopify/cli-kit/node/git';
-import { resolvePath } from '@shopify/cli-kit/node/path';
-import { renderFatalError, renderWarning, renderSelectPrompt, renderSuccess, renderTasks } from '@shopify/cli-kit/node/ui';
-import { ciPlatform } from '@shopify/cli-kit/node/context/local';
-import { parseToken, createDeploy } from '@shopify/oxygen-cli/deploy';
-import { commonFlags, flagsToCamelObject } from '../../lib/flags.js';
-import { getOxygenDeploymentData } from '../../lib/get-oxygen-deployment-data.js';
-import { runBuild } from './build.js';
+import { outputWarn } from '@shopify/cli-kit/node/output';
+import { renderWarning } from '@shopify/cli-kit/node/ui';
+import { commonFlags } from '../../lib/flags.js';
 
 const deploymentLogger = (message, level = "info") => {
   if (level === "error" || level === "warn") {
@@ -74,222 +65,13 @@ class Deploy extends Command {
   };
   static hidden = true;
   async run() {
-    const { flags } = await this.parse(Deploy);
-    const deploymentOptions = this.flagsToOxygenDeploymentOptions(flags);
-    await oxygenDeploy(deploymentOptions).catch((error) => {
-      renderFatalError(error);
-      process.exit(1);
-    }).finally(() => {
-      process.exit(0);
-    });
-  }
-  flagsToOxygenDeploymentOptions(flags) {
-    const camelFlags = flagsToCamelObject(flags);
-    return {
-      ...camelFlags,
-      environmentTag: flags["env-branch"],
-      path: flags.path ? resolvePath(flags.path) : process.cwd()
-    };
-  }
-}
-async function oxygenDeploy(options) {
-  const {
-    environmentTag,
-    force: forceOnUncommitedChanges,
-    noJsonOutput,
-    path,
-    shop,
-    publicDeployment,
-    metadataUrl,
-    metadataUser,
-    metadataVersion
-  } = options;
-  let { metadataDescription } = options;
-  let isCleanGit = true;
-  try {
-    await ensureIsClean(path);
-  } catch (error) {
-    if (error instanceof GitDirectoryNotCleanError) {
-      isCleanGit = false;
-    }
-    if (!forceOnUncommitedChanges && !isCleanGit) {
-      throw new AbortError("Uncommitted changes detected.", null, [
-        [
-          "Commit your changes before deploying or use the ",
-          { command: "--force" },
-          " flag to deploy with uncommitted changes."
-        ]
-      ]);
-    }
-  }
-  const isCI = ciPlatform().isCI;
-  let token = options.token;
-  let branch;
-  let commitHash;
-  let deploymentData;
-  let deploymentEnvironmentTag = void 0;
-  let gitCommit;
-  try {
-    gitCommit = await getLatestGitCommit(path);
-    branch = (/HEAD -> ([^,]*)/.exec(gitCommit.refs) || [])[1];
-    commitHash = gitCommit.hash;
-  } catch (error) {
-    outputWarn("Could not retrieve Git history.");
-    branch = void 0;
-  }
-  if (!metadataDescription && !isCleanGit) {
     renderWarning({
-      headline: "No deployment description provided",
-      body: [
-        "Deploying uncommited changes, but no description has been provided. Use the ",
-        { command: "--metadata-description" },
-        "flag to provide a description. If no description is provided, the description defaults to ",
-        { userInput: "<sha> with additional changes" },
-        " using the SHA of the last commit."
-      ]
-    });
-    metadataDescription = `${commitHash} with additional changes`;
-  }
-  if (!isCI) {
-    deploymentData = await getOxygenDeploymentData({
-      root: path,
-      flagShop: shop
-    });
-    if (!deploymentData) {
-      return;
-    }
-    token = token || deploymentData.oxygenDeploymentToken;
-  }
-  if (!token) {
-    const errMessage = isCI ? [
-      "No deployment token provided. Use the ",
-      { command: "--token" },
-      " flag to provide a token."
-    ] : `Could not obtain an Oxygen deployment token, please try again or contact Shopify support.`;
-    throw new AbortError(errMessage);
-  }
-  if (!isCI && !environmentTag && deploymentData?.environments) {
-    if (deploymentData.environments.length > 1) {
-      const choices = [
-        ...deploymentData.environments.map(({ name, branch: branch2 }) => ({
-          label: name,
-          value: branch2
-        }))
-      ];
-      deploymentEnvironmentTag = await renderSelectPrompt({
-        message: "Select an environment to deploy to",
-        choices,
-        defaultValue: branch
-      });
-    } else {
-      outputInfo(
-        `Using current checked out branch ${branch} as environment tag`
-      );
-    }
-  }
-  let deploymentUrl = "https://oxygen.shopifyapps.com";
-  if (process.env.UNSAFE_SHOPIFY_HYDROGEN_DEPLOYMENT_URL) {
-    deploymentUrl = process.env.UNSAFE_SHOPIFY_HYDROGEN_DEPLOYMENT_URL;
-    outputWarn(
-      "Using a custom deployment service. Don't do this in production!"
-    );
-  }
-  const config = {
-    assetsDir: "dist/client",
-    bugsnag: true,
-    deploymentUrl,
-    deploymentToken: parseToken(token),
-    environmentTag: environmentTag || deploymentEnvironmentTag || branch,
-    verificationMaxDuration: 180,
-    metadata: {
-      ...metadataDescription ? { description: metadataDescription } : {},
-      ...metadataUrl ? { url: metadataUrl } : {},
-      ...metadataUser ? { user: metadataUser } : {},
-      ...metadataVersion ? { version: metadataVersion } : {}
-    },
-    publicDeployment,
-    skipVerification: false,
-    rootPath: path,
-    skipBuild: false,
-    workerOnly: false,
-    workerDir: "dist/worker"
-  };
-  let resolveUpload;
-  const uploadPromise = new Promise((resolve) => {
-    resolveUpload = resolve;
-  });
-  let resolveHealthCheck;
-  const healthCheckPromise = new Promise((resolve) => {
-    resolveHealthCheck = resolve;
-  });
-  let deployError = null;
-  let resolveDeploy;
-  let rejectDeploy;
-  const deployPromise = new Promise((resolve, reject) => {
-    resolveDeploy = resolve;
-    rejectDeploy = reject;
-  });
-  const hooks = {
-    buildFunction: async (assetPath) => {
-      outputInfo(
-        outputContent`${colors.whiteBright("Building project...")}`.value
-      );
-      await runBuild({
-        directory: path,
-        assetPath,
-        sourcemap: false,
-        useCodegen: false
-      });
-    },
-    onVerificationComplete: () => resolveHealthCheck(),
-    onUploadFilesStart: () => uploadStart(),
-    onUploadFilesComplete: () => resolveUpload(),
-    onVerificationError: (error) => {
-      deployError = new AbortError(
-        error.message,
-        "Please verify the deployment status in the Shopify Admin and retry deploying if necessary."
-      );
-    },
-    onUploadFilesError: (error) => {
-      deployError = new AbortError(
-        error.message,
-        "Check your connection and try again. If the problem persists, try again later or contact support."
-      );
-    }
-  };
-  const uploadStart = async () => {
-    outputInfo(
-      outputContent`${colors.whiteBright("Deploying to Oxygen..\n")}`.value
-    );
-    await renderTasks([
-      {
-        title: "Uploading files",
-        task: async () => await uploadPromise
-      },
-      {
-        title: "Verifying deployment",
-        task: async () => await healthCheckPromise
-      }
-    ]);
-  };
-  await createDeploy({ config, hooks, logger: deploymentLogger }).then(async (url) => {
-    const deploymentType = config.publicDeployment ? "public" : "private";
-    renderSuccess({
-      body: ["Successfully deployed to Oxygen"],
+      body: "Deploy command unavailable.",
       nextSteps: [
-        [
-          `Open ${url} in your browser to view your ${deploymentType} deployment`
-        ]
+        "To use the deploy command, upgrade cli-hydrogen to v7.0.0+."
       ]
     });
-    if (isCI && !noJsonOutput) {
-      await writeFile("h2_deploy_log.json", JSON.stringify({ url }));
-    }
-    resolveDeploy();
-  }).catch((error) => {
-    rejectDeploy(deployError || error);
-  });
-  return deployPromise;
+  }
 }
 
-export { Deploy as default, deploymentLogger, oxygenDeploy };
+export { Deploy as default, deploymentLogger };

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "6.1.0",
+  "version": "6.1.1",
   "commands": {
     "hydrogen:build": {
       "id": "hydrogen:build",

package/package.json

@@ -4,7 +4,7 @@
     "access": "public",
     "@shopify:registry": "https://registry.npmjs.org"
   },
-  "version": "6.1.0",
+  "version": "6.1.1",
   "license": "MIT",
   "type": "module",
   "scripts": {

package/dist/commands/hydrogen/deploy.test.js

@@ -1,340 +0,0 @@
-import { vi, describe, expect, beforeEach, afterEach, it } from 'vitest';
-import { login } from '../../lib/auth.js';
-import { getStorefronts } from '../../lib/graphql/admin/link-storefront.js';
-import { AbortError } from '@shopify/cli-kit/node/error';
-import { writeFile } from '@shopify/cli-kit/node/fs';
-import { renderSelectPrompt, renderSuccess, renderWarning, renderFatalError } from '@shopify/cli-kit/node/ui';
-import { ensureIsClean, GitDirectoryNotCleanError, getLatestGitCommit } from '@shopify/cli-kit/node/git';
-import { oxygenDeploy, deploymentLogger } from './deploy.js';
-import { getOxygenDeploymentData } from '../../lib/get-oxygen-deployment-data.js';
-import { createDeploy, parseToken } from '@shopify/oxygen-cli/deploy';
-import { ciPlatform } from '@shopify/cli-kit/node/context/local';
-
-vi.mock("../../lib/get-oxygen-deployment-data.js");
-vi.mock("@shopify/oxygen-cli/deploy");
-vi.mock("@shopify/cli-kit/node/fs");
-vi.mock("@shopify/cli-kit/node/context/local");
-vi.mock("../../lib/auth.js");
-vi.mock("../../lib/shopify-config.js");
-vi.mock("../../lib/graphql/admin/link-storefront.js");
-vi.mock("../../lib/graphql/admin/create-storefront.js");
-vi.mock("../../lib/graphql/admin/fetch-job.js");
-vi.mock("../../lib/shell.js", () => ({ getCliCommand: () => "h2" }));
-vi.mock("@shopify/cli-kit/node/output", async () => {
-  return {
-    outputContent: () => ({ value: "" }),
-    outputInfo: () => {
-    },
-    outputWarn: () => {
-    }
-  };
-});
-vi.mock("@shopify/cli-kit/node/ui", async () => {
-  return {
-    renderFatalError: vi.fn(),
-    renderSelectPrompt: vi.fn(),
-    renderSuccess: vi.fn(),
-    renderTasks: vi.fn(),
-    renderWarning: vi.fn()
-  };
-});
-vi.mock("@shopify/cli-kit/node/git", async () => {
-  const actual = await vi.importActual("@shopify/cli-kit/node/git");
-  return {
-    ...actual,
-    getLatestGitCommit: vi.fn(),
-    ensureIsClean: vi.fn()
-  };
-});
-describe("deploy", () => {
-  const ADMIN_SESSION = {
-    token: "abc123",
-    storeFqdn: "my-shop.myshopify.com"
-  };
-  const FULL_SHOPIFY_CONFIG = {
-    shop: "my-shop.myshopify.com",
-    shopName: "My Shop",
-    email: "email",
-    storefront: {
-      id: "gid://shopify/HydrogenStorefront/1",
-      title: "Hydrogen"
-    }
-  };
-  const UNLINKED_SHOPIFY_CONFIG = {
-    ...FULL_SHOPIFY_CONFIG,
-    storefront: void 0
-  };
-  const originalExit = process.exit;
-  const deployParams = {
-    force: false,
-    noJsonOutput: false,
-    path: "./",
-    shop: "snowdevil.myshopify.com",
-    publicDeployment: false,
-    metadataUrl: "https://example.com",
-    metadataUser: "user",
-    metadataVersion: "1.0.0"
-  };
-  const mockToken = {
-    accessToken: "some-token",
-    allowedResource: "some-resource",
-    appId: "1",
-    client: "1",
-    expiresAt: "some-time",
-    namespace: "some-namespace",
-    namespaceId: "1"
-  };
-  const expectedConfig = {
-    assetsDir: "dist/client",
-    bugsnag: true,
-    deploymentUrl: "https://oxygen.shopifyapps.com",
-    deploymentToken: mockToken,
-    verificationMaxDuration: 180,
-    metadata: {
-      url: deployParams.metadataUrl,
-      user: deployParams.metadataUser,
-      version: deployParams.metadataVersion
-    },
-    publicDeployment: deployParams.publicDeployment,
-    skipVerification: false,
-    rootPath: deployParams.path,
-    skipBuild: false,
-    workerOnly: false,
-    workerDir: "dist/worker"
-  };
-  const expectedHooks = {
-    buildFunction: expect.any(Function),
-    onVerificationComplete: expect.any(Function),
-    onUploadFilesStart: expect.any(Function),
-    onUploadFilesComplete: expect.any(Function),
-    onVerificationError: expect.any(Function),
-    onUploadFilesError: expect.any(Function)
-  };
-  beforeEach(async () => {
-    process.exit = vi.fn();
-    vi.mocked(login).mockResolvedValue({
-      session: ADMIN_SESSION,
-      config: UNLINKED_SHOPIFY_CONFIG
-    });
-    vi.mocked(ciPlatform).mockReturnValue({ isCI: false });
-    vi.mocked(getStorefronts).mockResolvedValue([
-      {
-        ...FULL_SHOPIFY_CONFIG.storefront,
-        parsedId: "1",
-        productionUrl: "https://example.com"
-      }
-    ]);
-    vi.mocked(renderSelectPrompt).mockResolvedValue(FULL_SHOPIFY_CONFIG.shop);
-    vi.mocked(createDeploy).mockResolvedValue(
-      "https://a-lovely-deployment.com"
-    );
-    vi.mocked(getOxygenDeploymentData).mockResolvedValue({
-      oxygenDeploymentToken: "some-encoded-token",
-      environments: []
-    });
-    vi.mocked(parseToken).mockReturnValue(mockToken);
-  });
-  afterEach(() => {
-    vi.resetAllMocks();
-    process.exit = originalExit;
-  });
-  it("calls getOxygenDeploymentData with the correct parameters", async () => {
-    await oxygenDeploy(deployParams);
-    expect(getOxygenDeploymentData).toHaveBeenCalledWith({
-      root: "./",
-      flagShop: "snowdevil.myshopify.com"
-    });
-    expect(getOxygenDeploymentData).toHaveBeenCalledTimes(1);
-  });
-  it("calls createDeploy with the correct parameters", async () => {
-    await oxygenDeploy(deployParams);
-    expect(vi.mocked(createDeploy)).toHaveBeenCalledWith({
-      config: expectedConfig,
-      hooks: expectedHooks,
-      logger: deploymentLogger
-    });
-    expect(vi.mocked(renderSuccess)).toHaveBeenCalled;
-  });
-  it("errors when there are uncommited changes", async () => {
-    vi.mocked(ensureIsClean).mockRejectedValue(
-      new GitDirectoryNotCleanError("Uncommitted changes")
-    );
-    await expect(oxygenDeploy(deployParams)).rejects.toThrowError(
-      "Uncommitted changes detected"
-    );
-    expect(vi.mocked(createDeploy)).not.toHaveBeenCalled;
-  });
-  it("proceeds with warning and modified description when there are uncommited changes and the force flag is used", async () => {
-    vi.mocked(ensureIsClean).mockRejectedValue(
-      new GitDirectoryNotCleanError("Uncommitted changes")
-    );
-    vi.mocked(getLatestGitCommit).mockResolvedValue({
-      hash: "123",
-      message: "test commit",
-      date: "2021-01-01",
-      author_name: "test author",
-      author_email: "test@author.com",
-      body: "test body",
-      refs: "HEAD -> main"
-    });
-    await oxygenDeploy({
-      ...deployParams,
-      force: true
-    });
-    expect(vi.mocked(renderWarning)).toHaveBeenCalledWith({
-      headline: "No deployment description provided",
-      body: expect.anything()
-    });
-    expect(vi.mocked(createDeploy)).toHaveBeenCalledWith({
-      config: {
-        ...expectedConfig,
-        environmentTag: "main",
-        metadata: {
-          ...expectedConfig.metadata,
-          description: "123 with additional changes"
-        }
-      },
-      hooks: expectedHooks,
-      logger: deploymentLogger
-    });
-  });
-  it("proceeds with provided description without warning when there are uncommited changes and the force flag is used", async () => {
-    vi.mocked(ensureIsClean).mockRejectedValue(
-      new GitDirectoryNotCleanError("Uncommitted changes")
-    );
-    vi.mocked(getLatestGitCommit).mockResolvedValue({
-      hash: "123",
-      message: "test commit",
-      date: "2021-01-01",
-      author_name: "test author",
-      author_email: "test@author.com",
-      body: "test body",
-      refs: "HEAD -> main"
-    });
-    await oxygenDeploy({
-      ...deployParams,
-      force: true,
-      metadataDescription: "cool new stuff"
-    });
-    expect(vi.mocked(renderWarning)).not.toHaveBeenCalled;
-    expect(vi.mocked(createDeploy)).toHaveBeenCalledWith({
-      config: {
-        ...expectedConfig,
-        environmentTag: "main",
-        metadata: {
-          ...expectedConfig.metadata,
-          description: "cool new stuff"
-        }
-      },
-      hooks: expectedHooks,
-      logger: deploymentLogger
-    });
-  });
-  it("calls createDeploy with the checked out branch name", async () => {
-    vi.mocked(getLatestGitCommit).mockResolvedValue({
-      hash: "123",
-      message: "test commit",
-      date: "2021-01-01",
-      author_name: "test author",
-      author_email: "test@author.com",
-      body: "test body",
-      refs: "HEAD -> main"
-    });
-    await oxygenDeploy(deployParams);
-    expect(vi.mocked(createDeploy)).toHaveBeenCalledWith({
-      config: { ...expectedConfig, environmentTag: "main" },
-      hooks: expectedHooks,
-      logger: deploymentLogger
-    });
-    expect(vi.mocked(renderSuccess)).toHaveBeenCalled;
-  });
-  it("calls renderSelectPrompt when there are multiple environments", async () => {
-    vi.mocked(getOxygenDeploymentData).mockResolvedValue({
-      oxygenDeploymentToken: "some-encoded-token",
-      environments: [
-        { name: "production", branch: "main" },
-        { name: "preview", branch: "staging" }
-      ]
-    });
-    await oxygenDeploy(deployParams);
-    expect(vi.mocked(renderSelectPrompt)).toHaveBeenCalledWith({
-      message: "Select an environment to deploy to",
-      choices: [
-        { label: "production", value: "main" },
-        { label: "preview", value: "staging" }
-      ]
-    });
-  });
-  it("writes a file with JSON content in CI environments", async () => {
-    vi.mocked(ciPlatform).mockReturnValue({
-      isCI: true,
-      name: "github",
-      metadata: {}
-    });
-    const ciDeployParams = {
-      ...deployParams,
-      token: "some-token",
-      metadataDescription: "cool new stuff"
-    };
-    await oxygenDeploy(ciDeployParams);
-    expect(vi.mocked(writeFile)).toHaveBeenCalledWith(
-      "h2_deploy_log.json",
-      JSON.stringify({ url: "https://a-lovely-deployment.com" })
-    );
-    vi.mocked(writeFile).mockClear();
-    ciDeployParams.noJsonOutput = true;
-    await oxygenDeploy(ciDeployParams);
-    expect(vi.mocked(writeFile)).not.toHaveBeenCalled();
-  });
-  it("handles error during uploadFiles", async () => {
-    const mockRenderFatalError = vi.fn();
-    vi.mocked(renderFatalError).mockImplementation(mockRenderFatalError);
-    const error = new Error("Wonky internet!");
-    vi.mocked(createDeploy).mockImplementation((options) => {
-      options.hooks?.onUploadFilesStart?.();
-      options.hooks?.onUploadFilesError?.(error);
-      return new Promise((_resolve, reject) => {
-        reject(error);
-      });
-    });
-    try {
-      await oxygenDeploy(deployParams);
-      expect(true).toBe(false);
-    } catch (err) {
-      if (err instanceof AbortError) {
-        expect(err.message).toBe(error.message);
-        expect(err.tryMessage).toBe(
-          "Check your connection and try again. If the problem persists, try again later or contact support."
-        );
-      } else {
-        expect(true).toBe(false);
-      }
-    }
-  });
-  it("handles error during deployment verification", async () => {
-    const mockRenderFatalError = vi.fn();
-    vi.mocked(renderFatalError).mockImplementation(mockRenderFatalError);
-    const error = new Error("Cloudflare is down!");
-    vi.mocked(createDeploy).mockImplementation((options) => {
-      options.hooks?.onUploadFilesStart?.();
-      options.hooks?.onUploadFilesComplete?.();
-      options.hooks?.onVerificationError?.(error);
-      return new Promise((_resolve, reject) => {
-        reject(error);
-      });
-    });
-    try {
-      await oxygenDeploy(deployParams);
-      expect(true).toBe(false);
-    } catch (err) {
-      if (err instanceof AbortError) {
-        expect(err.message).toBe(error.message);
-        expect(err.tryMessage).toBe(
-          "Please verify the deployment status in the Shopify Admin and retry deploying if necessary."
-        );
-      } else {
-        expect(true).toBe(false);
-      }
-    }
-  });
-});