wrangler 0.0.0-e178d6fb → 0.0.0-e1c2f5b9

package/src/__tests__/dialogs.test.tsx

@@ -0,0 +1,40 @@
+jest.unmock("../dialogs");
+import { fromDashMessagePrompt } from "../dialogs";
+import { CI } from "../is-ci";
+
+describe("fromDashMessagePrompt", () => {
+	it("should return undefined in CI when last deployed from api", async () => {
+		//in CI
+		jest.spyOn(CI, "isCI").mockReturnValue(true);
+		const result = await fromDashMessagePrompt("api");
+		expect(result).toBe(undefined);
+	});
+
+	it("should return undefined in CI when last deployed from wrangler", async () => {
+		//in CI
+		jest.spyOn(CI, "isCI").mockReturnValue(true);
+		const result = await fromDashMessagePrompt("wrangler");
+		expect(result).toBe(undefined);
+	});
+
+	it("should return true in CI when last deployed from dash", async () => {
+		//in CI
+		jest.spyOn(CI, "isCI").mockReturnValue(true);
+		const result = await fromDashMessagePrompt("dash");
+		expect(result).toBe(true);
+	});
+
+	it("should return undefined when last deployed from api", async () => {
+		//not in CI
+		jest.spyOn(CI, "isCI").mockReturnValue(false);
+		const result = await fromDashMessagePrompt("api");
+		expect(result).toBe(undefined);
+	});
+
+	it("should return undefined when last deployed from wrangler", async () => {
+		//not in CI
+		jest.spyOn(CI, "isCI").mockReturnValue(false);
+		const result = await fromDashMessagePrompt("wrangler");
+		expect(result).toBe(undefined);
+	});
+});

package/src/__tests__/generate.test.ts

@@ -0,0 +1,235 @@
+import fs from "node:fs";
+import path from "node:path";
+import { mockConsoleMethods } from "./helpers/mock-console";
+import { mockConfirm, clearConfirmMocks } from "./helpers/mock-dialogs";
+import { runInTempDir } from "./helpers/run-in-tmp";
+import { runWrangler } from "./helpers/run-wrangler";
+
+describe("generate", () => {
+	runInTempDir();
+	const std = mockConsoleMethods();
+
+	describe("cli functionality", () => {
+		afterEach(() => {
+			clearConfirmMocks();
+		});
+
+		it("defers to `wrangler init` when no template is given", async () => {
+			mockConfirm(
+				{
+					text: "Would you like to use git to manage this Worker?",
+					result: false,
+				},
+				{
+					text: "No package.json found. Would you like to create one?",
+					result: false,
+				}
+			);
+			await runWrangler("generate no-template");
+			expect(std.out).toMatchInlineSnapshot(
+				`"✨ Created no-template/wrangler.toml"`
+			);
+		});
+
+		it("complains when given the --type argument", async () => {
+			await expect(
+				runWrangler("generate worker-name worker-template --type rust")
+			).rejects.toThrowErrorMatchingInlineSnapshot(
+				`"The --type option is no longer supported."`
+			);
+		});
+
+		it("complains when given the --site argument", async () => {
+			await expect(runWrangler("generate worker-name worker-template --site"))
+				.rejects.toThrowErrorMatchingInlineSnapshot(`
+					"The --site option is no longer supported.
+					If you wish to create a brand new Worker Sites project then clone the \`worker-sites-template\` starter repository:
+
+					\`\`\`
+					git clone --depth=1 --branch=wrangler2 https://github.com/cloudflare/worker-sites-template worker-name
+					cd worker-name
+					\`\`\`
+
+					Find out more about how to create and maintain Sites projects at https://developers.cloudflare.com/workers/platform/sites.
+					Have you considered using Cloudflare Pages instead? See https://pages.cloudflare.com/."
+				`);
+		});
+
+		it.skip("auto-increments the worker directory name", async () => {
+			fs.mkdirSync("my-worker");
+
+			expect(fs.existsSync("my-worker-1")).toBe(false);
+
+			await expect(
+				runWrangler("generate my-worker worker-typescript")
+			).resolves.toBeUndefined();
+
+			expect(std.out).toStrictEqual(expect.stringContaining("my-worker-1"));
+
+			expect(readDirectory("my-worker-1")).toMatchObject<Directory>({
+				".git": expect.any(Object),
+				".gitignore": expect.any(String),
+				"README.md": expect.stringContaining("Template: worker-typescript"),
+				"jest.config.json": expect.any(String),
+				"package.json": expect.stringContaining("@cloudflare/workers-types"),
+				src: expect.objectContaining({ "index.ts": expect.any(String) }),
+				test: expect.objectContaining({
+					"index.test.ts": expect.any(String),
+				}),
+				"tsconfig.json": expect.any(String),
+				"wrangler.toml": expect.any(String),
+			});
+			expect(fs.existsSync("my-worker-2")).toBe(false);
+
+			await expect(
+				runWrangler("generate my-worker worker-typescript")
+			).resolves.toBeUndefined();
+
+			expect(std.out).toStrictEqual(expect.stringContaining("my-worker-2"));
+
+			expect(readDirectory("my-worker-2")).toMatchObject<Directory>({
+				".git": expect.any(Object),
+				".gitignore": expect.any(String),
+				"README.md": expect.stringContaining("Template: worker-typescript"),
+				"jest.config.json": expect.any(String),
+				"package.json": expect.stringContaining("@cloudflare/workers-types"),
+				src: expect.objectContaining({ "index.ts": expect.any(String) }),
+				test: expect.objectContaining({
+					"index.test.ts": expect.any(String),
+				}),
+				"tsconfig.json": expect.any(String),
+				"wrangler.toml": expect.any(String),
+			});
+		});
+	});
+
+	describe("cloning", () => {
+		it.skip("clones a cloudflare template with sparse checkouts", async () => {
+			await expect(
+				runWrangler("generate my-worker worker-typescript")
+			).resolves.toBeUndefined();
+
+			expect(readDirectory("my-worker")).toMatchObject<Directory>({
+				".git": expect.any(Object),
+				".gitignore": expect.any(String),
+				"README.md": expect.stringContaining("Template: worker-typescript"),
+				"jest.config.json": expect.any(String),
+				"package.json": expect.stringContaining("@cloudflare/workers-types"),
+				src: expect.objectContaining({ "index.ts": expect.any(String) }),
+				test: expect.objectContaining({
+					"index.test.ts": expect.any(String),
+				}),
+				"tsconfig.json": expect.any(String),
+				"wrangler.toml": expect.any(String),
+			});
+		});
+
+		// mocking out calls to either `isGitInstalled` or `execa("git", ["--version"])`
+		// 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 () => {
+			await expect(
+				runWrangler("generate my-worker caass/wrangler-generate-test-template")
+			).resolves.toBeUndefined();
+
+			expect(readDirectory("my-worker")).toMatchObject<Directory>({
+				".git": expect.any(Object),
+				".gitignore": expect.any(String),
+				"package.json": expect.stringContaining("@cloudflare/workers-types"),
+				src: expect.objectContaining({ "index.ts": expect.any(String) }),
+				"tsconfig.json": expect.any(String),
+				"wrangler.toml": expect.any(String),
+			});
+		});
+
+		it.skip("clones a user/repo/path/to/subdirectory template", async () => {
+			await expect(
+				runWrangler("generate my-worker cloudflare/templates/worker-typescript")
+			).resolves.toBeUndefined();
+
+			expect(readDirectory("my-worker")).toMatchObject<Directory>({
+				".git": expect.any(Object),
+				".gitignore": expect.any(String),
+				"README.md": expect.stringContaining("Template: worker-typescript"),
+				"jest.config.json": expect.any(String),
+				"package.json": expect.stringContaining("@cloudflare/workers-types"),
+				src: expect.objectContaining({ "index.ts": expect.any(String) }),
+				test: expect.objectContaining({
+					"index.test.ts": expect.any(String),
+				}),
+				"tsconfig.json": expect.any(String),
+				"wrangler.toml": expect.any(String),
+			});
+		});
+
+		it.skip("clones a git@github.com/user/repo template", async () => {
+			await expect(
+				runWrangler(
+					"generate my-worker git@github.com:caass/wrangler-generate-test-template"
+				)
+			).resolves.toBeUndefined();
+
+			expect(readDirectory("my-worker")).toMatchObject<Directory>({
+				".git": expect.any(Object),
+				".gitignore": expect.any(String),
+				"package.json": expect.stringContaining("@cloudflare/workers-types"),
+				src: expect.objectContaining({ "index.ts": expect.any(String) }),
+				"tsconfig.json": expect.any(String),
+				"wrangler.toml": expect.any(String),
+			});
+		});
+
+		it.skip("clones a git@github.com/user/repo/path/to/subdirectory template", async () => {
+			await expect(
+				runWrangler(
+					"generate my-worker git@github.com:cloudflare/templates/worker-typescript"
+				)
+			).resolves.toBeUndefined();
+
+			expect(readDirectory("my-worker")).toMatchObject<Directory>({
+				".git": expect.any(Object),
+				".gitignore": expect.any(String),
+				"README.md": expect.stringContaining("Template: worker-typescript"),
+				"jest.config.json": expect.any(String),
+				"package.json": expect.stringContaining("@cloudflare/workers-types"),
+				src: expect.objectContaining({ "index.ts": expect.any(String) }),
+				test: expect.objectContaining({
+					"index.test.ts": expect.any(String),
+				}),
+				"tsconfig.json": expect.any(String),
+				"wrangler.toml": expect.any(String),
+			});
+		});
+	});
+});
+
+type FileName = string;
+type FileContents = string;
+type Directory = { [key: FileName]: FileContents | Directory };
+
+function readDirectory(directoryPath: string): Directory {
+	if (!fs.existsSync(directoryPath)) {
+		throw new Error(`${directoryPath} does not exist!`);
+	}
+
+	if (!fs.lstatSync(directoryPath).isDirectory()) {
+		throw new Error(`${directoryPath} is not a directory!`);
+	}
+
+	return fs
+		.readdirSync(directoryPath, { withFileTypes: true })
+		.reduce((output, child) => {
+			const childPath = path.join(directoryPath, child.name);
+
+			if (child.isDirectory()) {
+				output[child.name] = readDirectory(childPath);
+			} else if (child.isFile()) {
+				output[child.name] = fs.readFileSync(childPath, { encoding: "utf-8" });
+			} else {
+				throw new Error(`${childPath} was not a file or directory!`);
+			}
+
+			return output;
+		}, {} as Directory);
+}

package/src/__tests__/get-host-from-url.test.ts

@@ -0,0 +1,16 @@
+import { getHostFromUrl } from "../zones";
+
+//return the host given a url-like string
+describe("getHostFromUrl", () => {
+	it("should return the host from a url", () => {
+		expect(getHostFromUrl("https://www.example.com")).toBe("www.example.com");
+	});
+
+	it("should return the host from a url using wildcard *.", () => {
+		expect(getHostFromUrl("*.example.com")).toBe("example.com");
+	});
+
+	it("should return the host from a url using wildcard *", () => {
+		expect(getHostFromUrl("*example.com")).toBe("example.com");
+	});
+});

package/src/__tests__/helpers/mock-auth-domain.ts

@@ -0,0 +1,20 @@
+const ORIGINAL_WRANGLER_AUTH_DOMAIN = process.env.WRANGLER_AUTH_DOMAIN;
+
+/**
+ * Mock the Auth URL domain so that we can control where we attempt to login.
+ *
+ * Note that you can remove any API token from the environment by setting the value to `null`.
+ * This is useful if a higher `describe()` block has already called `mockAuthDomain()`.
+ */
+export function mockAuthDomain({ domain }: { domain: string | null }) {
+	beforeEach(() => {
+		if (domain === null) {
+			delete process.env.WRANGLER_AUTH_DOMAIN;
+		} else {
+			process.env.WRANGLER_AUTH_DOMAIN = domain;
+		}
+	});
+	afterEach(() => {
+		process.env.WRANGLER_AUTH_DOMAIN = ORIGINAL_WRANGLER_AUTH_DOMAIN;
+	});
+}

package/src/__tests__/helpers/mock-cfetch.ts

@@ -1,8 +1,36 @@
+import { Readable } from "node:stream";
 import { URL, URLSearchParams } from "node:url";
 import { pathToRegexp } from "path-to-regexp";
-import { getCloudflareApiBaseUrl } from "../../cfetch";
+import { Response } from "undici";
+import { getCloudflareApiBaseUrl } from "../../environment-variables/misc-variables";
 import type { FetchResult, FetchError } from "../../cfetch";
-import type { RequestInit } from "undici";
+import type {
+	fetchInternal,
+	fetchR2Objects,
+	performApiFetch,
+} from "../../cfetch/internal";
+import type { RequestInit, BodyInit, HeadersInit } from "undici";
+
+/**
+ * When the custom mocks fallthrough in tests because they aren't set, instead of throwing an error,
+ * we use real fetch to make the request which will use Mock Service Workers.
+ */
+const {
+	fetchInternal: realFetchInternal,
+}: { fetchInternal: typeof fetchInternal } = jest.requireActual(
+	"../../cfetch/internal"
+);
+const {
+	fetchR2Objects: realFetchR2Objects,
+}: { fetchR2Objects: typeof fetchR2Objects } = jest.requireActual(
+	"../../cfetch/internal"
+);
+
+const {
+	performApiFetch: realPerformApiFetch,
+}: { performApiFetch: typeof performApiFetch } = jest.requireActual(
+	"../../cfetch/internal"
+);
 
 /**
  * The signature of the function that will handle a mock request.
@@ -32,7 +60,7 @@ const mocks: MockFetch<unknown>[] = [];
 export async function mockFetchInternal(
 	resource: string,
 	init: RequestInit = {},
-	queryParams: URLSearchParams = new URLSearchParams()
+	queryParams: URLSearchParams | undefined
 ) {
 	for (const { regexp, method, handler } of mocks) {
 		const resourcePath = new URL(resource, getCloudflareApiBaseUrl()).pathname;
@@ -41,14 +69,22 @@ export async function mockFetchInternal(
 		if (uri !== null && (!method || method === (init.method ?? "GET"))) {
 			// The `resource` regular expression will extract the labelled groups from the URL.
 			// These are passed through to the `handler` call, to allow it to do additional checks or behaviour.
-			return await handler(uri, init, queryParams); // TODO: should we have some kind of fallthrough system? we'll see.
+			return await handler(uri, init, queryParams ?? new URLSearchParams()); // TODO: should we have some kind of fallthrough system? we'll see.
 		}
 	}
-	throw new Error(
-		`no mocks found for ${init.method ?? "any HTTP"} request to ${resource}`
-	);
+
+	// let it fall through to mock-service-worker
+	// (do a real, unmocked fetch)
+	return await realFetchInternal(resource, init, queryParams);
 }
 
+/**
+ * We don't have loads of infrastructure around performApiFetch
+ * the same way we do for cfetch, so we'll just pass off the real
+ * deal to avoid getting it auto-mocked, so that msw can catch it.
+ */
+export const mockPerformApiFetch = realPerformApiFetch;
+
 /**
  * Specify an expected resource path that is to be handled, resulting in a raw JSON response.
  *
@@ -180,32 +216,62 @@ export function unsetAllMocks() {
  */
 
 const kvGetMocks = new Map<string, string | Buffer>();
+const r2GetMocks = new Map<string, string | undefined>();
+const dashScriptMocks = new Map<string, string | undefined>();
 
 /**
- * @mocked typeof fetchKVGetValue
+ * @mocked typeof fetchR2Objects
  */
-export function mockFetchKVGetValue(
-	accountId: string,
-	namespaceId: string,
-	key: string
-) {
-	const mapKey = `${accountId}/${namespaceId}/${key}`;
-	if (kvGetMocks.has(mapKey)) {
-		const value = kvGetMocks.get(mapKey);
-		if (value !== undefined) return Promise.resolve(value);
+export async function mockFetchR2Objects(
+	resource: string,
+	bodyInit: {
+		body: BodyInit | Readable;
+		headers: HeadersInit | undefined;
+		method: "PUT" | "GET" | "DELETE";
+	}
+): Promise<Response> {
+	if (r2GetMocks.has(resource)) {
+		/**
+		 * Here we destroy & removeListeners to "drain" the stream, for testing purposes
+		 * mimicking the fetch request taking in the stream and draining it.
+		 */
+		if (bodyInit.body instanceof Readable) {
+			bodyInit.body.destroy();
+			bodyInit.body.removeAllListeners();
+		}
+
+		const value = r2GetMocks.get(resource);
+
+		return new Response(value);
 	}
-	throw new Error(`no mock value found for \`kv:key get\` - ${mapKey}`);
+
+	// No mocks found for ${init.method ?? "any HTTP"} request to ${resource}
+	// let it fall through to Mock Service Worker with a real fetch.
+	return await realFetchR2Objects(resource, bodyInit);
 }
 
-export function setMockFetchKVGetValue(
-	accountId: string,
-	namespaceId: string,
-	key: string,
-	value: string | Buffer
-) {
-	kvGetMocks.set(`${accountId}/${namespaceId}/${key}`, value);
+/**
+ * Mock setter for usage within test blocks, companion helper to `mockFetchR2Objects`
+ */
+export function setMockFetchR2Objects({
+	accountId,
+	bucketName,
+	objectName,
+	mockResponse,
+}: {
+	accountId: string;
+	bucketName: string;
+	objectName: string;
+	mockResponse?: string;
+}) {
+	r2GetMocks.set(
+		`/accounts/${accountId}/r2/buckets/${bucketName}/objects/${objectName}`,
+		mockResponse
+	);
 }
 
-export function unsetMockFetchKVGetValues() {
+export function unsetSpecialMockFns() {
 	kvGetMocks.clear();
+	r2GetMocks.clear();
+	dashScriptMocks.clear();
 }

package/src/__tests__/helpers/mock-console.ts

@@ -29,7 +29,9 @@ const std = {
 function normalizeOutput(spy: jest.SpyInstance): string {
 	return normalizeErrorMarkers(
 		replaceByte(
-			stripTrailingWhitespace(normalizeSlashes(stripTimings(captureCalls(spy))))
+			stripTrailingWhitespace(
+				normalizeSlashes(normalizeTempDirs(stripTimings(captureCalls(spy))))
+			)
 		)
 	);
 }
@@ -93,5 +95,12 @@ export function stripTrailingWhitespace(str: string): string {
  * variation causing every few tests the value to change by ± .01
  */
 function replaceByte(stdout: string): string {
-	return stdout.replaceAll(/.[0-9][0-9] KiB/g, "xx KiB");
+	return stdout.replaceAll(/\d+\.\d+ KiB/g, "xx KiB");
+}
+
+/**
+ * Temp directories are created with random names, so we replace all comments temp dirs in them
+ */
+export function normalizeTempDirs(stdout: string): string {
+	return stdout.replaceAll(/\/\/.+\/tmp.+/g, "//tmpdir");
 }

package/src/__tests__/helpers/mock-dialogs.ts

@@ -78,7 +78,7 @@ export function mockPrompt(...expectations: PromptExpectation[]) {
 					return Promise.resolve(expectation.result);
 				}
 			}
-			throw new Error(`Unexpected confirmation message: ${text}`);
+			throw new Error(`Unexpected prompt message: ${text}`);
 		}
 	);
 	return () => {

package/src/__tests__/helpers/mock-get-zone-from-host.ts

@@ -0,0 +1,8 @@
+import { setMockResponse } from "./mock-cfetch";
+
+export function mockGetZoneFromHostRequest(host: string, zone?: string) {
+	setMockResponse("/zones", (_uri, _init, queryParams) => {
+		expect(queryParams.get("name")).toEqual(host);
+		return zone ? [{ id: zone }] : [];
+	});
+}

package/src/__tests__/helpers/mock-known-routes.ts

@@ -0,0 +1,7 @@
+import { setMockResponse } from "./mock-cfetch";
+
+export function mockCollectKnownRoutesRequest(
+	routes: { pattern: string; script: string }[]
+) {
+	setMockResponse(`/zones/:zoneId/workers/routes`, "GET", () => routes);
+}

package/src/__tests__/helpers/mock-kv.ts

@@ -1,5 +1,5 @@
 import { createFetchResult, setMockRawResponse } from "./mock-cfetch";
-import type { NamespaceKeyInfo } from "../../kv";
+import type { NamespaceKeyInfo } from "../../kv/helpers";
 
 export function mockKeyListRequest(
 	expectedNamespaceId: string,