Handle errors happen during streaming components

[AbanoubGhadban]

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 

Summary by CodeRabbit

• New Features

  • Introduced streaming capabilities for server-rendered React components.
  • Added functionality to skip initial console messages during replay.

• Bug Fixes

  • Enhanced error handling during server rendering processes.

• Documentation

  • Updated test cases to focus on rendered output rather than internal component structure.

• Chores

  • Upgraded React and its type definitions to the latest version for improved performance and compatibility.
  • Updated Webpack configuration for better browser compatibility with Node.js features.

[coderabbitai[bot]]

Walkthrough

The changes introduce enhancements to the ReactOnRails library, focusing on error handling and control flow for rendering React components. Key additions include the raise_prerender_error and should_raise_streaming_prerender_error? methods in the helper module, as well as new methods in the RenderOptions class to manage server rendering errors. The serverRenderReactComponent.ts file has been updated to improve streaming logic and error management, ensuring a more robust server-side rendering process.

Changes

File	Change Summary
lib/react_on_rails/helper.rb	Added raise_prerender_error and should_raise_streaming_prerender_error? methods for improved error handling.
lib/react_on_rails/react_component/render_options.rb	Added raise_non_shell_server_rendering_errors and retrieve_react_on_rails_pro_config_value_for methods.
node_package/src/serverRenderReactComponent.ts	Updated stream handling logic and enhanced error management in streamServerRenderedReactComponent.
node_package/src/types/index.ts	Updated RenderResult interface to include optional isShellReady property.
node_package/tests/streamServerRenderedReactComponent.test.jsx	Introduced tests for streamServerRenderedReactComponent to validate streaming behavior and error handling.
package.json	Updated react and react-dom dependencies to specific canary versions.

Possibly related PRs

• #1633: This PR adds support for streaming rendered components using renderToPipeableStream, which directly relates to the enhancements in error handling and rendering logic in the main PR, particularly for streamed React components.
• #1647: This PR introduces support for console replay while streaming components, which complements the error handling improvements made in the main PR by enhancing debugging capabilities during the rendering process.
• #1649: This PR focuses on adding support for replaying logs from asynchronous server operations, which aligns with the error handling and rendering improvements in the main PR.
• #1653: This PR refactors the serverRenderReactComponent function, which is closely related to the changes in the main PR that enhance the rendering logic and error handling for React components.

Suggested reviewers

• Justin808
• Alexeyr-ci

🐇 In the garden, hopping about,
New features sprout, without a doubt.
Streams of React, flowing with grace,
Errors handled, in their place.
With tests now set, all is bright,
A joyful code, in morning light! 🌼

---

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

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