zlib: Brotli reset() drops quality and dictionary
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 76/100
- Issue type
- Bug
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- cpp, javascript, node.js
Research direction
Start in src/node_zlib.cc at BrotliEncoderContext::ResetStream, BrotliDecoderContext::ResetStream, and Init(), then run the JavaScript reproduction from the issue. Verify that reset preserves Brotli quality parameters and dictionaries for compression and decompression, and add regression coverage showing the configured behavior remains after reset.
Written by the indexing model from the issue text.
Description
Version
v27.0.0-pre (built from main at a2a051cd42; src/node_zlib.cc is unchanged on current main)
Platform
Linux x86_64 (Ubuntu 22.04, built with clang 20)
Subsystem
zlib
What steps will reproduce the bug?
Create a Brotli compressor with a custom quality or a dictionary, call .reset() before writing anything, then compress as usual.
The quality/dictionary you passed in is gone. Nothing throws.
import * as zlib from 'node:zlib';
const input = Buffer.from('the quick brown fox jumps over the lazy dog '.repeat(100));
const dict = Buffer.from('the quick brown fox jumps over the lazy dog '.repeat(40));
function compress(options, reset) {
return new Promise((resolve, reject) => {
const s = zlib.createBrotliCompress(options);
const chunks = [];
s.on('data', (d) => chunks.push(d));
s.on('error', reject);
if (reset) s.reset();
s.end(input);
s.on('end', () => resolve(Buffer.concat(chunks).length));
});
}
const q0 = { params: { [zlib.constants.BROTLI_PARAM_QUALITY]: 0 } };
console.log('quality 0, no reset:', await compress(q0, false)); // 109
console.log('quality 0, then reset:', await compress(q0, true)); // 55 (same as default quality 11)
console.log('with dictionary, no reset:', await compress({ dictionary: dict }, false)); // 18
console.log('with dictionary, then reset:', await compress({ dictionary: dict }, true)); // 55 (same as no dictionary)
const compressed = zlib.brotliCompressSync(input, { dictionary: dict });
const dec = zlib.createBrotliDecompress({ dictionary: dict });
dec.reset();
dec.end(compressed);
dec.on('error', (err) => console.log('decompress after reset:', err.code));
// ERR__ERROR_FORMAT_DICTIONARY
How often does it reproduce? Is there a required condition?
Always. You do not need to write any data first. Just construct the stream with options and call reset().
What is the expected behavior? Why is that the expected behavior?
reset() should start a new Brotli session on the same stream, keeping the quality/params and dictionary you already set.
That is what the same API already documents for Zstd (zlib.reset(): "start a new session while preserving the configured parameters and dictionary"), and it is what test/parallel/test-zlib-zstd-reset.js asserts. Brotli goes through the same JS reset() method.
If the dictionary is dropped, a decoder cannot read a dictionary-compressed frame at all.
What do you see instead?
- Quality 0 after
reset()compresses as if you had used the default quality 11 (109 bytes become 55). - A dictionary after
reset()compresses as if you had used no dictionary (18 bytes become 55). createBrotliDecompress({ dictionary })thenreset()fails withERR__ERROR_FORMAT_DICTIONARYon a frame that was compressed with that dictionary.
The compressor never reports an error. The settings just disappear.
Additional information
C++: BrotliEncoderContext::ResetStream / BrotliDecoderContext::ResetStream both do return Init(); with no arguments. Init() immediately does dictionary_.clear() and creates a brand-new Brotli instance. It never replays SetParams.
This is not #66087 / #66088. Those are about flush() then reset() leaving a broken frame. Here there is no write at all — only the configuration is thrown away.
LLDB on src/node_zlib.cc at a2a051cd42 (same ResetStream/Init as current main):
- Stopped in
BrotliEncoderContext::ResetStreamat line 1514. Watch:this->dictionary_still has size 1760. Next statement isreturn Init();with no dictionary argument.
- That call lands in
Initat line 1474, ondictionary_.clear();. Watch: the memberthis->dictionary_is still 1760 (clear has not run yet), but thedictionaryparameter is already size 0, becauseResetStreamdid not pass it in.
- Continue to line 1483,
if (!dictionary.empty()). Watch: boththis->dictionary_and thedictionaryparameter are now size 0, so the attach-dictionary branch is skipped.
- Dominant language
- JavaScript
- Stars
- 122k
- Forks
- 37.4k
- Avg merge
- 4d 3h
- Merged PRs (30d)
- 272
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from nodejs/node
-
doc
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
-
build
Difficulty 1/5 Under an hour Newbie friendliness 88/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
-
Difficulty 1/5 Under an hour Newbie friendliness 90/100
-
feature request
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
Similar issues
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
avniproject/avni-client#2135 ·
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
babalae/bettergi-scripts-list#3674 ·
-
A-Release-Notes C-Editing D-Modest S-Ready-For-Implementation
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
bevyengine/bevy-website#2595 ·
-
ecosystem wording
Difficulty 1/5 Under an hour Newbie friendliness 90/100
matrix-org/matrix.org#3649 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
vadimdemedes/ink#1029 ·