wrangler 0.0.0-e9ab55a → 0.0.0-e9e9872

package/src/dev/remote.tsx

@@ -0,0 +1,382 @@
+import { readFile } from "node:fs/promises";
+import path from "node:path";
+import React, { useState, useEffect, useRef } from "react";
+import { useErrorHandler } from "react-error-boundary";
+import { printBundleSize } from "../bundle-reporter";
+import {
+	createPreviewSession,
+	createWorkerPreview,
+} from "../create-worker-preview";
+import useInspector from "../inspect";
+import { logger } from "../logger";
+import { usePreviewServer } from "../proxy";
+import { syncAssets } from "../sites";
+import {
+	ChooseAccount,
+	getAccountChoices,
+	requireApiToken,
+	saveAccountToCache,
+} from "../user";
+import type { Route } from "../config/environment";
+import type {
+	CfPreviewToken,
+	CfPreviewSession,
+} from "../create-worker-preview";
+import type { AssetPaths } from "../sites";
+import type { ChooseAccountItem } from "../user";
+import type {
+	CfModule,
+	CfWorkerInit,
+	CfScriptFormat,
+	CfAccount,
+	CfWorkerContext,
+} from "../worker";
+import type { EsbuildBundle } from "./use-esbuild";
+
+export function Remote(props: {
+	name: string | undefined;
+	bundle: EsbuildBundle | undefined;
+	format: CfScriptFormat | undefined;
+	isWorkersSite: boolean;
+	assetPaths: AssetPaths | undefined;
+	port: number;
+	ip: string;
+	localProtocol: "https" | "http";
+	inspectorPort: number;
+	accountId: string | undefined;
+	bindings: CfWorkerInit["bindings"];
+	compatibilityDate: string;
+	compatibilityFlags: string[] | undefined;
+	usageModel: "bundled" | "unbound" | undefined;
+	env: string | undefined;
+	legacyEnv: boolean | undefined;
+	zone: string | undefined;
+	host: string | undefined;
+	routes: Route[] | undefined;
+	onReady?: (() => void) | undefined;
+}) {
+	const [accountId, setAccountId] = useState(props.accountId);
+	const accountChoicesRef = useRef<Promise<ChooseAccountItem[]>>();
+	const [accountChoices, setAccountChoices] = useState<ChooseAccountItem[]>();
+
+	const previewToken = useWorker({
+		name: props.name,
+		bundle: props.bundle,
+		format: props.format,
+		modules: props.bundle ? props.bundle.modules : [],
+		accountId,
+		bindings: props.bindings,
+		assetPaths: props.assetPaths,
+		isWorkersSite: props.isWorkersSite,
+		port: props.port,
+		compatibilityDate: props.compatibilityDate,
+		compatibilityFlags: props.compatibilityFlags,
+		usageModel: props.usageModel,
+		env: props.env,
+		legacyEnv: props.legacyEnv,
+		zone: props.zone,
+		host: props.host,
+		routes: props.routes,
+		onReady: props.onReady,
+	});
+
+	usePreviewServer({
+		previewToken,
+		assetDirectory: props.isWorkersSite
+			? undefined
+			: props.assetPaths?.assetDirectory,
+		localProtocol: props.localProtocol,
+		localPort: props.port,
+		ip: props.ip,
+	});
+
+	useInspector({
+		inspectorUrl: previewToken ? previewToken.inspectorUrl.href : undefined,
+		port: props.inspectorPort,
+		logToTerminal: true,
+	});
+
+	const errorHandler = useErrorHandler();
+
+	// This effect handles the async step of fetching the available accounts for the current user.
+	// If only one account is available then it is just used by calling `setAccountId()`.
+	useEffect(() => {
+		if (
+			accountChoicesRef.current !== undefined ||
+			props.accountId !== undefined
+		) {
+			return;
+		}
+		accountChoicesRef.current = getAccountChoices();
+		accountChoicesRef.current.then(
+			(accounts) => {
+				if (accounts.length === 1) {
+					saveAccountToCache({
+						id: accounts[0].id,
+						name: accounts[0].name,
+					});
+					setAccountId(accounts[0].id);
+				} else {
+					setAccountChoices(accounts);
+				}
+			},
+			(err) => {
+				errorHandler(err);
+			}
+		);
+	});
+
+	// If we have not already chosen an account and there are multiple accounts available
+	// allow the users to select one.
+	return accountId === undefined && accountChoices !== undefined ? (
+		<ChooseAccount
+			accounts={accountChoices}
+			onSelect={(selectedAccount) => {
+				saveAccountToCache(selectedAccount);
+				setAccountId(selectedAccount.id);
+			}}
+			onError={(err) => errorHandler(err)}
+		></ChooseAccount>
+	) : null;
+}
+
+export function useWorker(props: {
+	name: string | undefined;
+	bundle: EsbuildBundle | undefined;
+	format: CfScriptFormat | undefined;
+	modules: CfModule[];
+	accountId: string | undefined;
+	bindings: CfWorkerInit["bindings"];
+	assetPaths: AssetPaths | undefined;
+	isWorkersSite: boolean;
+	port: number;
+	compatibilityDate: string | undefined;
+	compatibilityFlags: string[] | undefined;
+	usageModel: "bundled" | "unbound" | undefined;
+	env: string | undefined;
+	legacyEnv: boolean | undefined;
+	zone: string | undefined;
+	host: string | undefined;
+	routes: Route[] | undefined;
+	onReady: (() => void) | undefined;
+}): CfPreviewToken | undefined {
+	const {
+		name,
+		bundle,
+		format,
+		modules,
+		accountId,
+		bindings,
+		assetPaths,
+		compatibilityDate,
+		compatibilityFlags,
+		usageModel,
+		port,
+		onReady,
+	} = props;
+	const [session, setSession] = useState<CfPreviewSession | undefined>();
+	const [token, setToken] = useState<CfPreviewToken | undefined>();
+
+	// This is the most reliable way to detect whether
+	// something's "happened" in our system; We make a ref and
+	// mark it once we log our initial message. Refs are vars!
+	const startedRef = useRef(false);
+
+	// This effect sets up the preview session
+	useEffect(() => {
+		const abortController = new AbortController();
+		async function start() {
+			if (accountId === undefined) {
+				return;
+			}
+
+			const workerAccount: CfAccount = {
+				accountId,
+				apiToken: requireApiToken(),
+			};
+
+			const workerCtx: CfWorkerContext = {
+				env: props.env,
+				legacyEnv: props.legacyEnv,
+				zone: props.zone,
+				host: props.host,
+				routes: props.routes,
+			};
+
+			setSession(
+				await createPreviewSession(
+					workerAccount,
+					workerCtx,
+					abortController.signal
+				)
+			);
+		}
+		start().catch((err) => {
+			// we want to log the error, but not end the process
+			// since it could recover after the developer fixes whatever's wrong
+			if ((err as { code: string }).code !== "ABORT_ERR") {
+				logger.error("Error while creating remote dev session:", err);
+			}
+		});
+
+		return () => {
+			abortController.abort();
+		};
+	}, [
+		accountId,
+		props.env,
+		props.host,
+		props.legacyEnv,
+		props.routes,
+		props.zone,
+	]);
+
+	// This effect uses the session to upload the worker and create a preview
+	useEffect(() => {
+		const abortController = new AbortController();
+		async function start() {
+			if (accountId === undefined) {
+				return;
+			}
+			if (session === undefined) {
+				return;
+			}
+			setToken(undefined); // reset token in case we're re-running
+
+			if (!bundle || !format) return;
+
+			if (!startedRef.current) {
+				startedRef.current = true;
+			} else {
+				logger.log("⎔ Detected changes, restarted server.");
+			}
+
+			const content = await readFile(bundle.path, "utf-8");
+
+			// TODO: For Dev we could show the reporter message in the interactive box.
+			void printBundleSize(
+				{ name: path.basename(bundle.path), content: content },
+				modules
+			);
+
+			const assets = await syncAssets(
+				accountId,
+				// When we're using the newer service environments, we wouldn't
+				// have added the env name on to the script name. However, we must
+				// include it in the kv namespace name regardless (since there's no
+				// concept of service environments for kv namespaces yet).
+				name + (!props.legacyEnv && props.env ? `-${props.env}` : ""),
+				props.isWorkersSite ? assetPaths : undefined,
+				true,
+				false
+			); // TODO: cancellable?
+
+			const init: CfWorkerInit = {
+				name,
+				main: {
+					name: path.basename(bundle.path),
+					type: format === "modules" ? "esm" : "commonjs",
+					content,
+				},
+				modules: modules.concat(
+					assets.manifest
+						? {
+								name: "__STATIC_CONTENT_MANIFEST",
+								content: JSON.stringify(assets.manifest),
+								type: "text",
+						  }
+						: []
+				),
+				bindings: {
+					...bindings,
+					kv_namespaces: (bindings.kv_namespaces || []).concat(
+						assets.namespace
+							? { binding: "__STATIC_CONTENT", id: assets.namespace }
+							: []
+					),
+					text_blobs: {
+						...bindings.text_blobs,
+						...(assets.manifest &&
+							format === "service-worker" && {
+								__STATIC_CONTENT_MANIFEST: "__STATIC_CONTENT_MANIFEST",
+							}),
+					},
+				},
+				migrations: undefined, // no migrations in dev
+				compatibility_date: compatibilityDate,
+				compatibility_flags: compatibilityFlags,
+				usage_model: usageModel,
+			};
+
+			const workerAccount: CfAccount = {
+				accountId,
+				apiToken: requireApiToken(),
+			};
+
+			const workerCtx: CfWorkerContext = {
+				env: props.env,
+				legacyEnv: props.legacyEnv,
+				zone: props.zone,
+				host: props.host,
+				routes: props.routes,
+			};
+
+			setToken(
+				await createWorkerPreview(
+					init,
+					workerAccount,
+					workerCtx,
+					session,
+					abortController.signal
+				)
+			);
+			onReady?.();
+		}
+		start().catch((err) => {
+			// we want to log the error, but not end the process
+			// since it could recover after the developer fixes whatever's wrong
+			if ((err as { code: string }).code !== "ABORT_ERR") {
+				// instead of logging the raw API error to the user,
+				// give them friendly instructions
+				// for error 10063 (workers.dev subdomain required)
+				if (err.code === 10063) {
+					const errorMessage =
+						"Error: You need to register a workers.dev subdomain before running the dev command in remote mode";
+					const solutionMessage =
+						"You can either enable local mode by pressing l, or register a workers.dev subdomain here:";
+					const onboardingLink = `https://dash.cloudflare.com/${accountId}/workers/onboarding`;
+					logger.error(
+						`${errorMessage}\n${solutionMessage}\n${onboardingLink}`
+					);
+				} else {
+					logger.error("Error on remote worker:", err);
+				}
+			}
+		});
+
+		return () => {
+			abortController.abort();
+		};
+	}, [
+		name,
+		bundle,
+		format,
+		accountId,
+		port,
+		assetPaths,
+		props.isWorkersSite,
+		compatibilityDate,
+		compatibilityFlags,
+		usageModel,
+		bindings,
+		modules,
+		props.env,
+		props.legacyEnv,
+		props.zone,
+		props.host,
+		props.routes,
+		session,
+		onReady,
+	]);
+	return token;
+}

package/src/dev/use-esbuild.ts

@@ -0,0 +1,150 @@
+import assert from "node:assert";
+import { watch } from "chokidar";
+import { useApp } from "ink";
+import { useState, useEffect } from "react";
+import { bundleWorker } from "../bundle";
+import { logger } from "../logger";
+import type { Config } from "../config";
+import type { Entry } from "../entry";
+import type { CfModule } from "../worker";
+import type { WatchMode } from "esbuild";
+
+export type EsbuildBundle = {
+	id: number;
+	path: string;
+	entry: Entry;
+	type: "esm" | "commonjs";
+	modules: CfModule[];
+};
+
+export function useEsbuild({
+	entry,
+	destination,
+	jsxFactory,
+	jsxFragment,
+	rules,
+	serveAssetsFromWorker,
+	tsconfig,
+	minify,
+	nodeCompat,
+	define,
+	noBundle,
+}: {
+	entry: Entry;
+	destination: string | undefined;
+	jsxFactory: string | undefined;
+	jsxFragment: string | undefined;
+	rules: Config["rules"];
+	define: Config["define"];
+	serveAssetsFromWorker: boolean;
+	tsconfig: string | undefined;
+	minify: boolean | undefined;
+	nodeCompat: boolean | undefined;
+	noBundle: boolean;
+}): EsbuildBundle | undefined {
+	const [bundle, setBundle] = useState<EsbuildBundle>();
+	const { exit } = useApp();
+	useEffect(() => {
+		let stopWatching: (() => void) | undefined = undefined;
+
+		function updateBundle() {
+			// nothing really changes here, so let's increment the id
+			// to change the return object's identity
+			setBundle((previousBundle) => {
+				assert(
+					previousBundle,
+					"Rebuild triggered with no previous build available"
+				);
+				return { ...previousBundle, id: previousBundle.id + 1 };
+			});
+		}
+
+		const watchMode: WatchMode = {
+			async onRebuild(error) {
+				if (error) logger.error("Watch build failed:", error);
+				else {
+					updateBundle();
+				}
+			},
+		};
+
+		async function build() {
+			if (!destination) return;
+
+			const {
+				resolvedEntryPointPath,
+				bundleType,
+				modules,
+				stop,
+			}: Awaited<ReturnType<typeof bundleWorker>> = noBundle
+				? {
+						modules: [],
+						resolvedEntryPointPath: entry.file,
+						bundleType: entry.format === "modules" ? "esm" : "commonjs",
+						stop: undefined,
+				  }
+				: await bundleWorker(entry, destination, {
+						serveAssetsFromWorker,
+						jsxFactory,
+						jsxFragment,
+						rules,
+						watch: watchMode,
+						tsconfig,
+						minify,
+						nodeCompat,
+						define,
+						checkFetch: true,
+				  });
+
+			// Capture the `stop()` method to use as the `useEffect()` destructor.
+			stopWatching = stop;
+
+			// if "noBundle" is true, then we need to manually watch the entry point and
+			// trigger "builds" when it changes
+			if (noBundle) {
+				const watcher = watch(entry.file, {
+					persistent: true,
+				}).on("change", async (_event) => {
+					updateBundle();
+				});
+
+				stopWatching = () => {
+					watcher.close();
+				};
+			}
+
+			setBundle({
+				id: 0,
+				entry,
+				path: resolvedEntryPointPath,
+				type: bundleType,
+				modules,
+			});
+		}
+
+		build().catch((err) => {
+			// If esbuild fails on first run, we want to quit the process
+			// since we can't recover from here
+			// related: https://github.com/evanw/esbuild/issues/1037
+			exit(err);
+		});
+
+		return () => {
+			stopWatching?.();
+		};
+	}, [
+		entry,
+		destination,
+		jsxFactory,
+		jsxFragment,
+		serveAssetsFromWorker,
+		rules,
+		tsconfig,
+		exit,
+		noBundle,
+		minify,
+		nodeCompat,
+		define,
+	]);
+	return bundle;
+}