wrangler 0.0.0-e2a26a0 → 0.0.0-e3cab74

package/src/inspect.ts

@@ -367,7 +367,10 @@ export default function useInspector(props: InspectorProps) {
         );
         remoteWebSocket.send(event.data);
       } catch (e) {
-        if (e.message !== "WebSocket is not open: readyState 0 (CONNECTING)") {
+        if (
+          (e as Error).message !==
+          "WebSocket is not open: readyState 0 (CONNECTING)"
+        ) {
           /**
            * ^ this just means we haven't opened a websocket yet
            * usually happens until there's at least one request
@@ -587,8 +590,18 @@ function logConsoleMessage(evt: Protocol.Runtime.ConsoleAPICalledEvent): void {
   const method = mapConsoleAPIMessageTypeToConsoleMethod[evt.type];
 
   if (method in console) {
-    // eslint-disable-next-line prefer-spread
-    console[method].apply(console, args);
+    switch (method) {
+      case "dir":
+        console.dir(args);
+        break;
+      case "table":
+        console.table(args);
+        break;
+      default:
+        // eslint-disable-next-line prefer-spread
+        console[method].apply(console, args);
+        break;
+    }
   } else {
     console.warn(`Unsupported console method: ${method}`);
     console.log("console event:", evt);

package/src/kv.tsx

@@ -1,13 +1,12 @@
 import { URLSearchParams } from "node:url";
 import { fetchListResult, fetchResult, fetchKVGetValue } from "./cfetch";
-import type { Config } from "./config";
+import type { Config, Environment } from "./config";
 
 type KvArgs = {
   binding?: string;
   "namespace-id"?: string;
   env?: string;
   preview?: boolean;
-  config?: Config;
 };
 
 /**
@@ -153,13 +152,10 @@ export async function deleteBulkKeyValue(
   );
 }
 
-export function getNamespaceId({
-  preview,
-  binding,
-  config,
-  "namespace-id": namespaceId,
-  env,
-}: KvArgs): string {
+export function getNamespaceId(
+  { preview, binding, "namespace-id": namespaceId, env }: KvArgs,
+  configOrEnv: Config | Environment | undefined
+): string {
   // nice
   if (namespaceId) {
     return namespaceId;
@@ -167,13 +163,13 @@ export function getNamespaceId({
 
   // begin pre-flight checks
 
-  // `--binding` is only valid if there's a wrangler configuration file.
-  if (binding && !config) {
+  // `--binding` is only valid if there's a wrangler configuration.
+  if (binding && !configOrEnv) {
     throw new Error("--binding specified, but no config file was found.");
   }
 
   // there's no config. abort here
-  if (!config) {
+  if (!configOrEnv) {
     throw new Error(
       "Failed to find a config file.\n" +
         "Either use --namespace-id to upload directly or create a configuration file with a binding."
@@ -182,36 +178,31 @@ export function getNamespaceId({
 
   // they want to use an environment, actually
   if (env) {
-    if (!config.env || !config.env[env]) {
+    if (!("env" in configOrEnv) || !configOrEnv.env[env]) {
       throw new Error(
         `Failed to find environment "${env}" in configuration file!`
       );
     }
-
-    // TODO: either a bespoke arg type for this function to avoid `undefined`s or an `EnvOrConfig` type
-    return getNamespaceId({
-      binding,
-      "namespace-id": namespaceId,
-      env: undefined,
-      preview,
-      config: {
-        env: undefined,
-        build: undefined,
-        name: undefined,
-        account_id: undefined,
-        ...config.env[env],
+    return getNamespaceId(
+      {
+        binding,
+        "namespace-id": namespaceId,
+        preview,
       },
-    });
+      configOrEnv.env[env]
+    );
   }
 
   // there's no KV namespaces
-  if (!config.kv_namespaces || config.kv_namespaces.length === 0) {
+  if (!configOrEnv.kv_namespaces || configOrEnv.kv_namespaces.length === 0) {
     throw new Error(
       "No KV Namespaces configured! Either use --namespace-id to upload directly or add a KV namespace to your wrangler config file."
     );
   }
 
-  const namespace = config.kv_namespaces.find((ns) => ns.binding === binding);
+  const namespace = configOrEnv.kv_namespaces.find(
+    (ns) => ns.binding === binding
+  );
 
   // we couldn't find a namespace with that binding
   if (!namespace) {

package/src/module-collection.ts

@@ -1,21 +1,86 @@
 import crypto from "node:crypto";
 import { readFile } from "node:fs/promises";
 import path from "node:path";
-import type { CfModule } from "./api/worker";
+import globToRegExp from "glob-to-regexp";
+import type { CfModule, CfModuleType, CfScriptFormat } from "./api/worker";
+import type { Config, ConfigModuleRuleType } from "./config";
 import type esbuild from "esbuild";
 
+const RuleTypeToModuleType: Record<ConfigModuleRuleType, CfModuleType> = {
+  ESModule: "esm",
+  CommonJS: "commonjs",
+  CompiledWasm: "compiled-wasm",
+  Data: "buffer",
+  Text: "text",
+};
+
 // This is a combination of an esbuild plugin and a mutable array
 // that we use to collect module references from source code.
 // There will be modules that _shouldn't_ be inlined directly into
 // the bundle. (eg. wasm modules, some text files, etc). We can include
-// those files as modules in the multi part forker form upload. This
+// those files as modules in the multi part worker form upload. This
 // plugin+array is used to collect references to these modules, reference
 // them correctly in the bundle, and add them to the form upload.
 
-export default function makeModuleCollector(): {
+export const DEFAULT_MODULE_RULES: Config["rules"] = [
+  { type: "Text", globs: ["**/*.txt", "**/*.html"] },
+  { type: "Data", globs: ["**/*.bin"] },
+  { type: "CompiledWasm", globs: ["**/*.wasm"] },
+];
+
+export default function makeModuleCollector(props: {
+  format: CfScriptFormat;
+  rules?: Config["rules"];
+}): {
   modules: CfModule[];
   plugin: esbuild.Plugin;
 } {
+  const rules: Config["rules"] = [
+    ...(props.rules || []),
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+    ...DEFAULT_MODULE_RULES!,
+  ];
+
+  const completedRuleLocations: Record<string, number> = {};
+  let index = 0;
+  const rulesToRemove: Config["rules"] = [];
+  for (const rule of rules) {
+    if (rule.type in completedRuleLocations) {
+      if (rules[completedRuleLocations[rule.type]].fallthrough !== false) {
+        if (index < (props.rules || []).length) {
+          console.warn(
+            `The module rule at position ${index} (${JSON.stringify(
+              rule
+            )}) has the same type as a previous rule (at position ${
+              completedRuleLocations[rule.type]
+            }, ${JSON.stringify(
+              rules[completedRuleLocations[rule.type]]
+            )}). This rule will be ignored. To the previous rule, add \`fallthrough = true\` to allow this one to also be used, or \`fallthrough = false\` to silence this warning.`
+          );
+        } else {
+          console.warn(
+            `The default module rule ${JSON.stringify(
+              rule
+            )} has the same type as a previous rule (at position ${
+              completedRuleLocations[rule.type]
+            }, ${JSON.stringify(
+              rules[completedRuleLocations[rule.type]]
+            )}). This rule will be ignored. To the previous rule, add \`fallthrough = true\` to allow the default one to also be used, or \`fallthrough = false\` to silence this warning.`
+          );
+        }
+      }
+
+      rulesToRemove.push(rule);
+    }
+    if (!(rule.type in completedRuleLocations) && rule.fallthrough !== true) {
+      completedRuleLocations[rule.type] = index;
+    }
+    index++;
+  }
+
+  // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+  rulesToRemove.forEach((rule) => rules!.splice(rules!.indexOf(rule), 1));
+
   const modules: CfModule[] = [];
   return {
     modules,
@@ -23,40 +88,82 @@ export default function makeModuleCollector(): {
       name: "wrangler-module-collector",
       setup(build) {
         build.onStart(() => {
-          // reset the moduels collection
+          // reset the module collection array
           modules.splice(0);
         });
 
-        build.onResolve(
-          // filter on "known" file types,
-          // we can expand this list later
-          { filter: /.*\.(wasm)$/ },
-          async (args: esbuild.OnResolveArgs) => {
-            // take the file and massage it to a
-            // transportable/manageable format
-            const filePath = path.join(args.resolveDir, args.path);
-            const fileContent = await readFile(filePath);
-            const fileHash = crypto
-              .createHash("sha1")
-              .update(fileContent)
-              .digest("hex");
-            const fileName = `${fileHash}-${path.basename(args.path)}`;
-
-            // add the module to the array
-            modules.push({
-              name: fileName,
-              content: fileContent,
-              type: "compiled-wasm",
-            });
-
-            return {
-              path: fileName, // change the reference to the changed module
-              external: true, // mark it as external in the bundle
-              namespace: "wrangler-module-collector-ns", // just a tag, this isn't strictly necessary
-              watchFiles: [filePath], // we also add the file to esbuild's watch list
-            };
-          }
-        );
+        rules?.forEach((rule) => {
+          if (rule.type === "ESModule" || rule.type === "CommonJS") return; // TODO: we should treat these as js files, and use the jsx loader
+
+          rule.globs.forEach((glob) => {
+            build.onResolve(
+              { filter: globToRegExp(glob) },
+              async (args: esbuild.OnResolveArgs) => {
+                // take the file and massage it to a
+                // transportable/manageable format
+
+                const filePath = path.join(args.resolveDir, args.path);
+                const fileContent = await readFile(filePath);
+                const fileHash = crypto
+                  .createHash("sha1")
+                  .update(fileContent)
+                  .digest("hex");
+                const fileName = `./${fileHash}-${path.basename(args.path)}`;
+
+                // add the module to the array
+                modules.push({
+                  name: fileName,
+                  content: fileContent,
+                  type: RuleTypeToModuleType[rule.type],
+                });
+
+                return {
+                  path: fileName, // change the reference to the changed module
+                  external: props.format === "modules", // mark it as external in the bundle
+                  namespace: `wrangler-module-${rule.type}`, // just a tag, this isn't strictly necessary
+                  watchFiles: [filePath], // we also add the file to esbuild's watch list
+                };
+              }
+            );
+
+            if (props.format === "service-worker") {
+              build.onLoad(
+                { filter: globToRegExp(glob) },
+                async (args: esbuild.OnLoadArgs) => {
+                  return {
+                    // We replace the the module with an identifier
+                    // that we'll separately add to the form upload
+                    // as part of [wasm_modules]/[text_blobs]. This identifier has to be a valid
+                    // JS identifier, so we replace all non alphanumeric characters
+                    // with an underscore.
+                    // TODO: what of "Data"?
+                    contents: `export default ${args.path.replace(
+                      /[^a-zA-Z0-9_$]/g,
+                      "_"
+                    )};`,
+                  };
+                }
+              );
+            }
+          });
+        });
+
+        rulesToRemove.forEach((rule) => {
+          rule.globs.forEach((glob) => {
+            build.onResolve(
+              { filter: globToRegExp(glob) },
+              async (args: esbuild.OnResolveArgs) => {
+                throw new Error(
+                  `The file ${
+                    args.path
+                  } matched a module rule in your configuration (${JSON.stringify(
+                    rule
+                  )}), but was ignored because a previous rule with the same type was not marked as \`fallthrough = true\`.`
+                );
+              }
+            );
+          });
+        });
       },
     },
   };

package/src/open-in-browser.ts

@@ -0,0 +1,13 @@
+import open from "open";
+/**
+ * An extremely simple wrapper around the open command.
+ * Specifically, it adds an 'error' event handler so that when this function
+ * is called in environments where we can't open the browser (e.g. github codespaces,
+ * stackblitz, remote servers), it doesn't just crash the process.
+ */
+export default async function openInBrowser(url: string): Promise<void> {
+  const childProcess = await open(url);
+  childProcess.on("error", () => {
+    console.warn(`Failed to open ${url} in a browser`);
+  });
+}

package/src/package-manager.ts

@@ -3,49 +3,51 @@ import { join } from "node:path";
 import { execa, execaCommandSync } from "execa";
 
 export interface PackageManager {
+  cwd: string;
+  type: "npm" | "yarn";
   addDevDeps(...packages: string[]): Promise<void>;
   install(): Promise<void>;
 }
 
-export async function getPackageManager(root: string): Promise<PackageManager> {
+export async function getPackageManager(cwd: string): Promise<PackageManager> {
   const [hasYarn, hasNpm] = await Promise.all([supportsYarn(), supportsNpm()]);
-  const hasYarnLock = existsSync(join(root, "yarn.lock"));
-  const hasNpmLock = existsSync(join(root, "package-lock.json"));
+  const hasYarnLock = existsSync(join(cwd, "yarn.lock"));
+  const hasNpmLock = existsSync(join(cwd, "package-lock.json"));
 
   if (hasNpmLock) {
     if (hasNpm) {
       console.log(
         "Using npm as package manager, as there is already a package-lock.json file."
       );
-      return NpmPackageManager;
+      return { ...NpmPackageManager, cwd };
     } else if (hasYarn) {
       console.log("Using yarn as package manager.");
       console.warn(
         "There is already a package-lock.json file but could not find npm on the PATH."
       );
-      return YarnPackageManager;
+      return { ...YarnPackageManager, cwd };
     }
   } else if (hasYarnLock) {
     if (hasYarn) {
       console.log(
         "Using yarn as package manager, as there is already a yarn.lock file."
       );
-      return YarnPackageManager;
+      return { ...YarnPackageManager, cwd };
     } else if (hasNpm) {
       console.log("Using npm as package manager.");
       console.warn(
         "There is already a yarn.lock file but could not find yarn on the PATH."
       );
-      return NpmPackageManager;
+      return { ...NpmPackageManager, cwd };
     }
   }
 
   if (hasNpm) {
     console.log("Using npm as package manager.");
-    return NpmPackageManager;
+    return { ...NpmPackageManager, cwd };
   } else if (hasYarn) {
     console.log("Using yarn as package manager.");
-    return YarnPackageManager;
+    return { ...YarnPackageManager, cwd };
   } else {
     throw new Error(
       "Unable to find a package manager. Supported managers are: npm and yarn."
@@ -56,22 +58,21 @@ export async function getPackageManager(root: string): Promise<PackageManager> {
 /**
  * Get the name of the given `packageManager`.
  */
-export function getPackageManagerName(packageManager: unknown): string {
-  return packageManager === NpmPackageManager
-    ? "npm"
-    : packageManager === YarnPackageManager
-    ? "yarn"
-    : "unknown";
+export function getPackageManagerName(packageManager: PackageManager): string {
+  return packageManager.type ?? "unknown";
 }
 
 /**
  * Manage packages using npm
  */
 const NpmPackageManager: PackageManager = {
+  cwd: process.cwd(),
+  type: "npm",
   /** Add and install a new devDependency into the local package.json. */
   async addDevDeps(...packages: string[]): Promise<void> {
     await execa("npm", ["install", ...packages, "--save-dev"], {
       stdio: "inherit",
+      cwd: this.cwd,
     });
   },
 
@@ -79,6 +80,7 @@ const NpmPackageManager: PackageManager = {
   async install(): Promise<void> {
     await execa("npm", ["install"], {
       stdio: "inherit",
+      cwd: this.cwd,
     });
   },
 };
@@ -87,10 +89,13 @@ const NpmPackageManager: PackageManager = {
  * Manage packages using yarn
  */
 const YarnPackageManager: PackageManager = {
+  cwd: process.cwd(),
+  type: "yarn",
   /** Add and install a new devDependency into the local package.json. */
   async addDevDeps(...packages: string[]): Promise<void> {
     await execa("yarn", ["add", ...packages, "--dev"], {
       stdio: "inherit",
+      cwd: this.cwd,
     });
   },
 
@@ -98,6 +103,7 @@ const YarnPackageManager: PackageManager = {
   async install(): Promise<void> {
     await execa("yarn", ["install"], {
       stdio: "inherit",
+      cwd: this.cwd,
     });
   },
 };

package/src/pages.tsx

@@ -7,10 +7,10 @@ import { join } from "node:path";
 import { URL } from "node:url";
 import { watch } from "chokidar";
 import { getType } from "mime";
-import open from "open";
 import { buildWorker } from "../pages/functions/buildWorker";
 import { generateConfigFromFileTree } from "../pages/functions/filepath-routing";
 import { writeRoutesModule } from "../pages/functions/routes";
+import openInBrowser from "./open-in-browser";
 import { toUrlPath } from "./paths";
 import type { Config } from "../pages/functions/routes";
 import type { Headers, Request, fetch } from "@miniflare/core";
@@ -771,7 +771,7 @@ export const pages: BuilderCallback<unknown, unknown> = (yargs) => {
         kv: kvs = [],
         do: durableObjects = [],
         "live-reload": liveReload,
-        "--": remaining = [],
+        _: [_pages, _dev, ...remaining],
       }) => {
         if (!local) {
           console.error("Only local mode is supported at the moment.");
@@ -795,8 +795,8 @@ export const pages: BuilderCallback<unknown, unknown> = (yargs) => {
 
         let miniflareArgs: MiniflareOptions = {};
 
-        let scriptReadyResolve;
-        const scriptReadyPromise = new Promise(
+        let scriptReadyResolve: () => void;
+        const scriptReadyPromise = new Promise<void>(
           (resolve) => (scriptReadyResolve = resolve)
         );
 
@@ -830,7 +830,8 @@ export const pages: BuilderCallback<unknown, unknown> = (yargs) => {
             scriptPath,
           };
         } else {
-          scriptReadyResolve();
+          // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+          scriptReadyResolve!();
 
           const scriptPath =
             directory !== undefined
@@ -900,7 +901,7 @@ export const pages: BuilderCallback<unknown, unknown> = (yargs) => {
 
           // env.ASSETS.fetch
           serviceBindings: {
-            async ASSETS(request) {
+            async ASSETS(request: Request) {
               if (proxyPort) {
                 try {
                   const url = new URL(request.url);
@@ -945,9 +946,7 @@ export const pages: BuilderCallback<unknown, unknown> = (yargs) => {
           console.log(`Serving at http://localhost:${port}/`);
 
           if (process.env.BROWSER !== "none") {
-            const childProcess = await open(`http://localhost:${port}/`);
-            // fail silently if the open command doesn't work (e.g. in GitHub Codespaces)
-            childProcess.on("error", (_err) => {});
+            await openInBrowser(`http://localhost:${port}/`);
           }
 
           if (directory !== undefined && liveReload) {
@@ -964,7 +963,7 @@ export const pages: BuilderCallback<unknown, unknown> = (yargs) => {
             miniflare.dispose().catch((err) => miniflare.log.error(err));
           });
         } catch (e) {
-          miniflare.log.error(e);
+          miniflare.log.error(e as Error);
           EXIT("Could not start Miniflare.", 1);
         }
       }