[WIP] Hydrate components immediately after downloading chunks #1656

AbanoubGhadban · 2024-11-19T11:51:37Z

Summary

Remove this paragraph and provide a general description of the code changes in your pull
request... were there any bugs you had fixed? If so, mention them. If
these bugs have open GitHub issues, be sure to tag them here as well,
to keep the conversation linked together.

Pull Request checklist

Remove this line after checking all the items here. If the item is not applicable to the PR, both check it out and wrap it by ~.

Add/update test to cover these changes
Update documentation
Update CHANGELOG file
Add the CHANGELOG entry at the top of the file.

Other Information

Remove this paragraph and mention any other important and relevant information such as benchmarks.

This change is

coderabbitai · 2024-11-19T11:51:45Z

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

🪧 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.
- Generate unit testing code for this file.
- 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 generate unit testing code for this file.
- @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 generate unit testing code.
- @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.

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. (Beta)
@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.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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.

lib/react_on_rails/configuration.rb

lib/react_on_rails/helper.rb

node_package/src/ComponentRegistry.ts

node_package/src/RSCClientRoot.ts

node_package/src/ReactOnRailsRSC.ts

node_package/src/StoreRegistry.ts

Judahmeek

Other small issues on the side, the primary implementation of using a CallbackRegistry looks good.

Judahmeek · 2025-01-14T04:41:14Z

lib/react_on_rails/helper.rb

+      end

-      result << all_stores.each_with_object(declarations) do |redux_store_data, memo|
+      result << store_objects.each_with_object(declarations) do |redux_store_data, memo|


How do we make sure that registered stores that aren't listed in the store_dependencies don't slip through the cracks?

Should we throw a warning if a store is registered that isn't listed in store_dependencies?

Judahmeek · 2025-01-14T04:45:25Z

lib/react_on_rails/packs_generator.rb

+      content = File.read(file_path)
+      # has "use client" directive. It can be "use client" or 'use client'
+      first_js_statement_in_code(content).match?(/^["']use client["'](?:;|\s|$)/)
+    end


Is all this necessary?

Client & server entrypoints should be detectable by their filenames.

React server and client components differ significantly from the server and client files in React on Rails:

React on Rails server and client files:
In this system, packs/*.server.js files are bundled into the server bundle, while *.client.js files are bundled into the client bundle.

React server and client components:
This is a new system introduced by React itself. By default, all components are considered server components and are excluded from the client bundle. To designate a component as a client component (an entry point for the client bundle), the "use client"; directive must be added at the top of the file. This system is part of React’s core functionality, not specific to React on Rails.

This code ensures compatibility between both systems within React on Rails.

Judahmeek · 2025-01-14T05:01:11Z

lib/react_on_rails/test_helper/webpack_assets_status_checker.rb

-            if bundle_name == ReactOnRails.configuration.server_bundle_js_file
-              ReactOnRails::Utils.server_bundle_js_file_path
+            if bundle_name == ReactOnRails.configuration.react_client_manifest_file
+              ReactOnRails::Utils.react_client_manifest_file_path


This doesn't make sense.

Neither the ReactOnRails.configuration.react_client_manifest_file or the ReactOnRails::Utils.react_client_manifest_file_path currently exist.

Also, I don't see why you would want to replace the server_bundle_js_file reference with a react_client_manifest_file reference when the bundle_js_file_path below basically does the same thing.

Reverted. This code has been moved to PR #1663, which introduced ReactOnRails.configuration.react_client_manifest_file.

I did not replace the server_bundle_js_file reference with the react_client_manifest_file reference because the original code appears to have been written a long time ago when the server bundle path was handled differently. However, with the current implementation, the following code:

if bundle_name == ReactOnRails.configuration.server_bundle_js_file ReactOnRails::Utils.server_bundle_js_file_path else ReactOnRails::Utils.bundle_js_file_path(bundle_name) end

is now effectively equivalent to:

ReactOnRails::Utils.bundle_js_file_path(bundle_name)

This is because server_bundle_js_file_path internally calls bundle_js_file_path(ReactOnRails.configuration.server_bundle_js_file). Therefore, the updated code you mentioned enables locating the react-client-manifest file path rather than simply replacing server_bundle with react-client-manifest.

…le and refactor

…nt bundle increase

* stream rsc payload in json objects like streamed react components * make path to rsc bundle and react client manifest configurable * feat: Improve client manifest path handling for dev server - Add `dev_server_url` helper to centralize dev server URL construction - Add `public_output_uri_path` to get relative webpack output path - Add `asset_uri_from_packer` to handle asset URIs consistently - Update `react_client_manifest_file_path` to return dev server URLs when appropriate - Add comprehensive specs for new asset URI handling This change ensures client manifest paths are properly resolved to dev server URLs during development, improving hot-reloading functionality. * fix: normalize RSC URL path by absorbing leading/trailing slashes * specify Shakapacker as top-level module * add tests for RSCClientRoot * Make RSCClientRoot tests run with react 18 * Update webpack asset path configuration for client manifest --------- Co-authored-by: Judah Meek <[email protected]>

This reverts commit be85e6b.

This reverts commit fb12a56.

* hydrate the component immediately when loaded and registered * auto register server components and immediately hydrate stores * move react-server-dom-webpack.d.ts to types directory * ensure to initialize registered stores array before accessing * refactor registration callback into separate class * make the early hydration compatible with turbopack, backward compatible and refactor * pass rsc path to RSC Client Root and move the config to RORP * update min node version to 18 * export registerServerComponent as a separate entrypoint to avoid client bundle increase * Update webpack assets status checker to use server bundle configuration * Update webpack assets status checker to handle bundle file paths * [WIP] handle errors happen in rsc payload (#1663) * stream rsc payload in json objects like streamed react components * make path to rsc bundle and react client manifest configurable * feat: Improve client manifest path handling for dev server - Add `dev_server_url` helper to centralize dev server URL construction - Add `public_output_uri_path` to get relative webpack output path - Add `asset_uri_from_packer` to handle asset URIs consistently - Update `react_client_manifest_file_path` to return dev server URLs when appropriate - Add comprehensive specs for new asset URI handling This change ensures client manifest paths are properly resolved to dev server URLs during development, improving hot-reloading functionality. * fix: normalize RSC URL path by absorbing leading/trailing slashes * specify Shakapacker as top-level module * add tests for RSCClientRoot * Make RSCClientRoot tests run with react 18 * Update webpack asset path configuration for client manifest --------- Co-authored-by: Judah Meek <[email protected]>

AbanoubGhadban changed the title ~~Hydrate components immediately after downloading chunks~~ [WIP] Hydrate components immediately after downloading chunks Nov 22, 2024

AbanoubGhadban force-pushed the abanoubghadban/pro425/hydrate-components-immediately-after-downloading-chunks branch from 7d6577c to de85fb4 Compare December 6, 2024 09:07

alexeyr-ci reviewed Dec 12, 2024

View reviewed changes

AbanoubGhadban force-pushed the abanoubghadban/pro425/hydrate-components-immediately-after-downloading-chunks branch from c676342 to 266acae Compare December 18, 2024 10:20

AbanoubGhadban force-pushed the abanoubghadban/pro362-add-support-for-RSC branch from eb0edbd to 07e701e Compare December 24, 2024 09:12

AbanoubGhadban force-pushed the abanoubghadban/pro425/hydrate-components-immediately-after-downloading-chunks branch from f2242c4 to a761735 Compare December 24, 2024 09:16

Judahmeek reviewed Jan 14, 2025

View reviewed changes

AbanoubGhadban force-pushed the abanoubghadban/pro362-add-support-for-RSC branch from 07e701e to 666dc98 Compare January 16, 2025 13:26

AbanoubGhadban force-pushed the abanoubghadban/pro425/hydrate-components-immediately-after-downloading-chunks branch from 1f3e921 to 999312d Compare January 16, 2025 13:31

alexeyr-ci mentioned this pull request Jan 24, 2025

Format all file types supported by Prettier #1686

Merged

3 tasks

AbanoubGhadban force-pushed the abanoubghadban/pro362-add-support-for-RSC branch from 666dc98 to 9ea28f4 Compare January 25, 2025 14:05

AbanoubGhadban force-pushed the abanoubghadban/pro425/hydrate-components-immediately-after-downloading-chunks branch from 999312d to aeaeca4 Compare January 25, 2025 14:38

AbanoubGhadban added 8 commits January 25, 2025 17:15

hydrate the component immediately when loaded and registered

16078ef

auto register server components and immediately hydrate stores

2ceec94

move react-server-dom-webpack.d.ts to types directory

b1a886b

ensure to initialize registered stores array before accessing

2c4fae3

refactoring

c547b75

refactor registration callback into separate class

0bc967c

make the early hydration compatible with turbopack, backward compatib…

78aaa28

…le and refactor

pass rsc path to RSC Client Root and move the config to RORP

58fd819

AbanoubGhadban force-pushed the abanoubghadban/pro425/hydrate-components-immediately-after-downloading-chunks branch from aeaeca4 to 58fd819 Compare January 25, 2025 15:16

AbanoubGhadban added 5 commits January 26, 2025 11:49

update min node version to 18

e7c80c3

export registerServerComponent as a separate entrypoint to avoid clie…

d972901

…nt bundle increase

linting

c6b0e1f

Update webpack assets status checker to use server bundle configuration

0d8842b

Update webpack assets status checker to handle bundle file paths

94131d9

AbanoubGhadban requested a review from alexeyr-ci January 27, 2025 15:46

AbanoubGhadban and others added 2 commits January 29, 2025 18:02

Empty commit to trigger new CI build

96d10ea

AbanoubGhadban added 4 commits January 30, 2025 22:46

Simplify build script for react-on-rails package

fb12a56

Add logging to prepack and prepare npm scripts

be85e6b

Revert "Add logging to prepack and prepare npm scripts"

9b36013

This reverts commit be85e6b.

Revert "Simplify build script for react-on-rails package"

402bd8f

This reverts commit fb12a56.

Judahmeek marked this pull request as ready for review January 31, 2025 23:32

Judahmeek merged commit edb68cc into abanoubghadban/pro362-add-support-for-RSC Jan 31, 2025
11 checks passed

Judahmeek deleted the abanoubghadban/pro425/hydrate-components-immediately-after-downloading-chunks branch January 31, 2025 23:33

Uh oh!

[WIP] Hydrate components immediately after downloading chunks #1656

[WIP] Hydrate components immediately after downloading chunks #1656

Uh oh!

Conversation

AbanoubGhadban commented Nov 19, 2024 • edited by justin808 Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Pull Request checklist

Other Information

Uh oh!

coderabbitai bot commented Nov 19, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Judahmeek left a comment

Choose a reason for hiding this comment

Uh oh!

Judahmeek Jan 14, 2025

Choose a reason for hiding this comment

Uh oh!

Judahmeek Jan 14, 2025

Choose a reason for hiding this comment

Uh oh!

AbanoubGhadban Jan 27, 2025

Choose a reason for hiding this comment

Uh oh!

Judahmeek Jan 14, 2025

Choose a reason for hiding this comment

Uh oh!

AbanoubGhadban Jan 27, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

AbanoubGhadban commented Nov 19, 2024 •

edited by justin808

Loading

coderabbitai bot commented Nov 19, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)