|
| 1 | +# frozen_string_literal: true |
| 2 | + |
| 3 | +require "rails_helper" |
| 4 | + |
| 5 | +# Integration tests for incremental rendering with bidirectional streaming |
| 6 | +# |
| 7 | +# IMPORTANT: These tests require a running node-renderer server. |
| 8 | +# Before running these tests: |
| 9 | +# 1. cd packages/node-renderer |
| 10 | +# 2. yarn test:setup # or equivalent command to start the test server |
| 11 | +# 3. Keep the server running in a separate terminal |
| 12 | +# |
| 13 | +# Then run these tests: |
| 14 | +# bundle exec rspec spec/requests/incremental_rendering_integration_spec.rb |
| 15 | +# |
| 16 | +describe "Incremental Rendering Integration", :integration do |
| 17 | + let(:server_bundle_hash) { "test_incremental_bundle" } |
| 18 | + # Fixture bundle paths (real files on disk) |
| 19 | + let(:fixture_bundle_path) do |
| 20 | + File.expand_path( |
| 21 | + "../../../../packages/node-renderer/tests/fixtures/bundle-incremental.js", |
| 22 | + __dir__ |
| 23 | + ) |
| 24 | + end |
| 25 | + let(:fixture_rsc_bundle_path) do |
| 26 | + File.expand_path( |
| 27 | + "../../../../packages/node-renderer/tests/fixtures/secondary-bundle-incremental.js", |
| 28 | + __dir__ |
| 29 | + ) |
| 30 | + end |
| 31 | + let(:rsc_bundle_hash) { "test_incremental_rsc_bundle" } |
| 32 | + |
| 33 | + before do |
| 34 | + allow(ReactOnRailsPro::ServerRenderingPool::NodeRenderingPool).to receive_messages( |
| 35 | + server_bundle_hash: server_bundle_hash, |
| 36 | + rsc_bundle_hash: rsc_bundle_hash, |
| 37 | + renderer_bundle_file_name: "#{server_bundle_hash}.js", |
| 38 | + rsc_renderer_bundle_file_name: "#{rsc_bundle_hash}.js" |
| 39 | + ) |
| 40 | + |
| 41 | + # Enable RSC support for these tests |
| 42 | + allow(ReactOnRailsPro.configuration).to receive(:enable_rsc_support).and_return(true) |
| 43 | + |
| 44 | + # Mock populate_form_with_bundle_and_assets to use fixture bundles directly |
| 45 | + # rubocop:disable Lint/UnusedBlockArgument |
| 46 | + allow(ReactOnRailsPro::Request).to receive(:populate_form_with_bundle_and_assets) do |form, check_bundle:| |
| 47 | + # rubocop:enable Lint/UnusedBlockArgument |
| 48 | + form["bundle_#{server_bundle_hash}"] = { |
| 49 | + body: Pathname.new(fixture_bundle_path), |
| 50 | + content_type: "text/javascript", |
| 51 | + filename: "#{server_bundle_hash}.js" |
| 52 | + } |
| 53 | + |
| 54 | + form["bundle_#{rsc_bundle_hash}"] = { |
| 55 | + body: Pathname.new(fixture_rsc_bundle_path), |
| 56 | + content_type: "text/javascript", |
| 57 | + filename: "#{rsc_bundle_hash}.js" |
| 58 | + } |
| 59 | + end |
| 60 | + |
| 61 | + # Mock AsyncPropsEmitter chunk generation methods to work with fixture bundles |
| 62 | + # Only mock the chunk generation, not the actual call/streaming logic |
| 63 | + # rubocop:disable RSpec/AnyInstance |
| 64 | + allow_any_instance_of(ReactOnRailsPro::AsyncPropsEmitter) |
| 65 | + .to receive(:generate_update_chunk) do |emitter, _prop_name, value| |
| 66 | + bundle_timestamp = emitter.instance_variable_get(:@bundle_timestamp) |
| 67 | + { |
| 68 | + bundleTimestamp: bundle_timestamp, |
| 69 | + # Add newline to the value so the fixture bundle writes it with newline |
| 70 | + updateChunk: "ReactOnRails.addStreamValue(#{value.to_json} + '\\n')" |
| 71 | + } |
| 72 | + end |
| 73 | + |
| 74 | + allow_any_instance_of(ReactOnRailsPro::AsyncPropsEmitter).to receive(:end_stream_chunk).and_call_original |
| 75 | + allow_any_instance_of(ReactOnRailsPro::AsyncPropsEmitter).to receive(:generate_end_stream_js).and_return( |
| 76 | + "ReactOnRails.endStream()" |
| 77 | + ) |
| 78 | + # rubocop:enable RSpec/AnyInstance |
| 79 | + |
| 80 | + # Reset any existing connections to ensure clean state |
| 81 | + ReactOnRailsPro::Request.reset_connection |
| 82 | + end |
| 83 | + |
| 84 | + after do |
| 85 | + ReactOnRailsPro::Request.reset_connection |
| 86 | + end |
| 87 | + |
| 88 | + describe "upload_assets" do |
| 89 | + it "successfully uploads fixture bundles to the node renderer" do |
| 90 | + expect do |
| 91 | + ReactOnRailsPro::Request.upload_assets |
| 92 | + end.not_to raise_error |
| 93 | + end |
| 94 | + end |
| 95 | + |
| 96 | + describe "render_code" do |
| 97 | + it "renders simple non-streaming request using ReactOnRails.dummy" do |
| 98 | + # Upload bundles first |
| 99 | + ReactOnRailsPro::Request.upload_assets |
| 100 | + |
| 101 | + # Construct the render path: /bundles/:bundleTimestamp/render/:renderRequestDigest |
| 102 | + js_code = "ReactOnRails.dummy" |
| 103 | + request_digest = Digest::MD5.hexdigest(js_code) |
| 104 | + render_path = "/bundles/#{server_bundle_hash}/render/#{request_digest}" |
| 105 | + |
| 106 | + # Render using the fixture bundle |
| 107 | + response = ReactOnRailsPro::Request.render_code(render_path, js_code, false) |
| 108 | + |
| 109 | + expect(response.status).to eq(200) |
| 110 | + expect(response.body.to_s).to include("Dummy Object") |
| 111 | + end |
| 112 | + end |
| 113 | + |
| 114 | + describe "render_code_with_incremental_updates" do |
| 115 | + it "sends stream values and receives them in the response" do |
| 116 | + # Upload bundles first |
| 117 | + ReactOnRailsPro::Request.upload_assets |
| 118 | + |
| 119 | + # Construct the incremental render path |
| 120 | + js_code = "ReactOnRails.getStreamValues()" |
| 121 | + request_digest = Digest::MD5.hexdigest(js_code) |
| 122 | + render_path = "/bundles/#{server_bundle_hash}/incremental-render/#{request_digest}" |
| 123 | + |
| 124 | + # Perform incremental rendering with stream updates |
| 125 | + stream = ReactOnRailsPro::Request.render_code_with_incremental_updates( |
| 126 | + render_path, |
| 127 | + js_code, |
| 128 | + async_props_block: proc { |emitter| |
| 129 | + emitter.call("prop1", "value1") |
| 130 | + emitter.call("prop2", "value2") |
| 131 | + emitter.call("prop3", "value3") |
| 132 | + }, |
| 133 | + is_rsc_payload: false |
| 134 | + ) |
| 135 | + |
| 136 | + # Collect all chunks from the stream |
| 137 | + chunks = [] |
| 138 | + stream.each_chunk do |chunk| |
| 139 | + chunks << chunk |
| 140 | + end |
| 141 | + |
| 142 | + # Verify we received all the values |
| 143 | + response_text = chunks.join |
| 144 | + expect(response_text).to include("value1") |
| 145 | + expect(response_text).to include("value2") |
| 146 | + expect(response_text).to include("value3") |
| 147 | + end |
| 148 | + |
| 149 | + it "streams bidirectionally - each_chunk receives chunks while async_props_block is still running" do |
| 150 | + # Upload bundles first |
| 151 | + ReactOnRailsPro::Request.upload_assets |
| 152 | + |
| 153 | + # Construct the incremental render path |
| 154 | + js_code = "ReactOnRails.getStreamValues()" |
| 155 | + request_digest = Digest::MD5.hexdigest(js_code) |
| 156 | + render_path = "/bundles/#{server_bundle_hash}/incremental-render/#{request_digest}" |
| 157 | + |
| 158 | + # Single condition to signal when each chunk is received |
| 159 | + chunk_received = Async::Condition.new |
| 160 | + |
| 161 | + # Wrap the test in a timeout to prevent hanging forever on deadlock |
| 162 | + Timeout.timeout(10) do |
| 163 | + # Perform incremental rendering with bidirectional verification |
| 164 | + stream = ReactOnRailsPro::Request.render_code_with_incremental_updates( |
| 165 | + render_path, |
| 166 | + js_code, |
| 167 | + async_props_block: proc { |emitter| |
| 168 | + # Send first value and wait for confirmation |
| 169 | + emitter.call("prop1", "value1") |
| 170 | + chunk_received.wait |
| 171 | + |
| 172 | + # Send second value and wait for confirmation |
| 173 | + emitter.call("prop2", "value2") |
| 174 | + chunk_received.wait |
| 175 | + |
| 176 | + # Send third value and wait for confirmation |
| 177 | + emitter.call("prop3", "value3") |
| 178 | + chunk_received.wait |
| 179 | + |
| 180 | + # If we reach here, all chunks were received while async_block was running |
| 181 | + }, |
| 182 | + is_rsc_payload: false |
| 183 | + ) |
| 184 | + |
| 185 | + # Collect chunks and signal after each one |
| 186 | + chunks = [] |
| 187 | + stream.each_chunk do |chunk| |
| 188 | + chunks << chunk |
| 189 | + chunk_received.signal |
| 190 | + end |
| 191 | + |
| 192 | + # Verify all values were received |
| 193 | + response_text = chunks.join |
| 194 | + expect(response_text).to include("value1") |
| 195 | + expect(response_text).to include("value2") |
| 196 | + expect(response_text).to include("value3") |
| 197 | + |
| 198 | + # If this test completes without deadlock, it proves bidirectional streaming: |
| 199 | + # - async_props_block sent chunks and waited for confirmation |
| 200 | + # - each_chunk received chunks and signaled back while async_props_block was still running |
| 201 | + # - This would deadlock if chunks weren't received concurrently |
| 202 | + end |
| 203 | + end |
| 204 | + end |
| 205 | +end |
0 commit comments