wrangler 2.0.16 → 2.0.19

package/src/__tests__/metrics.test.ts

@@ -0,0 +1,415 @@
+import { mkdirSync } from "node:fs";
+import fetchMock from "jest-fetch-mock";
+import { version as wranglerVersion } from "../../package.json";
+import { purgeConfigCaches, saveToConfigCache } from "../config-cache";
+import { logger } from "../logger";
+import { getMetricsDispatcher, getMetricsConfig } from "../metrics";
+import {
+	CURRENT_METRICS_DATE,
+	readMetricsConfig,
+	USER_ID_CACHE_PATH,
+	writeMetricsConfig,
+} from "../metrics/metrics-config";
+import { writeAuthConfigFile } from "../user";
+import { setMockResponse, unsetAllMocks } from "./helpers/mock-cfetch";
+import { mockConsoleMethods } from "./helpers/mock-console";
+import { mockConfirm } from "./helpers/mock-dialogs";
+import { useMockIsTTY } from "./helpers/mock-istty";
+import { runInTempDir } from "./helpers/run-in-tmp";
+
+declare const global: { SPARROW_SOURCE_KEY: string | undefined };
+
+describe("metrics", () => {
+	const ORIGINAL_SPARROW_SOURCE_KEY = global.SPARROW_SOURCE_KEY;
+	const std = mockConsoleMethods();
+	runInTempDir();
+
+	beforeEach(() => {
+		global.SPARROW_SOURCE_KEY = "MOCK_KEY";
+		logger.loggerLevel = "debug";
+		// Create a node_modules directory to store config-cache files
+		mkdirSync("node_modules");
+	});
+	afterEach(() => {
+		global.SPARROW_SOURCE_KEY = ORIGINAL_SPARROW_SOURCE_KEY;
+		fetchMock.resetMocks();
+		unsetAllMocks();
+		purgeConfigCaches();
+	});
+
+	describe("getMetricsDispatcher()", () => {
+		const MOCK_DISPATCHER_OPTIONS = {
+			// By setting this to true we avoid the `getMetricsConfig()` logic in these tests.
+			sendMetrics: true,
+			offline: false,
+		};
+
+		// These tests should never hit the `/user` API endpoint.
+		const userRequests = mockUserRequest();
+		afterEach(() => {
+			expect(userRequests.count).toBe(0);
+		});
+
+		describe("identify()", () => {
+			it("should send a request to the default URL", async () => {
+				const dispatcher = await getMetricsDispatcher(MOCK_DISPATCHER_OPTIONS);
+				fetchMock.mockResponse("");
+				await dispatcher.identify({ a: 1, b: 2 });
+				expect(fetchMock).toHaveBeenCalledTimes(1);
+				const [url, { body, headers }] = fetchMock.mock.calls[0];
+				expect(url).toEqual("https://sparrow.cloudflare.com/api/v1/identify");
+				expect(JSON.parse(body)).toEqual(
+					expect.objectContaining({
+						event: "identify",
+						properties: {
+							category: "Workers",
+							wranglerVersion,
+							a: 1,
+							b: 2,
+						},
+					})
+				);
+				expect(headers).toEqual(
+					expect.objectContaining({
+						"Sparrow-Source-Key": "MOCK_KEY",
+					})
+				);
+				expect(std.debug).toMatchInlineSnapshot(
+					`"Metrics dispatcher: Posting data {\\"type\\":\\"identify\\",\\"name\\":\\"identify\\",\\"properties\\":{\\"a\\":1,\\"b\\":2}}"`
+				);
+				expect(std.out).toMatchInlineSnapshot(`""`);
+				expect(std.warn).toMatchInlineSnapshot(`""`);
+				expect(std.err).toMatchInlineSnapshot(`""`);
+			});
+
+			it("should write a debug log if the dispatcher is disabled", async () => {
+				const dispatcher = await getMetricsDispatcher({
+					...MOCK_DISPATCHER_OPTIONS,
+					sendMetrics: false,
+				});
+				await dispatcher.identify({ a: 1, b: 2 });
+				expect(fetchMock).toHaveBeenCalledTimes(0);
+				expect(std.debug).toMatchInlineSnapshot(
+					`"Metrics dispatcher: Dispatching disabled - would have sent {\\"type\\":\\"identify\\",\\"name\\":\\"identify\\",\\"properties\\":{\\"a\\":1,\\"b\\":2}}."`
+				);
+				expect(std.out).toMatchInlineSnapshot(`""`);
+				expect(std.warn).toMatchInlineSnapshot(`""`);
+				expect(std.err).toMatchInlineSnapshot(`""`);
+			});
+
+			it("should write a debug log if the request fails", async () => {
+				const dispatcher = await getMetricsDispatcher(MOCK_DISPATCHER_OPTIONS);
+				fetchMock.mockReject(new Error("BAD REQUEST"));
+				await dispatcher.identify({ a: 1, b: 2 });
+				expect(std.debug).toMatchInlineSnapshot(`
+			"Metrics dispatcher: Posting data {\\"type\\":\\"identify\\",\\"name\\":\\"identify\\",\\"properties\\":{\\"a\\":1,\\"b\\":2}}
+			Metrics dispatcher: Failed to send request: BAD REQUEST"
+		`);
+				expect(std.out).toMatchInlineSnapshot(`""`);
+				expect(std.warn).toMatchInlineSnapshot(`""`);
+				expect(std.err).toMatchInlineSnapshot(`""`);
+			});
+
+			it("should write a warning log if no source key has been provided", async () => {
+				global.SPARROW_SOURCE_KEY = undefined;
+				const dispatcher = await getMetricsDispatcher(MOCK_DISPATCHER_OPTIONS);
+				await dispatcher.identify({ a: 1, b: 2 });
+				expect(fetchMock).toHaveBeenCalledTimes(0);
+				expect(std.debug).toMatchInlineSnapshot(
+					`"Metrics dispatcher: Source Key not provided. Be sure to initialize before sending events. { type: 'identify', name: 'identify', properties: { a: 1, b: 2 } }"`
+				);
+				expect(std.out).toMatchInlineSnapshot(`""`);
+				expect(std.warn).toMatchInlineSnapshot(`""`);
+				expect(std.err).toMatchInlineSnapshot(`""`);
+			});
+		});
+
+		describe("sendEvent()", () => {
+			it("should send a request to the default URL", async () => {
+				const dispatcher = await getMetricsDispatcher(MOCK_DISPATCHER_OPTIONS);
+				fetchMock.mockResponse("");
+				await dispatcher.sendEvent("some-event", { a: 1, b: 2 });
+				expect(fetchMock).toHaveBeenCalledTimes(1);
+				const [url, { body, headers }] = fetchMock.mock.calls[0];
+				expect(url).toEqual("https://sparrow.cloudflare.com/api/v1/event");
+				expect(JSON.parse(body)).toEqual(
+					expect.objectContaining({
+						event: "some-event",
+						properties: {
+							category: "Workers",
+							wranglerVersion,
+							a: 1,
+							b: 2,
+						},
+					})
+				);
+				expect(headers).toEqual(
+					expect.objectContaining({
+						"Sparrow-Source-Key": "MOCK_KEY",
+					})
+				);
+				expect(std.debug).toMatchInlineSnapshot(
+					`"Metrics dispatcher: Posting data {\\"type\\":\\"event\\",\\"name\\":\\"some-event\\",\\"properties\\":{\\"a\\":1,\\"b\\":2}}"`
+				);
+				expect(std.out).toMatchInlineSnapshot(`""`);
+				expect(std.warn).toMatchInlineSnapshot(`""`);
+				expect(std.err).toMatchInlineSnapshot(`""`);
+			});
+
+			it("should write a debug log if the dispatcher is disabled", async () => {
+				const dispatcher = await getMetricsDispatcher({
+					...MOCK_DISPATCHER_OPTIONS,
+					sendMetrics: false,
+				});
+				await dispatcher.sendEvent("some-event", { a: 1, b: 2 });
+				expect(fetchMock).toHaveBeenCalledTimes(0);
+				expect(std.debug).toMatchInlineSnapshot(
+					`"Metrics dispatcher: Dispatching disabled - would have sent {\\"type\\":\\"event\\",\\"name\\":\\"some-event\\",\\"properties\\":{\\"a\\":1,\\"b\\":2}}."`
+				);
+				expect(std.out).toMatchInlineSnapshot(`""`);
+				expect(std.warn).toMatchInlineSnapshot(`""`);
+				expect(std.err).toMatchInlineSnapshot(`""`);
+			});
+
+			it("should write a debug log if the request fails", async () => {
+				const dispatcher = await getMetricsDispatcher(MOCK_DISPATCHER_OPTIONS);
+				fetchMock.mockReject(new Error("BAD REQUEST"));
+				await dispatcher.sendEvent("some-event", { a: 1, b: 2 });
+				expect(std.debug).toMatchInlineSnapshot(`
+			"Metrics dispatcher: Posting data {\\"type\\":\\"event\\",\\"name\\":\\"some-event\\",\\"properties\\":{\\"a\\":1,\\"b\\":2}}
+			Metrics dispatcher: Failed to send request: BAD REQUEST"
+		`);
+				expect(std.out).toMatchInlineSnapshot(`""`);
+				expect(std.warn).toMatchInlineSnapshot(`""`);
+				expect(std.err).toMatchInlineSnapshot(`""`);
+			});
+
+			it("should write a warning log if no source key has been provided", async () => {
+				global.SPARROW_SOURCE_KEY = undefined;
+				const dispatcher = await getMetricsDispatcher(MOCK_DISPATCHER_OPTIONS);
+				await dispatcher.sendEvent("some-event", { a: 1, b: 2 });
+				expect(fetchMock).toHaveBeenCalledTimes(0);
+				expect(std.debug).toMatchInlineSnapshot(
+					`"Metrics dispatcher: Source Key not provided. Be sure to initialize before sending events. { type: 'event', name: 'some-event', properties: { a: 1, b: 2 } }"`
+				);
+				expect(std.out).toMatchInlineSnapshot(`""`);
+				expect(std.warn).toMatchInlineSnapshot(`""`);
+				expect(std.err).toMatchInlineSnapshot(`""`);
+			});
+		});
+	});
+
+	describe("getMetricsConfig()", () => {
+		const { setIsTTY } = useMockIsTTY();
+		beforeEach(() => {
+			// Default the mock TTY to interactive for all these tests.
+			setIsTTY(true);
+		});
+
+		describe("enabled", () => {
+			it("should return the sendMetrics argument for enabled if it is defined", async () => {
+				expect(
+					await getMetricsConfig({ sendMetrics: false, offline: false })
+				).toMatchObject({
+					enabled: false,
+				});
+				expect(
+					await getMetricsConfig({ sendMetrics: true, offline: false })
+				).toMatchObject({
+					enabled: true,
+				});
+			});
+
+			it("should return enabled false if the process is not interactive", async () => {
+				setIsTTY(false);
+				expect(
+					await getMetricsConfig({
+						sendMetrics: undefined,
+						offline: false,
+					})
+				).toMatchObject({
+					enabled: false,
+				});
+			});
+
+			it("should return enabled true if the user on this device previously agreed to send metrics", async () => {
+				await writeMetricsConfig({
+					permission: {
+						enabled: true,
+						date: new Date(2022, 6, 4),
+					},
+				});
+				expect(
+					await getMetricsConfig({
+						sendMetrics: undefined,
+						offline: false,
+					})
+				).toMatchObject({
+					enabled: true,
+				});
+			});
+
+			it("should return enabled false if the user on this device previously refused to send metrics", async () => {
+				await writeMetricsConfig({
+					permission: {
+						enabled: false,
+						date: new Date(2022, 6, 4),
+					},
+				});
+				expect(
+					await getMetricsConfig({
+						sendMetrics: undefined,
+						offline: false,
+					})
+				).toMatchObject({
+					enabled: false,
+				});
+			});
+
+			it("should accept and store permission granting to send metrics if the user agrees", async () => {
+				const checkConfirmations = mockConfirm({
+					text: "Would you like to help improve Wrangler by sending usage metrics to Cloudflare?",
+					result: true,
+				});
+				expect(
+					await getMetricsConfig({
+						sendMetrics: undefined,
+						offline: false,
+					})
+				).toMatchObject({
+					enabled: true,
+				});
+				checkConfirmations();
+				expect((await readMetricsConfig()).permission).toMatchObject({
+					enabled: true,
+				});
+			});
+
+			it("should accept and store permission declining to send metrics if the user declines", async () => {
+				const checkConfirmations = mockConfirm({
+					text: "Would you like to help improve Wrangler by sending usage metrics to Cloudflare?",
+					result: false,
+				});
+				expect(
+					await getMetricsConfig({
+						sendMetrics: undefined,
+						offline: false,
+					})
+				).toMatchObject({
+					enabled: false,
+				});
+				checkConfirmations();
+				expect((await readMetricsConfig()).permission).toMatchObject({
+					enabled: false,
+				});
+			});
+
+			it("should ignore the config if the permission date is older than the current metrics date", async () => {
+				const checkConfirmations = mockConfirm({
+					text: "Would you like to help improve Wrangler by sending usage metrics to Cloudflare?",
+					result: false,
+				});
+				const OLD_DATE = new Date(2000);
+				await writeMetricsConfig({
+					permission: { enabled: true, date: OLD_DATE },
+				});
+				expect(
+					await getMetricsConfig({
+						sendMetrics: undefined,
+						offline: false,
+					})
+				).toMatchObject({
+					enabled: false,
+				});
+				checkConfirmations();
+				const { permission } = await readMetricsConfig();
+				expect(permission?.enabled).toBe(false);
+				// The date should be updated to today's date
+				expect(permission?.date).toEqual(CURRENT_METRICS_DATE);
+
+				expect(std.out).toMatchInlineSnapshot(`
+			"Usage metrics tracking has changed since you last granted permission.
+			Your choice has been saved in the following file: home/.wrangler/config/metrics.json.
+
+			  You can override the user level setting for a project in \`wrangler.toml\`:
+
+			   - to disable sending metrics for a project: \`send_metrics = false\`
+			   - to enable sending metrics for a project: \`send_metrics = true\`"
+		`);
+			});
+		});
+
+		describe("deviceId", () => {
+			it("should return a deviceId found in the config file", async () => {
+				await writeMetricsConfig({ deviceId: "XXXX-YYYY-ZZZZ" });
+				const { deviceId } = await getMetricsConfig({
+					sendMetrics: true,
+					offline: false,
+				});
+				expect(deviceId).toEqual("XXXX-YYYY-ZZZZ");
+				expect((await readMetricsConfig()).deviceId).toEqual(deviceId);
+			});
+
+			it("should create and store a new deviceId if none is found in the config file", async () => {
+				await writeMetricsConfig({});
+				const { deviceId } = await getMetricsConfig({
+					sendMetrics: true,
+					offline: false,
+				});
+				expect(deviceId).toMatch(
+					/[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}/
+				);
+				expect((await readMetricsConfig()).deviceId).toEqual(deviceId);
+			});
+		});
+
+		describe("userId", () => {
+			const userRequests = mockUserRequest();
+			it("should return a userId found in a cache file", async () => {
+				await saveToConfigCache(USER_ID_CACHE_PATH, {
+					userId: "CACHED_USER_ID",
+				});
+				const { userId } = await getMetricsConfig({
+					sendMetrics: true,
+					offline: false,
+				});
+				expect(userId).toEqual("CACHED_USER_ID");
+				expect(userRequests.count).toBe(0);
+			});
+
+			it("should fetch the userId from Cloudflare and store it in a cache file", async () => {
+				writeAuthConfigFile({ oauth_token: "DUMMY_TOKEN" });
+				const { userId } = await getMetricsConfig({
+					sendMetrics: true,
+					offline: false,
+				});
+				expect(userId).toEqual("MOCK_USER_ID");
+				expect(userRequests.count).toBe(1);
+			});
+
+			it("should not fetch the userId from Cloudflare if running in `offline` mode", async () => {
+				writeAuthConfigFile({ oauth_token: "DUMMY_TOKEN" });
+				const { userId } = await getMetricsConfig({
+					sendMetrics: true,
+					offline: true,
+				});
+				expect(userId).toBe(undefined);
+				expect(userRequests.count).toBe(0);
+			});
+		});
+	});
+});
+
+function mockUserRequest() {
+	const requests = { count: 0 };
+	beforeEach(() => {
+		setMockResponse("/user", () => {
+			requests.count++;
+			return { id: "MOCK_USER_ID" };
+		});
+	});
+	afterEach(() => {
+		requests.count = 0;
+	});
+	return requests;
+}

package/src/__tests__/pages.test.ts

@@ -45,6 +45,13 @@ describe("pages", () => {
 		outOfBandTests.forEach((fn) => fn());
 	});
 
+	beforeEach(() => {
+		// @ts-expect-error we're using a very simple setTimeout mock here
+		jest.spyOn(global, "setTimeout").mockImplementation((fn, _period) => {
+			setImmediate(fn);
+		});
+	});
+
 	it("should should display a list of available subcommands, for pages with no subcommand", async () => {
 		await runWrangler("pages");
 		await endEventLoop();
@@ -645,8 +652,8 @@ describe("pages", () => {
 				});
 				bodies.push(JSON.parse(init.body as string) as UploadPayloadFile[]);
 			}
-			// First bucket should end up with 2 files
-			expect(bodies.map((b) => b.length)).toEqual([2, 1, 1]);
+			// One bucket should end up with 2 files
+			expect(bodies.map((b) => b.length).sort()).toEqual([1, 1, 2]);
 			// But we don't know the order, so flatten and test without ordering
 			expect(bodies.flatMap((b) => b)).toEqual(
 				expect.arrayContaining([
@@ -759,8 +766,8 @@ describe("pages", () => {
 				});
 				bodies.push(JSON.parse(init.body as string) as UploadPayloadFile[]);
 			}
-			// First bucket should end up with 2 files
-			expect(bodies.map((b) => b.length)).toEqual([2, 1, 1]);
+			// One bucket should end up with 2 files
+			expect(bodies.map((b) => b.length).sort()).toEqual([1, 1, 2]);
 			// But we don't know the order, so flatten and test without ordering
 			expect(bodies.flatMap((b) => b)).toEqual(
 				expect.arrayContaining([
@@ -874,8 +881,8 @@ describe("pages", () => {
 				});
 				bodies.push(JSON.parse(init.body as string) as UploadPayloadFile[]);
 			}
-			// First bucket should end up with 2 files
-			expect(bodies.map((b) => b.length)).toEqual([2, 1, 1]);
+			// One bucket should end up with 2 files
+			expect(bodies.map((b) => b.length).sort()).toEqual([1, 1, 2]);
 			// But we don't know the order, so flatten and test without ordering
 			expect(bodies.flatMap((b) => b)).toEqual(
 				expect.arrayContaining([
@@ -1163,8 +1170,8 @@ describe("pages", () => {
 				});
 				bodies.push(JSON.parse(init.body as string) as UploadPayloadFile[]);
 			}
-			// First bucket should end up with 2 files
-			expect(bodies.map((b) => b.length)).toEqual([2, 1, 1]);
+			// One bucket should end up with 2 files
+			expect(bodies.map((b) => b.length).sort()).toEqual([1, 1, 2]);
 			// But we don't know the order, so flatten and test without ordering
 			expect(bodies.flatMap((b) => b)).toEqual(
 				expect.arrayContaining([

package/src/__tests__/publish.test.ts

@@ -29,7 +29,7 @@ import type { FormData, File } from "undici";
 describe("publish", () => {
 	mockAccountId();
 	mockApiToken();
-	runInTempDir({ homedir: "./home" });
+	runInTempDir();
 	const { setIsTTY } = useMockIsTTY();
 	const std = mockConsoleMethods();
 	const {
@@ -51,6 +51,31 @@ describe("publish", () => {
 		unsetMockFetchKVGetValues();
 	});
 
+	describe("output additional script information", () => {
+		mockApiToken();
+
+		it("should print worker information at log level", async () => {
+			setIsTTY(false);
+			writeWranglerToml();
+			writeWorkerSource();
+			mockSubDomainRequest();
+			mockUploadWorkerRequest({ expectedType: "esm", sendScriptIds: true });
+			mockOAuthServerCallback();
+
+			await runWrangler("publish ./index");
+
+			expect(std.out).toMatchInlineSnapshot(`
+			"Total Upload: 0xx KiB / gzip: 0xx KiB
+			Worker ID:  abc12345
+			Worker ETag:  etag98765
+			Worker PipelineHash:  hash9999
+			Uploaded test-name (TIMINGS)
+			Published test-name (TIMINGS)
+			  test-name.test-sub-domain.workers.dev"
+		`);
+		});
+	});
+
 	describe("authentication", () => {
 		mockApiToken({ apiToken: null });
 		beforeEach(() => {
@@ -97,33 +122,23 @@ describe("publish", () => {
 				api_token: "some-api-token",
 			});
 
-			const accessTokenRequest = mockGrantAccessToken({ respondWith: "ok" });
-			mockGrantAuthorization({ respondWith: "success" });
-
 			await expect(runWrangler("publish index.js")).resolves.toBeUndefined();
 
-			expect(accessTokenRequest.actual.url).toEqual(
-				accessTokenRequest.expected.url
-			);
-
 			expect(std.out).toMatchInlineSnapshot(`
-			        "Attempting to login via OAuth...
-			        Opening a link in your default browser: https://dash.cloudflare.com/oauth2/auth?response_type=code&client_id=54d11594-84e4-41aa-b438-e81b8fa78ee7&redirect_uri=http%3A%2F%2Flocalhost%3A8976%2Foauth%2Fcallback&scope=account%3Aread%20user%3Aread%20workers%3Awrite%20workers_kv%3Awrite%20workers_routes%3Awrite%20workers_scripts%3Awrite%20workers_tail%3Aread%20pages%3Awrite%20zone%3Aread%20offline_access&state=MOCK_STATE_PARAM&code_challenge=MOCK_CODE_CHALLENGE&code_challenge_method=S256
-			        Successfully logged in.
-			        Total Upload: 0xx KiB / gzip: 0xx KiB
-			        Uploaded test-name (TIMINGS)
-			        Published test-name (TIMINGS)
-			          test-name.test-sub-domain.workers.dev"
-		      `);
+			"Total Upload: 0xx KiB / gzip: 0xx KiB
+			Uploaded test-name (TIMINGS)
+			Published test-name (TIMINGS)
+			  test-name.test-sub-domain.workers.dev"
+		`);
 			expect(std.warn).toMatchInlineSnapshot(`
-			        "▲ [WARNING] It looks like you have used Wrangler 1's \`config\` command to login with an API token.
+			"▲ [WARNING] It looks like you have used Wrangler 1's \`config\` command to login with an API token.
 
-			          This is no longer supported in the current version of Wrangler.
-			          If you wish to authenticate via an API token then please set the \`CLOUDFLARE_API_TOKEN\`
-			          environment variable.
+			  This is no longer supported in the current version of Wrangler.
+			  If you wish to authenticate via an API token then please set the \`CLOUDFLARE_API_TOKEN\`
+			  environment variable.
 
-			        "
-		      `);
+			"
+		`);
 			expect(std.err).toMatchInlineSnapshot(`""`);
 		});
 
@@ -6123,6 +6138,7 @@ function mockUploadWorkerRequest(
 		expectedMigrations?: CfWorkerInit["migrations"];
 		env?: string;
 		legacyEnv?: boolean;
+		sendScriptIds?: boolean;
 	} = {}
 ) {
 	const {
@@ -6137,6 +6153,7 @@ function mockUploadWorkerRequest(
 		env = undefined,
 		legacyEnv = false,
 		expectedMigrations,
+		sendScriptIds,
 	} = options;
 	setMockResponse(
 		env && !legacyEnv
@@ -6185,7 +6202,16 @@ function mockUploadWorkerRequest(
 				expect(await (formBody.get(name) as File).text()).toEqual(content);
 			}
 
-			return { available_on_subdomain };
+			return {
+				available_on_subdomain,
+				...(sendScriptIds
+					? {
+							id: "abc12345",
+							etag: "etag98765",
+							pipeline_hash: "hash9999",
+					  }
+					: {}),
+			};
 		}
 	);
 }