@shopify/oxygen-cli 1.12.3-unstable.202309251430.0 → 2.0.0

package/README.md

@@ -42,8 +42,8 @@ oxygen:deploy [options]
 - -o, --workerOnly: Worker only deployment.
 - -s, --skipBuild: Skip running build command.
 - -b, --buildCommand <buildCommand>: Build command (default: `yarn build`).
-- -h, --skipHealthCheck: Skip running the health check on the deployment
-- -d, --healthCheckMaxDuration: The maximum duration (in seconds) that the health check is allowed to run before it is considered failed. Accepts values between 10 and 300.
+- -v, --skipVerification: skip the worker deployment verification step
+- -d, --verificationMaxDuration: The maximum duration (in seconds) that the deployment verification is allowed to run before it is considered failed. Accepts values between 10 and 300.
 - --publicDeployment: set the deployment to be publicly accessible.
 - --metadataDescription <metadataDescription>: A brief description of the deployment, typically the commit message associated with the changes being deployed.
 - --metadataUrl <metadataUrl>: URL that links to the deployment.
@@ -62,6 +62,16 @@ This command will deploy your Oxygen project to the staging environment with the
 
 The `environmentTag` option and the `metadata` options serve as overrides for values that can be retrieved from supported CI environments, see the section on environment variables below.
 
+### Deployment Verification
+
+By default, `oxygen-cli` performs a verification step to ensure the worker deployment process has completed successfully. This step attempts to confirm the successful deployment of your worker. However, please note that this verification step does not dispatch requests to the worker, so it does not validate that the worker is correctly handling requests.
+
+If you wish to skip this verification step, you can use the` --skipVerification` command flag.
+
+The verification step runs for a default duration of 180 seconds. If the verification process does not complete successfully within this time, the deployment is considered unsuccessful. However, you can customize this duration using the --verificationMaxDuration command flag. This flag allows you to specify a maximum duration between 10 and 300 seconds for the verification process. If the verification process does not complete within your specified duration, the deployment will be considered unsuccessful.
+
+In the case of the deployment verification failing, we recommend checking your Shopify Admin to confirm the status of the deployment.
+
 ## Environment variables
 
 The Oxygen deployment token can be specified with the `token` option. Alternatively, you can use the environment variable `OXYGEN_DEPLOYMENT_TOKEN` for this. In CI environments this is recommended. For example, when using CircleCI you can define a custom environment variable in your project settings which holds the token. The `OXYGEN_DEPLOYMENT_TOKEN` can then be populated with this variable's value in your `config.yml` file:

package/dist/commands/oxygen/deploy.d.ts

@@ -8,11 +8,11 @@ declare class Deploy extends Command {
         assetsFolder: _oclif_core_lib_interfaces_parser_js.OptionFlag<string, _oclif_core_lib_interfaces_parser_js.CustomOptions>;
         buildCommand: _oclif_core_lib_interfaces_parser_js.OptionFlag<string, _oclif_core_lib_interfaces_parser_js.CustomOptions>;
         environmentTag: _oclif_core_lib_interfaces_parser_js.OptionFlag<string | undefined, _oclif_core_lib_interfaces_parser_js.CustomOptions>;
-        healthCheckMaxDuration: _oclif_core_lib_interfaces_parser_js.OptionFlag<number, _oclif_core_lib_interfaces_parser_js.CustomOptions>;
+        verificationMaxDuration: _oclif_core_lib_interfaces_parser_js.OptionFlag<number, _oclif_core_lib_interfaces_parser_js.CustomOptions>;
         path: _oclif_core_lib_interfaces_parser_js.OptionFlag<string, _oclif_core_lib_interfaces_parser_js.CustomOptions>;
         publicDeployment: _oclif_core_lib_interfaces_parser_js.BooleanFlag<boolean>;
         skipBuild: _oclif_core_lib_interfaces_parser_js.BooleanFlag<boolean>;
-        skipHealthCheck: _oclif_core_lib_interfaces_parser_js.BooleanFlag<boolean>;
+        skipVerification: _oclif_core_lib_interfaces_parser_js.BooleanFlag<boolean>;
         token: _oclif_core_lib_interfaces_parser_js.OptionFlag<string, _oclif_core_lib_interfaces_parser_js.CustomOptions>;
         workerFolder: _oclif_core_lib_interfaces_parser_js.OptionFlag<string, _oclif_core_lib_interfaces_parser_js.CustomOptions>;
         workerOnly: _oclif_core_lib_interfaces_parser_js.BooleanFlag<boolean>;

package/dist/commands/oxygen/deploy.js

@@ -3,7 +3,7 @@ import { consoleError } from '@shopify/cli-kit/node/output';
 import { normalizePath } from '@shopify/cli-kit/node/path';
 import { createDeploy } from '../../deploy/index.js';
 import { deployDefaults, parseToken, verifyConfig, getBuildCommandFromLockFile } from '../../utils/utils.js';
-import { HealthCheckError } from '../../deploy/types.js';
+import { VerificationError } from '../../deploy/types.js';
 
 class Deploy extends Command {
   static description = "Creates a deployment to Oxygen";
@@ -30,13 +30,13 @@ class Deploy extends Command {
       description: "Tag of the environment to deploy to",
       required: false
     }),
-    healthCheckMaxDuration: Flags.integer({
+    verificationMaxDuration: Flags.integer({
       char: "d",
-      description: "the maximum duration (in seconds) that the health check is allowed to run before it is considered failed.",
+      description: "the maximum duration (in seconds) that the deployment verification step is allowed to run before it is considered failed.",
       min: 10,
       max: 300,
       required: false,
-      default: deployDefaults.healthCheckMaxDurationDefault
+      default: deployDefaults.verificationMaxDurationDefault
     }),
     path: Flags.string({
       char: "p",
@@ -56,9 +56,9 @@ class Deploy extends Command {
       required: false,
       default: false
     }),
-    skipHealthCheck: Flags.boolean({
-      char: "h",
-      description: "Skip running deployment health check",
+    skipVerification: Flags.boolean({
+      char: "v",
+      description: "Skip running deployment verification step",
       required: false,
       default: false
     }),
@@ -115,7 +115,7 @@ class Deploy extends Command {
         deploymentToken: parseToken(flags.token),
         environmentTag: flags.environmentTag,
         deploymentUrl,
-        healthCheckMaxDuration: flags.healthCheckMaxDuration,
+        verificationMaxDuration: flags.verificationMaxDuration,
         metadata: {
           description: flags.metadataDescription,
           url: flags.metadataUrl,
@@ -125,7 +125,7 @@ class Deploy extends Command {
         publicDeployment: flags.publicDeployment,
         rootPath: normalizePath(flags.path),
         skipBuild: flags.skipBuild,
-        skipHealthCheck: flags.skipHealthCheck,
+        skipVerification: flags.skipVerification,
         workerDir: normalizePath(flags.workerFolder),
         workerOnly: flags.workerOnly
       };
@@ -137,7 +137,7 @@ class Deploy extends Command {
     } catch (error) {
       if (!(error instanceof Error)) {
         consoleError(error);
-      } else if (!(error instanceof HealthCheckError)) {
+      } else if (!(error instanceof VerificationError)) {
         consoleError(error.message);
       }
       this.exit(1);

package/dist/deploy/index.js

@@ -6,10 +6,10 @@ import { buildCancel } from './build-cancel.js';
 import { getUploadFiles } from './get-upload-files.js';
 import { deploymentInitiate } from './deployment-initiate.js';
 import { deploymentComplete } from './deployment-complete.js';
-import { healthCheck } from './health-check.js';
+import { verifyDeployment } from './verify-deployment.js';
 import { deploymentCancel } from './deployment-cancel.js';
 import { uploadFiles } from './upload-files.js';
-import { HealthCheckError } from './types.js';
+import { VerificationError } from './types.js';
 import { buildProject } from './build-project.js';
 import { getMetadata, createLabels, getEnvironmentInput } from './metadata.js';
 
@@ -59,8 +59,8 @@ async function createDeploy(options) {
       config,
       deployment.deployment.id
     );
-    if (!config.skipHealthCheck) {
-      await healthCheck({
+    if (!config.skipVerification) {
+      await verifyDeployment({
         config,
         url: deploymentCompleteOp.deployment.url,
         logger,
@@ -82,7 +82,7 @@ ${urlMessage} preview URL: ${deploymentCompleteOp.deployment.url}`,
       console.error("Unknown error", error);
       return Promise.reject(new Error("Unknown error"));
     }
-    if (error instanceof HealthCheckError) {
+    if (error instanceof VerificationError) {
       outputWarn(error.message, logger);
     } else if (build.id && !buildCompleted) {
       outputWarn(

package/dist/deploy/types.d.ts

@@ -7,9 +7,9 @@ interface ClientError extends Error {
 }
 interface DeploymentHooks {
     buildFunction?: (urlPath?: string) => Promise<void>;
-    onHealthCheckStart?: () => void;
-    onHealthCheckComplete?: () => void;
-    onHealthCheckError?: (error: Error) => void;
+    onVerificationStart?: () => void;
+    onVerificationComplete?: () => void;
+    onVerificationError?: (error: Error) => void;
     onUploadFilesStart?: () => void;
     onUploadFilesError?: (error: Error) => void;
     onUploadFilesComplete?: () => void;
@@ -20,7 +20,6 @@ interface DeploymentConfig {
     deploymentToken: DeploymentToken;
     deploymentUrl: string;
     environmentTag?: string;
-    healthCheckMaxDuration: number;
     metadata: {
         description?: string;
         user?: string;
@@ -30,7 +29,8 @@ interface DeploymentConfig {
     publicDeployment: boolean;
     rootPath?: string;
     skipBuild: boolean;
-    skipHealthCheck: boolean;
+    skipVerification: boolean;
+    verificationMaxDuration: number;
     workerDir?: string;
     workerOnly: boolean;
 }
@@ -61,7 +61,7 @@ declare enum FileType {
 interface OxygenError {
     message: string;
 }
-declare class HealthCheckError extends Error {
+declare class VerificationError extends Error {
 }
 
-export { Build, ClientError, DeploymentConfig, DeploymentHooks, DeploymentManifestFile, DeploymentToken, EnvironmentInput, FileType, HealthCheckError, OxygenError };
+export { Build, ClientError, DeploymentConfig, DeploymentHooks, DeploymentManifestFile, DeploymentToken, EnvironmentInput, FileType, OxygenError, VerificationError };

package/dist/deploy/types.js

@@ -3,7 +3,7 @@ var FileType = /* @__PURE__ */ ((FileType2) => {
   FileType2["Asset"] = "ASSET";
   return FileType2;
 })(FileType || {});
-class HealthCheckError extends Error {
+class VerificationError extends Error {
 }
 
-export { FileType, HealthCheckError };
+export { FileType, VerificationError };

package/dist/deploy/{health-check.d.ts → verify-deployment.d.ts}

@@ -1,12 +1,12 @@
 import { Logger } from '@shopify/cli-kit/node/output';
 import { DeploymentConfig, DeploymentHooks } from './types.js';
 
-interface HealthCheckOptions {
+interface VerificationOptions {
     config: DeploymentConfig;
     hooks?: DeploymentHooks;
     logger: Logger;
     url: string;
 }
-declare function healthCheck(options: HealthCheckOptions): Promise<void>;
+declare function verifyDeployment(options: VerificationOptions): Promise<void>;
 
-export { healthCheck };
+export { verifyDeployment };

package/dist/deploy/{health-check.js → verify-deployment.js}

@@ -1,14 +1,14 @@
 import { fetch } from '@shopify/cli-kit/node/http';
 import { outputInfo } from '@shopify/cli-kit/node/output';
-import { HealthCheckError } from './types.js';
+import { VerificationError } from './types.js';
 
-async function healthCheck(options) {
+async function verifyDeployment(options) {
   const { config, url, logger, hooks } = options;
-  hooks?.onHealthCheckStart?.();
-  outputInfo("Performing health check on the deployment...", logger);
+  hooks?.onVerificationStart?.();
+  outputInfo("Verifying worker deployment has been completed...", logger);
   let attempts = 0;
   let delay = 0;
-  let calledHealthCheckError = false;
+  let calledVerificationError = false;
   const startTime = Date.now();
   const handleInterval = async () => {
     if (attempts < 10) {
@@ -17,11 +17,13 @@ async function healthCheck(options) {
       delay += 5e3;
     }
     const elapsedTime = (Date.now() - startTime) / 1e3;
-    if (elapsedTime + delay / 1e3 > config.healthCheckMaxDuration) {
-      const error = new HealthCheckError("Unable to verify deployment health.");
-      if (!calledHealthCheckError) {
-        calledHealthCheckError = true;
-        hooks?.onHealthCheckError?.(error);
+    if (elapsedTime + delay / 1e3 > config.verificationMaxDuration) {
+      const error = new VerificationError(
+        "Unable to verify worker deployment completion."
+      );
+      if (!calledVerificationError) {
+        calledVerificationError = true;
+        hooks?.onVerificationError?.(error);
       }
       throw error;
     }
@@ -33,8 +35,8 @@ async function healthCheck(options) {
     try {
       const response = await fetch(`${url}/.oxygen/deployment`);
       if (response.status === 200) {
-        outputInfo("Deployment health check passed", logger);
-        hooks?.onHealthCheckComplete?.();
+        outputInfo("Deployment verification check passed", logger);
+        hooks?.onVerificationComplete?.();
         return Promise.resolve();
       }
       await handleInterval();
@@ -45,4 +47,4 @@ async function healthCheck(options) {
   await check();
 }
 
-export { healthCheck };
+export { verifyDeployment };

package/dist/utils/test-helper.js

@@ -16,12 +16,12 @@ function createTestConfig(rootFolder) {
     deploymentToken: testToken,
     environmentTag: "environment",
     deploymentUrl: "https://localhost:3000",
-    healthCheckMaxDuration: 300,
+    verificationMaxDuration: 300,
     metadata: {},
     rootPath: rootFolder,
     publicDeployment: false,
     skipBuild: false,
-    skipHealthCheck: false,
+    skipVerification: false,
     workerDir: "/worker/",
     workerOnly: false
   };

package/dist/utils/utils.js

@@ -6,7 +6,7 @@ import { AbortError } from '@shopify/cli-kit/node/error';
 const deployDefaults = {
   assetsDirDefault: "dist/client/",
   buildCommandDefault: "yarn build",
-  healthCheckMaxDurationDefault: 180,
+  verificationDurationDefault: 180,
   maxUploadAttempts: 3,
   maxResumabeUploadAttempts: 9,
   workerDirDefault: "dist/worker/"

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.12.3-unstable.202309251430.0",
+  "version": "2.0.0",
   "commands": {
     "oxygen:deploy": {
       "id": "oxygen:deploy",
@@ -37,14 +37,13 @@
           "required": false,
           "multiple": false
         },
-        "healthCheckMaxDuration": {
-          "name": "healthCheckMaxDuration",
+        "verificationMaxDuration": {
+          "name": "verificationMaxDuration",
           "type": "option",
           "char": "d",
-          "description": "the maximum duration (in seconds) that the health check is allowed to run before it is considered failed.",
+          "description": "the maximum duration (in seconds) that the deployment verification step is allowed to run before it is considered failed.",
           "required": false,
-          "multiple": false,
-          "default": 180
+          "multiple": false
         },
         "path": {
           "name": "path",
@@ -70,11 +69,11 @@
           "required": false,
           "allowNo": false
         },
-        "skipHealthCheck": {
-          "name": "skipHealthCheck",
+        "skipVerification": {
+          "name": "skipVerification",
           "type": "boolean",
-          "char": "h",
-          "description": "Skip running deployment health check",
+          "char": "v",
+          "description": "Skip running deployment verification step",
           "required": false,
           "allowNo": false
         },

package/package.json

@@ -5,7 +5,7 @@
     "@shopify:registry": "https://registry.npmjs.org"
   },
   "license": "MIT",
-  "version": "1.12.3-unstable.202309251430.0",
+  "version": "2.0.0",
   "type": "module",
   "scripts": {
     "build": "tsup --clean --config ./tsup.config.ts && oclif manifest",