@shopify/oxygen-cli 1.6.0 → 1.8.0

package/dist/commands/oxygen/deploy.js

@@ -107,7 +107,6 @@ class Deploy extends Command {
       const config = {
         assetsDir: normalizePath(flags.assetsFolder),
         buildCommand: flags.buildCommand,
-        buildOutput: true,
         deploymentToken: parseToken(flags.token),
         environmentTag: flags.environmentTag,
         deploymentUrl,

package/dist/deploy/build-project.js

@@ -2,12 +2,19 @@ import { spawn } from 'child_process';
 
 async function buildProject(options) {
   const { config, assetPath, hooks } = options;
-  hooks?.onBuildStart?.();
+  if (hooks?.buildFunction) {
+    try {
+      await hooks.buildFunction(assetPath);
+    } catch (error) {
+      throw new Error(`Build function failed with error: ${error}`);
+    }
+    return;
+  }
   const assetPathEnvironment = assetPath ? { HYDROGEN_ASSET_BASE_URL: assetPath } : {};
   try {
     await new Promise((resolve, reject) => {
       const buildCommand = spawn(config.buildCommand, [], {
-        stdio: config.buildOutput ? ["inherit", "pipe", "inherit"] : ["ignore", "ignore", "pipe"],
+        stdio: ["inherit", process.stderr, "inherit"],
         env: {
           // eslint-disable-next-line no-process-env
           ...process.env,
@@ -16,22 +23,11 @@ async function buildProject(options) {
         cwd: config.rootPath,
         shell: true
       });
-      let stderrOutput = "";
-      if (buildCommand.stderr) {
-        buildCommand.stderr.on("data", (data) => {
-          stderrOutput += data;
-        });
-      }
-      if (config.buildOutput && buildCommand.stdout) {
-        buildCommand.stdout.pipe(process.stderr);
-      }
       buildCommand.on("close", (code) => {
         if (code !== 0) {
-          hooks?.onBuildError?.(new Error(stderrOutput));
           reject(code);
           return;
         }
-        hooks?.onBuildComplete?.();
         resolve(code);
       });
     });

package/dist/deploy/build-project.test.js

@@ -30,32 +30,39 @@ test("BuildProject builds the project successfully", async () => {
     buildCommand: "npm run build"
   };
   const assetPath = "https://example.com/assets";
-  const hooks = {
-    onBuildStart: vi.fn(),
-    onBuildComplete: vi.fn()
-  };
-  await buildProject({ config, assetPath, hooks });
+  await buildProject({ config, assetPath });
   expect(spawn).toBeCalledWith("npm run build", [], {
     cwd: "rootFolder",
     shell: true,
-    stdio: ["inherit", "pipe", "inherit"],
+    stdio: ["inherit", process.stderr, "inherit"],
     env: {
       // eslint-disable-next-line no-process-env
       ...process.env,
       HYDROGEN_ASSET_BASE_URL: "https://example.com/assets"
     }
   });
-  expect(hooks.onBuildStart).toBeCalled();
-  expect(hooks.onBuildComplete).toBeCalled();
 });
 test("should throw error on build command failure", async () => {
   returnCode = 1;
-  const hooks = {
-    onBuildError: vi.fn()
-  };
   const assetPath = "https://example.com/assets";
   await expect(
-    () => buildProject({ config: testConfig, assetPath, hooks })
+    () => buildProject({ config: testConfig, assetPath })
   ).rejects.toThrow("Build failed with error code: 1");
-  expect(hooks.onBuildError).toBeCalled();
+});
+test("should call buildFunction hook if provided", async () => {
+  const buildFunction = vi.fn().mockResolvedValue(void 0);
+  const hooks = { buildFunction };
+  const assetPath = "https://example.com/assets";
+  await buildProject({ config: testConfig, assetPath, hooks });
+  expect(buildFunction).toBeCalledWith(assetPath);
+});
+test("should throw error if buildFunction hook fails", async () => {
+  const buildFunction = vi.fn().mockRejectedValue(new Error("Oops! I tripped over a cable."));
+  const hooks = { buildFunction };
+  const assetPath = "https://example.com/assets";
+  await expect(
+    () => buildProject({ config: testConfig, assetPath, hooks })
+  ).rejects.toThrow(
+    "Build function failed with error: Error: Oops! I tripped over a cable."
+  );
 });

package/dist/deploy/index.js

@@ -49,7 +49,12 @@ async function createDeploy(options) {
       input: deploymentInitiateInput,
       logger
     });
-    await uploadFiles({ config, targets: deployment.deploymentTargets, logger });
+    await uploadFiles({
+      config,
+      targets: deployment.deploymentTargets,
+      hooks,
+      logger
+    });
     const deploymentCompleteOp = await deploymentComplete(
       config,
       deployment.deployment.id

package/dist/deploy/types.d.ts

@@ -6,19 +6,17 @@ interface ClientError extends Error {
     statusCode: number;
 }
 interface DeploymentHooks {
-    onBuildStart?: () => void;
-    onBuildComplete?: () => void;
-    onBuildError?: (error: Error) => void;
+    buildFunction?: (urlPath?: string) => Promise<void>;
     onHealthCheckStart?: () => void;
     onHealthCheckComplete?: () => void;
     onHealthCheckError?: (error: Error) => void;
     onUploadFilesStart?: () => void;
+    onUploadFilesError?: (error: Error) => void;
     onUploadFilesComplete?: () => void;
 }
 interface DeploymentConfig {
     assetsDir?: string;
-    buildCommand: string;
-    buildOutput: boolean;
+    buildCommand?: string;
     deploymentToken: DeploymentToken;
     deploymentUrl: string;
     environmentTag?: string;

package/dist/deploy/upload-files.js

@@ -14,6 +14,9 @@ async function uploadFiles(options) {
   }).then(() => {
     hooks?.onUploadFilesComplete?.();
     outputCompleted(`Files uploaded successfully`, logger);
+  }).catch((err) => {
+    hooks?.onUploadFilesError?.(err);
+    throw err;
   });
 }
 async function uploadFile(config, target) {

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

@@ -30,15 +30,17 @@ vi.mock("@shopify/cli-kit/node/fs", () => {
   };
 });
 const testConfig = createTestConfig("/tmp/deploymentRoot");
+let hooks;
 describe("UploadFiles", () => {
   beforeEach(() => {
     vi.mocked(fetch).mockReset();
+    hooks = {
+      onUploadFilesComplete: vi.fn(),
+      onUploadFilesError: vi.fn(),
+      onUploadFilesStart: vi.fn()
+    };
   });
   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 = [
@@ -90,12 +92,15 @@ describe("UploadFiles", () => {
       uploadFiles({
         config: testConfig,
         targets: testWorkerUpload,
-        logger: stderrLogger
+        logger: stderrLogger,
+        hooks
       })
     ).rejects.toThrow("Failed to upload file index.js");
     expect(vi.mocked(fetch)).toHaveBeenCalledTimes(
       Number(deployDefaults.maxUploadAttempts) + 1
     );
+    expect(hooks.onUploadFilesError).toBeCalled();
+    expect(hooks.onUploadFilesComplete).not.toBeCalled();
   });
   it("Performs a resumable upload", async () => {
     const headers = {
@@ -116,7 +121,8 @@ describe("UploadFiles", () => {
     await uploadFiles({
       config: testConfig,
       targets: testWorkerUpload,
-      logger: stderrLogger
+      logger: stderrLogger,
+      hooks
     });
     expect(vi.mocked(fetch)).toHaveBeenCalledTimes(2);
     const secondCall = vi.mocked(fetch).mock.calls[1];
@@ -125,6 +131,8 @@ describe("UploadFiles", () => {
       return req.method === "PUT" && req.body instanceof NamedReadable;
     };
     expect(validateRequestBody(secondCall[1])).toBe(true);
+    expect(hooks.onUploadFilesStart).toBeCalled();
+    expect(hooks.onUploadFilesComplete).toBeCalled();
   });
   it("Resumes a resumable upload", async () => {
     console.error = () => {
@@ -200,7 +208,8 @@ describe("UploadFiles", () => {
       uploadFiles({
         config: testConfig,
         targets: testWorkerUpload,
-        logger: stderrLogger
+        logger: stderrLogger,
+        hooks
       })
     ).rejects.toThrow(
       `Failed to upload file index.js after ${deployDefaults.maxResumabeUploadAttempts} attempts`
@@ -209,5 +218,7 @@ describe("UploadFiles", () => {
       // for each attempt, we make two calls to fetch, plus the initial attempt makes two calls
       Number(deployDefaults.maxResumabeUploadAttempts) * 2 + 2
     );
+    expect(hooks.onUploadFilesError).toBeCalled();
+    expect(hooks.onUploadFilesComplete).not.toBeCalled();
   });
 });

package/dist/utils/test-helper.js

@@ -13,7 +13,6 @@ function createTestConfig(rootFolder) {
   return {
     assetsDir: "/assets/",
     buildCommand: String(deployDefaults.buildCommandDefault),
-    buildOutput: true,
     deploymentToken: testToken,
     environmentTag: "environment",
     deploymentUrl: "https://localhost:3000",

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.6.0",
+  "version": "1.8.0",
   "commands": {
     "oxygen:deploy": {
       "id": "oxygen:deploy",

package/package.json

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