Load project-specific environment variables in the Functions Emulator

CHANGELOG.md

@@ -1,3 +1,4 @@
 - Fixes bug where functions' memory configurations weren't preserved in batched function deploys (#4253).
 - `ext:export` now uses stable ordering for params in .env files (#4256).
 - Adds alerting event provider (#4258).
+- Fixes bug where project-specific environment variables weren't loaded by the Functions Emulator (#4273).

src/emulator/controller.ts

@@ -512,6 +512,7 @@ export async function startAll(options: EmulatorOptions, showUI: boolean = true)
       host: functionsAddr.host,
       port: functionsAddr.port,
       debugPort: inspectFunctions,
+      projectAlias: options.projectAlias,
     });
     await startEmulator(functionsEmulator);
   }

src/emulator/functionsEmulator.ts

@@ -119,6 +119,7 @@ export interface FunctionsEmulatorArgs {
   debugPort?: number;
   remoteEmulators?: { [key: string]: EmulatorInfo };
   adminSdkConfig?: AdminSdkConfig;
+  projectAlias?: string;
 }
 
 // FunctionsRuntimeInstance is the handler for a running function invocation
@@ -944,6 +945,7 @@ export class FunctionsEmulator implements EmulatorInstance {
     const projectInfo = {
       functionsSource: backend.functionsDir,
       projectId: this.args.projectId,
+      projectAlias: this.args.projectAlias,
       isEmulator: true,
     };
 

src/functions/env.ts

@@ -196,13 +196,12 @@ function findEnvfiles(
   isEmulator?: boolean
 ): string[] {
   const files: string[] = [".env"];
+  files.push(`.env.${projectId}`);
+  if (projectAlias) {
+    files.push(`.env.${projectAlias}`);
+  }
   if (isEmulator) {
     files.push(FUNCTIONS_EMULATOR_DOTENV);
-  } else {
-    files.push(`.env.${projectId}`);
-    if (projectAlias && projectAlias.length) {
-      files.push(`.env.${projectAlias}`);
-    }
   }
 
   return files

src/serve/functions.ts

@@ -46,6 +46,7 @@ export class FunctionsServer {
       projectId,
       projectDir: options.config.projectDir,
       emulatableBackends: [this.backend],
+      projectAlias: options.projectAlias,
       account,
       ...partialArgs,
     };

src/test/functions/env.spec.ts

@@ -328,6 +328,20 @@ FOO=foo
       });
     });
 
+    it("loads envs, preferring ones from .env.<project> for emulators too", () => {
+      createEnvFiles(tmpdir, {
+        ".env": "FOO=bad\nBAR=bar",
+        [`.env.${projectInfo.projectId}`]: "FOO=good",
+      });
+
+      expect(
+        env.loadUserEnvs({ ...projectInfo, functionsSource: tmpdir, isEmulator: true })
+      ).to.be.deep.equal({
+        FOO: "good",
+        BAR: "bar",
+      });
+    });
+
     it("loads envs, preferring ones from .env.<alias>", () => {
       createEnvFiles(tmpdir, {
         ".env": "FOO=bad\nBAR=bar",
@@ -340,6 +354,48 @@ FOO=foo
       });
     });
 
+    it("loads envs, preferring ones from .env.<alias> for emulators too", () => {
+      createEnvFiles(tmpdir, {
+        ".env": "FOO=bad\nBAR=bar",
+        [`.env.${projectInfo.projectAlias}`]: "FOO=good",
+      });
+
+      expect(
+        env.loadUserEnvs({ ...projectInfo, functionsSource: tmpdir, isEmulator: true })
+      ).to.be.deep.equal({
+        FOO: "good",
+        BAR: "bar",
+      });
+    });
+
+    it("loads envs ignoring .env.local", () => {
+      createEnvFiles(tmpdir, {
+        ".env": "FOO=bad\nBAR=bar",
+        [`.env.${projectInfo.projectId}`]: "FOO=good",
+        ".env.local": "FOO=bad",
+      });
+
+      expect(env.loadUserEnvs({ ...projectInfo, functionsSource: tmpdir })).to.be.deep.equal({
+        FOO: "good",
+        BAR: "bar",
+      });
+    });
+
+    it("loads envs, preferring .env.local for the emulator", () => {
+      createEnvFiles(tmpdir, {
+        ".env": "FOO=bad\nBAR=bar",
+        [`.env.${projectInfo.projectId}`]: "FOO=another bad",
+        ".env.local": "FOO=good",
+      });
+
+      expect(
+        env.loadUserEnvs({ ...projectInfo, functionsSource: tmpdir, isEmulator: true })
+      ).to.be.deep.equal({
+        FOO: "good",
+        BAR: "bar",
+      });
+    });
+
     it("throws an error if both .env.<project> and .env.<alias> exists", () => {
       createEnvFiles(tmpdir, {
         ".env": "FOO=foo\nBAR=bar",