wrangler 0.0.0-e492c10 → 0.0.0-e4bb5f36

package/src/dialogs.tsx

@@ -1,87 +0,0 @@
-import chalk from "chalk";
-import { Box, Text, useInput, render } from "ink";
-import TextInput from "ink-text-input";
-import * as React from "react";
-import { useState } from "react";
-import { logger } from "./logger";
-type ConfirmProps = {
-  text: string;
-  onConfirm: (answer: boolean) => void;
-};
-function Confirm(props: ConfirmProps) {
-  useInput((input: string, key) => {
-    if (input === "y" || key.return === true) {
-      props.onConfirm(true);
-    } else if (input === "n") {
-      props.onConfirm(false);
-    } else {
-      logger.warn("Unrecognised input:", input);
-    }
-  });
-  return (
-    <Box>
-      <Text>
-        {props.text} ({chalk.bold("y")}/n)
-      </Text>
-    </Box>
-  );
-}
-
-export function confirm(text: string): Promise<boolean> {
-  return new Promise((resolve) => {
-    const { unmount } = render(
-      <Confirm
-        text={text}
-        onConfirm={(answer: boolean) => {
-          unmount();
-          resolve(answer);
-        }}
-      />
-    );
-  });
-}
-
-type PromptProps = {
-  text: string;
-  defaultValue?: string;
-  type?: "text" | "password";
-  onSubmit: (text: string) => void;
-};
-
-function Prompt(props: PromptProps) {
-  const [value, setValue] = useState(props.defaultValue || "");
-
-  return (
-    <Box>
-      <Text>{props.text} </Text>
-      <Box>
-        <TextInput
-          mask={props.type === "password" ? "*" : undefined}
-          value={value}
-          onChange={setValue}
-          onSubmit={props.onSubmit}
-        />
-      </Box>
-    </Box>
-  );
-}
-
-export async function prompt(
-  text: string,
-  type: "text" | "password" = "text",
-  defaultValue?: string
-): Promise<string> {
-  return new Promise((resolve) => {
-    const { unmount } = render(
-      <Prompt
-        text={text}
-        defaultValue={defaultValue}
-        type={type}
-        onSubmit={(inputText) => {
-          unmount();
-          resolve(inputText);
-        }}
-      />
-    );
-  });
-}

package/src/entry.ts

@@ -1,267 +0,0 @@
-import assert from "node:assert";
-import { existsSync } from "node:fs";
-import path from "node:path";
-import * as esbuild from "esbuild";
-import { execaCommand } from "execa";
-import { logger } from "./logger";
-import type { Config } from "./config";
-import type { CfScriptFormat } from "./worker";
-import type { Metafile } from "esbuild";
-
-/**
- * An entry point for the Worker.
- *
- * It consists not just of a `file`, but also of a `directory` that is used to resolve relative paths.
- */
-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"
-): 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) {
-    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 {
-      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) {
-    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"]
-) {
-  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(expectedEntry) === false) {
-      throw new Error(
-        `Could not resolve "${path.relative(
-          process.cwd(),
-          expectedEntry
-        )}" after running custom build: ${build.command}`
-      );
-    }
-  }
-}
-
-/**
- * A function to "guess" the type of worker.
- * We do this by running a lightweight build of the actual script,
- * and looking at the metafile generated by esbuild. If it has a default
- * export (or really, any exports), that means it's a "modules" worker.
- * Else, it's a "service-worker" worker. This seems hacky, but works remarkably
- * well in practice.
- */
-export default async function guessWorkerFormat(
-  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",
-    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"]>][]
-): string {
-  return outputs.map(([_input, output]) => output.entryPoint).join("\n");
-}
-
-type ValueOf<T> = T[keyof T];
-
-/**
- * Returns true if the given `filePath` exists as-is,
- * 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;
-}
-
-type DurableObjectBindings = Config["durable_objects"]["bindings"];
-
-/**
- * Groups the durable object bindings into two lists:
- * 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;
-} {
-  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 };
-}
-
-/**
- * Generates some help text based on the Durable Object bindings in a given
- * config indicating how the user can add a `script_name` field to bind an
- * externally defined Durable Object.
- */
-function generateAddScriptNameExamples(
-  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");
-}

package/src/environment-variables.ts

@@ -1,35 +0,0 @@
-import { logger } from "./logger";
-
-/**
- * Create a function used to access an environment variable.
- *
- * This is not memoized to allow us to change the value at runtime, such as in testing.
- * A warning is shown if the client is using a deprecated version - but only once.
- */
-export function getEnvironmentVariableFactory({
-  variableName,
-  deprecatedName,
-  defaultValue,
-}: {
-  variableName: string;
-  deprecatedName?: string;
-  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;
-        logger.warn(
-          `Using "${deprecatedName}" environment variable. This is deprecated. Please use "${variableName}", instead.`
-        );
-      }
-      return process.env[deprecatedName];
-    } else {
-      return defaultValue;
-    }
-  };
-}

package/src/errors.ts

@@ -1,11 +0,0 @@
-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);
-  }
-}

package/src/https-options.ts

@@ -1,123 +0,0 @@
-import * as fs from "node:fs";
-import { homedir, networkInterfaces } from "node:os";
-import * as path from "node:path";
-import { promisify } from "node:util";
-import { logger } from "./logger";
-import type { Attributes, Options } from "selfsigned";
-
-// Most of this file has been borrowed from the implementation in Miniflare.
-// See https://github.com/cloudflare/miniflare/blob/870b401ef5/packages/http-server/src/plugin.ts#L313-L397
-// Thanks @mrbbot.
-const CERT_EXPIRY_DAYS = 30;
-const ONE_DAY_IN_MS = 86400000;
-
-/**
- * Get the options (i.e. SSL certificates) for running an HTTPS server.
- *
- * The certificates are self-signed and generated locally, and cached in the `CERT_ROOT` directory.
- */
-export async function getHttpsOptions() {
-  const certDirectory = path.join(homedir(), ".wrangler/local-cert");
-  const keyPath = path.join(certDirectory, "key.pem");
-  const certPath = path.join(certDirectory, "cert.pem");
-
-  const regenerate =
-    !fs.existsSync(keyPath) ||
-    !fs.existsSync(certPath) ||
-    hasCertificateExpired(keyPath, certPath);
-
-  if (regenerate) {
-    logger.log("Generating new self-signed certificate...");
-    const { key, cert } = await generateCertificate();
-    try {
-      // Write certificate files so we can reuse them later.
-      fs.mkdirSync(certDirectory, { recursive: true });
-      fs.writeFileSync(keyPath, key, "utf8");
-      fs.writeFileSync(certPath, cert, "utf8");
-    } catch (e) {
-      const message = e instanceof Error ? e.message : `${e}`;
-      logger.warn(
-        `Unable to cache generated self-signed certificate in ${certDirectory}.\n${message}`
-      );
-    }
-    return { key, cert };
-  } else {
-    return {
-      key: fs.readFileSync(keyPath, "utf8"),
-      cert: fs.readFileSync(certPath, "utf8"),
-    };
-  }
-}
-
-/**
- * Determine if the certificate defined in `keyPath` and `certPath` files
- * have expired based on the date when they were last modified.
- */
-function hasCertificateExpired(keyPath: string, certPath: string): boolean {
-  const keyStat = fs.statSync(keyPath);
-  const certStat = fs.statSync(certPath);
-  const created = Math.max(keyStat.mtimeMs, certStat.mtimeMs);
-  return Date.now() - created > (CERT_EXPIRY_DAYS - 2) * ONE_DAY_IN_MS;
-}
-
-/**
- * Generate a new self-signed certificate and cache it in `CERT_ROOT` directory.
- */
-async function generateCertificate() {
-  // `selfsigned` imports `node-forge`, which is a pretty big library.
-  // To reduce startup time, only load this dynamically when needed.
-  // eslint-disable-next-line @typescript-eslint/consistent-type-imports
-  const generate: typeof import("selfsigned").generate = promisify(
-    // eslint-disable-next-line @typescript-eslint/no-var-requires
-    require("selfsigned").generate
-  );
-
-  const certAttrs: Attributes = [{ name: "commonName", value: "localhost" }];
-
-  const certOptions: Options = {
-    algorithm: "sha256",
-    days: CERT_EXPIRY_DAYS,
-    keySize: 2048,
-    extensions: [
-      { name: "basicConstraints", cA: true },
-      {
-        name: "keyUsage",
-        keyCertSign: true,
-        digitalSignature: true,
-        nonRepudiation: true,
-        keyEncipherment: true,
-        dataEncipherment: true,
-      },
-      {
-        name: "extKeyUsage",
-        serverAuth: true,
-        clientAuth: true,
-        codeSigning: true,
-        timeStamping: true,
-      },
-      {
-        name: "subjectAltName",
-        altNames: [
-          { type: 2, value: "localhost" },
-          ...getAccessibleHosts().map((ip) => ({ type: 7, ip })),
-        ],
-      },
-    ],
-  };
-
-  const { private: key, cert } = await generate(certAttrs, certOptions);
-  return { key, cert };
-}
-
-/**
- * Ask the OS for the addresses of locally accessible hosts.
- */
-function getAccessibleHosts(ipv4 = false): string[] {
-  const hosts: string[] = [];
-  Object.values(networkInterfaces()).forEach((net) =>
-    net?.forEach(({ family, address }) => {
-      if (!ipv4 || family === "IPv4") hosts.push(address);
-    })
-  );
-  return hosts;
-}