@shopify/oxygen-cli 1.4.0 → 1.6.0

package/dist/deploy/upload-files.test.js

@@ -3,7 +3,7 @@ import { fetch } from '@shopify/cli-kit/node/http';
 import { vi, describe, beforeEach, it, expect } from 'vitest';
 import { Response } from 'node-fetch';
 import { createTestConfig } from '../utils/test-helper.js';
-import { deployDefaults } from '../utils/utils.js';
+import { stderrLogger, deployDefaults } from '../utils/utils.js';
 import { uploadFiles } from './upload-files.js';
 
 class NamedReadable extends Readable {
@@ -29,22 +29,16 @@ vi.mock("@shopify/cli-kit/node/fs", () => {
     })
   };
 });
-vi.mock("fs", () => {
-  return {
-    createReadStream: vi.fn(() => {
-      const readable = new NamedReadable();
-      readable.push("dummy");
-      readable.emit("end");
-      return readable;
-    })
-  };
-});
 const testConfig = createTestConfig("/tmp/deploymentRoot");
 describe("UploadFiles", () => {
   beforeEach(() => {
     vi.mocked(fetch).mockReset();
   });
   it("Performs a form upload", async () => {
+    const hooks = {
+      onUploadFilesStart: vi.fn(),
+      onUploadFilesComplete: vi.fn()
+    };
     const response = new Response();
     vi.mocked(fetch).mockResolvedValueOnce(response);
     const testWorkerUpload = [
@@ -56,7 +50,12 @@ describe("UploadFiles", () => {
         parameters: [{ name: "someName", value: "someValue" }]
       }
     ];
-    await uploadFiles(testConfig, testWorkerUpload);
+    await uploadFiles({
+      config: testConfig,
+      targets: testWorkerUpload,
+      logger: stderrLogger,
+      hooks
+    });
     expect(vi.mocked(fetch)).toHaveBeenCalledTimes(1);
     expect(vi.mocked(fetch)).toHaveBeenCalledWith(
       "https://storage.googleapis.com/the-bucket/",
@@ -73,6 +72,8 @@ describe("UploadFiles", () => {
         })
       })
     );
+    expect(hooks.onUploadFilesStart).toBeCalled();
+    expect(hooks.onUploadFilesComplete).toBeCalled();
   });
   it("Retries a failed form upload until the max upload attempts then throws", async () => {
     vi.mocked(fetch).mockRejectedValue(new Error("some error"));
@@ -85,9 +86,13 @@ describe("UploadFiles", () => {
         parameters: [{ name: "someName", value: "someValue" }]
       }
     ];
-    await expect(uploadFiles(testConfig, testWorkerUpload)).rejects.toThrow(
-      "Failed to upload file index.js"
-    );
+    await expect(
+      uploadFiles({
+        config: testConfig,
+        targets: testWorkerUpload,
+        logger: stderrLogger
+      })
+    ).rejects.toThrow("Failed to upload file index.js");
     expect(vi.mocked(fetch)).toHaveBeenCalledTimes(
       Number(deployDefaults.maxUploadAttempts) + 1
     );
@@ -108,7 +113,11 @@ describe("UploadFiles", () => {
         parameters: null
       }
     ];
-    await uploadFiles(testConfig, testWorkerUpload);
+    await uploadFiles({
+      config: testConfig,
+      targets: testWorkerUpload,
+      logger: stderrLogger
+    });
     expect(vi.mocked(fetch)).toHaveBeenCalledTimes(2);
     const secondCall = vi.mocked(fetch).mock.calls[1];
     expect(secondCall[0]).toBe("https://upload-it-here.com/");
@@ -145,7 +154,11 @@ describe("UploadFiles", () => {
         parameters: null
       }
     ];
-    await uploadFiles(testConfig, testWorkerUpload);
+    await uploadFiles({
+      config: testConfig,
+      targets: testWorkerUpload,
+      logger: stderrLogger
+    });
     expect(vi.mocked(fetch)).toHaveBeenCalledTimes(4);
     const statusCall = vi.mocked(fetch).mock.calls[2];
     expect(statusCall[0]).toBe("https://upload-it-here.com/");
@@ -183,7 +196,13 @@ describe("UploadFiles", () => {
         parameters: null
       }
     ];
-    await expect(uploadFiles(testConfig, testWorkerUpload)).rejects.toThrow(
+    await expect(
+      uploadFiles({
+        config: testConfig,
+        targets: testWorkerUpload,
+        logger: stderrLogger
+      })
+    ).rejects.toThrow(
       `Failed to upload file index.js after ${deployDefaults.maxResumabeUploadAttempts} attempts`
     );
     expect(vi.mocked(fetch)).toHaveBeenCalledTimes(

package/dist/utils/test-helper.d.ts

@@ -1,4 +1,4 @@
-import { DeployConfig } from '../deploy/types.js';
+import { DeploymentConfig } from '../deploy/types.js';
 
 declare const testToken: {
     accessToken: string;
@@ -9,6 +9,6 @@ declare const testToken: {
     namespace: string;
     namespaceId: string;
 };
-declare function createTestConfig(rootFolder: string): DeployConfig;
+declare function createTestConfig(rootFolder: string): DeploymentConfig;
 
 export { createTestConfig, testToken };

package/dist/utils/test-helper.js

@@ -13,13 +13,16 @@ function createTestConfig(rootFolder) {
   return {
     assetsDir: "/assets/",
     buildCommand: String(deployDefaults.buildCommandDefault),
+    buildOutput: true,
     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.d.ts

@@ -1,10 +1,10 @@
-import { DeployConfig, ClientError, DeploymentToken } from '../deploy/types.js';
+import { DeploymentConfig, ClientError, DeploymentToken } from '../deploy/types.js';
 
 declare const deployDefaults: {
     [key: string]: string | number;
 };
 declare function errorHandler(error: any): void;
-declare function getBuildCommandFromLockFile(config: DeployConfig): string;
+declare function getBuildCommandFromLockFile(config: DeploymentConfig): string;
 declare enum Header {
     OxygenNamespaceHandle = "X-Oxygen-Namespace-Handle"
 }
@@ -13,7 +13,7 @@ declare function stderrLogger(log: string): void;
 declare const maxLabelLength = 90;
 declare function parseToken(inputToken: string): DeploymentToken;
 interface VerifyConfigParams {
-    config: DeployConfig;
+    config: DeploymentConfig;
     performedBuild?: boolean;
 }
 declare function verifyConfig({ config, performedBuild, }: VerifyConfigParams): Promise<void>;

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/"
@@ -72,11 +73,6 @@ function stderrLogger(log) {
 }
 const maxLabelLength = 90;
 function parseToken(inputToken) {
-  if (!inputToken) {
-    throw new Error(
-      "No deployment token provided. Use the --token flag to set a deployment token."
-    );
-  }
   try {
     const decodedToken = Buffer.from(inputToken, "base64").toString("utf-8");
     const rawToken = JSON.parse(decodedToken);

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.4.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",
+          "char": "a",
+          "description": "Assets folder",
           "required": false,
-          "multiple": 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.4.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.7",
-    "@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": "^6.7.0",
+    "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": {