@shopify/oxygen-cli 1.12.2-unstable.202309141504.0 → 1.12.2-unstable.202309150831.0

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

@@ -1,67 +0,0 @@
-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 include 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);
-  });
-  test("GetUploadFiles manifest does not include source map files in assets", async () => {
-    const testFilename = "index.js.MaP";
-    await touchFile(`${rootFolder}/assets/${testFilename}`);
-    const manifest = await getUploadFiles(testConfig);
-    const assetSourcemapFileExist = (fileName) => {
-      return manifest.some(
-        (file) => file.filePath === fileName && file.fileType === FileType.Asset
-      );
-    };
-    expect(assetSourcemapFileExist(testFilename)).toBe(false);
-  });
-});

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

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

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

@@ -1,92 +0,0 @@
-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/metadata.test.d.ts

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

package/dist/deploy/metadata.test.js

@@ -1,170 +0,0 @@
-import { getLatestGitCommit } from '@shopify/cli-kit/node/git';
-import { ciPlatform } from '@shopify/cli-kit/node/context/local';
-import { vi, describe, test, expect } from 'vitest';
-import { stderrLogger, maxLabelLength } from '../utils/utils.js';
-import { createTestConfig } from '../utils/test-helper.js';
-import { getMetadata, getEnvironmentInput, createLabels } from './metadata.js';
-
-vi.mock("@shopify/cli-kit/node/context/local");
-vi.mock("@shopify/cli-kit/node/git");
-vi.mock("@shopify/cli-kit/node/output");
-describe("getMetadata", () => {
-  test("should return custom metadata from environment", async () => {
-    vi.mocked(ciPlatform).mockReturnValueOnce({
-      isCI: true,
-      name: "circle",
-      metadata: {
-        actor: "circle_actor",
-        commitSha: "circle_sha",
-        url: "circle_url"
-      }
-    });
-    const testConfig = createTestConfig("/tmp/deploymentRoot/");
-    const metadataResult = await getMetadata(testConfig, stderrLogger);
-    expect(metadataResult.actor).toBe("circle_actor");
-    expect(metadataResult.commitSha).toBe("circle_sha");
-    expect(metadataResult.name).toBe("circle");
-    expect(metadataResult.url).toBe("circle_url");
-  });
-  test("should return custom metadata when provided in config", async () => {
-    vi.mocked(ciPlatform).mockReturnValueOnce({
-      isCI: true,
-      name: "circle",
-      metadata: {
-        actor: "circle_actor",
-        commitSha: "circle_sha",
-        url: "circle_url"
-      }
-    });
-    const testConfig = createTestConfig("/tmp/deploymentRoot/");
-    testConfig.metadata = {
-      user: "custom_user",
-      version: "custom_version",
-      url: "custom_url"
-    };
-    const metadataResult = await getMetadata(testConfig, stderrLogger);
-    expect(metadataResult.actor).toBe("custom_user");
-    expect(metadataResult.commitSha).toBe("custom_version");
-    expect(metadataResult.name).toBe("circle");
-    expect(metadataResult.url).toBe("custom_url");
-  });
-  test("should return commit data from latest commit through getLastestGitCommit", async () => {
-    vi.mocked(ciPlatform).mockReturnValueOnce({
-      isCI: false
-    });
-    vi.mocked(getLatestGitCommit).mockResolvedValueOnce({
-      author_name: "gh_author",
-      author_email: "test@github.com",
-      hash: "gh_hash",
-      message: "gh_message",
-      refs: "gh_refs",
-      date: "gh_date",
-      body: "gh_body"
-    });
-    const testConfig = createTestConfig("/tmp/deploymentRoot/");
-    const metadataResult = await getMetadata(testConfig, stderrLogger);
-    expect(metadataResult.actor).toBe("gh_author");
-    expect(metadataResult.commitSha).toBe("gh_hash");
-    expect(metadataResult.commitDate).toBe("gh_date");
-    expect(metadataResult.commitMessage).toBe("gh_message");
-    expect(metadataResult.name).toBe("none");
-    expect(metadataResult.url).toBe(void 0);
-  });
-  test("should derive branch correctly from commit refs", async () => {
-    vi.mocked(ciPlatform).mockReturnValue({
-      isCI: false
-    });
-    const testCases = {
-      "HEAD -> main, origin/main, origin/HEAD": "main",
-      "HEAD -> dev, origin/dev, origin/HEAD": "dev",
-      "HEAD -> feature/awesome-feature, origin/feature/awesome-feature, origin/HEAD": "feature/awesome-feature",
-      "HEAD -> bugfix/123-fix-bug, origin/bugfix/123-fix-bug, origin/HEAD": "bugfix/123-fix-bug",
-      "HEAD -> release/v1.0.0, origin/release/v1.0.0, origin/HEAD": "release/v1.0.0",
-      "HEAD -> hotfix/urgent-fix, origin/hotfix/urgent-fix, origin/HEAD": "hotfix/urgent-fix",
-      "HEAD -> test, origin/test, origin/HEAD": "test",
-      "HEAD -> my-branch, origin/my-branch, origin/HEAD": "my-branch",
-      "HEAD -> long-branch-name, origin/long-branch-name, origin/HEAD": "long-branch-name",
-      "HEAD -> branch_with_underscores, origin/branch_with_underscores, origin/HEAD": "branch_with_underscores",
-      "HEAD -> branch-with-dashes, origin/branch-with-dashes, origin/HEAD": "branch-with-dashes",
-      "HEAD -> branch.with.dots, origin/branch.with.dots, origin/HEAD": "branch.with.dots"
-    };
-    for (const [refs, expectedBranch] of Object.entries(testCases)) {
-      vi.mocked(getLatestGitCommit).mockResolvedValueOnce({
-        author_name: "gh_author",
-        author_email: "test@github.com",
-        hash: "gh_hash",
-        message: "gh_message",
-        refs,
-        date: "gh_date",
-        body: "gh_body"
-      });
-      const testConfig = createTestConfig("/tmp/deploymentRoot/");
-      const metadataResult = await getMetadata(testConfig, stderrLogger);
-      expect(metadataResult.branch).toBe(expectedBranch);
-    }
-  });
-});
-describe("getEnvironmentInput", () => {
-  test("should return environment tag from config", () => {
-    const testConfig = createTestConfig("/tmp/deploymentRoot/");
-    testConfig.environmentTag = "test_tag";
-    const metadata = {
-      branch: "test_branch"
-    };
-    const environmentInput = getEnvironmentInput(testConfig, metadata);
-    expect(environmentInput.tag).toBe("test_tag");
-  });
-  test("should return environment tag from metadata", () => {
-    const testConfig = createTestConfig("/tmp/deploymentRoot/");
-    delete testConfig.environmentTag;
-    const metadata = {
-      branch: "test_branch"
-    };
-    const environmentInput = getEnvironmentInput(testConfig, metadata);
-    expect(environmentInput.tag).toBe("test_branch");
-  });
-  test("should return undefined if no environment tag is provided", () => {
-    const testConfig = createTestConfig("/tmp/deploymentRoot/");
-    delete testConfig.environmentTag;
-    const metadata = {};
-    expect(getEnvironmentInput(testConfig, metadata)).toBe(void 0);
-  });
-});
-describe("createLabels", () => {
-  test("should return labels from metadata", () => {
-    const metadata = {
-      name: "circle",
-      run: "circle_1234",
-      url: "http://circleci.com/workflow/123",
-      actor: "circle_actor",
-      commitSha: "circle_sha",
-      branch: "main"
-    };
-    const labels = [
-      'circle-runId="circle_1234"',
-      'user="circle_actor"',
-      'branch="main"',
-      'version="circle_sha"',
-      'url="http://circleci.com/workflow/123"'
-    ];
-    expect(createLabels(metadata)).toEqual(labels);
-  });
-  test("should return labels from metadata only for populated fields", () => {
-    const metadata = {
-      name: "circle",
-      run: "circle_run",
-      attempt: "1"
-    };
-    const labels = ['circle-attempt="1"', 'circle-runId="circle_run"'];
-    expect(createLabels(metadata)).toEqual(labels);
-  });
-  test("should throw when user metadata exceeds maximum length", () => {
-    const metadata = {
-      actor: "a".repeat(101),
-      name: "unknown"
-    };
-    expect(() => createLabels(metadata)).toThrow(
-      `Provided user metadata exceeds maximum length (max ${maxLabelLength} characters).`
-    );
-  });
-});

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

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

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

@@ -1,224 +0,0 @@
-import { Readable } from 'stream';
-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 { stderrLogger, deployDefaults } from '../utils/utils.js';
-import { uploadFiles } from './upload-files.js';
-
-class NamedReadable extends Readable {
-  name = "dummy";
-  _read() {
-  }
-}
-vi.mock("@shopify/cli-kit/node/output");
-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/fs", () => {
-  return {
-    createFileReadStream: vi.fn(() => {
-      const readable = new NamedReadable();
-      readable.push("dummy");
-      readable.emit("end");
-      return readable;
-    })
-  };
-});
-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 response = new Response();
-    vi.mocked(fetch).mockResolvedValueOnce(response);
-    const testWorkerUpload = [
-      {
-        filePath: "index.js",
-        fileSize: 1,
-        uploadUrl: "https://storage.googleapis.com/the-bucket/",
-        fileType: "WORKER",
-        parameters: [{ name: "someName", value: "someValue" }]
-      }
-    ];
-    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/",
-      expect.objectContaining({
-        method: "POST",
-        body: expect.objectContaining({
-          _streams: expect.arrayContaining([
-            expect.stringContaining('name="someName"'),
-            expect.stringMatching("someValue")
-          ]),
-          _valuesToMeasure: expect.arrayContaining([
-            expect.objectContaining({ name: "dummy" })
-          ])
-        })
-      })
-    );
-    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"));
-    const testWorkerUpload = [
-      {
-        filePath: "index.js",
-        fileSize: 1,
-        uploadUrl: "https://storage.googleapis.com/the-bucket/",
-        fileType: "WORKER",
-        parameters: [{ name: "someName", value: "someValue" }]
-      }
-    ];
-    await expect(
-      uploadFiles({
-        config: testConfig,
-        targets: testWorkerUpload,
-        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 = {
-      "x-guploader-uploadid": "some-id",
-      location: "https://upload-it-here.com/"
-    };
-    const response = new Response(null, { headers });
-    vi.mocked(fetch).mockResolvedValue(response);
-    const testWorkerUpload = [
-      {
-        filePath: "index.js",
-        fileSize: 1,
-        uploadUrl: "https://storage.googleapis.com/the-bucket/",
-        fileType: "WORKER",
-        parameters: null
-      }
-    ];
-    await uploadFiles({
-      config: testConfig,
-      targets: testWorkerUpload,
-      logger: stderrLogger,
-      hooks
-    });
-    expect(vi.mocked(fetch)).toHaveBeenCalledTimes(2);
-    const secondCall = vi.mocked(fetch).mock.calls[1];
-    expect(secondCall[0]).toBe("https://upload-it-here.com/");
-    const validateRequestBody = (req) => {
-      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 = () => {
-    };
-    let fetchCounter = 0;
-    vi.mocked(fetch).mockImplementation(async () => {
-      fetchCounter++;
-      if (fetchCounter === 1) {
-        const headers = {
-          "x-guploader-uploadid": "some-id",
-          location: "https://upload-it-here.com/"
-        };
-        const response = new Response(null, { headers });
-        return Promise.resolve(response);
-      } else if (fetchCounter === 4) {
-        return Promise.resolve(new Response(null, { status: 200 }));
-      } else {
-        return Promise.reject(new Error("some error"));
-      }
-    });
-    const testWorkerUpload = [
-      {
-        filePath: "index.js",
-        fileSize: 1,
-        uploadUrl: "https://storage.googleapis.com/the-bucket/",
-        fileType: "WORKER",
-        parameters: null
-      }
-    ];
-    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/");
-    expect(statusCall[1]).toMatchObject({
-      method: "PUT",
-      headers: {
-        "Content-Range": "bytes */1",
-        "Content-Length": "0"
-      }
-    });
-  });
-  it("Throws when a resumable upload fails after exhausting attempt count", async () => {
-    console.error = () => {
-    };
-    let fetchCounter = 0;
-    vi.mocked(fetch).mockImplementation(async () => {
-      fetchCounter++;
-      if (fetchCounter === 1) {
-        const headers = {
-          "x-guploader-uploadid": "some-id",
-          location: "https://upload-it-here.com/"
-        };
-        const response = new Response(null, { headers });
-        return Promise.resolve(response);
-      } else {
-        return Promise.reject(new Error("some error"));
-      }
-    });
-    const testWorkerUpload = [
-      {
-        filePath: "index.js",
-        fileSize: 1,
-        uploadUrl: "https://storage.googleapis.com/the-bucket/",
-        fileType: "WORKER",
-        parameters: null
-      }
-    ];
-    await expect(
-      uploadFiles({
-        config: testConfig,
-        targets: testWorkerUpload,
-        logger: stderrLogger,
-        hooks
-      })
-    ).rejects.toThrow(
-      `Failed to upload file index.js after ${deployDefaults.maxResumabeUploadAttempts} attempts`
-    );
-    expect(vi.mocked(fetch)).toHaveBeenCalledTimes(
-      // 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/utils.test.d.ts

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