wrangler 0.0.0-e88a54e → 0.0.0-e8e684c7

package/src/__tests__/test-old-node-version.js

@@ -0,0 +1,31 @@
+// this test has to be run with a version of node.js older than 16.13 to pass
+
+const { spawn } = require("child_process");
+const path = require("path");
+
+const assert = require("assert");
+
+const wranglerProcess = spawn(
+	"node",
+	[path.join(__dirname, "../../bin/wrangler.js")],
+	{ stdio: "pipe" }
+);
+
+const messageToMatch = "Wrangler requires at least node.js v16.13.0";
+
+wranglerProcess.once("exit", (code) => {
+	try {
+		const errorMessage = wranglerProcess.stderr.read().toString();
+
+		assert(code === 1, "Expected exit code 1");
+		assert(
+			errorMessage.includes(messageToMatch),
+			`Expected error message to include "${messageToMatch}"`
+		);
+	} catch (err) {
+		console.error("Error:", err);
+		throw new Error(
+			"This test has to be run with a version of node.js under 16.13 to pass"
+		);
+	}
+});

package/src/__tests__/user.test.ts

@@ -0,0 +1,155 @@
+import fs from "node:fs";
+import path from "node:path";
+import fetchMock from "jest-fetch-mock";
+import { getGlobalWranglerConfigPath } from "../global-wrangler-config-path";
+import { CI } from "../is-ci";
+import {
+	loginOrRefreshIfRequired,
+	readAuthConfigFile,
+	requireAuth,
+	USER_AUTH_CONFIG_FILE,
+	writeAuthConfigFile,
+} from "../user";
+import { mockConsoleMethods } from "./helpers/mock-console";
+import { useMockIsTTY } from "./helpers/mock-istty";
+import { mockOAuthFlow } from "./helpers/mock-oauth-flow";
+import { runInTempDir } from "./helpers/run-in-tmp";
+import { runWrangler } from "./helpers/run-wrangler";
+import type { Config } from "../config";
+import type { UserAuthConfig } from "../user";
+
+describe("User", () => {
+	let isCISpy: jest.SpyInstance;
+	runInTempDir();
+	const std = mockConsoleMethods();
+	const {
+		mockOAuthServerCallback,
+		mockGrantAccessToken,
+		mockGrantAuthorization,
+		mockRevokeAuthorization,
+		mockExchangeRefreshTokenForAccessToken,
+	} = mockOAuthFlow();
+
+	const { setIsTTY } = useMockIsTTY();
+
+	beforeEach(() => {
+		isCISpy = jest.spyOn(CI, "isCI").mockReturnValue(false);
+	});
+
+	describe("login", () => {
+		it("should login a user when `wrangler login` is run", async () => {
+			mockOAuthServerCallback();
+			const accessTokenRequest = mockGrantAccessToken({ respondWith: "ok" });
+			mockGrantAuthorization({ respondWith: "success" });
+
+			await runWrangler("login");
+
+			expect(accessTokenRequest.actual.url).toEqual(
+				accessTokenRequest.expected.url
+			);
+			expect(accessTokenRequest.actual.method).toEqual(
+				accessTokenRequest.expected.method
+			);
+
+			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."
+      `);
+
+			expect(readAuthConfigFile()).toEqual<UserAuthConfig>({
+				api_token: undefined,
+				oauth_token: "test-access-token",
+				refresh_token: "test-refresh-token",
+				expiration_time: expect.any(String),
+				scopes: ["account:read"],
+			});
+		});
+	});
+
+	describe("logout", () => {
+		it("should exit with a message stating the user is not logged in", async () => {
+			await runWrangler("logout");
+			expect(std.out).toMatchInlineSnapshot(`"Not logged in, exiting..."`);
+		});
+
+		it("should logout user that has been properly logged in", async () => {
+			writeAuthConfigFile({
+				oauth_token: "some-oauth-tok",
+				refresh_token: "some-refresh-tok",
+			});
+			const outcome = mockRevokeAuthorization();
+
+			await runWrangler("logout");
+
+			expect(outcome.actual.url).toEqual(
+				"https://dash.cloudflare.com/oauth2/revoke"
+			);
+			expect(outcome.actual.method).toEqual("POST");
+
+			expect(std.out).toMatchInlineSnapshot(`"Successfully logged out."`);
+
+			// Make sure that we made the request to logout.
+			expect(fetchMock).toHaveBeenCalledTimes(1);
+
+			// Make sure that logout removed the config file containing the auth tokens.
+			const config = path.join(
+				getGlobalWranglerConfigPath(),
+				USER_AUTH_CONFIG_FILE
+			);
+			expect(fs.existsSync(config)).toBeFalsy();
+		});
+	});
+
+	// TODO: Improve OAuth mocking to handle `/token` endpoints from different calls
+	it("should handle errors for failed token refresh", async () => {
+		setIsTTY(false);
+		writeAuthConfigFile({
+			oauth_token: "hunter2",
+			refresh_token: "Order 66",
+		});
+		mockExchangeRefreshTokenForAccessToken({
+			respondWith: "badResponse",
+		});
+
+		// Handles the requireAuth error throw from failed login that is unhandled due to directly calling it here
+		await expect(
+			requireAuth({} as Config)
+		).rejects.toThrowErrorMatchingInlineSnapshot(
+			`"In a non-interactive environment, it's necessary to set a CLOUDFLARE_API_TOKEN environment variable for wrangler to work. Please go to https://developers.cloudflare.com/api/tokens/create/ for instructions on how to create an api token, and assign its value to CLOUDFLARE_API_TOKEN."`
+		);
+	});
+
+	it("should confirm no error message when refresh is successful", async () => {
+		setIsTTY(false);
+		mockOAuthServerCallback();
+		writeAuthConfigFile({
+			oauth_token: "hunter2",
+			refresh_token: "Order 66",
+		});
+		mockGrantAuthorization({ respondWith: "success" });
+
+		mockExchangeRefreshTokenForAccessToken({
+			respondWith: "refreshSuccess",
+		});
+
+		// Handles the requireAuth error throw from failed login that is unhandled due to directly calling it here
+		await expect(requireAuth({} as Config)).rejects.toThrowError();
+		expect(std.err).toContain("");
+	});
+
+	it("should revert to non-interactive mode if in CI", async () => {
+		isCISpy.mockReturnValue(true);
+		await expect(loginOrRefreshIfRequired()).resolves.toEqual(false);
+	});
+
+	it("should revert to non-interactive mode if isTTY throws an error", async () => {
+		setIsTTY({
+			stdin() {
+				throw new Error("stdin is not tty");
+			},
+			stdout: true,
+		});
+		await expect(loginOrRefreshIfRequired()).resolves.toEqual(false);
+	});
+});

package/src/__tests__/validate-dev-props.test.ts

@@ -0,0 +1,56 @@
+import { validateDevProps } from "../dev/validate-dev-props";
+import type { DevProps } from "../dev/dev";
+
+describe("validateDevProps", () => {
+	it("should throw if the user tries to use the service-worker format with an `assets` directory", () => {
+		const props = {
+			isWorkersSite: false,
+			assetPaths: ["assets"],
+			entry: { format: "service-worker" },
+			bindings: {},
+		};
+
+		expect(() => validateDevProps(props as unknown as DevProps)).toThrowError(
+			"You cannot use the service-worker format with an `assets` directory yet. For information on how to migrate to the module-worker format, see: https://developers.cloudflare.com/workers/learning/migrating-to-module-workers/"
+		);
+	});
+
+	it("should throw if the user tries to configure [wasm_modules] with an ES module worker", () => {
+		const props = {
+			isWorkersSite: false,
+			assetPaths: [],
+			entry: { format: "modules" },
+			bindings: { wasm_modules: true },
+		};
+
+		expect(() => validateDevProps(props as unknown as DevProps)).toThrowError(
+			"You cannot configure [wasm_modules] with an ES module worker. Instead, import the .wasm module directly in your code"
+		);
+	});
+
+	it("should throw if the user tries to configure [text_blobs] with an ES module worker", () => {
+		const props = {
+			isWorkersSite: false,
+			assetPaths: [],
+			entry: { format: "modules" },
+			bindings: { text_blobs: true },
+		};
+
+		expect(() => validateDevProps(props as unknown as DevProps)).toThrowError(
+			"You cannot configure [text_blobs] with an ES module worker. Instead, import the file directly in your code, and optionally configure `[rules]` in your wrangler.toml"
+		);
+	});
+
+	it("should throw if the user tries to configure [data_blobs] with an ES module worker", () => {
+		const props = {
+			isWorkersSite: false,
+			assetPaths: [],
+			entry: { format: "modules" },
+			bindings: { data_blobs: true },
+		};
+
+		expect(() => validateDevProps(props as unknown as DevProps)).toThrowError(
+			"You cannot configure [data_blobs] with an ES module worker. Instead, import the file directly in your code, and optionally configure `[rules]` in your wrangler.toml"
+		);
+	});
+});

package/src/__tests__/version.test.ts

@@ -0,0 +1,35 @@
+import { version } from "./../../package.json";
+import { mockConsoleMethods } from "./helpers/mock-console";
+import { useMockIsTTY } from "./helpers/mock-istty";
+import { runWrangler } from "./helpers/run-wrangler";
+
+describe("version", () => {
+	const std = mockConsoleMethods();
+	const { setIsTTY } = useMockIsTTY();
+
+	// We cannot test output of version banner,
+	// as it is disabled in jest environments
+
+	// it("should output version banner", async () => {
+	// 	await runWrangler("-v");
+	// 	expect(std.out).toMatchInlineSnapshot(`
+	// 	" ⛅️ wrangler 2.0.22
+	// 	--------------------"
+	// `);
+	// });
+
+	it("should output current version if !isTTY calling -v", async () => {
+		setIsTTY(false);
+
+		await runWrangler("-v");
+		expect(std.out).toMatch(version);
+	});
+
+	// This run separately as command handling is different
+	it("should output current version if !isTTY calling --version", async () => {
+		setIsTTY(false);
+
+		await runWrangler("--version");
+		expect(std.out).toMatch(version);
+	});
+});

package/src/__tests__/whoami.test.tsx

@@ -1,100 +1,289 @@
 import { render } from "ink-testing-library";
 import React from "react";
-import { reinitialiseAuthTokens, writeAuthConfigFile } from "../user";
+import { writeAuthConfigFile } from "../user";
 import { getUserInfo, WhoAmI } from "../whoami";
-import { setMockResponse } from "./helpers/mock-cfetch";
+import {
+	createFetchResult,
+	setMockRawResponse,
+	setMockResponse,
+	unsetAllMocks,
+} from "./helpers/mock-cfetch";
 import { mockConsoleMethods } from "./helpers/mock-console";
+import { useMockIsTTY } from "./helpers/mock-istty";
 import { runInTempDir } from "./helpers/run-in-tmp";
 import type { UserInfo } from "../whoami";
 
 describe("getUserInfo()", () => {
-  runInTempDir({ homedir: "./home" });
-  const std = mockConsoleMethods();
-
-  it("should return undefined if there is no config file", async () => {
-    const userInfo = await getUserInfo();
-    expect(userInfo).toBeUndefined();
-  });
-
-  it("should return undefined if there is an empty config file", async () => {
-    writeAuthConfigFile({});
-    // Now that we have changed the auth tokens in the wrangler.toml we must reinitialize the user auth state.
-    reinitialiseAuthTokens();
-    const userInfo = await getUserInfo();
-    expect(userInfo).toBeUndefined();
-  });
-
-  it("should return the user's email and accounts if authenticated via config token", async () => {
-    writeAuthConfigFile({ oauth_token: "some-oauth-token" });
-    // Now that we have changed the auth tokens in the wrangler.toml we must reinitialize the user auth state.
-    reinitialiseAuthTokens();
-
-    setMockResponse("/user", () => {
-      return { email: "user@example.com" };
-    });
-    setMockResponse("/accounts", () => {
-      return [
-        { name: "Account One", id: "account-1" },
-        { name: "Account Two", id: "account-2" },
-        { name: "Account Three", id: "account-3" },
-      ];
-    });
-
-    const userInfo = await getUserInfo();
-
-    expect(userInfo).toEqual({
-      authType: "OAuth",
-      apiToken: "some-oauth-token",
-      email: "user@example.com",
-      accounts: [
-        { name: "Account One", id: "account-1" },
-        { name: "Account Two", id: "account-2" },
-        { name: "Account Three", id: "account-3" },
-      ],
-    });
-  });
-
-  it("should display a warning message if the config file contains a legacy api_token field", async () => {
-    writeAuthConfigFile({ api_token: "API_TOKEN" });
-    await reinitialiseAuthTokens();
-    await getUserInfo();
-    expect(std.warn).toMatchInlineSnapshot(`
-      "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."
+	const ENV_COPY = process.env;
+
+	runInTempDir();
+	const std = mockConsoleMethods();
+	const { setIsTTY } = useMockIsTTY();
+
+	beforeEach(() => {
+		setIsTTY(true);
+	});
+
+	afterEach(() => {
+		process.env = ENV_COPY;
+		unsetAllMocks();
+	});
+
+	it("should return undefined if there is no config file", async () => {
+		const userInfo = await getUserInfo();
+		expect(userInfo).toBeUndefined();
+	});
+
+	it("should return undefined if there is an empty config file", async () => {
+		writeAuthConfigFile({});
+		const userInfo = await getUserInfo();
+		expect(userInfo).toBeUndefined();
+	});
+
+	it("should return undefined for email if the user settings API request fails with 9109", async () => {
+		process.env = {
+			CLOUDFLARE_API_TOKEN: "123456789",
+		};
+		setMockRawResponse("/user", () =>
+			createFetchResult(undefined, false, [
+				{ code: 9109, message: "Uauthorized to access requested resource" },
+			])
+		);
+		setMockResponse("/accounts", () => []);
+		const userInfo = await getUserInfo();
+		expect(userInfo?.email).toBeUndefined();
+	});
+
+	it("should say it's using an API token when one is set", async () => {
+		process.env = {
+			CLOUDFLARE_API_TOKEN: "123456789",
+		};
+		setMockResponse("/user", () => {
+			return { email: "user@example.com" };
+		});
+		setMockResponse("/accounts", () => {
+			return [
+				{ name: "Account One", id: "account-1" },
+				{ name: "Account Two", id: "account-2" },
+				{ name: "Account Three", id: "account-3" },
+			];
+		});
+
+		const userInfo = await getUserInfo();
+		expect(userInfo).toEqual({
+			authType: "API Token",
+			apiToken: "123456789",
+			email: "user@example.com",
+			accounts: [
+				{ name: "Account One", id: "account-1" },
+				{ name: "Account Two", id: "account-2" },
+				{ name: "Account Three", id: "account-3" },
+			],
+		});
+	});
+
+	it("should say it's using a Global API Key when one is set", async () => {
+		process.env = {
+			CLOUDFLARE_API_KEY: "123456789",
+			CLOUDFLARE_EMAIL: "user@example.com",
+		};
+		setMockResponse("/accounts", () => {
+			return [
+				{ name: "Account One", id: "account-1" },
+				{ name: "Account Two", id: "account-2" },
+				{ name: "Account Three", id: "account-3" },
+			];
+		});
+
+		const userInfo = await getUserInfo();
+		expect(userInfo).toEqual({
+			authType: "Global API Key",
+			apiToken: "123456789",
+			email: "user@example.com",
+			accounts: [
+				{ name: "Account One", id: "account-1" },
+				{ name: "Account Two", id: "account-2" },
+				{ name: "Account Three", id: "account-3" },
+			],
+		});
+	});
+
+	it("should use a Global API Key in preference to an API token", async () => {
+		process.env = {
+			CLOUDFLARE_API_KEY: "123456789",
+			CLOUDFLARE_EMAIL: "user@example.com",
+			CLOUDFLARE_API_TOKEN: "123456789",
+		};
+		setMockResponse("/accounts", () => {
+			return [
+				{ name: "Account One", id: "account-1" },
+				{ name: "Account Two", id: "account-2" },
+				{ name: "Account Three", id: "account-3" },
+			];
+		});
+
+		const userInfo = await getUserInfo();
+		expect(userInfo).toEqual({
+			authType: "Global API Key",
+			apiToken: "123456789",
+			email: "user@example.com",
+			accounts: [
+				{ name: "Account One", id: "account-1" },
+				{ name: "Account Two", id: "account-2" },
+				{ name: "Account Three", id: "account-3" },
+			],
+		});
+	});
+
+	it("should return undefined only a Global API Key, but not Email, is set", async () => {
+		process.env = {
+			CLOUDFLARE_API_KEY: "123456789",
+		};
+		const userInfo = await getUserInfo();
+		expect(userInfo).toEqual(undefined);
+	});
+
+	it("should return the user's email and accounts if authenticated via config token", async () => {
+		writeAuthConfigFile({ oauth_token: "some-oauth-token" });
+
+		setMockResponse("/user", () => {
+			return { email: "user@example.com" };
+		});
+		setMockResponse("/accounts", () => {
+			return [
+				{ name: "Account One", id: "account-1" },
+				{ name: "Account Two", id: "account-2" },
+				{ name: "Account Three", id: "account-3" },
+			];
+		});
+
+		const userInfo = await getUserInfo();
+
+		expect(userInfo).toEqual({
+			authType: "OAuth Token",
+			apiToken: "some-oauth-token",
+			email: "user@example.com",
+			accounts: [
+				{ name: "Account One", id: "account-1" },
+				{ name: "Account Two", id: "account-2" },
+				{ name: "Account Three", id: "account-3" },
+			],
+		});
+	});
+
+	it("should display a warning message if the config file contains a legacy api_token field", async () => {
+		writeAuthConfigFile({ api_token: "API_TOKEN" });
+		setMockResponse("/user", () => {
+			return { email: "user@example.com" };
+		});
+		setMockResponse("/accounts", () => {
+			return [
+				{ name: "Account One", id: "account-1" },
+				{ name: "Account Two", id: "account-2" },
+				{ name: "Account Three", id: "account-3" },
+			];
+		});
+		await getUserInfo();
+		expect(std.warn).toMatchInlineSnapshot(`
+      "▲ [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.
+
+      "
     `);
-  });
+	});
 });
 
 describe("WhoAmI component", () => {
-  it("should return undefined if there is no user", async () => {
-    const { lastFrame } = render(<WhoAmI user={undefined}></WhoAmI>);
-
-    expect(lastFrame()).toMatchInlineSnapshot(
-      `"You are not authenticated. Please run \`wrangler login\`."`
-    );
-  });
-
-  it("should display the user's email and accounts", async () => {
-    const user: UserInfo = {
-      authType: "OAuth",
-      apiToken: "some-oauth-token",
-      email: "user@example.com",
-      accounts: [
-        { name: "Account One", id: "account-1" },
-        { name: "Account Two", id: "account-2" },
-        { name: "Account Three", id: "account-3" },
-      ],
-    };
-
-    const { lastFrame } = render(<WhoAmI user={user}></WhoAmI>);
-
-    expect(lastFrame()).toContain(
-      "You are logged in with an OAuth Token, associated with the email 'user@example.com'!"
-    );
-    expect(lastFrame()).toMatch(/Account Name .+ Account ID/);
-    expect(lastFrame()).toMatch(/Account One .+ account-1/);
-    expect(lastFrame()).toMatch(/Account Two .+ account-2/);
-    expect(lastFrame()).toMatch(/Account Three .+ account-3/);
-  });
+	it("should return undefined if there is no user", async () => {
+		const { lastFrame } = render(<WhoAmI user={undefined}></WhoAmI>);
+
+		expect(lastFrame()).toMatchInlineSnapshot(
+			`"You are not authenticated. Please run \`wrangler login\`."`
+		);
+	});
+
+	it("should display the user's email, accounts and OAuth scopes", async () => {
+		const user: UserInfo = {
+			authType: "OAuth Token",
+			apiToken: "some-oauth-token",
+			email: "user@example.com",
+			tokenPermissions: ["scope1:read", "scope2:write", "scope3"],
+			accounts: [
+				{ name: "Account One", id: "account-1" },
+				{ name: "Account Two", id: "account-2" },
+				{ name: "Account Three", id: "account-3" },
+			],
+		};
+
+		const { lastFrame } = render(<WhoAmI user={user}></WhoAmI>);
+
+		expect(lastFrame()).toContain(
+			"You are logged in with an OAuth Token, associated with the email 'user@example.com'!"
+		);
+		expect(lastFrame()).toMatch(/Account Name .+ Account ID/);
+		expect(lastFrame()).toMatch(/Account One .+ account-1/);
+		expect(lastFrame()).toMatch(/Account Two .+ account-2/);
+		expect(lastFrame()).toMatch(/Account Three .+ account-3/);
+		expect(lastFrame()).toContain(
+			"Token Permissions: If scopes are missing, you may need to logout and re-login."
+		);
+		expect(lastFrame()).toContain("- scope1 (read)");
+		expect(lastFrame()).toContain("- scope2 (write)");
+		expect(lastFrame()).toContain("- scope3");
+	});
+
+	// For the case where the cache hasn't updated to include the scopes array
+	it("should display the user's email and accounts, but no OAuth scopes if none provided", async () => {
+		const user: UserInfo = {
+			authType: "OAuth Token",
+			apiToken: "some-oauth-token",
+			email: "user@example.com",
+			tokenPermissions: undefined,
+			accounts: [
+				{ name: "Account One", id: "account-1" },
+				{ name: "Account Two", id: "account-2" },
+				{ name: "Account Three", id: "account-3" },
+			],
+		};
+
+		const { lastFrame } = render(<WhoAmI user={user}></WhoAmI>);
+
+		expect(lastFrame()).toContain(
+			"You are logged in with an OAuth Token, associated with the email 'user@example.com'!"
+		);
+		expect(lastFrame()).toMatch(/Account Name .+ Account ID/);
+		expect(lastFrame()).toMatch(/Account One .+ account-1/);
+		expect(lastFrame()).toMatch(/Account Two .+ account-2/);
+		expect(lastFrame()).toMatch(/Account Three .+ account-3/);
+	});
+
+	it("should display the user's email, accounts and link to view token permissions for non-OAuth tokens", async () => {
+		const user: UserInfo = {
+			authType: "API Token",
+			apiToken: "some-api-token",
+			email: "user@example.com",
+			tokenPermissions: undefined,
+			accounts: [
+				{ name: "Account One", id: "account-1" },
+				{ name: "Account Two", id: "account-2" },
+				{ name: "Account Three", id: "account-3" },
+			],
+		};
+
+		const { lastFrame } = render(<WhoAmI user={user}></WhoAmI>);
+
+		expect(lastFrame()).toContain(
+			"You are logged in with an API Token, associated with the email 'user@example.com'!"
+		);
+		expect(lastFrame()).toMatch(/Account Name .+ Account ID/);
+		expect(lastFrame()).toMatch(/Account One .+ account-1/);
+		expect(lastFrame()).toMatch(/Account Two .+ account-2/);
+		expect(lastFrame()).toMatch(/Account Three .+ account-3/);
+		expect(lastFrame()).toContain(
+			"To see token permissions visit https://dash.cloudflare.com/profile/api-tokens"
+		);
+	});
 });