wrangler 0.0.0-e7a0cd5b → 0.0.0-e7cf0caa

package/src/__tests__/worker-namespace.test.ts

@@ -1,7 +1,11 @@
 import { rest } from "msw";
 import { mockAccountId, mockApiToken } from "./helpers/mock-account-id";
 import { mockConsoleMethods } from "./helpers/mock-console";
-import { msw, mswSuccessNamespacesHandlers } from "./helpers/msw";
+import {
+	createFetchResult,
+	msw,
+	mswSuccessNamespacesHandlers,
+} from "./helpers/msw";
 import { runInTempDir } from "./helpers/run-in-tmp";
 import { runWrangler } from "./helpers/run-wrangler";
 
@@ -13,7 +17,7 @@ describe("dispatch-namespace", () => {
 	mockAccountId();
 	mockApiToken();
 
-	it("should should display a list of available subcommands, for dispatch-namespace with no subcommand", async () => {
+	it("should display a list of available subcommands, for dispatch-namespace with no subcommand", async () => {
 		await runWrangler("dispatch-namespace");
 
 		// wait a tick for the help menu to be printed
@@ -23,6 +27,7 @@ describe("dispatch-namespace", () => {
 		Object {
 		  "debug": "",
 		  "err": "",
+		  "info": "",
 		  "out": "wrangler dispatch-namespace
 
 		📦 Interact with a dispatch namespace
@@ -35,10 +40,11 @@ describe("dispatch-namespace", () => {
 		  wrangler dispatch-namespace rename <old-name> <new-name>  Rename a dispatch namespace
 
 		Flags:
-		  -c, --config   Path to .toml configuration file  [string]
-		  -e, --env      Environment to use for operations and .env files  [string]
-		  -h, --help     Show help  [boolean]
-		  -v, --version  Show version number  [boolean]",
+		  -j, --experimental-json-config  Experimental: Support wrangler.json  [boolean]
+		  -c, --config                    Path to .toml configuration file  [string]
+		  -e, --env                       Environment to use for operations and .env files  [string]
+		  -h, --help                      Show help  [boolean]
+		  -v, --version                   Show version number  [boolean]",
 		  "warn": "",
 		}
 	`);
@@ -49,22 +55,23 @@ describe("dispatch-namespace", () => {
 		let counter = 0;
 		msw.use(
 			rest.post(
-				"/accounts/:accountId/workers/dispatch/namespaces/:namespaceNameParam",
-				(req, res, cxt) => {
+				"*/accounts/:accountId/workers/dispatch/namespaces/:namespaceNameParam",
+				(req, res, ctx) => {
 					counter++;
 					const { namespaceNameParam } = req.params;
 					expect(counter).toBe(1);
 					expect(namespaceNameParam).toBe(namespaceName);
 					return res.once(
-						cxt.status(200),
-						cxt.json({
-							namespace_id: "some-namespace-id",
-							namespace_name: "namespace-name",
-							created_on: "2022-06-29T14:30:08.16152Z",
-							created_by: "1fc1df98cc4420fe00367c3ab68c1639",
-							modified_on: "2022-06-29T14:30:08.16152Z",
-							modified_by: "1fc1df98cc4420fe00367c3ab68c1639",
-						})
+						ctx.json(
+							createFetchResult({
+								namespace_id: "some-namespace-id",
+								namespace_name: "namespace-name",
+								created_on: "2022-06-29T14:30:08.16152Z",
+								created_by: "1fc1df98cc4420fe00367c3ab68c1639",
+								modified_on: "2022-06-29T14:30:08.16152Z",
+								modified_by: "1fc1df98cc4420fe00367c3ab68c1639",
+							})
+						)
 					);
 				}
 			)
@@ -87,10 +94,11 @@ describe("dispatch-namespace", () => {
 			  name  Name of the dispatch namespace  [string] [required]
 
 			Flags:
-			  -c, --config   Path to .toml configuration file  [string]
-			  -e, --env      Environment to use for operations and .env files  [string]
-			  -h, --help     Show help  [boolean]
-			  -v, --version  Show version number  [boolean]"
+			  -j, --experimental-json-config  Experimental: Support wrangler.json  [boolean]
+			  -c, --config                    Path to .toml configuration file  [string]
+			  -e, --env                       Environment to use for operations and .env files  [string]
+			  -h, --help                      Show help  [boolean]
+			  -v, --version                   Show version number  [boolean]"
 		`);
 		});
 
@@ -108,13 +116,13 @@ describe("dispatch-namespace", () => {
 		let counter = 0;
 		msw.use(
 			rest.delete(
-				"/accounts/:accountId/workers/dispatch/namespaces/:namespaceNameParam",
-				(req, res, cxt) => {
+				"*/accounts/:accountId/workers/dispatch/namespaces/:namespaceNameParam",
+				(req, res, ctx) => {
 					counter++;
 					const { namespaceNameParam } = req.params;
 					expect(counter).toBe(1);
 					expect(namespaceNameParam).toBe(namespaceName);
-					return res.once(cxt.status(200), cxt.json(null));
+					return res.once(ctx.json(null));
 				}
 			)
 		);
@@ -136,10 +144,11 @@ describe("dispatch-namespace", () => {
 			  name  Name of the dispatch namespace  [string] [required]
 
 			Flags:
-			  -c, --config   Path to .toml configuration file  [string]
-			  -e, --env      Environment to use for operations and .env files  [string]
-			  -h, --help     Show help  [boolean]
-			  -v, --version  Show version number  [boolean]"
+			  -j, --experimental-json-config  Experimental: Support wrangler.json  [boolean]
+			  -c, --config                    Path to .toml configuration file  [string]
+			  -e, --env                       Environment to use for operations and .env files  [string]
+			  -h, --help                      Show help  [boolean]
+			  -v, --version                   Show version number  [boolean]"
 		`);
 		});
 
@@ -157,22 +166,23 @@ describe("dispatch-namespace", () => {
 		let counter = 0;
 		msw.use(
 			rest.get(
-				"/accounts/:accountId/workers/dispatch/namespaces/:namespaceNameParam",
-				(req, res, cxt) => {
+				"*/accounts/:accountId/workers/dispatch/namespaces/:namespaceNameParam",
+				(req, res, ctx) => {
 					counter++;
 					const { namespaceNameParam } = req.params;
 					expect(counter).toBe(1);
 					expect(namespaceNameParam).toBe(namespaceName);
 					return res.once(
-						cxt.status(200),
-						cxt.json({
-							namespace_id: "some-namespace-id",
-							namespace_name: "namespace-name",
-							created_on: "2022-06-29T14:30:08.16152Z",
-							created_by: "1fc1df98cc4420fe00367c3ab68c1639",
-							modified_on: "2022-06-29T14:30:08.16152Z",
-							modified_by: "1fc1df98cc4420fe00367c3ab68c1639",
-						})
+						ctx.json(
+							createFetchResult({
+								namespace_id: "some-namespace-id",
+								namespace_name: "namespace-name",
+								created_on: "2022-06-29T14:30:08.16152Z",
+								created_by: "1fc1df98cc4420fe00367c3ab68c1639",
+								modified_on: "2022-06-29T14:30:08.16152Z",
+								modified_by: "1fc1df98cc4420fe00367c3ab68c1639",
+							})
+						)
 					);
 				}
 			)
@@ -195,10 +205,11 @@ describe("dispatch-namespace", () => {
 			  name  Name of the dispatch namespace  [string] [required]
 
 			Flags:
-			  -c, --config   Path to .toml configuration file  [string]
-			  -e, --env      Environment to use for operations and .env files  [string]
-			  -h, --help     Show help  [boolean]
-			  -v, --version  Show version number  [boolean]"
+			  -j, --experimental-json-config  Experimental: Support wrangler.json  [boolean]
+			  -c, --config                    Path to .toml configuration file  [string]
+			  -e, --env                       Environment to use for operations and .env files  [string]
+			  -h, --help                      Show help  [boolean]
+			  -v, --version                   Show version number  [boolean]"
 		`);
 		});
 
@@ -223,22 +234,23 @@ describe("dispatch-namespace", () => {
 		let counter = 0;
 		msw.use(
 			rest.get(
-				"/accounts/:accountId/workers/dispatch/namespaces/:namespaceNameParam",
-				(req, res, cxt) => {
+				"*/accounts/:accountId/workers/dispatch/namespaces/:namespaceNameParam",
+				(req, res, ctx) => {
 					counter++;
 					const { namespaceNameParam } = req.params;
 					expect(counter).toBe(1);
 					expect(namespaceNameParam).toBe(namespaceName);
 					return res.once(
-						cxt.status(200),
-						cxt.json({
-							namespace_id: "some-namespace-id",
-							namespace_name: "namespace-name",
-							created_on: "2022-06-29T14:30:08.16152Z",
-							created_by: "1fc1df98cc4420fe00367c3ab68c1639",
-							modified_on: "2022-06-29T14:30:08.16152Z",
-							modified_by: "1fc1df98cc4420fe00367c3ab68c1639",
-						})
+						ctx.json(
+							createFetchResult({
+								namespace_id: "some-namespace-id",
+								namespace_name: "namespace-name",
+								created_on: "2022-06-29T14:30:08.16152Z",
+								created_by: "1fc1df98cc4420fe00367c3ab68c1639",
+								modified_on: "2022-06-29T14:30:08.16152Z",
+								modified_by: "1fc1df98cc4420fe00367c3ab68c1639",
+							})
+						)
 					);
 				}
 			)
@@ -266,22 +278,23 @@ describe("dispatch-namespace", () => {
 		let counter = 0;
 		msw.use(
 			rest.put(
-				"/accounts/:accountId/workers/dispatch/namespaces/:namespaceNameParam",
-				(req, res, cxt) => {
+				"*/accounts/:accountId/workers/dispatch/namespaces/:namespaceNameParam",
+				(req, res, ctx) => {
 					counter++;
 					const { namespaceNameParam } = req.params;
 					expect(counter).toBe(1);
 					expect(namespaceNameParam).toBe(namespaceName);
 					return res.once(
-						cxt.status(200),
-						cxt.json({
-							namespace_id: "some-namespace-id",
-							namespace_name: "namespace-name",
-							created_on: "2022-06-29T14:30:08.16152Z",
-							created_by: "1fc1df98cc4420fe00367c3ab68c1639",
-							modified_on: "2022-06-29T14:30:08.16152Z",
-							modified_by: "1fc1df98cc4420fe00367c3ab68c1639",
-						})
+						ctx.json(
+							createFetchResult({
+								namespace_id: "some-namespace-id",
+								namespace_name: "namespace-name",
+								created_on: "2022-06-29T14:30:08.16152Z",
+								created_by: "1fc1df98cc4420fe00367c3ab68c1639",
+								modified_on: "2022-06-29T14:30:08.16152Z",
+								modified_by: "1fc1df98cc4420fe00367c3ab68c1639",
+							})
+						)
 					);
 				}
 			)
@@ -305,10 +318,11 @@ describe("dispatch-namespace", () => {
 			  new-name  New name of the dispatch namespace  [string] [required]
 
 			Flags:
-			  -c, --config   Path to .toml configuration file  [string]
-			  -e, --env      Environment to use for operations and .env files  [string]
-			  -h, --help     Show help  [boolean]
-			  -v, --version  Show version number  [boolean]"
+			  -j, --experimental-json-config  Experimental: Support wrangler.json  [boolean]
+			  -c, --config                    Path to .toml configuration file  [string]
+			  -e, --env                       Environment to use for operations and .env files  [string]
+			  -h, --help                      Show help  [boolean]
+			  -v, --version                   Show version number  [boolean]"
 		`);
 		});
 

package/src/api/dev.ts

@@ -3,28 +3,26 @@ import { startApiDev, startDev } from "../dev";
 import { logger } from "../logger";
 
 import type { Environment } from "../config";
-import type { EnablePagesAssetsServiceBindingOptions } from "../miniflare-cli";
+import type { EnablePagesAssetsServiceBindingOptions } from "../miniflare-cli/types";
 import type { RequestInit, Response, RequestInfo } from "undici";
 
-interface DevOptions {
-	config?: string;
-	env?: string;
-	ip?: string;
-	port?: number;
-	bundle?: boolean;
-	inspectorPort?: number;
-	localProtocol?: "http" | "https";
-	assets?: string;
-	site?: string;
-	siteInclude?: string[];
-	siteExclude?: string[];
-	nodeCompat?: boolean;
-	compatibilityDate?: string;
-	compatibilityFlags?: string[];
-	persist?: boolean;
-	persistTo?: string;
-	liveReload?: boolean;
-	watch?: boolean;
+export interface UnstableDevOptions {
+	config?: string; // Path to .toml configuration file, relative to cwd
+	env?: string; // Environment to use for operations and .env files
+	ip?: string; // IP address to listen on
+	port?: number; // Port to listen on
+	bundle?: boolean; // Set to false to skip internal build steps and directly publish script
+	inspectorPort?: number; // Port for devtools to connect to
+	localProtocol?: "http" | "https"; // Protocol to listen to requests on, defaults to http.
+	assets?: string; // Static assets to be served
+	site?: string; // Root folder of static assets for Workers Sites
+	siteInclude?: string[]; // Array of .gitignore-style patterns that match file or directory names from the sites directory. Only matched items will be uploaded.
+	siteExclude?: string[]; // Array of .gitignore-style patterns that match file or directory names from the sites directory. Matched items will not be uploaded.
+	nodeCompat?: boolean; // Enable Node.js compatibility
+	compatibilityDate?: string; // Date to use for compatibility checks
+	compatibilityFlags?: string[]; // Flags to use for compatibility checks
+	persist?: boolean; // Enable persistence for local mode, using default path: .wrangler/state
+	persistTo?: string; // Specify directory to use for local persistence (implies --persist)
 	vars?: {
 		[key: string]: unknown;
 	};
@@ -44,23 +42,24 @@ interface DevOptions {
 		bucket_name: string;
 		preview_bucket_name?: string;
 	}[];
-	d1Databases?: Environment["d1_databases"];
-	showInteractiveDevSession?: boolean;
-	logLevel?: "none" | "info" | "error" | "log" | "warn" | "debug";
-	logPrefix?: string;
+	logLevel?: "none" | "info" | "error" | "log" | "warn" | "debug"; // Specify logging level  [choices: "debug", "info", "log", "warn", "error", "none"] [default: "log"]
 	inspect?: boolean;
 	local?: boolean;
-	forceLocal?: boolean;
-	enablePagesAssetsServiceBinding?: EnablePagesAssetsServiceBindingOptions;
-	_?: (string | number)[]; //yargs wants this
-	$0?: string; //yargs wants this
-	testScheduled?: boolean;
-	experimentalLocal?: boolean;
-}
-
-interface DevApiOptions {
-	testMode?: boolean;
-	disableExperimentalWarning?: boolean;
+	accountId?: string;
+	experimental?: {
+		d1Databases?: Environment["d1_databases"];
+		disableExperimentalWarning?: boolean; // Disables wrangler's warning when unstable APIs are used.
+		disableDevRegistry?: boolean; // Disables wrangler's support multi-worker setups. May reduce flakiness when used in tests in CI.
+		enablePagesAssetsServiceBinding?: EnablePagesAssetsServiceBindingOptions;
+		experimentalLocal?: boolean; // Use Miniflare 3 instead of Miniflare 2
+		experimentalLocalRemoteKv?: boolean;
+		forceLocal?: boolean;
+		liveReload?: boolean; // Auto reload HTML pages when change is detected in local mode
+		showInteractiveDevSession?: boolean;
+		testMode?: boolean; // This option shouldn't be used - We plan on removing it eventually
+		testScheduled?: boolean; // Test scheduled events by visiting /__scheduled in browser
+		watch?: boolean; // unstable_dev doesn't support watch-mode yet in testMode
+	};
 }
 
 export interface UnstableDevWorker {
@@ -75,11 +74,44 @@ export interface UnstableDevWorker {
  */
 export async function unstable_dev(
 	script: string,
-	options?: DevOptions,
-	apiOptions?: DevApiOptions
+	options?: UnstableDevOptions,
+	apiOptions?: unknown
 ): Promise<UnstableDevWorker> {
-	const { testMode = true, disableExperimentalWarning = false } =
-		apiOptions || {};
+	// Note that not every experimental option is passed directly through to the underlying dev API - experimental options can be used here in unstable_dev. Otherwise we could just pass experimental down to dev blindly.
+
+	const experimentalOptions = {
+		// Defaults for "experimental" options
+		disableDevRegistry: false,
+		disableExperimentalWarning: false,
+		showInteractiveDevSession: false,
+		testMode: true,
+		// Override all options, including overwriting with "undefined"
+		...options?.experimental,
+	};
+
+	const {
+		// there are two types of "experimental" options:
+		// 1. options to unstable_dev that we're still testing or are unsure of
+		disableDevRegistry,
+		disableExperimentalWarning,
+		forceLocal,
+		liveReload,
+		showInteractiveDevSession,
+		testMode,
+		testScheduled,
+		// 2. options for alpha/beta products/libs
+		d1Databases,
+		experimentalLocal,
+		experimentalLocalRemoteKv,
+		enablePagesAssetsServiceBinding,
+	} = experimentalOptions;
+
+	if (apiOptions) {
+		logger.error(
+			"unstable_dev's third argument (apiOptions) has been deprecated in favor of an `experimental` property within the second argument (options).\nPlease update your code from:\n`await unstable_dev('...', {...}, {...});`\nto:\n`await unstable_dev('...', {..., experimental: {...}});`"
+		);
+	}
+
 	if (!disableExperimentalWarning) {
 		logger.warn(
 			`unstable_dev() is experimental\nunstable_dev()'s behaviour will likely change in future releases`
@@ -99,17 +131,59 @@ export async function unstable_dev(
 					script: script,
 					inspect: false,
 					logLevel: "none",
-					showInteractiveDevSession: false,
 					_: [],
 					$0: "",
 					port: options?.port ?? 0,
 					local: true,
-					...options,
+					d1Databases,
+					disableDevRegistry,
+					testScheduled: testScheduled ?? false,
+					experimentalLocal: experimentalLocal ?? false,
+					experimentalLocalRemoteKv: experimentalLocalRemoteKv ?? false,
+					enablePagesAssetsServiceBinding,
+					liveReload,
+					showInteractiveDevSession,
 					onReady: (address, port) => {
 						readyPort = port;
 						readyAddress = address;
 						ready(devServer);
 					},
+					config: options?.config,
+					env: options?.env,
+					bundle: options?.bundle,
+					compatibilityDate: options?.compatibilityDate,
+					compatibilityFlags: options?.compatibilityFlags,
+					ip: options?.ip,
+					inspectorPort: options?.inspectorPort,
+					v: undefined,
+					localProtocol: options?.localProtocol,
+					assets: options?.assets,
+					site: options?.site, // Root folder of static assets for Workers Sites
+					siteInclude: options?.siteInclude, // Array of .gitignore-style patterns that match file or directory names from the sites directory. Only matched items will be uploaded.
+					siteExclude: options?.siteExclude, // Array of .gitignore-style patterns that match file or directory names from the sites directory. Matched items will not be uploaded.
+					nodeCompat: options?.nodeCompat, // Enable Node.js compatibility
+					persist: options?.persist, // Enable persistence for local mode, using default path: .wrangler/state
+					persistTo: options?.persistTo, // Specify directory to use for local persistence (implies --persist)
+					experimentalJsonConfig: undefined,
+					name: undefined,
+					noBundle: false,
+					format: undefined,
+					latest: false,
+					routes: undefined,
+					host: undefined,
+					localUpstream: undefined,
+					experimentalPublic: undefined,
+					upstreamProtocol: undefined,
+					var: undefined,
+					define: undefined,
+					jsxFactory: undefined,
+					jsxFragment: undefined,
+					tsconfig: undefined,
+					minify: undefined,
+					experimentalEnableLocalPersistence: undefined,
+					legacyEnv: undefined,
+					public: undefined,
+					...options,
 				});
 			}).then((devServer) => {
 				// now that the inner promise has resolved, we can resolve the outer promise
@@ -145,16 +219,61 @@ export async function unstable_dev(
 				const devServer = startDev({
 					script: script,
 					inspect: false,
-					showInteractiveDevSession: false,
 					_: [],
 					$0: "",
+					logLevel: options?.logLevel ?? "log",
+					port: options?.port ?? 0,
 					local: true,
-					...options,
+					showInteractiveDevSession,
+					d1Databases,
+					disableDevRegistry,
+					testScheduled: testScheduled ?? false,
+					experimentalLocal: experimentalLocal ?? false,
+					experimentalLocalRemoteKv: experimentalLocalRemoteKv ?? false,
+					enablePagesAssetsServiceBinding,
+					forceLocal,
+					liveReload,
 					onReady: (address, port) => {
 						readyPort = port;
 						readyAddress = address;
 						ready(devServer);
 					},
+					config: options?.config,
+					env: options?.env,
+					bundle: options?.bundle,
+					compatibilityDate: options?.compatibilityDate,
+					compatibilityFlags: options?.compatibilityFlags,
+					ip: options?.ip,
+					inspectorPort: options?.inspectorPort,
+					v: undefined,
+					localProtocol: options?.localProtocol,
+					assets: options?.assets,
+					site: options?.site, // Root folder of static assets for Workers Sites
+					siteInclude: options?.siteInclude, // Array of .gitignore-style patterns that match file or directory names from the sites directory. Only matched items will be uploaded.
+					siteExclude: options?.siteExclude, // Array of .gitignore-style patterns that match file or directory names from the sites directory. Matched items will not be uploaded.
+					nodeCompat: options?.nodeCompat, // Enable Node.js compatibility
+					persist: options?.persist, // Enable persistence for local mode, using default path: .wrangler/state
+					persistTo: options?.persistTo, // Specify directory to use for local persistence (implies --persist)
+					experimentalJsonConfig: undefined,
+					name: undefined,
+					noBundle: false,
+					format: undefined,
+					latest: false,
+					routes: undefined,
+					host: undefined,
+					localUpstream: undefined,
+					experimentalPublic: undefined,
+					upstreamProtocol: undefined,
+					var: undefined,
+					define: undefined,
+					jsxFactory: undefined,
+					jsxFragment: undefined,
+					tsconfig: undefined,
+					minify: undefined,
+					experimentalEnableLocalPersistence: undefined,
+					legacyEnv: undefined,
+					public: undefined,
+					...options,
 				});
 			}).then((devServer) => {
 				resolve({
@@ -182,27 +301,16 @@ export async function unstable_dev(
 export function parseRequestInput(
 	readyAddress: string,
 	readyPort: number,
-	input?: RequestInfo,
+	input: RequestInfo = "/",
 	init?: RequestInit,
 	protocol: "http" | "https" = "http"
 ): [RequestInfo, RequestInit | undefined] {
 	if (input instanceof Request) {
 		return [input, undefined];
-	} else if (input instanceof URL) {
-		input = `${protocol}://${readyAddress}:${readyPort}${input.pathname}`;
-	} else if (typeof input === "string") {
-		try {
-			// Want to strip the URL to only get the pathname, but the user could pass in only the pathname
-			// Will error if we try and pass "/something" into new URL("/something")
-			input = `${protocol}://${readyAddress}:${readyPort}${
-				new URL(input).pathname
-			}`;
-		} catch {
-			input = `${protocol}://${readyAddress}:${readyPort}${input}`;
-		}
-	} else {
-		input = `${protocol}://${readyAddress}:${readyPort}`;
 	}
-
-	return [input, init];
+	const url = new URL(`${input}`, `${protocol}://${readyAddress}:${readyPort}`);
+	url.protocol = protocol;
+	url.hostname = readyAddress;
+	url.port = readyPort.toString();
+	return [url, init];
 }

package/src/api/index.ts

@@ -1,2 +1,11 @@
 export { unstable_dev } from "./dev";
-export type { UnstableDevWorker } from "./dev";
+export type { UnstableDevWorker, UnstableDevOptions } from "./dev";
+export { unstable_pages } from "./pages";
+export {
+	uploadMTlsCertificate,
+	uploadMTlsCertificateFromFs,
+	listMTlsCertificates,
+	getMTlsCertificate,
+	getMTlsCertificateByName,
+	deleteMTlsCertificate,
+} from "./mtls-certificate";