feat: support elementTemplate for web

[PupilTong]

Summary by CodeRabbit

• New Features
  • Added support for the "elementTemplate" feature in web environments.
• Tests
  • Introduced new test cases and configuration to verify the presence and correctness of the "elementTemplate" property in generated outputs.
• Chores
  • Added configuration files to support new test scenarios.

Checklist

• Tests updated (or not required).
• Documentation updated (or not required).
• Changeset added, and when a BREAKING CHANGE occurs, it needs to be clearly marked (or not required).

#1042

[changeset-bot]

🦋 Changeset detected

Latest commit: 33cef98

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

This PR includes changesets to release 3 packages

Name	Type
@lynx-js/template-webpack-plugin	Patch
@lynx-js/react-rsbuild-plugin	Patch
@lynx-js/react-alias-rsbuild-plugin	Patch

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

[coderabbitai]

📝 Walkthrough

Walkthrough

A patch update introduces support for the elementTemplate feature in the @lynx-js/template-webpack-plugin package for web environments. The update modifies the encoding logic to include the elementTemplate property, and adds a new test case suite—comprising configuration, test, and sample files—to verify this feature's presence and integration.

Changes

Cohort / File(s)	Change Summary
Version & Metadata .changeset/afraid-crews-dig.md	Documents a patch version update for @lynx-js/template-webpack-plugin, noting the addition of elementTemplate support for web environments.
Plugin Logic Update packages/webpack/template-webpack-plugin/src/WebEncodePlugin.ts	Modifies the encoding process to serialize and include the elementTemplate property from encodeOptions in the output buffer during the encode hook. No other logic is changed.
Test Suite: elementTemplate packages/webpack/template-webpack-plugin/test/cases/web/element-template/a.js, b.js, rspack.config.js, test.config.cjs	Adds a new test suite for the elementTemplate feature: - a.js: Outputs a string to the console. - b.js: Vitest test checks for the presence of elementTemplate in a JSON output. - rspack.config.js: Rspack config sets up plugins and compilation hooks to inject and test elementTemplate. - test.config.cjs: Exports a test runner config specifying the output bundle path.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~15 minutes

Suggested reviewers

• Sherry-hue
• colinaaa

Poem

In the warren of code, a patch hops in,
With elementTemplate tucked under its chin.
Tests now bloom in the web’s bright light,
Ensuring all features work just right.
Console chatter, configs anew—
This bunny’s patch is fresh as dew! 🐇✨

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

✨ Finishing Touches

• 📝 Generate Docstrings

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai generate unit tests to generate unit tests for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

packages/webpack/template-webpack-plugin/src/WebEncodePlugin.ts (1)

100-100: Consider type safety and property access consistency.

The elementTemplate property addition looks correct, but there are a few considerations:

1. Property access inconsistency: This uses bracket notation while other properties use dot notation (e.g., encodeOptions.manifest on line 91).
2. Potential undefined value: No validation that elementTemplate exists in encodeOptions.

Consider using consistent dot notation and potentially providing a default value:

-              elementTemplate: encodeOptions['elementTemplate'],
+              elementTemplate: encodeOptions.elementTemplate ?? {},

Alternatively, if bracket notation is intentional due to typing constraints, consider adding a comment explaining why.

packages/webpack/template-webpack-plugin/test/cases/web/element-template/b.js (1)

6-13: LGTM! Test correctly verifies elementTemplate presence.

The test successfully validates that the elementTemplate property is included in the generated JSON. The async file reading and JSON parsing logic is correct.

Consider making the test more specific about what constitutes a valid elementTemplate:

  const { elementTemplate } = JSON.parse(fileContent);
- expect(elementTemplate).toBeTruthy();
+ expect(elementTemplate).toBeDefined();
+ expect(typeof elementTemplate).toBe('object');

This would ensure elementTemplate is not just truthy but is actually an object as expected.

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 92445ad and 33cef98.

📒 Files selected for processing (6)

• .changeset/afraid-crews-dig.md (1 hunks)
• packages/webpack/template-webpack-plugin/src/WebEncodePlugin.ts (1 hunks)
• packages/webpack/template-webpack-plugin/test/cases/web/element-template/a.js (1 hunks)
• packages/webpack/template-webpack-plugin/test/cases/web/element-template/b.js (1 hunks)
• packages/webpack/template-webpack-plugin/test/cases/web/element-template/rspack.config.js (1 hunks)
• packages/webpack/template-webpack-plugin/test/cases/web/element-template/test.config.cjs (1 hunks)

🧰 Additional context used

🧠 Learnings (3)

📓 Common learnings

Learnt from: colinaaa
PR: lynx-family/lynx-stack#1330
File: .changeset/olive-animals-attend.md:1-3
Timestamp: 2025-07-22T09:23:07.797Z
Learning: In the lynx-family/lynx-stack repository, changesets are only required for meaningful changes to end-users such as bugfixes and features. Internal/development changes like chores, refactoring, or removing debug info do not need changeset entries.

Learnt from: colinaaa
PR: lynx-family/lynx-stack#1330
File: .changeset/olive-animals-attend.md:1-3
Timestamp: 2025-07-22T09:26:16.722Z
Learning: In the lynx-family/lynx-stack repository, CI checks require changesets when files matching the pattern "src/**" are modified (as configured in .changeset/config.json). For internal changes that don't need meaningful changesets, an empty changeset file is used to satisfy the CI requirement while not generating any release notes.

Learnt from: PupilTong
PR: lynx-family/lynx-stack#1029
File: packages/web-platform/web-core/src/uiThread/createRenderAllOnUI.ts:95-99
Timestamp: 2025-07-16T06:28:26.463Z
Learning: In the lynx-stack codebase, CSS selectors in SSR hydration are generated by their own packages, ensuring a predictable format that makes simple string manipulation safe and preferable over regex for performance reasons.

Learnt from: PupilTong
PR: lynx-family/lynx-stack#1029
File: packages/web-platform/web-core/src/uiThread/createRenderAllOnUI.ts:95-99
Timestamp: 2025-07-16T05:57:29.837Z
Learning: In the lynx-stack codebase, PupilTong prefers avoiding regex for parsing in performance-critical code paths like SSR hydration, preferring simple string manipulation operations even if they're less robust, when the input format is predictable and controlled.

.changeset/afraid-crews-dig.md (2)

Learnt from: colinaaa
PR: #1330
File: .changeset/olive-animals-attend.md:1-3
Timestamp: 2025-07-22T09:23:07.797Z
Learning: In the lynx-family/lynx-stack repository, changesets are only required for meaningful changes to end-users such as bugfixes and features. Internal/development changes like chores, refactoring, or removing debug info do not need changeset entries.

Learnt from: colinaaa
PR: #1330
File: .changeset/olive-animals-attend.md:1-3
Timestamp: 2025-07-22T09:26:16.722Z
Learning: In the lynx-family/lynx-stack repository, CI checks require changesets when files matching the pattern "src/**" are modified (as configured in .changeset/config.json). For internal changes that don't need meaningful changesets, an empty changeset file is used to satisfy the CI requirement while not generating any release notes.

packages/webpack/template-webpack-plugin/test/cases/web/element-template/rspack.config.js (3)

Learnt from: colinaaa
PR: #1330
File: .changeset/olive-animals-attend.md:1-3
Timestamp: 2025-07-22T09:26:16.722Z
Learning: In the lynx-family/lynx-stack repository, CI checks require changesets when files matching the pattern "src/**" are modified (as configured in .changeset/config.json). For internal changes that don't need meaningful changesets, an empty changeset file is used to satisfy the CI requirement while not generating any release notes.

Learnt from: PupilTong
PR: #1029
File: packages/web-platform/web-core/src/uiThread/createRenderAllOnUI.ts:95-99
Timestamp: 2025-07-16T06:28:26.463Z
Learning: In the lynx-stack codebase, CSS selectors in SSR hydration are generated by their own packages, ensuring a predictable format that makes simple string manipulation safe and preferable over regex for performance reasons.

Learnt from: PupilTong
PR: #1029
File: packages/web-platform/web-core/src/uiThread/createRenderAllOnUI.ts:95-99
Timestamp: 2025-07-16T05:57:29.837Z
Learning: In the lynx-stack codebase, PupilTong prefers avoiding regex for parsing in performance-critical code paths like SSR hydration, preferring simple string manipulation operations even if they're less robust, when the input format is predictable and controlled.

🧬 Code Graph Analysis (1)

packages/webpack/template-webpack-plugin/test/cases/web/element-template/rspack.config.js (1)

packages/webpack/template-webpack-plugin/src/WebEncodePlugin.ts (1)

• WebEncodePlugin (14-123)

🔇 Additional comments (9)

packages/webpack/template-webpack-plugin/test/cases/web/element-template/a.js (1)

1-1: LGTM! Simple test fixture correctly implemented.

This test entry point serves its purpose well as part of the elementTemplate feature test suite.

.changeset/afraid-crews-dig.md (1)

1-5: LGTM! Changeset correctly formatted for the feature addition.

The patch version update is appropriate for adding elementTemplate support, and the description aligns with the PR objectives.

packages/webpack/template-webpack-plugin/test/cases/web/element-template/test.config.cjs (1)

1-6: LGTM! Test configuration correctly structured.

The configuration properly specifies the bundle path for the elementTemplate test case and uses appropriate JSDoc typing.

packages/webpack/template-webpack-plugin/test/cases/web/element-template/rspack.config.js (6)

1-14: LGTM! Configuration follows established patterns.

The import statement and entry configuration are consistent with other test cases in the repository. The main-thread entries with .lepus.js extension and the organized output structure align with the lynx-stack architecture.

---

16-18: LGTM! WebEncodePlugin configuration is correct.

The plugin is properly configured to include only the 'a.js' module, which aligns with the test case requirements for elementTemplate support.

---

19-24: LGTM! LynxTemplatePlugin configuration follows conventions.

The plugin configuration correctly targets the 'a' and 'a:main-thread' chunks with appropriate filename and intermediate directory settings, consistent with other test cases.

---

26-36: LGTM! Asset processing follows established pattern.

The logic for marking assets with the 'lynx:main-thread' flag is identical to other test configurations and correctly implements the required asset processing.

---

54-57: LGTM! File structure is complete and syntactically correct.

The configuration properly closes the plugins array and maintains valid JavaScript syntax throughout.

---

37-53: ElementTemplate injection test coverage confirmed

• The hook in packages/webpack/template-webpack-plugin/test/cases/web/element-template/rspack.config.js injects encodeData.elementTemplate = {} as intended.
• The Vitest in the same folder reads .rspeedy/a/tasm.json and asserts:

  it('should have elementTemplate', async () => {
    const { elementTemplate } = JSON.parse(/* file contents */);
    expect(elementTemplate).toBeTruthy();
  });

• No further changes required.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ All tests successful. No failed tests found.

📢 Thoughts on this report? Let us know!

[codspeed-hq]

CodSpeed Performance Report

Merging #1374 will not alter performance

_{Comparing PupilTong:p/hw/element-template (33cef98) with main (92445ad)}

Summary

✅ 10 untouched benchmarks

[relativeci]

Web Explorer

#3434 Bundle Size — 352.53KiB (0%).

33cef98(current) vs 92445ad main#3426(baseline)

Bundle metrics   1 change

	Current #3434	Baseline #3426
Initial JS	142.12KiB	142.12KiB
Initial CSS	31.83KiB	31.83KiB
Cache Invalidation	0%	0%
Chunks	7	7
Assets	7	7
Modules	215(+0.47%)	214
Duplicate Modules	17	17
Duplicate Code	3.94%	3.94%
Packages	4	4
Duplicate Packages	0	0

Bundle size by type  no changes

	Current #3434	Baseline #3426
JS	226.4KiB	226.4KiB
Other	94.29KiB	94.29KiB
CSS	31.83KiB	31.83KiB

Bundle analysis report Branch PupilTong:p/hw/element-template Project dashboard

---

^{Generated by RelativeCI Documentation Report issue}

[relativeci]

React Example

#3444 Bundle Size — 235.18KiB (0%).

33cef98(current) vs 92445ad main#3436(baseline)

Bundle metrics  no changes

	Current #3444	Baseline #3436
Initial JS	0B	0B
Initial CSS	0B	0B
Cache Invalidation	0%	0%
Chunks	0	0
Assets	4	4
Modules	156	156
Duplicate Modules	63	63
Duplicate Code	45.94%	45.94%
Packages	2	2
Duplicate Packages	0	0

Bundle size by type  no changes

	Current #3444	Baseline #3436
IMG	145.76KiB	145.76KiB
Other	89.42KiB	89.42KiB

Bundle analysis report Branch PupilTong:p/hw/element-template Project dashboard

---

^{Generated by RelativeCI Documentation Report issue}