wrangler 0.0.0-e14e589 → 0.0.0-e1c615f

package/src/dev.tsx

@@ -1,15 +1,15 @@
 import esbuild from "esbuild";
-import httpProxy from "http-proxy";
 import { readFile } from "fs/promises";
+import { existsSync } from "fs";
 import type { DirectoryResult } from "tmp-promise";
 import tmp from "tmp-promise";
 import type { CfPreviewToken } from "./api/preview";
-import { Box, Text, useInput } from "ink";
+import { Box, Text, useApp, useInput } from "ink";
 import React, { useState, useEffect, useRef } from "react";
 import path from "path";
 import open from "open";
 import { DtInspector } from "./api/inspect";
-import type { CfModule, CfVariable } from "./api/worker";
+import type { CfModule } from "./api/worker";
 import { createWorker } from "./api/worker";
 import type { CfWorkerInit } from "./api/worker";
 import { spawn } from "child_process";
@@ -17,27 +17,41 @@ import onExit from "signal-exit";
 import { syncAssets } from "./sites";
 import clipboardy from "clipboardy";
 import http from "node:http";
-import serveStatic from "serve-static";
 import commandExists from "command-exists";
 import assert from "assert";
 import { getAPIToken } from "./user";
 import fetch from "node-fetch";
+import makeModuleCollector from "./module-collection";
+import { withErrorBoundary, useErrorHandler } from "react-error-boundary";
+import { createHttpProxy } from "./proxy";
+import { execa } from "execa";
+import { watch } from "chokidar";
 
 type CfScriptFormat = void | "modules" | "service-worker";
 
-type Props = {
+export type DevProps = {
   name?: string;
   entry: string;
   port?: number;
   format: CfScriptFormat;
   accountId: void | string;
   initialMode: "local" | "remote";
-  variables?: { [name: string]: CfVariable };
-  public?: void | string;
-  site?: void | string;
+  jsxFactory: void | string;
+  jsxFragment: void | string;
+  bindings: CfWorkerInit["bindings"];
+  public: void | string;
+  site: void | string;
+  compatibilityDate: void | string;
+  compatibilityFlags: void | string[];
+  usageModel: void | "bundled" | "unbound";
+  buildCommand: {
+    command?: undefined | string;
+    cwd?: undefined | string;
+    watch_dir?: undefined | string;
+  };
 };
 
-export function Dev(props: Props): JSX.Element {
+function Dev(props: DevProps): JSX.Element {
   if (props.public && props.format === "service-worker") {
     throw new Error(
       "You cannot use the service worker format with a `public` directory."
@@ -47,7 +61,18 @@ export function Dev(props: Props): JSX.Element {
   const apiToken = getAPIToken();
   const directory = useTmpDir();
 
-  const bundle = useEsbuild(props.entry, directory, props.public);
+  // if there isn't a build command, we just return the entry immediately
+  // ideally there would be a conditional here, but the rules of hooks
+  // kinda forbid that, so we thread the entry through useCustomBuild
+  const entry = useCustomBuild(props.entry, props.buildCommand);
+
+  const bundle = useEsbuild({
+    entry,
+    destination: directory,
+    staticRoot: props.public,
+    jsxFactory: props.jsxFactory,
+    jsxFragment: props.jsxFragment,
+  });
   if (bundle && bundle.type === "commonjs" && !props.format && props.public) {
     throw new Error(
       "You cannot use the service worker format with a `public` directory."
@@ -74,7 +99,7 @@ export function Dev(props: Props): JSX.Element {
           name={props.name}
           bundle={bundle}
           format={props.format}
-          variables={props.variables}
+          bindings={props.bindings}
           site={props.site}
           public={props.public}
           port={props.port}
@@ -86,10 +111,13 @@ export function Dev(props: Props): JSX.Element {
           format={props.format}
           accountId={props.accountId}
           apiToken={apiToken}
-          variables={props.variables}
+          bindings={props.bindings}
           site={props.site}
           public={props.public}
           port={props.port}
+          compatibilityDate={props.compatibilityDate}
+          compatibilityFlags={props.compatibilityFlags}
+          usageModel={props.usageModel}
         />
       )}
       <Box borderStyle="round" paddingLeft={1} paddingRight={1}>
@@ -144,7 +172,10 @@ function Remote(props: {
   port: number;
   accountId: void | string;
   apiToken: void | string;
-  variables: { [name: string]: CfVariable };
+  bindings: CfWorkerInit["bindings"];
+  compatibilityDate: string | void;
+  compatibilityFlags: void | string[];
+  usageModel: void | "bundled" | "unbound";
 }) {
   assert(props.accountId, "accountId is required");
   assert(props.apiToken, "apiToken is required");
@@ -152,12 +183,15 @@ function Remote(props: {
     name: props.name,
     bundle: props.bundle,
     format: props.format,
-    modules: [],
+    modules: props.bundle ? props.bundle.modules : [],
     accountId: props.accountId,
     apiToken: props.apiToken,
-    variables: props.variables,
+    bindings: props.bindings,
     sitesFolder: props.site,
     port: props.port,
+    compatibilityDate: props.compatibilityDate,
+    compatibilityFlags: props.compatibilityFlags,
+    usageModel: props.usageModel,
   });
 
   useProxy({ token, publicRoot: props.public, port: props.port });
@@ -169,7 +203,7 @@ function Local(props: {
   name: void | string;
   bundle: EsbuildBundle | void;
   format: CfScriptFormat;
-  variables: { [name: string]: CfVariable };
+  bindings: CfWorkerInit["bindings"];
   public: void | string;
   site: void | string;
   port: number;
@@ -178,7 +212,7 @@ function Local(props: {
     name: props.name,
     bundle: props.bundle,
     format: props.format,
-    variables: props.variables,
+    bindings: props.bindings,
     port: props.port,
   });
   useInspector(inspectorUrl);
@@ -189,11 +223,11 @@ function useLocalWorker(props: {
   name: void | string;
   bundle: EsbuildBundle | void;
   format: CfScriptFormat;
-  variables: { [name: string]: CfVariable };
+  bindings: CfWorkerInit["bindings"];
   port: number;
 }) {
   // TODO: pass vars via command line
-  const { bundle, format, variables, port } = props;
+  const { bundle, format, bindings, port } = props;
   const local = useRef<ReturnType<typeof spawn>>();
   const removeSignalExitListener = useRef<() => void>();
   const [inspectorUrl, setInspectorUrl] = useState<string | void>();
@@ -212,6 +246,7 @@ function useLocalWorker(props: {
       }
 
       console.log("⎔ Starting a local server...");
+      // TODO: just use execa for this
       local.current = spawn("node", [
         "--experimental-vm-modules",
         "--inspect",
@@ -228,18 +263,18 @@ function useLocalWorker(props: {
         port.toString(),
         "--kv-persist",
         "--cache-persist",
-        ...Object.entries(variables)
-          .map(([varKey, varVal]) => {
-            if (typeof varVal === "string") {
-              return `--binding ${varKey}=${varVal}`;
-            } else if (
-              "namespaceId" in varVal &&
-              typeof varVal.namespaceId === "string"
-            ) {
-              return `--kv ${varKey}`;
-            }
-          })
-          .filter(Boolean),
+        "--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}`];
+          }
+        ),
         "--modules",
         format ||
         (bundle.type === "esm" ? "modules" : "service-worker") === "modules"
@@ -254,29 +289,42 @@ function useLocalWorker(props: {
         }
       });
 
-      local.current.stdout.on("data", (data: string) => {
-        // console.log(`stdout: ${data}`);
+      local.current.stdout.on("data", (data: Buffer) => {
+        console.log(`${data.toString()}`);
       });
 
-      local.current.stderr.on("data", (data: string) => {
-        // console.error(`stderr: ${data}`);
+      local.current.stderr.on("data", (data: Buffer) => {
+        console.error(`${data.toString()}`);
         const matches =
           /Debugger listening on (ws:\/\/127\.0\.0\.1:9229\/[A-Za-z0-9-]+)/.exec(
-            data
+            data.toString()
           );
         if (matches) {
           setInspectorUrl(matches[1]);
         }
       });
 
-      removeSignalExitListener.current = onExit((code, signal) => {
+      local.current.on("exit", (code) => {
+        if (code !== 0) {
+          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();
+    startLocalWorker().catch((err) => {
+      console.error("local worker:", err);
+    });
 
     return () => {
       if (local.current) {
@@ -287,12 +335,20 @@ function useLocalWorker(props: {
         removeSignalExitListener.current = undefined;
       }
     };
-  }, [bundle, format, port]);
+  }, [
+    bundle,
+    format,
+    port,
+    bindings.durable_objects?.bindings,
+    bindings.kv_namespaces,
+    bindings.vars,
+  ]);
   return { inspectorUrl };
 }
 
 function useTmpDir(): string | void {
   const [directory, setDirectory] = useState<DirectoryResult>();
+  const handleError = useErrorHandler();
   useEffect(() => {
     let dir: DirectoryResult;
     async function create() {
@@ -302,36 +358,117 @@ function useTmpDir(): string | void {
         return;
       } catch (err) {
         console.error("failed to create tmp dir");
-        console.error(err);
         throw err;
       }
     }
-    create();
+    create().catch((err) => {
+      // we want to break here
+      // we can't do much without a temp dir anyway
+      handleError(err);
+    });
     return () => {
-      dir.cleanup();
+      dir.cleanup().catch(() => {
+        // extremely unlikely,
+        // but it's 2021 after all
+        console.error("failed to cleanup tmp dir");
+      });
     };
-  }, []);
+  }, [handleError]);
   return directory?.path;
 }
 
+function useCustomBuild(
+  expectedEntry: string,
+  props: {
+    command?: undefined | string;
+    cwd?: undefined | string;
+    watch_dir?: undefined | string;
+  }
+): void | string {
+  const [entry, setEntry] = useState<string | void>(
+    // if there's no build command, just return the expected entry
+    props.command ? null : expectedEntry
+  );
+  const { command, cwd, watch_dir } = props;
+  useEffect(() => {
+    if (!command) return;
+    let cmd, interval;
+    console.log("running:", command);
+    const commandPieces = command.split(" ");
+    cmd = execa(commandPieces[0], commandPieces.slice(1), {
+      ...(cwd && { cwd }),
+      stderr: "inherit",
+      stdout: "inherit",
+    });
+    if (watch_dir) {
+      watch(watch_dir, { persistent: true, ignoreInitial: true }).on(
+        "all",
+        (_event, _path) => {
+          console.log(`The file ${path} changed, restarting build...`);
+          cmd.kill();
+          cmd = execa(commandPieces[0], commandPieces.slice(1), {
+            ...(cwd && { cwd }),
+            stderr: "inherit",
+            stdout: "inherit",
+          });
+        }
+      );
+    }
+
+    // check every so often whether `expectedEntry` exists
+    // if it does, we're done
+    const startedAt = Date.now();
+    interval = setInterval(() => {
+      if (existsSync(expectedEntry)) {
+        clearInterval(interval);
+        setEntry(expectedEntry);
+      } else {
+        const elapsed = Date.now() - startedAt;
+        // timeout after 30 seconds of waiting
+        if (elapsed > 1000 * 60 * 30) {
+          console.error("⎔ Build timed out.");
+          clearInterval(interval);
+          cmd.kill();
+        }
+      }
+    }, 200);
+    // TODO: we could probably timeout here after a while
+
+    return () => {
+      if (cmd) {
+        cmd.kill();
+        cmd = undefined;
+      }
+      clearInterval(interval);
+      interval = undefined;
+    };
+  }, [command, cwd, expectedEntry, watch_dir]);
+  return entry;
+}
+
 type EsbuildBundle = {
   id: number;
   path: string;
   entry: string;
   type: "esm" | "commonjs";
   exports: string[];
+  modules: CfModule[];
 };
 
-function useEsbuild(
-  entry: string,
-  destination: string | void,
-  staticRoot: void | string
-): EsbuildBundle | void {
+function useEsbuild(props: {
+  entry: void | string;
+  destination: string | void;
+  staticRoot: void | string;
+  jsxFactory: string | void;
+  jsxFragment: string | void;
+}): EsbuildBundle | void {
+  const { entry, destination, staticRoot, jsxFactory, jsxFragment } = props;
   const [bundle, setBundle] = useState<EsbuildBundle>();
   useEffect(() => {
     let result: esbuild.BuildResult;
     async function build() {
-      if (!destination) return;
+      if (!destination || !entry) return;
+      const moduleCollector = makeModuleCollector();
       result = await esbuild.build({
         entryPoints: [entry],
         bundle: true,
@@ -339,7 +476,14 @@ function useEsbuild(
         metafile: true,
         format: "esm",
         sourcemap: true,
+        loader: {
+          ".js": "jsx",
+        },
+        ...(jsxFactory && { jsxFactory }),
+        ...(jsxFragment && { jsxFragment }),
         external: ["__STATIC_CONTENT_MANIFEST"],
+        conditions: ["worker", "browser"],
+        plugins: [moduleCollector.plugin],
         // TODO: import.meta.url
         watch: {
           async onRebuild(error) {
@@ -347,7 +491,10 @@ function useEsbuild(
             else {
               // nothing really changes here, so let's increment the id
               // to change the return object's identity
-              setBundle((bundle) => ({ ...bundle, id: bundle.id + 1 }));
+              setBundle((previousBundle) => ({
+                ...previousBundle,
+                id: previousBundle.id + 1,
+              }));
             }
           },
         },
@@ -363,13 +510,19 @@ function useEsbuild(
         path: chunks[0],
         type: chunks[1].exports.length > 0 ? "esm" : "commonjs",
         exports: chunks[1].exports,
+        modules: moduleCollector.modules,
       });
     }
-    build();
+    build().catch((_err) => {
+      // 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 () => {
       result?.stop();
     };
-  }, [entry, destination, staticRoot]);
+  }, [entry, destination, staticRoot, jsxFactory, jsxFragment]);
   return bundle;
 }
 
@@ -380,9 +533,12 @@ function useWorker(props: {
   modules: CfModule[];
   accountId: string;
   apiToken: string;
-  variables: { [name: string]: CfVariable };
+  bindings: CfWorkerInit["bindings"];
   sitesFolder: void | string;
   port: number;
+  compatibilityDate: string | void;
+  compatibilityFlags: string[] | void;
+  usageModel: void | "bundled" | "unbound";
 }): CfPreviewToken | void {
   const {
     name,
@@ -391,11 +547,20 @@ function useWorker(props: {
     modules,
     accountId,
     apiToken,
-    variables,
+    bindings,
     sitesFolder,
+    compatibilityDate,
+    compatibilityFlags,
+    usageModel,
     port,
   } = props;
   const [token, setToken] = useState<CfPreviewToken>();
+
+  // 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() {
       if (!bundle) return;
@@ -410,17 +575,17 @@ function useWorker(props: {
         return;
       }
 
-      if (token) {
-        console.log("⎔ Detected changes, restarting server...");
-      } else {
+      if (!startedRef.current) {
         console.log("⎔ Starting server...");
+        startedRef.current = true;
+      } else {
+        console.log("⎔ Detected changes, restarting server...");
       }
-      const scriptName = path.basename(bundle.path);
 
       const assets = sitesFolder
         ? await syncAssets(
             accountId,
-            scriptName,
+            path.basename(bundle.path),
             sitesFolder,
             true,
             undefined // TODO: env
@@ -432,28 +597,33 @@ function useWorker(props: {
 
       const content = await readFile(bundle.path, "utf-8");
       const init: CfWorkerInit = {
+        name,
         main: {
-          name: name || path.basename(bundle.path),
-          type:
-            format ||
-            (bundle.type === "esm" ? "modules" : "service-worker") === "modules"
-              ? "esm"
-              : "commonjs",
+          name: path.basename(bundle.path),
+          type: format || bundle.type === "esm" ? "esm" : "commonjs",
           content,
         },
-        modules: assets.manifest
-          ? modules.concat({
-              name: "__STATIC_CONTENT_MANIFEST",
-              content: JSON.stringify(assets.manifest),
-              type: "text",
-            })
-          : modules,
-        variables: assets.namespace
-          ? {
-              ...variables,
-              __STATIC_CONTENT: { namespaceId: assets.namespace },
-            }
-          : variables,
+        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 }
+              : []
+          ),
+        },
+        migrations: undefined, // no migrations in dev
+        compatibility_date: compatibilityDate,
+        compatibility_flags: compatibilityFlags,
+        usage_model: usageModel,
       };
       setToken(
         await createWorker(init, {
@@ -461,10 +631,26 @@ function useWorker(props: {
           apiToken,
         })
       );
-      console.log(`⬣ Listening at http://localhost:${port}`);
     }
-    start();
-  }, [name, bundle, format, accountId, apiToken, port, sitesFolder]);
+    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,
+    sitesFolder,
+    compatibilityDate,
+    compatibilityFlags,
+    usageModel,
+    bindings,
+    modules,
+  ]);
   return token;
 }
 
@@ -479,43 +665,53 @@ function useProxy({
 }) {
   useEffect(() => {
     if (!token) return;
-    const proxy = httpProxy.createProxyServer({
-      secure: false,
-      changeOrigin: true,
-      headers: {
-        "cf-workers-preview-token": token.value,
+    // TODO(soon): since headers are added in callbacks, the server
+    // does not need to restart when changes are made.
+    const host = token.host;
+    const proxy = createHttpProxy({
+      host,
+      assetPath: typeof publicRoot === "string" ? publicRoot : null,
+      onRequest: (headers) => {
+        headers["cf-workers-preview-token"] = token.value;
+      },
+      onResponse: (headers) => {
+        for (const [name, value] of Object.entries(headers)) {
+          // Rewrite the remote host to the local host.
+          if (typeof value === "string" && value.includes(host)) {
+            headers[name] = value
+              .replaceAll(`https://${host}`, `http://localhost:${port}`)
+              .replaceAll(host, `localhost:${port}`);
+          }
+        }
       },
-      target: `https://${token.host}`,
-      // TODO: log websockets too? validate durables, etc
     });
 
-    const servePublic =
-      publicRoot &&
-      serveStatic(publicRoot, {
-        cacheControl: false,
-      });
-    const server = http
-      .createServer((req, res) => {
-        if (publicRoot) {
-          servePublic(req, res, () => {
-            proxy.web(req, res);
-          });
-        } else {
-          proxy.web(req, res);
-        }
-      })
-      .listen(port); // TODO: custom port
+    console.log(`⬣ Listening at http://localhost:${port}`);
+
+    const server = proxy.listen(port);
 
-    proxy.on("proxyRes", function (proxyRes, req, res) {
+    // TODO(soon): refactor logging format into its own function
+    proxy.on("request", function (req, res) {
       // log all requests
       console.log(
         new Date().toLocaleTimeString(),
         req.method,
         req.url,
-        res.statusCode // TODO add a status message like Ok etc?
+        res.statusCode
+      );
+    });
+    proxy.on("upgrade", (req) => {
+      console.log(
+        new Date().toLocaleTimeString(),
+        req.method,
+        req.url,
+        101,
+        "(WebSocket)"
       );
     });
-    // TODO: log errors?
+    proxy.on("error", (err) => {
+      console.error(new Date().toLocaleTimeString(), err);
+    });
 
     return () => {
       proxy.close();
@@ -589,19 +785,21 @@ function useTunnel(toggle: boolean) {
           }
         });
 
-        removeSignalExitListener.current = onExit((code, signal) => {
+        removeSignalExitListener.current = onExit((_code, _signal) => {
           console.log("⎔ Shutting down local tunnel.");
           tunnel.current?.kill();
           tunnel.current = undefined;
         });
 
         const hostName = await findTunnelHostname();
-        clipboardy.write(hostName);
+        await clipboardy.write(hostName);
         console.log(`⬣ Sharing at ${hostName}, copied to clipboard.`);
       }
     }
 
-    startTunnel();
+    startTunnel().catch((err) => {
+      console.error("tunnel:", err);
+    });
 
     return () => {
       if (tunnel.current) {
@@ -623,38 +821,31 @@ function useHotkeys(initial: useHotkeysInitialState, port: number) {
   // UGH, we should put port in context instead
   const [toggles, setToggles] = useState(initial);
   useInput(
-    (
+    async (
       input,
       // eslint-disable-next-line @typescript-eslint/no-unused-vars
       key
     ) => {
       switch (input) {
         case "b": // open browser
-          open(
-            `http://localhost:${port}/`
-            // {
-            //   app: {
-            //     name: open.apps.chrome, // TODO: fallback on other browsers
-            //   },
-            // }
-          );
+          await open(`http://localhost:${port}/`);
           break;
         case "d": // toggle inspector
-          open(
+          await open(
             `https://built-devtools.pages.dev/js_app?experiments=true&v8only=true&ws=localhost:9229/ws`
-            // {
-            //   app: {
-            //     name: open.apps.chrome,
-            //     // todo - add firefox and edge fallbacks
-            //   },
-            // }
           );
           break;
         case "s": // toggle tunnel
-          setToggles((toggles) => ({ ...toggles, tunnel: !toggles.tunnel }));
+          setToggles((previousToggles) => ({
+            ...previousToggles,
+            tunnel: !previousToggles.tunnel,
+          }));
           break;
         case "l": // toggle local
-          setToggles((toggles) => ({ ...toggles, local: !toggles.local }));
+          setToggles((previousToggles) => ({
+            ...previousToggles,
+            local: !previousToggles.local,
+          }));
           break;
         case "q": // shut down
         case "x": // shut down
@@ -668,3 +859,16 @@ function useHotkeys(initial: useHotkeysInitialState, port: number) {
   );
   return toggles;
 }
+
+function ErrorFallback(props: { error: Error }) {
+  const { exit } = useApp();
+  useEffect(() => exit(new Error()));
+  return (
+    <>
+      <Text>Something went wrong:</Text>
+      <Text>{props.error.message}</Text>
+    </>
+  );
+}
+
+export default withErrorBoundary(Dev, { FallbackComponent: ErrorFallback });