wrangler 2.0.23 → 2.0.24

package/src/__tests__/generate.test.ts

@@ -0,0 +1,93 @@
+import fs from "node:fs";
+import path from "node:path";
+import process from "node:process";
+import { setup } from "create-cloudflare";
+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";
+
+const createCloudflareMock = setup as jest.Mock;
+
+describe("generate", () => {
+	runInTempDir();
+	const std = mockConsoleMethods();
+
+	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("runs `create-cloudflare` when a template is given", async () => {
+		await expect(
+			runWrangler("generate my-worker some-template")
+		).resolves.toBeUndefined();
+
+		expect(createCloudflareMock).toBeCalled();
+	});
+
+	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("auto-increments the worker directory name", async () => {
+		fs.mkdirSync("my-worker");
+		await expect(
+			runWrangler("generate my-worker some-template")
+		).resolves.toBeUndefined();
+
+		expect(createCloudflareMock).lastCalledWith(
+			path.resolve(process.cwd(), "my-worker-1"),
+			"some-template",
+			{ debug: false, force: false, init: true }
+		);
+
+		fs.mkdirSync("my-worker-1");
+
+		await expect(
+			runWrangler("generate my-worker some-template")
+		).resolves.toBeUndefined();
+
+		expect(createCloudflareMock).lastCalledWith(
+			path.resolve(process.cwd(), "my-worker-2"),
+			"some-template",
+			{ debug: false, force: false, init: true }
+		);
+	});
+});

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

@@ -1,8 +1,10 @@
+import { Readable } from "node:stream";
 import { URL, URLSearchParams } from "node:url";
 import { pathToRegexp } from "path-to-regexp";
+import { Response } from "undici";
 import { getCloudflareApiBaseUrl } from "../../cfetch";
 import type { FetchResult, FetchError } from "../../cfetch";
-import type { RequestInit } from "undici";
+import type { RequestInit, BodyInit, HeadersInit } from "undici";
 
 /**
  * The signature of the function that will handle a mock request.
@@ -180,6 +182,7 @@ export function unsetAllMocks() {
  */
 
 const kvGetMocks = new Map<string, string | Buffer>();
+const r2GetMocks = new Map<string, string | undefined>();
 
 /**
  * @mocked typeof fetchKVGetValue
@@ -206,6 +209,55 @@ export function setMockFetchKVGetValue(
 	kvGetMocks.set(`${accountId}/${namespaceId}/${key}`, value);
 }
 
-export function unsetMockFetchKVGetValues() {
+/**
+ * @mocked typeof fetchR2Objects
+ */
+export async function mockFetchR2Objects(
+	resource: string,
+	bodyInit: {
+		body: BodyInit | Readable;
+		headers: HeadersInit | undefined;
+		method: "PUT" | "GET";
+	}
+): Promise<Response> {
+	/**
+	 * 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();
+	}
+
+	if (r2GetMocks.has(resource)) {
+		const value = r2GetMocks.get(resource);
+
+		return new Response(value);
+	}
+	throw new Error(`no expected mock found for \`r2 object get\` - ${resource}`);
+}
+
+/**
+ * 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 unsetSpecialMockFns() {
 	kvGetMocks.clear();
+	r2GetMocks.clear();
 }

package/src/__tests__/index.test.ts

@@ -203,36 +203,19 @@ describe("wrangler", () => {
 			await runWrangler("r2");
 			await endEventLoop();
 			expect(std.out).toMatchInlineSnapshot(`
-			        "wrangler r2
+			"wrangler r2
 
-			        📦 Interact with an R2 store
+			📦 Interact with an R2 store
 
-			        Commands:
-			          wrangler r2 bucket  Manage R2 buckets
-
-			        Flags:
-			          -c, --config   Path to .toml configuration file  [string]
-			          -h, --help     Show help  [boolean]
-			          -v, --version  Show version number  [boolean]"
-		      `);
-		});
-	});
+			Commands:
+			  wrangler r2 object  Manage R2 objects
+			  wrangler r2 bucket  Manage R2 buckets
 
-	describe("Deprecated commands", () => {
-		it("should print a deprecation message for 'generate'", async () => {
-			await runWrangler("generate").catch((err) => {
-				expect(err.message).toMatchInlineSnapshot(`
-			          "Deprecation:
-			          \`wrangler generate\` has been deprecated.
-			          Try running \`wrangler init\` to generate a basic Worker, or cloning the template repository instead:
-
-			          \`\`\`
-			          git clone https://github.com/cloudflare/worker-template
-			          \`\`\`
-
-			          Please refer to https://developers.cloudflare.com/workers/wrangler/deprecations/#generate for more information."
-		        `);
-			});
+			Flags:
+			  -c, --config   Path to .toml configuration file  [string]
+			  -h, --help     Show help  [boolean]
+			  -v, --version  Show version number  [boolean]"
+		`);
 		});
 	});
 

package/src/__tests__/jest.setup.ts

@@ -2,10 +2,15 @@ import fetchMock from "jest-fetch-mock";
 import {
 	fetchInternal,
 	fetchKVGetValue,
+	fetchR2Objects,
 	getCloudflareAPIBaseURL,
 } from "../cfetch/internal";
 import { confirm, prompt } from "../dialogs";
-import { mockFetchInternal, mockFetchKVGetValue } from "./helpers/mock-cfetch";
+import {
+	mockFetchInternal,
+	mockFetchKVGetValue,
+	mockFetchR2Objects,
+} from "./helpers/mock-cfetch";
 import { MockWebSocket } from "./helpers/mock-web-socket";
 
 // Mock out getPort since we don't actually care about what ports are open in unit tests.
@@ -43,6 +48,7 @@ jest.mock("../cfetch/internal");
 (getCloudflareAPIBaseURL as jest.Mock).mockReturnValue(
 	"https://api.cloudflare.com/client/v4"
 );
+(fetchR2Objects as jest.Mock).mockImplementation(mockFetchR2Objects);
 
 jest.mock("../dialogs");
 
@@ -118,3 +124,27 @@ jest.mock("xdg-app-paths", () => {
 		}),
 	};
 });
+
+jest.mock("create-cloudflare");
+
+jest.mock("../metrics/metrics-config", () => {
+	const realModule = jest.requireActual("../metrics/metrics-config");
+	const fakeModule = {
+		...realModule,
+		// Although we mock out the getMetricsConfig() function in most tests,
+		// we need a way to reinstate it for the metrics specific tests.
+		// This is what `useOriginal` is for.
+		useOriginal: false,
+		getMetricsConfig: (...args: unknown[]) =>
+			fakeModule.useOriginal
+				? realModule.getMetricsConfig(...args)
+				: async () => {
+						return {
+							enabled: false,
+							deviceId: "mock-device",
+							userId: undefined,
+						};
+				  },
+	};
+	return fakeModule;
+});

package/src/__tests__/kv.test.ts

@@ -4,7 +4,7 @@ import { mockAccountId, mockApiToken } from "./helpers/mock-account-id";
 import {
 	setMockResponse,
 	unsetAllMocks,
-	unsetMockFetchKVGetValues,
+	unsetSpecialMockFns,
 	setMockFetchKVGetValue,
 	setMockRawResponse,
 	createFetchResult,
@@ -924,7 +924,7 @@ describe("wrangler", () => {
 
 		describe("get", () => {
 			afterEach(() => {
-				unsetMockFetchKVGetValues();
+				unsetSpecialMockFns();
 			});
 
 			it("should get a key in a given namespace specified by namespace-id", async () => {

package/src/__tests__/metrics.test.ts

@@ -26,6 +26,9 @@ describe("metrics", () => {
 	runInTempDir();
 
 	beforeEach(() => {
+		// Tell jest to use the original version of the `getMetricsConfig()` function in these tests.
+		const mockMetricsConfig = jest.requireMock("../metrics/metrics-config");
+		mockMetricsConfig.useOriginal = true;
 		global.SPARROW_SOURCE_KEY = "MOCK_KEY";
 		logger.loggerLevel = "debug";
 		// Create a node_modules directory to store config-cache files
@@ -65,6 +68,7 @@ describe("metrics", () => {
 						properties: {
 							category: "Workers",
 							wranglerVersion,
+							os: process.platform + ":" + process.arch,
 							a: 1,
 							b: 2,
 						},
@@ -139,6 +143,7 @@ describe("metrics", () => {
 						properties: {
 							category: "Workers",
 							wranglerVersion,
+							os: process.platform + ":" + process.arch,
 							a: 1,
 							b: 2,
 						},