@shopify/cli-hydrogen 6.0.1 → 6.1.0

package/dist/commands/hydrogen/deploy.js

@@ -3,9 +3,10 @@ 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 { getLatestGitCommit } from '@shopify/cli-kit/node/git';
+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, renderSelectPrompt, renderSuccess, renderTasks } from '@shopify/cli-kit/node/ui';
+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';
@@ -24,6 +25,13 @@ class Deploy extends Command {
       description: "Environment branch (tag) for environment to deploy to",
       required: false
     }),
+    force: Flags.boolean({
+      char: "f",
+      description: "Forces a deployment to proceed if there are uncommited changes in its Git repository.",
+      default: false,
+      env: "SHOPIFY_HYDROGEN_FLAG_FORCE",
+      required: false
+    }),
     path: commonFlags.path,
     shop: commonFlags.shop,
     "public-deployment": Flags.boolean({
@@ -32,12 +40,22 @@ class Deploy extends Command {
       required: false,
       default: false
     }),
+    "no-json-output": Flags.boolean({
+      description: "Prevents the command from creating a JSON file containing the deployment URL (in CI environments).",
+      required: false,
+      default: false
+    }),
     token: Flags.string({
       char: "t",
       description: "Oxygen deployment token",
       env: "SHOPIFY_HYDROGEN_DEPLOYMENT_TOKEN",
       required: false
     }),
+    "metadata-description": Flags.string({
+      description: "Description of the changes in the deployment. Defaults to the commit message of the latest commit if there are no uncommited changes.",
+      required: false,
+      env: "SHOPIFY_HYDROGEN_FLAG_METADATA_DESCRIPTION"
+    }),
     "metadata-url": Flags.string({
       description: "URL that links to the deployment. Will be saved and displayed in the Shopify admin",
       required: false,
@@ -77,6 +95,8 @@ class Deploy extends Command {
 async function oxygenDeploy(options) {
   const {
     environmentTag,
+    force: forceOnUncommitedChanges,
+    noJsonOutput,
     path,
     shop,
     publicDeployment,
@@ -84,20 +104,53 @@ async function oxygenDeploy(options) {
     metadataUser,
     metadataVersion
   } = options;
-  const ci = ciPlatform();
+  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 (!ci.isCI) {
+  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
@@ -108,14 +161,14 @@ async function oxygenDeploy(options) {
     token = token || deploymentData.oxygenDeploymentToken;
   }
   if (!token) {
-    const errMessage = ci.isCI ? [
+    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 (!ci.isCI && !environmentTag && deploymentData?.environments) {
+  if (!isCI && !environmentTag && deploymentData?.environments) {
     if (deploymentData.environments.length > 1) {
       const choices = [
         ...deploymentData.environments.map(({ name, branch: branch2 }) => ({
@@ -134,14 +187,22 @@ async function oxygenDeploy(options) {
       );
     }
   }
+  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: "https://oxygen.shopifyapps.com",
+    deploymentUrl,
     deploymentToken: parseToken(token),
     environmentTag: environmentTag || deploymentEnvironmentTag || branch,
     verificationMaxDuration: 180,
     metadata: {
+      ...metadataDescription ? { description: metadataDescription } : {},
       ...metadataUrl ? { url: metadataUrl } : {},
       ...metadataUser ? { user: metadataUser } : {},
       ...metadataVersion ? { version: metadataVersion } : {}
@@ -211,7 +272,7 @@ async function oxygenDeploy(options) {
       }
     ]);
   };
-  await createDeploy({ config, hooks, logger: deploymentLogger }).then((url) => {
+  await createDeploy({ config, hooks, logger: deploymentLogger }).then(async (url) => {
     const deploymentType = config.publicDeployment ? "public" : "private";
     renderSuccess({
       body: ["Successfully deployed to Oxygen"],
@@ -221,6 +282,9 @@ async function oxygenDeploy(options) {
         ]
       ]
     });
+    if (isCI && !noJsonOutput) {
+      await writeFile("h2_deploy_log.json", JSON.stringify({ url }));
+    }
     resolveDeploy();
   }).catch((error) => {
     rejectDeploy(deployError || error);

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

@@ -2,14 +2,18 @@ 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 { renderSelectPrompt, renderSuccess, renderFatalError } from '@shopify/cli-kit/node/ui';
-import { getLatestGitCommit } from '@shopify/cli-kit/node/git';
+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");
@@ -30,17 +34,16 @@ vi.mock("@shopify/cli-kit/node/ui", async () => {
     renderFatalError: vi.fn(),
     renderSelectPrompt: vi.fn(),
     renderSuccess: vi.fn(),
-    renderTasks: 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 {
-    getLatestGitCommit: vi.fn()
-  };
-});
-vi.mock("@shopify/cli-kit/node/context/local", async () => {
-  return {
-    ciPlatform: () => ({ isCI: false })
+    ...actual,
+    getLatestGitCommit: vi.fn(),
+    ensureIsClean: vi.fn()
   };
 });
 describe("deploy", () => {
@@ -63,6 +66,8 @@ describe("deploy", () => {
   };
   const originalExit = process.exit;
   const deployParams = {
+    force: false,
+    noJsonOutput: false,
     path: "./",
     shop: "snowdevil.myshopify.com",
     publicDeployment: false,
@@ -111,6 +116,7 @@ describe("deploy", () => {
       session: ADMIN_SESSION,
       config: UNLINKED_SHOPIFY_CONFIG
     });
+    vi.mocked(ciPlatform).mockReturnValue({ isCI: false });
     vi.mocked(getStorefronts).mockResolvedValue([
       {
         ...FULL_SHOPIFY_CONFIG.storefront,
@@ -149,6 +155,81 @@ describe("deploy", () => {
     });
     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",
@@ -184,6 +265,27 @@ describe("deploy", () => {
       ]
     });
   });
+  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);

package/dist/commands/hydrogen/dev.js

@@ -7,11 +7,10 @@ import colors from '@shopify/cli-kit/node/colors';
 import { copyPublicFiles } from './build.js';
 import { getProjectPaths, assertOxygenChecks, handleRemixImportFail, getRemixConfig } from '../../lib/remix-config.js';
 import { muteDevLogs, createRemixLogger, enhanceH2Logs } from '../../lib/log.js';
-import { commonFlags, overrideFlag, deprecated, flagsToCamelObject, DEFAULT_PORT } from '../../lib/flags.js';
+import { commonFlags, overrideFlag, deprecated, flagsToCamelObject } from '../../lib/flags.js';
 import Command from '@shopify/cli-kit/node/base-command';
 import { Flags } from '@oclif/core';
-import { startMiniOxygen } from '../../lib/mini-oxygen/index.js';
-import { checkHydrogenVersion } from '../../lib/check-version.js';
+import { buildAssetsUrl, startMiniOxygen } from '../../lib/mini-oxygen/index.js';
 import { addVirtualRoutes } from '../../lib/virtual-routes.js';
 import { spawnCodegenProcess } from '../../lib/codegen.js';
 import { getAllEnvironmentVariables } from '../../lib/environment-variables.js';
@@ -19,6 +18,8 @@ import { getConfig } from '../../lib/shopify-config.js';
 import { setupLiveReload } from '../../lib/live-reload.js';
 import { checkRemixVersions } from '../../lib/remix-version-check.js';
 import { getGraphiQLUrl } from '../../lib/graphiql-url.js';
+import { displayDevUpgradeNotice } from './upgrade.js';
+import { findPort } from '../../lib/find-port.js';
 
 const LOG_REBUILDING = "\u{1F9F1} Rebuilding...";
 const LOG_REBUILT = "\u{1F680} Rebuilt";
@@ -27,7 +28,7 @@ class Dev extends Command {
   static flags = {
     path: commonFlags.path,
     port: commonFlags.port,
-    ["worker-unstable"]: commonFlags.workerRuntime,
+    worker: commonFlags.workerRuntime,
     codegen: overrideFlag(commonFlags.codegen, {
       description: commonFlags.codegen.description + " It updates the types on file save."
     }),
@@ -38,43 +39,42 @@ class Dev extends Command {
       env: "SHOPIFY_HYDROGEN_FLAG_DISABLE_VIRTUAL_ROUTES",
       default: false
     }),
-    debug: Flags.boolean({
-      description: "Attaches a Node inspector",
-      env: "SHOPIFY_HYDROGEN_FLAG_DEBUG",
-      default: false
-    }),
+    debug: commonFlags.debug,
+    "inspector-port": commonFlags.inspectorPort,
     host: deprecated("--host")(),
-    ["env-branch"]: commonFlags.envBranch
+    ["env-branch"]: commonFlags.envBranch,
+    ["disable-version-check"]: Flags.boolean({
+      description: "Skip the version check when running `hydrogen dev`",
+      default: false,
+      required: false
+    })
   };
   async run() {
     const { flags } = await this.parse(Dev);
     const directory = flags.path ? path.resolve(flags.path) : process.cwd();
     await runDev({
       ...flagsToCamelObject(flags),
-      useCodegen: flags.codegen,
-      workerRuntime: flags["worker-unstable"],
       path: directory
     });
   }
 }
 async function runDev({
-  port: portFlag = DEFAULT_PORT,
+  port: appPort,
   path: appPath,
-  useCodegen = false,
-  workerRuntime = false,
+  codegen: useCodegen = false,
+  worker: workerRuntime = false,
   codegenConfigPath,
   disableVirtualRoutes,
   envBranch,
   debug = false,
-  sourcemap = true
+  sourcemap = true,
+  disableVersionCheck = false,
+  inspectorPort
 }) {
   if (!process.env.NODE_ENV)
     process.env.NODE_ENV = "development";
   muteDevLogs();
-  if (debug)
-    (await import('node:inspector')).open();
   const { root, publicPath, buildPathClient, buildPathWorkerFile } = getProjectPaths(appPath);
-  const checkingHydrogenVersion = checkHydrogenVersion(root);
   const copyingFiles = copyPublicFiles(publicPath, buildPathClient);
   const reloadConfig = async () => {
     const config = await getRemixConfig(root);
@@ -90,6 +90,12 @@ async function runDev({
     return [fileRelative, path.resolve(root, fileRelative)];
   };
   const serverBundleExists = () => fileExists(buildPathWorkerFile);
+  inspectorPort = debug ? await findPort(inspectorPort) : inspectorPort;
+  appPort = workerRuntime ? await findPort(appPort) : appPort;
+  const assetsPort = workerRuntime ? await findPort(appPort + 100) : 0;
+  if (assetsPort) {
+    process.env.HYDROGEN_ASSET_BASE_URL = buildAssetsUrl(assetsPort);
+  }
   const [remixConfig, { shop, storefront }] = await Promise.all([
     reloadConfig(),
     getConfig(root)
@@ -112,7 +118,10 @@ async function runDev({
     miniOxygen = await startMiniOxygen(
       {
         root,
-        port: portFlag,
+        debug,
+        assetsPort,
+        inspectorPort,
+        port: appPort,
         watch: !liveReload,
         buildPathWorkerFile,
         buildPathClient,
@@ -142,9 +151,9 @@ View server-side network requests: ${miniOxygen.listeningAt}/debug-network`
       spawnCodegenProcess({ ...remixConfig, configFilePath: codegenConfigPath });
     }
     checkRemixVersions();
-    const showUpgrade = await checkingHydrogenVersion;
-    if (showUpgrade)
-      showUpgrade();
+    if (!disableVersionCheck) {
+      displayDevUpgradeNotice({ targetPath: appPath });
+    }
   }
   const fileWatchCache = createFileWatchCache();
   let skipRebuildLogs = false;
@@ -184,6 +193,7 @@ View server-side network requests: ${miniOxygen.listeningAt}/debug-network`
             name: "BuildError",
             type: 0,
             message: "MiniOxygen cannot start because the server bundle has not been generated.",
+            skipOclifErrorHandling: true,
             tryMessage: "This is likely due to an error in your app and Remix is unable to compile. Try fixing the app and MiniOxygen will start."
           });
         }

package/dist/commands/hydrogen/preview.js

@@ -1,32 +1,36 @@
 import Command from '@shopify/cli-kit/node/base-command';
 import { muteDevLogs } from '../../lib/log.js';
 import { getProjectPaths } from '../../lib/remix-config.js';
-import { commonFlags, flagsToCamelObject, DEFAULT_PORT } from '../../lib/flags.js';
+import { commonFlags, flagsToCamelObject } from '../../lib/flags.js';
 import { startMiniOxygen } from '../../lib/mini-oxygen/index.js';
 import { getAllEnvironmentVariables } from '../../lib/environment-variables.js';
 import { getConfig } from '../../lib/shopify-config.js';
+import { findPort } from '../../lib/find-port.js';
 
 class Preview extends Command {
   static description = "Runs a Hydrogen storefront in an Oxygen worker for production.";
   static flags = {
     path: commonFlags.path,
     port: commonFlags.port,
-    ["worker-unstable"]: commonFlags.workerRuntime,
-    ["env-branch"]: commonFlags.envBranch
+    worker: commonFlags.workerRuntime,
+    "env-branch": commonFlags.envBranch,
+    "inspector-port": commonFlags.inspectorPort,
+    debug: commonFlags.debug
   };
   async run() {
     const { flags } = await this.parse(Preview);
     await runPreview({
-      ...flagsToCamelObject(flags),
-      workerRuntime: flags["worker-unstable"]
+      ...flagsToCamelObject(flags)
     });
   }
 }
 async function runPreview({
-  port = DEFAULT_PORT,
+  port: appPort,
   path: appPath,
-  workerRuntime = false,
-  envBranch
+  worker: workerRuntime = false,
+  envBranch,
+  inspectorPort,
+  debug
 }) {
   if (!process.env.NODE_ENV)
     process.env.NODE_ENV = "production";
@@ -35,13 +39,19 @@ async function runPreview({
   const { shop, storefront } = await getConfig(root);
   const fetchRemote = !!shop && !!storefront?.id;
   const env = await getAllEnvironmentVariables({ root, fetchRemote, envBranch });
+  appPort = workerRuntime ? await findPort(appPort) : appPort;
+  inspectorPort = debug ? await findPort(inspectorPort) : inspectorPort;
+  const assetsPort = workerRuntime ? await findPort(appPort + 100) : 0;
   const miniOxygen = await startMiniOxygen(
     {
       root,
-      port,
+      port: appPort,
+      assetsPort,
+      env,
       buildPathClient,
       buildPathWorkerFile,
-      env
+      inspectorPort,
+      debug
     },
     workerRuntime
   );

package/dist/commands/hydrogen/shortcut.js

@@ -22,6 +22,7 @@ Restart your terminal session and run \`${ALIAS_NAME}\` from your local project.
       name: "error",
       type: 0,
       message: "No supported shell found.",
+      skipOclifErrorHandling: true,
       tryMessage: "Please create a shortcut manually."
     });
   }