Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

http.compressionThreshold: docs say default 1200, shipped config sets 0 (compression off by default)

Abierto
#656 1 comentario 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
38/100
Tipo de issue
Documentación
Claridad
Bastante claro
Estado de actividad
Activo
Stack tecnológico
typescript

Línea de trabajo

Comienza revisando las cuatro ubicaciones de documentación citadas y confirmando con la persona responsable de static/defaultConfig.yaml de Harper si compressionThreshold: 0 es intencional. Después verifica la inconsistencia correspondiente de Harper y el problema de streams de #655 antes de actualizar de forma coherente todos los valores documentados; se considera terminado cuando la decisión entre repositorios queda registrada y las cuatro páginas coinciden con el comportamiento distribuido.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

content
What's wrong

The docs state that http.compressionThreshold defaults to 1200 bytes, so Brotli response compression is on out of the box. Harper's shipped configuration sets it to 0, and the runtime treats 0 as "off" — so on a default install, Brotli response compression never happens.

The root cause is not in this repo. Harper contradicts itself, and our docs faithfully mirror the half of it that isn't what actually ships.

Evidence (harper origin/main)
Location Says
config-root.schema.json:25-31 property description: "Responses larger than this threshold (bytes) will be compressed... Default: 1200"
config-root.schema.json:774 examples block: "compressionThreshold": 1200
static/defaultConfig.yaml:4 compressionThreshold: 0 — this is what gets written into a new install's config
validation/configValidator.ts:329 compressionThreshold: number.optional() — no default injected
server/serverHelpers/contentTypes.ts:362 const COMPRESSION_THRESHOLD = envMgr.get(CONFIG_PARAMS.HTTP_COMPRESSIONTHRESHOLD) — no || fallback, so a configured 0 stays 0
server/serverHelpers/contentTypes.ts:373 canCompress = COMPRESSION_THRESHOLD && request.headers...includes('br') — 0 is falsy, so compression is skipped entirely

So the schema documents 1200, the shipped template sets 0, and the runtime honors 0. There is no code-level 1200 default anywhere.

Note this is specifically http.compressionThreshold. The unrelated storage.compressionThreshold (LMDB record compression) does have a real code default — (storage.pageSize || 4096) - 60 at resources/databases.ts:102 — which makes this easy to conflate when grepping.

Affected pages in this repo
The question that has to be answered first

Is compressionThreshold: 0 in the shipped config intentional? The docs fix depends entirely on the answer, and the two outcomes are very different:

  • If 0 is a bug in harper - Brotli compression has been silently off for every default install. That is the real finding here, and the fix belongs in static/defaultConfig.yaml. Our docs then need no change beyond possibly noting the versions affected.
  • If 0 is intentional - then harper's own schema description and examples are wrong too, and our four locations should say compression is disabled by default and must be explicitly enabled. In that case config-root.schema.json should be corrected alongside.

Either way one of the two harper locations is wrong, so this likely wants a companion harper issue; transferring or cross-linking is fine.

Why it matters beyond a wrong number

Two things downstream depend on this:

  1. Anyone following our docs believes responses over 1200 bytes are compressed. If they are not, that is a real and invisible performance difference on a default install.
  2. There is a latent crash gated behind this setting. contentTypes.ts:410-425 pipes serializeStream's return value into createBrotliCompress() whenever canCompress is true, but the application/x-msgpack handler returns a Buffer (not a stream) for a plain array. Accept: application/x-msgpack + Accept-Encoding: br + an array body would throw TypeError: stream.pipe is not a function. That is currently unreachable only because compression ships disabled - so if the default is "corrected" to 1200 without fixing the pipe path first, this becomes reachable the same day. Sequencing matters. Surfaced in #655.
Suggested fix
  1. Get a ruling from whoever owns static/defaultConfig.yaml on whether 0 is intended.
  2. Fix harper's inconsistency (either the shipped default or the schema description + examples).
  3. Update the four locations above to match, in one pass so they cannot disagree with each other.
  4. Track the .pipe() normalization separately, and land it before any change that turns compression on by default.

sent with Claude Opus 5

Lenguaje dominante
MDX
Estrellas
9
Forks
9
Merge medio
2 d 3 h
PR fusionados (30 d)
30

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de HarperFast/documentation

Todos los issues de HarperFast/documentation

Issues similares

Más issues de Documentation

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.