wrangler 0.0.0-ece06ea → 0.0.0-ed08df4

package/src/__tests__/logger.test.ts

@@ -0,0 +1,115 @@
+import { logger } from "../logger";
+import { mockConsoleMethods } from "./helpers/mock-console";
+
+describe("logger", () => {
+  const std = mockConsoleMethods();
+
+  it("should add colored markers to error and warning messages", () => {
+    logger.loggerLevel = "debug";
+    logger.debug("This is a debug message");
+    logger.log("This is a log message");
+    logger.warn("This is a warn message");
+    logger.error("This is a error message");
+
+    expect(std.debug).toMatchInlineSnapshot(`"This is a debug message"`);
+    expect(std.out).toMatchInlineSnapshot(`"This is a log message"`);
+    expect(std.warn).toMatchInlineSnapshot(`
+      "▲ [WARNING] This is a warn message
+
+      "
+    `);
+    expect(std.err).toMatchInlineSnapshot(`
+      "X [ERROR] This is a error message
+
+      "
+    `);
+  });
+
+  describe("loggerLevel=debug", () => {
+    it("should render messages that are at or above the log level set in the logger", () => {
+      logger.loggerLevel = "debug";
+      logger.debug("This is a debug message");
+      logger.log("This is a log message");
+      logger.warn("This is a warn message");
+      logger.error("This is a error message");
+
+      expect(std.debug).toMatchInlineSnapshot(`"This is a debug message"`);
+      expect(std.out).toMatchInlineSnapshot(`"This is a log message"`);
+      expect(std.warn).toMatchInlineSnapshot(`
+        "▲ [WARNING] This is a warn message
+
+        "
+      `);
+      expect(std.err).toMatchInlineSnapshot(`
+        "X [ERROR] This is a error message
+
+        "
+      `);
+    });
+  });
+
+  describe("loggerLevel=log", () => {
+    it("should render messages that are at or above the log level set in the logger", () => {
+      logger.loggerLevel = "log";
+      logger.debug("This is a debug message");
+      logger.log("This is a log message");
+      logger.warn("This is a warn message");
+      logger.error("This is a error message");
+
+      expect(std.debug).toMatchInlineSnapshot(`""`);
+      expect(std.out).toMatchInlineSnapshot(`"This is a log message"`);
+      expect(std.warn).toMatchInlineSnapshot(`
+        "▲ [WARNING] This is a warn message
+
+        "
+      `);
+      expect(std.err).toMatchInlineSnapshot(`
+        "X [ERROR] This is a error message
+
+        "
+      `);
+    });
+  });
+
+  describe("loggerLevel=warn", () => {
+    it("should render messages that are at or above the log level set in the logger", () => {
+      logger.loggerLevel = "warn";
+      logger.debug("This is a debug message");
+      logger.log("This is a log message");
+      logger.warn("This is a warn message");
+      logger.error("This is a error message");
+
+      expect(std.debug).toMatchInlineSnapshot(`""`);
+      expect(std.out).toMatchInlineSnapshot(`""`);
+      expect(std.warn).toMatchInlineSnapshot(`
+        "▲ [WARNING] This is a warn message
+
+        "
+      `);
+      expect(std.err).toMatchInlineSnapshot(`
+        "X [ERROR] This is a error message
+
+        "
+      `);
+    });
+  });
+
+  describe("loggerLevel=error", () => {
+    it("should render messages that are at or above the log level set in the logger", () => {
+      logger.loggerLevel = "error";
+      logger.debug("This is a debug message");
+      logger.log("This is a log message");
+      logger.warn("This is a warn message");
+      logger.error("This is a error message");
+
+      expect(std.debug).toMatchInlineSnapshot(`""`);
+      expect(std.out).toMatchInlineSnapshot(`""`);
+      expect(std.warn).toMatchInlineSnapshot(`""`);
+      expect(std.err).toMatchInlineSnapshot(`
+        "X [ERROR] This is a error message
+
+        "
+      `);
+    });
+  });
+});

package/src/__tests__/package-manager.test.ts

@@ -0,0 +1,206 @@
+import { writeFileSync } from "node:fs";
+import { mockBinary } from "./helpers/mock-bin";
+import { mockConsoleMethods } from "./helpers/mock-console";
+import { runInTempDir } from "./helpers/run-in-tmp";
+
+const { getPackageManager, getPackageManagerName } =
+  jest.requireActual("../package-manager");
+interface TestCase {
+  npm: boolean;
+  yarn: boolean;
+  npmLockFile: boolean;
+  yarnLockFile: boolean;
+  expectedPackageManager: string;
+}
+
+const testCases: TestCase[] = [
+  // npm binary - no yarn binary
+  {
+    npm: true,
+    yarn: false,
+    npmLockFile: false,
+    yarnLockFile: false,
+    expectedPackageManager: "npm",
+  },
+  {
+    npm: true,
+    yarn: false,
+    npmLockFile: true,
+    yarnLockFile: false,
+    expectedPackageManager: "npm",
+  },
+  {
+    npm: true,
+    yarn: false,
+    npmLockFile: false,
+    yarnLockFile: true,
+    expectedPackageManager: "npm",
+  },
+  {
+    npm: true,
+    yarn: false,
+    npmLockFile: true,
+    yarnLockFile: true,
+    expectedPackageManager: "npm",
+  },
+
+  // yarn binary - no npm binary
+  {
+    npm: false,
+    yarn: true,
+    npmLockFile: false,
+    yarnLockFile: false,
+    expectedPackageManager: "yarn",
+  },
+  {
+    npm: false,
+    yarn: true,
+    npmLockFile: true,
+    yarnLockFile: false,
+    expectedPackageManager: "yarn",
+  },
+  {
+    npm: false,
+    yarn: true,
+    npmLockFile: false,
+    yarnLockFile: true,
+    expectedPackageManager: "yarn",
+  },
+  {
+    npm: false,
+    yarn: true,
+    npmLockFile: true,
+    yarnLockFile: true,
+    expectedPackageManager: "yarn",
+  },
+
+  // npm and yarn binaries
+  {
+    npm: true,
+    yarn: true,
+    npmLockFile: false,
+    yarnLockFile: false,
+    expectedPackageManager: "npm",
+  },
+  {
+    npm: true,
+    yarn: true,
+    npmLockFile: true,
+    yarnLockFile: false,
+    expectedPackageManager: "npm",
+  },
+  {
+    npm: true,
+    yarn: true,
+    npmLockFile: false,
+    yarnLockFile: true,
+    expectedPackageManager: "yarn",
+  },
+  {
+    npm: true,
+    yarn: true,
+    npmLockFile: true,
+    yarnLockFile: true,
+    expectedPackageManager: "npm",
+  },
+];
+
+describe("getPackageManager()", () => {
+  runInTempDir();
+  mockConsoleMethods();
+
+  describe("no supported package manager", () => {
+    mockYarn(false);
+    mockNpm(false);
+
+    it("should throw an error", async () => {
+      await expect(() =>
+        getPackageManager(process.cwd())
+      ).rejects.toThrowErrorMatchingInlineSnapshot(
+        `"Unable to find a package manager. Supported managers are: npm and yarn."`
+      );
+    });
+  });
+
+  for (const {
+    npm,
+    yarn,
+    npmLockFile,
+    yarnLockFile,
+    expectedPackageManager,
+  } of testCases) {
+    describe(
+      getTestCaseDescription(npm, yarn, npmLockFile, yarnLockFile),
+      () => {
+        mockYarn(yarn);
+        mockNpm(npm);
+        mockLockFiles(npmLockFile, yarnLockFile);
+
+        it(`should return the ${expectedPackageManager} package manager`, async () => {
+          const actualPackageManager = await getPackageManager(process.cwd());
+          expect(getPackageManagerName(actualPackageManager)).toEqual(
+            expectedPackageManager
+          );
+        });
+      }
+    );
+  }
+});
+
+/**
+ * Create a fake yarn binary
+ */
+function mockYarn(succeed: boolean): void {
+  let unMock: () => void;
+  beforeEach(async () => {
+    unMock = await mockBinary("yarn", `process.exit(${succeed ? 0 : 1})`);
+  });
+  afterEach(() => unMock());
+}
+
+/**
+ * Create a fake npm binary
+ */
+function mockNpm(succeed: boolean): void {
+  let unMock: () => void;
+  beforeEach(async () => {
+    unMock = await mockBinary("npm", `process.exit(${succeed ? 0 : 1})`);
+  });
+  afterEach(() => unMock());
+}
+
+/**
+ * Create a fake lock files.
+ */
+function mockLockFiles(npmLockFile: boolean, yarnLockFile: boolean) {
+  beforeEach(() => {
+    if (npmLockFile) {
+      writeFileSync("package-lock.json", "");
+    }
+    if (yarnLockFile) {
+      writeFileSync("yarn.lock", "");
+    }
+  });
+}
+
+function getTestCaseDescription(
+  npm: boolean,
+  yarn: boolean,
+  npmLockFile: boolean,
+  yarnLockFile: boolean
+): string {
+  const criteria: string[] = [];
+  if (npm) {
+    criteria.push("npm");
+  }
+  if (npmLockFile) {
+    criteria.push("package-lock.json");
+  }
+  if (yarn) {
+    criteria.push("yarn");
+  }
+  if (yarnLockFile) {
+    criteria.push("yarn.lock");
+  }
+  return "using " + criteria.join("; ");
+}

package/src/__tests__/pages.test.ts

@@ -0,0 +1,327 @@
+import { writeFileSync } from "node:fs";
+import { mockAccountId, mockApiToken } from "./helpers/mock-account-id";
+import { setMockResponse, unsetAllMocks } from "./helpers/mock-cfetch";
+import { mockConsoleMethods } from "./helpers/mock-console";
+import { runInTempDir } from "./helpers/run-in-tmp";
+import { runWrangler } from "./helpers/run-wrangler";
+import type { Project, Deployment } from "../pages";
+import type { File, FormData } from "undici";
+
+describe("pages", () => {
+  runInTempDir();
+  const std = mockConsoleMethods();
+  function endEventLoop() {
+    return new Promise((resolve) => setImmediate(resolve));
+  }
+
+  it("should should display a list of available subcommands, for pages with no subcommand", async () => {
+    await runWrangler("pages");
+    await endEventLoop();
+
+    expect(std.out).toMatchInlineSnapshot(`
+      "wrangler pages
+
+      ⚡️ Configure Cloudflare Pages
+
+      Commands:
+        wrangler pages dev [directory] [-- command]  🧑‍💻 Develop your full-stack Pages application locally
+        wrangler pages project                       ⚡️ Interact with your Pages projects
+        wrangler pages deployment                    🚀 Interact with the deployments of a project
+        wrangler pages publish [directory]           🆙 Publish a directory of static assets as a Pages deployment
+
+      Flags:
+        -c, --config   Path to .toml configuration file  [string]
+        -h, --help     Show help  [boolean]
+        -v, --version  Show version number  [boolean]
+
+      🚧 'wrangler pages <command>' is a beta command. Please report any issues to https://github.com/cloudflare/wrangler2/issues/new/choose"
+    `);
+  });
+
+  describe("beta message for subcommands", () => {
+    it("should display for pages:dev", async () => {
+      await expect(
+        runWrangler("pages dev")
+      ).rejects.toThrowErrorMatchingInlineSnapshot(
+        `"Must specify a directory of static assets to serve or a command to run."`
+      );
+
+      expect(std.out).toMatchInlineSnapshot(`
+        "🚧 'wrangler pages <command>' is a beta command. Please report any issues to https://github.com/cloudflare/wrangler2/issues/new/choose
+
+        If you think this is a bug then please create an issue at https://github.com/cloudflare/wrangler2/issues/new."
+      `);
+    });
+
+    it("should display for pages:functions:build", async () => {
+      await expect(runWrangler("pages functions build")).rejects.toThrowError();
+
+      expect(std.out).toMatchInlineSnapshot(`
+        "🚧 'wrangler pages <command>' is a beta command. Please report any issues to https://github.com/cloudflare/wrangler2/issues/new/choose
+
+        If you think this is a bug then please create an issue at https://github.com/cloudflare/wrangler2/issues/new."
+      `);
+    });
+  });
+
+  describe("project list", () => {
+    mockAccountId();
+    mockApiToken();
+
+    afterEach(() => {
+      unsetAllMocks();
+    });
+
+    function mockListRequest(projects: unknown[]) {
+      const requests = { count: 0 };
+      setMockResponse(
+        "/accounts/:accountId/pages/projects",
+        ([_url, accountId], init, query) => {
+          requests.count++;
+          expect(accountId).toEqual("some-account-id");
+          expect(query.get("per_page")).toEqual("10");
+          expect(query.get("page")).toEqual(`${requests.count}`);
+          expect(init).toEqual({});
+          const pageSize = Number(query.get("per_page"));
+          const page = Number(query.get("page"));
+          return projects.slice((page - 1) * pageSize, page * pageSize);
+        }
+      );
+      return requests;
+    }
+
+    it("should make request to list projects", async () => {
+      const projects: Project[] = [
+        {
+          name: "dogs",
+          subdomain: "docs.pages.dev",
+          domains: ["dogs.pages.dev"],
+          source: {
+            type: "github",
+          },
+          latest_deployment: {
+            modified_on: "2021-11-17T14:52:26.133835Z",
+          },
+          created_on: "2021-11-17T14:52:26.133835Z",
+          production_branch: "main",
+        },
+        {
+          name: "cats",
+          subdomain: "cats.pages.dev",
+          domains: ["cats.pages.dev", "kitten.com"],
+          latest_deployment: {
+            modified_on: "2021-11-17T14:52:26.133835Z",
+          },
+          created_on: "2021-11-17T14:52:26.133835Z",
+          production_branch: "main",
+        },
+      ];
+
+      const requests = mockListRequest(projects);
+      await runWrangler("pages project list");
+
+      expect(requests.count).toBe(1);
+    });
+
+    it("should make multiple requests for paginated results", async () => {
+      const projects: Project[] = [];
+      for (let i = 0; i < 15; i++) {
+        projects.push({
+          name: "dogs" + i,
+          subdomain: i + "dogs.pages.dev",
+          domains: [i + "dogs.pages.dev"],
+          source: {
+            type: "github",
+          },
+          latest_deployment: {
+            modified_on: "2021-11-17T14:52:26.133835Z",
+          },
+          created_on: "2021-11-17T14:52:26.133835Z",
+          production_branch: "main",
+        });
+      }
+      const requests = mockListRequest(projects);
+      await runWrangler("pages project list");
+      expect(requests.count).toEqual(2);
+    });
+  });
+
+  describe("project create", () => {
+    mockAccountId();
+    mockApiToken();
+
+    afterEach(() => {
+      unsetAllMocks();
+    });
+
+    it("should create a project with a production branch", async () => {
+      setMockResponse(
+        "/accounts/:accountId/pages/projects",
+        ([_url, accountId], init) => {
+          expect(accountId).toEqual("some-account-id");
+          expect(init.method).toEqual("POST");
+          const body = JSON.parse(init.body as string);
+          expect(body).toEqual({
+            name: "a-new-project",
+            production_branch: "main",
+          });
+          return {
+            name: "a-new-project",
+            subdomain: "a-new-project.pages.dev",
+            production_branch: "main",
+          };
+        }
+      );
+      await runWrangler(
+        "pages project create a-new-project --production-branch=main"
+      );
+      expect(std.out).toMatchInlineSnapshot(`
+        "✨ Successfully created the 'a-new-project' project. It will be available at https://a-new-project.pages.dev/ once you create your first deployment.
+        To deploy a folder of assets, run 'wrangler pages publish [directory]'."
+      `);
+    });
+  });
+
+  describe("deployment list", () => {
+    mockAccountId();
+    mockApiToken();
+
+    afterEach(() => {
+      unsetAllMocks();
+    });
+    function mockListRequest(deployments: unknown[]) {
+      const requests = { count: 0 };
+      setMockResponse(
+        "/accounts/:accountId/pages/projects/:project/deployments",
+        ([_url, accountId, project]) => {
+          requests.count++;
+          expect(project).toEqual("images");
+          expect(accountId).toEqual("some-account-id");
+          return deployments;
+        }
+      );
+      return requests;
+    }
+
+    it("should make request to list deployments", async () => {
+      const deployments: Deployment[] = [
+        {
+          id: "87bbc8fe-16be-45cd-81e0-63d722e82cdf",
+          url: "https://87bbc8fe.images.pages.dev",
+          environment: "preview",
+          latest_stage: {
+            ended_on: "2021-11-17T14:52:26.133835Z",
+            status: "success",
+          },
+          deployment_trigger: {
+            metadata: {
+              branch: "main",
+              commit_hash: "c7649364c4cb32ad4f65b530b9424e8be5bec9d6",
+            },
+          },
+          project_name: "images",
+        },
+      ];
+
+      const requests = mockListRequest(deployments);
+      await runWrangler("pages deployment list --project-name=images");
+
+      expect(requests.count).toBe(1);
+    });
+  });
+
+  describe("deployment create", () => {
+    let actualProcessEnvCI: string | undefined;
+
+    mockAccountId();
+    mockApiToken();
+    runInTempDir();
+
+    beforeEach(() => {
+      actualProcessEnvCI = process.env.CI;
+      process.env.CI = "true";
+    });
+
+    afterEach(() => {
+      unsetAllMocks();
+      process.env.CI = actualProcessEnvCI;
+    });
+
+    it("should be aliased with 'wrangler pages publish'", async () => {
+      await runWrangler("pages publish --help");
+      await endEventLoop();
+
+      expect(std.out).toMatchInlineSnapshot(`
+        "wrangler pages publish [directory]
+
+        🆙 Publish a directory of static assets as a Pages deployment
+
+        Positionals:
+          directory  The directory of static files to upload  [string]
+
+        Flags:
+          -c, --config   Path to .toml configuration file  [string]
+          -h, --help     Show help  [boolean]
+          -v, --version  Show version number  [boolean]
+
+        Options:
+              --project-name    The name of the project you want to deploy to  [string]
+              --branch          The name of the branch you want to deploy to  [string]
+              --commit-hash     The SHA to attach to this deployment  [string]
+              --commit-message  The commit message to attach to this deployment  [string]
+              --commit-dirty    Whether or not the workspace should be considered dirty for this deployment  [boolean]
+
+        🚧 'wrangler pages <command>' is a beta command. Please report any issues to https://github.com/cloudflare/wrangler2/issues/new/choose"
+      `);
+    });
+
+    it("should upload a directory of files", async () => {
+      writeFileSync("logo.png", "foobar");
+
+      setMockResponse(
+        "/accounts/:accountId/pages/projects/foo/file",
+        async ([_url, accountId], init) => {
+          expect(accountId).toEqual("some-account-id");
+          expect(init.method).toEqual("POST");
+          const body = init.body as FormData;
+          const logoPNGFile = body.get("file") as File;
+          expect(await logoPNGFile.text()).toEqual("foobar");
+          expect(logoPNGFile.name).toEqual("logo.png");
+
+          return {
+            id: "2082190357cfd3617ccfe04f340c6247",
+          };
+        }
+      );
+
+      setMockResponse(
+        "/accounts/:accountId/pages/projects/foo/deployments",
+        async ([_url, accountId], init) => {
+          expect(accountId).toEqual("some-account-id");
+          expect(init.method).toEqual("POST");
+          const body = init.body as FormData;
+          const manifest = JSON.parse(body.get("manifest") as string);
+          expect(manifest).toMatchInlineSnapshot(`
+            Object {
+              "/logo.png": "2082190357cfd3617ccfe04f340c6247",
+            }
+          `);
+
+          return {
+            url: "https://abcxyz.foo.pages.dev/",
+          };
+        }
+      );
+
+      await runWrangler("pages publish . --project-name=foo");
+
+      // TODO: Unmounting somehow loses this output
+
+      // expect(std.out).toMatchInlineSnapshot(`
+      //   "✨ Success! Uploaded 1 files (TIMINGS)
+
+      //   ✨ Deployment complete! Take a peek over at https://abcxyz.foo.pages.dev/"
+      // `);
+    });
+  });
+});