Add --root option for resolving default configs

Also combine `log` and `compat` into `PluginContext` passed to plugins

Author: mrbbot

packages/cache/src/plugin.ts

@@ -1,10 +1,10 @@
 import {
-  Compatibility,
   Log,
   MiniflareError,
   Option,
   OptionType,
   Plugin,
+  PluginContext,
   SetupResult,
   StorageFactory,
 } from "@miniflare/shared";
@@ -123,17 +123,17 @@ export class CachePlugin extends Plugin<CacheOptions> implements CacheOptions {
 
   #caches?: CacheStorage;
 
-  constructor(log: Log, compat: Compatibility, options?: CacheOptions) {
-    super(log, compat);
+  constructor(ctx: PluginContext, options?: CacheOptions) {
+    super(ctx);
     this.assignOptions(options);
   }
 
   setup(storageFactory: StorageFactory): SetupResult {
     this.#caches = new CacheStorage(
       this,
-      this.log,
+      this.ctx.log,
       storageFactory,
-      this.compat.isEnabled("formdata_parser_supports_files")
+      this.ctx.compat.isEnabled("formdata_parser_supports_files")
     );
     return { globals: { caches: this.#caches } };
   }

packages/cache/test/plugin.spec.ts

@@ -10,6 +10,7 @@ import {
   Compatibility,
   LogLevel,
   NoOpLog,
+  PluginContext,
   StoredValueMeta,
 } from "@miniflare/shared";
 import {
@@ -27,6 +28,8 @@ import { testResponse } from "./helpers";
 
 const log = new NoOpLog();
 const compat = new Compatibility();
+const rootPath = process.cwd();
+const ctx: PluginContext = { log, compat, rootPath };
 
 test("CacheStorage: provides default cache", async (t) => {
   const factory = new MemoryStorageFactory();
@@ -137,11 +140,10 @@ test("CachePlugin: logs options", (t) => {
 });
 
 test("CachePlugin: setup: includes CacheStorage in globals", async (t) => {
-  const log = new NoOpLog();
   const map = new Map<string, StoredValueMeta<CachedMeta>>();
   const factory = new MemoryStorageFactory({ ["map:default"]: map });
 
-  let plugin = new CachePlugin(log, compat, { cachePersist: "map" });
+  let plugin = new CachePlugin(ctx, { cachePersist: "map" });
   let result = plugin.setup(factory);
   let caches = result.globals?.caches;
   t.true(caches instanceof CacheStorage);
@@ -150,7 +152,7 @@ test("CachePlugin: setup: includes CacheStorage in globals", async (t) => {
   await caches.default.put("http://localhost:8787/", testResponse());
   t.true(map.has("http://localhost:8787/"));
 
-  plugin = new CachePlugin(log, compat, { cache: false });
+  plugin = new CachePlugin(ctx, { cache: false });
   result = plugin.setup(factory);
   caches = result.globals?.caches;
   t.true(caches instanceof CacheStorage);
@@ -163,7 +165,7 @@ test("CachePlugin: setup: Responses parse files in FormData as File objects only
   const formData = new FormData();
   formData.append("file", new File(["test"], "test.txt"));
 
-  let plugin = new CachePlugin(log, new Compatibility());
+  let plugin = new CachePlugin(ctx);
   let caches: CacheStorage = plugin.setup(factory).globals?.caches;
   await caches.default.put("http://localhost", testResponse(formData));
   let cache = await caches.open("test");
@@ -177,7 +179,7 @@ test("CachePlugin: setup: Responses parse files in FormData as File objects only
   const compat = new Compatibility(undefined, [
     "formdata_parser_supports_files",
   ]);
-  plugin = new CachePlugin(log, compat);
+  plugin = new CachePlugin({ log, compat, rootPath });
   caches = plugin.setup(factory).globals?.caches;
   cache = await caches.open("test");
 

packages/cli-parser/test/help.spec.ts

@@ -32,6 +32,8 @@ test("buildHelp: generates correctly formatted help text", (t) => {
 Core Options:
  -h, --help                  Show help                                 [boolean]
  -v, --version               Show version number                       [boolean]
+     --root                  Path to resolve default config files       [string]
+                             relative to
  -c, --wrangler-config       Path to wrangler.toml                      [string]
      --wrangler-env          Environment in wrangler.toml to use        [string]
      --package               Path to package.json                       [string]

packages/core/src/index.ts

@@ -8,6 +8,7 @@ import {
   Log,
   Mutex,
   Options,
+  PluginContext,
   PluginEntries,
   PluginOptions,
   PluginOptionsUnion,
@@ -182,7 +183,6 @@ export interface MiniflareCoreContext {
   scriptRunner?: ScriptRunner;
   scriptRequired?: boolean;
   scriptRunForModuleExports?: boolean;
-  defaultConfigPath?: string;
 }
 
 export class ReloadEvent<Plugins extends PluginSignatures> extends Event {
@@ -209,9 +209,9 @@ export class MiniflareCore<
   readonly #scriptRunner?: ScriptRunner;
   readonly #scriptRequired?: boolean;
   readonly #scriptRunForModuleExports?: boolean;
-  readonly #defaultConfigPath: string;
 
   #compat?: Compatibility;
+  #previousRootPath?: string;
   #instances?: PluginInstances<Plugins>;
 
   #wranglerConfigPath?: string;
@@ -243,7 +243,6 @@ export class MiniflareCore<
     this.#scriptRunner = ctx.scriptRunner;
     this.#scriptRequired = ctx.scriptRequired;
     this.#scriptRunForModuleExports = ctx.scriptRunForModuleExports;
-    this.#defaultConfigPath = ctx.defaultConfigPath ?? "wrangler.toml";
 
     this.#initPromise = this.#init().then(() => this.#reload());
   }
@@ -288,12 +287,14 @@ export class MiniflareCore<
     const previous = this.#previousOptions;
     let options = this.#overrides;
 
+    const rootPath = options.CorePlugin.rootPath ?? process.cwd();
+
     // Merge in wrangler config if defined
     const originalConfigPath = options.CorePlugin.wranglerConfigPath;
     const configEnv = options.CorePlugin.wranglerConfigEnv;
     let configPath =
       originalConfigPath === true
-        ? this.#defaultConfigPath
+        ? path.join(rootPath, "wrangler.toml")
         : originalConfigPath;
     if (configPath) {
       configPath = path.resolve(configPath);
@@ -330,14 +331,23 @@ export class MiniflareCore<
     this.#watching ??= options.CorePlugin.watch ?? false;
 
     // Build compatibility manager, rebuild all plugins if compatibility data
-    // has changed
+    // or root path has changed
     const { compatibilityDate, compatibilityFlags } = options.CorePlugin;
-    let compatUpdate = false;
+    let ctxUpdate =
+      this.#previousRootPath && this.#previousRootPath !== rootPath;
+    this.#previousRootPath = rootPath;
     if (this.#compat) {
-      compatUpdate = this.#compat.update(compatibilityDate, compatibilityFlags);
+      if (this.#compat.update(compatibilityDate, compatibilityFlags)) {
+        ctxUpdate = true;
+      }
     } else {
       this.#compat = new Compatibility(compatibilityDate, compatibilityFlags);
     }
+    const ctx: PluginContext = {
+      log: this.log,
+      compat: this.#compat,
+      rootPath,
+    };
 
     // Create plugin instances and run beforeSetup hooks, recreating any plugins
     // with changed options
@@ -347,7 +357,7 @@ export class MiniflareCore<
     for (const [name, plugin] of this.#plugins) {
       if (
         previous !== undefined &&
-        !compatUpdate &&
+        !ctxUpdate &&
         _deepEqual(previous[name], options[name])
       ) {
         continue;
@@ -360,7 +370,7 @@ export class MiniflareCore<
         await existingInstance.dispose();
       }
 
-      const instance = new plugin(this.log, this.#compat, options[name]);
+      const instance = new plugin(ctx, options[name]);
       this.#instances[name] = instance as any;
       if (await this.#runBeforeSetup(name)) ranBeforeSetup = true;
     }
@@ -371,7 +381,7 @@ export class MiniflareCore<
     for (const [name] of this.#plugins) {
       if (
         previous !== undefined &&
-        !compatUpdate &&
+        !ctxUpdate &&
         _deepEqual(previous[name], options[name]) &&
         // Make sure if we ran any beforeSetups and this plugin previously
         // returned scripts, that we rerun its setup

packages/core/src/plugins/bindings.ts

@@ -1,12 +1,11 @@
 import fs from "fs/promises";
 import path from "path";
 import {
-  Compatibility,
   Context,
-  Log,
   Option,
   OptionType,
   Plugin,
+  PluginContext,
   SetupResult,
 } from "@miniflare/shared";
 import dotenv from "dotenv";
@@ -80,13 +79,8 @@ export class BindingsPlugin
   })
   wasmBindings?: Record<string, string>;
 
-  constructor(
-    log: Log,
-    compat: Compatibility,
-    options?: BindingsOptions,
-    private readonly defaultEnvPath: string = ".env"
-  ) {
-    super(log, compat);
+  constructor(ctx: PluginContext, options?: BindingsOptions) {
+    super(ctx);
     this.assignOptions(options);
   }
 
@@ -104,7 +98,10 @@ export class BindingsPlugin
     Object.assign(bindings, this[kWranglerBindings]);
 
     // Load bindings from .env file
-    const envPath = this.envPath === true ? this.defaultEnvPath : this.envPath;
+    const envPath =
+      this.envPath === true
+        ? path.join(this.ctx.rootPath, ".env")
+        : this.envPath;
     if (envPath) {
       try {
         Object.assign(

packages/core/src/plugins/build.ts

@@ -5,12 +5,11 @@ import { fileURLToPath } from "url";
 import {
   Awaitable,
   BeforeSetupResult,
-  Compatibility,
-  Log,
   MiniflareError,
   Option,
   OptionType,
   Plugin,
+  PluginContext,
   WranglerConfig,
 } from "@miniflare/shared";
 
@@ -48,8 +47,8 @@ export class BuildPlugin extends Plugin<BuildOptions> implements BuildOptions {
   })
   buildWatchPaths?: string[];
 
-  constructor(log: Log, compat: Compatibility, options?: BuildOptions) {
-    super(log, compat);
+  constructor(ctx: PluginContext, options?: BuildOptions) {
+    super(ctx);
     this.assignOptions(options);
   }
 
@@ -75,7 +74,7 @@ export class BuildPlugin extends Plugin<BuildOptions> implements BuildOptions {
           return reject(error);
         }
 
-        this.log.info("Build succeeded");
+        this.ctx.log.info("Build succeeded");
         resolve({ watch: this.buildWatchPaths });
       });
     });

packages/core/src/plugins/core.ts

@@ -19,15 +19,14 @@ import {
 import { URL, URLSearchParams } from "url";
 import { TextEncoder } from "util";
 import {
-  Compatibility,
   CompatibilityFlag,
   Context,
-  Log,
   ModuleRule,
   ModuleRuleType,
   Option,
   OptionType,
   Plugin,
+  PluginContext,
   ProcessedModuleRule,
   STRING_SCRIPT_PATH,
   SetupResult,
@@ -68,6 +67,7 @@ function proxyStringFormDataFiles<
 export interface CoreOptions {
   script?: string;
   scriptPath?: string;
+  rootPath?: string;
   packagePath?: boolean | string;
   wranglerConfigPath?: boolean | string;
   wranglerConfigEnv?: string;
@@ -102,6 +102,13 @@ export class CorePlugin extends Plugin<CoreOptions> implements CoreOptions {
   })
   scriptPath?: string;
 
+  @Option({
+    type: OptionType.STRING,
+    name: "root",
+    description: "Path to resolve default config files relative to",
+  })
+  rootPath?: string;
+
   @Option({
     type: OptionType.STRING,
     name: "wrangler-config",
@@ -225,19 +232,16 @@ export class CorePlugin extends Plugin<CoreOptions> implements CoreOptions {
 
   readonly #globals: Context;
 
-  constructor(
-    log: Log,
-    compat: Compatibility,
-    options?: CoreOptions,
-    private readonly defaultPackagePath = "package.json"
-  ) {
-    super(log, compat);
+  constructor(ctx: PluginContext, options?: CoreOptions) {
+    super(ctx);
     this.assignOptions(options);
 
     // Make sure the kFormDataFiles flag is set correctly when constructing
     let CompatRequest = Request;
     let CompatResponse = Response;
-    const formDataFiles = compat.isEnabled("formdata_parser_supports_files");
+    const formDataFiles = ctx.compat.isEnabled(
+      "formdata_parser_supports_files"
+    );
     if (!formDataFiles) {
       CompatRequest = proxyStringFormDataFiles(CompatRequest);
       CompatResponse = proxyStringFormDataFiles(CompatResponse);
@@ -261,7 +265,7 @@ export class CorePlugin extends Plugin<CoreOptions> implements CoreOptions {
       TextDecoder,
       TextEncoder,
 
-      fetch: createCompatFetch(compat),
+      fetch: createCompatFetch(ctx.compat),
       Headers,
       Request: CompatRequest,
       Response: CompatResponse,
@@ -363,7 +367,9 @@ export class CorePlugin extends Plugin<CoreOptions> implements CoreOptions {
     // from package.json
     if (scriptPath === undefined) {
       const packagePath =
-        this.packagePath === true ? this.defaultPackagePath : this.packagePath;
+        this.packagePath === true
+          ? path.join(this.ctx.rootPath, "package.json")
+          : this.packagePath;
       if (packagePath) {
         try {
           const pkg = JSON.parse(await fs.readFile(packagePath, "utf8"));