wrangler 2.8.0 → 2.9.0

package/src/kv/index.ts

@@ -25,12 +25,10 @@ import {
 	putKVKeyValue,
 	unexpectedKVKeyValueProps,
 } from "./helpers";
-import type { ConfigPath } from "../index";
-import type { CommonYargsOptions } from "../yargs-types";
+import type { CommonYargsArgv } from "../yargs-types";
 import type { KeyValue } from "./helpers";
-import type { Argv } from "yargs";
 
-export const kvNamespace = (kvYargs: Argv<CommonYargsOptions>) => {
+export function kvNamespace(kvYargs: CommonYargsArgv) {
 	return kvYargs
 		.command(
 			"create <namespace>",
@@ -56,7 +54,7 @@ export const kvNamespace = (kvYargs: Argv<CommonYargsOptions>) => {
 					);
 				}
 
-				const config = readConfig(args.config as ConfigPath, args);
+				const config = readConfig(args.config, args);
 				if (!config.name) {
 					logger.warn(
 						"No configured name present, using `worker` as a prefix for the title"
@@ -94,9 +92,9 @@ export const kvNamespace = (kvYargs: Argv<CommonYargsOptions>) => {
 		.command(
 			"list",
 			"Outputs a list of all KV namespaces associated with your account id.",
-			{},
+			(listArgs) => listArgs,
 			async (args) => {
-				const config = readConfig(args.config as ConfigPath, args);
+				const config = readConfig(args.config, args);
 
 				const accountId = await requireAuth(config);
 
@@ -133,7 +131,7 @@ export const kvNamespace = (kvYargs: Argv<CommonYargsOptions>) => {
 			},
 			async (args) => {
 				await printWranglerBanner();
-				const config = readConfig(args.config as ConfigPath, args);
+				const config = readConfig(args.config, args);
 
 				let id;
 				try {
@@ -172,9 +170,9 @@ export const kvNamespace = (kvYargs: Argv<CommonYargsOptions>) => {
 				// TODO: delete the preview namespace as well?
 			}
 		);
-};
+}
 
-export const kvKey = (kvYargs: Argv<CommonYargsOptions>) => {
+export const kvKey = (kvYargs: CommonYargsArgv) => {
 	return kvYargs
 		.command(
 			"put <key> [value]",
@@ -231,7 +229,7 @@ export const kvKey = (kvYargs: Argv<CommonYargsOptions>) => {
 			},
 			async ({ key, ttl, expiration, metadata, ...args }) => {
 				await printWranglerBanner();
-				const config = readConfig(args.config as ConfigPath, args);
+				const config = readConfig(args.config, args);
 				const namespaceId = getKVNamespaceId(args, config);
 				// One of `args.path` and `args.value` must be defined
 				const value = args.path
@@ -297,7 +295,7 @@ export const kvKey = (kvYargs: Argv<CommonYargsOptions>) => {
 			},
 			async ({ prefix, ...args }) => {
 				// TODO: support for limit+cursor (pagination)
-				const config = readConfig(args.config as ConfigPath, args);
+				const config = readConfig(args.config, args);
 				const namespaceId = getKVNamespaceId(args, config);
 
 				const accountId = await requireAuth(config);
@@ -351,7 +349,7 @@ export const kvKey = (kvYargs: Argv<CommonYargsOptions>) => {
 					});
 			},
 			async ({ key, ...args }) => {
-				const config = readConfig(args.config as ConfigPath, args);
+				const config = readConfig(args.config, args);
 				const namespaceId = getKVNamespaceId(args, config);
 
 				const accountId = await requireAuth(config);
@@ -398,7 +396,7 @@ export const kvKey = (kvYargs: Argv<CommonYargsOptions>) => {
 			},
 			async ({ key, ...args }) => {
 				await printWranglerBanner();
-				const config = readConfig(args.config as ConfigPath, args);
+				const config = readConfig(args.config, args);
 				const namespaceId = getKVNamespaceId(args, config);
 
 				logger.log(`Deleting the key "${key}" on namespace ${namespaceId}.`);
@@ -413,7 +411,7 @@ export const kvKey = (kvYargs: Argv<CommonYargsOptions>) => {
 		);
 };
 
-export const kvBulk = (kvYargs: Argv<CommonYargsOptions>) => {
+export const kvBulk = (kvYargs: CommonYargsArgv) => {
 	return kvYargs
 		.command(
 			"put <filename>",
@@ -447,7 +445,7 @@ export const kvBulk = (kvYargs: Argv<CommonYargsOptions>) => {
 				// This could be made more efficient with a streaming parser/uploader
 				// but we'll do that in the future if needed.
 
-				const config = readConfig(args.config as ConfigPath, args);
+				const config = readConfig(args.config, args);
 				const namespaceId = getKVNamespaceId(args, config);
 				const content = parseJSON(readFileSync(filename), filename);
 
@@ -541,7 +539,7 @@ export const kvBulk = (kvYargs: Argv<CommonYargsOptions>) => {
 			},
 			async ({ filename, ...args }) => {
 				await printWranglerBanner();
-				const config = readConfig(args.config as ConfigPath, args);
+				const config = readConfig(args.config, args);
 				const namespaceId = getKVNamespaceId(args, config);
 
 				if (!args.force) {

package/src/metrics/send-event.ts

@@ -56,7 +56,8 @@ export type EventNames =
 	| "run dev"
 	| "run dev (api)"
 	| "run pages dev"
-	| "view docs";
+	| "view docs"
+	| "view deployments";
 
 /**
  * Send a metrics event, with no extra properties, to Cloudflare, if usage tracking is enabled.

package/src/pages/build.ts

@@ -1,29 +1,23 @@
-import { writeFileSync } from "node:fs";
-import { tmpdir } from "node:os";
-import { dirname, join, resolve } from "node:path";
+import { dirname } from "node:path";
 import { FatalError } from "../errors";
 import { logger } from "../logger";
 import * as metrics from "../metrics";
-import { toUrlPath } from "../paths";
+import { buildFunctions } from "./buildFunctions";
 import { isInPagesCI } from "./constants";
 import {
 	EXIT_CODE_FUNCTIONS_NO_ROUTES_ERROR,
 	FunctionsNoRoutesError,
 	getFunctionsNoRoutesWarning,
 } from "./errors";
-import { buildPlugin } from "./functions/buildPlugin";
-import { buildWorker } from "./functions/buildWorker";
-import { generateConfigFromFileTree } from "./functions/filepath-routing";
-import { writeRoutesModule } from "./functions/routes";
-import { convertRoutesToRoutesJSONSpec } from "./functions/routes-transformation";
-import { pagesBetaWarning, RUNNING_BUILDERS } from "./utils";
-import type { YargsOptionsToInterface } from "../yargs-types";
-import type { Config } from "./functions/routes";
-import type { Argv } from "yargs";
+import { pagesBetaWarning } from "./utils";
+import type {
+	CommonYargsArgv,
+	StrictYargsOptionsToInterface,
+} from "../yargs-types";
 
-type PagesBuildArgs = YargsOptionsToInterface<typeof Options>;
+export type PagesBuildArgs = StrictYargsOptionsToInterface<typeof Options>;
 
-export function Options(yargs: Argv) {
+export function Options(yargs: CommonYargsArgv) {
 	return yargs
 		.positional("directory", {
 			type: "string",
@@ -156,115 +150,3 @@ export const Handler = async ({
 	}
 	await metrics.sendMetricsEvent("build pages functions");
 };
-
-/**
- * Builds a Functions worker based on the functions directory, with filepath and handler based routing.
- * @throws FunctionsNoRoutesError when there are no routes found in the functions directory
- */
-export async function buildFunctions({
-	outfile,
-	outputConfigPath,
-	functionsDirectory,
-	minify = false,
-	sourcemap = false,
-	fallbackService = "ASSETS",
-	watch = false,
-	onEnd,
-	plugin = false,
-	buildOutputDirectory,
-	routesOutputPath,
-	nodeCompat,
-	local,
-	d1Databases,
-}: Partial<
-	Pick<
-		PagesBuildArgs,
-		| "outputConfigPath"
-		| "minify"
-		| "sourcemap"
-		| "fallbackService"
-		| "watch"
-		| "plugin"
-		| "buildOutputDirectory"
-		| "nodeCompat"
-	>
-> & {
-	functionsDirectory: string;
-	onEnd?: () => void;
-	outfile: Required<PagesBuildArgs>["outfile"];
-	routesOutputPath?: PagesBuildArgs["outputRoutesPath"];
-	local: boolean;
-	d1Databases?: string[];
-}) {
-	RUNNING_BUILDERS.forEach(
-		(runningBuilder) => runningBuilder.stop && runningBuilder.stop()
-	);
-
-	const routesModule = join(tmpdir(), `./functionsRoutes-${Math.random()}.mjs`);
-	const baseURL = toUrlPath("/");
-
-	const config: Config = await generateConfigFromFileTree({
-		baseDir: functionsDirectory,
-		baseURL,
-	});
-
-	if (!config.routes || config.routes.length === 0) {
-		throw new FunctionsNoRoutesError(
-			`Failed to find any routes while compiling Functions in: ${functionsDirectory}`
-		);
-	}
-
-	if (routesOutputPath) {
-		const routesJSON = convertRoutesToRoutesJSONSpec(config.routes);
-		writeFileSync(routesOutputPath, JSON.stringify(routesJSON, null, 2));
-	}
-
-	if (outputConfigPath) {
-		writeFileSync(
-			outputConfigPath,
-			JSON.stringify({ ...config, baseURL }, null, 2)
-		);
-	}
-
-	await writeRoutesModule({
-		config,
-		srcDir: functionsDirectory,
-		outfile: routesModule,
-	});
-
-	const absoluteFunctionsDirectory = resolve(functionsDirectory);
-
-	if (plugin) {
-		RUNNING_BUILDERS.push(
-			await buildPlugin({
-				routesModule,
-				outfile,
-				minify,
-				sourcemap,
-				watch,
-				nodeCompat,
-				functionsDirectory: absoluteFunctionsDirectory,
-				local,
-				betaD1Shims: d1Databases,
-				onEnd,
-			})
-		);
-	} else {
-		RUNNING_BUILDERS.push(
-			await buildWorker({
-				routesModule,
-				outfile,
-				minify,
-				sourcemap,
-				fallbackService,
-				watch,
-				functionsDirectory: absoluteFunctionsDirectory,
-				local,
-				betaD1Shims: d1Databases,
-				onEnd,
-				buildOutputDirectory,
-				nodeCompat,
-			})
-		);
-	}
-}

package/src/pages/buildFunctions.ts

@@ -0,0 +1,129 @@
+import { writeFileSync } from "node:fs";
+import { tmpdir } from "node:os";
+import { join, resolve } from "node:path";
+import { toUrlPath } from "../paths";
+import { FunctionsNoRoutesError } from "./errors";
+import { buildPlugin } from "./functions/buildPlugin";
+import { buildWorker } from "./functions/buildWorker";
+import { generateConfigFromFileTree } from "./functions/filepath-routing";
+import { writeRoutesModule } from "./functions/routes";
+import { convertRoutesToRoutesJSONSpec } from "./functions/routes-transformation";
+import { RUNNING_BUILDERS } from "./utils";
+import type { PagesBuildArgs } from "./build";
+import type { Config } from "./functions/routes";
+
+/**
+ * Builds a Functions worker based on the functions directory, with filepath and handler based routing.
+ * @throws FunctionsNoRoutesError when there are no routes found in the functions directory
+ */
+
+export async function buildFunctions({
+	outfile,
+	outputConfigPath,
+	functionsDirectory,
+	minify = false,
+	sourcemap = false,
+	fallbackService = "ASSETS",
+	watch = false,
+	onEnd,
+	plugin = false,
+	buildOutputDirectory,
+	routesOutputPath,
+	nodeCompat,
+	local,
+	d1Databases,
+	experimentalWorkerBundle = false,
+}: Partial<
+	Pick<
+		PagesBuildArgs,
+		| "outputConfigPath"
+		| "minify"
+		| "sourcemap"
+		| "fallbackService"
+		| "watch"
+		| "plugin"
+		| "buildOutputDirectory"
+		| "nodeCompat"
+	>
+> & {
+	functionsDirectory: string;
+	onEnd?: () => void;
+	outfile: Required<PagesBuildArgs>["outfile"];
+	routesOutputPath?: PagesBuildArgs["outputRoutesPath"];
+	local: boolean;
+	d1Databases?: string[];
+	experimentalWorkerBundle?: boolean;
+}) {
+	RUNNING_BUILDERS.forEach(
+		(runningBuilder) => runningBuilder.stop && runningBuilder.stop()
+	);
+
+	const routesModule = join(tmpdir(), `./functionsRoutes-${Math.random()}.mjs`);
+	const baseURL = toUrlPath("/");
+
+	const config: Config = await generateConfigFromFileTree({
+		baseDir: functionsDirectory,
+		baseURL,
+	});
+
+	if (!config.routes || config.routes.length === 0) {
+		throw new FunctionsNoRoutesError(
+			`Failed to find any routes while compiling Functions in: ${functionsDirectory}`
+		);
+	}
+
+	if (routesOutputPath) {
+		const routesJSON = convertRoutesToRoutesJSONSpec(config.routes);
+		writeFileSync(routesOutputPath, JSON.stringify(routesJSON, null, 2));
+	}
+
+	if (outputConfigPath) {
+		writeFileSync(
+			outputConfigPath,
+			JSON.stringify({ ...config, baseURL }, null, 2)
+		);
+	}
+
+	await writeRoutesModule({
+		config,
+		srcDir: functionsDirectory,
+		outfile: routesModule,
+	});
+
+	const absoluteFunctionsDirectory = resolve(functionsDirectory);
+
+	if (plugin) {
+		RUNNING_BUILDERS.push(
+			await buildPlugin({
+				routesModule,
+				outfile,
+				minify,
+				sourcemap,
+				watch,
+				nodeCompat,
+				functionsDirectory: absoluteFunctionsDirectory,
+				local,
+				betaD1Shims: d1Databases,
+				onEnd,
+			})
+		);
+	} else {
+		RUNNING_BUILDERS.push(
+			await buildWorker({
+				routesModule,
+				outfile,
+				minify,
+				sourcemap,
+				fallbackService,
+				watch,
+				functionsDirectory: absoluteFunctionsDirectory,
+				local,
+				betaD1Shims: d1Databases,
+				onEnd,
+				buildOutputDirectory,
+				nodeCompat,
+				experimentalWorkerBundle,
+			})
+		);
+	}
+}

package/src/pages/deployment-tails.ts

@@ -18,15 +18,12 @@ import { requireAuth } from "../user";
 import { PAGES_CONFIG_CACHE_FILENAME } from "./constants";
 import { promptSelectProject } from "./prompt-select-project";
 import { isUrl } from "./utils";
-import type { ConfigPath } from "..";
-import type { YargsOptionsToInterface } from "../yargs-types";
+import type {
+	CommonYargsArgv,
+	StrictYargsOptionsToInterface,
+} from "../yargs-types";
 import type { Deployment, PagesConfigCache } from "./types";
-import type { Argv } from "yargs";
 
-type Options = YargsOptionsToInterface<typeof Options> & {
-	// Global flag
-	config?: string;
-};
 const statusChoices = ["ok", "error", "canceled"] as const;
 type StatusChoice = typeof statusChoices[number];
 const isStatusChoiceList = (
@@ -35,7 +32,7 @@ const isStatusChoiceList = (
 ): data is StatusChoice[] =>
 	data?.every((d) => statusChoices.includes(d)) ?? false;
 
-export function Options(yargs: Argv) {
+export function Options(yargs: CommonYargsArgv) {
 	return (
 		yargs
 			.positional("deployment", {
@@ -122,7 +119,7 @@ export async function Handler({
 	format = "pretty",
 	debug,
 	...args
-}: Options) {
+}: StrictYargsOptionsToInterface<typeof Options>) {
 	if (status && !isStatusChoiceList(status)) {
 		throw new FatalError(
 			"Invalid value for `--status`. Valid options: " + statusChoices.join(", ")
@@ -133,7 +130,7 @@ export async function Handler({
 		await printWranglerBanner();
 	}
 
-	const config = readConfig(args.config as ConfigPath, args);
+	const config = readConfig(args.config, args);
 	const pagesConfig = getConfigCache<PagesConfigCache>(
 		PAGES_CONFIG_CACHE_FILENAME
 	);

package/src/pages/deployments.tsx

@@ -10,13 +10,15 @@ import { requireAuth } from "../user";
 import { PAGES_CONFIG_CACHE_FILENAME } from "./constants";
 import { promptSelectProject } from "./prompt-select-project";
 import { pagesBetaWarning } from "./utils";
-import type { YargsOptionsToInterface } from "../yargs-types";
+import type {
+	CommonYargsArgv,
+	StrictYargsOptionsToInterface,
+} from "../yargs-types";
 import type { Deployment, PagesConfigCache } from "./types";
-import type { Argv } from "yargs";
 
-type ListArgs = YargsOptionsToInterface<typeof ListOptions>;
+type ListArgs = StrictYargsOptionsToInterface<typeof ListOptions>;
 
-export function ListOptions(yargs: Argv) {
+export function ListOptions(yargs: CommonYargsArgv) {
 	return yargs
 		.options({
 			"project-name": {

package/src/pages/dev.ts

@@ -10,24 +10,24 @@ import { FatalError } from "../errors";
 import { logger } from "../logger";
 import * as metrics from "../metrics";
 import { getBasePath } from "../paths";
-import { buildFunctions } from "./build";
+import { buildFunctions } from "./buildFunctions";
 import { ROUTES_SPEC_VERSION, SECONDS_TO_WAIT_FOR_PROXY } from "./constants";
 import { FunctionsNoRoutesError, getFunctionsNoRoutesWarning } from "./errors";
 import { buildRawWorker, checkRawWorker } from "./functions/buildWorker";
 import { validateRoutes } from "./functions/routes-validation";
 import { CLEANUP, CLEANUP_CALLBACKS, pagesBetaWarning } from "./utils";
 import type { AdditionalDevProps } from "../dev";
-import type { YargsOptionsToInterface } from "../yargs-types";
+import type {
+	CommonYargsArgv,
+	StrictYargsOptionsToInterface,
+} from "../yargs-types";
 import type { RoutesJSONSpec } from "./functions/routes-transformation";
-import type { Argv } from "yargs";
 
 const DURABLE_OBJECTS_BINDING_REGEXP = new RegExp(
 	/^(?<binding>[^=]+)=(?<className>[^@\s]+)(@(?<scriptName>.*)$)?$/
 );
 
-type PagesDevArgs = YargsOptionsToInterface<typeof Options>;
-
-export function Options(yargs: Argv) {
+export function Options(yargs: CommonYargsArgv) {
 	return yargs
 		.positional("directory", {
 			type: "string",
@@ -89,6 +89,13 @@ export function Options(yargs: Argv) {
 				default: true,
 				description: "Whether to run bundling on `_worker.js`",
 			},
+			"experimental-worker-bundle": {
+				type: "boolean",
+				default: false,
+				hidden: true,
+				description:
+					"Whether to process non-JS module imports or not, such as wasm/text/binary, when we run bundling on `functions` or `_worker.js`",
+			},
 			binding: {
 				type: "array",
 				description: "Bind variable/secret (KEY=VALUE)",
@@ -166,38 +173,37 @@ export function Options(yargs: Argv) {
 export const Handler = async ({
 	local,
 	directory,
-	"compatibility-date": compatibilityDate,
-	"compatibility-flags": compatibilityFlags,
+	compatibilityDate,
+	compatibilityFlags,
 	ip,
 	port,
-	"inspector-port": inspectorPort,
+	inspectorPort,
 	proxy: requestedProxyPort,
-	"script-path": singleWorkerScriptPath,
 	bundle,
 	noBundle,
+	experimentalWorkerBundle,
+	scriptPath: singleWorkerScriptPath,
 	binding: bindings = [],
 	kv: kvs = [],
 	do: durableObjects = [],
 	d1: d1s = [],
 	r2: r2s = [],
-	"live-reload": liveReload,
-	"local-protocol": localProtocol,
+	liveReload,
+	localProtocol,
 	experimentalEnableLocalPersistence,
 	persist,
 	persistTo,
-	"node-compat": nodeCompat,
-	"experimental-local": experimentalLocal,
+	nodeCompat,
+	experimentalLocal,
 	config: config,
 	_: [_pages, _dev, ...remaining],
 	logLevel,
-}: PagesDevArgs) => {
+}: StrictYargsOptionsToInterface<typeof Options>) => {
 	// Beta message for `wrangler pages <commands>` usage
 	logger.log(pagesBetaWarning);
 
-	type LogLevelArg = "debug" | "info" | "log" | "warn" | "error" | "none";
 	if (logLevel) {
-		// The YargsOptionsToInterface doesn't handle the passing in of Unions from choices in Yargs
-		logger.loggerLevel = logLevel as LogLevelArg;
+		logger.loggerLevel = logLevel;
 	}
 
 	if (!local) {
@@ -270,7 +276,7 @@ export const Handler = async ({
 			await checkRawWorker(workerScriptPath, () => scriptReadyResolve());
 		};
 
-		const enableBundling = bundle || !noBundle;
+		const enableBundling = bundle || !noBundle || experimentalWorkerBundle;
 		if (enableBundling) {
 			// We want to actually run the `_worker.js` script through the bundler
 			// So update the final path to the script that will be uploaded and
@@ -286,6 +292,7 @@ export const Handler = async ({
 						sourcemap: true,
 						watch: true,
 						onEnd: () => scriptReadyResolve(),
+						experimentalWorkerBundle,
 					});
 				} catch (e: unknown) {
 					logger.warn("Failed to bundle _worker.js.", e);
@@ -323,6 +330,7 @@ export const Handler = async ({
 					buildOutputDirectory: directory,
 					nodeCompat,
 					local: true,
+					experimentalWorkerBundle,
 				});
 				await metrics.sendMetricsEvent("build pages functions");
 			};

package/src/pages/functions/buildPlugin.ts

@@ -37,6 +37,7 @@ export function buildPlugin({
 			betaD1Shims: (betaD1Shims || []).map(
 				(binding) => `${D1_BETA_PREFIX}${binding}`
 			),
+			doBindings: [], // Pages functions don't support internal Durable Objects
 			plugins: [
 				buildNotifierPlugin(onEnd),
 				{

package/src/pages/functions/buildWorker.ts

@@ -21,6 +21,7 @@ export type Options = {
 	functionsDirectory: string;
 	local: boolean;
 	betaD1Shims?: string[];
+	experimentalWorkerBundle?: boolean;
 };
 
 export function buildWorker({
@@ -36,6 +37,7 @@ export function buildWorker({
 	functionsDirectory,
 	local,
 	betaD1Shims,
+	experimentalWorkerBundle = false,
 }: Options) {
 	return bundleWorker(
 		{
@@ -60,6 +62,7 @@ export function buildWorker({
 			betaD1Shims: (betaD1Shims || []).map(
 				(binding) => `${D1_BETA_PREFIX}${binding}`
 			),
+			doBindings: [], // Pages functions don't support internal Durable Objects
 			plugins: [
 				buildNotifierPlugin(onEnd),
 				{
@@ -139,7 +142,7 @@ export function buildWorker({
 			],
 			isOutfile: true,
 			serveAssetsFromWorker: false,
-			disableModuleCollection: true,
+			disableModuleCollection: experimentalWorkerBundle ? false : true,
 			rules: [],
 			checkFetch: local,
 			targetConsumer: local ? "dev" : "publish",
@@ -162,6 +165,7 @@ export type RawOptions = {
 	nodeCompat?: boolean;
 	local: boolean;
 	betaD1Shims?: string[];
+	experimentalWorkerBundle?: boolean;
 };
 
 /**
@@ -183,6 +187,7 @@ export function buildRawWorker({
 	nodeCompat,
 	local,
 	betaD1Shims,
+	experimentalWorkerBundle = false,
 }: RawOptions) {
 	return bundleWorker(
 		{
@@ -204,10 +209,11 @@ export function buildRawWorker({
 			betaD1Shims: (betaD1Shims || []).map(
 				(binding) => `${D1_BETA_PREFIX}${binding}`
 			),
+			doBindings: [], // Pages functions don't support internal Durable Objects
 			plugins: [...plugins, buildNotifierPlugin(onEnd)],
 			isOutfile: true,
 			serveAssetsFromWorker: false,
-			disableModuleCollection: true,
+			disableModuleCollection: experimentalWorkerBundle ? false : true,
 			rules: [],
 			checkFetch: local,
 			targetConsumer: local ? "dev" : "publish",