wrangler 0.0.0-e4ca780f → 0.0.0-e4ef867c

package/README.md

@@ -6,8 +6,6 @@
 <a href="https://discord.gg/CloudflareDev"><img alt="Discord" src="https://img.shields.io/discord/595317990191398933?color=%23F48120&style=flat-square"></a>
 </section>
 
-> This package is for wrangler v2.x, released first in May 2022. If you're looking for v1.x of the `@cloudflare/wrangler` package, visit https://www.npmjs.com/package/@cloudflare/wrangler / https://github.com/cloudflare/wrangler-legacy.
-
 `wrangler` is a command line tool for building [Cloudflare Workers](https://workers.cloudflare.com/).
 
 ## Quick Start
@@ -17,8 +15,8 @@
 echo "export default { fetch() { return new Response('hello world') } }" > index.js
 # try it out
 npx wrangler dev index.js
-# and then publish it
-npx wrangler publish index.js --name my-worker
+# and then deploy it
+npx wrangler deploy index.js --name my-worker
 # visit https://my-worker.<your workers subdomain>.workers.dev
 ```
 
@@ -26,10 +24,10 @@ npx wrangler publish index.js --name my-worker
 
 ```bash
 # Generate a new project
-npx wrangler init my-worker
+npx wrangler init my-worker --no-delegate-c3
 # try it out
 cd my-worker && npm run start
-# and then publish it
+# and then deploy it
 npm run deploy
 ```
 
@@ -43,15 +41,15 @@ $ npm install wrangler --save-dev
 
 Wrangler is configured via a `wrangler.toml` file in the project root. When utilizing the `wrangler init` command, a `wrangler.toml` file will be created for you.
 
-example:
+Example:
 
 ```toml
-main = "./src/index.ts" # init w/ TypeScript
 name = "my-worker"
-compatibility_date = "YYY-MM-DD"
+main = "./src/index.ts" # init w/ TypeScript
+compatibility_date = "YYYY-MM-DD"
 ```
 
-for more detailed information about configuration, see the [documentation](https://developers.cloudflare.com/workers/cli-wrangler/configuration)
+For more detailed information about configuration, refer to the [documentation](https://developers.cloudflare.com/workers/wrangler/configuration/).
 
 ## Commands
 
@@ -63,11 +61,11 @@ Creates a Worker project. For details on configuration keys and values, refer to
 
 Start a local development server, with live reloading and devtools.
 
-### `wrangler publish`
+### `wrangler deploy`
 
 Publish the given script to the worldwide Cloudflare network.
 
-For more commands and options, refer to the [documentation](https://developers.cloudflare.com/workers/cli-wrangler/commands).
+For more commands and options, refer to the [documentation](https://developers.cloudflare.com/workers/wrangler/commands/).
 
 ## Pages
 

package/bin/wrangler.js

@@ -79,80 +79,6 @@ Consider using a Node.js version manager such as https://volta.sh/ or https://gi
 		});
 }
 
-/**
- * Runs a locally-installed version of wrangler, delegating from this version.
- * @throws {MODULE_NOT_FOUND} if there isn't a locally installed version of wrangler.
- */
-function runDelegatedWrangler() {
-	const packageJsonPath = require.resolve("wrangler/package.json", {
-		paths: [process.cwd()],
-	});
-	const {
-		bin: { wrangler: binaryPath },
-		version,
-	} = JSON.parse(fs.readFileSync(packageJsonPath));
-	const resolvedBinaryPath = path.resolve(packageJsonPath, "..", binaryPath);
-
-	// Make sure the user knows we're delegating to a different installation
-	const currentPackageJsonPath = path.resolve(__dirname, "..", "package.json");
-	const currentPackage = JSON.parse(fs.readFileSync(currentPackageJsonPath));
-	const argv = process.argv.slice(2).join(" ");
-	console.log(
-		`Delegating to locally-installed wrangler@${version} over global wrangler@${currentPackage.version}...
-Run \`npx wrangler ${argv}\` to use the local version directly.
-`
-	);
-
-	// this call to `spawn` is simpler because the delegated version will do all
-	// of the other work.
-	return spawn(
-		process.execPath,
-		[resolvedBinaryPath, ...process.argv.slice(2)],
-		{
-			stdio: ["inherit", "inherit", "inherit", "ipc"],
-		}
-	)
-		.on("exit", (code) =>
-			process.exit(code === undefined || code === null ? 0 : code)
-		)
-		.on("message", (message) => {
-			if (process.send) {
-				process.send(message);
-			}
-		});
-}
-
-/**
- * Indicates if this invocation of `wrangler` should delegate
- * to a locally-installed version.
- */
-function shouldDelegate() {
-	try {
-		// `require.resolve` will throw if it can't find
-		// a locally-installed version of `wrangler`
-		const delegatedPackageJson = require.resolve("wrangler/package.json", {
-			paths: [process.cwd()],
-		});
-		const thisPackageJson = path.resolve(__dirname, "..", "package.json");
-		// if it's the same path, then we're already a local install -- no need to delegate
-		return thisPackageJson !== delegatedPackageJson;
-	} catch (e) {
-		// there's no local version to delegate to -- `require.resolve` threw
-		return false;
-	}
-}
-
-async function main() {
-	wranglerProcess = shouldDelegate() ? runDelegatedWrangler() : runWrangler();
-}
-
-process.on("SIGINT", () => {
-	wranglerProcess && wranglerProcess.kill();
-});
-process.on("SIGTERM", () => {
-	wranglerProcess && wranglerProcess.kill();
-});
-
 // semiver implementation via https://github.com/lukeed/semiver/blob/ae7eebe6053c96be63032b14fb0b68e2553fcac4/src/index.js
 
 /**
@@ -185,4 +111,12 @@ function semiver(a, b, bool) {
 
 // end semiver implementation
 
-void main();
+if (module === require.main) {
+	wranglerProcess = runWrangler();
+	process.on("SIGINT", () => {
+		wranglerProcess && wranglerProcess.kill();
+	});
+	process.on("SIGTERM", () => {
+		wranglerProcess && wranglerProcess.kill();
+	});
+}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "wrangler",
-	"version": "0.0.0-e4ca780f",
+	"version": "0.0.0-e4ef867c",
 	"description": "Command-line interface for all things Cloudflare Workers",
 	"keywords": [
 		"wrangler",
@@ -42,14 +42,10 @@
 		"wrangler2": "./bin/wrangler.js"
 	},
 	"files": [
-		"src",
 		"bin",
-		"miniflare-config-stubs",
 		"miniflare-dist",
 		"wrangler-dist",
 		"templates",
-		"vendor",
-		"import_meta_url.js",
 		"kv-asset-handler.js",
 		"Cloudflare_CA.pem"
 	],
@@ -57,17 +53,19 @@
 		"assert-git-version": "node -r esbuild-register scripts/assert-git-version.ts",
 		"build": "npm run clean && npm run bundle && npm run emit-types",
 		"bundle": "node -r esbuild-register scripts/bundle.ts",
-		"check:type": "node -r esbuild-register scripts/tsc-all.ts",
+		"check:lint": "eslint .",
+		"check:type": "tsc",
 		"clean": "rimraf wrangler-dist miniflare-dist emitted-types",
 		"dev": "npm run clean && concurrently -c black,blue --kill-others-on-fail false 'npm run bundle -- --watch' 'npm run check:type -- --watch --preserveWatchOutput'",
 		"emit-types": "tsc -p tsconfig.emit.json && node -r esbuild-register scripts/emit-types.ts",
 		"prepublishOnly": "SOURCEMAPS=false npm run build",
 		"start": "npm run bundle && cross-env NODE_OPTIONS=--enable-source-maps ./bin/wrangler.js",
 		"test": "npm run assert-git-version && jest",
-		"test-watch": "npm run test -- --runInBand --testTimeout=50000 --watch",
 		"test:ci": "npm run test -- --coverage",
 		"test:debug": "npm run test -- --silent=false --verbose=true",
-		"test:e2e": "vitest --no-threads ./e2e"
+		"test:e2e": "vitest --test-timeout 240000 --single-thread --dir ./e2e run",
+		"test:watch": "npm run test -- --runInBand --testTimeout=50000 --watch",
+		"type:tests": "tsc -p ./src/__tests__/tsconfig.json && tsc -p ./e2e/tsconfig.json"
 	},
 	"jest": {
 		"coverageReporters": [
@@ -85,7 +83,7 @@
 			"<rootDir>/src/__tests__/jest.setup.ts"
 		],
 		"testRegex": "src/__tests__/.*\\.(test|spec)\\.[jt]sx?$",
-		"testTimeout": 30000,
+		"testTimeout": 50000,
 		"transform": {
 			"^.+\\.c?(t|j)sx?$": [
 				"esbuild-jest",
@@ -102,13 +100,10 @@
 		"@cloudflare/kv-asset-handler": "^0.2.0",
 		"@esbuild-plugins/node-globals-polyfill": "^0.1.1",
 		"@esbuild-plugins/node-modules-polyfill": "^0.1.4",
-		"@miniflare/core": "2.13.0",
-		"@miniflare/d1": "2.13.0",
-		"@miniflare/durable-objects": "2.13.0",
 		"blake3-wasm": "^2.1.5",
 		"chokidar": "^3.5.3",
 		"esbuild": "0.16.3",
-		"miniflare": "2.13.0",
+		"miniflare": "3.20230717.0",
 		"nanoid": "^3.3.3",
 		"path-to-regexp": "^6.2.0",
 		"selfsigned": "^2.0.1",
@@ -116,11 +111,12 @@
 		"xxhash-wasm": "^1.0.1"
 	},
 	"devDependencies": {
+		"@cloudflare/eslint-config-worker": "*",
 		"@cloudflare/types": "^6.18.4",
-		"@cloudflare/workers-types": "^4.20221111.1",
+		"@cloudflare/workers-tsconfig": "*",
+		"@cloudflare/workers-types": "^4.20230717.0",
 		"@iarna/toml": "^3.0.0",
 		"@microsoft/api-extractor": "^7.28.3",
-		"@miniflare/tre": "3.0.0-next.12",
 		"@types/better-sqlite3": "^7.6.0",
 		"@types/busboy": "^1.5.0",
 		"@types/command-exists": "^1.2.0",
@@ -135,7 +131,7 @@
 		"@types/supports-color": "^8.1.1",
 		"@types/ws": "^8.5.3",
 		"@types/yargs": "^17.0.10",
-		"@webcontainer/env": "^1.0.1",
+		"@webcontainer/env": "^1.1.0",
 		"body-parser": "^1.20.0",
 		"chalk": "^2.4.2",
 		"cli-table3": "^0.6.3",
@@ -176,7 +172,7 @@
 		"remove-accents-esm": "^0.0.1",
 		"semiver": "^1.1.0",
 		"serve-static": "^1.15.0",
-		"shellac": "^0.7.3",
+		"shellac": "^0.8.0",
 		"signal-exit": "^3.0.7",
 		"strip-ansi": "^7.0.1",
 		"supports-color": "^9.2.2",
@@ -185,7 +181,7 @@
 		"ts-dedent": "^2.2.0",
 		"undici": "5.20.0",
 		"update-check": "^1.5.4",
-		"vitest": "^0.29.2",
+		"vitest": "^0.31.0",
 		"ws": "^8.5.0",
 		"xdg-app-paths": "^7.3.0",
 		"yargs": "^17.4.1",

package/templates/__tests__/tsconfig.json

@@ -1,5 +1,5 @@
 {
-	"extends": "../../tsconfig.json",
+	"extends": "@cloudflare/workers-tsconfig/tsconfig.json",
 	"compilerOptions": {
 		"types": ["node", "jest"]
 	},

package/templates/checked-fetch.js

@@ -1,6 +1,6 @@
 const urls = new Set();
 
-export function checkedFetch(request, init) {
+function checkURL(request, init) {
 	const url =
 		request instanceof URL
 			? request
@@ -15,9 +15,16 @@ export function checkedFetch(request, init) {
 			urls.add(url.toString());
 			console.warn(
 				`WARNING: known issue with \`fetch()\` requests to custom HTTPS ports in published Workers:\n` +
-					` - ${url.toString()} - the custom port will be ignored when the Worker is published using the \`wrangler publish\` command.\n`
+					` - ${url.toString()} - the custom port will be ignored when the Worker is published using the \`wrangler deploy\` command.\n`
 			);
 		}
 	}
-	return globalThis.fetch(request, init);
 }
+
+globalThis.fetch = new Proxy(globalThis.fetch, {
+	apply(target, thisArg, argArray) {
+		const [request, init] = argArray;
+		checkURL(request, init);
+		return Reflect.apply(target, thisArg, argArray);
+	},
+});

package/templates/facade.d.ts

@@ -1,6 +1,9 @@
 declare module "__ENTRY_POINT__" {
 	import type { Middleware } from "./middleware/common";
-	const worker: ExportedHandler & { middleware?: Middleware[] };
+	const worker: ExportedHandler & {
+		middleware?: Middleware[];
+		envWrappers: ((env: Record<string, unknown>) => Record<string, unknown>)[];
+	};
 	export default worker;
 }
 

package/templates/middleware/common.ts

@@ -5,13 +5,18 @@ export type Dispatcher = (
 	init: { cron?: string }
 ) => Awaitable<void>;
 
+export type IncomingRequest = Request<
+	unknown,
+	IncomingRequestCfProperties<unknown>
+>;
+
 export interface MiddlewareContext {
 	dispatch: Dispatcher;
-	next(request: Request, env: any): Awaitable<Response>;
+	next(request: IncomingRequest, env: any): Awaitable<Response>;
 }
 
 export type Middleware = (
-	request: Request,
+	request: IncomingRequest,
 	env: any,
 	ctx: ExecutionContext,
 	middlewareCtx: MiddlewareContext
@@ -32,7 +37,7 @@ export function __facade_registerInternal__(
 }
 
 function __facade_invokeChain__(
-	request: Request,
+	request: IncomingRequest,
 	env: any,
 	ctx: ExecutionContext,
 	dispatch: Dispatcher,
@@ -49,7 +54,7 @@ function __facade_invokeChain__(
 }
 
 export function __facade_invoke__(
-	request: Request,
+	request: IncomingRequest,
 	env: any,
 	ctx: ExecutionContext,
 	dispatch: Dispatcher,

package/templates/middleware/loader-modules.ts

@@ -36,17 +36,68 @@ class __Facade_ScheduledController__ implements ScheduledController {
 	}
 }
 
-const __facade_modules_fetch__: Middleware = function (request, env, ctx) {
-	if (worker.fetch === undefined) throw new Error("No fetch handler!"); // TODO: proper error message
+const __facade_modules_fetch__: ExportedHandlerFetchHandler = function (
+	request,
+	env,
+	ctx
+) {
+	if (worker.fetch === undefined)
+		throw new Error("Handler does not export a fetch() function.");
 	return worker.fetch(request, env, ctx);
 };
 
-const facade: ExportedHandler<unknown> = {
-	fetch(request, env, ctx) {
+function getMaskedEnv(rawEnv: unknown) {
+	let env = rawEnv as Record<string, unknown>;
+	if (worker.envWrappers && worker.envWrappers.length > 0) {
+		for (const wrapFn of worker.envWrappers) {
+			env = wrapFn(env);
+		}
+	}
+	return env;
+}
+
+/**
+ * This type is here to cause a type error if a new export handler is added to
+ * `ExportHandler` without it being included in the `facade` below.
+ */
+type MissingExportHandlers = Omit<
+	Required<ExportedHandler>,
+	"tail" | "trace" | "scheduled" | "queue" | "test" | "email" | "fetch"
+>;
+
+let registeredMiddleware = false;
+
+const facade: ExportedHandler<unknown> & MissingExportHandlers = {
+	...(worker.tail && {
+		tail: maskHandlerEnv(worker.tail),
+	}),
+	...(worker.trace && {
+		trace: maskHandlerEnv(worker.trace),
+	}),
+	...(worker.scheduled && {
+		scheduled: maskHandlerEnv(worker.scheduled),
+	}),
+	...(worker.queue && {
+		queue: maskHandlerEnv(worker.queue),
+	}),
+	...(worker.test && {
+		test: maskHandlerEnv(worker.test),
+	}),
+	...(worker.email && {
+		email: maskHandlerEnv(worker.email),
+	}),
+
+	fetch(request, rawEnv, ctx) {
+		const env = getMaskedEnv(rawEnv);
 		// Get the chain of middleware from the worker object
 		if (worker.middleware && worker.middleware.length > 0) {
-			for (const middleware of worker.middleware) {
-				__facade_register__(middleware);
+			// Make sure we only register middleware once:
+			// https://github.com/cloudflare/workers-sdk/issues/2386#issuecomment-1614715911
+			if (!registeredMiddleware) {
+				registeredMiddleware = true;
+				for (const middleware of worker.middleware) {
+					__facade_register__(middleware);
+				}
 			}
 
 			const __facade_modules_dispatch__: Dispatcher = function (type, init) {
@@ -71,14 +122,16 @@ const facade: ExportedHandler<unknown> = {
 			// We didn't have any middleware so we can skip the invocation chain,
 			// and just call the fetch handler directly
 
-			// We "don't care" if this is undefined as we want to have the same behaviour
+			// We "don't care" if this is undefined as we want to have the same behavior
 			// as if the worker completely bypassed middleware.
-			return worker.fetch!(request, env, ctx);
+			return __facade_modules_fetch__(request, env, ctx);
 		}
 	},
-	scheduled: worker.scheduled,
-	queue: worker.queue,
-	trace: worker.trace,
 };
 
+type HandlerFn<D, R> = (data: D, env: unknown, ctx: ExecutionContext) => R;
+function maskHandlerEnv<D, R>(handler: HandlerFn<D, R>): HandlerFn<D, R> {
+	return (data, env, ctx) => handler(data, getMaskedEnv(env), ctx);
+}
+
 export default facade;

package/templates/middleware/loader-sw.ts

@@ -1,6 +1,7 @@
 import {
 	Awaitable,
 	Dispatcher,
+	IncomingRequest,
 	Middleware,
 	__facade_invoke__,
 	__facade_register__,
@@ -183,8 +184,6 @@ __facade__originalAddEventListener__("fetch", (event) => {
 			});
 
 			__FACADE_EVENT_TARGET__.dispatchEvent(facadeEvent);
-			// @ts-expect-error `waitUntil` types are currently broken, blocked on
-			// https://github.com/cloudflare/workerd/pull/191
 			event.waitUntil(Promise.all(facadeEvent[__facade_waitUntil__]));
 		}
 	};
@@ -197,8 +196,6 @@ __facade__originalAddEventListener__("fetch", (event) => {
 
 		__FACADE_EVENT_TARGET__.dispatchEvent(facadeEvent);
 		facadeEvent[__facade_dispatched__] = true;
-		// @ts-expect-error `waitUntil` types are currently broken, blocked on
-		// https://github.com/cloudflare/workerd/pull/191
 		event.waitUntil(Promise.all(facadeEvent[__facade_waitUntil__]));
 
 		const response = facadeEvent[__facade_response__];
@@ -210,7 +207,7 @@ __facade__originalAddEventListener__("fetch", (event) => {
 
 	event.respondWith(
 		__facade_invoke__(
-			event.request,
+			event.request as IncomingRequest,
 			globalThis,
 			ctx,
 			__facade_sw_dispatch__,
@@ -227,7 +224,5 @@ __facade__originalAddEventListener__("scheduled", (event) => {
 	});
 
 	__FACADE_EVENT_TARGET__.dispatchEvent(facadeEvent);
-	// @ts-expect-error `waitUntil` types are currently broken, blocked on
-	// https://github.com/cloudflare/workerd/pull/191
 	event.waitUntil(Promise.all(facadeEvent[__facade_waitUntil__]));
 });

package/templates/middleware/middleware-d1-beta.d.ts

@@ -0,0 +1,3 @@
+declare module "config:middleware/d1-beta" {
+	export const D1_IMPORTS: string[];
+}