Fix issue where emulator throws an error due to non-standard whitespa…

…ces in filenames (#7308)

* Fix issue where emulator throws an error due to non-standard whitespace in filenames.

* Fix tests

* Added changelog entry

CHANGELOG.md

@@ -0,0 +1 @@
+- Fixes issue where storage emulator throws an error due to non-standard whitespaces in filenames (#6834).

scripts/storage-emulator-integration/conformance/firebase-js-sdk.test.ts

@@ -474,7 +474,7 @@ describe("Firebase Storage JavaScript SDK conformance tests", () => {
  TEST_ENV.requestClient.get(downloadUrl, (response) => {
  let data = Buffer.alloc(0);
  expect(response.headers["content-disposition"]).to.be.eql(
- "attachment; filename=testFile",
+ "attachment; filename*=testFile",
  );
  response
  .on("data", (chunk) => {

scripts/storage-emulator-integration/conformance/gcs.endpoints.test.ts

@@ -99,7 +99,7 @@ describe("GCS endpoint conformance tests", () => {
  .then((res) => res);
 
  expect(res.header["content-type"]).to.be.eql("application/octet-stream");
- expect(res.header["content-disposition"]).to.be.eql("attachment; filename=testFile");
+ expect(res.header["content-disposition"]).to.be.eql("attachment; filename*=testFile");
  });
  });
 

src/emulator/storage/apis/shared.ts

@@ -2,6 +2,7 @@ import { gunzipSync } from "zlib";
 import { StoredFileMetadata } from "../metadata";
 import { Request, Response } from "express";
 import { crc32cToString } from "../crc";
+import { encodeRFC5987 } from "../rfc";
 
 /** Populates an object media GET Express response. */
 export function sendFileBytes(
@@ -26,7 +27,7 @@ export function sendFileBytes(
  const fileName = md.name.split("/").pop();
  res.setHeader(
  "Content-Disposition",
- `${md.contentDisposition || "attachment"}; filename=${fileName}`,
+ `${md.contentDisposition || "attachment"}; filename*=${encodeRFC5987(fileName!)}`,
  );
  if (didGunzip) {
  // Set to mirror server behavior and supress express's "content-length" header.

src/emulator/storage/rfc.ts

@@ -0,0 +1,12 @@
+/**
+ * Adapted from:
+ * - https://datatracker.ietf.org/doc/html/rfc5987
+ * - https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/encodeURIComponent#examples
+ *
+ * @returns RFC5987 encoded string
+ */
+export function encodeRFC5987(str: string): string {
+ return encodeURIComponent(str)
+ .replace(/['()*]/g, (c) => `%${c.charCodeAt(0).toString(16).toUpperCase()}`)
+ .replace(/%(7C|60|5E)/g, (str, hex) => String.fromCharCode(parseInt(hex, 16)));
+}