[wrangler] feat: add support for environments in getPlatformProxy (#…

…5604)

.changeset/wicked-donkeys-yell.md

@@ -0,0 +1,15 @@
+---
+"wrangler": minor
+---
+
+feat: add support for environments in `getPlatformProxy`
+
+allow `getPlatformProxy` to target environments by allowing users to specify an `environment` option
+
+Example usage:
+
+```js
+const { env } = await getPlatformProxy({
+	environment: "production",
+});
+```

fixtures/get-platform-proxy/.dev.vars.production

@@ -0,0 +1,3 @@
+MY_DEV_VAR = "my-PRODUCTION-dev-var-value"
+MY_VAR_A = "my-PRODUCTION-dev-var-a"
+MY_KV = "my-dev-kv-PRODUCTION"

fixtures/get-platform-proxy/tests/get-platform-proxy.env.test.ts

@@ -30,6 +30,7 @@ type Env = {
 	MY_SERVICE_B: Fetcher;
 	MY_RPC: Service;
 	MY_KV: KVNamespace;
+	MY_KV_PROD: KVNamespace;
 	MY_DO_A: DurableObjectNamespace;
 	MY_DO_B: DurableObjectNamespace;
 	MY_BUCKET: R2Bucket;
@@ -38,7 +39,7 @@ type Env = {
 
 const wranglerTomlFilePath = path.join(__dirname, "..", "wrangler.toml");
 
-describe("getPlatformProxy - bindings", () => {
+describe("getPlatformProxy - env", () => {
 	let devWorkers: UnstableDevWorker[];
 
 	beforeEach(() => {
@@ -265,6 +266,66 @@ describe("getPlatformProxy - bindings", () => {
 			await dispose();
 		}
 	});
+
+	describe("with a target environment", () => {
+		it("should provide bindings targeting a specified environment and also inherit top-level ones", async () => {
+			const { env, dispose } = await getPlatformProxy<Env>({
+				configPath: wranglerTomlFilePath,
+				environment: "production",
+			});
+			try {
+				expect(env.MY_VAR).not.toBe("my-var-value");
+				expect(env.MY_VAR).toBe("my-PRODUCTION-var-value");
+				expect(env.MY_JSON_VAR).toEqual({ test: true, production: true });
+
+				expect(env.MY_KV).toBeTruthy();
+				expect(env.MY_KV_PROD).toBeTruthy();
+			} finally {
+				await dispose();
+			}
+		});
+
+		it("should not provide bindings targeting an environment when none was specified", async () => {
+			const { env, dispose } = await getPlatformProxy<Env>({
+				configPath: wranglerTomlFilePath,
+			});
+			try {
+				expect(env.MY_VAR).not.toBe("my-PRODUCTION-var-value");
+				expect(env.MY_VAR).toBe("my-var-value");
+				expect(env.MY_JSON_VAR).toEqual({ test: true });
+
+				expect(env.MY_KV).toBeTruthy();
+				expect(env.MY_KV_PROD).toBeFalsy();
+			} finally {
+				await dispose();
+			}
+		});
+
+		it("should provide secrets targeting a specified environment", async () => {
+			const { env, dispose } = await getPlatformProxy<Env>({
+				configPath: wranglerTomlFilePath,
+				environment: "production",
+			});
+			try {
+				const { MY_DEV_VAR } = env;
+				expect(MY_DEV_VAR).not.toEqual("my-dev-var-value");
+				expect(MY_DEV_VAR).toEqual("my-PRODUCTION-dev-var-value");
+			} finally {
+				await dispose();
+			}
+		});
+
+		it("should error if a non-existent environment is provided", async () => {
+			await expect(
+				getPlatformProxy({
+					configPath: wranglerTomlFilePath,
+					environment: "non-existent-environment",
+				})
+			).rejects.toThrow(
+				/No environment found in configuration with name "non-existent-environment"/
+			);
+		});
+	});
 });
 
 /**

fixtures/get-platform-proxy/wrangler.toml

@@ -31,3 +31,9 @@ bindings = [
 binding = "MY_D1"
 database_name = "test-db"
 database_id = "000000000-0000-0000-0000-000000000000"
+
+[env.production]
+
+vars = { MY_VAR = "my-PRODUCTION-var-value", MY_JSON_VAR = { test = true, production = true } }
+
+kv_namespaces = [{ binding = "MY_KV_PROD", id = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"}]

packages/wrangler/src/api/integrations/platform/index.ts

@@ -20,6 +20,10 @@ import type { MiniflareOptions, ModuleRule, WorkerOptions } from "miniflare";
  * Options for the `getPlatformProxy` utility
  */
 export type GetPlatformProxyOptions = {
+	/**
+	 * The name of the environment to use
+	 */
+	environment?: string;
 	/**
 	 * The path to the config object to use (default `wrangler.toml`)
 	 */
@@ -82,13 +86,13 @@ export async function getPlatformProxy<
 >(
 	options: GetPlatformProxyOptions = {}
 ): Promise<PlatformProxy<Env, CfProperties>> {
+	const env = options.environment;
+
 	const rawConfig = readConfig(options.configPath, {
 		experimentalJsonConfig: options.experimentalJsonConfig,
+		env,
 	});
 
-	// getBindingsProxy doesn't currently support selecting an environment
-	const env = undefined;
-
 	const miniflareOptions = await getMiniflareOptionsFromConfig(
 		rawConfig,
 		env,

packages/wrangler/src/config/index.ts

@@ -24,28 +24,29 @@ export type {
 	ConfigModuleRuleType,
 } from "./environment";
 
+type ReadConfigCommandArgs<CommandArgs> = CommandArgs &
+	Pick<OnlyCamelCase<CommonYargsOptions>, "experimentalJsonConfig"> &
+	Partial<Pick<OnlyCamelCase<CommonYargsOptions>, "env">>;
+
 /**
  * Get the Wrangler configuration; read it from the give `configPath` if available.
  */
 export function readConfig<CommandArgs>(
 	configPath: string | undefined,
 	// Include command specific args as well as the wrangler global flags
-	args: CommandArgs &
-		Pick<OnlyCamelCase<CommonYargsOptions>, "experimentalJsonConfig">,
+	args: ReadConfigCommandArgs<CommandArgs>,
 	requirePagesConfig: true
 ): Omit<Config, "pages_build_output_dir"> & { pages_build_output_dir: string };
 export function readConfig<CommandArgs>(
 	configPath: string | undefined,
 	// Include command specific args as well as the wrangler global flags
-	args: CommandArgs &
-		Pick<OnlyCamelCase<CommonYargsOptions>, "experimentalJsonConfig">,
+	args: ReadConfigCommandArgs<CommandArgs>,
 	requirePagesConfig?: boolean
 ): Config;
 export function readConfig<CommandArgs>(
 	configPath: string | undefined,
 	// Include command specific args as well as the wrangler global flags
-	args: CommandArgs &
-		Pick<OnlyCamelCase<CommonYargsOptions>, "experimentalJsonConfig">,
+	args: ReadConfigCommandArgs<CommandArgs>,
 	requirePagesConfig?: boolean
 ): Config {
 	let rawConfig: RawConfig = {};