Hacktoberfest 2026：维护者为十月标记出来的 issue，仍然开放、适合新手。 浏览 Hacktoberfest issue

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

未关闭
  • 哪里不对？
#656 1 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 2 天内回复

还没有人认领这个 Issue。

评估

难度
4/5
预计耗时
3-5 天
新手友好度
38/100
Issue 类型
文档
描述清晰度
基本清楚
活跃度
活跃
技术栈
typescript
领域
documentation

调研方向

首先检查所引用的四个文档位置，并与 Harper 的 static/defaultConfig.yaml 负责人确认 compressionThreshold: 0 是否是有意为之。然后在统一更新所有文档值之前，验证 Harper 中对应的不一致以及 #655 的流问题；完成的标准是跨仓库决策已记录，并且四个页面与已发布的行为一致。

由索引模型根据 Issue 内容生成。

描述

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

主要语言
MDX
星标
9
派生
9
平均合并
2 天 23 小时
30 天内合并 PR
26

环境准备

  • 没有 Dockerfile 或 Docker Compose 文件
  • 没有 Pull Request 模板
  • 阅读贡献指南

从这里开始

  1. 先读完整个 Issue，再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库，在一个分支上完成修改。
  4. 提交 Pull Request，并在描述里引用这个 Issue 编号。

HarperFast/documentation 的其他 Issue

查看 HarperFast/documentation 的全部 Issue

相似的 Issue

更多 Documentation Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。