fix(web): web-explorer needs to actively send an iframeReady message … by Sherry-hue · Pull Request #2001 · lynx-family/lynx-stack

Sherry-hue · 2025-12-17T08:44:36Z

…to the parent

Summary by CodeRabbit

Bug Fixes
- Resolved an issue where the iframe readiness signal was not consistently reaching the parent window, improving initialization reliability.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

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).

…to the parent

changeset-bot · 2025-12-17T08:44:41Z

🦋 Changeset detected

Latest commit: 7a98269

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

This PR includes changesets to release 1 package

Name	Type
@lynx-js/web-explorer	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 · 2025-12-17T08:44:52Z

📝 Walkthrough

Walkthrough

This PR adds a patch release for @lynx-js/web-explorer that implements an iframe-to-parent readiness handshake. The iframe now actively sends an "iframeReady" message with its iframeId to the parent window, ensuring reliable notification of iframe readiness independent of the parent's load event listeners.

Changes

Cohort / File(s)	Change Summary
Release metadata `\.changeset/few-rats-doubt\.md`	Adds patch release entry documenting the fix for iframe readiness messaging.
Web explorer initialization `packages/web-platform/web-explorer/index\.ts`	Extracts iframeId from URL query parameters and sends an "iframeReady" postMessage to parent window to signal iframe readiness.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Focus on verifying that the iframeId extraction from URLSearchParams is correct and defensive against missing query parameters
Confirm the postMessage payload structure ({ method: 'iframeReady', iframeId }) aligns with parent window listener expectations
Verify that sending to target origin '*' is appropriate for this use case

Possibly related PRs

fix(web): resolve mts freeze issue after reload by ensuring iframe is… #1892 — Implements the complementary parent-side logic that awaits the iframe's readiness message to resolve iframe creation promise

Suggested reviewers

PupilTong

Poem

🐰 A tiny iframe hops up tall,
"I'm ready!" it cries down the hall,
No waiting for parents to guess,
Just sends a message—nothing less!
The handshake complete, all is well. ✨

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	You can run `@coderabbitai generate docstrings` to improve docstring coverage.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'fix(web): web-explorer needs to actively send an iframeReady message' directly and clearly describes the main change in the PR, matching the core objective of adding active iframeReady message sending.

✨ Finishing touches

📝 Generate docstrings

🧪 Generate unit tests (beta)

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

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

coderabbitai

Actionable comments posted: 1

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 27dea6e and 7a98269.

📒 Files selected for processing (2)

.changeset/few-rats-doubt.md (1 hunks)
packages/web-platform/web-explorer/index.ts (1 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

.changeset/*.md

📄 CodeRabbit inference engine (AGENTS.md)

For contributions, generate and commit a Changeset describing your changes

Files:

.changeset/few-rats-doubt.md

🧠 Learnings (5)

📓 Common learnings

Learnt from: colinaaa
Repo: lynx-family/lynx-stack PR: 1454
File: pnpm-workspace.yaml:46-46
Timestamp: 2025-08-07T04:00:59.645Z
Learning: In the lynx-family/lynx-stack repository, the webpack patch (patches/webpack5.101.0.patch) was created to fix issues with webpack5.99.9 but only takes effect on webpack5.100.0 and later versions. The patchedDependencies entry should use "webpack@^5.100.0" to ensure the patch applies to the correct version range.

📚 Learning: 2025-09-12T09:43:04.847Z

Learnt from: gaoachao
Repo: lynx-family/lynx-stack PR: 1736
File: .changeset/spotty-experts-smoke.md:1-3
Timestamp: 2025-09-12T09:43:04.847Z
Learning: In the lynx-family/lynx-stack repository, empty changeset files (containing only `---\n\n---`) are used for internal changes that modify src/** files but don't require meaningful release notes, such as private package changes or testing-only modifications. This satisfies CI requirements without generating user-facing release notes.

Applied to files:

.changeset/few-rats-doubt.md

📚 Learning: 2025-09-12T09:43:04.847Z

Learnt from: gaoachao
Repo: lynx-family/lynx-stack PR: 1736
File: .changeset/spotty-experts-smoke.md:1-3
Timestamp: 2025-09-12T09:43:04.847Z
Learning: In the lynx-family/lynx-stack repository, private packages (marked with "private": true in package.json) like lynx-js/react-transform don't require meaningful changeset entries even when their public APIs change, since they are not published externally and only affect internal development.

Applied to files:

.changeset/few-rats-doubt.md

📚 Learning: 2025-07-22T09:23:07.797Z

Learnt from: colinaaa
Repo: lynx-family/lynx-stack 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.

Applied to files:

.changeset/few-rats-doubt.md

📚 Learning: 2025-08-07T04:00:59.645Z

Learnt from: colinaaa
Repo: lynx-family/lynx-stack PR: 1454
File: pnpm-workspace.yaml:46-46
Timestamp: 2025-08-07T04:00:59.645Z
Learning: In the lynx-family/lynx-stack repository, the webpack patch (patches/webpack5.101.0.patch) was created to fix issues with webpack5.99.9 but only takes effect on webpack5.100.0 and later versions. The patchedDependencies entry should use "webpack@^5.100.0" to ensure the patch applies to the correct version range.

Applied to files:

.changeset/few-rats-doubt.md

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)

GitHub Check: build / Build (Windows)
GitHub Check: test-rust / Test (Ubuntu)

🔇 Additional comments (2)

.changeset/few-rats-doubt.md (1)

1-5: Changeset looks good.

The changeset correctly documents this bugfix as a patch release with a clear description of the race condition being addressed.

packages/web-platform/web-explorer/index.ts (1)

44-44: Verify handling of null iframeId in parent window.

When the iframeId query parameter is not present, URLSearchParams.get() returns null. The iframe sends this null value in the iframeReady message to the parent window. Since the parent window code that receives this message is not found in this repository, verify that the parent correctly handles receiving iframeId: null in the message payload and does not break when this value is null.

packages/web-platform/web-explorer/index.ts

codecov · 2025-12-17T08:49:17Z

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 · 2025-12-17T09:11:34Z

CodSpeed Performance Report

Merging #2001 will improve performance by 8.14%

_{Comparing Sherry-hue:fix/web-explorer-load (7a98269) with main (27dea6e)}

Summary

⚡ 2 improvements
✅ 61 untouched
⏩ 3 skipped¹

Benchmarks breakdown

	Benchmark	`BASE`	`HEAD`	Efficiency
⚡	`basic-performance-nest-level-100`	6.7 ms	6.2 ms	+8.14%
⚡	`transform 1000 view elements`	46.9 ms	43.6 ms	+7.58%

3 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 · 2025-12-17T09:14:17Z

React Example

#6489 Bundle Size — 236.9KiB (0%).

7a98269(current) vs 27dea6e main#6487(baseline)

Bundle metrics no changes

	Current #6489	Baseline #6487
Initial JS	`0B`	`0B`
Initial CSS	`0B`	`0B`
Cache Invalidation	`0%`	`0%`
Chunks	`0`	`0`
Assets	`4`	`4`
Modules	`162`	`162`
Duplicate Modules	`65`	`65`
Duplicate Code	`46.74%`	`46.74%`
Packages	`2`	`2`
Duplicate Packages	`0`	`0`

Bundle size by type no changes

	Current #6489	Baseline #6487
IMG	`145.76KiB`	`145.76KiB`
Other	`91.14KiB`	`91.14KiB`

Bundle analysis report Branch Sherry-hue:fix/web-explorer-load Project dashboard

^{Generated by RelativeCI Documentation Report issue}

relativeci · 2025-12-17T09:14:25Z

Web Explorer

#6649 Bundle Size — 372.63KiB (+0.03%).

7a98269(current) vs 27dea6e main#6647(baseline)

Bundle metrics

2 changes

1 regression

	Current #6649	Baseline #6647
Initial JS	`146.36KiB`(`+0.09%`)	`146.23KiB`
Initial CSS	`32.4KiB`	`32.4KiB`
Cache Invalidation	`39.26%`	`39.25%`
Chunks	`8`	`8`
Assets	`8`	`8`
Modules	`230`	`230`
Duplicate Modules	`16`	`16`
Duplicate Code	`2.97%`	`2.97%`
Packages	`4`	`4`
Duplicate Packages	`0`	`0`

Bundle size by type

1 change

1 regression

	Current #6649	Baseline #6647
JS	`243.25KiB` (`+0.05%`)	`243.12KiB`
Other	`96.98KiB`	`96.98KiB`
CSS	`32.4KiB`	`32.4KiB`

Bundle analysis report Branch Sherry-hue:fix/web-explorer-load Project dashboard

^{Generated by RelativeCI Documentation Report issue}

lynx-family#2001) …to the parent    ## Summary by CodeRabbit * **Bug Fixes** * Resolved an issue where the iframe readiness signal was not consistently reaching the parent window, improving initialization reliability. <sub>✏️ Tip: You can customize this high-level summary in your review settings.</sub>  ## 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).

This PR was opened by the [Changesets release](https://github.com/changesets/action) GitHub action. When you're ready to do a release, you can merge this and the packages will be published to npm automatically. If you're not ready to do a release yet, that's fine, whenever you add more changesets to main, this PR will be updated. # Releases ## @lynx-js/gesture-runtime@2.1.0 ### Minor Changes - Initialize `'@lynx-js/gesture-runtime` ([#1984](#1984)) ## @lynx-js/rspeedy@0.12.3 ### Patch Changes - Support environment variants to enable multiple configurations for the same targets. ([#1969](#1969)) - Updated dependencies \[]: - @lynx-js/web-rsbuild-server-middleware@0.19.2 ## @lynx-js/lynx-bundle-rslib-config@0.0.2 ### Patch Changes - Introduce `@lynx-js/externals-loading-webpack-plugin`. It will help you to load externals built by `@lynx-js/lynx-bundle-rslib-config`. ([#1924](#1924)) ```js // webpack.config.js import { ExternalsLoadingPlugin } from "@lynx-js/externals-loading-webpack-plugin"; export default { plugins: [ new ExternalsLoadingPlugin({ mainThreadLayer: "main-thread", backgroundLayer: "background", externals: { lodash: { url: "http://lodash.lynx.bundle", background: { sectionPath: "background" }, mainThread: { sectionPath: "main-thread" }, }, }, }), ], }; ``` ## @lynx-js/react-rsbuild-plugin@0.12.2 ### Patch Changes - Support environment variants to enable multiple configurations for the same targets. ([#1969](#1969)) - Updated dependencies \[]: - @lynx-js/react-alias-rsbuild-plugin@0.12.2 ## @lynx-js/web-constants@0.19.2 ### Patch Changes - Updated dependencies \[]: - @lynx-js/web-worker-rpc@0.19.2 ## @lynx-js/web-core@0.19.2 ### Patch Changes - chore: mark the "multi-thread" deprecated ([#2030](#2030)) **NOTICE This will be a breaking change in the future** mark the thread strategy "multi-thread" as deprecated. Please use "all-on-ui" instead. If you still want to use multi-thread mode, please try to use a cross-origin isolated iframe. A console warning will be printed if `thread-strategy` is set to `multi-thread`. - fix csp issue for mts realm ([#1998](#1998)) - Updated dependencies \[]: - @lynx-js/web-constants@0.19.2 - @lynx-js/web-mainthread-apis@0.19.2 - @lynx-js/web-worker-rpc@0.19.2 - @lynx-js/web-worker-runtime@0.19.2 ## @lynx-js/web-explorer@0.0.15 ### Patch Changes - fix: web-explorer needs to actively send an iframeReady message to the parent, the parent uses `iframe load` listener cannot guarantee that the `message-listener` will complete execution. ([#2001](#2001)) ## @lynx-js/web-mainthread-apis@0.19.2 ### Patch Changes - Updated dependencies \[]: - @lynx-js/web-constants@0.19.2 ## @lynx-js/web-worker-runtime@0.19.2 ### Patch Changes - Updated dependencies \[]: - @lynx-js/web-constants@0.19.2 - @lynx-js/web-mainthread-apis@0.19.2 - @lynx-js/web-worker-rpc@0.19.2 ## @lynx-js/externals-loading-webpack-plugin@0.0.1 ### Patch Changes - Introduce `@lynx-js/externals-loading-webpack-plugin`. It will help you to load externals built by `@lynx-js/lynx-bundle-rslib-config`. ([#1924](#1924)) ```js // webpack.config.js import { ExternalsLoadingPlugin } from "@lynx-js/externals-loading-webpack-plugin"; export default { plugins: [ new ExternalsLoadingPlugin({ mainThreadLayer: "main-thread", backgroundLayer: "background", externals: { lodash: { url: "http://lodash.lynx.bundle", background: { sectionPath: "background" }, mainThread: { sectionPath: "main-thread" }, }, }, }), ], }; ``` ## create-rspeedy@0.12.3 ## @lynx-js/react-alias-rsbuild-plugin@0.12.2 ## upgrade-rspeedy@0.12.3 ## @lynx-js/web-core-server@0.19.2 ## @lynx-js/web-rsbuild-server-middleware@0.19.2 ## @lynx-js/web-worker-rpc@0.19.2 Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

fix(web): web-explorer needs to actively send an iframeReady message …

7a98269

…to the parent

Sherry-hue self-assigned this Dec 17, 2025

Sherry-hue requested a review from PupilTong as a code owner December 17, 2025 08:44

Sherry-hue added this to Lynx for Web Dec 17, 2025

Sherry-hue added the platform:Web label Dec 17, 2025

coderabbitai bot reviewed Dec 17, 2025

View reviewed changes

packages/web-platform/web-explorer/index.ts Show resolved Hide resolved

PupilTong approved these changes Dec 17, 2025

View reviewed changes

Sherry-hue merged commit 3a9a730 into lynx-family:main Dec 17, 2025
81 of 85 checks passed

github-project-automation bot moved this to Done in Lynx for Web Dec 17, 2025

PupilTong approved these changes Dec 17, 2025

View reviewed changes

github-actions bot mentioned this pull request Dec 17, 2025

chore: Release 2025-12-22 04:06:36 #1999

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(web): web-explorer needs to actively send an iframeReady message …#2001

fix(web): web-explorer needs to actively send an iframeReady message …#2001
Sherry-hue merged 1 commit intolynx-family:mainfrom
Sherry-hue:fix/web-explorer-load

Sherry-hue commented Dec 17, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

changeset-bot bot commented Dec 17, 2025

Uh oh!

coderabbitai bot commented Dec 17, 2025 •

edited

Loading

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

Suggested reviewers

Poem

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

codecov bot commented Dec 17, 2025 •

edited

Loading

Uh oh!

codspeed-hq bot commented Dec 17, 2025 •

edited

Loading

Uh oh!

relativeci bot commented Dec 17, 2025 •

edited

Loading

Uh oh!

relativeci bot commented Dec 17, 2025 •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

Sherry-hue commented Dec 17, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Checklist

Uh oh!

changeset-bot bot commented Dec 17, 2025

🦋 Changeset detected

Uh oh!

coderabbitai bot commented Dec 17, 2025 • 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

Poem

Pre-merge checks and finishing touches

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

codecov bot commented Dec 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

codspeed-hq bot commented Dec 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

CodSpeed Performance Report

Merging #2001 will improve performance by 8.14%

Summary

Benchmarks breakdown

Footnotes

Uh oh!

relativeci bot commented Dec 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

React Example

#6489 Bundle Size — 236.9KiB (0%).

Uh oh!

relativeci bot commented Dec 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Web Explorer

#6649 Bundle Size — 372.63KiB (+0.03%).

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Sherry-hue commented Dec 17, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Dec 17, 2025 •

edited

Loading

codecov bot commented Dec 17, 2025 •

edited

Loading

codspeed-hq bot commented Dec 17, 2025 •

edited

Loading

relativeci bot commented Dec 17, 2025 •

edited

Loading

relativeci bot commented Dec 17, 2025 •

edited

Loading