@shopify/oxygen-cli 1.5.0 → 1.6.0

package/README.md

@@ -42,6 +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.
 - --publicDeployment: set the deployment to be publicly accessible.
 - --metadataUrl <metadataUrl>: URL that links to the deployment.
 - --metadataUser <metadataUser>: User that initiated the deployment.

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

@@ -1,20 +1,21 @@
 import * as _oclif_core_lib_interfaces_parser_js from '@oclif/core/lib/interfaces/parser.js';
 import { Command } from '@oclif/core';
-import { DeploymentConfig } from '../../deploy/types.js';
 
 declare class Deploy extends Command {
     static description: string;
     static hidden: boolean;
     static flags: {
-        token: _oclif_core_lib_interfaces_parser_js.OptionFlag<string, _oclif_core_lib_interfaces_parser_js.CustomOptions>;
-        path: _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>;
-        workerFolder: _oclif_core_lib_interfaces_parser_js.OptionFlag<string, _oclif_core_lib_interfaces_parser_js.CustomOptions>;
         assetsFolder: _oclif_core_lib_interfaces_parser_js.OptionFlag<string, _oclif_core_lib_interfaces_parser_js.CustomOptions>;
-        workerOnly: _oclif_core_lib_interfaces_parser_js.BooleanFlag<boolean>;
-        skipBuild: _oclif_core_lib_interfaces_parser_js.BooleanFlag<boolean>;
         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>;
+        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>;
+        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>;
         metadataUrl: _oclif_core_lib_interfaces_parser_js.OptionFlag<string | undefined, _oclif_core_lib_interfaces_parser_js.CustomOptions>;
         metadataUser: _oclif_core_lib_interfaces_parser_js.OptionFlag<string | undefined, _oclif_core_lib_interfaces_parser_js.CustomOptions>;
         metadataVersion: _oclif_core_lib_interfaces_parser_js.OptionFlag<string | undefined, _oclif_core_lib_interfaces_parser_js.CustomOptions>;
@@ -22,6 +23,5 @@ declare class Deploy extends Command {
     static hasCustomBuildCommand: boolean;
     run(): Promise<void>;
 }
-declare function runInit(config: DeploymentConfig): void;
 
-export { Deploy, runInit };
+export { Deploy };

package/dist/commands/oxygen/deploy.js

@@ -3,52 +3,18 @@ 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';
 
 class Deploy extends Command {
   static description = "Creates a deployment to Oxygen";
   static hidden = false;
   static flags = {
-    token: Flags.string({
-      char: "t",
-      description: "Oxygen deployment token",
-      env: "OXYGEN_DEPLOYMENT_TOKEN",
-      required: true
-    }),
-    path: Flags.string({
-      char: "p",
-      description: "Root path",
-      default: "./",
-      required: false
-    }),
-    environmentTag: Flags.string({
-      char: "e",
-      description: "Tag of the environment to deploy to",
-      required: false
-    }),
-    workerFolder: Flags.string({
-      char: "w",
-      description: "Worker folder",
-      default: String(deployDefaults.workerDirDefault),
-      required: false
-    }),
     assetsFolder: Flags.string({
       char: "a",
       description: "Assets folder",
       default: String(deployDefaults.assetsDirDefault),
       required: false
     }),
-    workerOnly: Flags.boolean({
-      char: "o",
-      description: "Worker only deployment",
-      default: false,
-      required: false
-    }),
-    skipBuild: Flags.boolean({
-      char: "s",
-      description: "Skip running build command",
-      required: false,
-      default: false
-    }),
     buildCommand: Flags.string({
       char: "b",
       description: "Build command",
@@ -59,12 +25,61 @@ class Deploy extends Command {
         return Promise.resolve(input);
       }
     }),
+    environmentTag: Flags.string({
+      char: "e",
+      description: "Tag of the environment to deploy to",
+      required: false
+    }),
+    healthCheckMaxDuration: Flags.integer({
+      char: "d",
+      description: "the maximum duration (in seconds) that the health check is allowed to run before it is considered failed.",
+      min: 10,
+      max: 300,
+      required: false,
+      default: deployDefaults.healthCheckMaxDurationDefault
+    }),
+    path: Flags.string({
+      char: "p",
+      description: "Root path",
+      default: "./",
+      required: false
+    }),
     publicDeployment: Flags.boolean({
       env: "OXYGEN_PUBLIC_DEPLOYMENT",
       description: "Marks a preview deployment as publicly accessible.",
       required: false,
       default: false
     }),
+    skipBuild: Flags.boolean({
+      char: "s",
+      description: "Skip running build command",
+      required: false,
+      default: false
+    }),
+    skipHealthCheck: Flags.boolean({
+      char: "h",
+      description: "Skip running deployment health check",
+      required: false,
+      default: false
+    }),
+    token: Flags.string({
+      char: "t",
+      description: "Oxygen deployment token",
+      env: "OXYGEN_DEPLOYMENT_TOKEN",
+      required: true
+    }),
+    workerFolder: Flags.string({
+      char: "w",
+      description: "Worker folder",
+      default: String(deployDefaults.workerDirDefault),
+      required: false
+    }),
+    workerOnly: Flags.boolean({
+      char: "o",
+      description: "Worker only deployment",
+      default: false,
+      required: false
+    }),
     metadataUrl: Flags.string({
       description: "URL that links to the deployment. Will be saved and displayed in the Shopify admin",
       required: false,
@@ -96,6 +111,7 @@ class Deploy extends Command {
         deploymentToken: parseToken(flags.token),
         environmentTag: flags.environmentTag,
         deploymentUrl,
+        healthCheckMaxDuration: flags.healthCheckMaxDuration,
         metadata: {
           url: flags.metadataUrl,
           user: flags.metadataUser,
@@ -104,6 +120,7 @@ class Deploy extends Command {
         publicDeployment: flags.publicDeployment,
         rootPath: normalizePath(flags.path),
         skipBuild: flags.skipBuild,
+        skipHealthCheck: flags.skipHealthCheck,
         workerDir: normalizePath(flags.workerFolder),
         workerOnly: flags.workerOnly
       };
@@ -111,19 +128,16 @@ class Deploy extends Command {
       if (!Deploy.hasCustomBuildCommand && !config.skipBuild) {
         config.buildCommand = getBuildCommandFromLockFile(config);
       }
-      runInit(config);
+      await createDeploy({ config });
     } catch (error) {
-      if (error instanceof Error) {
+      if (!(error instanceof Error)) {
+        consoleError(error);
+      } else if (!(error instanceof HealthCheckError)) {
         consoleError(error.message);
-      } else {
-        console.error(error);
       }
       this.exit(1);
     }
   }
 }
-function runInit(config) {
-  createDeploy({ config });
-}
 
-export { Deploy, runInit };
+export { Deploy };

package/dist/deploy/health-check.d.ts

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

package/dist/deploy/health-check.js

@@ -0,0 +1,44 @@
+import { fetch } from '@shopify/cli-kit/node/http';
+import { outputInfo } from '@shopify/cli-kit/node/output';
+import { HealthCheckError } from './types.js';
+
+async function healthCheck(options) {
+  const { config, url, logger, hooks } = options;
+  hooks?.onHealthCheckStart?.();
+  outputInfo("Performing health check on the deployment...", logger);
+  let attempts = 0;
+  let delay = 0;
+  const startTime = Date.now();
+  const handleInterval = async () => {
+    if (attempts < 10) {
+      delay = 500;
+    } else if (attempts % 5 === 0) {
+      delay += 5e3;
+    }
+    const elapsedTime = (Date.now() - startTime) / 1e3;
+    if (elapsedTime + delay / 1e3 > config.healthCheckMaxDuration) {
+      const error = new HealthCheckError("Unable to verify deployment health.");
+      hooks?.onHealthCheckError?.(error);
+      throw error;
+    }
+    attempts++;
+    await new Promise((resolve) => setTimeout(resolve, delay));
+    await check();
+  };
+  const check = async () => {
+    try {
+      const response = await fetch(`${url}/.oxygen/deployment`);
+      if (response.status === 200) {
+        outputInfo("Deployment health check passed", logger);
+        hooks?.onHealthCheckComplete?.();
+        return Promise.resolve();
+      }
+      await handleInterval();
+    } catch {
+      await handleInterval();
+    }
+  };
+  await check();
+}
+
+export { healthCheck };

package/dist/deploy/health-check.test.d.ts

@@ -0,0 +1,2 @@
+
+export { }

package/dist/deploy/health-check.test.js

@@ -0,0 +1,92 @@
+import { vi, describe, beforeEach, it, expect } from 'vitest';
+import { fetch } from '@shopify/cli-kit/node/http';
+import { Response } from 'node-fetch';
+import { stderrLogger } from '../utils/utils.js';
+import { createTestConfig } from '../utils/test-helper.js';
+import { HealthCheckError } from './types.js';
+import { healthCheck } from './health-check.js';
+
+vi.mock("@shopify/cli-kit/node/http", async () => {
+  const actual = await vi.importActual("@shopify/cli-kit/node/http");
+  return {
+    ...actual,
+    fetch: vi.fn()
+  };
+});
+vi.mock("@shopify/cli-kit/node/output");
+const testConfig = createTestConfig("rootFolder");
+describe("healthCheck", () => {
+  let setTimeoutSpy;
+  const hooks = {
+    onHealthCheckError: vi.fn(),
+    onHealthCheckStart: vi.fn(),
+    onHealthCheckComplete: vi.fn()
+  };
+  const url = "http://example.com";
+  beforeEach(() => {
+    vi.mocked(fetch).mockReset();
+    setTimeoutSpy = vi.spyOn(global, "setTimeout").mockImplementation((cb, _delay) => {
+      cb();
+      return {};
+    });
+  });
+  it("resolves when URL is accessible", async () => {
+    const response = new Response();
+    vi.mocked(fetch).mockResolvedValueOnce(response);
+    await healthCheck({ config: testConfig, url, logger: stderrLogger, hooks });
+    expect(fetch).toHaveBeenCalledTimes(1);
+    expect(fetch).toHaveBeenCalledWith(`${url}/.oxygen/deployment`);
+    expect(hooks.onHealthCheckStart).toBeCalled();
+    expect(hooks.onHealthCheckComplete).toBeCalled();
+  });
+  it("repeats request until URL is accessible with progressive timeout", async () => {
+    const responseFail = new Response(null, { status: 404 });
+    const responseSuccess = new Response(null, { status: 200 });
+    let attempts = 0;
+    vi.mocked(fetch).mockImplementation(() => {
+      if (attempts === 30) {
+        return Promise.resolve(responseSuccess);
+      }
+      attempts++;
+      return Promise.resolve(responseFail);
+    });
+    await new Promise((resolve, reject) => {
+      healthCheck({ config: testConfig, url, logger: stderrLogger, hooks }).then(() => {
+        expect(fetch).toHaveBeenCalledTimes(attempts + 1);
+        expect(fetch).toHaveBeenCalledWith(`${url}/.oxygen/deployment`);
+        expect(setTimeoutSpy).toHaveBeenCalledTimes(attempts);
+        expect(hooks.onHealthCheckStart).toBeCalled();
+        expect(hooks.onHealthCheckComplete).toBeCalled();
+        let expectedDuration = 500;
+        setTimeoutSpy.mock.calls.forEach(
+          (call, index) => {
+            if (index >= 10 && index % 5 === 0) {
+              expectedDuration += 5e3;
+            }
+            expect(call[1]).toBe(expectedDuration);
+          }
+        );
+        resolve();
+      }).catch((error) => {
+        reject(error);
+      });
+    });
+  });
+  it("throws an error after max duration", async () => {
+    vi.useFakeTimers();
+    const responseFail = new Response(null, { status: 404 });
+    vi.mocked(fetch).mockResolvedValue(responseFail);
+    const healthCheckPromise = healthCheck({
+      config: testConfig,
+      url,
+      logger: stderrLogger,
+      hooks
+    });
+    vi.setSystemTime(Date.now() + testConfig.healthCheckMaxDuration * 1e3);
+    await expect(healthCheckPromise).rejects.toThrow(HealthCheckError);
+    expect(fetch).toHaveBeenCalledOnce();
+    expect(hooks.onHealthCheckStart).toBeCalled();
+    expect(hooks.onHealthCheckError).toBeCalled();
+    vi.useRealTimers();
+  });
+});

package/dist/deploy/index.js

@@ -1,4 +1,4 @@
-import { outputSuccess, outputInfo, outputWarn, consoleError } from '@shopify/cli-kit/node/output';
+import { outputSuccess, outputInfo, outputWarn } from '@shopify/cli-kit/node/output';
 import { stderrLogger, verifyConfig } from '../utils/utils.js';
 export { parseToken } from '../utils/utils.js';
 import { buildInitiate } from './build-initiate.js';
@@ -6,8 +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 { deploymentCancel, DeploymentCancelReason } from './deployment-cancel.js';
 import { uploadFiles } from './upload-files.js';
+import { HealthCheckError } from './types.js';
 import { buildProject } from './build-project.js';
 import { getMetadata, createLabels, getEnvironmentInput } from './metadata.js';
 
@@ -52,6 +54,14 @@ async function createDeploy(options) {
       config,
       deployment.deployment.id
     );
+    if (!config.skipHealthCheck) {
+      await healthCheck({
+        config,
+        url: deploymentCompleteOp.deployment.url,
+        logger,
+        hooks
+      });
+    }
     const urlMessage = config.publicDeployment ? "Public" : "Private";
     outputSuccess(
       `Deployment complete.
@@ -67,7 +77,9 @@ ${urlMessage} preview URL: ${deploymentCompleteOp.deployment.url}`,
       console.error("Unknown error", error);
       return Promise.reject(new Error("Unknown error"));
     }
-    if (build.id && !buildCompleted) {
+    if (error instanceof HealthCheckError) {
+      outputWarn(error.message, logger);
+    } else if (build.id && !buildCompleted) {
       outputWarn(
         `Build failed with: ${error.message}, cancelling build.`,
         logger
@@ -98,7 +110,6 @@ ${urlMessage} preview URL: ${deploymentCompleteOp.deployment.url}`,
         }
       });
     }
-    consoleError(error.message);
     return Promise.reject(error);
   }
 }

package/dist/deploy/types.d.ts

@@ -9,6 +9,9 @@ interface DeploymentHooks {
     onBuildStart?: () => void;
     onBuildComplete?: () => void;
     onBuildError?: (error: Error) => void;
+    onHealthCheckStart?: () => void;
+    onHealthCheckComplete?: () => void;
+    onHealthCheckError?: (error: Error) => void;
     onUploadFilesStart?: () => void;
     onUploadFilesComplete?: () => void;
 }
@@ -19,6 +22,7 @@ interface DeploymentConfig {
     deploymentToken: DeploymentToken;
     deploymentUrl: string;
     environmentTag?: string;
+    healthCheckMaxDuration: number;
     metadata: {
         user?: string;
         version?: string;
@@ -27,6 +31,7 @@ interface DeploymentConfig {
     publicDeployment: boolean;
     rootPath?: string;
     skipBuild: boolean;
+    skipHealthCheck: boolean;
     workerDir?: string;
     workerOnly: boolean;
 }
@@ -57,5 +62,7 @@ declare enum FileType {
 interface OxygenError {
     message: string;
 }
+declare class HealthCheckError extends Error {
+}
 
-export { Build, ClientError, DeploymentConfig, DeploymentHooks, DeploymentManifestFile, DeploymentToken, EnvironmentInput, FileType, OxygenError };
+export { Build, ClientError, DeploymentConfig, DeploymentHooks, DeploymentManifestFile, DeploymentToken, EnvironmentInput, FileType, HealthCheckError, OxygenError };

package/dist/deploy/types.js

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

package/dist/utils/test-helper.js

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

package/dist/utils/utils.js

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

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.5.0",
+  "version": "1.6.0",
   "commands": {
     "oxygen:deploy": {
       "id": "oxygen:deploy",
@@ -11,22 +11,23 @@
       "hidden": false,
       "aliases": [],
       "flags": {
-        "token": {
-          "name": "token",
+        "assetsFolder": {
+          "name": "assetsFolder",
           "type": "option",
-          "char": "t",
-          "description": "Oxygen deployment token",
-          "required": true,
-          "multiple": false
+          "char": "a",
+          "description": "Assets folder",
+          "required": false,
+          "multiple": false,
+          "default": "dist/client/"
         },
-        "path": {
-          "name": "path",
+        "buildCommand": {
+          "name": "buildCommand",
           "type": "option",
-          "char": "p",
-          "description": "Root path",
+          "char": "b",
+          "description": "Build command",
           "required": false,
           "multiple": false,
-          "default": "./"
+          "default": "yarn build"
         },
         "environmentTag": {
           "name": "environmentTag",
@@ -36,29 +37,28 @@
           "required": false,
           "multiple": false
         },
-        "workerFolder": {
-          "name": "workerFolder",
+        "healthCheckMaxDuration": {
+          "name": "healthCheckMaxDuration",
           "type": "option",
-          "char": "w",
-          "description": "Worker folder",
+          "char": "d",
+          "description": "the maximum duration (in seconds) that the health check is allowed to run before it is considered failed.",
           "required": false,
           "multiple": false,
-          "default": "dist/worker/"
+          "default": 180
         },
-        "assetsFolder": {
-          "name": "assetsFolder",
+        "path": {
+          "name": "path",
           "type": "option",
-          "char": "a",
-          "description": "Assets folder",
+          "char": "p",
+          "description": "Root path",
           "required": false,
           "multiple": false,
-          "default": "dist/client/"
+          "default": "./"
         },
-        "workerOnly": {
-          "name": "workerOnly",
+        "publicDeployment": {
+          "name": "publicDeployment",
           "type": "boolean",
-          "char": "o",
-          "description": "Worker only deployment",
+          "description": "Marks a preview deployment as publicly accessible.",
           "required": false,
           "allowNo": false
         },
@@ -70,19 +70,36 @@
           "required": false,
           "allowNo": false
         },
-        "buildCommand": {
-          "name": "buildCommand",
+        "skipHealthCheck": {
+          "name": "skipHealthCheck",
+          "type": "boolean",
+          "char": "h",
+          "description": "Skip running deployment health check",
+          "required": false,
+          "allowNo": false
+        },
+        "token": {
+          "name": "token",
           "type": "option",
-          "char": "b",
-          "description": "Build command",
+          "char": "t",
+          "description": "Oxygen deployment token",
+          "required": true,
+          "multiple": false
+        },
+        "workerFolder": {
+          "name": "workerFolder",
+          "type": "option",
+          "char": "w",
+          "description": "Worker folder",
           "required": false,
           "multiple": false,
-          "default": "yarn build"
+          "default": "dist/worker/"
         },
-        "publicDeployment": {
-          "name": "publicDeployment",
+        "workerOnly": {
+          "name": "workerOnly",
           "type": "boolean",
-          "description": "Marks a preview deployment as publicly accessible.",
+          "char": "o",
+          "description": "Worker only deployment",
           "required": false,
           "allowNo": false
         },

package/package.json

@@ -5,7 +5,7 @@
     "@shopify:registry": "https://registry.npmjs.org"
   },
   "license": "MIT",
-  "version": "1.5.0",
+  "version": "1.6.0",
   "type": "module",
   "scripts": {
     "build": "tsup --clean --config ./tsup.config.ts && oclif manifest",
@@ -31,8 +31,8 @@
     "/oclif.manifest.json"
   ],
   "dependencies": {
-    "@oclif/core": "2.8.11",
-    "@shopify/cli-kit": "^3.46.5",
+    "@oclif/core": "2.9.4",
+    "@shopify/cli-kit": "^3.47.5",
     "async": "^3.2.4"
   },
   "devDependencies": {
@@ -40,15 +40,15 @@
     "@shopify/eslint-plugin": "^42.1.0",
     "@shopify/prettier-config": "^1.1.2",
     "@types/async": "^3.2.18",
-    "@types/node": "^20.3.1",
+    "@types/node": "^20.4.2",
     "@types/prettier": "^2.7.3",
-    "eslint": "^8.43.0",
+    "eslint": "^8.45.0",
     "node-fetch": "^3.3.1",
     "oclif": "^3",
     "tsup": "^7.1.0",
     "typescript": "^5.1.3",
-    "vite": "^4.3.9",
-    "vitest": "^0.32.2"
+    "vite": "^4.4.4",
+    "vitest": "^0.33.0"
   },
   "prettier": "@shopify/prettier-config",
   "oclif": {