feat: add entry lifecycle hooks by harlan-zw · Pull Request #875 · unjs/unhead

harlan-zw · Jul 23, 2026

🔗 Linked issue

Nuxt integration workarounds: nuxt/nuxt#32100, nuxt/nuxt#35389

❓ Type of change

📚 Description

Adds entries:beforePush so integrations can suppress an entry without replacing head.push. Adds client entries:beforeDispose so integrations can keep outgoing head state until registered promises settle.

Nuxt currently replaces head.push during island rendering and returns a cast fake entry. It also replaces every entry dispose method to wait for page transitions. These typed hooks remove both monkey patches.

Deferred disposal uses Promise.allSettled, so failed navigation or suspense promises still release the entry. Both hooks are documented and covered by lifecycle tests.

Testing: pnpm lint, pnpm lint:docs, pnpm typecheck, pnpm build, and pnpm vitest run, with 1,784 passed and 8 skipped.

coderabbitai · Jul 23, 2026

Warning

Review limit reached

@harlan-zw, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 52 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: e8ffc0e2-dcd3-4f4d-bb54-da63a3efb047

📥 Commits

Reviewing files that changed from the base of the PR and between cebded7 and ea162ee.

📒 Files selected for processing (1)

packages/unhead/src/plugins/validate.ts

📝 Walkthrough

Walkthrough

Adds entries:beforePush and entries:beforeDispose lifecycle hooks, including public types, push suppression, deferred client disposal, validation handling, documentation, and unit tests.

Changes

Entry Lifecycle Hooks

Layer / File(s)	Summary
Hook contracts and composition `packages/unhead/src/types/hooks.ts`, `docs/head/7.api/0.get-started/overview.md`	Adds context types and exposes the new hooks through client and general head hook compositions.
Before-push veto flow `packages/unhead/src/unhead.ts`, `packages/unhead/src/plugins/validate.ts`, `docs/head/7.api/hooks/00.entries-before-push.md`, `packages/unhead/test/unit/entryLifecycle.test.ts`	Allows synchronous push suppression, returns an inert entry when vetoed, avoids invalid validation indexes, and tests frozen and unfrozen pushes.
Deferred client disposal `packages/unhead/src/client/adapter.ts`, `docs/head/7.api/hooks/01.entries-before-dispose.md`, `packages/unhead/test/unit/entryLifecycle.test.ts`	Collects disposal promises, finalizes entries after settlement, handles rejection cleanup, and tests multiple deferred promises.

Estimated code review effort: 3 (Moderate) | ~20 minutes

Sequence Diagram(s)

Before-push flow

sequenceDiagram
  participant Caller
  participant createUnhead
  participant entriesBeforePush
  Caller->>createUnhead: push(input, options)
  createUnhead->>entriesBeforePush: callHook(input, options, shouldPush)
  entriesBeforePush-->>createUnhead: update shouldPush
  createUnhead-->>Caller: noop entry or active entry

Deferred disposal flow

sequenceDiagram
  participant ActiveHeadEntry
  participant ClientAdapter
  participant entriesBeforeDispose
  participant DeferredPromises
  ActiveHeadEntry->>ClientAdapter: dispose()
  ClientAdapter->>entriesBeforeDispose: callHook(entry, defer)
  entriesBeforeDispose-->>ClientAdapter: register PromiseLike values
  ClientAdapter->>DeferredPromises: Promise.allSettled(values)
  DeferredPromises-->>ClientAdapter: promises settle
  ClientAdapter-->>ActiveHeadEntry: finalize disposal and invalidate head

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 25.00% which is insufficient. The required threshold is 80.00%.	Write docstrings for the functions missing them to satisfy the coverage threshold.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Title check	✅ Passed	The title clearly and concisely summarizes the main change: adding entry lifecycle hooks.
Description check	✅ Passed	The description includes linked issues, type of change, a clear summary, rationale, and testing details, matching the template well.

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Commit unit tests in branch feat/entry-lifecycle-hooks

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands.}

github-actions · Jul 23, 2026

📦 Bundle Size

⚠️ 12 bundles grew · net +1.5 kB gz

Bundle	Gzipped	Δ
Client (Minimal)	5.4 kB → 5.5 kB	🔴 +0.2 kB (+3.4%)
Client (Full)	9.5 kB → 9.7 kB	🔴 +0.2 kB (+1.8%)
Client (Self-Contained)	5.7 kB → 5.9 kB	🔴 +0.2 kB (+3.3%)
Server (Minimal)	4.9 kB → 5 kB	🔴 +52 B (+1.0%)
Server (Self-Contained)	5.2 kB → 5.3 kB	🔴 +49 B (+0.9%)
Vue Client (Minimal)	5.9 kB → 6 kB	🔴 +0.2 kB (+2.9%)
Vue Client (Full)	10.5 kB → 10.7 kB	🔴 +0.2 kB (+1.7%)
Vue Server (Minimal)	5.4 kB → 5.4 kB	🔴 +48 B (+0.9%)
React Client (Minimal)	5.8 kB → 6 kB	🔴 +0.2 kB (+3.1%)
React Client (Full)	10.6 kB → 10.8 kB	🔴 +0.2 kB (+1.6%)
React Server (Minimal)	5.2 kB → 5.2 kB	🔴 +49 B (+0.9%)
Schema.org (Minimal)	10.1 kB → 10.2 kB	🔴 +48 B (+0.5%)

All bundles (14)

Bundle	Gzipped	Brotli	Raw
Core
Client (Minimal)	5.5 kB	5 kB	14 kB	🔴
Client (Full)	9.7 kB	8.8 kB	25.3 kB	🔴
Client (Self-Contained)	5.9 kB	5.3 kB	14.8 kB	🔴
Server (Minimal)	5 kB	4.5 kB	12.5 kB	🔴
Server (Self-Contained)	5.3 kB	4.8 kB	13.2 kB	🔴
Vue
Vue Client (Minimal)	6 kB	5.5 kB	15.1 kB	🔴
Vue Client (Full)	10.7 kB	9.7 kB	28.1 kB	🔴
Vue Server (Minimal)	5.4 kB	4.9 kB	13.5 kB	🔴
React
React Client (Minimal)	6 kB	5.5 kB	15.2 kB	🔴
React Client (Full)	10.8 kB	9.8 kB	28.5 kB	🔴
React Server (Minimal)	5.2 kB	4.7 kB	13.2 kB	🔴
Schema.org
Schema.org (Minimal)	10.2 kB	9.2 kB	28.1 kB	🔴
Schema.org Imports	0.1 kB	0.1 kB	0.1 kB	✅
Schema.org Vue Meta	0.4 kB	0.3 kB	0.8 kB	✅

📦 Runtime Dependencies

✅ No runtime dependency changes

All packages (10)

Package	External deps	Install size	Largest dependency	Skipped optional
@unhead/angular	10	773.6 kB	@jridgewell/trace-mapping 146.7 kB	0
@unhead/bundler	18	5.6 MB	@oxc-parser/binding-linux-arm64-gnu 2.2 MB	19
@unhead/cli	22	5.7 MB	@oxc-parser/binding-linux-arm64-gnu 2.2 MB	19
@unhead/eslint-plugin	9	683.2 kB	@jridgewell/trace-mapping 146.7 kB	0
@unhead/react	19	5.6 MB	@oxc-parser/binding-linux-arm64-gnu 2.2 MB	19
@unhead/schema-org	9	683.2 kB	@jridgewell/trace-mapping 146.7 kB	0
@unhead/solid-js	19	5.6 MB	@oxc-parser/binding-linux-arm64-gnu 2.2 MB	19
@unhead/svelte	19	5.6 MB	@oxc-parser/binding-linux-arm64-gnu 2.2 MB	19
@unhead/vue	19	5.6 MB	@oxc-parser/binding-linux-arm64-gnu 2.2 MB	19
unhead	9	683.2 kB	@jridgewell/trace-mapping 146.7 kB	0

Skipped optional dependencies (114)

@unhead/bundler: oxc-parser -> @oxc-parser/binding-android-arm-eabi, oxc-parser -> @oxc-parser/binding-android-arm64, oxc-parser -> @oxc-parser/binding-darwin-arm64, oxc-parser -> @oxc-parser/binding-darwin-x64, oxc-parser -> @oxc-parser/binding-freebsd-x64, oxc-parser -> @oxc-parser/binding-linux-arm-gnueabihf, oxc-parser -> @oxc-parser/binding-linux-arm-musleabihf, oxc-parser -> @oxc-parser/binding-linux-arm64-musl, oxc-parser -> @oxc-parser/binding-linux-ppc64-gnu, oxc-parser -> @oxc-parser/binding-linux-riscv64-gnu, oxc-parser -> @oxc-parser/binding-linux-riscv64-musl, oxc-parser -> @oxc-parser/binding-linux-s390x-gnu, oxc-parser -> @oxc-parser/binding-linux-x64-gnu, oxc-parser -> @oxc-parser/binding-linux-x64-musl, oxc-parser -> @oxc-parser/binding-openharmony-arm64, oxc-parser -> @oxc-parser/binding-wasm32-wasi, oxc-parser -> @oxc-parser/binding-win32-arm64-msvc, oxc-parser -> @oxc-parser/binding-win32-ia32-msvc, oxc-parser -> @oxc-parser/binding-win32-x64-msvc
@unhead/cli: oxc-parser -> @oxc-parser/binding-android-arm-eabi, oxc-parser -> @oxc-parser/binding-android-arm64, oxc-parser -> @oxc-parser/binding-darwin-arm64, oxc-parser -> @oxc-parser/binding-darwin-x64, oxc-parser -> @oxc-parser/binding-freebsd-x64, oxc-parser -> @oxc-parser/binding-linux-arm-gnueabihf, oxc-parser -> @oxc-parser/binding-linux-arm-musleabihf, oxc-parser -> @oxc-parser/binding-linux-arm64-musl, oxc-parser -> @oxc-parser/binding-linux-ppc64-gnu, oxc-parser -> @oxc-parser/binding-linux-riscv64-gnu, oxc-parser -> @oxc-parser/binding-linux-riscv64-musl, oxc-parser -> @oxc-parser/binding-linux-s390x-gnu, oxc-parser -> @oxc-parser/binding-linux-x64-gnu, oxc-parser -> @oxc-parser/binding-linux-x64-musl, oxc-parser -> @oxc-parser/binding-openharmony-arm64, oxc-parser -> @oxc-parser/binding-wasm32-wasi, oxc-parser -> @oxc-parser/binding-win32-arm64-msvc, oxc-parser -> @oxc-parser/binding-win32-ia32-msvc, oxc-parser -> @oxc-parser/binding-win32-x64-msvc
@unhead/react: oxc-parser -> @oxc-parser/binding-android-arm-eabi, oxc-parser -> @oxc-parser/binding-android-arm64, oxc-parser -> @oxc-parser/binding-darwin-arm64, oxc-parser -> @oxc-parser/binding-darwin-x64, oxc-parser -> @oxc-parser/binding-freebsd-x64, oxc-parser -> @oxc-parser/binding-linux-arm-gnueabihf, oxc-parser -> @oxc-parser/binding-linux-arm-musleabihf, oxc-parser -> @oxc-parser/binding-linux-arm64-musl, oxc-parser -> @oxc-parser/binding-linux-ppc64-gnu, oxc-parser -> @oxc-parser/binding-linux-riscv64-gnu, oxc-parser -> @oxc-parser/binding-linux-riscv64-musl, oxc-parser -> @oxc-parser/binding-linux-s390x-gnu, oxc-parser -> @oxc-parser/binding-linux-x64-gnu, oxc-parser -> @oxc-parser/binding-linux-x64-musl, oxc-parser -> @oxc-parser/binding-openharmony-arm64, oxc-parser -> @oxc-parser/binding-wasm32-wasi, oxc-parser -> @oxc-parser/binding-win32-arm64-msvc, oxc-parser -> @oxc-parser/binding-win32-ia32-msvc, oxc-parser -> @oxc-parser/binding-win32-x64-msvc
@unhead/solid-js: oxc-parser -> @oxc-parser/binding-android-arm-eabi, oxc-parser -> @oxc-parser/binding-android-arm64, oxc-parser -> @oxc-parser/binding-darwin-arm64, oxc-parser -> @oxc-parser/binding-darwin-x64, oxc-parser -> @oxc-parser/binding-freebsd-x64, oxc-parser -> @oxc-parser/binding-linux-arm-gnueabihf, oxc-parser -> @oxc-parser/binding-linux-arm-musleabihf, oxc-parser -> @oxc-parser/binding-linux-arm64-musl, oxc-parser -> @oxc-parser/binding-linux-ppc64-gnu, oxc-parser -> @oxc-parser/binding-linux-riscv64-gnu, oxc-parser -> @oxc-parser/binding-linux-riscv64-musl, oxc-parser -> @oxc-parser/binding-linux-s390x-gnu, oxc-parser -> @oxc-parser/binding-linux-x64-gnu, oxc-parser -> @oxc-parser/binding-linux-x64-musl, oxc-parser -> @oxc-parser/binding-openharmony-arm64, oxc-parser -> @oxc-parser/binding-wasm32-wasi, oxc-parser -> @oxc-parser/binding-win32-arm64-msvc, oxc-parser -> @oxc-parser/binding-win32-ia32-msvc, oxc-parser -> @oxc-parser/binding-win32-x64-msvc
@unhead/svelte: oxc-parser -> @oxc-parser/binding-android-arm-eabi, oxc-parser -> @oxc-parser/binding-android-arm64, oxc-parser -> @oxc-parser/binding-darwin-arm64, oxc-parser -> @oxc-parser/binding-darwin-x64, oxc-parser -> @oxc-parser/binding-freebsd-x64, oxc-parser -> @oxc-parser/binding-linux-arm-gnueabihf, oxc-parser -> @oxc-parser/binding-linux-arm-musleabihf, oxc-parser -> @oxc-parser/binding-linux-arm64-musl, oxc-parser -> @oxc-parser/binding-linux-ppc64-gnu, oxc-parser -> @oxc-parser/binding-linux-riscv64-gnu, oxc-parser -> @oxc-parser/binding-linux-riscv64-musl, oxc-parser -> @oxc-parser/binding-linux-s390x-gnu, oxc-parser -> @oxc-parser/binding-linux-x64-gnu, oxc-parser -> @oxc-parser/binding-linux-x64-musl, oxc-parser -> @oxc-parser/binding-openharmony-arm64, oxc-parser -> @oxc-parser/binding-wasm32-wasi, oxc-parser -> @oxc-parser/binding-win32-arm64-msvc, oxc-parser -> @oxc-parser/binding-win32-ia32-msvc, oxc-parser -> @oxc-parser/binding-win32-x64-msvc
@unhead/vue: oxc-parser -> @oxc-parser/binding-android-arm-eabi, oxc-parser -> @oxc-parser/binding-android-arm64, oxc-parser -> @oxc-parser/binding-darwin-arm64, oxc-parser -> @oxc-parser/binding-darwin-x64, oxc-parser -> @oxc-parser/binding-freebsd-x64, oxc-parser -> @oxc-parser/binding-linux-arm-gnueabihf, oxc-parser -> @oxc-parser/binding-linux-arm-musleabihf, oxc-parser -> @oxc-parser/binding-linux-arm64-musl, oxc-parser -> @oxc-parser/binding-linux-ppc64-gnu, oxc-parser -> @oxc-parser/binding-linux-riscv64-gnu, oxc-parser -> @oxc-parser/binding-linux-riscv64-musl, oxc-parser -> @oxc-parser/binding-linux-s390x-gnu, oxc-parser -> @oxc-parser/binding-linux-x64-gnu, oxc-parser -> @oxc-parser/binding-linux-x64-musl, oxc-parser -> @oxc-parser/binding-openharmony-arm64, oxc-parser -> @oxc-parser/binding-wasm32-wasi, oxc-parser -> @oxc-parser/binding-win32-arm64-msvc, oxc-parser -> @oxc-parser/binding-win32-ia32-msvc, oxc-parser -> @oxc-parser/binding-win32-x64-msvc

_{Production dependencies only. Peer dependencies and Unhead workspace packages are excluded. Skipped optional dependencies are unavailable on the CI platform.}

⚡ Performance (directional)

✅ No significant change (within CI noise)

All benchmarks (14)

Benchmark	PR	Δ	RME
SSR render (CPU)	0.359 ms	~ noise	±8.5%
SSR render (wall)	0.259 ms	~ noise	±4.7%
SSR allocated / render	238.2 KiB	~ noise	±6.8%
Schema.org cached render (CPU)	0.342 ms	~ noise	±6.6%
Schema.org cached render (wall)	0.248 ms	~ noise	±2.9%
Schema.org cached allocated / render	134.6 KiB	~ noise	±0.2%
Streaming wrapStream drain (CPU)	0.227 ms	~ noise	±4.4%
Streaming wrapStream drain (wall)	0.146 ms	~ noise	±4.3%
Streaming allocated / drain	149.9 KiB	~ noise	±0.3%
Streaming suspense chunk (CPU)	0.012 ms	~ noise	±6.7%
Streaming allocated / suspense chunk	4.7 KiB	~ noise	±0.5%
CSR DOM mutations / nav	38	~ noise	—
CSR re-render (CPU)	0.778 ms	~ noise	±5.4%
CSR re-render (wall)	0.447 ms	~ noise	±2.1%

_{Baseline: main @ d9b3d2a · 2026-07-26 · gzipped is the headline size metric · perf is directional (shared-runner, gated)}

feat: add entry lifecycle hooks

cebded7

Merge branch 'main' into feat/entry-lifecycle-hooks

ea162ee

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

feat: add entry lifecycle hooks#875

feat: add entry lifecycle hooks#875
harlan-zw wants to merge 2 commits into
mainunjs/unhead:mainfrom
feat/entry-lifecycle-hooksunjs/unhead:feat/entry-lifecycle-hooksCopy head branch name to clipboard

harlan-zw commented Jul 23, 2026 •

edited

Loading

Uh oh!

coderabbitai Bot commented Jul 23, 2026 •

edited

Loading

Review limit reached

Walkthrough

Changes

Sequence Diagram(s)

Before-push flow

Deferred disposal flow

❌ Failed checks (1 warning)

Uh oh!

github-actions Bot commented Jul 23, 2026 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Search code, repositories, users, issues, pull requests...

Uh oh!

Uh oh!

Conversation

harlan-zw commented Jul 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🔗 Linked issue

❓ Type of change

📚 Description

Uh oh!

coderabbitai Bot commented Jul 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review limit reached

Walkthrough

Changes

Sequence Diagram(s)

Before-push flow

Deferred disposal flow

❌ Failed checks (1 warning)

Uh oh!

github-actions Bot commented Jul 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

📦 Bundle Size

📦 Runtime Dependencies

⚡ Performance (directional)

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

harlan-zw commented Jul 23, 2026 •

edited

Loading

coderabbitai Bot commented Jul 23, 2026 •

edited

Loading

github-actions Bot commented Jul 23, 2026 •

edited

Loading