refactor(runtime): share initData commit context by Yradex · Pull Request #2677 · lynx-family/lynx-stack

Yradex · 2026-05-20T07:23:59Z

Summary by CodeRabbit

New Features
- InitData APIs: added InitData provider, consumer, and hooks (useInitData, useInitDataChanged) plus withInitDataInState for class components.
- useLynxGlobalEventListener made available from the hooks entry.
Behavioral Improvements
- Data-change flushes now trigger update notifications even when only flush options are present.
- Patch application now skips native patch work unless there are actual ops to apply.
Tests
- Added tests covering commit context and comprehensive init-data/data-change scenarios.

Overview

Element Template needs initData APIs without depending on Snapshot-private runtime state. This PR moves the initData factory and shared commit context into core, then wires Snapshot and Element Template through that shared state so data-change flush options can be produced consistently.

Key Points

Moves initData support from snapshot/compat into core and re-exports the APIs from both the existing React runtime entry and the Element Template entry.
Shares globalCommitContext through core, while keeping ET-only teardown state out of the cross-thread payload.
Allows ET to dispatch option-only updates for initData changes, using payloads such as { ops: [], flushOptions: { triggerDataUpdated: true } }.
Uses the public @lynx-js/react/hooks entry for ET hooks; existing layer/alias rules resolve it to background or main-thread hook implementations without an ET-only hook facade.

Runtime Contract

Background ET commits may send an update event with empty ops when only flushOptions need to reach the main thread.
The main-thread ET patch listener skips patch-command application and patch profiling when ops is missing or empty, but still calls __FlushElementTree(__page, flushOptions).
Snapshot timing flush options and initData triggerDataUpdated now share the same core commit-context storage, with each runtime consuming/resetting it at its own commit boundary.

Checklist

Tests updated.
Documentation updated (not required; behavior is covered by runtime tests and existing public docs remain applicable).
Changeset added, and when a BREAKING CHANGE occurs, it needs to be clearly marked (empty changeset: no release-facing defaults changed).

coderabbitai · 2026-05-20T07:24:07Z

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 18662afd-2656-444e-8ba1-e09746fdc6cc

📥 Commits

Reviewing files that changed from the base of the PR and between 290b868 and 0f3c6ce.

📒 Files selected for processing (8)

packages/react/runtime/__test__/element-template/runtime/background/commit-hook.test.ts
packages/react/runtime/__test__/element-template/vitest.config.ts
packages/react/runtime/src/core/hooks/useLynxGlobalEventListener.ts
packages/react/runtime/src/element-template/hooks/react.ts
packages/react/runtime/src/element-template/index.ts
packages/react/runtime/src/element-template/native/index.ts
packages/react/runtime/tsconfig.json
packages/react/runtime/vitest.config.ts

💤 Files with no reviewable changes (1)

packages/react/runtime/src/element-template/hooks/react.ts

📝 Walkthrough

Walkthrough

Consolidates runtime flush-option management into a shared global commit context, migrates initData wiring to core, exposes InitData provider/consumer/hooks from the element-template entrypoint, tightens op handling, updates types for a triggerDataUpdated flush flag, removes test shims, and adds tests and Vitest/TS aliases.

Changes

Element Template InitData Public API with Shared Commit Context

Layer / File(s)	Summary
All changes (single checkpoint) `packages/react/runtime/src/core/commit-context.ts`, `packages/react/runtime/src/core/initData.ts`, `packages/react/runtime/src/element-template/background/`, `packages/react/runtime/src/snapshot/`, `packages/react/runtime/src/element-template/index.ts`, `packages/react/runtime/src/element-template/internal.ts`, `packages/react/runtime/src/internal.ts`, `packages/react/runtime/src/lynx-api.ts`, `packages/react/runtime/src/element-template/protocol/types.ts`, `packages/react/runtime/src/element-template/native/`, `packages/react/runtime/src/core/hooks/`, `packages/react/runtime/vitest.config.ts`, `packages/react/runtime/tsconfig.json`, tests/*`	Adds a core `globalCommitContext` singleton with helpers to take/reset flush options; migrates initData, snapshot, and element-template background modules to use the shared context; exposes InitData Provider/Consumer and hooks from the element-template entry; tightens patch-listener hasOps logic; activates `triggerDataUpdated?: boolean` in protocol types; removes layered debug shims from test surface via Vitest alias changes; and adds tests and a data-change harness covering flush-only and data-change flows.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Possibly related PRs

lynx-family/lynx-stack#2441: Related to changes introducing/altering main-thread hook implementations and exports that this PR now imports (@lynx-js/react/hooks) from.
lynx-family/lynx-stack#2579: Related to removed-subtree cleanup and background commit-hook behavior that interact with the shared globalCommitContext.nonPayload handling.

Suggested reviewers

hzy
HuJean
colinaaa
luhc228

"🐰 I hop through lines and bytes so neat,
I stitch flush options where modules meet,
InitData whispers, events ring true,
Tests clap once, the shared context grew."

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 13.33% 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
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly and concisely describes the main refactoring: moving initData support and shared commit context from snapshot/compat into core, which is the primary objective of this PR.
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.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

📝 Generate docstrings

Create stacked PR
Commit on current branch

🧪 Generate unit tests (beta)

Create PR with unit tests
Commit unit tests in branch wt/lynx-stack-20260520-1406

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 and usage tips.}

changeset-bot · 2026-05-20T07:24:07Z

🦋 Changeset detected

Latest commit: 0f3c6ce

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 0 packages

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

codecov · 2026-05-20T07:27:16Z

❌ 1 Tests Failed:

Tests completed	Failed	Passed	Skipped
5105	1	5104	93

View the top 1 failed test(s) by shortest run time

packages/web-platform/web-rsbuild-server-middleware/test/basic.spec.ts > test/basic.spec.ts

Stack Traces | 10s run time

Error: Hook timed out in 10000ms.
If this is a long-running hook, pass a timeout value as the last argument or configure it globally with "hookTimeout".
 ❯ test/basic.spec.ts:8:1

To view more test analytics, go to the Test Analytics Dashboard
_{📋 Got 3 mins? Take this short survey to help us improve Test Analytics.}

coderabbitai

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@packages/react/runtime/src/element-template/hooks/react.ts`:
- Around line 63-79: The code currently performs GlobalEventEmitter subscription
side effects inside useMemo (previousArgsRef, eventName, listener,
lynx.getJSModule('GlobalEventEmitter')), which is unsafe; move the
addListener/removeListener logic into a useEffect: remove the useMemo block
entirely, create a useEffect that adds the listener
(lynx.getJSModule('GlobalEventEmitter').addListener(eventName, listener)) when
[eventName, listener] change, store the args in previousArgsRef, and return a
cleanup that removes the previous listener via removeListener using
previousArgsRef; keep the existing teardown-only useEffect (or merge it) so no
subscriptions occur during render and all listeners are removed on unmount or
dependency change.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

Push a commit to this branch (recommended)
Create a new PR with the fixes

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 034ebfa3-1e19-4833-a142-fa514585d186

📥 Commits

Reviewing files that changed from the base of the PR and between 3901c96 and 290b868.

📒 Files selected for processing (22)

.changeset/empty-et-init-data-core.md
packages/react/runtime/__test__/core/commit-context.test.ts
packages/react/runtime/__test__/element-template/imports/init-data-api.test.ts
packages/react/runtime/__test__/element-template/runtime/background/commit-hook.test.ts
packages/react/runtime/__test__/element-template/runtime/patch/element-template-patch.test.tsx
packages/react/runtime/__test__/element-template/test-utils/debug/layeredHooks.ts
packages/react/runtime/__test__/element-template/test-utils/debug/layeredReact.ts
packages/react/runtime/__test__/element-template/vitest.config.ts
packages/react/runtime/__test__/snapshot/commit-context.test.ts
packages/react/runtime/src/core/commit-context.ts
packages/react/runtime/src/core/initData.ts
packages/react/runtime/src/element-template/background/commit-context.ts
packages/react/runtime/src/element-template/background/commit-hook.ts
packages/react/runtime/src/element-template/hooks/react.ts
packages/react/runtime/src/element-template/index.ts
packages/react/runtime/src/element-template/internal.ts
packages/react/runtime/src/element-template/native/patch-listener.ts
packages/react/runtime/src/element-template/protocol/types.ts
packages/react/runtime/src/internal.ts
packages/react/runtime/src/lynx-api.ts
packages/react/runtime/src/snapshot/lifecycle/patch/commit.ts
packages/react/runtime/src/snapshot/lynx/component.ts

💤 Files with no reviewable changes (2)

packages/react/runtime/test/element-template/test-utils/debug/layeredReact.ts
packages/react/runtime/test/element-template/test-utils/debug/layeredHooks.ts

codspeed-hq · 2026-05-20T07:47:41Z

Merging this PR will improve performance by 12.03%

⚠️

Different runtime environments detected

Some benchmarks with significant performance changes were compared across different runtime environments,
which may affect the accuracy of the results.

Open the report in CodSpeed to investigate

⚡ 1 improved benchmark
✅ 80 untouched benchmarks
⏩ 26 skipped benchmarks¹

Performance Changes

	Benchmark	`BASE`	`HEAD`	Efficiency
⚡	`transform 1000 view elements`	44.8 ms	40 ms	+12.03%

Tip

Curious why this is faster? Comment @codspeedbot explain why this is faster on this PR, or directly use the CodSpeed MCP with your agent.

_{Comparing wt/lynx-stack-20260520-1406 (0f3c6ce) with main (b42a7dc)}

26 benchmarks were skipped, so the baseline results were used instead. If they were deleted from the codebase, click here and archive them to remove them from the performance reports. ↩

relativeci · 2026-05-20T07:52:05Z

React MTF Example

#1632 Bundle Size — 208.74KiB (+0.03%).

0f3c6ce(current) vs b42a7dc main#1627(baseline)

Bundle metrics

4 changes

1 improvement

	Current #1632	Baseline #1627
Initial JS	`0B`	`0B`
Initial CSS	`0B`	`0B`
Cache Invalidation	`46.7%`	`0%`
Chunks	`0`	`0`
Assets	`3`	`3`
Modules	`194`(`-0.51%`)	`195`
Duplicate Modules	`77`(`-1.28%`)	`78`
Duplicate Code	`44.19%`(`-0.16%`)	`44.26%`
Packages	`2`	`2`
Duplicate Packages	`0`	`0`

Bundle size by type

1 change

1 regression

	Current #1632	Baseline #1627
IMG	`111.23KiB`	`111.23KiB`
Other	`97.51KiB` (`+0.05%`)	`97.46KiB`

Bundle analysis report Branch wt/lynx-stack-20260520-1406 Project dashboard

^{Generated by RelativeCI Documentation Report issue}

relativeci · 2026-05-20T07:52:06Z

React Example with Element Template

#768 Bundle Size — 201.17KiB (-1.64%).

0f3c6ce(current) vs b42a7dc main#763(baseline)

Bundle metrics

3 changes

1 improvement

	Current #768	Baseline #763
Initial JS	`0B`	`0B`
Initial CSS	`0B`	`0B`
Cache Invalidation	`28.74%`	`0%`
Chunks	`0`	`0`
Assets	`4`	`4`
Modules	`97`	`97`
Duplicate Modules	`30`(`-3.23%`)	`31`
Duplicate Code	`39.41%`(`-0.5%`)	`39.61%`
Packages	`2`	`2`
Duplicate Packages	`0`	`0`

Bundle size by type

1 change

1 improvement

	Current #768	Baseline #763
IMG	`145.76KiB`	`145.76KiB`
Other	`55.42KiB` (`-5.72%`)	`58.78KiB`

Bundle analysis report Branch wt/lynx-stack-20260520-1406 Project dashboard

^{Generated by RelativeCI Documentation Report issue}

relativeci · 2026-05-20T07:52:14Z

React External

#1614 Bundle Size — 697.99KiB (+0.01%).

0f3c6ce(current) vs b42a7dc main#1609(baseline)

Bundle metrics

1 change

	Current #1614	Baseline #1609
Initial JS	`0B`	`0B`
Initial CSS	`0B`	`0B`
Cache Invalidation	`41.22%`	`0%`
Chunks	`0`	`0`
Assets	`3`	`3`
Modules	`17`	`17`
Duplicate Modules	`5`	`5`
Duplicate Code	`8.59%`	`8.59%`
Packages	`0`	`0`
Duplicate Packages	`0`	`0`

Bundle size by type

1 change

1 regression

	Current #1614	Baseline #1609
Other	`697.99KiB` (`+0.01%`)	`697.9KiB`

Bundle analysis report Branch wt/lynx-stack-20260520-1406 Project dashboard

^{Generated by RelativeCI Documentation Report issue}

relativeci · 2026-05-20T07:54:06Z

Web Explorer

#10073 Bundle Size — 903.53KiB (0%).

0f3c6ce(current) vs b42a7dc main#10068(baseline)

Bundle metrics no changes

	Current #10073	Baseline #10068
Initial JS	`45.06KiB`	`45.06KiB`
Initial CSS	`2.22KiB`	`2.22KiB`
Cache Invalidation	`0%`	`0%`
Chunks	`9`	`9`
Assets	`11`	`11`
Modules	`231`	`231`
Duplicate Modules	`11`	`11`
Duplicate Code	`27.12%`	`27.12%`
Packages	`10`	`10`
Duplicate Packages	`0`	`0`

Bundle size by type no changes

	Current #10073	Baseline #10068
JS	`499.15KiB`	`499.15KiB`
Other	`402.16KiB`	`402.16KiB`
CSS	`2.22KiB`	`2.22KiB`

Bundle analysis report Branch wt/lynx-stack-20260520-1406 Project dashboard

^{Generated by RelativeCI Documentation Report issue}

relativeci · 2026-05-20T07:58:38Z

React Example

#8499 Bundle Size — 237.79KiB (+0.02%).

0f3c6ce(current) vs b42a7dc main#8494(baseline)

Bundle metrics

4 changes

1 improvement

	Current #8499	Baseline #8494
Initial JS	`0B`	`0B`
Initial CSS	`0B`	`0B`
Cache Invalidation	`38.69%`	`0%`
Chunks	`0`	`0`
Assets	`4`	`4`
Modules	`199`(`-0.5%`)	`200`
Duplicate Modules	`80`(`-1.23%`)	`81`
Duplicate Code	`44.69%`(`-0.16%`)	`44.76%`
Packages	`2`	`2`
Duplicate Packages	`0`	`0`

Bundle size by type

1 change

1 regression

	Current #8499	Baseline #8494
IMG	`145.76KiB`	`145.76KiB`
Other	`92.04KiB` (`+0.06%`)	`91.98KiB`

Bundle analysis report Branch wt/lynx-stack-20260520-1406 Project dashboard

^{Generated by RelativeCI Documentation Report issue}

refactor(runtime): share init data commit context

290b868

Yradex marked this pull request as ready for review May 20, 2026 07:26

Yradex requested review from HuJean and hzy as code owners May 20, 2026 07:26

coderabbitai Bot added the framework:React label May 20, 2026

coderabbitai Bot reviewed May 20, 2026

View reviewed changes

Comment thread packages/react/runtime/src/element-template/hooks/react.ts Outdated

Yradex marked this pull request as draft May 20, 2026 07:31

refactor(runtime): use layered hooks for element template

0f3c6ce

Yradex marked this pull request as ready for review May 20, 2026 08:16

HuJean approved these changes May 20, 2026

View reviewed changes

Yradex merged commit e794bbf into main May 20, 2026
141 of 148 checks passed

Yradex deleted the wt/lynx-stack-20260520-1406 branch May 20, 2026 09:15

coderabbitai Bot mentioned this pull request May 20, 2026

feat(react): support ET updateCardData bridge #2679

Merged

3 tasks

Conversation

Yradex commented May 20, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Overview

Key Points

Runtime Contract

Checklist

Uh oh!

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

Uh oh!

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

Suggested reviewers

❌ Failed checks (1 warning)

Uh oh!

changeset-bot Bot commented May 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

codecov Bot commented May 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

❌ 1 Tests Failed:

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

codspeed-hq Bot commented May 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Merging this PR will improve performance by 12.03%

Performance Changes

Footnotes

Uh oh!

relativeci Bot commented May 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

React MTF Example

#1632 Bundle Size — 208.74KiB (+0.03%).

Uh oh!

relativeci Bot commented May 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

React Example with Element Template

#768 Bundle Size — 201.17KiB (-1.64%).

Uh oh!

relativeci Bot commented May 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

React External

#1614 Bundle Size — 697.99KiB (+0.01%).

Uh oh!

relativeci Bot commented May 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Web Explorer

#10073 Bundle Size — 903.53KiB (0%).

Uh oh!

relativeci Bot commented May 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

React Example

#8499 Bundle Size — 237.79KiB (+0.02%).

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Yradex commented May 20, 2026 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented May 20, 2026 •

edited

Loading

changeset-bot Bot commented May 20, 2026 •

edited

Loading

codecov Bot commented May 20, 2026 •

edited

Loading

codspeed-hq Bot commented May 20, 2026 •

edited

Loading

relativeci Bot commented May 20, 2026 •

edited

Loading

relativeci Bot commented May 20, 2026 •

edited

Loading

relativeci Bot commented May 20, 2026 •

edited

Loading

relativeci Bot commented May 20, 2026 •

edited

Loading

relativeci Bot commented May 20, 2026 •

edited

Loading