Fix .env parsing of CRLF multi-line values

CHANGELOG.md

@@ -0,0 +1 @@
+- Fixed parsing of `.env` files with Windows (CRLF) line endings so carriage returns no longer leak into multi-line double-quoted values.

src/functions/env.spec.ts

@@ -40,6 +40,16 @@
 `,
         want: { FOO: "foo1\nfoo2", BAR: "bar" },
       },
+      {
+        description: "should normalize CRLF line endings (Windows)",
+        input: "FOO=foo\r\nBAR=bar\r\nBAZ=baz\r\n",
+        want: { FOO: "foo", BAR: "bar", BAZ: "baz" },
+      },
+      {
+        description: "should normalize CRLF inside double quoted, multi-line values (Windows)",
+        input: 'FOO="foo1\r\nfoo2\r\nfoo3"\r\nBAR=bar\r\n',
+        want: { FOO: "foo1\nfoo2\nfoo3", BAR: "bar" },
+      },
       {
         description: "should parse many double quoted values",
         input: 'FOO="foo"\nBAR="bar"',
@@ -495,7 +505,7 @@
           { FOO: "bar", lowercase: "bar" },
           { projectId: "project", functionsSource: tmpdir },
         );
       } catch (err: any) {
         // no-op
       }
       expect(env.loadUserEnvs({ projectId: "project", functionsSource: tmpdir })["FOO"]).to.be
@@ -565,7 +575,7 @@
 
     it("loads envs from .env.<alias> file", () => {
       createEnvFiles(tmpdir, {
         [`.env.${projectInfo.projectAlias}`]: "FOO=foo\nBAR=bar",
       });
 
       expect(env.loadUserEnvs({ ...projectInfo, functionsSource: tmpdir })).to.be.deep.equal({
@@ -603,7 +613,7 @@
     it("loads envs, preferring ones from .env.<alias>", () => {
       createEnvFiles(tmpdir, {
         ".env": "FOO=bad\nBAR=bar",
         [`.env.${projectInfo.projectAlias}`]: "FOO=good",
       });
 
       expect(env.loadUserEnvs({ ...projectInfo, functionsSource: tmpdir })).to.be.deep.equal({
@@ -615,7 +625,7 @@
     it("loads envs, preferring ones from .env.<alias> for emulators too", () => {
       createEnvFiles(tmpdir, {
         ".env": "FOO=bad\nBAR=bar",
         [`.env.${projectInfo.projectAlias}`]: "FOO=good",
       });
 
       expect(
@@ -658,7 +668,7 @@
       createEnvFiles(tmpdir, {
         ".env": "FOO=foo\nBAR=bar",
         [`.env.${projectInfo.projectId}`]: "FOO=not-foo",
         [`.env.${projectInfo.projectAlias}`]: "FOO=not-foo",
       });
 
       expect(() => {

src/functions/env.ts

@@ -110,7 +110,7 @@
  *   EFG
  *   -----BEGIN PUBLIC KEY-----"
  *
  * See test for more examples.
  *
  * @return {ParseResult} Result containing parsed key, value pairs and errored lines.
  */
@@ -118,7 +118,7 @@
   const envs: Record<string, string> = {};
   const errors: string[] = [];
 
-  data = data.replace(/\r\n?/, "\n"); // For Windows support.
+  data = data.replace(/\r\n?/g, "\n"); // For Windows support.
   let match;
   while ((match = LINE_RE.exec(data))) {
     let [, k, v] = match;
@@ -201,8 +201,8 @@
   for (const key of Object.keys(envs)) {
     try {
       validateKey(key);
     } catch (err: any) {
       logger.debug(`Failed to validate key ${key}: ${err}`);
       if (err instanceof KeyValidationError) {
         validationErrors.push(err);
       } else {
@@ -248,7 +248,7 @@
 }
 
 /**
  * Checks if user has specified any environment variables for their functions.
  *
  * @return True if there are any user-specified environment variables
  */
@@ -263,7 +263,7 @@
  * Identifies one and only one dotenv file to touch using the same rules as loadUserEnvs().
  * It is an error to provide a key-value pair which is already in the file.
  */
 export function writeUserEnvs(toWrite: Record<string, string>, envOpts: UserEnvsOpts) {
   if (Object.keys(toWrite).length === 0) {
     return;
   }