feat: avoid re-evaluating the hydrate platform closure on every SSR render
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 25/100
- issue の種類
- 機能追加
- 明瞭さ
- 明確に書かれている
- 活発さ
- 静か
- 技術スタック
- typescript
- 領域
- performance, web-dev
調査の方向性
src/compiler/output-targets/dist-hydrate-script/hydrate-factory-closure.ts、src/hydrate/runner/render.ts、src/declarations/stencil-public-compiler.ts から始めてください。まず hydrate のテストスイートとリンクされた再現ベンチマークを実行してください。新しいオプションと closure の再利用が、プールされたウィンドウのレンダリングとシリアライズを含む既存の動作を壊さずに機能すれば完了です。
索引モデルが issue の本文から書いたものです。
説明
Prerequisites
- I have read the Contributing Guidelines.
- I agree to follow the Code of Conduct.
- I have searched for existing issues that already include this feature request, without success.
Describe the Feature Request
Every call to renderToString() / hydrateDocument() from the dist-hydrate-script output re-executes hydrateAppClosure and constructs a fresh MockWindow. hydrateAppClosure is the function in the generated hydrate module that wraps the whole Stencil platform (runtime, vdom) and every component class in the library. The closure exists so the platform can capture the per-call window/document, but re-evaluating it on each render is a fixed cost that scales with the size of the component library rather than with the content being rendered.
This request is for two changes:
- Cache the evaluated closure per window (transparent, no API change): in
HYDRATE_FACTORY_OUTRO, store the result ofhydrateAppClosure(win)on the window object and reuse it when the same window is passed again. - Add an opt-in
reuseWindow?: booleanhydrate option. When set,hydrateDocument/renderToStringreuse a pooledMockWindowacross calls instead of creating and destroying one per render. The pool is keyed by theserializeShadowRootconfiguration, because'scoped'permanently ORsshadowNeedsScopedCssintocmpMetaflags inside the evaluated closure. Freshhead/bodyelements are swapped in per render, so therootAppliedStylesWeakMap (keyed on the head node) resets correctly, and renders against a shared window are serialized through an internal queue.
Describe the Use Case
We maintain a design system (~300 shadow components, hydrate module >10 MB) consumed by high-traffic Next.js (App Router) sites via @stencil/react-output-target. Its SSR integration (createComponentForServerSideRendering) calls renderToString once per component boundary in the React tree, so a page with 150 Stencil component boundaries pays the fixed per-call overhead 150 times per request.
Measured with the attached reproduction (300 components, @stencil/core 4.43.5, Node 22):
- The fixed overhead is ~0.5 ms median per
renderToStringcall. A page with one component instance costs 6% of a page with 200 instances, so the per-call cost comes from platform re-evaluation and window construction, not from rendering. - A simulated request (150 component boundaries) spends ~54-62 ms in pure hydrate overhead before any application work.
- A CPU profile of 500 small renders under the V8 sampling profiler puts 42-49% of all sampled time inside
hydrateAppClosure(platform re-evaluation, withregisterComponentsalone at 19.6% self time), plus ~17% in garbage collection caused by the allocation churn.MockWindowconstruction is ~6.5%. - With both proposed changes the simulated request drops to 7.9 ms (6.7x), the p95 of single-component renders drops from 1.60 ms to 0.19 ms, and
hydrateAppClosureandMockWindowfall to 0.0% of profile samples.
Single large one-shot renders are unaffected (1.03x), since their time is real rendering work. The win is specific to the many-small-renders SSR pattern that production React/Next.js integrations use.
Describe Preferred Solution
Implementation is complete on a branch (test/hydrate-platform-reuse, happy to open a PR):
src/compiler/output-targets/dist-hydrate-script/hydrate-factory-closure.tscacheshydrateAppClosure(win)on the window object in the factory outro.src/hydrate/runner/render.tsadds thereuseWindowsupport: aMapof pooledMockWindows keyed by serializedserializeShadowRootoptions. Per render, freshhead/bodyelements are swapped in viareplaceChildand the render is queued behind any in-flight render on the same window.destroyWindow/destroyDocumentare forced off for pooled windows.src/declarations/stencil-public-compiler.tsdocuments the newreuseWindow?: booleanoption onHydrateDocumentOptions(defaultfalse, fully backwards compatible).
Existing test suites pass (test.jest, test.end-to-end).
Describe Alternatives
- Userland window pooling via the existing
destroyWindow: falseoption is not enough. The platform closure is still re-evaluated per call (the cache in change 1 is not reachable from userland), and internal state such asrootAppliedStylesand the mode/flag mutations underserializeShadowRoot: 'scoped'make naive window reuse incorrect. - Caching rendered HTML at the application layer only helps repeated identical pages; personalised and dynamic pages still pay the full cost.
Related Code
Reproduction repo: https://github.com/Armand-Lluka/stencil-hydrate-perf-repro. Run npm install && npm run generate && npm run build && npm run bench. The benchmark prints the baseline table above and, when run against a build containing the proposed changes, a comparison section. node profile.mjs produces the CPU profile attribution.
Additional Information
- The closure cache (change 1) alone benefits any consumer that passes the same window twice;
reuseWindow(change 2) is what makes it reachable through the publicrenderToString/hydrateDocumentAPI. - Concurrency: parallel
renderToStringcalls withreuseWindow: trueare serialized per pooled window; callers wanting parallelism can keep the default behaviour.
- 主要言語
- TypeScript
- スター
- 13.2k
- フォーク
- 865
- 平均マージ
- 2日 16時間
- マージ済み PR(30日)
- 29
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
stenciljs/core のほかの issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
メンテナーはふだん 1 日以内に返信
-
bug(mock-doc): `Element.toggleAttribute()` is missing, so components that use it fail during SSRオープンtriage
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
メンテナーはふだん 1 日以内に返信
-
Stencil FOUC styles should use @layer to avoid cascade conflicts with React 19対応中かも @johnjenkins が 230 日前に担当しました。 オープンStencil v5
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
メンテナーはふだん 1 日以内に返信
-
難易度 3/5 1〜2日 初心者へのやさしさ 45/100
stenciljs/core#7016 · リアクション 1 件 ·
メンテナーはふだん 1 日以内に返信
-
難易度 4/5 3〜5日 初心者へのやさしさ 22/100
メンテナーはふだん 1 日以内に返信
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
AykutSarac/jsoncrack.com#616 ·
-
nip27: long hashtag swallows the rest of the content, lone # gives an empty hashtag対応中かも @bardrop が今日担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
nbd-wtf/nostr-tools#578 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
backnotprop/plannotator#3427 ·
メンテナーはふだん 1 日以内に返信
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
microsoft/Power-CAT-Copilot-Studio-Kit#942 ·
メンテナーはふだん 1 日以内に返信
-
[BUG]: Duplicate preposition in heading and unformatted feedback text on Strengthen Argument pageオープンbug
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
AOSSIE-Org/DebateAI#801 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信