-
-
Notifications
You must be signed in to change notification settings - Fork 637
Add async_react_component and cached_async_react_component helpers #2139
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 2 commits
5d78a83
8aaf212
d03434d
38d0dfd
a3baa6c
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| # frozen_string_literal: true | ||
|
|
||
| module ReactOnRailsPro | ||
| # AsyncValue wraps an Async task to provide a simple interface for | ||
| # retrieving the result of an async react_component render. | ||
| # | ||
| # @example | ||
| # async_value = async_react_component("MyComponent", props: { name: "World" }) | ||
| # # ... do other work ... | ||
| # html = async_value.value # blocks until result is ready | ||
| # | ||
| class AsyncValue | ||
| attr_reader :component_name | ||
|
|
||
| def initialize(component_name:, task:) | ||
| @component_name = component_name | ||
| @task = task | ||
| end | ||
|
|
||
| # Blocks until result is ready, returns HTML string. | ||
| # If the async task raised an exception, it will be re-raised here. | ||
| def value | ||
| @task.wait | ||
| end | ||
|
|
||
| def resolved? | ||
| @task.finished? | ||
| end | ||
|
|
||
| def to_s | ||
| value.to_s | ||
| end | ||
|
|
||
| def html_safe | ||
| value.html_safe | ||
| end | ||
| end | ||
| end | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,68 @@ | ||
| # frozen_string_literal: true | ||
|
|
||
| module ReactOnRailsPro | ||
| # AsyncRendering enables concurrent rendering of multiple React components. | ||
| # When enabled, async_react_component calls will execute their HTTP requests | ||
| # in parallel instead of sequentially. | ||
| # | ||
| # @example Enable for all actions | ||
| # class ProductsController < ApplicationController | ||
| # include ReactOnRailsPro::AsyncRendering | ||
| # enable_async_react_rendering | ||
| # end | ||
| # | ||
| # @example Enable for specific actions only | ||
| # class ProductsController < ApplicationController | ||
| # include ReactOnRailsPro::AsyncRendering | ||
| # enable_async_react_rendering only: [:show, :index] | ||
| # end | ||
| # | ||
| # @example Enable for all except specific actions | ||
| # class ProductsController < ApplicationController | ||
| # include ReactOnRailsPro::AsyncRendering | ||
| # enable_async_react_rendering except: [:create, :update] | ||
| # end | ||
| # | ||
| module AsyncRendering | ||
| extend ActiveSupport::Concern | ||
|
|
||
| class_methods do | ||
| # Enables async React component rendering for controller actions. | ||
| # Accepts standard Rails filter options like :only and :except. | ||
| # | ||
| # @param options [Hash] Options passed to around_action (e.g., only:, except:) | ||
| def enable_async_react_rendering(**options) | ||
| around_action :wrap_in_async_react_context, **options | ||
| end | ||
| end | ||
|
|
||
| private | ||
|
|
||
| def wrap_in_async_react_context | ||
| require "async" | ||
| require "async/barrier" | ||
|
|
||
| Sync do | ||
| @react_on_rails_async_barrier = Async::Barrier.new | ||
| yield | ||
| check_for_unresolved_async_components | ||
| ensure | ||
| @react_on_rails_async_barrier&.stop | ||
| @react_on_rails_async_barrier = nil | ||
| end | ||
| end | ||
|
|
||
| def check_for_unresolved_async_components | ||
| return if @react_on_rails_async_barrier.nil? | ||
|
|
||
| pending_tasks = @react_on_rails_async_barrier.size | ||
| return if pending_tasks.zero? | ||
|
|
||
| Rails.logger.error( | ||
| "[React on Rails Pro] #{pending_tasks} async component(s) were started but never resolved. " \ | ||
| "Make sure to call .value on all AsyncValue objects returned by async_react_component " \ | ||
| "or cached_async_react_component. Unresolved tasks will be stopped." | ||
| ) | ||
| end | ||
| end | ||
| end |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| # frozen_string_literal: true | ||
|
|
||
| module ReactOnRailsPro | ||
| # ImmediateAsyncValue is returned when a cached_async_react_component call | ||
| # has a cache hit. It provides the same interface as AsyncValue but returns | ||
AbanoubGhadban marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| # the cached value immediately without any async operations. | ||
| # | ||
| class ImmediateAsyncValue | ||
| def initialize(value) | ||
| @value = value | ||
| end | ||
|
|
||
| attr_reader :value | ||
|
|
||
| def resolved? | ||
| true | ||
| end | ||
|
|
||
| def to_s | ||
| @value.to_s | ||
| end | ||
|
|
||
| def html_safe | ||
| @value.html_safe | ||
| end | ||
| end | ||
| end | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| <h1>Async React Components Demo</h1> | ||
| <p> | ||
| This page renders 10 React components, each with a 1-second delay. | ||
| <br> | ||
| <strong>Sequential rendering:</strong> ~10 seconds | ||
| <br> | ||
| <strong>Concurrent rendering (async_react_component):</strong> ~1 second | ||
| </p> | ||
|
|
||
| <% start_time = Time.now %> | ||
|
|
||
| <% | ||
| # Start all 10 async renders immediately (non-blocking) | ||
| components = 10.times.map do |i| | ||
| async_react_component( | ||
| "DelayedComponent", | ||
| props: { index: i + 1, delayMs: 1000 }, | ||
| prerender: true | ||
| ) | ||
| end | ||
| %> | ||
|
|
||
| <div id="components-container"> | ||
| <% components.each do |component| %> | ||
| <%= component.value %> | ||
| <% end %> | ||
| </div> | ||
|
|
||
| <% elapsed = Time.now - start_time %> | ||
| <p> | ||
| <strong>Total render time:</strong> <%= (elapsed * 1000).round %>ms | ||
| <br> | ||
| <em>If this is close to 1 second instead of 10 seconds, concurrent rendering is working!</em> | ||
| </p> |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| 'use client'; | ||
|
|
||
| import React from 'react'; | ||
|
|
||
| // Client-side version of DelayedComponent (no delay needed on client) | ||
| const DelayedComponent = ({ index, delayMs = 1000 }) => ( | ||
| <div style={{ padding: '10px', margin: '5px', border: '1px solid #ccc' }}> | ||
| <strong>Component {index}</strong> - Rendered after {delayMs}ms delay | ||
| </div> | ||
| ); | ||
|
|
||
| export default DelayedComponent; |
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,21 @@ | ||||||||||||||||||||||||||||||||||||||||||
| 'use client'; | ||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||
| import React from 'react'; | ||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||
| // Component that simulates a slow render by delaying for 1 second | ||||||||||||||||||||||||||||||||||||||||||
| // Used to demonstrate concurrent rendering with async_react_component | ||||||||||||||||||||||||||||||||||||||||||
| const DelayedComponent = ({ index, delayMs = 1000 }) => ( | ||||||||||||||||||||||||||||||||||||||||||
| <div style={{ padding: '10px', margin: '5px', border: '1px solid #ccc' }}> | ||||||||||||||||||||||||||||||||||||||||||
| <strong>Component {index}</strong> - Rendered after {delayMs}ms delay | ||||||||||||||||||||||||||||||||||||||||||
| </div> | ||||||||||||||||||||||||||||||||||||||||||
| ); | ||||||||||||||||||||||||||||||||||||||||||
|
Comment on lines
+1
to
+11
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove 'use client' directive from server component file. The file is named
Based on the async function export pattern (Lines 14-21) and the server-side delay simulation, this should be a server component. Apply this diff to remove the directive: -'use client';
-
import React from 'react';📝 Committable suggestion
Suggested change
🧰 Tools🪛 GitHub Actions: React on Rails Pro - Lint[error] 1-1: ESLint: 'no-promise-executor-return' violation. Return values from promise executor functions cannot be read. (no-promise-executor-return) 🤖 Prompt for AI Agents |
||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||
| // Async render function that delays for specified time before returning | ||||||||||||||||||||||||||||||||||||||||||
| export default async (props, _railsContext) => { | ||||||||||||||||||||||||||||||||||||||||||
| const { delayMs = 1000 } = props; | ||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||
| // Simulate slow server-side data fetching | ||||||||||||||||||||||||||||||||||||||||||
| await new Promise((resolve) => setTimeout(resolve, delayMs)); | ||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||
| return () => <DelayedComponent {...props} />; | ||||||||||||||||||||||||||||||||||||||||||
| }; | ||||||||||||||||||||||||||||||||||||||||||
coderabbitai[bot] marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||||||||||||||||||||||||||||||||||||||
Uh oh!
There was an error while loading. Please reload this page.