[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

Draft detected.

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

alexeyr-ci · 2024-12-12T13:26:26Z

lib/react_on_rails/configuration.rb

+      force_load: false,
+      auto_load_server_components: true,
+      rsc_rendering_url: DEFAULT_RSC_RENDERING_URL


I think we can easily update Configuration so adding new options at least has to change only 2 places, not 4 :) Do you expect to need more changes like this soon?

I don't think I will need to add more configs like this soon. But it's useful if you want to implement a helper function.

It wouldn't be a helper function, just initialize to default values directly in the constructor and remove constructor parameters since we never end up using them (at least in RORP, need to double-check ROR before doing that).

I can wait until your PRs are merged to avoid conflicts anyway.

alexeyr-ci · 2024-12-12T13:27:57Z

lib/react_on_rails/helper.rb

@@ -401,6 +403,17 @@ def run_stream_inside_fiber
      rendering_fiber.resume
    end

+    def registered_stores
+      (@registered_stores || []) + (@registered_stores_defer_render || [])


Can we initialize the variables with [] and avoid needing || here?

alexeyr-ci · 2024-12-12T13:31:45Z

lib/react_on_rails/helper.rb

+      add_component_to_pending_hydration_code = "window.#{ADD_COMPONENT_TO_PENDING_HYDRATION_FUNCTION}('#{dom_id}');"
+      hydrate_script = dom_id.present? ? content_tag(:script, add_component_to_pending_hydration_code.html_safe) : ""


I think it's a bit clearer like this:

Suggested change

add_component_to_pending_hydration_code = "window.#{ADD_COMPONENT_TO_PENDING_HYDRATION_FUNCTION}('#{dom_id}');"

hydrate_script = dom_id.present? ? content_tag(:script, add_component_to_pending_hydration_code.html_safe) : ""

hydrate_script = if dom_id.present?

add_component_to_pending_hydration_code = "window.#{ADD_COMPONENT_TO_PENDING_HYDRATION_FUNCTION}('#{dom_id}');"

content_tag(:script, add_component_to_pending_hydration_code.html_safe)

else

""

alexeyr-ci · 2024-12-12T13:37:44Z

node_package/src/ComponentRegistry.ts

 import isRenderFunction from './isRenderFunction';

 const registeredComponents = new Map<string, RegisteredComponent>();
+const registrationCallbacks = new Map<string, Array<(component: RegisteredComponent) => void>>();


Better give a name to the callback type (here if it isn't used anywhere else, in ./types/index.ts if it is).

alexeyr-ci · 2024-12-12T13:38:13Z

node_package/src/ComponentRegistry.ts

@@ -1,9 +1,33 @@
-import type { RegisteredComponent, ReactComponentOrRenderFunction, RenderFunction } from './types/index';
+import React from 'react';
+import type { RegisteredComponent, ReactComponentOrRenderFunction, RenderFunction, ReactComponent } from './types/index';


While changing this anyway, can simplify the import to ./types.

alexeyr-ci · 2024-12-12T13:40:33Z

node_package/src/ComponentRegistry.ts

    });
  },

+  registerServerComponent(...componentNames: string[]): void {
+    // eslint-disable-next-line global-require, @typescript-eslint/no-var-requires
+    const RSCClientRoot = require('./RSCClientRoot').default;


For better types:

Suggested change

const RSCClientRoot = require('./RSCClientRoot').default;

const RSCClientRoot = (require('./RSCClientRoot') as typeof(import('./RSCClientRoot'))).default;

alexeyr-ci · 2024-12-12T13:42:11Z

node_package/src/RSCClientRoot.ts

+import RSDWClient from 'react-server-dom-webpack/client';
+
+if (!('use' in React)) {
+  throw new Error('React.use is not defined. Please ensure you are using React 18.3.0-canary-670811593-20240322 or later to use server components.');


18.3.0 would count as later but doesn't support RSC, so the message can be improved.

alexeyr-ci · 2024-12-12T13:44:26Z

node_package/src/RSCClientRoot.ts

+}
+
+// It's not the exact type, but it's close enough for now
+type Use = <T>(promise: Promise<T>) => T;


Can we update @types/react to 19 even if we don't update React itself yet? If not, leave a comment to remove it once we update to 19.

alexeyr-ci · 2024-12-12T13:45:38Z

node_package/src/ReactOnRailsRSC.ts

@@ -29,7 +28,7 @@ const stringToStream = (str: string) => {
 const getBundleConfig = () => {
  const bundleConfig = JSON.parse(fs.readFileSync('./public/webpack/development/react-client-manifest.json', 'utf8'));
  // remove file:// from keys
-  const newBundleConfig: { [key: string]: any } = {};
+  const newBundleConfig: { [key: string]: unknown } = {};


This change can go into the previous PR already, no?

alexeyr-ci · 2024-12-12T13:46:36Z

node_package/src/StoreRegistry.ts

+      callbacks.forEach(callback => {
+        setTimeout(() => callback(store), 0);
+      });


This ends up duplicated several times with different callbacks, extract it?

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

AbanoubGhadban added 2 commits December 6, 2024 11:06

hydrate the component immediately when loaded and registered

45b51a6

auto register server components and immediately hydrate stores

de85fb4

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

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[WIP] Hydrate components immediately after downloading chunks #1656

[WIP] Hydrate components immediately after downloading chunks #1656

AbanoubGhadban commented Nov 19, 2024 •

edited by justin808

Loading

coderabbitai bot commented Nov 19, 2024

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

alexeyr-ci Dec 12, 2024

AbanoubGhadban Dec 12, 2024

alexeyr-ci Dec 12, 2024

alexeyr-ci Dec 12, 2024

alexeyr-ci Dec 12, 2024

alexeyr-ci Dec 12, 2024

alexeyr-ci Dec 12, 2024

alexeyr-ci Dec 12, 2024

alexeyr-ci Dec 12, 2024

alexeyr-ci Dec 12, 2024

alexeyr-ci Dec 12, 2024

alexeyr-ci Dec 12, 2024

		add_component_to_pending_hydration_code = "window.#{ADD_COMPONENT_TO_PENDING_HYDRATION_FUNCTION}('#{dom_id}');"
		hydrate_script = dom_id.present? ? content_tag(:script, add_component_to_pending_hydration_code.html_safe) : ""

	const RSCClientRoot = require('./RSCClientRoot').default;
	const RSCClientRoot = (require('./RSCClientRoot') as typeof(import('./RSCClientRoot'))).default;

[WIP] Hydrate components immediately after downloading chunks #1656

Are you sure you want to change the base?

[WIP] Hydrate components immediately after downloading chunks #1656

Conversation

AbanoubGhadban commented Nov 19, 2024 • edited by justin808 Loading

Summary

Pull Request checklist

Other Information

coderabbitai bot commented Nov 19, 2024

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

AbanoubGhadban commented Nov 19, 2024 •

edited by justin808

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)