http.compressionThreshold: docs say default 1200, shipped config sets 0 (compression off by default)
まだ誰も着手していません。
評価
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 初心者へのやさしさ
- 38/100
- issue の種類
- ドキュメント
- 明瞭さ
- おおむね明確
- 活発さ
- 活発
- 技術スタック
- typescript
調査の方向性
まず、引用されている4つのドキュメント箇所を確認し、Harper の static/defaultConfig.yaml の担当者に compressionThreshold: 0 が意図したものか確認します。次に、Harper に対応する不整合と #655 のストリーム問題を検証してから、文書化されているすべての値を一貫して更新します。完了とは、リポジトリ間の決定が記録され、4つのページが提供済みの動作と一致することです。
索引モデルが issue の本文から書いたものです。
説明
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
reference/configuration/options.md:37- "Default:1200(bytes)"reference/http/configuration.md:111- thehttp.compressionThresholdsection, plus1200in examples at:123and:318reference/http/overview.md:104- "Compression applies when the response body exceeds the configuredcompressionThreshold(default 1200 bytes)"reference/configuration/operations.md:106-"compressionThreshold": 1200in a config response example
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.jsonshould 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:
- 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.
- There is a latent crash gated behind this setting.
contentTypes.ts:410-425pipesserializeStream's return value intocreateBrotliCompress()whenevercanCompressis true, but theapplication/x-msgpackhandler returns aBuffer(not a stream) for a plain array.Accept: application/x-msgpack+Accept-Encoding: br+ an array body would throwTypeError: 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
- Get a ruling from whoever owns
static/defaultConfig.yamlon whether 0 is intended. - Fix harper's inconsistency (either the shipped default or the schema description + examples).
- Update the four locations above to match, in one pass so they cannot disagree with each other.
- 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日 3時間
- マージ済み PR(30日)
- 30
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
HarperFast/documentation のほかの issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
HarperFast/documentation#677 ·
-
難易度 2/5 半日 初心者へのやさしさ 88/100
HarperFast/documentation#675 ·
-
難易度 1/5 1時間未満 初心者へのやさしさ 92/100
HarperFast/documentation#665 ·
-
content
難易度 2/5 1〜3時間 初心者へのやさしさ 74/100
HarperFast/documentation#478 ·
-
content
難易度 1/5 1時間未満 初心者へのやさしさ 76/100
HarperFast/documentation#399 · コメント 2 件 ·
HarperFast/documentation の issue をすべて見る
似ている issue
-
agent-ready documentation needs-triage
難易度 1/5 1〜3時間 初心者へのやさしさ 88/100
-
untriaged
難易度 1/5 1時間未満 初心者へのやさしさ 88/100
dotnet/dotnet-api-docs#13095 ·
-
documentation
難易度 1/5 1時間未満 初心者へのやさしさ 91/100
-
workflow-status page template still says reusable workflows are "triggered only by workflow_call:" オープン
難易度 1/5 1時間未満 初心者へのやさしさ 92/100
-
refactor
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100