wrangler 0.0.0-e9ab55a → 0.0.0-e9c2b04a

package/templates/__tests__/pages-dev-util.test.ts

@@ -0,0 +1,128 @@
+import { isRoutingRuleMatch } from "../pages-dev-util";
+
+describe("isRoutingRuleMatch", () => {
+	it("should match rules referencing root level correctly", () => {
+		const routingRule = "/";
+
+		expect(isRoutingRuleMatch("/", routingRule)).toBeTruthy();
+		expect(isRoutingRuleMatch("/foo", routingRule)).toBeFalsy();
+		expect(isRoutingRuleMatch("/foo/", routingRule)).toBeFalsy();
+		expect(isRoutingRuleMatch("/foo/bar", routingRule)).toBeFalsy();
+	});
+
+	it("should match include-all rules correctly", () => {
+		const routingRule = "/*";
+
+		expect(isRoutingRuleMatch("/", routingRule)).toBeTruthy();
+		expect(isRoutingRuleMatch("/foo", routingRule)).toBeTruthy();
+		expect(isRoutingRuleMatch("/foo/", routingRule)).toBeTruthy();
+		expect(isRoutingRuleMatch("/foo/bar", routingRule)).toBeTruthy();
+		expect(isRoutingRuleMatch("/foo/bar/", routingRule)).toBeTruthy();
+		expect(isRoutingRuleMatch("/foo/bar/baz", routingRule)).toBeTruthy();
+		expect(isRoutingRuleMatch("/foo/bar/baz/", routingRule)).toBeTruthy();
+	});
+
+	it("should match `/*` suffix-ed rules correctly", () => {
+		let routingRule = "/foo/*";
+
+		expect(isRoutingRuleMatch("/foo", routingRule)).toBeTruthy();
+		expect(isRoutingRuleMatch("/foo/", routingRule)).toBeTruthy();
+		expect(isRoutingRuleMatch("/foobar", routingRule)).toBeFalsy();
+		expect(isRoutingRuleMatch("/foo/bar", routingRule)).toBeTruthy();
+		expect(isRoutingRuleMatch("/foo/bar/baz", routingRule)).toBeTruthy();
+		expect(isRoutingRuleMatch("/bar/foo", routingRule)).toBeFalsy();
+		expect(isRoutingRuleMatch("/bar/foo/baz", routingRule)).toBeFalsy();
+
+		routingRule = "/foo/bar/*";
+
+		expect(isRoutingRuleMatch("/foo", routingRule)).toBeFalsy();
+		expect(isRoutingRuleMatch("/foo/", routingRule)).toBeFalsy();
+		expect(isRoutingRuleMatch("/foo/bar", routingRule)).toBeTruthy();
+		expect(isRoutingRuleMatch("/foo/bar/baz", routingRule)).toBeTruthy();
+		expect(isRoutingRuleMatch("/foo/barfoo", routingRule)).toBeFalsy();
+		expect(isRoutingRuleMatch("baz/foo/bar", routingRule)).toBeFalsy();
+		expect(isRoutingRuleMatch("baz/foo/bar/", routingRule)).toBeFalsy();
+	});
+
+	it("should match `/` suffix-ed rules correctly", () => {
+		let routingRule = "/foo/";
+		expect(isRoutingRuleMatch("/foo/", routingRule)).toBeTruthy();
+		expect(isRoutingRuleMatch("/foo", routingRule)).toBeTruthy();
+
+		routingRule = "/foo/bar/";
+		expect(isRoutingRuleMatch("/foo/bar/", routingRule)).toBeTruthy();
+		expect(isRoutingRuleMatch("/foo/bar", routingRule)).toBeTruthy();
+	});
+
+	it("should match `*` suffix-ed rules correctly", () => {
+		let routingRule = "/foo*";
+		expect(isRoutingRuleMatch("/foo", routingRule)).toBeTruthy();
+		expect(isRoutingRuleMatch("/foo/", routingRule)).toBeTruthy();
+		expect(isRoutingRuleMatch("/foobar", routingRule)).toBeTruthy();
+		expect(isRoutingRuleMatch("/barfoo", routingRule)).toBeFalsy();
+		expect(isRoutingRuleMatch("/foo/bar", routingRule)).toBeTruthy();
+		expect(isRoutingRuleMatch("/bar/foo", routingRule)).toBeFalsy();
+		expect(isRoutingRuleMatch("/bar/foobar", routingRule)).toBeFalsy();
+		expect(isRoutingRuleMatch("/foo/bar/baz", routingRule)).toBeTruthy();
+		expect(isRoutingRuleMatch("/bar/foo/baz", routingRule)).toBeFalsy();
+
+		routingRule = "/foo/bar*";
+		expect(isRoutingRuleMatch("/foo/bar", routingRule)).toBeTruthy();
+		expect(isRoutingRuleMatch("/foo/bar/", routingRule)).toBeTruthy();
+		expect(isRoutingRuleMatch("/foo/barfoo", routingRule)).toBeTruthy();
+		expect(isRoutingRuleMatch("/bar/foo/barfoo", routingRule)).toBeFalsy();
+		expect(isRoutingRuleMatch("/foo/bar/baz", routingRule)).toBeTruthy();
+		expect(isRoutingRuleMatch("/bar/foo/bar/baz", routingRule)).toBeFalsy();
+	});
+
+	it("should match rules without wildcards correctly", () => {
+		let routingRule = "/foo";
+
+		expect(isRoutingRuleMatch("/foo", routingRule)).toBeTruthy();
+		expect(isRoutingRuleMatch("/foo/", routingRule)).toBeTruthy();
+		expect(isRoutingRuleMatch("/foo/bar", routingRule)).toBeFalsy();
+		expect(isRoutingRuleMatch("/bar/foo", routingRule)).toBeFalsy();
+
+		routingRule = "/foo/bar";
+		expect(isRoutingRuleMatch("/foo/bar", routingRule)).toBeTruthy();
+		expect(isRoutingRuleMatch("/foo/bar/", routingRule)).toBeTruthy();
+		expect(isRoutingRuleMatch("/foo/bar/baz", routingRule)).toBeFalsy();
+		expect(isRoutingRuleMatch("/baz/foo/bar", routingRule)).toBeFalsy();
+	});
+
+	it("should throw an error if pathname or routing rule params are missing", () => {
+		// MISSING PATHNAME
+		expect(() =>
+			// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+			// @ts-ignore: sanity check
+			isRoutingRuleMatch(undefined, "/*")
+		).toThrow("Pathname is undefined.");
+
+		expect(() =>
+			// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+			// @ts-ignore: sanity check
+			isRoutingRuleMatch(null, "/*")
+		).toThrow("Pathname is undefined.");
+
+		expect(() => isRoutingRuleMatch("", "/*")).toThrow(
+			"Pathname is undefined."
+		);
+
+		// MISSING ROUTING RULE
+		expect(() =>
+			// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+			// @ts-ignore: sanity check
+			isRoutingRuleMatch("/foo", undefined)
+		).toThrow("Routing rule is undefined.");
+
+		expect(() =>
+			// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+			// @ts-ignore: sanity check
+			isRoutingRuleMatch("/foo", null)
+		).toThrow("Routing rule is undefined.");
+
+		expect(() => isRoutingRuleMatch("/foo", "")).toThrow(
+			"Routing rule is undefined."
+		);
+	});
+});

package/templates/__tests__/tsconfig-sanity.ts

@@ -0,0 +1,12 @@
+// `@types/node` should be included
+Buffer.from("test");
+
+// `@types/jest` should be included
+test("test");
+
+// @ts-expect-error `@cloudflare/workers-types` should NOT be included
+const _handler: ExportedHandler = {};
+// @ts-expect-error `@cloudflare/workers-types` should NOT be included
+new HTMLRewriter();
+
+export {};

package/templates/__tests__/tsconfig.json

@@ -0,0 +1,8 @@
+{
+	"extends": "@cloudflare/workers-tsconfig/tsconfig.json",
+	"compilerOptions": {
+		"types": ["node", "jest"]
+	},
+	"include": ["**/*.ts"],
+	"exclude": []
+}

package/templates/checked-fetch.js

@@ -0,0 +1,30 @@
+const urls = new Set();
+
+function checkURL(request, init) {
+	const url =
+		request instanceof URL
+			? request
+			: new URL(
+					(typeof request === "string"
+						? new Request(request, init)
+						: request
+					).url
+			  );
+	if (url.port && url.port !== "443" && url.protocol === "https:") {
+		if (!urls.has(url.toString())) {
+			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 deploy\` command.\n`
+			);
+		}
+	}
+}
+
+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

@@ -0,0 +1,17 @@
+declare module "__ENTRY_POINT__" {
+	import type { Middleware } from "./middleware/common";
+	const worker: ExportedHandler & {
+		middleware?: Middleware[];
+		envWrappers: ((env: Record<string, unknown>) => Record<string, unknown>)[];
+	};
+	export default worker;
+}
+
+declare module "__KV_ASSET_HANDLER__" {
+	export * from "@cloudflare/kv-asset-handler";
+}
+
+declare module "__STATIC_CONTENT_MANIFEST" {
+	const manifest: string;
+	export default manifest;
+}

package/templates/gitignore

@@ -0,0 +1,172 @@
+# Logs
+
+logs
+_.log
+npm-debug.log_
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+
+report.[0-9]_.[0-9]_.[0-9]_.[0-9]_.json
+
+# Runtime data
+
+pids
+_.pid
+_.seed
+\*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+
+lib-cov
+
+# Coverage directory used by tools like istanbul
+
+coverage
+\*.lcov
+
+# nyc test coverage
+
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+
+bower_components
+
+# node-waf configuration
+
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+
+build/Release
+
+# Dependency directories
+
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+
+web_modules/
+
+# TypeScript cache
+
+\*.tsbuildinfo
+
+# Optional npm cache directory
+
+.npm
+
+# Optional eslint cache
+
+.eslintcache
+
+# Optional stylelint cache
+
+.stylelintcache
+
+# Microbundle cache
+
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+
+.node_repl_history
+
+# Output of 'npm pack'
+
+\*.tgz
+
+# Yarn Integrity file
+
+.yarn-integrity
+
+# dotenv environment variable files
+
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# parcel-bundler cache (https://parceljs.org/)
+
+.cache
+.parcel-cache
+
+# Next.js build output
+
+.next
+out
+
+# Nuxt.js build / generate output
+
+.nuxt
+dist
+
+# Gatsby files
+
+.cache/
+
+# Comment in the public line in if your project uses Gatsby and not Next.js
+
+# https://nextjs.org/blog/next-9-1#public-directory-support
+
+# public
+
+# vuepress build output
+
+.vuepress/dist
+
+# vuepress v2.x temp and cache directory
+
+.temp
+.cache
+
+# Docusaurus cache and generated files
+
+.docusaurus
+
+# Serverless directories
+
+.serverless/
+
+# FuseBox cache
+
+.fusebox/
+
+# DynamoDB Local files
+
+.dynamodb/
+
+# TernJS port file
+
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+
+.vscode-test
+
+# yarn v2
+
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.\*
+
+# wrangler project
+
+.dev.vars
+.wrangler/

package/templates/init-tests/test-jest-new-worker.js

@@ -0,0 +1,23 @@
+const { unstable_dev } = require("wrangler");
+
+describe("Worker", () => {
+	let worker;
+
+	beforeAll(async () => {
+		worker = await unstable_dev("src/index.js", {
+			experimental: { disableExperimentalWarning: true },
+		});
+	});
+
+	afterAll(async () => {
+		await worker.stop();
+	});
+
+	it("should return Hello World", async () => {
+		const resp = await worker.fetch();
+		if (resp) {
+			const text = await resp.text();
+			expect(text).toMatchInlineSnapshot(`"Hello World!"`);
+		}
+	});
+});

package/templates/init-tests/test-vitest-new-worker.js

@@ -0,0 +1,24 @@
+import { unstable_dev } from "wrangler";
+import { describe, expect, it, beforeAll, afterAll } from "vitest";
+
+describe("Worker", () => {
+	let worker;
+
+	beforeAll(async () => {
+		worker = await unstable_dev("src/index.js", {
+			experimental: { disableExperimentalWarning: true },
+		});
+	});
+
+	afterAll(async () => {
+		await worker.stop();
+	});
+
+	it("should return Hello World", async () => {
+		const resp = await worker.fetch();
+		if (resp) {
+			const text = await resp.text();
+			expect(text).toMatchInlineSnapshot(`"Hello World!"`);
+		}
+	});
+});

package/templates/init-tests/test-vitest-new-worker.ts

@@ -0,0 +1,25 @@
+import { unstable_dev } from "wrangler";
+import type { UnstableDevWorker } from "wrangler";
+import { describe, expect, it, beforeAll, afterAll } from "vitest";
+
+describe("Worker", () => {
+	let worker: UnstableDevWorker;
+
+	beforeAll(async () => {
+		worker = await unstable_dev("src/index.ts", {
+			experimental: { disableExperimentalWarning: true },
+		});
+	});
+
+	afterAll(async () => {
+		await worker.stop();
+	});
+
+	it("should return Hello World", async () => {
+		const resp = await worker.fetch();
+		if (resp) {
+			const text = await resp.text();
+			expect(text).toMatchInlineSnapshot(`"Hello World!"`);
+		}
+	});
+});

package/templates/middleware/common.ts

@@ -0,0 +1,67 @@
+export type Awaitable<T> = T | Promise<T>;
+// TODO: allow dispatching more events?
+export type Dispatcher = (
+	type: "scheduled",
+	init: { cron?: string }
+) => Awaitable<void>;
+
+export type IncomingRequest = Request<
+	unknown,
+	IncomingRequestCfProperties<unknown>
+>;
+
+export interface MiddlewareContext {
+	dispatch: Dispatcher;
+	next(request: IncomingRequest, env: any): Awaitable<Response>;
+}
+
+export type Middleware = (
+	request: IncomingRequest,
+	env: any,
+	ctx: ExecutionContext,
+	middlewareCtx: MiddlewareContext
+) => Awaitable<Response>;
+
+const __facade_middleware__: Middleware[] = [];
+
+// The register functions allow for the insertion of one or many middleware,
+// We register internal middleware first in the stack, but have no way of controlling
+// the order that addMiddleware is run in service workers so need an internal function.
+export function __facade_register__(...args: (Middleware | Middleware[])[]) {
+	__facade_middleware__.push(...args.flat());
+}
+export function __facade_registerInternal__(
+	...args: (Middleware | Middleware[])[]
+) {
+	__facade_middleware__.unshift(...args.flat());
+}
+
+function __facade_invokeChain__(
+	request: IncomingRequest,
+	env: any,
+	ctx: ExecutionContext,
+	dispatch: Dispatcher,
+	middlewareChain: Middleware[]
+): Awaitable<Response> {
+	const [head, ...tail] = middlewareChain;
+	const middlewareCtx: MiddlewareContext = {
+		dispatch,
+		next(newRequest, newEnv) {
+			return __facade_invokeChain__(newRequest, newEnv, ctx, dispatch, tail);
+		},
+	};
+	return head(request, env, ctx, middlewareCtx);
+}
+
+export function __facade_invoke__(
+	request: IncomingRequest,
+	env: any,
+	ctx: ExecutionContext,
+	dispatch: Dispatcher,
+	finalMiddleware: Middleware
+): Awaitable<Response> {
+	return __facade_invokeChain__(request, env, ctx, dispatch, [
+		...__facade_middleware__,
+		finalMiddleware,
+	]);
+}

package/templates/middleware/loader-modules.ts

@@ -0,0 +1,137 @@
+// // This loads all middlewares exposed on the middleware object
+// // and then starts the invocation chain.
+// // The big idea is that we can add these to the middleware export dynamically
+// // through wrangler, or we can potentially let users directly add them as a sort
+// // of "plugin" system.
+
+import {
+	Dispatcher,
+	Middleware,
+	__facade_invoke__,
+	__facade_register__,
+} from "./common";
+
+import worker from "__ENTRY_POINT__";
+
+// We need to preserve all of the exports from the worker
+export * from "__ENTRY_POINT__";
+
+class __Facade_ScheduledController__ implements ScheduledController {
+	#noRetry: ScheduledController["noRetry"];
+
+	constructor(
+		readonly scheduledTime: number,
+		readonly cron: string,
+		noRetry: ScheduledController["noRetry"]
+	) {
+		this.#noRetry = noRetry;
+	}
+
+	noRetry() {
+		if (!(this instanceof __Facade_ScheduledController__)) {
+			throw new TypeError("Illegal invocation");
+		}
+		// Need to call native method immediately in case uncaught error thrown
+		this.#noRetry();
+	}
+}
+
+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);
+};
+
+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) {
+			// 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) {
+				if (type === "scheduled" && worker.scheduled !== undefined) {
+					const controller = new __Facade_ScheduledController__(
+						Date.now(),
+						init.cron ?? "",
+						() => {}
+					);
+					return worker.scheduled(controller, env, ctx);
+				}
+			};
+
+			return __facade_invoke__(
+				request,
+				env,
+				ctx,
+				__facade_modules_dispatch__,
+				__facade_modules_fetch__
+			);
+		} else {
+			// 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 behavior
+			// as if the worker completely bypassed middleware.
+			return __facade_modules_fetch__(request, env, ctx);
+		}
+	},
+};
+
+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;