add rsc_bundle_js_file config and update utils spec

Author: AbanoubGhadban

lib/react_on_rails/configuration.rb

@@ -17,6 +17,7 @@ def self.configuration
       # generated_assets_dirs is deprecated
       generated_assets_dir: "",
       server_bundle_js_file: "",
+      rsc_bundle_js_file: "",
       prerender: false,
       auto_load_bundle: false,
       replay_console: true,
@@ -55,7 +56,7 @@ class Configuration
                   :server_render_method, :random_dom_id, :auto_load_bundle,
                   :same_bundle_for_client_and_server, :rendering_props_extension,
                   :make_generated_server_bundle_the_entrypoint,
-                  :defer_generated_component_packs,
+                  :defer_generated_component_packs, :rsc_bundle_js_file,
                   :force_load
 
     # rubocop:disable Metrics/AbcSize
@@ -71,7 +72,8 @@ def initialize(node_modules_location: nil, server_bundle_js_file: nil, prerender
                    same_bundle_for_client_and_server: nil,
                    i18n_dir: nil, i18n_yml_dir: nil, i18n_output_format: nil,
                    random_dom_id: nil, server_render_method: nil, rendering_props_extension: nil,
-                   components_subdirectory: nil, auto_load_bundle: nil, force_load: nil)
+                   components_subdirectory: nil, auto_load_bundle: nil, force_load: nil,
+                   rsc_bundle_js_file: nil)
       self.node_modules_location = node_modules_location.present? ? node_modules_location : Rails.root
       self.generated_assets_dirs = generated_assets_dirs
       self.generated_assets_dir = generated_assets_dir
@@ -97,6 +99,7 @@ def initialize(node_modules_location: nil, server_bundle_js_file: nil, prerender
 
       # Server rendering:
       self.server_bundle_js_file = server_bundle_js_file
+      self.rsc_bundle_js_file = rsc_bundle_js_file
       self.same_bundle_for_client_and_server = same_bundle_for_client_and_server
       self.server_renderer_pool_size = self.development_mode ? 1 : server_renderer_pool_size
       self.server_renderer_timeout = server_renderer_timeout # seconds
@@ -241,7 +244,7 @@ def ensure_webpack_generated_files_exists
 
       files = ["manifest.json"]
       files << server_bundle_js_file if server_bundle_js_file.present?
-
+      files << rsc_bundle_js_file if rsc_bundle_js_file.present?
       self.webpack_generated_files = files
     end
 

lib/react_on_rails/packer_utils.rb

@@ -74,9 +74,10 @@ def self.bundle_js_uri_from_packer(bundle_name)
       # the webpack-dev-server is provided by the config value
       # "same_bundle_for_client_and_server" where a value of true
       # would mean that the bundle is created by the webpack-dev-server
-      is_server_bundle = bundle_name == ReactOnRails.configuration.server_bundle_js_file
+      is_bundle_running_on_server = (bundle_name == ReactOnRails.configuration.server_bundle_js_file) ||
+                                    (bundle_name == ReactOnRails.configuration.rsc_bundle_js_file)
 
-      if packer.dev_server.running? && (!is_server_bundle ||
+      if packer.dev_server.running? && (!is_bundle_running_on_server ||
         ReactOnRails.configuration.same_bundle_for_client_and_server)
         "#{packer.dev_server.protocol}://#{packer.dev_server.host_with_port}#{hashed_bundle_name}"
       else

lib/react_on_rails/utils.rb

@@ -114,8 +114,7 @@ def self.server_bundle_js_file_path
     def self.rsc_bundle_js_file_path
       return @rsc_bundle_path if @rsc_bundle_path && !Rails.env.development?
 
-      # TODO: make it configurable
-      bundle_name = "rsc-bundle.js"
+      bundle_name = ReactOnRails.configuration.rsc_bundle_js_file
       @rsc_bundle_path = bundle_js_file_path(bundle_name)
     end
 

spec/react_on_rails/utils_spec.rb

@@ -81,6 +81,20 @@ def mock_missing_manifest_entry(bundle_name)
         )::Manifest::MissingEntryError)
     end
 
+    def random_bundle_name
+      "webpack-bundle-#{SecureRandom.hex(4)}.js"
+    end
+
+    # If bundle names are not provided, random unique names will be used for each bundle.
+    # This ensures that if server_bundle and rsc_bundle are accidentally swapped in the code,
+    # the tests will fail since each bundle has a distinct random name that won't match if used incorrectly.
+    def mock_bundle_configs(server_bundle_name: random_bundle_name, rsc_bundle_name: random_bundle_name)
+      allow(ReactOnRails).to receive_message_chain("configuration.server_bundle_js_file")
+        .and_return(server_bundle_name)
+      allow(ReactOnRails).to receive_message_chain("configuration.rsc_bundle_js_file")
+        .and_return(rsc_bundle_name)
+    end
+
     def mock_dev_server_running
       allow(ReactOnRails::PackerUtils.packer).to receive_message_chain("dev_server.running?")
         .and_return(true)
@@ -123,8 +137,7 @@ def mock_dev_server_running
             before do
               mock_bundle_in_manifest("webpack-bundle.js", "/webpack/dev/webpack-bundle-0123456789abcdef.js")
 
-              allow(ReactOnRails).to receive_message_chain("configuration.server_bundle_js_file")
-                .and_return("server-bundle.js")
+              mock_bundle_configs(server_bundle_name: "server-bundle.js")
             end
 
             it { is_expected.to eq("#{packer_public_output_path}/webpack-bundle-0123456789abcdef.js") }
@@ -183,8 +196,7 @@ def mock_dev_server_running
           context "with server file not in manifest", packer_type.to_sym do
             it "returns the unhashed server path" do
               server_bundle_name = "server-bundle.js"
-              allow(ReactOnRails).to receive_message_chain("configuration.server_bundle_js_file")
-                .and_return(server_bundle_name)
+              mock_bundle_configs(server_bundle_name: server_bundle_name)
               mock_missing_manifest_entry(server_bundle_name)
 
               path = described_class.server_bundle_js_file_path
@@ -196,8 +208,7 @@ def mock_dev_server_running
           context "with server file in the manifest, used for client", packer_type.to_sym do
             it "returns the correct path hashed server path" do
               Packer = ReactOnRails::PackerUtils.packer # rubocop:disable Lint/ConstantDefinitionInBlock, RSpec/LeakyConstantDeclaration
-              allow(ReactOnRails).to receive_message_chain("configuration.server_bundle_js_file")
-                .and_return("webpack-bundle.js")
+              mock_bundle_configs(server_bundle_name: "webpack-bundle.js")
               allow(ReactOnRails).to receive_message_chain("configuration.same_bundle_for_client_and_server")
                 .and_return(true)
               mock_bundle_in_manifest("webpack-bundle.js", "webpack/development/webpack-bundle-123456.js")
@@ -211,8 +222,7 @@ def mock_dev_server_running
 
             context "with webpack-dev-server running, and same file used for server and client" do
               it "returns the correct path hashed server path" do
-                allow(ReactOnRails).to receive_message_chain("configuration.server_bundle_js_file")
-                  .and_return("webpack-bundle.js")
+                mock_bundle_configs(server_bundle_name: "webpack-bundle.js")
                 allow(ReactOnRails).to receive_message_chain("configuration.same_bundle_for_client_and_server")
                   .and_return(true)
                 mock_dev_server_running
@@ -228,8 +238,7 @@ def mock_dev_server_running
           context "with dev-server running, and server file in the manifest, and separate client/server files",
                   packer_type.to_sym do
             it "returns the correct path hashed server path" do
-              allow(ReactOnRails).to receive_message_chain("configuration.server_bundle_js_file")
-                .and_return("server-bundle.js")
+              mock_bundle_configs(server_bundle_name: "server-bundle.js")
               allow(ReactOnRails).to receive_message_chain("configuration.same_bundle_for_client_and_server")
                 .and_return(false)
               mock_bundle_in_manifest("server-bundle.js", "webpack/development/server-bundle-123456.js")
@@ -248,29 +257,23 @@ def mock_dev_server_running
 
           context "with server file not in manifest", packer_type.to_sym do
             it "returns the unhashed server path" do
-              server_bundle_name = "rsc-server-bundle.js"
-              allow(ReactOnRails).to receive_message_chain("configuration.rsc_bundle_js_file")
-                .and_return(server_bundle_name)
-              # TODO: fix after adding rsc_bundle_js_file config
-              mock_missing_manifest_entry("rsc-bundle.js")
+              server_bundle_name = "rsc-bundle.js"
+              mock_bundle_configs(rsc_bundle_name: server_bundle_name)
+              mock_missing_manifest_entry(server_bundle_name)
 
               path = described_class.rsc_bundle_js_file_path
 
-              expect(path).to end_with("public/webpack/development/rsc-bundle.js")
+              expect(path).to end_with("public/webpack/development/#{server_bundle_name}")
             end
           end
 
           context "with server file in the manifest, used for client", packer_type.to_sym do
             it "returns the correct path hashed server path" do
               Packer = ReactOnRails::PackerUtils.packer # rubocop:disable Lint/ConstantDefinitionInBlock, RSpec/LeakyConstantDeclaration
-              allow(ReactOnRails).to receive_message_chain("configuration.rsc_bundle_js_file")
-                .and_return("webpack-bundle.js")
-              allow(ReactOnRails).to receive_message_chain("configuration.server_bundle_js_file")
-                .and_return("webpack-server-bundle.js")
+              mock_bundle_configs(rsc_bundle_name: "webpack-bundle.js")
               allow(ReactOnRails).to receive_message_chain("configuration.same_bundle_for_client_and_server")
                 .and_return(true)
-              # TODO: fix after adding rsc_bundle_js_file config
-              mock_bundle_in_manifest("rsc-bundle.js", "webpack/development/webpack-bundle-123456.js")
+              mock_bundle_in_manifest("webpack-bundle.js", "webpack/development/webpack-bundle-123456.js")
               allow(Packer).to receive_message_chain("dev_server.running?")
                 .and_return(false)
 
@@ -281,15 +284,11 @@ def mock_dev_server_running
 
             context "with webpack-dev-server running, and same file used for server and client" do
               it "returns the correct path hashed server path" do
-                allow(ReactOnRails).to receive_message_chain("configuration.server_bundle_js_file")
-                  .and_return("webpack-bundle.js")
-                  allow(ReactOnRails).to receive_message_chain("configuration.server_bundle_js_file")
-                    .and_return("webpack-server-bundle.js")
+                mock_bundle_configs(rsc_bundle_name: "webpack-bundle.js")
                 allow(ReactOnRails).to receive_message_chain("configuration.same_bundle_for_client_and_server")
                   .and_return(true)
                 mock_dev_server_running
-                # TODO: fix after adding rsc_bundle_js_file config
-                mock_bundle_in_manifest("rsc-bundle.js", "/webpack/development/webpack-bundle-123456.js")
+                mock_bundle_in_manifest("webpack-bundle.js", "/webpack/development/webpack-bundle-123456.js")
 
                 path = described_class.rsc_bundle_js_file_path
 
@@ -298,25 +297,20 @@ def mock_dev_server_running
             end
           end
 
-          # TODO: fix after adding rsc_bundle_js_file config
-          # context "with dev-server running, and server file in the manifest, and separate client/server files",
-          #         packer_type.to_sym do
-          #   it "returns the correct path hashed server path" do
-          #     # TODO: fix after adding rsc_bundle_js_file config
-          #     allow(ReactOnRails).to receive_message_chain("configuration.rsc_bundle_js_file")
-          #       .and_return("rsc-server-bundle.js")
-          #       allow(ReactOnRails).to receive_message_chain("configuration.server_bundle_js_file")
-          #         .and_return("server-bundle.js")
-          #     allow(ReactOnRails).to receive_message_chain("configuration.same_bundle_for_client_and_server")
-          #       .and_return(false)
-          #     mock_bundle_in_manifest("rsc-bundle.js", "webpack/development/server-bundle-123456.js")
-          #     mock_dev_server_running
-
-          #     path = described_class.rsc_bundle_js_file_path
-
-          #     expect(path).to end_with("/public/webpack/development/server-bundle-123456.js")
-          #   end
-          # end
+          context "with dev-server running, and server file in the manifest, and separate client/server files",
+                  packer_type.to_sym do
+            it "returns the correct path hashed server path" do
+              mock_bundle_configs(rsc_bundle_name: "rsc-bundle.js")
+              allow(ReactOnRails).to receive_message_chain("configuration.same_bundle_for_client_and_server")
+                .and_return(false)
+              mock_bundle_in_manifest("rsc-bundle.js", "webpack/development/server-bundle-123456.js")
+              mock_dev_server_running
+
+              path = described_class.rsc_bundle_js_file_path
+
+              expect(path).to end_with("/public/webpack/development/server-bundle-123456.js")
+            end
+          end
         end
       end