stream: add brotli support to CompressionStream and DecompressionStream

KhafraDev · richardlau · commit cf06e74076e1 · 2025-09-20T04:32:47.000Z
Refs: whatwg/compression#34 PR-URL: #59464 Reviewed-By: Mattias Buelens <mattias@buelens.com> Reviewed-By: Jason Zhang <xzha4350@gmail.com> Reviewed-By: Ethan Arrowood <ethan@arrowood.dev>
diff --git a/doc/api/globals.md b/doc/api/globals.md
@@ -319,6 +319,9 @@ added: v0.0.1
 <!-- YAML
 added: v18.0.0
 changes:
+ - version: REPLACEME
+   pr-url: https://github.com/nodejs/node/pull/59464
+   description: format now accepts `brotli` value.
  - version: v22.15.0
    pr-url: https://github.com/nodejs/node/pull/57510
    description: Marking the API stable.
@@ -427,6 +430,9 @@ A browser-compatible implementation of {CustomEvent}.
 <!-- YAML
 added: v18.0.0
 changes:
+ - version: REPLACEME
+   pr-url: https://github.com/nodejs/node/pull/59464
+   description: format now accepts `brotli` value.
  - version: v22.15.0
    pr-url: https://github.com/nodejs/node/pull/57510
    description: Marking the API stable.
diff --git a/doc/api/webstreams.md b/doc/api/webstreams.md
@@ -1478,14 +1478,17 @@ changes:
 <!-- YAML
 added: v17.0.0
 changes:
+  - version: REPLACEME
+    pr-url: https://github.com/nodejs/node/pull/59464
+    description: format now accepts `brotli` value.
   - version:
     - v21.2.0
     - v20.12.0
     pr-url: https://github.com/nodejs/node/pull/50097
     description: format now accepts `deflate-raw` value.
 -->
 
-* `format` {string} One of `'deflate'`, `'deflate-raw'`, or `'gzip'`.
+* `format` {string} One of `'deflate'`, `'deflate-raw'`, `'gzip'`, or `'brotli'`.
 
 #### `compressionStream.readable`
 
@@ -1518,14 +1521,17 @@ changes:
 <!-- YAML
 added: v17.0.0
 changes:
+  - version: REPLACEME
+    pr-url: https://github.com/nodejs/node/pull/59464
+    description: format now accepts `brotli` value.
   - version:
     - v21.2.0
     - v20.12.0
     pr-url: https://github.com/nodejs/node/pull/50097
     description: format now accepts `deflate-raw` value.
 -->
 
-* `format` {string} One of `'deflate'`, `'deflate-raw'`, or `'gzip'`.
+* `format` {string} One of `'deflate'`, `'deflate-raw'`, `'gzip'`, or `'brotli'`.
 
 #### `decompressionStream.readable`
 
diff --git a/lib/internal/webstreams/compression.js b/lib/internal/webstreams/compression.js
@@ -28,6 +28,7 @@ const formatConverter = createEnumConverter('CompressionFormat', [
   'deflate',
   'deflate-raw',
   'gzip',
+  'brotli',
 ]);
 
 /**
@@ -40,7 +41,7 @@ class CompressionStream {
   #transform;
 
   /**
-   * @param {'deflate'|'deflate-raw'|'gzip'} format
+   * @param {'deflate'|'deflate-raw'|'gzip'|'brotli'} format
    */
   constructor(format) {
     format = formatConverter(format, {
@@ -57,6 +58,9 @@ class CompressionStream {
       case 'gzip':
         this.#handle = lazyZlib().createGzip();
         break;
+      case 'brotli':
+        this.#handle = lazyZlib().createBrotliCompress();
+        break;
     }
     this.#transform = newReadableWritablePairFromDuplex(this.#handle);
   }
@@ -90,7 +94,7 @@ class DecompressionStream {
   #transform;
 
   /**
-   * @param {'deflate'|'deflate-raw'|'gzip'} format
+   * @param {'deflate'|'deflate-raw'|'gzip'|'brotli'} format
    */
   constructor(format) {
     format = formatConverter(format, {
@@ -111,6 +115,9 @@ class DecompressionStream {
           rejectGarbageAfterEnd: true,
         });
         break;
+      case 'brotli':
+        this.#handle = lazyZlib().createBrotliDecompress();
+        break;
     }
     this.#transform = newReadableWritablePairFromDuplex(this.#handle);
 
diff --git a/test/parallel/test-whatwg-webstreams-compression.js b/test/parallel/test-whatwg-webstreams-compression.js
@@ -41,7 +41,7 @@ async function test(format) {
   ]);
 }
 
-Promise.all(['gzip', 'deflate', 'deflate-raw'].map((i) => test(i))).then(common.mustCall());
+Promise.all(['gzip', 'deflate', 'deflate-raw', 'brotli'].map((i) => test(i))).then(common.mustCall());
 
 [1, 'hello', false, {}].forEach((i) => {
   assert.throws(() => new CompressionStream(i), {

Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@ async function test(format) {`
`41`	`41`	`]);`
`42`	`42`	`}`
`43`	`43`
`44`		`-Promise.all(['gzip', 'deflate', 'deflate-raw'].map((i) => test(i))).then(common.mustCall());`
	`44`	`+Promise.all(['gzip', 'deflate', 'deflate-raw', 'brotli'].map((i) => test(i))).then(common.mustCall());`
`45`	`45`
`46`	`46`	`[1, 'hello', false, {}].forEach((i) => {`
`47`	`47`	`assert.throws(() => new CompressionStream(i), {`