Next

CHANGELOG.md

@@ -0,0 +1 @@
+- Fixed an issue in the extensions emulator where parameter default values would not be substitued into resource definitions.

src/deploy/functions/release/index.ts

@@ -106,7 +106,7 @@
 
   await setupArtifactCleanupPolicies(
     options,
     options.projectId!,
     Object.keys(wantBackend.endpoints),
   );
 
@@ -198,8 +198,8 @@
     );
     throw new FirebaseError(
       `Functions successfully deployed but could not set up cleanup policy in ` +
-        `${locationsWithErrors.length > 1 ? "regions" : "region"} ${locationsWithErrors.join(", ")}.` +
-        `Pass the --force option to automatically set up a cleanup policy or` +
+        `${locationsWithErrors.length > 1 ? "regions" : "region"} ${locationsWithErrors.join(", ")}. ` +
+        `Pass the --force option to automatically set up a cleanup policy or ` +
         "run 'firebase functions:artifacts:setpolicy' to set up a cleanup policy to automatically delete old images.",
     );
   }

src/emulator/extensionsEmulator.ts

@@ -21,6 +21,7 @@
 import { EmulatorInfo, EmulatorInstance, Emulators } from "./types";
 import { Build } from "../deploy/functions/build";
 import { extractExtensionsFromBuilds } from "../extensions/runtimes/common";
+import { populateDefaultParams } from "../extensions/paramHelper";
 
 export interface ExtensionEmulatorArgs {
   options: Options;
@@ -267,7 +268,8 @@
     // TODO: This should find package.json, then use that as functionsDir.
     const functionsDir = path.join(extensionDir, "functions");
     // TODO(b/213335255): For local extensions, this should include extensionSpec instead of extensionVersion
-    const env = Object.assign(this.autoPopulatedParams(instance), instance.params);
+    const params = populateDefaultParams(instance.params, await planner.getExtensionSpec(instance));
+    const env = Object.assign(this.autoPopulatedParams(instance), params);
 
     const { extensionTriggers, runtime, nonSecretEnv, secretEnvVariables } =
       await getExtensionFunctionInfo(instance, env);
@@ -369,7 +371,7 @@
         )} triggered functions, and the ${unemulatedServices.join(
           ", ",
         )} emulator does not exist or is not running.`;
         this.logger.logLabeled("WARN", `extensions[${backend.extensionInstanceId}]`, msg);
       }
       return unemulatedServices.length === 0;
     });

src/extensions/paramHelper.ts

@@ -26,7 +26,7 @@
   // Add project specific key:value here when we want to support that.
 }
 
 export function getBaseParamBindings(params: { [key: string]: ParamBindingOptions }): {
   [key: string]: string;
 } {
   let ret = {};
@@ -39,7 +39,7 @@
   return ret;
 }
 
 export function buildBindingOptionsWithBaseValue(baseParams: { [key: string]: string }): {
   [key: string]: ParamBindingOptions;
 } {
   let paramOptions: { [key: string]: ParamBindingOptions } = {};
@@ -54,7 +54,7 @@
 
 /**
  * A mutator to switch the defaults for a list of params to new ones.
  * For convenience, this also returns the params
  *
  * @param params A list of params
  * @param newDefaults a map of { PARAM_NAME: default_value }
@@ -75,7 +75,7 @@
 
 /**
  * Gets params from the user
  * or prompting the user for each param.
  * @param projectId the id of the project in use
  * @param paramSpecs a list of params, ie. extensionSpec.params
  * @param envFilePath a path to an env file containing param values
@@ -225,3 +225,16 @@
   const regex = /^firebaseextensions\.[a-zA-Z0-9\.]*\//;
   return regex.test(paramName);
 }
+
+// Populate default values for missing params.
+// This is only needed when emulating extensions - when deploying, this is handled in the back end.
+export function populateDefaultParams(
+  params: Record<string, string>,
+  spec: ExtensionSpec,
+): Record<string, string> {
+  const ret = { ...params };
+  for (const p of spec.params) {
+    ret[p.param] = ret[p.param] ?? p.default;
+  }
+  return ret;
+}

src/responseToError.ts

@@ -6,7 +6,6 @@ export function responseToError(response: any, body: any, url?: string): Firebas
   if (response.statusCode < 400) {
     return;
   }
-
   if (typeof body === "string") {
     if (response.statusCode === 404) {
       body = {