wrangler 2.9.0 → 2.10.0

package/src/__tests__/pages/functions-build.test.ts

@@ -0,0 +1,402 @@
+import { existsSync, mkdirSync, readFileSync, writeFileSync } from "node:fs";
+import { endEventLoop } from "../helpers/end-event-loop";
+import { mockConsoleMethods } from "../helpers/mock-console";
+import { runInTempDir } from "../helpers/run-in-tmp";
+import { runWrangler } from "../helpers/run-wrangler";
+import { replaceRandomWithConstantData } from "../helpers/string-dynamic-values-matcher";
+
+describe("functions build", () => {
+	const std = mockConsoleMethods();
+
+	runInTempDir();
+
+	afterEach(async () => {
+		// Force a tick to ensure that all promises resolve
+		await endEventLoop();
+	});
+
+	it("should throw an error if no worker script and no Functions directory was found", async () => {
+		await expect(runWrangler("pages functions build")).rejects.toThrowError();
+		expect(std.err).toContain("Could not find anything to build.");
+	});
+
+	it("should build functions", async () => {
+		/* ---------------------------- */
+		/*       Set up Functions       */
+		/* ---------------------------- */
+		mkdirSync("functions");
+		writeFileSync(
+			"functions/hello.js",
+			`
+    export async function onRequest() {
+      return new Response("Hello from Pages Functions");
+    }
+    `
+		);
+
+		/* --------------------------------- */
+		/*     Run cmd & make assertions     */
+		/* --------------------------------- */
+		await runWrangler(`pages functions build`);
+
+		expect(existsSync("_worker.js")).toBe(true);
+		expect(std.out).toMatchInlineSnapshot(`
+		"🚧 'wrangler pages <command>' is a beta command. Please report any issues to https://github.com/cloudflare/workers-sdk/issues/new/choose
+		✨ Compiled Worker successfully"
+	`);
+		expect(std.err).toMatchInlineSnapshot(`""`);
+	});
+
+	it("should include any external modules imported by functions in the output bundle when the [--experimental-worker-bundle] flag is set", async () => {
+		/* ---------------------------- */
+		/*       Set up wasm files      */
+		/* ---------------------------- */
+		mkdirSync("wasm");
+		writeFileSync("wasm/greeting.wasm", "Hello");
+		writeFileSync("wasm/name.wasm", "wasm Functions");
+
+		/* ---------------------------- */
+		/*       Set up Functions       */
+		/* ---------------------------- */
+		mkdirSync("functions");
+		writeFileSync(
+			"functions/hello.js",
+			`
+    import hello from "./../wasm/greeting.wasm";
+    import name from "./../wasm/name.wasm";
+
+    export async function onRequest() {
+      const greetingModule = await WebAssembly.instantiate(greeting);
+			const nameModule = await WebAssembly.instantiate(name);
+      return new Response(greetingModule.exports.hello + " " + nameModule.exports.name);
+    }
+    `
+		);
+
+		/* --------------------------------- */
+		/*     Run cmd & make assertions     */
+		/* --------------------------------- */
+		await runWrangler(
+			`pages functions build --outfile=_worker.bundle --experimental-worker-bundle=true`
+		);
+
+		expect(existsSync("_worker.bundle")).toBe(true);
+		expect(std.out).toMatchInlineSnapshot(`
+		"🚧 'wrangler pages <command>' is a beta command. Please report any issues to https://github.com/cloudflare/workers-sdk/issues/new/choose
+		✨ Compiled Worker successfully"
+	`);
+
+		// some values in workerBundleContents, such as the undici form boundary
+		// or the file hashes, are randomly generated. Let's replace them
+		// with static values so we can test the file contents
+		const workerBundleContents = readFileSync("_worker.bundle", "utf-8");
+		const workerBundleWithConstantData = replaceRandomWithConstantData(
+			workerBundleContents,
+			[
+				[/------formdata-undici-0.[0-9]*/g, "------formdata-undici-0.test"],
+				[/functionsWorker-0.[0-9]*.js/g, "functionsWorker-0.test.js"],
+				[/[0-9a-z]*-greeting.wasm/g, "test-greeting.wasm"],
+				[/[0-9a-z]*-name.wasm/g, "test-name.wasm"],
+			]
+		);
+
+		// check we appended the metadata
+		expect(workerBundleWithConstantData).toContain(
+			`Content-Disposition: form-data; name="metadata"`
+		);
+		expect(workerBundleWithConstantData).toContain(
+			`{"main_module":"functionsWorker-0.test.js"}`
+		);
+
+		// check we appended the compiled Worker
+		expect(workerBundleWithConstantData).toContain(
+			`Content-Disposition: form-data; name="functionsWorker-0.test.js"; filename="functionsWorker-0.test.js"`
+		);
+
+		// check we appended the wasm modules
+		expect(workerBundleWithConstantData).toContain(
+			`Content-Disposition: form-data; name="./test-greeting.wasm"; filename="./test-greeting.wasm"`
+		);
+		expect(workerBundleWithConstantData).toContain(
+			`Content-Disposition: form-data; name="./test-name.wasm"; filename="./test-name.wasm"`
+		);
+		expect(workerBundleWithConstantData).toContain(`Hello`);
+		expect(workerBundleWithConstantData).toContain(`wasm Functions`);
+
+		expect(std.err).toMatchInlineSnapshot(`""`);
+	});
+
+	it("should fail building if functions use external module imports, but the [--experimental-worker-bundle] flag is not set", async () => {
+		/* ---------------------------- */
+		/*       Set up wasm files      */
+		/* ---------------------------- */
+		mkdirSync("wasm");
+		writeFileSync("wasm/greeting.wasm", "Hello wasm Functions!");
+
+		/* ---------------------------- */
+		/*       Set up Functions       */
+		/* ---------------------------- */
+		mkdirSync("functions");
+		writeFileSync(
+			"functions/hello.js",
+			`
+    import hello from "./../wasm/greeting.wasm";
+
+    export async function onRequest() {
+      const module = await WebAssembly.instantiate(greeting);
+      return new Response(module.exports.hello);
+    }
+    `
+		);
+
+		/* --------------------------------- */
+		/*     Run cmd & make assertions     */
+		/* --------------------------------- */
+		await expect(runWrangler(`pages functions build`)).rejects.toThrowError();
+		expect(std.err).toContain(
+			`ERROR: No loader is configured for ".wasm" files: ../wasm/greeting.wasm`
+		);
+	});
+
+	it("should build _worker.js if the [--experimental-worker-bundle] flag is set", async () => {
+		/* ---------------------------- */
+		/*       Set up js files        */
+		/* ---------------------------- */
+		mkdirSync("utils");
+		writeFileSync(
+			"utils/meaning-of-life.js",
+			`
+export const MEANING_OF_LIFE = 21;
+`
+		);
+
+		/* ---------------------------- */
+		/*       Set up _worker.js      */
+		/* ---------------------------- */
+		mkdirSync("public");
+		writeFileSync(
+			"public/_worker.js",
+			`
+import { MEANING_OF_LIFE } from "./../utils/meaning-of-life.js";
+
+export default {
+  async fetch(request, env) {
+    return new Response("Hello from _worker.js. The meaning of life is " + MEANING_OF_LIFE);
+  },
+};`
+		);
+
+		/* --------------------------------- */
+		/*     Run cmd & make assertions     */
+		/* --------------------------------- */
+		await runWrangler(
+			`pages functions build --build-output-directory=public --outfile=_worker.bundle --experimental-worker-bundle=true`
+		);
+		expect(existsSync("_worker.bundle")).toBe(true);
+		expect(std.out).toMatchInlineSnapshot(`
+		"🚧 'wrangler pages <command>' is a beta command. Please report any issues to https://github.com/cloudflare/workers-sdk/issues/new/choose
+		✨ Compiled Worker successfully"
+	`);
+
+		// some values in workerBundleContents, such as the undici form boundary
+		// or the file hashes, are randomly generated. Let's replace them
+		// with static values so we can test the file contents
+		const workerBundleContents = readFileSync("_worker.bundle", "utf-8");
+		const workerBundleWithConstantData = replaceRandomWithConstantData(
+			workerBundleContents,
+			[
+				[/------formdata-undici-0.[0-9]*/g, "------formdata-undici-0.test"],
+				[/bundledWorker-0.[0-9]*.mjs/g, "bundledWorker-0.test.mjs"],
+			]
+		);
+
+		expect(workerBundleWithConstantData).toMatchInlineSnapshot(`
+		"------formdata-undici-0.test
+		Content-Disposition: form-data; name=\\"metadata\\"
+
+		{\\"main_module\\":\\"bundledWorker-0.test.mjs\\"}
+		------formdata-undici-0.test
+		Content-Disposition: form-data; name=\\"bundledWorker-0.test.mjs\\"; filename=\\"bundledWorker-0.test.mjs\\"
+		Content-Type: application/javascript+module
+
+		// ../utils/meaning-of-life.js
+		var MEANING_OF_LIFE = 21;
+
+		// _worker.js
+		var worker_default = {
+		  async fetch(request, env) {
+		    return new Response(\\"Hello from _worker.js. The meaning of life is \\" + MEANING_OF_LIFE);
+		  }
+		};
+		export {
+		  worker_default as default
+		};
+		//# sourceMappingURL=bundledWorker-0.test.mjs.map
+
+		------formdata-undici-0.test--"
+	`);
+		expect(std.err).toMatchInlineSnapshot(`""`);
+
+		await expect(
+			runWrangler(`pages functions build --build-output-directory=public`)
+		).rejects.toThrowError();
+		expect(std.err).toMatch(
+			/ENOENT: no such file or directory, scandir '.*functions'/
+		);
+	});
+
+	it("should include all external modules imported by _worker.js in the output bundle, when bundling _worker.js", async () => {
+		/* ---------------------------- */
+		/*       Set up wasm files      */
+		/* ---------------------------- */
+		mkdirSync("wasm");
+		writeFileSync("wasm/greeting.wasm", "Hello");
+		writeFileSync("wasm/name.wasm", "wasm _worker.js");
+
+		/* ---------------------------- */
+		/*       Set up _worker.js      */
+		/* ---------------------------- */
+		mkdirSync("public");
+		writeFileSync(
+			"public/_worker.js",
+			`
+import greeting from "./../wasm/greeting.wasm";
+import name from "./../wasm/name.wasm";
+
+export default {
+  async fetch(request, env) {
+    const greetingModule = await WebAssembly.instantiate(greeting);
+    const nameModule = await WebAssembly.instantiate(name);
+    return new Response(greetingModule.exports.hello + " " + nameModule.exports.name + "!");
+  },
+};`
+		);
+
+		/* --------------------------------- */
+		/*     Run cmd & make assertions     */
+		/* --------------------------------- */
+		await runWrangler(
+			`pages functions build --build-output-directory=public --experimental-worker-bundle=true`
+		);
+
+		// built to _worker.js by default
+		expect(existsSync("_worker.js")).toBe(true);
+		expect(std.out).toMatchInlineSnapshot(`
+		"🚧 'wrangler pages <command>' is a beta command. Please report any issues to https://github.com/cloudflare/workers-sdk/issues/new/choose
+		✨ Compiled Worker successfully"
+	`);
+
+		// some values in workerBundleContents, such as the undici form boundary
+		// or the file hashes, are randomly generated. Let's replace them
+		// with static values so we can test the file contents
+		const workerBundleContents = readFileSync("_worker.js", "utf-8");
+		const workerBundleWithConstantData = replaceRandomWithConstantData(
+			workerBundleContents,
+			[
+				[/------formdata-undici-0.[0-9]*/g, "------formdata-undici-0.test"],
+				[/bundledWorker-0.[0-9]*.mjs/g, "bundledWorker-0.test.mjs"],
+				[/[0-9a-z]*-greeting.wasm/g, "test-greeting.wasm"],
+				[/[0-9a-z]*-name.wasm/g, "test-name.wasm"],
+			]
+		);
+
+		// check we appended the metadata
+		expect(workerBundleWithConstantData).toContain(
+			`Content-Disposition: form-data; name="metadata"`
+		);
+		expect(workerBundleWithConstantData).toContain(
+			`{"main_module":"bundledWorker-0.test.mjs"}`
+		);
+
+		// check we appended the wasm modules
+		expect(workerBundleWithConstantData).toContain(
+			`Content-Disposition: form-data; name="./test-greeting.wasm"; filename="./test-greeting.wasm"`
+		);
+		expect(workerBundleWithConstantData).toContain(
+			`Content-Disposition: form-data; name="./test-name.wasm"; filename="./test-name.wasm"`
+		);
+		expect(workerBundleWithConstantData).toContain(`Hello`);
+		expect(workerBundleWithConstantData).toContain(`wasm _worker.js`);
+
+		expect(std.err).toMatchInlineSnapshot(`""`);
+	});
+
+	it("should build _worker.js over /functions, if both are present and the [--experimental-worker-bundle] flag is set", async () => {
+		/* ---------------------------- */
+		/*       Set up _worker.js      */
+		/* ---------------------------- */
+		mkdirSync("public");
+		writeFileSync(
+			"public/_worker.js",
+			`
+export default {
+  async fetch(request, env) {
+    return new Response("Hello from _worker.js");
+  },
+};`
+		);
+
+		/* ---------------------------- */
+		/*       Set up Functions       */
+		/* ---------------------------- */
+		mkdirSync("functions");
+		writeFileSync(
+			"functions/hello.js",
+			`
+    export async function onRequest() {
+      return new Response("Hello from Pages Functions");
+    }
+    `
+		);
+
+		/* --------------------------------- */
+		/*     Run cmd & make assertions     */
+		/* --------------------------------- */
+		await runWrangler(
+			`pages functions build --outfile=public/_worker.bundle --experimental-worker-bundle=true`
+		);
+
+		expect(existsSync("public/_worker.bundle")).toBe(true);
+		expect(std.out).toMatchInlineSnapshot(`
+		"🚧 'wrangler pages <command>' is a beta command. Please report any issues to https://github.com/cloudflare/workers-sdk/issues/new/choose
+		✨ Compiled Worker successfully"
+	`);
+
+		// some values in workerBundleContents, such as the undici form boundary
+		// or the file hashes, are randomly generated. Let's replace them
+		// with static values so we can test the file contents
+		const workerBundleContents = readFileSync("public/_worker.bundle", "utf-8");
+		const workerBundleWithConstantData = replaceRandomWithConstantData(
+			workerBundleContents,
+			[
+				[/------formdata-undici-0.[0-9]*/g, "------formdata-undici-0.test"],
+				[/bundledWorker-0.[0-9]*.mjs/g, "bundledWorker-0.test.mjs"],
+			]
+		);
+
+		expect(workerBundleWithConstantData).toMatchInlineSnapshot(`
+		"------formdata-undici-0.test
+		Content-Disposition: form-data; name=\\"metadata\\"
+
+		{\\"main_module\\":\\"bundledWorker-0.test.mjs\\"}
+		------formdata-undici-0.test
+		Content-Disposition: form-data; name=\\"bundledWorker-0.test.mjs\\"; filename=\\"bundledWorker-0.test.mjs\\"
+		Content-Type: application/javascript+module
+
+		// _worker.js
+		var worker_default = {
+		  async fetch(request, env) {
+		    return new Response(\\"Hello from _worker.js\\");
+		  }
+		};
+		export {
+		  worker_default as default
+		};
+		//# sourceMappingURL=bundledWorker-0.test.mjs.map
+
+		------formdata-undici-0.test--"
+	`);
+
+		expect(std.err).toMatchInlineSnapshot(`""`);
+	});
+});

package/src/__tests__/pages/pages.test.ts

@@ -0,0 +1,81 @@
+import { endEventLoop } from "../helpers/end-event-loop";
+import { mockConsoleMethods } from "../helpers/mock-console";
+import { runInTempDir } from "../helpers/run-in-tmp";
+import { runWrangler } from "../helpers/run-wrangler";
+
+describe("pages", () => {
+	const std = mockConsoleMethods();
+
+	runInTempDir();
+
+	afterEach(async () => {
+		// Force a tick to ensure that all promises resolve
+		await endEventLoop();
+	});
+
+	it("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:
+		  -j, --experimental-json-config  Experimental: Support wrangler.json  [boolean]
+		  -c, --config                    Path to .toml configuration file  [string]
+		  -e, --env                       Environment to use for operations and .env files  [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/workers-sdk/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 or a proxy port."`
+			);
+
+			expect(std.out).toMatchInlineSnapshot(`
+			        "🚧 'wrangler pages <command>' is a beta command. Please report any issues to https://github.com/cloudflare/workers-sdk/issues/new/choose
+
+			        If you think this is a bug then please create an issue at https://github.com/cloudflare/workers-sdk/issues/new/choose"
+		      `);
+		});
+
+		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/workers-sdk/issues/new/choose
+
+			        If you think this is a bug then please create an issue at https://github.com/cloudflare/workers-sdk/issues/new/choose"
+		      `);
+		});
+
+		it("should display for pages:functions:optimize-routes", async () => {
+			await expect(
+				runWrangler(
+					'pages functions optimize-routes --routes-path="/build/_routes.json" --output-routes-path="/build/_optimized-routes.json"'
+				)
+			).rejects.toThrowError();
+
+			expect(std.out).toMatchInlineSnapshot(`
+			        "🚧 'wrangler pages <command>' is a beta command. Please report any issues to https://github.com/cloudflare/workers-sdk/issues/new/choose
+
+			        If you think this is a bug then please create an issue at https://github.com/cloudflare/workers-sdk/issues/new/choose"
+		      `);
+		});
+	});
+});

package/src/__tests__/pages/project-create.test.ts

@@ -0,0 +1,63 @@
+import { rest } from "msw";
+import { endEventLoop } from "../helpers/end-event-loop";
+import { mockAccountId, mockApiToken } from "./../helpers/mock-account-id";
+import { mockConsoleMethods } from "./../helpers/mock-console";
+import { msw } from "./../helpers/msw";
+import { runInTempDir } from "./../helpers/run-in-tmp";
+import { runWrangler } from "./../helpers/run-wrangler";
+
+describe("project create", () => {
+	const std = mockConsoleMethods();
+
+	runInTempDir();
+	mockAccountId();
+	mockApiToken();
+
+	afterEach(async () => {
+		// Force a tick to ensure that all promises resolve
+		await endEventLoop();
+		// Reset MSW after tick to ensure that all requests have been handled
+		msw.resetHandlers();
+		msw.restoreHandlers();
+	});
+
+	it("should create a project with a production branch", async () => {
+		msw.use(
+			rest.post(
+				"*/accounts/:accountId/pages/projects",
+				async (req, res, ctx) => {
+					const body = await req.json();
+
+					expect(req.params.accountId).toEqual("some-account-id");
+					expect(body).toEqual({
+						name: "a-new-project",
+						production_branch: "main",
+					});
+
+					return res.once(
+						ctx.status(200),
+						ctx.json({
+							success: true,
+							errors: [],
+							messages: [],
+							result: {
+								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]'."
+        `);
+	});
+});

package/src/__tests__/pages/project-list.test.ts

@@ -0,0 +1,108 @@
+import { rest } from "msw";
+import { endEventLoop } from "../helpers/end-event-loop";
+import { mockAccountId, mockApiToken } from "./../helpers/mock-account-id";
+import { msw } from "./../helpers/msw";
+import { runInTempDir } from "./../helpers/run-in-tmp";
+import { runWrangler } from "./../helpers/run-wrangler";
+import type { Project } from "./../../pages/types";
+
+describe("project list", () => {
+	runInTempDir();
+	mockAccountId();
+	mockApiToken();
+
+	afterEach(async () => {
+		// Force a tick to ensure that all promises resolve
+		await endEventLoop();
+		// Reset MSW after tick to ensure that all requests have been handled
+		msw.resetHandlers();
+		msw.restoreHandlers();
+	});
+
+	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 = mockProjectListRequest(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 = mockProjectListRequest(projects);
+		await runWrangler("pages project list");
+		expect(requests.count).toEqual(2);
+	});
+});
+
+/* -------------------------------------------------- */
+/*                    Helper Functions                */
+/* -------------------------------------------------- */
+
+function mockProjectListRequest(projects: unknown[]) {
+	const requests = { count: 0 };
+	msw.use(
+		rest.get("*/accounts/:accountId/pages/projects", async (req, res, ctx) => {
+			requests.count++;
+			const pageSize = Number(req.url.searchParams.get("per_page"));
+			const page = Number(req.url.searchParams.get("page"));
+			const expectedPageSize = 10;
+			const expectedPage = requests.count;
+			expect(req.params.accountId).toEqual("some-account-id");
+			expect(pageSize).toEqual(expectedPageSize);
+			expect(page).toEqual(expectedPage);
+			expect(await req.text()).toEqual("");
+
+			return res(
+				ctx.status(200),
+				ctx.json({
+					success: true,
+					errors: [],
+					messages: [],
+					result: projects.slice((page - 1) * pageSize, page * pageSize),
+				})
+			);
+		})
+	);
+	return requests;
+}