@shopify/oxygen-cli 1.0.2

package/dist/deploy/deployment-cancel.test.js

@@ -0,0 +1,78 @@
+import { AbortError } from '@shopify/cli-kit/node/error';
+import { graphqlRequest } from '@shopify/cli-kit/node/api/graphql';
+import { vi, describe, test, expect } from 'vitest';
+import { createTestConfig } from '../utils/test-helper.js';
+import { Header } from '../utils/utils.js';
+import { deploymentCancel } from './deployment-cancel.js';
+
+vi.mock("@shopify/cli-kit/node/api/graphql");
+vi.mock("@shopify/cli-kit/node/output");
+const testConfig = createTestConfig("/tmp/deploymentRoot");
+describe("DeploymentComplete", () => {
+  test("should cancel a deployment", async () => {
+    const response = {
+      deploymentCancel: {
+        deployment: {
+          id: "deployment-1"
+        },
+        userErrors: []
+      }
+    };
+    vi.mocked(graphqlRequest).mockResolvedValueOnce(response);
+    const completeResponse = await deploymentCancel(
+      testConfig,
+      "deployment-1",
+      "some reason"
+    );
+    expect(completeResponse).toEqual(response.deploymentCancel);
+    expect(graphqlRequest).toHaveBeenCalledWith({
+      query: expect.any(String),
+      api: "Oxygen",
+      url: `${testConfig.deploymentUrl}/api/v2/admin/graphql`,
+      token: testConfig.deploymentToken.accessToken,
+      variables: {
+        deploymentId: "deployment-1",
+        reason: "some reason"
+      },
+      addedHeaders: {
+        [Header.OxygenNamespaceHandle]: `${testConfig.deploymentToken.namespace}`
+      }
+    });
+  });
+  test("should throw AbortError when deploymentComplete fails with error", async () => {
+    const response = {
+      deploymentCancel: {
+        userErrors: [
+          {
+            message: "Cannot cancel deployment."
+          }
+        ]
+      }
+    };
+    vi.mocked(graphqlRequest).mockResolvedValueOnce(response);
+    await expect(
+      deploymentCancel(testConfig, "deployment-1", "some reason")
+    ).rejects.toThrow(
+      new AbortError(
+        `Failed to cancel deployment: ${response.deploymentCancel.userErrors[0]?.message}`
+      )
+    );
+  });
+  test("should throw AbortError when unauthorized", async () => {
+    const error = {
+      statusCode: 401
+    };
+    vi.mocked(graphqlRequest).mockRejectedValueOnce(error);
+    try {
+      await expect(
+        deploymentCancel(testConfig, "deployment-1", "some reason")
+      ).rejects.toThrow(
+        new AbortError(
+          "You are not authorized to perform this action. Please check your deployment token."
+        )
+      );
+    } catch (err) {
+      expect(error).toBeInstanceOf(AbortError);
+    }
+  });
+});

package/dist/deploy/deployment-complete.d.ts

@@ -0,0 +1,6 @@
+import { DeploymentCompleteResponse } from './graphql/deployment-complete.js';
+import { DeployConfig } from './types.js';
+
+declare function deploymentComplete(config: DeployConfig, deploymentId: string): Promise<DeploymentCompleteResponse>;
+
+export { deploymentComplete };

package/dist/deploy/deployment-complete.js

@@ -0,0 +1,33 @@
+import { graphqlRequest } from '@shopify/cli-kit/node/api/graphql';
+import { AbortError } from '@shopify/cli-kit/node/error';
+import { Header, errorHandler } from '../utils/utils.js';
+import { DeploymentCompleteQuery } from './graphql/deployment-complete.js';
+
+async function deploymentComplete(config, deploymentId) {
+  const variables = {
+    deploymentId
+  };
+  try {
+    const response = await graphqlRequest({
+      query: DeploymentCompleteQuery,
+      api: "Oxygen",
+      url: `${config.deploymentUrl}/api/v2/admin/graphql`,
+      token: config.deploymentToken.accessToken,
+      variables,
+      addedHeaders: {
+        [Header.OxygenNamespaceHandle]: config.deploymentToken.namespace
+      }
+    });
+    if (response.deploymentComplete.userErrors.length >= 1) {
+      throw new AbortError(
+        `Failed to complete deployment: ${response.deploymentComplete.userErrors[0]?.message}`
+      );
+    }
+    return response.deploymentComplete;
+  } catch (error) {
+    errorHandler(error);
+    throw error;
+  }
+}
+
+export { deploymentComplete };

package/dist/deploy/deployment-complete.test.d.ts

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

package/dist/deploy/deployment-complete.test.js

@@ -0,0 +1,77 @@
+import { AbortError } from '@shopify/cli-kit/node/error';
+import { graphqlRequest } from '@shopify/cli-kit/node/api/graphql';
+import { vi, describe, test, expect } from 'vitest';
+import { createTestConfig } from '../utils/test-helper.js';
+import { Header } from '../utils/utils.js';
+import { deploymentComplete } from './deployment-complete.js';
+
+vi.mock("@shopify/cli-kit/node/api/graphql");
+const testConfig = createTestConfig("/tmp/deploymentRoot");
+describe("DeploymentComplete", () => {
+  test("should complete a deployment", async () => {
+    const response = {
+      deploymentComplete: {
+        deployment: {
+          id: "deployment-1",
+          status: "pending",
+          url: "https://www.go-here.com"
+        },
+        userErrors: []
+      }
+    };
+    vi.mocked(graphqlRequest).mockResolvedValueOnce(response);
+    const completeResponse = await deploymentComplete(
+      testConfig,
+      "deployment-1"
+    );
+    expect(completeResponse).toEqual(response.deploymentComplete);
+    expect(graphqlRequest).toHaveBeenCalledWith({
+      query: expect.any(String),
+      api: "Oxygen",
+      url: `${testConfig.deploymentUrl}/api/v2/admin/graphql`,
+      token: testConfig.deploymentToken.accessToken,
+      variables: {
+        deploymentId: "deployment-1"
+      },
+      addedHeaders: {
+        [Header.OxygenNamespaceHandle]: `${testConfig.deploymentToken.namespace}`
+      }
+    });
+  });
+  test("should throw AbortError when deploymentComplete fails with error", async () => {
+    const response = {
+      deploymentComplete: {
+        userErrors: [
+          {
+            message: "Cannot complete deployment."
+          }
+        ]
+      }
+    };
+    vi.mocked(graphqlRequest).mockResolvedValueOnce(response);
+    await expect(
+      deploymentComplete(testConfig, "deployment-1")
+    ).rejects.toThrow(
+      new AbortError(
+        `Failed to complete deployment: ${response.deploymentComplete.userErrors[0]?.message}`
+      )
+    );
+  });
+  test("should throw AbortError when unauthorized", async () => {
+    const error = {
+      statusCode: 401
+    };
+    vi.mocked(graphqlRequest).mockRejectedValueOnce(error);
+    try {
+      await expect(
+        deploymentComplete(testConfig, "deployment-1")
+      ).rejects.toThrow(
+        new AbortError(
+          "You are not authorized to perform this action. Please check your deployment token."
+        )
+      );
+    } catch (err) {
+      expect(error).toBeInstanceOf(AbortError);
+    }
+  });
+});

package/dist/deploy/deployment-initiate.d.ts

@@ -0,0 +1,17 @@
+import { DeployConfig, DeploymentManifestFile, EnvironmentInput } from './types.js';
+import { DeploymentInitiateResponse } from './graphql/deployment-initiate.js';
+
+type DeploymentInitiateInput = {
+    buildId: string;
+    environment?: never;
+    manifest: DeploymentManifestFile[];
+    labels?: string[];
+} | {
+    environment?: EnvironmentInput;
+    buildId?: never;
+    manifest: DeploymentManifestFile[];
+    labels?: string[];
+};
+declare function deploymentInitiate(config: DeployConfig, input: DeploymentInitiateInput): Promise<DeploymentInitiateResponse>;
+
+export { deploymentInitiate };

package/dist/deploy/deployment-initiate.js

@@ -0,0 +1,40 @@
+import { graphqlRequest } from '@shopify/cli-kit/node/api/graphql';
+import { AbortError } from '@shopify/cli-kit/node/error';
+import { outputCompleted } from '@shopify/cli-kit/node/output';
+import { Header, errorHandler } from '../utils/utils.js';
+import { DeploymentInitiateQuery } from './graphql/deployment-initiate.js';
+
+async function deploymentInitiate(config, input) {
+  const variables = {
+    buildId: input.buildId,
+    environment: input.environment,
+    files: input.manifest,
+    labels: input.labels
+  };
+  try {
+    const response = await graphqlRequest({
+      query: DeploymentInitiateQuery,
+      api: "Oxygen",
+      url: `${config.deploymentUrl}/api/v2/admin/graphql`,
+      token: config.deploymentToken.accessToken,
+      variables,
+      addedHeaders: {
+        [Header.OxygenNamespaceHandle]: config.deploymentToken.namespace
+      }
+    });
+    if (response.deploymentInitiate.userErrors.length >= 1) {
+      throw new AbortError(
+        `Failed to create deployment. ${response.deploymentInitiate.userErrors[0]?.message}`
+      );
+    }
+    outputCompleted(
+      `Deployment initiated, ${response.deploymentInitiate.deploymentTargets.length} files to upload.`
+    );
+    return response.deploymentInitiate;
+  } catch (error) {
+    errorHandler(error);
+    throw error;
+  }
+}
+
+export { deploymentInitiate };

package/dist/deploy/deployment-initiate.test.d.ts

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

package/dist/deploy/deployment-initiate.test.js

@@ -0,0 +1,136 @@
+import { AbortError } from '@shopify/cli-kit/node/error';
+import { graphqlRequest } from '@shopify/cli-kit/node/api/graphql';
+import { outputCompleted } from '@shopify/cli-kit/node/output';
+import { vi, describe, test, expect } from 'vitest';
+import { createTestConfig } from '../utils/test-helper.js';
+import { Header } from '../utils/utils.js';
+import { deploymentInitiate } from './deployment-initiate.js';
+
+vi.mock("@shopify/cli-kit/node/api/graphql");
+vi.mock("@shopify/cli-kit/node/output");
+const testConfig = createTestConfig("/tmp/deploymentRoot");
+const testManifest = [
+  {
+    filePath: "index.js",
+    fileSize: 20,
+    mimeType: "application/javascript",
+    fileType: "WORKER",
+    fileHash: "b62d550d0cae0c4f15e0e16fc2492893"
+  }
+];
+const testResponse = {
+  deploymentInitiate: {
+    deployment: {
+      id: "gid://oxygen-hub/Deployment/1"
+    },
+    deploymentTargets: [
+      {
+        filePath: "index.js",
+        fileSize: 20,
+        uploadUrl: "https://storage.googleapis.com/dms-assets-test/",
+        fileType: "WORKER",
+        parameters: []
+      }
+    ],
+    userErrors: []
+  }
+};
+describe("DeploymentInitiate", () => {
+  test("should initiate a deployment with a buildId", async () => {
+    vi.mocked(graphqlRequest).mockResolvedValueOnce(testResponse);
+    const initiateResponse = await deploymentInitiate(testConfig, {
+      buildId: "build-1",
+      manifest: testManifest
+    });
+    expect(initiateResponse).toEqual(testResponse.deploymentInitiate);
+    expect(graphqlRequest).toHaveBeenCalledWith({
+      query: expect.any(String),
+      api: "Oxygen",
+      url: `${testConfig.deploymentUrl}/api/v2/admin/graphql`,
+      token: testConfig.deploymentToken.accessToken,
+      variables: {
+        buildId: "build-1",
+        environment: void 0,
+        files: testManifest
+      },
+      addedHeaders: {
+        [Header.OxygenNamespaceHandle]: `${testConfig.deploymentToken.namespace}`
+      }
+    });
+    expect(outputCompleted).toHaveBeenCalledWith(
+      `Deployment initiated, ${testManifest.length} files to upload.`
+    );
+  });
+  test("should initiate a deployment with an environmentName", async () => {
+    vi.mocked(graphqlRequest).mockResolvedValueOnce(testResponse);
+    const initiateResponse = await deploymentInitiate(testConfig, {
+      buildId: void 0,
+      environment: { tag: "preview" },
+      manifest: testManifest
+    });
+    expect(initiateResponse).toEqual(testResponse.deploymentInitiate);
+    expect(graphqlRequest).toHaveBeenCalledWith({
+      query: expect.any(String),
+      api: "Oxygen",
+      url: `${testConfig.deploymentUrl}/api/v2/admin/graphql`,
+      token: testConfig.deploymentToken.accessToken,
+      variables: {
+        buildId: void 0,
+        environment: { tag: "preview" },
+        files: testManifest
+      },
+      addedHeaders: {
+        [Header.OxygenNamespaceHandle]: `${testConfig.deploymentToken.namespace}`
+      }
+    });
+    expect(outputCompleted).toHaveBeenCalledWith(
+      `Deployment initiated, ${testManifest.length} files to upload.`
+    );
+  });
+  test("should throw AbortError when deployment initiation fails due to user errors", async () => {
+    const response = {
+      deploymentInitiate: {
+        userErrors: [
+          {
+            message: "Error: cannot proceed with deployment."
+          }
+        ]
+      }
+    };
+    vi.mocked(graphqlRequest).mockResolvedValueOnce(response);
+    const deploymentInitData = {
+      buildId: void 0,
+      environment: { tag: "preview" },
+      manifest: testManifest
+    };
+    await expect(
+      deploymentInitiate(testConfig, deploymentInitData)
+    ).rejects.toThrow(
+      new AbortError(
+        `Failed to create deployment. ${response.deploymentInitiate.userErrors[0]?.message}`
+      )
+    );
+  });
+  test("should throw AbortError when unauthorized", async () => {
+    const error = {
+      statusCode: 401
+    };
+    vi.mocked(graphqlRequest).mockRejectedValueOnce(error);
+    try {
+      const deploymentInitData = {
+        buildId: void 0,
+        environment: { tag: "preview" },
+        manifest: testManifest
+      };
+      await expect(
+        deploymentInitiate(testConfig, deploymentInitData)
+      ).rejects.toThrow(
+        new AbortError(
+          "You are not authorized to perform this action. Please check your deployment token."
+        )
+      );
+    } catch (err) {
+      expect(error).toBeInstanceOf(AbortError);
+    }
+  });
+});

package/dist/deploy/get-upload-files.d.ts

@@ -0,0 +1,5 @@
+import { DeployConfig, DeploymentManifestFile } from './types.js';
+
+declare function getUploadFiles(config: DeployConfig): Promise<DeploymentManifestFile[]>;
+
+export { getUploadFiles };

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

@@ -0,0 +1,65 @@
+import { glob, fileSizeSync, readFileSync } from '@shopify/cli-kit/node/fs';
+import { fileHash } from '@shopify/cli-kit/node/crypto';
+import { joinPath, relativePath } from '@shopify/cli-kit/node/path';
+import { lookupMimeType } from '@shopify/cli-kit/node/mimes';
+import { FileType } from './types.js';
+
+async function getUploadFiles(config) {
+  const workerPath = joinPath(config.rootPath, config.workerDir);
+  const workerFiles = await glob(`${workerPath}/**`);
+  let manifest = createManifestEntries({
+    files: workerFiles,
+    basePath: workerPath,
+    type: FileType.Worker,
+    filter: workerFileFilter
+  });
+  if (!config.workerOnly) {
+    const assetPath = joinPath(config.rootPath, config.assetsDir);
+    const assetFiles = await glob(`${assetPath}/**`);
+    manifest = [
+      ...manifest,
+      ...createManifestEntries({
+        files: assetFiles,
+        basePath: assetPath,
+        type: FileType.Asset
+      })
+    ];
+  }
+  return manifest;
+}
+function createHash(file) {
+  const buff = readFileSync(file);
+  return fileHash(buff);
+}
+function createManifestEntries(params) {
+  const { files, basePath, type, filter } = params;
+  const manifest = [];
+  files.forEach((file) => {
+    const filePath = relativePath(basePath, file);
+    if (filter && !filter(filePath, type)) {
+      return;
+    }
+    manifest.push({
+      filePath,
+      fileSize: fileSizeSync(file),
+      mimeType: lookupMimeType(file),
+      fileType: type,
+      fileHash: createHash(file)
+    });
+  });
+  return manifest;
+}
+function workerFileFilter(fileName, type) {
+  if (type === FileType.Asset) {
+    return true;
+  }
+  const allowedExtensions = [".js.map", ".mjs.map", ".map", ".js", ".mjs"];
+  const allowedFilenames = ["index"];
+  const regexString = `^(${allowedFilenames.join(
+    "|"
+  )})(${allowedExtensions.join("|")})$`;
+  const regex = new RegExp(regexString);
+  return regex.test(fileName);
+}
+
+export { getUploadFiles };

package/dist/deploy/get-upload-files.test.d.ts

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

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

@@ -0,0 +1,56 @@
+import { mkdir, appendFile, rmdir, touchFile } from '@shopify/cli-kit/node/fs';
+import { beforeAll, afterAll, describe, test, expect } from 'vitest';
+import { createTestConfig } from '../utils/test-helper.js';
+import { FileType } from './types.js';
+import { getUploadFiles } from './get-upload-files.js';
+
+const randomString = Math.random().toString(36).substring(7);
+const rootFolder = `/tmp/${randomString}`;
+const testConfig = createTestConfig(rootFolder);
+beforeAll(async () => {
+  await mkdir(rootFolder);
+  await mkdir(`${rootFolder}/worker`);
+  appendFile(`${rootFolder}/worker/index.js`, 'console.log("Hello World")');
+  await mkdir(`${rootFolder}/assets`);
+  appendFile(`${rootFolder}/assets/image.png`, "foo");
+});
+afterAll(async () => {
+  await rmdir(rootFolder, { force: true });
+});
+describe("GetUploadFiles", () => {
+  test("GetUploadFiles creates a manifest of files", async () => {
+    const manifest = await getUploadFiles(testConfig);
+    const expectedManifest = [
+      {
+        filePath: "index.js",
+        fileSize: 26,
+        mimeType: "application/javascript",
+        fileType: FileType.Worker,
+        fileHash: "87a53c8019cbd3358025a289a46b1d25"
+      },
+      {
+        filePath: "image.png",
+        fileSize: 3,
+        mimeType: "image/png",
+        fileType: FileType.Asset,
+        fileHash: "acbd18db4cc2f85cedef654fccc4a4d8"
+      }
+    ];
+    expect(manifest).toEqual(expectedManifest);
+  });
+  test("GetUploadFiles manifest does not included non-worker files", async () => {
+    await touchFile(`${rootFolder}/worker/image.jpg`);
+    await touchFile(`${rootFolder}/worker/worker.ts`);
+    await touchFile(`${rootFolder}/worker/index.js.map`);
+    const manifest = await getUploadFiles(testConfig);
+    const workerFileExist = (fileName) => {
+      return manifest.some(
+        (file) => file.filePath === fileName && file.fileType === FileType.Worker
+      );
+    };
+    expect(workerFileExist("image.jpg")).toBe(false);
+    expect(workerFileExist("worker.ts")).toBe(false);
+    expect(workerFileExist("index.js.map")).toBe(true);
+    expect(workerFileExist("index.js")).toBe(true);
+  });
+});

package/dist/deploy/graphql/build-cancel.d.ts

@@ -0,0 +1,14 @@
+import { OxygenError } from '../types.js';
+
+declare const BuildCancelQuery = "\n  mutation BuildCancel($buildId: ID!, $reason: String!) {\n    buildCancel(id: $buildId, reason: $reason) {\n      build {\n        id\n      }\n      userErrors {\n        message\n      }\n    }\n  }\n";
+interface BuildCancelQueryData {
+    buildCancel: BuildCancelResponse;
+}
+interface BuildCancelResponse {
+    build: {
+        id: string;
+    };
+    userErrors: OxygenError[];
+}
+
+export { BuildCancelQuery, BuildCancelQueryData, BuildCancelResponse };

package/dist/deploy/graphql/build-cancel.js

@@ -0,0 +1,14 @@
+const BuildCancelQuery = `
+  mutation BuildCancel($buildId: ID!, $reason: String!) {
+    buildCancel(id: $buildId, reason: $reason) {
+      build {
+        id
+      }
+      userErrors {
+        message
+      }
+    }
+  }
+`;
+
+export { BuildCancelQuery };

package/dist/deploy/graphql/build-initiate.d.ts

@@ -0,0 +1,15 @@
+import { OxygenError } from '../types.js';
+
+declare const BuildInitiateQuery = "\n  mutation BuildInitiate($environment: EnvironmentSelectorInput, $labels: [String!]) {\n    buildInitiate(environment: $environment, labels: $labels) {\n      build {\n        id\n        assetPath\n      }\n      userErrors {\n        message\n      }\n    }\n  }\n";
+interface BuildInitiateQueryData {
+    buildInitiate: BuildInitiateResponse;
+}
+interface BuildInitiateResponse {
+    build: {
+        id: string;
+        assetPath: string;
+    };
+    userErrors: OxygenError[];
+}
+
+export { BuildInitiateQuery, BuildInitiateQueryData, BuildInitiateResponse };

package/dist/deploy/graphql/build-initiate.js

@@ -0,0 +1,15 @@
+const BuildInitiateQuery = `
+  mutation BuildInitiate($environment: EnvironmentSelectorInput, $labels: [String!]) {
+    buildInitiate(environment: $environment, labels: $labels) {
+      build {
+        id
+        assetPath
+      }
+      userErrors {
+        message
+      }
+    }
+  }
+`;
+
+export { BuildInitiateQuery };

package/dist/deploy/graphql/deployment-cancel.d.ts

@@ -0,0 +1,14 @@
+import { OxygenError } from '../types.js';
+
+declare const DeploymentCancelQuery = "\nmutation DeploymentCancel($deploymentId: ID!, $reason: DeploymentCancellationReason!) {\n  deploymentCancel(id: $deploymentId, reason: $reason) {\n    deployment {\n      id\n    }\n    userErrors {\n      message\n    }\n  }\n}\n";
+interface DeploymentCancelQueryData {
+    deploymentCancel: DeploymentCancelResponse;
+}
+interface DeploymentCancelResponse {
+    deployment: {
+        id: string;
+    };
+    userErrors: OxygenError[];
+}
+
+export { DeploymentCancelQuery, DeploymentCancelQueryData, DeploymentCancelResponse };

package/dist/deploy/graphql/deployment-cancel.js

@@ -0,0 +1,14 @@
+const DeploymentCancelQuery = `
+mutation DeploymentCancel($deploymentId: ID!, $reason: DeploymentCancellationReason!) {
+  deploymentCancel(id: $deploymentId, reason: $reason) {
+    deployment {
+      id
+    }
+    userErrors {
+      message
+    }
+  }
+}
+`;
+
+export { DeploymentCancelQuery };

package/dist/deploy/graphql/deployment-complete.d.ts

@@ -0,0 +1,17 @@
+import { OxygenError } from '../types.js';
+
+declare const DeploymentCompleteQuery = "\n  mutation DeploymentComplete($deploymentId: ID!) {\n    deploymentComplete(id: $deploymentId) {\n      deployment {\n        id\n        status\n        url\n      }\n      userErrors {\n        message\n      }\n    }\n  }\n";
+interface DeploymentCompleteQueryData {
+    deploymentComplete: DeploymentCompleteResponse;
+}
+interface DeploymentCompleteResponse {
+    deployment: Deployment;
+    userErrors: OxygenError[];
+}
+interface Deployment {
+    id: string;
+    status: string;
+    url: string;
+}
+
+export { DeploymentCompleteQuery, DeploymentCompleteQueryData, DeploymentCompleteResponse };

package/dist/deploy/graphql/deployment-complete.js

@@ -0,0 +1,16 @@
+const DeploymentCompleteQuery = `
+  mutation DeploymentComplete($deploymentId: ID!) {
+    deploymentComplete(id: $deploymentId) {
+      deployment {
+        id
+        status
+        url
+      }
+      userErrors {
+        message
+      }
+    }
+  }
+`;
+
+export { DeploymentCompleteQuery };