wrangler 2.1.4 → 2.1.6

package/src/__tests__/pages.test.ts

@@ -1,7 +1,7 @@
 import { mkdirSync, writeFileSync } from "node:fs";
 import { chdir } from "node:process";
 import { ROUTES_SPEC_VERSION } from "../pages/constants";
-import { isRoutesJSONSpec } from "../pages/functions/routes-transformation";
+import { isRoutesJSONSpec } from "../pages/functions/routes-validation";
 import { version } from "./../../package.json";
 import { mockAccountId, mockApiToken } from "./helpers/mock-account-id";
 import {
@@ -1113,10 +1113,11 @@ describe("pages", () => {
 						// generated and that the file size is greater than zero
 						expect(generatedWorkerJS).not.toBeNull();
 						expect(generatedWorkerJS.size).toBeGreaterThan(0);
+
 						const maybeRoutesJSONSpec = JSON.parse(generatedRoutesJSON);
 						expect(isRoutesJSONSpec(maybeRoutesJSONSpec)).toBe(true);
 						expect(maybeRoutesJSONSpec).toMatchObject({
-							version: 1,
+							version: ROUTES_SPEC_VERSION,
 							description: `Generated by wrangler@${version}`,
 							include: ["/hello"],
 							exclude: [],
@@ -1371,16 +1372,13 @@ describe("pages", () => {
 						expect(generatedWorkerJS).not.toBeNull();
 						expect(generatedWorkerJS.size).toBeGreaterThan(0);
 
-						expect(customRoutesJSON).toMatchInlineSnapshot(`
-				"
-							{
-								\\"version\\": 1,
-								\\"description\\": \\"Custom _routes.json file\\",
-								\\"include\\": [\\"/hello\\"],
-								\\"exclude\\": []
-							}
-										"
-			`);
+						const customRoutes = JSON.parse(customRoutesJSON);
+						expect(customRoutes).toMatchObject({
+							version: ROUTES_SPEC_VERSION,
+							description: "Custom _routes.json file",
+							include: ["/hello"],
+							exclude: [],
+						});
 					});
 
 					return {
@@ -1476,15 +1474,15 @@ describe("pages", () => {
 			});
 
 			await expect(runWrangler("pages publish public --project-name=foo"))
-				.rejects.toThrowErrorMatchingInlineSnapshot(`
-			"Invalid _routes.json file found at: public/_routes.json. Please make sure the JSON object has the following format:
-			      {
-			        version: ${ROUTES_SPEC_VERSION};
-			        include: string[];
-			        exclude: string[];
-			      }
-			and that at least one include rule is provided.
-			      "
+				.rejects
+				.toThrow(`Invalid _routes.json file found at: public/_routes.json
+Please make sure the JSON object has the following format:
+{
+	version: ${ROUTES_SPEC_VERSION};
+	include: string[];
+	exclude: string[];
+}
+and that at least one include rule is provided.
 		`);
 		});
 
@@ -1612,16 +1610,13 @@ describe("pages", () => {
 							"
 			`);
 
-						expect(customRoutesJSON).toMatchInlineSnapshot(`
-				"
-								{
-									\\"version\\": 1,
-									\\"description\\": \\"Custom _routes.json file\\",
-									\\"include\\": [\\"/api/*\\"],
-									\\"exclude\\": []
-								}
-								"
-			`);
+						const customRoutes = JSON.parse(customRoutesJSON);
+						expect(customRoutes).toMatchObject({
+							version: ROUTES_SPEC_VERSION,
+							description: "Custom _routes.json file",
+							include: ["/api/*"],
+							exclude: [],
+						});
 					});
 
 					return {
@@ -1716,15 +1711,15 @@ describe("pages", () => {
 			});
 
 			await expect(runWrangler("pages publish public --project-name=foo"))
-				.rejects.toThrowErrorMatchingInlineSnapshot(`
-			"Invalid _routes.json file found at: public/_routes.json. Please make sure the JSON object has the following format:
-			      {
-			        version: ${ROUTES_SPEC_VERSION};
-			        include: string[];
-			        exclude: string[];
-			      }
-			and that at least one include rule is provided.
-			      "
+				.rejects
+				.toThrow(`Invalid _routes.json file found at: public/_routes.json
+Please make sure the JSON object has the following format:
+{
+	version: ${ROUTES_SPEC_VERSION};
+	include: string[];
+	exclude: string[];
+}
+and that at least one include rule is provided.
 		`);
 		});
 	});

package/src/__tests__/publish.test.ts

@@ -6540,6 +6540,56 @@ addEventListener('fetch', event => {});`
 			`A request to the Cloudflare API (/accounts/some-account-id/workers/services/test-name) failed`
 		);
 	});
+
+	describe("--keep-vars", () => {
+		it("should send keepVars when keep-vars is passed in", async () => {
+			process.env = {
+				CLOUDFLARE_API_TOKEN: "hunter2",
+				CLOUDFLARE_ACCOUNT_ID: "some-account-id",
+			};
+			setIsTTY(false);
+			writeWranglerToml();
+			writeWorkerSource();
+			mockSubDomainRequest();
+			mockUploadWorkerRequest({ keepVars: true });
+			mockOAuthServerCallback();
+			mockGetMemberships([]);
+
+			await runWrangler("publish index.js --keep-vars");
+
+			expect(std.out).toMatchInlineSnapshot(`
+			"Total Upload: xx KiB / gzip: xx KiB
+			Uploaded test-name (TIMINGS)
+			Published test-name (TIMINGS)
+			  https://test-name.test-sub-domain.workers.dev"
+		`);
+			expect(std.err).toMatchInlineSnapshot(`""`);
+		});
+
+		it("should not send keepVars by default", async () => {
+			process.env = {
+				CLOUDFLARE_API_TOKEN: "hunter2",
+				CLOUDFLARE_ACCOUNT_ID: "some-account-id",
+			};
+			setIsTTY(false);
+			writeWranglerToml();
+			writeWorkerSource();
+			mockSubDomainRequest();
+			mockUploadWorkerRequest();
+			mockOAuthServerCallback();
+			mockGetMemberships([]);
+
+			await runWrangler("publish index.js");
+
+			expect(std.out).toMatchInlineSnapshot(`
+			"Total Upload: xx KiB / gzip: xx KiB
+			Uploaded test-name (TIMINGS)
+			Published test-name (TIMINGS)
+			  https://test-name.test-sub-domain.workers.dev"
+		`);
+			expect(std.err).toMatchInlineSnapshot(`""`);
+		});
+	});
 });
 
 /** Write mock assets to the file system so they can be uploaded. */
@@ -6571,6 +6621,7 @@ function mockUploadWorkerRequest(
 		env?: string;
 		legacyEnv?: boolean;
 		sendScriptIds?: boolean;
+		keepVars?: boolean;
 	} = {}
 ) {
 	const {
@@ -6586,6 +6637,7 @@ function mockUploadWorkerRequest(
 		legacyEnv = false,
 		expectedMigrations,
 		sendScriptIds,
+		keepVars,
 	} = options;
 	setMockResponse(
 		env && !legacyEnv
@@ -6617,7 +6669,11 @@ function mockUploadWorkerRequest(
 				expect(metadata.body_part).toEqual("index.js");
 			}
 
-			expect(metadata.keep_bindings).toEqual(["plain_text", "json"]);
+			if (keepVars) {
+				expect(metadata.keep_bindings).toEqual(["plain_text", "json"]);
+			} else {
+				expect(metadata.keep_bindings).toBeFalsy();
+			}
 
 			if ("expectedBindings" in options) {
 				expect(metadata.bindings).toEqual(expectedBindings);

package/src/api/dev.ts

@@ -10,6 +10,7 @@ interface DevOptions {
 	env?: string;
 	ip?: string;
 	port?: number;
+	noBundle?: boolean;
 	inspectorPort?: number;
 	localProtocol?: "http" | "https";
 	assets?: string;
@@ -50,6 +51,7 @@ interface DevOptions {
 	enablePagesAssetsServiceBinding?: EnablePagesAssetsServiceBindingOptions;
 	_?: (string | number)[]; //yargs wants this
 	$0?: string; //yargs wants this
+	testScheduled?: boolean;
 }
 
 interface DevApiOptions {

package/src/bundle.ts

@@ -7,7 +7,7 @@ import NodeModulesPolyfills from "@esbuild-plugins/node-modules-polyfill";
 import * as esbuild from "esbuild";
 import tmp from "tmp-promise";
 import createModuleCollector from "./module-collection";
-import { getBasePath } from "./paths";
+import { getBasePath, toUrlPath } from "./paths";
 import type { Config } from "./config";
 import type { WorkerRegistry } from "./dev-registry";
 import type { Entry } from "./entry";
@@ -76,6 +76,7 @@ export async function bundleWorker(
 		workerDefinitions: WorkerRegistry | undefined;
 		firstPartyWorkerDevFacade: boolean | undefined;
 		targetConsumer: "dev" | "publish";
+		testScheduled?: boolean | undefined;
 	}
 ): Promise<BundleResult> {
 	const {
@@ -93,6 +94,7 @@ export async function bundleWorker(
 		services,
 		firstPartyWorkerDevFacade,
 		targetConsumer,
+		testScheduled,
 	} = options;
 
 	// We create a temporary directory for any oneoff files we
@@ -144,16 +146,13 @@ export async function bundleWorker(
 
 	// We also have middleware that uses a more "traditional" middleware stack,
 	// which is all loaded as one in a stack.
-	const middlewareToLoad: MiddlewareLoader[] = [
-		// {
-		// 	path: "templates/middleware/middleware-pretty-error.ts",
-		// 	publish: true,
-		// 	dev: false,
-		// },
-		// {
-		// 	path: "../templates/middleware/middleware-scheduled.ts",
-		// },
-	];
+	const middlewareToLoad: MiddlewareLoader[] = [];
+
+	if (testScheduled) {
+		middlewareToLoad.push({
+			path: "templates/middleware/middleware-scheduled.ts",
+		});
+	}
 
 	type MiddlewareFn = (arg0: Entry) => Promise<Entry>;
 	const middleware: (false | undefined | MiddlewareFn)[] = [
@@ -309,7 +308,7 @@ export async function bundleWorker(
 /**
  * A simple plugin to alias modules and mark them as external
  */
-function esbuildAliasExternalPlugin(
+export function esbuildAliasExternalPlugin(
 	aliases: Record<string, string>
 ): esbuild.Plugin {
 	return {
@@ -445,7 +444,7 @@ async function applyMiddlewareLoaderFacade(
 					...Object.fromEntries(
 						middleware.map((val, index) => [
 							middlewareIdentifiers[index],
-							path.resolve(getBasePath(), val.path),
+							toUrlPath(path.resolve(getBasePath(), val.path)),
 						])
 					),
 				}),
@@ -471,9 +470,8 @@ async function applyMiddlewareLoaderFacade(
 		const imports = middlewareIdentifiers
 			.map(
 				(m, i) =>
-					`import ${m} from "${path.resolve(
-						getBasePath(),
-						middleware[i].path
+					`import ${m} from "${toUrlPath(
+						path.resolve(getBasePath(), middleware[i].path)
 					)}";`
 			)
 			.join("\n");

package/src/config/config.ts

@@ -168,6 +168,18 @@ export interface ConfigFields<Dev extends RawDevConfig> {
 				[key: string]: string;
 		  }
 		| undefined;
+
+	/**
+	 * By default, wrangler.toml is the source of truth for your environment configuration, like a terraform file.
+	 *
+	 * If you change your vars in the dashboard, wrangler *will* override/delete them on its next publish.
+	 *
+	 * If you want to keep your dashboard vars when wrangler deploys, set this field to true.
+	 *
+	 * @default false
+	 * @nonInheritable
+	 */
+	keep_vars?: boolean;
 }
 
 export interface DevConfig {

package/src/config/validation.ts

@@ -102,6 +102,14 @@ export function normalizeAndValidateConfig(
 		"boolean"
 	);
 
+	validateOptionalProperty(
+		diagnostics,
+		"",
+		"keep_vars",
+		rawConfig.keep_vars,
+		"boolean"
+	);
+
 	// TODO: set the default to false to turn on service environments as the default
 	const isLegacyEnv =
 		(args as { "legacy-env": boolean | undefined })["legacy-env"] ??
@@ -182,6 +190,7 @@ export function normalizeAndValidateConfig(
 		configPath,
 		legacy_env: isLegacyEnv,
 		send_metrics: rawConfig.send_metrics,
+		keep_vars: rawConfig.keep_vars,
 		...activeEnv,
 		dev: normalizeAndValidateDev(diagnostics, rawConfig.dev ?? {}),
 		migrations: normalizeAndValidateMigrations(

package/src/create-worker-upload-form.ts

@@ -59,7 +59,7 @@ export interface WorkerMetadata {
 	migrations?: CfDurableObjectMigrations;
 	capnp_schema?: string;
 	bindings: WorkerMetadataBinding[];
-	keep_bindings: WorkerMetadataBinding["type"][];
+	keep_bindings?: WorkerMetadataBinding["type"][];
 }
 
 /**
@@ -74,6 +74,7 @@ export function createWorkerUploadForm(worker: CfWorkerInit): FormData {
 		usage_model,
 		compatibility_date,
 		compatibility_flags,
+		keepVars,
 	} = worker;
 
 	let { modules } = worker;
@@ -257,7 +258,7 @@ export function createWorkerUploadForm(worker: CfWorkerInit): FormData {
 		...(usage_model && { usage_model }),
 		...(migrations && { migrations }),
 		capnp_schema: bindings.logfwdr?.schema,
-		keep_bindings: ["plain_text", "json"],
+		...(keepVars && { keep_bindings: ["plain_text", "json"] }),
 	};
 
 	formData.set("metadata", JSON.stringify(metadata));

package/src/dev/dev.tsx

@@ -11,7 +11,7 @@ import onExit from "signal-exit";
 import tmp from "tmp-promise";
 import { fetch } from "undici";
 import {
-	getRegisteredWorkers,
+	getBoundRegisteredWorkers,
 	startWorkerRegistry,
 	stopWorkerRegistry,
 	unregisterWorker,
@@ -53,32 +53,21 @@ function useDevRegistry(
 			logger.error("failed to start worker registry", err);
 		});
 
-		const serviceNames = (services || []).map(
-			(serviceBinding) => serviceBinding.service
-		);
-		const durableObjectServices = (
-			durableObjects || { bindings: [] }
-		).bindings.map((durableObjectBinding) => durableObjectBinding.script_name);
-
 		const interval =
 			// TODO: enable this for remote mode as well
 			// https://github.com/cloudflare/wrangler2/issues/1182
 			mode === "local"
 				? setInterval(() => {
-						getRegisteredWorkers().then(
-							(workerDefinitions: WorkerRegistry | undefined) => {
-								// We only want the workers that we're bound to
-								// so let's filter out the others
-								const filteredWorkers = Object.fromEntries(
-									Object.entries(workerDefinitions || {}).filter(
-										([key, _value]) =>
-											serviceNames.includes(key) ||
-											durableObjectServices.includes(key)
-									)
-								);
+						getBoundRegisteredWorkers({
+							services,
+							durableObjects,
+						}).then(
+							(boundRegisteredWorkers: WorkerRegistry | undefined) => {
 								setWorkers((prevWorkers) => {
-									if (!util.isDeepStrictEqual(filteredWorkers, prevWorkers)) {
-										return filteredWorkers;
+									if (
+										!util.isDeepStrictEqual(boundRegisteredWorkers, prevWorkers)
+									) {
+										return boundRegisteredWorkers || {};
 									}
 									return prevWorkers;
 								});
@@ -164,6 +153,7 @@ export type DevProps = {
 	enablePagesAssetsServiceBinding?: EnablePagesAssetsServiceBindingOptions;
 	firstPartyWorker: boolean | undefined;
 	sendMetrics: boolean | undefined;
+	testScheduled: boolean | undefined;
 };
 
 export function DevImplementation(props: DevProps): JSX.Element {
@@ -259,6 +249,7 @@ function DevSession(props: DevSessionProps) {
 		firstPartyWorkerDevFacade: props.firstPartyWorker,
 		// Enable the bundling to know whether we are using dev or publish
 		targetConsumer: "dev",
+		testScheduled: props.testScheduled ?? false,
 	});
 
 	return props.local ? (

package/src/dev/local.tsx

@@ -52,6 +52,7 @@ export interface LocalProps {
 	logLevel: "none" | "error" | "log" | "warn" | "debug" | undefined;
 	logPrefix?: string;
 	enablePagesAssetsServiceBinding?: EnablePagesAssetsServiceBindingOptions;
+	testScheduled?: boolean;
 }
 
 export function Local(props: LocalProps) {

package/src/dev/remote.tsx

@@ -169,19 +169,6 @@ export function useWorker(props: {
 	sendMetrics: boolean | undefined;
 	port: number;
 }): CfPreviewToken | undefined {
-	const {
-		name,
-		bundle,
-		format,
-		modules,
-		accountId,
-		bindings,
-		assetPaths,
-		compatibilityDate,
-		compatibilityFlags,
-		usageModel,
-		onReady,
-	} = props;
 	const [session, setSession] = useState<CfPreviewSession | undefined>();
 	const [token, setToken] = useState<CfPreviewToken | undefined>();
 	const [restartCounter, setRestartCounter] = useState<number>(0);
@@ -189,17 +176,18 @@ export function useWorker(props: {
 	// something's "happened" in our system; We make a ref and
 	// mark it once we log our initial message. Refs are vars!
 	const startedRef = useRef(false);
-
+	// functions must be destructured before use inside a useEffect, otherwise the entire props object has to be added to the dependency array
+	const { onReady } = props;
 	// This effect sets up the preview session
 	useEffect(() => {
 		const abortController = new AbortController();
 		async function start() {
-			if (accountId === undefined) {
+			if (props.accountId === undefined) {
 				return;
 			}
 
 			const workerAccount: CfAccount = {
-				accountId,
+				accountId: props.accountId,
 				apiToken: requireApiToken(),
 			};
 
@@ -232,7 +220,7 @@ export function useWorker(props: {
 			abortController.abort();
 		};
 	}, [
-		accountId,
+		props.accountId,
 		props.env,
 		props.host,
 		props.legacyEnv,
@@ -246,7 +234,7 @@ export function useWorker(props: {
 	useEffect(() => {
 		const abortController = new AbortController();
 		async function start() {
-			if (accountId === undefined) {
+			if (props.accountId === undefined) {
 				return;
 			}
 			if (session === undefined) {
@@ -254,7 +242,7 @@ export function useWorker(props: {
 			}
 			setToken(undefined); // reset token in case we're re-running
 
-			if (!bundle || !format) return;
+			if (!props.bundle || !props.format) return;
 
 			if (!startedRef.current) {
 				startedRef.current = true;
@@ -262,34 +250,34 @@ export function useWorker(props: {
 				logger.log("⎔ Detected changes, restarted server.");
 			}
 
-			const content = await readFile(bundle.path, "utf-8");
+			const content = await readFile(props.bundle.path, "utf-8");
 
 			// TODO: For Dev we could show the reporter message in the interactive box.
 			void printBundleSize(
-				{ name: path.basename(bundle.path), content: content },
-				modules
+				{ name: path.basename(props.bundle.path), content: content },
+				props.modules
 			);
 
 			const assets = await syncAssets(
-				accountId,
+				props.accountId,
 				// When we're using the newer service environments, we wouldn't
 				// have added the env name on to the script name. However, we must
 				// include it in the kv namespace name regardless (since there's no
 				// concept of service environments for kv namespaces yet).
-				name + (!props.legacyEnv && props.env ? `-${props.env}` : ""),
-				props.isWorkersSite ? assetPaths : undefined,
+				props.name + (!props.legacyEnv && props.env ? `-${props.env}` : ""),
+				props.isWorkersSite ? props.assetPaths : undefined,
 				true,
 				false
 			); // TODO: cancellable?
 
 			const init: CfWorkerInit = {
-				name,
+				name: props.name,
 				main: {
-					name: path.basename(bundle.path),
-					type: format === "modules" ? "esm" : "commonjs",
+					name: path.basename(props.bundle.path),
+					type: props.format === "modules" ? "esm" : "commonjs",
 					content,
 				},
-				modules: modules.concat(
+				modules: props.modules.concat(
 					assets.manifest
 						? {
 								name: "__STATIC_CONTENT_MANIFEST",
@@ -299,29 +287,29 @@ export function useWorker(props: {
 						: []
 				),
 				bindings: {
-					...bindings,
-					kv_namespaces: (bindings.kv_namespaces || []).concat(
+					...props.bindings,
+					kv_namespaces: (props.bindings.kv_namespaces || []).concat(
 						assets.namespace
 							? { binding: "__STATIC_CONTENT", id: assets.namespace }
 							: []
 					),
 					text_blobs: {
-						...bindings.text_blobs,
+						...props.bindings.text_blobs,
 						...(assets.manifest &&
-							format === "service-worker" && {
+							props.format === "service-worker" && {
 								__STATIC_CONTENT_MANIFEST: "__STATIC_CONTENT_MANIFEST",
 							}),
 					},
 				},
 				migrations: undefined, // no migrations in dev
-				compatibility_date: compatibilityDate,
-				compatibility_flags: compatibilityFlags,
-				usage_model: usageModel,
-				keep_bindings: true,
+				compatibility_date: props.compatibilityDate,
+				compatibility_flags: props.compatibilityFlags,
+				usage_model: props.usageModel,
+				keepVars: true,
 			};
 
 			const workerAccount: CfAccount = {
-				accountId,
+				accountId: props.accountId,
 				apiToken: requireApiToken(),
 			};
 
@@ -364,7 +352,6 @@ export function useWorker(props: {
 				});
 			}
 			*/
-
 			onReady?.(props.host || "localhost", props.port);
 		}
 		start().catch((err) => {
@@ -379,7 +366,7 @@ export function useWorker(props: {
 						"Error: You need to register a workers.dev subdomain before running the dev command in remote mode";
 					const solutionMessage =
 						"You can either enable local mode by pressing l, or register a workers.dev subdomain here:";
-					const onboardingLink = `https://dash.cloudflare.com/${accountId}/workers/onboarding`;
+					const onboardingLink = `https://dash.cloudflare.com/${props.accountId}/workers/onboarding`;
 					logger.error(
 						`${errorMessage}\n${solutionMessage}\n${onboardingLink}`
 					);
@@ -400,17 +387,17 @@ export function useWorker(props: {
 			abortController.abort();
 		};
 	}, [
-		name,
-		bundle,
-		format,
-		accountId,
-		assetPaths,
+		props.name,
+		props.bundle,
+		props.format,
+		props.accountId,
+		props.assetPaths,
 		props.isWorkersSite,
-		compatibilityDate,
-		compatibilityFlags,
-		usageModel,
-		bindings,
-		modules,
+		props.compatibilityDate,
+		props.compatibilityFlags,
+		props.usageModel,
+		props.bindings,
+		props.modules,
 		props.env,
 		props.legacyEnv,
 		props.zone,
@@ -421,5 +408,6 @@ export function useWorker(props: {
 		props.sendMetrics,
 		props.port,
 	]);
+
 	return token;
 }