wrangler 2.9.0 → 2.9.1

package/miniflare-dist/index.mjs

@@ -669,7 +669,7 @@ async function generateHandler({
         return new HTMLRewriter().on("body", {
           element(e) {
             e.append(
-              `<!-- Cloudflare Pages Analytics --><script defer src='https://static.cloudflareinsights.com/beacon.min.js' data-cf-beacon='{"token": "${metadata.analytics?.token}"}'><\/script><!-- Cloudflare Pages Analytics -->`,
+              `<!-- Cloudflare Pages Analytics --><script defer src='https://static.cloudflareinsights.com/beacon.min.js' data-cf-beacon='{"token": "${metadata.analytics?.token}"}'></script><!-- Cloudflare Pages Analytics -->`,
               { html: true }
             );
           }
@@ -6349,16 +6349,3 @@ async function main() {
   }
 }
 await main();
-/**
- * @fileoverview Main entrypoint for libraries using yargs-parser in Node.js
- * CJS and ESM environments.
- *
- * @license
- * Copyright (c) 2016, Contributors
- * SPDX-License-Identifier: ISC
- */
-/**
- * @license
- * Copyright (c) 2016, Contributors
- * SPDX-License-Identifier: ISC
- */

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "wrangler",
-	"version": "2.9.0",
+	"version": "2.9.1",
 	"description": "Command-line interface for all things Cloudflare Workers",
 	"keywords": [
 		"wrangler",
@@ -105,7 +105,7 @@
 		"@miniflare/durable-objects": "2.11.0",
 		"blake3-wasm": "^2.1.5",
 		"chokidar": "^3.5.3",
-		"esbuild": "0.14.51",
+		"esbuild": "0.16.3",
 		"miniflare": "2.11.0",
 		"nanoid": "^3.3.3",
 		"path-to-regexp": "^6.2.0",

package/src/__tests__/d1/d1.test.ts

@@ -1,11 +1,8 @@
+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";
 
-function endEventLoop() {
-	return new Promise((resolve) => setImmediate(resolve));
-}
-
 describe("d1", () => {
 	const std = mockConsoleMethods();
 	runInTempDir();

package/src/__tests__/d1/migrate.test.ts

@@ -1,4 +1,6 @@
 import { cwd } from "process";
+import { reinitialiseAuthTokens } from "../../user";
+import { mockAccountId, mockApiToken } from "../helpers/mock-account-id";
 import { useMockIsTTY } from "../helpers/mock-istty";
 import { runInTempDir } from "../helpers/run-in-tmp";
 import { runWrangler } from "../helpers/run-wrangler";
@@ -8,6 +10,21 @@ describe("migrate", () => {
 	runInTempDir();
 	const { setIsTTY } = useMockIsTTY();
 
+	describe("create", () => {
+		it("should reject the --local flag for create", async () => {
+			setIsTTY(false);
+			writeWranglerToml({
+				d1_databases: [
+					{ binding: "DATABASE", database_name: "db", database_id: "xxxx" },
+				],
+			});
+
+			await expect(
+				runWrangler("d1 migrations create test some-message --local DATABASE")
+			).rejects.toThrowError(`Unknown argument: local`);
+		});
+	});
+
 	describe("apply", () => {
 		it("should not attempt to login in local mode", async () => {
 			setIsTTY(false);
@@ -45,4 +62,80 @@ describe("migrate", () => {
 			);
 		});
 	});
+
+	describe("list", () => {
+		mockAccountId();
+		mockApiToken({ apiToken: null });
+
+		it("should not attempt to login in local mode", async () => {
+			setIsTTY(false);
+			writeWranglerToml({
+				d1_databases: [
+					{ binding: "DATABASE", database_name: "db", database_id: "xxxx" },
+				],
+			});
+			// If we get to the point where we are checking for migrations then we have not been asked to log in.
+			await expect(
+				runWrangler("d1 migrations list --local DATABASE")
+			).rejects.toThrowError(
+				`No migrations present at ${cwd().replaceAll("\\", "/")}/migrations.`
+			);
+		});
+
+		it("should use the custom migrations folder when provided", async () => {
+			setIsTTY(false);
+			writeWranglerToml({
+				d1_databases: [
+					{
+						binding: "DATABASE",
+						database_name: "db",
+						database_id: "xxxx",
+						migrations_dir: "my-migrations-go-here",
+					},
+				],
+			});
+			await expect(
+				runWrangler("d1 migrations list --local DATABASE")
+			).rejects.toThrowError(
+				`No migrations present at ${cwd().replaceAll(
+					"\\",
+					"/"
+				)}/my-migrations-go-here.`
+			);
+		});
+
+		it("should try to read D1 config from wrangler.toml when logged in", async () => {
+			// no need to clear this env var as it's implicitly cleared by mockApiToken in afterEach
+			process.env.CLOUDFLARE_API_TOKEN = "api-token";
+			reinitialiseAuthTokens();
+			setIsTTY(false);
+			writeWranglerToml();
+			await expect(
+				runWrangler("d1 migrations list DATABASE")
+			).rejects.toThrowError(
+				"Can't find a DB with name/binding 'DATABASE' in local config. Check info in wrangler.toml..."
+			);
+		});
+
+		it("should throw if user is not authenticated and not using --local", async () => {
+			setIsTTY(false);
+
+			await expect(
+				runWrangler("d1 migrations list DATABASE")
+			).rejects.toThrowError(
+				"In a non-interactive environment, it's necessary to set a CLOUDFLARE_API_TOKEN environment variable for wrangler to work"
+			);
+		});
+
+		it("should not try to read wrangler.toml in local mode", async () => {
+			setIsTTY(false);
+			writeWranglerToml();
+			// If we get to the point where we are checking for migrations then we have not checked wrangler.toml.
+			await expect(
+				runWrangler("d1 migrations list --local DATABASE")
+			).rejects.toThrowError(
+				`No migrations present at ${cwd().replaceAll("\\", "/")}/migrations.`
+			);
+		});
+	});
 });

package/src/__tests__/generate.test.ts

@@ -131,7 +131,7 @@ describe("generate", () => {
 		// was harder than i thought, leaving this for now.
 		it.todo("clones a cloudflare template with full checkouts");
 
-		it("clones a user/repo template", async () => {
+		it.skip("clones a user/repo template", async () => {
 			await expect(
 				runWrangler("generate my-worker caass/wrangler-generate-test-template")
 			).resolves.toBeUndefined();

package/src/__tests__/helpers/end-event-loop.ts

@@ -0,0 +1,6 @@
+/**
+ * Forces a tick and ensures that all pending promises resolve
+ */
+export function endEventLoop() {
+	return new Promise((resolve) => setImmediate(resolve));
+}

package/src/__tests__/helpers/mock-get-pages-upload-token.ts

@@ -0,0 +1,25 @@
+import { rest } from "msw";
+import { msw } from "./msw";
+
+/**
+ * Mocks the `/accounts/:accountId/pages/projects/:projectName/upload-token` GET request
+ */
+export function mockGetUploadTokenRequest(
+	jwt: string,
+	accountId: string,
+	projectName: string
+) {
+	msw.use(
+		rest.get(
+			`*/accounts/:accountId/pages/projects/${projectName}/upload-token`,
+			(req, res, ctx) => {
+				expect(req.params.accountId).toEqual(accountId);
+
+				return res(
+					ctx.status(200),
+					ctx.json({ success: true, errors: [], messages: [], result: { jwt } })
+				);
+			}
+		)
+	);
+}

package/src/__tests__/helpers/mock-set-timeout.ts

@@ -0,0 +1,16 @@
+let setTimeoutSpy: jest.SpyInstance;
+
+export function mockSetTimeout() {
+	beforeEach(() => {
+		setTimeoutSpy = jest
+			.spyOn(global, "setTimeout")
+			// @ts-expect-error we're using a very simple setTimeout mock here
+			.mockImplementation((fn, _period) => {
+				setImmediate(fn);
+			});
+	});
+
+	afterEach(() => {
+		setTimeoutSpy.mockRestore();
+	});
+}

package/src/__tests__/index.test.ts

@@ -1,4 +1,5 @@
 import { getPackageManager } from "../package-manager";
+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";
@@ -269,7 +270,3 @@ describe("wrangler", () => {
 	`);
 	});
 });
-
-function endEventLoop() {
-	return new Promise((resolve) => setImmediate(resolve));
-}

package/src/__tests__/init.test.ts

@@ -1392,7 +1392,7 @@ describe("init", () => {
 						contents: {
 							config: {
 								compilerOptions: expect.objectContaining({
-									types: ["@cloudflare/workers-types", "jest"],
+									types: ["@cloudflare/workers-types", "vitest"],
 								}),
 							},
 							error: undefined,

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

@@ -0,0 +1,78 @@
+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 { Deployment } from "./../../pages/types";
+
+describe("deployment 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 deployments", async () => {
+		const deployments: Deployment[] = [
+			{
+				id: "87bbc8fe-16be-45cd-81e0-63d722e82cdf",
+				url: "https://87bbc8fe.images.pages.dev",
+				environment: "preview",
+				created_on: "2021-11-17T14:52:26.133835Z",
+				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 = mockDeploymentListRequest(deployments);
+		await runWrangler("pages deployment list --project-name=images");
+
+		expect(requests.count).toBe(1);
+	});
+});
+
+/* -------------------------------------------------- */
+/*                    Helper Functions                */
+/* -------------------------------------------------- */
+
+function mockDeploymentListRequest(deployments: unknown[]) {
+	const requests = { count: 0 };
+	msw.use(
+		rest.get(
+			"*/accounts/:accountId/pages/projects/:project/deployments",
+			(req, res, ctx) => {
+				requests.count++;
+
+				expect(req.params.project).toEqual("images");
+				expect(req.params.accountId).toEqual("some-account-id");
+
+				return res.once(
+					ctx.status(200),
+					ctx.json({
+						success: true,
+						errors: [],
+						messages: [],
+						result: deployments,
+					})
+				);
+			}
+		)
+	);
+	return requests;
+}

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/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 or a proxy port."`
+			);
+
+			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/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/wrangler2/issues/new/choose
+
+			        If you think this is a bug then please create an issue at https://github.com/cloudflare/wrangler2/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/wrangler2/issues/new/choose
+
+			        If you think this is a bug then please create an issue at https://github.com/cloudflare/wrangler2/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;
+}