wrangler 0.0.0-e7a0cd5b → 0.0.0-e87ad068

package/src/deprecated/index.ts

@@ -1,310 +1,16 @@
-import fs from "node:fs";
-import path from "node:path";
 import { DeprecationError } from "../errors";
-import { cloneIntoDirectory, initializeGit } from "../git-client";
-import {
-	CommandLineArgsError,
-	createCLIParser,
-	printWranglerBanner,
-} from "../index";
-import { initHandler } from "../init";
+import { createCLIParser } from "../index";
 import { logger } from "../logger";
 import { formatMessage } from "../parse";
 import type {
-	CommonYargsOptions,
-	YargsOptionsToInterface,
+	CommonYargsArgv,
+	StrictYargsOptionsToInterface,
 } from "../yargs-types";
-import type { Argv, ArgumentsCamelCase, BuilderCallback } from "yargs";
 
-// https://github.com/cloudflare/wrangler/blob/master/src/cli/mod.rs#L106-L123
-interface GenerateArgs {
-	name?: string;
-	template?: string;
-	type?: string;
-	site?: boolean;
-}
-
-export function generateOptions(yargs: Argv<CommonYargsOptions>) {
-	return yargs
-		.positional("name", {
-			describe: "Name of the Workers project",
-			type: "string",
-		})
-		.positional("template", {
-			type: "string",
-			describe: "The URL of a GitHub template",
-		})
-		.option("type", {
-			alias: "t",
-			type: "string",
-			hidden: true,
-			deprecated: true,
-		})
-		.option("site", {
-			alias: "s",
-			type: "boolean",
-			hidden: true,
-			deprecated: true,
-		});
-}
-
-export async function generateHandler({
-	// somehow, `init` marks name as required but then also runs fine
-	// with the name omitted, and then substitutes it at runtime with ""
-	name = "",
-	template,
-	type,
-	site,
-	...args
-}: ArgumentsCamelCase<GenerateArgs>) {
-	// delegate to `wrangler init` if no template is specified
-	if (template === undefined) {
-		return initHandler({ name, ...args });
-	}
-
-	// print down here cuz `init` prints it own its own
-	await printWranglerBanner();
-
-	if (type) {
-		let message = "The --type option is no longer supported.";
-		if (args.type === "webpack") {
-			message +=
-				"\nIf you wish to use webpack then you will need to create a custom build.";
-			// TODO: Add a link to docs
-		}
-		throw new CommandLineArgsError(message);
-	}
-
-	if (isRemote(name)) {
-		[template, name] = [name, template];
-	}
-
-	const creationDirectory = generateWorkerDirectoryName(name);
-
-	if (site) {
-		const gitDirectory =
-			creationDirectory !== process.cwd()
-				? path.basename(creationDirectory)
-				: "my-site";
-		const message =
-			"The --site option is no longer supported.\n" +
-			"If you wish to create a brand new Worker Sites project then clone the `worker-sites-template` starter repository:\n\n" +
-			"```\n" +
-			`git clone --depth=1 --branch=wrangler2 https://github.com/cloudflare/worker-sites-template ${gitDirectory}\n` +
-			`cd ${gitDirectory}\n` +
-			"```\n\n" +
-			"Find out more about how to create and maintain Sites projects at https://developers.cloudflare.com/workers/platform/sites.\n" +
-			"Have you considered using Cloudflare Pages instead? See https://pages.cloudflare.com/.";
-		throw new CommandLineArgsError(message);
-	}
-
-	logger.log(
-		`Creating a worker in ${path.basename(creationDirectory)} from ${template}`
-	);
-
-	const { remote, subdirectory } = parseTemplatePath(template);
-
-	await cloneIntoDirectory(remote, creationDirectory, subdirectory);
-	await initializeGit(creationDirectory);
-
-	logger.log("✨ Success!");
-}
-
-/**
- * Creates a path based on the current working directory and a worker name.
- * Automatically increments a counter when searching for an available directory.
- *
- * Running `wrangler generate worker https://some-git-repo` in a directory
- * with the structure:
- * ```
- * - workers
- * |
- * | - worker
- * | | - wrangler.toml
- * | | ...
- * |
- * | - worker-1
- * | | - wrangler.toml
- * | | ...
- * ```
- *
- * will result in a new worker called `worker-2` being generated.
- *
- * @param workerName the name of the generated worker
- * @returns an absolute path to the directory to generate the worker into
- */
-function generateWorkerDirectoryName(workerName: string): string {
-	let workerDirectoryPath = path.resolve(process.cwd(), workerName);
-	let i = 1;
-
-	while (fs.existsSync(workerDirectoryPath)) {
-		workerDirectoryPath = path.resolve(process.cwd(), `${workerName}-${i}`);
-		i++;
-	}
-
-	return workerDirectoryPath;
-}
-
-/**
- * Checks if an arg is a template, which can be useful if the order
- * of template & worker name args is switched
- *
- * @param arg a template to generate from, or a folder to generate into
- * @returns true if the given arg was remote (a template)
- */
-function isRemote(arg: string) {
-	return /^(https?|ftps?|file|git|ssh):\/\//.test(arg) || arg.includes(":");
-}
-
-/**
- * unreadable regex basically copied from degit. i put some named capture groups in,
- * but uhh...there's not much to do short of using pomsky or some other tool.
- *
- * notably: this only supports `https://` and `git@` urls,
- * and is missing support for:
- * - `http`
- * - `ftp(s)`
- * - `file`
- * - `ssh`
- */
-const TEMPLATE_REGEX =
-	/^(?:(?:https:\/\/)?(?<httpsUrl>[^:/]+\.[^:/]+)\/|git@(?<gitUrl>[^:/]+)[:/]|(?<shorthandUrl>[^/]+):)?(?<user>[^/\s]+)\/(?<repository>[^/\s#]+)(?:(?<subdirectoryPath>(?:\/[^/\s#]+)+))?(?:\/)?(?:#(?<tag>.+))?/;
-
-// there are a few URL formats we support:
-// - `user/repo` -> assume github, use "https://github.com/user/repo.git"
-// - `https://<httpsUrl>
-// - `git@<gitUrl>`
-// - `(bb|bitbucket|gh|github|gl|gitlab):user/repo` -> parse shorthand into https url
-
-/**
- * There's no URL, so assume a github repo
- */
-type NoUrl = {
-	httpsUrl: undefined;
-	gitUrl: undefined;
-	shorthandUrl: undefined;
-};
-
-/**
- * A https url (e.g. https://bitbucket.org/user/repo)
- */
-type HttpsUrl = Omit<NoUrl, "httpsUrl"> & { httpsUrl: string };
-
-/**
- * A git url (e.g. git@gitlab.com:user/repo)
- */
-type GitUrl = Omit<NoUrl, "gitUrl"> & { gitUrl: string };
-
-/**
- * A shorthand url (e.g. github:user/repo)
- */
-type ShorthandUrl = Omit<NoUrl, "shorthandUrl"> & { shorthandUrl: string };
-
-/**
- * Union of all possible URL groups. Exactly one will be present, the rest
- * will be `undefined`.
- */
-type TemplateRegexUrlGroup = NoUrl | HttpsUrl | GitUrl | ShorthandUrl;
-
-/**
- * Possible matches of `TEMPLATE_REGEX` against a passed-in template arg
- */
-type TemplateRegexGroups = {
-	/** The user the repo is under */
-	user: string;
-
-	/** The repo name */
-	repository: string;
-
-	/** Optional, path to subdirectory containing template. Begins with `/` */
-	subdirectoryPath?: string;
-
-	/** Optional tag (or branch, etc.) to clone */
-	tag?: string;
-} & TemplateRegexUrlGroup;
-
-/**
- * Parses a regex match on any of the URL groups into a URL base
- *
- * @param urlGroup a regex hit for a URL of any sort
- * @returns the protocol and domain name of the url to clone from
- */
-function toUrlBase({ httpsUrl, gitUrl, shorthandUrl }: TemplateRegexUrlGroup) {
-	if (httpsUrl !== undefined) {
-		return `https://${httpsUrl}`;
-	}
-
-	if (gitUrl !== undefined) {
-		return `git@${gitUrl}`;
-	}
-
-	if (shorthandUrl !== undefined) {
-		switch (shorthandUrl) {
-			case "github":
-			case "gh":
-				return "https://github.com";
-			case "gitlab":
-			case "gl":
-				return "https://gitlab.com";
-			case "bitbucket":
-			case "bb":
-				return "https://bitbucket.org";
-			default:
-				throw new Error(
-					`Unable to parse shorthand ${shorthandUrl}. Supported options are "bitbucket" ("bb"), "github" ("gh"), and "gitlab" ("gl")`
-				);
-		}
-	}
-
-	return "https://github.com";
-}
-
-/**
- * Parses a template string (e.g. "user/repo", "github:user/repo/path/to/subdirectory")
- * into a remote URL to clone from and an optional subdirectory to filter for
- *
- * @param templatePath the template string to parse
- * @returns an object containing the remote url and an optional subdirectory to clone
- */
-function parseTemplatePath(templatePath: string): {
-	remote: string;
-	subdirectory?: string;
-} {
-	if (!templatePath.includes("/")) {
-		// template is a cloudflare canonical template, it doesn't include a slash in the name
-		return {
-			remote: "https://github.com/cloudflare/templates.git",
-			subdirectory: templatePath,
-		};
-	}
-
-	const groups = TEMPLATE_REGEX.exec(templatePath)?.groups as unknown as
-		| TemplateRegexGroups
-		| undefined;
-
-	if (!groups) {
-		throw new Error(`Unable to parse ${templatePath} as a template`);
-	}
-
-	const { user, repository, subdirectoryPath, tag, ...urlGroups } = groups;
-
-	const urlBase = toUrlBase(urlGroups);
-	const isHttp = urlBase.startsWith("http");
-
-	const remote = `${urlBase}${isHttp ? "/" : ":"}${user}/${repository}.git${
-		tag ? `#${tag}` : ""
-	}`;
-
-	// remove starting /
-	const subdirectory = subdirectoryPath?.slice(1);
-
-	return { remote, subdirectory };
-}
-
-export function buildOptions(yargs: Argv<CommonYargsOptions>) {
+export function buildOptions(yargs: CommonYargsArgv) {
 	return yargs;
 }
-type BuildArgs = YargsOptionsToInterface<typeof buildOptions>;
+type BuildArgs = StrictYargsOptionsToInterface<typeof buildOptions>;
 export async function buildHandler(buildArgs: BuildArgs) {
 	// "[DEPRECATED] 🦀 Build your project (if applicable)",
 
@@ -340,7 +46,7 @@ export const configHandler = () => {
 	);
 };
 
-export function previewOptions(yargs: Argv<CommonYargsOptions>) {
+export function previewOptions(yargs: CommonYargsArgv) {
 	return yargs
 		.positional("method", {
 			type: "string",
@@ -364,7 +70,7 @@ export function previewHandler() {
 	);
 }
 
-export const route: BuilderCallback<unknown, unknown> = (routeYargs: Argv) => {
+export const route = (routeYargs: CommonYargsArgv) => {
 	return routeYargs
 		.command(
 			"list",
@@ -427,7 +133,7 @@ export const routeHandler = () => {
 	throw new DeprecationError(`${deprecationNotice}\n${shouldDo}`);
 };
 
-export const subdomainOptions = (yargs: Argv<CommonYargsOptions>) => {
+export const subdomainOptions = (yargs: CommonYargsArgv) => {
 	return yargs.positional("name", { type: "string" });
 };
 

package/src/dev/dev.tsx

@@ -28,9 +28,9 @@ import type { Config } from "../config";
 import type { Route } from "../config/environment";
 import type { WorkerRegistry } from "../dev-registry";
 import type { Entry } from "../entry";
-import type { EnablePagesAssetsServiceBindingOptions } from "../miniflare-cli";
+import type { EnablePagesAssetsServiceBindingOptions } from "../miniflare-cli/types";
 import type { AssetPaths } from "../sites";
-import type { CfWorkerInit } from "../worker";
+import type { CfModule, CfWorkerInit } from "../worker";
 
 /**
  * This hooks establishes a connection with the dev registry,
@@ -55,7 +55,7 @@ function useDevRegistry(
 
 		const interval =
 			// TODO: enable this for remote mode as well
-			// https://github.com/cloudflare/wrangler2/issues/1182
+			// https://github.com/cloudflare/workers-sdk/issues/1182
 			mode === "local"
 				? setInterval(() => {
 						getBoundRegisteredWorkers({
@@ -113,9 +113,11 @@ export type DevProps = {
 	name: string | undefined;
 	noBundle: boolean;
 	entry: Entry;
-	port: number;
-	ip: string;
+	initialPort: number;
+	initialIp: string;
 	inspectorPort: number;
+	processEntrypoint: boolean;
+	additionalModules: CfModule[];
 	rules: Config["rules"];
 	accountId: string | undefined;
 	initialMode: "local" | "remote";
@@ -138,7 +140,8 @@ export type DevProps = {
 	compatibilityFlags: string[] | undefined;
 	usageModel: "bundled" | "unbound" | undefined;
 	minify: boolean | undefined;
-	nodeCompat: boolean | undefined;
+	legacyNodeCompat: boolean | undefined;
+	nodejsCompat: boolean | undefined;
 	build: Config["build"];
 	env: string | undefined;
 	legacyEnv: boolean;
@@ -146,7 +149,6 @@ export type DevProps = {
 	host: string | undefined;
 	routes: Route[] | undefined;
 	inspect: boolean;
-	logPrefix?: string;
 	onReady: ((ip: string, port: number) => void) | undefined;
 	showInteractiveDevSession: boolean | undefined;
 	forceLocal: boolean | undefined;
@@ -155,6 +157,7 @@ export type DevProps = {
 	sendMetrics: boolean | undefined;
 	testScheduled: boolean | undefined;
 	experimentalLocal: boolean | undefined;
+	experimentalLocalRemoteKv: boolean | undefined;
 };
 
 export function DevImplementation(props: DevProps): JSX.Element {
@@ -170,25 +173,43 @@ export function DevImplementation(props: DevProps): JSX.Element {
 	);
 }
 
+// This is a nasty hack to allow `useHotkeys` and its "[b] open a browser" feature to read these values
+// without triggering a re-render loop when `onReady()` updates them.
+// The initially requested port can be different than what's actually used, if, for example, you request port 0.
+let ip: string;
+let port: number;
+
 function InteractiveDevSession(props: DevProps) {
 	const toggles = useHotkeys({
 		initial: {
 			local: props.initialMode === "local",
 			tunnel: false,
 		},
-		port: props.port,
-		ip: props.ip,
 		inspectorPort: props.inspectorPort,
 		inspect: props.inspect,
 		localProtocol: props.localProtocol,
 		forceLocal: props.forceLocal,
+		worker: props.name,
 	});
 
+	ip = props.initialIp;
+	port = props.initialPort;
+
 	useTunnel(toggles.tunnel);
 
+	const onReady = (newIp: string, newPort: number) => {
+		if (newIp !== props.initialIp || newPort !== props.initialPort) {
+			ip = newIp;
+			port = newPort;
+			if (props.onReady) {
+				props.onReady(newIp, newPort);
+			}
+		}
+	};
+
 	return (
 		<>
-			<DevSession {...props} local={toggles.local} />
+			<DevSession {...props} local={toggles.local} onReady={onReady} />
 			<Box borderStyle="round" paddingLeft={1} paddingRight={1}>
 				<Text bold={true}>[b]</Text>
 				<Text> open a browser, </Text>
@@ -231,20 +252,6 @@ function DevSession(props: DevSessionProps) {
 		() => props.bindings.d1_databases?.map((db) => db.binding),
 		[props.bindings.d1_databases]
 	);
-	const everyD1BindingHasPreview = props.bindings.d1_databases?.every(
-		(binding) => binding.preview_database_id
-	);
-	if (
-		betaD1Shims &&
-		betaD1Shims.length > 0 &&
-		!(props.local || everyD1BindingHasPreview)
-	) {
-		handleError(
-			new Error(
-				"D1 bindings require dev --local or preview_database_id for now"
-			)
-		);
-	}
 
 	// If we are using d1 bindings, and are not bundling the worker
 	// we should error here as the d1 shim won't be added
@@ -267,6 +274,8 @@ function DevSession(props: DevSessionProps) {
 		entry: props.entry,
 		destination: directory,
 		jsxFactory: props.jsxFactory,
+		processEntrypoint: props.processEntrypoint,
+		additionalModules: props.additionalModules,
 		rules: props.rules,
 		jsxFragment: props.jsxFragment,
 		serveAssetsFromWorker: Boolean(
@@ -274,7 +283,8 @@ function DevSession(props: DevSessionProps) {
 		),
 		tsconfig: props.tsconfig,
 		minify: props.minify,
-		nodeCompat: props.nodeCompat,
+		legacyNodeCompat: props.legacyNodeCompat,
+		nodejsCompat: props.nodejsCompat,
 		betaD1Shims,
 		define: props.define,
 		noBundle: props.noBundle,
@@ -287,7 +297,7 @@ function DevSession(props: DevSessionProps) {
 		// Enable the bundling to know whether we are using dev or publish
 		targetConsumer: "dev",
 		testScheduled: props.testScheduled ?? false,
-		experimentalLocalStubCache: props.local && props.experimentalLocal,
+		experimentalLocal: props.experimentalLocal,
 	});
 
 	// TODO(queues) support remote wrangler dev
@@ -300,6 +310,22 @@ function DevSession(props: DevSessionProps) {
 		);
 	}
 
+	const announceAndOnReady: typeof props.onReady = (finalIp, finalPort) => {
+		if (process.send) {
+			process.send(
+				JSON.stringify({
+					event: "DEV_SERVER_READY",
+					ip: finalIp,
+					port: finalPort,
+				})
+			);
+		}
+
+		if (props.onReady) {
+			props.onReady(finalIp, finalPort);
+		}
+	};
+
 	return props.local ? (
 		<Local
 			name={props.name}
@@ -311,8 +337,8 @@ function DevSession(props: DevSessionProps) {
 			bindings={props.bindings}
 			workerDefinitions={workerDefinitions}
 			assetPaths={props.assetPaths}
-			port={props.port}
-			ip={props.ip}
+			initialPort={props.initialPort}
+			initialIp={props.initialIp}
 			rules={props.rules}
 			inspectorPort={props.inspectorPort}
 			localPersistencePath={props.localPersistencePath}
@@ -321,11 +347,13 @@ function DevSession(props: DevSessionProps) {
 			queueConsumers={props.queueConsumers}
 			localProtocol={props.localProtocol}
 			localUpstream={props.localUpstream}
-			logPrefix={props.logPrefix}
 			inspect={props.inspect}
-			onReady={props.onReady}
+			onReady={announceAndOnReady}
 			enablePagesAssetsServiceBinding={props.enablePagesAssetsServiceBinding}
 			experimentalLocal={props.experimentalLocal}
+			accountId={props.accountId}
+			experimentalLocalRemoteKv={props.experimentalLocalRemoteKv}
+			sourceMapPath={bundle?.sourceMapPath}
 		/>
 	) : (
 		<Remote
@@ -336,8 +364,8 @@ function DevSession(props: DevSessionProps) {
 			bindings={props.bindings}
 			assetPaths={props.assetPaths}
 			isWorkersSite={props.isWorkersSite}
-			port={props.port}
-			ip={props.ip}
+			port={props.initialPort}
+			ip={props.initialIp}
 			localProtocol={props.localProtocol}
 			inspectorPort={props.inspectorPort}
 			// TODO: @threepointone #1167
@@ -351,7 +379,7 @@ function DevSession(props: DevSessionProps) {
 			zone={props.zone}
 			host={props.host}
 			routes={props.routes}
-			onReady={props.onReady}
+			onReady={announceAndOnReady}
 			sourceMapPath={bundle?.sourceMapPath}
 			sendMetrics={props.sendMetrics}
 		/>
@@ -405,7 +433,7 @@ function useCustomBuild(expectedEntry: Entry, build: Config["build"]): void {
 		}
 
 		return () => {
-			watcher?.close();
+			void watcher?.close();
 		};
 	}, [build, expectedEntry]);
 }
@@ -500,25 +528,17 @@ type useHotkeysInitialState = {
 };
 function useHotkeys(props: {
 	initial: useHotkeysInitialState;
-	port: number;
-	ip: string;
 	inspectorPort: number;
 	inspect: boolean;
 	localProtocol: "http" | "https";
 	forceLocal: boolean | undefined;
+	worker: string | undefined;
 }) {
-	const {
-		initial,
-		port,
-		ip,
-		inspectorPort,
-		inspect,
-		localProtocol,
-		forceLocal,
-	} = props;
+	const { initial, inspectorPort, inspect, localProtocol, forceLocal } = props;
 	// UGH, we should put port in context instead
 	const [toggles, setToggles] = useState(initial);
 	const { exit } = useApp();
+
 	useInput(
 		async (
 			input,
@@ -545,7 +565,7 @@ function useHotkeys(props: {
 				// toggle inspector
 				case "d": {
 					if (inspect) {
-						await openInspector(inspectorPort);
+						await openInspector(inspectorPort, props.worker);
 					}
 					break;
 				}