wrangler 0.0.0-e2a26a0 → 0.0.0-e3a458e

package/src/dev/local.tsx

@@ -0,0 +1,247 @@
+import { spawn } from "node:child_process";
+import { realpathSync } from "node:fs";
+import { writeFile } from "node:fs/promises";
+import path from "node:path";
+import { useState, useEffect, useRef } from "react";
+import onExit from "signal-exit";
+import useInspector from "../inspect";
+import { DEFAULT_MODULE_RULES } from "../module-collection";
+import { waitForPortToBeAvailable } from "../proxy";
+import type { Config } from "../config";
+import type { AssetPaths } from "../sites";
+import type { CfWorkerInit, CfScriptFormat } from "../worker";
+import type { EsbuildBundle } from "./use-esbuild";
+
+export function Local(props: {
+  name: undefined | string;
+  bundle: EsbuildBundle | undefined;
+  format: CfScriptFormat | undefined;
+  bindings: CfWorkerInit["bindings"];
+  assetPaths: undefined | AssetPaths;
+  public: undefined | string;
+  port: number;
+  ip: string;
+  rules: Config["rules"];
+  inspectorPort: number;
+  enableLocalPersistence: boolean;
+}) {
+  const { inspectorUrl } = useLocalWorker({
+    name: props.name,
+    bundle: props.bundle,
+    format: props.format,
+    bindings: props.bindings,
+    assetPaths: props.assetPaths,
+    public: props.public,
+    port: props.port,
+    ip: props.ip,
+    rules: props.rules,
+    enableLocalPersistence: props.enableLocalPersistence,
+  });
+  useInspector({
+    inspectorUrl,
+    port: props.inspectorPort,
+    logToTerminal: false,
+  });
+  return null;
+}
+
+function useLocalWorker(props: {
+  name: undefined | string;
+  bundle: EsbuildBundle | undefined;
+  rules: Config["rules"];
+  format: CfScriptFormat | undefined;
+  bindings: CfWorkerInit["bindings"];
+  assetPaths: undefined | AssetPaths;
+  public: undefined | string;
+  port: number;
+  ip: string;
+  enableLocalPersistence: boolean;
+}) {
+  // TODO: pass vars via command line
+  const { bundle, format, bindings, port, ip, assetPaths } = props;
+  const local = useRef<ReturnType<typeof spawn>>();
+  const removeSignalExitListener = useRef<() => void>();
+  const [inspectorUrl, setInspectorUrl] = useState<string | undefined>();
+  useEffect(() => {
+    async function startLocalWorker() {
+      if (!bundle || !format) return;
+
+      // port for the worker
+      await waitForPortToBeAvailable(port, { retryPeriod: 200, timeout: 2000 });
+
+      if (props.public) {
+        throw new Error(
+          '⎔ A "public" folder is not yet supported in local mode.'
+        );
+      }
+
+      // In local mode, we want to copy all referenced modules into
+      // the output bundle directory before starting up
+      for (const module of bundle.modules) {
+        await writeFile(
+          path.join(path.dirname(bundle.path), module.name),
+          module.content
+        );
+      }
+
+      console.log("⎔ Starting a local server...");
+      // TODO: just use execa for this
+      local.current = spawn(
+        "node",
+        [
+          "--experimental-vm-modules",
+          "--inspect",
+          require.resolve("miniflare/cli"),
+          realpathSync(bundle.path),
+          "--watch",
+          "--wrangler-config",
+          path.join(__dirname, "../miniflare-config-stubs/wrangler.empty.toml"),
+          "--env",
+          path.join(__dirname, "../miniflare-config-stubs/.env.empty"),
+          "--package",
+          path.join(__dirname, "../miniflare-config-stubs/package.empty.json"),
+          "--port",
+          port.toString(),
+          "--host",
+          ip,
+          ...(assetPaths
+            ? [
+                "--site",
+                path.join(process.cwd(), assetPaths.baseDirectory),
+                ...assetPaths.includePatterns.map((pattern) => [
+                  "--site-include",
+                  pattern,
+                ]),
+                ...assetPaths.excludePatterns.map((pattern) => [
+                  "--site-exclude",
+                  pattern,
+                ]),
+              ].flatMap((x) => x)
+            : []),
+          ...(props.enableLocalPersistence
+            ? ["--kv-persist", "--cache-persist", "--do-persist"]
+            : []),
+          ...Object.entries(bindings.vars || {}).flatMap(([key, value]) => {
+            return ["--binding", `${key}=${value}`];
+          }),
+          ...(bindings.kv_namespaces || []).flatMap(({ binding }) => {
+            return ["--kv", binding];
+          }),
+          ...(bindings.durable_objects?.bindings || []).flatMap(
+            ({ name, class_name }) => {
+              return ["--do", `${name}=${class_name}`];
+            }
+          ),
+          ...Object.entries(bindings.wasm_modules || {}).flatMap(
+            ([name, filePath]) => {
+              return [
+                "--wasm",
+                `${name}=${path.join(process.cwd(), filePath)}`,
+              ];
+            }
+          ),
+          ...bundle.modules.reduce<string[]>((cmd, { name, type }) => {
+            if (format === "service-worker") {
+              if (type === "compiled-wasm") {
+                // In service-worker format, .wasm modules are referenced
+                // by global identifiers, so we convert it here.
+                // This identifier has to be a valid JS identifier,
+                // so we replace all non alphanumeric characters
+                // with an underscore.
+                const identifier = name.replace(/[^a-zA-Z0-9_$]/g, "_");
+                return cmd.concat([`--wasm`, `${identifier}=${name}`]);
+              } else {
+                // TODO: we should actually support this
+                throw new Error(
+                  `⎔ Unsupported module type ${type} for file ${name} in service-worker format`
+                );
+              }
+            }
+            return cmd;
+          }, []),
+          "--modules",
+          String(format === "modules"),
+          ...(props.rules || [])
+            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+            .concat(DEFAULT_MODULE_RULES!)
+            .flatMap((rule) =>
+              rule.globs.flatMap((glob) => [
+                "--modules-rule",
+                `${rule.type}=${glob}`,
+              ])
+            ),
+        ],
+        {
+          cwd: path.dirname(realpathSync(bundle.path)),
+        }
+      );
+      console.log(`⬣ Listening at http://localhost:${port}`);
+
+      local.current.on("close", (code) => {
+        if (code) {
+          console.log(`miniflare process exited with code ${code}`);
+        }
+      });
+
+      local.current.stdout?.on("data", (data: Buffer) => {
+        console.log(`${data.toString()}`);
+      });
+
+      local.current.stderr?.on("data", (data: Buffer) => {
+        console.error(`${data.toString()}`);
+        const matches =
+          /Debugger listening on (ws:\/\/127\.0\.0\.1:\d+\/[A-Za-z0-9-]+)/.exec(
+            data.toString()
+          );
+        if (matches) {
+          setInspectorUrl(matches[1]);
+        }
+      });
+
+      local.current.on("exit", (code) => {
+        if (code) {
+          console.error(`miniflare process exited with code ${code}`);
+        }
+      });
+
+      local.current.on("error", (error: Error) => {
+        console.error(`miniflare process failed to spawn`);
+        console.error(error);
+      });
+
+      removeSignalExitListener.current = onExit((_code, _signal) => {
+        console.log("⎔ Shutting down local server.");
+        local.current?.kill();
+        local.current = undefined;
+      });
+    }
+
+    startLocalWorker().catch((err) => {
+      console.error("local worker:", err);
+    });
+
+    return () => {
+      if (local.current) {
+        console.log("⎔ Shutting down local server.");
+        local.current?.kill();
+        local.current = undefined;
+        removeSignalExitListener.current && removeSignalExitListener.current();
+        removeSignalExitListener.current = undefined;
+      }
+    };
+  }, [
+    bundle,
+    format,
+    port,
+    ip,
+    bindings.durable_objects?.bindings,
+    bindings.kv_namespaces,
+    bindings.vars,
+    props.enableLocalPersistence,
+    assetPaths,
+    props.public,
+    props.rules,
+    bindings.wasm_modules,
+  ]);
+  return { inspectorUrl };
+}

package/src/dev/remote.tsx

@@ -0,0 +1,203 @@
+import assert from "node:assert";
+import { readFile } from "node:fs/promises";
+import path from "node:path";
+import { useState, useEffect, useRef } from "react";
+import { createWorkerPreview } from "../create-worker-preview";
+import useInspector from "../inspect";
+import { usePreviewServer } from "../proxy";
+import { syncAssets } from "../sites";
+import type { CfPreviewToken } from "../create-worker-preview";
+import type { AssetPaths } from "../sites";
+import type { CfModule, CfWorkerInit, CfScriptFormat } from "../worker";
+import type { EsbuildBundle } from "./use-esbuild";
+
+export function Remote(props: {
+  name: string | undefined;
+  bundle: EsbuildBundle | undefined;
+  format: CfScriptFormat | undefined;
+  public: undefined | string;
+  assetPaths: undefined | AssetPaths;
+  port: number;
+  ip: string;
+  localProtocol: "https" | "http";
+  inspectorPort: number;
+  accountId: undefined | string;
+  apiToken: undefined | string;
+  bindings: CfWorkerInit["bindings"];
+  compatibilityDate: string | undefined;
+  compatibilityFlags: undefined | string[];
+  usageModel: undefined | "bundled" | "unbound";
+  env: string | undefined;
+  legacyEnv: boolean | undefined;
+  zone: { id: string; host: string } | undefined;
+}) {
+  assert(props.accountId, "accountId is required");
+  assert(props.apiToken, "apiToken is required");
+  const previewToken = useWorker({
+    name: props.name,
+    bundle: props.bundle,
+    format: props.format,
+    modules: props.bundle ? props.bundle.modules : [],
+    accountId: props.accountId,
+    apiToken: props.apiToken,
+    bindings: props.bindings,
+    assetPaths: props.assetPaths,
+    port: props.port,
+    compatibilityDate: props.compatibilityDate,
+    compatibilityFlags: props.compatibilityFlags,
+    usageModel: props.usageModel,
+    env: props.env,
+    legacyEnv: props.legacyEnv,
+    zone: props.zone,
+  });
+
+  usePreviewServer({
+    previewToken,
+    publicRoot: props.public,
+    localProtocol: props.localProtocol,
+    localPort: props.port,
+    ip: props.ip,
+  });
+
+  useInspector({
+    inspectorUrl: previewToken ? previewToken.inspectorUrl.href : undefined,
+    port: props.inspectorPort,
+    logToTerminal: true,
+  });
+  return null;
+}
+
+export function useWorker(props: {
+  name: string | undefined;
+  bundle: EsbuildBundle | undefined;
+  format: CfScriptFormat | undefined;
+  modules: CfModule[];
+  accountId: string;
+  apiToken: string;
+  bindings: CfWorkerInit["bindings"];
+  assetPaths: undefined | AssetPaths;
+  port: number;
+  compatibilityDate: string | undefined;
+  compatibilityFlags: string[] | undefined;
+  usageModel: undefined | "bundled" | "unbound";
+  env: string | undefined;
+  legacyEnv: boolean | undefined;
+  zone: { id: string; host: string } | undefined;
+}): CfPreviewToken | undefined {
+  const {
+    name,
+    bundle,
+    format,
+    modules,
+    accountId,
+    apiToken,
+    bindings,
+    assetPaths,
+    compatibilityDate,
+    compatibilityFlags,
+    usageModel,
+    port,
+  } = props;
+  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);
+
+  useEffect(() => {
+    async function start() {
+      setToken(undefined); // reset token in case we're re-running
+
+      if (!bundle || !format) return;
+
+      if (!startedRef.current) {
+        startedRef.current = true;
+      } else {
+        console.log("⎔ Detected changes, restarted server.");
+      }
+
+      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}` : ""),
+        assetPaths,
+        true
+      ); // TODO: cancellable?
+
+      const content = await readFile(bundle.path, "utf-8");
+
+      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,
+      };
+      setToken(
+        await createWorkerPreview(
+          init,
+          {
+            accountId,
+            apiToken,
+          },
+          { env: props.env, legacyEnv: props.legacyEnv, zone: props.zone }
+        )
+      );
+    }
+    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
+      console.error("remote worker:", err);
+    });
+  }, [
+    name,
+    bundle,
+    format,
+    accountId,
+    apiToken,
+    port,
+    assetPaths,
+    compatibilityDate,
+    compatibilityFlags,
+    usageModel,
+    bindings,
+    modules,
+    props.env,
+    props.legacyEnv,
+    props.zone,
+  ]);
+  return token;
+}

package/src/dev/use-esbuild.ts

@@ -0,0 +1,100 @@
+import assert from "node:assert";
+import { useState, useEffect } from "react";
+import { bundleWorker } from "../bundle";
+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[];
+  serveAssetsFromWorker: boolean;
+};
+
+export function useEsbuild({
+  entry,
+  destination,
+  staticRoot,
+  jsxFactory,
+  jsxFragment,
+  rules,
+  serveAssetsFromWorker,
+}: {
+  entry: Entry;
+  destination: string | undefined;
+  staticRoot: undefined | string;
+  jsxFactory: string | undefined;
+  jsxFragment: string | undefined;
+  rules: Config["rules"];
+  serveAssetsFromWorker: boolean;
+}): EsbuildBundle | undefined {
+  const [bundle, setBundle] = useState<EsbuildBundle>();
+  useEffect(() => {
+    let stopWatching: (() => void) | undefined = undefined;
+
+    const watchMode: WatchMode = {
+      async onRebuild(error) {
+        if (error) console.error("watch build failed:", error);
+        else {
+          // 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 };
+          });
+        }
+      },
+    };
+
+    async function build() {
+      if (!destination) return;
+
+      const { resolvedEntryPointPath, bundleType, modules, stop } =
+        await bundleWorker(entry, destination, {
+          // In dev, we serve assets from the local proxy before we send the request to the worker.
+          serveAssetsFromWorker: false,
+          jsxFactory,
+          jsxFragment,
+          rules,
+          watch: watchMode,
+        });
+
+      // Capture the `stop()` method to use as the `useEffect()` destructor.
+      stopWatching = stop;
+
+      setBundle({
+        id: 0,
+        entry,
+        path: resolvedEntryPointPath,
+        type: bundleType,
+        modules,
+        serveAssetsFromWorker,
+      });
+    }
+
+    build().catch(() => {
+      // esbuild already logs errors to stderr and we don't want to end the process
+      // on build errors anyway so this is a no-op error handler
+    });
+
+    return () => {
+      stopWatching?.();
+    };
+  }, [
+    entry,
+    destination,
+    staticRoot,
+    jsxFactory,
+    jsxFragment,
+    serveAssetsFromWorker,
+    rules,
+  ]);
+  return bundle;
+}

package/src/entry.ts

@@ -0,0 +1,159 @@
+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 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: string
+): 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
+  );
+  return { file, directory, format };
+}
+
+export async function runCustomBuild(
+  expectedEntry: 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}`
+      );
+    }
+  }
+}
+
+/**
+ * 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
+): Promise<CfScriptFormat> {
+  const result = await esbuild.build({
+    entryPoints: [entryFile],
+    absWorkingDir: entryWorkingDirectory,
+    metafile: true,
+    bundle: false,
+    format: "esm",
+    write: false,
+  });
+  // 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;
+}
+
+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;
+}