zlib: Brotli reset() drops quality and dictionary
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 3/5
- Temps estimé
- 1-2 jours
- Accessibilité débutants
- 76/100
- Type d'issue
- Bug
- Clarté
- Clairement spécifiée
- Activité
- Active
- Stack technique
- cpp, javascript, node.js
Piste de recherche
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.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
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.
- Langage dominant
- JavaScript
- Étoiles
- 122k
- Forks
- 37.4k
- Merge moyen
- 4 j 3 h
- PR mergées (30 j)
- 272
Guide de contribution
Ouvrir le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de nodejs/node
-
doc
Difficulté 2/5 1-3 heures Accessibilité débutants 65/100
-
build
Difficulté 1/5 Moins d'une heure Accessibilité débutants 88/100
-
Difficulté 2/5 1-3 heures Accessibilité débutants 84/100
-
Difficulté 1/5 Moins d'une heure Accessibilité débutants 90/100
-
feature request
Difficulté 2/5 1-3 heures Accessibilité débutants 68/100
Toutes les issues de nodejs/node
Issues similaires
-
enhancement
Difficulté 2/5 1-3 heures Accessibilité débutants 70/100
babalae/bettergi-scripts-list#3674 ·
-
Difficulté 2/5 1-3 heures Accessibilité débutants 88/100
vadimdemedes/ink#1029 ·
-
code-quality refactoring
Difficulté 2/5 1-3 heures Accessibilité débutants 84/100
github/gh-aw-firewall#8816 ·
-
integration:quickjs org:external priority:backlog topic:code-interpreter topic:middleware type:feature
Difficulté 2/5 1-3 heures Accessibilité débutants 74/100
langchain-ai/deepagents#6450 ·
-
optimization optimization:agents-md-curator
Difficulté 2/5 1-3 heures Accessibilité débutants 86/100
githubnext/gh-aw-cao#13143 ·