stream: add brotli support to CompressionStream and DecompressionStream · nodejs/node@8dc6f5b · GitHub

nodejs / node Public

• Notifications You must be signed in to change notification settings
• Fork 36.6k
• Star 120k

• Code
• Issues 633
• Pull requests 748
• Actions
• Projects
• Security and quality
• Insights

Additional navigation options

Commit 8dc6f5b

Browse filesBrowse the repository at this point in the historyBrowse files

KhafraDev

authored and

targos

committed

stream: add brotli support to CompressionStream and DecompressionStream

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>

1 parent ed33958 commit 8dc6f5b
Copy full SHA for 8dc6f5b

4 files changed

+24-5Lines changed: 24 additions & 5 deletions

File tree

Expand file treeCollapse file tree

Open diff view settings

Filter options

• doc/api
  • globals.md
  • webstreams.md
• lib/internal/webstreams
  • compression.js
• test/parallel
  • test-whatwg-webstreams-compression.js

Expand file treeCollapse file tree

Open diff view settings

Collapse file

‎doc/api/globals.md‎

Copy file name to clipboardExpand all lines: doc/api/globals.md

+6Lines changed: 6 additions & 0 deletions

• Display the source diff
• Display the rich diff

Original file line number	Diff line number	Diff line change
@@ -330,6 +330,9 @@ with the [`--no-experimental-websocket`][] CLI flag.
330	330	<!-- YAML
331	331	added: v18.0.0
332	332	changes:
	333	+ - version: REPLACEME
	334	+ pr-url: https://github.com/nodejs/node/pull/59464
	335	+ description: format now accepts `brotli` value.
333	336	- version:
334	337	- v23.11.0
335	338	- v22.15.0
@@ -445,6 +448,9 @@ A browser-compatible implementation of {CustomEvent}.
445	448	<!-- YAML
446	449	added: v18.0.0
447	450	changes:
	451	+ - version: REPLACEME
	452	+ pr-url: https://github.com/nodejs/node/pull/59464
	453	+ description: format now accepts `brotli` value.
448	454	- version:
449	455	- v23.11.0
450	456	- v22.15.0

Collapse file

‎doc/api/webstreams.md‎

Copy file name to clipboardExpand all lines: doc/api/webstreams.md

+8-2Lines changed: 8 additions & 2 deletions

• Display the source diff
• Display the rich diff

Original file line number	Diff line number	Diff line change
@@ -1480,14 +1480,17 @@ changes:
1480	1480	<!-- YAML
1481	1481	added: v17.0.0
1482	1482	changes:
	1483	+ - version: REPLACEME
	1484	+ pr-url: https://github.com/nodejs/node/pull/59464
	1485	+ description: format now accepts `brotli` value.
1483	1486	- version:
1484	1487	- v21.2.0
1485	1488	- v20.12.0
1486	1489	pr-url: https://github.com/nodejs/node/pull/50097
1487	1490	description: format now accepts `deflate-raw` value.
1488	1491	-->
1489	1492
1490		- * `format` {string} One of `'deflate'`, `'deflate-raw'`, or `'gzip'`.
	1493	+ * `format` {string} One of `'deflate'`, `'deflate-raw'`, `'gzip'`, or `'brotli'`.
1491	1494
1492	1495	#### `compressionStream.readable`
1493	1496
@@ -1520,14 +1523,17 @@ changes:
1520	1523	<!-- YAML
1521	1524	added: v17.0.0
1522	1525	changes:
	1526	+ - version: REPLACEME
	1527	+ pr-url: https://github.com/nodejs/node/pull/59464
	1528	+ description: format now accepts `brotli` value.
1523	1529	- version:
1524	1530	- v21.2.0
1525	1531	- v20.12.0
1526	1532	pr-url: https://github.com/nodejs/node/pull/50097
1527	1533	description: format now accepts `deflate-raw` value.
1528	1534	-->
1529	1535
1530		- * `format` {string} One of `'deflate'`, `'deflate-raw'`, or `'gzip'`.
	1536	+ * `format` {string} One of `'deflate'`, `'deflate-raw'`, `'gzip'`, or `'brotli'`.
1531	1537
1532	1538	#### `decompressionStream.readable`
1533	1539

Collapse file

‎lib/internal/webstreams/compression.js‎

Copy file name to clipboardExpand all lines: lib/internal/webstreams/compression.js

+9-2Lines changed: 9 additions & 2 deletions

Original file line number	Diff line number	Diff line change
@@ -28,6 +28,7 @@ const formatConverter = createEnumConverter('CompressionFormat', [
28	28	'deflate',
29	29	'deflate-raw',
30	30	'gzip',
	31	+ 'brotli',
31	32	]);
32	33
33	34	/**
@@ -40,7 +41,7 @@ class CompressionStream {
40	41	#transform;
41	42
42	43	/**
43		- * @param {'deflate'|'deflate-raw'|'gzip'} format
	44	+ * @param {'deflate'|'deflate-raw'|'gzip'|'brotli'} format
44	45	*/
45	46	constructor(format) {
46	47	format = formatConverter(format, {
@@ -57,6 +58,9 @@ class CompressionStream {
57	58	case 'gzip':
58	59	this.#handle = lazyZlib().createGzip();
59	60	break;
	61	+ case 'brotli':
	62	+ this.#handle = lazyZlib().createBrotliCompress();
	63	+ break;
60	64	}
61	65	this.#transform = newReadableWritablePairFromDuplex(this.#handle);
62	66	}
@@ -90,7 +94,7 @@ class DecompressionStream {
90	94	#transform;
91	95
92	96	/**
93		- * @param {'deflate'|'deflate-raw'|'gzip'} format
	97	+ * @param {'deflate'|'deflate-raw'|'gzip'|'brotli'} format
94	98	*/
95	99	constructor(format) {
96	100	format = formatConverter(format, {
@@ -111,6 +115,9 @@ class DecompressionStream {
111	115	rejectGarbageAfterEnd: true,
112	116	});
113	117	break;
	118	+ case 'brotli':
	119	+ this.#handle = lazyZlib().createBrotliDecompress();
	120	+ break;
114	121	}
115	122	this.#transform = newReadableWritablePairFromDuplex(this.#handle);
116	123

Collapse file

‎test/parallel/test-whatwg-webstreams-compression.js‎

Copy file name to clipboardExpand all lines: test/parallel/test-whatwg-webstreams-compression.js

+1-1Lines changed: 1 addition & 1 deletion

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), {

0 commit comments

Comments

0 (0)