Rename experimental_services to services`, closes #280

Author: mrbbot

packages/core/src/index.ts

@@ -153,7 +153,8 @@ function splitWranglerConfig<Plugins extends PluginSignatures>(
   plugins: PluginEntries<Plugins>,
   overrides: PluginOptions<Plugins>,
   config: WranglerConfig,
-  configDir: string
+  configDir: string,
+  log: Log
 ): PluginOptions<Plugins> {
   // Create a new options object so we don't override overrides with undefined,
   // causing future reloads to unset config defined in Wrangler
@@ -168,7 +169,11 @@ function splitWranglerConfig<Plugins extends PluginSignatures>(
       if (key in pluginOverrides) {
         (pluginResult as any)[key] = pluginOverrides[key];
       } else {
-        (pluginResult as any)[key] = meta.fromWrangler?.(config, configDir);
+        (pluginResult as any)[key] = meta.fromWrangler?.(
+          config,
+          configDir,
+          log
+        );
       }
     }
     result[name] = pluginResult;
@@ -351,7 +356,8 @@ export class MiniflareCore<
           this.#plugins,
           this.#overrides,
           config,
-          configDir
+          configDir,
+          this.#ctx.log
         );
       } catch (e: any) {
         // Ignore ENOENT (file not found) errors for default path

packages/core/src/plugins/bindings.ts

@@ -11,6 +11,7 @@ import {
   PluginContext,
   RequestContext,
   SetupResult,
+  WranglerServiceConfig,
   getRequestContext,
   viewToBuffer,
 } from "@miniflare/shared";
@@ -208,14 +209,21 @@ export class BindingsPlugin
           }
         })
       ),
-    fromWrangler: ({ experimental_services }) =>
-      experimental_services?.reduce(
-        (services, { name, service, environment }) => {
-          services[name] = { service, environment };
-          return services;
-        },
-        {} as ServiceBindingsOptions
-      ),
+    fromWrangler: ({ services, experimental_services }, configDir, log) => {
+      if (experimental_services) {
+        log.warn(
+          "Using `experimental_services` in `wrangler.toml` is deprecated. " +
+            "This key should be renamed to `services`."
+        );
+      }
+      const allServices: WranglerServiceConfig[] = [];
+      if (services) allServices.push(...services);
+      if (experimental_services) allServices.push(...experimental_services);
+      return allServices?.reduce((services, { name, service, environment }) => {
+        services[name] = { service, environment };
+        return services;
+      }, {} as ServiceBindingsOptions);
+    },
   })
   serviceBindings?: ServiceBindingsOptions;
 

packages/core/test/plugins/bindings.spec.ts

@@ -121,10 +121,13 @@ test("BindingsPlugin: parses options from wrangler config", async (t) => {
       DATA1: "data-blob-1.bin",
       DATA2: "data-blob-2.bin",
     },
-    experimental_services: [
+    services: [
       { name: "SERVICE1", service: "service1", environment: "development" },
       { name: "SERVICE2", service: "service2", environment: "production" },
     ],
+    experimental_services: [
+      { name: "SERVICE3", service: "service3", environment: "staging" },
+    ],
     miniflare: {
       globals: { KEY5: "value5", KEY6: false, KEY7: 10 },
       env_path: ".env.test",
@@ -139,6 +142,7 @@ test("BindingsPlugin: parses options from wrangler config", async (t) => {
     serviceBindings: {
       SERVICE1: { service: "service1", environment: "development" },
       SERVICE2: { service: "service2", environment: "production" },
+      SERVICE3: { service: "service3", environment: "staging" },
     },
   });
 

packages/shared-test/src/plugin.ts

@@ -4,6 +4,7 @@ import {
   Context,
   ExtractOptions,
   Mount,
+  NoOpLog,
   Option,
   OptionType,
   Plugin,
@@ -30,7 +31,11 @@ export function parsePluginWranglerConfig<Plugin extends PluginSignature>(
 ): ExtractOptions<InstanceType<Plugin>> {
   const result = {} as ExtractOptions<InstanceType<Plugin>>;
   for (const [key, meta] of plugin.prototype.opts?.entries() ?? []) {
-    (result as any)[key] = meta.fromWrangler?.(config, configDir);
+    (result as any)[key] = meta.fromWrangler?.(
+      config,
+      configDir,
+      new NoOpLog()
+    );
   }
   return result;
 }

packages/shared/src/plugin.ts

@@ -42,7 +42,8 @@ export interface OptionMetadataType<Type extends OptionType, Value> {
     : undefined;
   fromWrangler?: (
     config: WranglerConfig,
-    configDir: string
+    configDir: string,
+    log: Log
   ) => Value | undefined;
 }
 

packages/shared/src/wrangler.ts

@@ -3,6 +3,12 @@ import { ModuleRuleType } from "./runner";
 
 // See https://developers.cloudflare.com/workers/cli-wrangler/configuration#keys
 
+export interface WranglerServiceConfig {
+  name: string;
+  service: string;
+  environment: string;
+}
+
 export interface WranglerEnvironmentConfig {
   name?: string; // inherited
   zone_id?: string; // inherited
@@ -37,11 +43,9 @@ export interface WranglerEnvironmentConfig {
   wasm_modules?: Record<string, string>; // inherited
   text_blobs?: Record<string, string>; // inherited
   data_blobs?: Record<string, string>; // inherited
-  experimental_services?: {
-    name: string;
-    service: string;
-    environment: string;
-  }[]; // (probably) NOT inherited
+  services?: WranglerServiceConfig[]; // (probably) NOT inherited
+  /** @deprecated Use `services` instead */
+  experimental_services?: WranglerServiceConfig[]; // (probably) NOT inherited
   miniflare?: {
     globals?: Record<string, any>;
     upstream?: string;