@shopify/cli-hydrogen 6.0.2 → 6.1.1

package/dist/commands/hydrogen/deploy.js

@@ -1,16 +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 { getLatestGitCommit } 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 { 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") {
@@ -24,6 +16,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 +31,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,
@@ -56,176 +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,
-    path,
-    shop,
-    publicDeployment,
-    metadataUrl,
-    metadataUser,
-    metadataVersion
-  } = options;
-  const ci = ciPlatform();
-  let token = options.token;
-  let branch;
-  let deploymentData;
-  let deploymentEnvironmentTag = void 0;
-  let gitCommit;
-  try {
-    gitCommit = await getLatestGitCommit(path);
-    branch = (/HEAD -> ([^,]*)/.exec(gitCommit.refs) || [])[1];
-  } catch (error) {
-    outputWarn("Could not retrieve Git history.");
-    branch = void 0;
-  }
-  if (!ci.isCI) {
-    deploymentData = await getOxygenDeploymentData({
-      root: path,
-      flagShop: shop
-    });
-    if (!deploymentData) {
-      return;
-    }
-    token = token || deploymentData.oxygenDeploymentToken;
-  }
-  if (!token) {
-    const errMessage = ci.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 (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`
-      );
-    }
-  }
-  const config = {
-    assetsDir: "dist/client",
-    bugsnag: true,
-    deploymentUrl: "https://oxygen.shopifyapps.com",
-    deploymentToken: parseToken(token),
-    environmentTag: environmentTag || deploymentEnvironmentTag || branch,
-    verificationMaxDuration: 180,
-    metadata: {
-      ...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((url) => {
-    const deploymentType = config.publicDeployment ? "public" : "private";
-    renderSuccess({
-      body: ["Successfully deployed to Oxygen"],
+    renderWarning({
+      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+."
       ]
     });
-    resolveDeploy();
-  }).catch((error) => {
-    rejectDeploy(deployError || error);
-  });
-  return deployPromise;
+  }
 }
 
-export { Deploy as default, deploymentLogger, oxygenDeploy };
+export { Deploy as default, deploymentLogger };

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."
     });
   }