wrangler 0.0.0-e3e3243 → 0.0.0-e4047cab

package/src/entry.ts

@@ -1,8 +1,10 @@
 import assert from "node:assert";
-import { existsSync } from "node:fs";
+import { existsSync, statSync } from "node:fs";
 import path from "node:path";
 import * as esbuild from "esbuild";
 import { execaCommand } from "execa";
+import { logger } from "./logger";
+import { getBasePath } from "./paths";
 import type { Config } from "./config";
 import type { CfScriptFormat } from "./worker";
 import type { Metafile } from "esbuild";
@@ -18,92 +20,115 @@ export type Entry = { file: string; directory: string; format: CfScriptFormat };
  * Compute the entry-point for the Worker.
  */
 export async function getEntry(
-  args: { script?: string; format?: CfScriptFormat | undefined },
-  config: Config,
-  command: "dev" | "publish"
+	args: {
+		script?: string;
+		format?: CfScriptFormat | undefined;
+		assets?: string | undefined;
+	},
+	config: Config,
+	command: "dev" | "publish" | "types"
 ): Promise<Entry> {
-  let file: string;
-  let directory = process.cwd();
-  if (args.script) {
-    // If the script name comes from the command line it is relative to the current working directory.
-    file = path.resolve(args.script);
-  } else if (config.main === undefined) {
-    throw new Error(
-      `Missing entry-point: The entry-point should be specified via the command line (e.g. \`wrangler ${command} path/to/script\`) or the \`main\` config field.`
-    );
-  } else {
-    directory = path.resolve(path.dirname(config.configPath ?? "."));
-    file = path.resolve(directory, config.main);
-  }
-
-  await runCustomBuild(file, config.build);
-
-  if (fileExists(file) === false) {
-    throw new Error(
-      `Could not resolve "${path.relative(process.cwd(), file)}".`
-    );
-  }
-  const format = await guessWorkerFormat(
-    file,
-    directory,
-    args.format ?? config.build?.upload?.format,
-    config.tsconfig
-  );
-
-  const { localBindings, remoteBindings } =
-    partitionDurableObjectBindings(config);
-
-  if (command === "dev" && remoteBindings.length > 0) {
-    console.warn(
-      "WARNING: You have Durable Object bindings, which are not defined locally in the worker being developed.\n" +
-        "Be aware that changes to the data stored in these Durable Objects will be permanent and affect the live instances.\n" +
-        "Remote Durable Objects that are affected:\n" +
-        remoteBindings.map((b) => `- ${JSON.stringify(b)}`).join("\n")
-    );
-  }
-
-  if (format === "service-worker" && localBindings.length > 0) {
-    const errorMessage =
-      "You seem to be trying to use Durable Objects in a Worker written with Service Worker syntax.";
-    const addScriptName =
-      "You can use Durable Objects defined in other Workers by specifying a `script_name` in your wrangler.toml, where `script_name` is the name of the Worker that implements that Durable Object. For example:";
-    const addScriptNameExamples = generateAddScriptNameExamples(localBindings);
-    const migrateText =
-      "Alternatively, migrate your worker to ES Module syntax to implement a Durable Object in this Worker:";
-    const migrateUrl =
-      "https://developers.cloudflare.com/workers/learning/migrating-to-module-workers/";
-    throw new Error(
-      `${errorMessage}\n${addScriptName}\n${addScriptNameExamples}\n${migrateText}\n${migrateUrl}`
-    );
-  }
-
-  return { file, directory, format };
+	let file: string;
+	let directory = process.cwd();
+	if (args.script) {
+		// If the script name comes from the command line it is relative to the current working directory.
+		file = path.resolve(args.script);
+	} else if (config.main === undefined) {
+		if (config.site?.["entry-point"]) {
+			directory = path.resolve(path.dirname(config.configPath ?? "."));
+			file = path.extname(config.site?.["entry-point"])
+				? path.resolve(config.site?.["entry-point"])
+				: // site.entry-point could be a directory
+				  path.resolve(config.site?.["entry-point"], "index.js");
+		} else if (args.assets || config.assets) {
+			file = path.resolve(getBasePath(), "templates/no-op-worker.js");
+		} else {
+			throw new Error(
+				`Missing entry-point: The entry-point should be specified via the command line (e.g. \`wrangler ${command} path/to/script\`) or the \`main\` config field.`
+			);
+		}
+	} else {
+		directory = path.resolve(path.dirname(config.configPath ?? "."));
+		file = path.resolve(directory, config.main);
+	}
+
+	const relativeFile = path.relative(directory, file) || ".";
+	await runCustomBuild(file, relativeFile, config.build);
+
+	if (fileExists(file) === false) {
+		throw new Error(
+			getMissingEntryPointMessage(
+				`The entry-point file at "${relativeFile}" was not found.`,
+				file,
+				relativeFile
+			)
+		);
+	}
+	const format = await guessWorkerFormat(
+		file,
+		directory,
+		args.format ?? config.build?.upload?.format,
+		config.tsconfig
+	);
+
+	const { localBindings, remoteBindings } =
+		partitionDurableObjectBindings(config);
+
+	if (command === "dev" && remoteBindings.length > 0) {
+		logger.warn(
+			"WARNING: You have Durable Object bindings that are not defined locally in the worker being developed.\n" +
+				"Be aware that changes to the data stored in these Durable Objects will be permanent and affect the live instances.\n" +
+				"Remote Durable Objects that are affected:\n" +
+				remoteBindings.map((b) => `- ${JSON.stringify(b)}`).join("\n")
+		);
+	}
+
+	if (format === "service-worker" && localBindings.length > 0) {
+		const errorMessage =
+			"You seem to be trying to use Durable Objects in a Worker written as a service-worker.";
+		const addScriptName =
+			"You can use Durable Objects defined in other Workers by specifying a `script_name` in your wrangler.toml, where `script_name` is the name of the Worker that implements that Durable Object. For example:";
+		const addScriptNameExamples = generateAddScriptNameExamples(localBindings);
+		const migrateText =
+			"Alternatively, migrate your worker to ES Module syntax to implement a Durable Object in this Worker:";
+		const migrateUrl =
+			"https://developers.cloudflare.com/workers/learning/migrating-to-module-workers/";
+		throw new Error(
+			`${errorMessage}\n${addScriptName}\n${addScriptNameExamples}\n${migrateText}\n${migrateUrl}`
+		);
+	}
+
+	return { file, directory, format };
 }
 
 export async function runCustomBuild(
-  expectedEntry: string,
-  build: Config["build"]
+	expectedEntryAbsolute: string,
+	expectedEntryRelative: string,
+	build: Config["build"]
 ) {
-  if (build?.command) {
-    // TODO: add a deprecation message here?
-    console.log("running:", build.command);
-    await execaCommand(build.command, {
-      shell: true,
-      stdout: "inherit",
-      stderr: "inherit",
-      timeout: 1000 * 30,
-      ...(build.cwd && { cwd: build.cwd }),
-    });
-
-    if (fileExists(expectedEntry) === false) {
-      throw new Error(
-        `Could not resolve "${path.relative(
-          process.cwd(),
-          expectedEntry
-        )}" after running custom build: ${build.command}`
-      );
-    }
-  }
+	if (build?.command) {
+		// TODO: add a deprecation message here?
+		logger.log("Running custom build:", build.command);
+		await execaCommand(build.command, {
+			shell: true,
+			// we keep these two as "inherit" so that
+			// logs are still visible.
+			stdout: "inherit",
+			stderr: "inherit",
+			...(build.cwd && { cwd: build.cwd }),
+		});
+
+		if (fileExists(expectedEntryAbsolute) === false) {
+			throw new Error(
+				getMissingEntryPointMessage(
+					`The expected output file at "${expectedEntryRelative}" was not found after running custom build: ${build.command}.\n` +
+						"The `main` property in wrangler.toml should point to the file generated by the custom build.",
+					expectedEntryAbsolute,
+					expectedEntryRelative
+				)
+			);
+		}
+	}
 }
 
 /**
@@ -115,64 +140,81 @@ export async function runCustomBuild(
  * well in practice.
  */
 export default async function guessWorkerFormat(
-  entryFile: string,
-  entryWorkingDirectory: string,
-  hint: CfScriptFormat | undefined,
-  tsconfig?: string | undefined
+	entryFile: string,
+	entryWorkingDirectory: string,
+	hint: CfScriptFormat | undefined,
+	tsconfig?: string | undefined
 ): Promise<CfScriptFormat> {
-  const result = await esbuild.build({
-    entryPoints: [entryFile],
-    absWorkingDir: entryWorkingDirectory,
-    metafile: true,
-    bundle: false,
-    format: "esm",
-    write: false,
-    loader: {
-      ".js": "jsx",
-      ".mjs": "jsx",
-      ".cjs": "jsx",
-    },
-    ...(tsconfig && { tsconfig }),
-  });
-  // result.metafile is defined because of the `metafile: true` option above.
-  // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-  const metafile = result.metafile!;
-  const entryPoints = Object.entries(metafile.outputs).filter(
-    ([_path, output]) => output.entryPoint !== undefined
-  );
-  assert(
-    entryPoints.length > 0,
-    `Cannot find entry-point "${entryFile}" in generated bundle.` +
-      listEntryPoints(entryPoints)
-  );
-  assert(
-    entryPoints.length < 2,
-    "More than one entry-point found for generated bundle." +
-      listEntryPoints(entryPoints)
-  );
-  const guessedWorkerFormat =
-    entryPoints[0][1].exports.length > 0 ? "modules" : "service-worker";
-
-  if (hint) {
-    if (hint !== guessedWorkerFormat) {
-      if (hint === "service-worker") {
-        throw new Error(
-          "You configured this worker to be a 'service-worker', but the file you are trying to build appears to have ES module exports. Please pass `--format modules`, or simply remove the configuration."
-        );
-      } else {
-        throw new Error(
-          "You configured this worker to be 'modules', but the file you are trying to build doesn't export a handler. Please pass `--format service-worker`, or simply remove the configuration."
-        );
-      }
-    }
-  }
-  return guessedWorkerFormat;
+	const result = await esbuild.build({
+		entryPoints: [entryFile],
+		absWorkingDir: entryWorkingDirectory,
+		metafile: true,
+		bundle: false,
+		format: "esm",
+		target: "es2020",
+		write: false,
+		loader: {
+			".js": "jsx",
+			".mjs": "jsx",
+			".cjs": "jsx",
+		},
+		...(tsconfig && { tsconfig }),
+	});
+	// result.metafile is defined because of the `metafile: true` option above.
+	// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+	const metafile = result.metafile!;
+	const entryPoints = Object.entries(metafile.outputs).filter(
+		([_path, output]) => output.entryPoint !== undefined
+	);
+	assert(
+		entryPoints.length > 0,
+		`Cannot find entry-point "${entryFile}" in generated bundle.` +
+			listEntryPoints(entryPoints)
+	);
+	assert(
+		entryPoints.length < 2,
+		"More than one entry-point found for generated bundle." +
+			listEntryPoints(entryPoints)
+	);
+
+	let guessedWorkerFormat: CfScriptFormat;
+	const scriptExports = entryPoints[0][1].exports;
+	if (scriptExports.length > 0) {
+		if (scriptExports.includes("default")) {
+			guessedWorkerFormat = "modules";
+		} else {
+			logger.warn(
+				`The entrypoint ${path.relative(
+					process.cwd(),
+					entryFile
+				)} has exports like an ES Module, but hasn't defined a default export like a module worker normally would. Building the worker using "service-worker" format...`
+			);
+			guessedWorkerFormat = "service-worker";
+		}
+	} else {
+		guessedWorkerFormat = "service-worker";
+	}
+
+	if (hint) {
+		if (hint !== guessedWorkerFormat) {
+			if (hint === "service-worker") {
+				throw new Error(
+					"You configured this worker to be a 'service-worker', but the file you are trying to build appears to have a `default` export like a module worker. Please pass `--format modules`, or simply remove the configuration."
+				);
+			} else {
+				throw new Error(
+					"You configured this worker to be 'modules', but the file you are trying to build doesn't export a handler. Please pass `--format service-worker`, or simply remove the configuration."
+				);
+			}
+		}
+	}
+	return guessedWorkerFormat;
 }
 
 function listEntryPoints(
-  outputs: [string, ValueOf<Metafile["outputs"]>][]
+	outputs: [string, ValueOf<Metafile["outputs"]>][]
 ): string {
-  return outputs.map(([_input, output]) => output.entryPoint).join("\n");
+	return outputs.map(([_input, output]) => output.entryPoint).join("\n");
 }
 
 type ValueOf<T> = T[keyof T];
@@ -182,16 +224,16 @@ type ValueOf<T> = T[keyof T];
  * or if some version of it (by appending a common extension) exists.
  */
 export function fileExists(filePath: string): boolean {
-  if (path.extname(filePath) !== "") {
-    return existsSync(filePath);
-  }
-  const base = path.join(path.dirname(filePath), path.basename(filePath));
-  for (const ext of [".ts", ".tsx", ".js", ".jsx"]) {
-    if (existsSync(base + ext)) {
-      return true;
-    }
-  }
-  return false;
+	if (path.extname(filePath) !== "") {
+		return existsSync(filePath);
+	}
+	const base = path.join(path.dirname(filePath), path.basename(filePath));
+	for (const ext of [".ts", ".tsx", ".js", ".jsx"]) {
+		if (existsSync(base + ext)) {
+			return true;
+		}
+	}
+	return false;
 }
 
 type DurableObjectBindings = Config["durable_objects"]["bindings"];
@@ -201,19 +243,19 @@ type DurableObjectBindings = Config["durable_objects"]["bindings"];
  * those that are defined locally and those that refer to a durable object defined in another script.
  */
 function partitionDurableObjectBindings(config: Config): {
-  localBindings: DurableObjectBindings;
-  remoteBindings: DurableObjectBindings;
+	localBindings: DurableObjectBindings;
+	remoteBindings: DurableObjectBindings;
 } {
-  const localBindings: DurableObjectBindings = [];
-  const remoteBindings: DurableObjectBindings = [];
-  for (const binding of config.durable_objects.bindings) {
-    if (binding.script_name === undefined) {
-      localBindings.push(binding);
-    } else {
-      remoteBindings.push(binding);
-    }
-  }
-  return { localBindings, remoteBindings };
+	const localBindings: DurableObjectBindings = [];
+	const remoteBindings: DurableObjectBindings = [];
+	for (const binding of config.durable_objects.bindings) {
+		if (binding.script_name === undefined) {
+			localBindings.push(binding);
+		} else {
+			remoteBindings.push(binding);
+		}
+	}
+	return { localBindings, remoteBindings };
 }
 
 /**
@@ -222,19 +264,66 @@ function partitionDurableObjectBindings(config: Config): {
  * externally defined Durable Object.
  */
 function generateAddScriptNameExamples(
-  localBindings: DurableObjectBindings
+	localBindings: DurableObjectBindings
 ): string {
-  function exampleScriptName(binding_name: string): string {
-    return `${binding_name.toLowerCase().replaceAll("_", "-")}-worker`;
-  }
-
-  return localBindings
-    .map(({ name, class_name }) => {
-      const script_name = exampleScriptName(name);
-      const currentBinding = `{ name = ${name}, class_name = ${class_name} }`;
-      const fixedBinding = `{ name = ${name}, class_name = ${class_name}, script_name = ${script_name} }`;
-
-      return `${currentBinding} ==> ${fixedBinding}`;
-    })
-    .join("\n");
+	function exampleScriptName(binding_name: string): string {
+		return `${binding_name.toLowerCase().replaceAll("_", "-")}-worker`;
+	}
+
+	return localBindings
+		.map(({ name, class_name }) => {
+			const script_name = exampleScriptName(name);
+			const currentBinding = `{ name = ${name}, class_name = ${class_name} }`;
+			const fixedBinding = `{ name = ${name}, class_name = ${class_name}, script_name = ${script_name} }`;
+
+			return `${currentBinding} ==> ${fixedBinding}`;
+		})
+		.join("\n");
+}
+
+/**
+ * Generate an appropriate message for when the entry-point is missing.
+ *
+ * To be more helpful to developers, we check whether there is a suitable file
+ * nearby to the expected file path.
+ */
+function getMissingEntryPointMessage(
+	message: string,
+	absoluteEntryPointPath: string,
+	relativeEntryPointPath: string
+): string {
+	if (
+		existsSync(absoluteEntryPointPath) &&
+		statSync(absoluteEntryPointPath).isDirectory()
+	) {
+		// The expected entry-point is a directory, so offer further guidance.
+		message += `\nThe provided entry-point path, "${relativeEntryPointPath}", points to a directory, rather than a file.\n`;
+
+		// Perhaps we can even guess what the correct path should be...
+		const possiblePaths: string[] = [];
+		for (const basenamePath of [
+			"worker",
+			"dist/worker",
+			"index",
+			"dist/index",
+		]) {
+			for (const extension of [".ts", ".tsx", ".js", ".jsx"]) {
+				const filePath = basenamePath + extension;
+				if (fileExists(path.resolve(absoluteEntryPointPath, filePath))) {
+					possiblePaths.push(path.join(relativeEntryPointPath, filePath));
+				}
+			}
+		}
+
+		if (possiblePaths.length > 0) {
+			message +=
+				`\nDid you mean to set the main field to${
+					possiblePaths.length > 1 ? " one of" : ""
+				}:\n` +
+				"```\n" +
+				possiblePaths.map((filePath) => `main = "./${filePath}"\n`).join("") +
+				"```";
+		}
+	}
+	return message;
 }

package/src/environment-variables.ts

@@ -1,3 +1,20 @@
+import { logger } from "./logger";
+
+type VariableNames =
+	| "CLOUDFLARE_ACCOUNT_ID"
+	| "CLOUDFLARE_API_TOKEN"
+	| "CLOUDFLARE_API_KEY"
+	| "CLOUDFLARE_EMAIL"
+	| "WRANGLER_SEND_METRICS"
+	| "CLOUDFLARE_API_BASE_URL"
+	| "WRANGLER_LOG";
+
+type DeprecatedNames =
+	| "CF_ACCOUNT_ID"
+	| "CF_API_TOKEN"
+	| "CF_API_KEY"
+	| "CF_EMAIL"
+	| "CF_API_BASE_URL";
 /**
  * Create a function used to access an environment variable.
  *
@@ -5,29 +22,29 @@
  * A warning is shown if the client is using a deprecated version - but only once.
  */
 export function getEnvironmentVariableFactory({
-  variableName,
-  deprecatedName,
-  defaultValue,
+	variableName,
+	deprecatedName,
+	defaultValue,
 }: {
-  variableName: string;
-  deprecatedName?: string;
-  defaultValue?: string;
+	variableName: VariableNames;
+	deprecatedName?: DeprecatedNames;
+	defaultValue?: string;
 }) {
-  let hasWarned = false;
-  return () => {
-    if (process.env[variableName]) {
-      return process.env[variableName];
-    } else if (deprecatedName && process.env[deprecatedName]) {
-      if (!hasWarned) {
-        // Only show the warning once.
-        hasWarned = true;
-        console.warn(
-          `Using "${deprecatedName}" environment variable. This is deprecated. Please use "${variableName}", instead.`
-        );
-      }
-      return process.env[deprecatedName];
-    } else {
-      return defaultValue;
-    }
-  };
+	let hasWarned = false;
+	return () => {
+		if (process.env[variableName]) {
+			return process.env[variableName];
+		} else if (deprecatedName && process.env[deprecatedName]) {
+			if (!hasWarned) {
+				// Only show the warning once.
+				hasWarned = true;
+				logger.warn(
+					`Using "${deprecatedName}" environment variable. This is deprecated. Please use "${variableName}", instead.`
+				);
+			}
+			return process.env[deprecatedName];
+		} else {
+			return defaultValue;
+		}
+	};
 }

package/src/errors.ts

@@ -0,0 +1,11 @@
+export class DeprecationError extends Error {
+	constructor(message: string) {
+		super(`Deprecation:\n${message}`);
+	}
+}
+
+export class FatalError extends Error {
+	constructor(message?: string, readonly code?: number) {
+		super(message);
+	}
+}