add missing docs and specs

Author: AbanoubGhadban

docs/guides/configuration.md

@@ -104,6 +104,31 @@ ReactOnRails.configure do |config|
   # you should include a name that matches your bundle name in your Webpack config.
   config.server_bundle_js_file = "server-bundle.js"
 
+  # When using React on Rails Pro with RSC support enabled, these configuration options work together:
+  #
+  # 1. In RORP, set `config.enable_rsc_support = true` in your react_on_rails_pro.rb initializer
+  #
+  # 2. The `rsc_bundle_js_file` (typically "rsc-bundle.js") contains only server components and
+  #    references to client components. It's generated using the RSC Webpack Loader which transforms
+  #    client components into references. This bundle is specifically used for generating RSC payloads
+  #    and is configured with the `react-server` condition.
+  config.rsc_bundle_js_file = "rsc-bundle.js"
+  #
+  # 3. The `react_client_manifest_file` contains mappings for client components that need hydration.
+  #    It's generated by the React Server Components Webpack plugin and is required for client-side
+  #    hydration of components.
+  # This manifest file is automatically generated by the React Server Components Webpack plugin. Only set this if you've configured the plugin to use a different filename.
+  config.react_client_manifest_file = "react-client-manifest.json"
+  #
+  # 4. The `react_server_client_manifest_file` is used during server-side rendering with RSC to
+  #    properly resolve references between server and client components.
+  #
+  # These files are crucial when implementing React Server Components with streaming, which offers
+  # benefits like reduced JavaScript bundle sizes, faster page loading, and selective hydration
+  # of client components.
+  # This manifest file is automatically generated by the React Server Components Webpack plugin. Only set this if you've configured the plugin to use a different filename.
+  config.react_server_client_manifest_file = "react-server-client-manifest.json"
+
   # `prerender` means server-side rendering
   # default is false. This is an option for view helpers `render_component` and `render_component_hash`.
   # Set to true to change the default value to true.

lib/react_on_rails/configuration.rb

@@ -312,8 +312,6 @@ def ensure_webpack_generated_files_exists
         react_client_manifest_file,
         react_server_client_manifest_file
       ].compact_blank
-
-      self.webpack_generated_files = files
     end
 
     def configure_skip_display_none_deprecation

lib/react_on_rails/utils.rb

@@ -128,6 +128,11 @@ def self.react_server_client_manifest_file_path
       return @react_server_manifest_path if @react_server_manifest_path && !Rails.env.development?
 
       asset_name = ReactOnRails.configuration.react_server_client_manifest_file
+      if asset_name.nil?
+        raise ReactOnRails::Error,
+              "react_server_client_manifest_file is nil, ensure to set it in your configuration"
+      end
+
       @react_server_manifest_path = File.join(generated_assets_full_path, asset_name)
     end
 

spec/react_on_rails/configuration_spec.rb

@@ -224,6 +224,103 @@ module ReactOnRails
       end
     end
 
+    describe "RSC configuration options" do
+      it "has default values for RSC-related configuration options" do
+        ReactOnRails.configure {} # rubocop:disable Lint/EmptyBlock
+
+        expect(ReactOnRails.configuration.rsc_bundle_js_file).to eq("")
+        expect(ReactOnRails.configuration.react_client_manifest_file).to eq("react-client-manifest.json")
+        expect(ReactOnRails.configuration.react_server_client_manifest_file).to eq("react-server-client-manifest.json")
+      end
+
+      it "allows setting rsc_bundle_js_file" do
+        ReactOnRails.configure do |config|
+          config.rsc_bundle_js_file = "custom-rsc-bundle.js"
+        end
+
+        expect(ReactOnRails.configuration.rsc_bundle_js_file).to eq("custom-rsc-bundle.js")
+      end
+
+      it "allows setting react_client_manifest_file" do
+        ReactOnRails.configure do |config|
+          config.react_client_manifest_file = "custom-client-manifest.json"
+        end
+
+        expect(ReactOnRails.configuration.react_client_manifest_file).to eq("custom-client-manifest.json")
+      end
+
+      it "allows setting react_server_client_manifest_file" do
+        ReactOnRails.configure do |config|
+          config.react_server_client_manifest_file = "custom-server-client-manifest.json"
+        end
+
+        expect(ReactOnRails.configuration.react_server_client_manifest_file).to eq("custom-server-client-manifest.json")
+      end
+
+      it "includes rsc files in webpack_generated_files when not blank" do
+        ReactOnRails.configure do |config|
+          config.rsc_bundle_js_file = "rsc-bundle.js"
+          config.webpack_generated_files = []
+        end
+
+        expect(ReactOnRails.configuration.webpack_generated_files).to include("rsc-bundle.js")
+      end
+
+      it "includes client manifest in webpack_generated_files" do
+        ReactOnRails.configure do |config|
+          config.react_client_manifest_file = "custom-client-manifest.json"
+          config.webpack_generated_files = []
+        end
+
+        expect(ReactOnRails.configuration.webpack_generated_files).to include("custom-client-manifest.json")
+      end
+
+      it "includes server-client manifest in webpack_generated_files" do
+        ReactOnRails.configure do |config|
+          config.react_server_client_manifest_file = "custom-server-client-manifest.json"
+          config.webpack_generated_files = []
+        end
+
+        expect(ReactOnRails.configuration.webpack_generated_files).to include("custom-server-client-manifest.json")
+      end
+
+      it "configures all RSC options together for a typical RSC setup" do
+        ReactOnRails.configure do |config|
+          config.rsc_bundle_js_file = "rsc-bundle.js"
+          config.react_client_manifest_file = "client-manifest.json"
+          config.react_server_client_manifest_file = "server-client-manifest.json"
+          config.webpack_generated_files = []
+        end
+
+        expect(ReactOnRails.configuration.rsc_bundle_js_file).to eq("rsc-bundle.js")
+        expect(ReactOnRails.configuration.react_client_manifest_file).to eq("client-manifest.json")
+        expect(ReactOnRails.configuration.react_server_client_manifest_file).to eq("server-client-manifest.json")
+
+        # All RSC files should be included in webpack_generated_files
+        expect(ReactOnRails.configuration.webpack_generated_files).to include("rsc-bundle.js")
+        expect(ReactOnRails.configuration.webpack_generated_files).to include("client-manifest.json")
+        expect(ReactOnRails.configuration.webpack_generated_files).to include("server-client-manifest.json")
+      end
+
+      it "allows nil values for RSC configuration options" do
+        ReactOnRails.configure do |config|
+          config.rsc_bundle_js_file = nil
+          config.react_client_manifest_file = nil
+          config.react_server_client_manifest_file = nil
+          config.webpack_generated_files = []
+        end
+
+        expect(ReactOnRails.configuration.rsc_bundle_js_file).to be_nil
+        expect(ReactOnRails.configuration.react_client_manifest_file).to be_nil
+        expect(ReactOnRails.configuration.react_server_client_manifest_file).to be_nil
+
+        # Nil values should not be included in webpack_generated_files
+        expect(ReactOnRails.configuration.webpack_generated_files).not_to include(nil)
+        # Only manifest.json should be in the list by default
+        expect(ReactOnRails.configuration.webpack_generated_files).to eq(["manifest.json"])
+      end
+    end
+
     it "changes the configuration of the gem, such as setting the prerender option to false" do
       ReactOnRails.configure do |config|
         config.server_bundle_js_file = "server.js"

spec/react_on_rails/utils_spec.rb

@@ -577,6 +577,97 @@ def mock_dev_server_running
         end
       end
     end
+
+    describe ".react_server_client_manifest_file_path" do
+      before do
+        described_class.instance_variable_set(:@react_server_manifest_path, nil)
+        allow(ReactOnRails.configuration).to receive(:react_server_client_manifest_file)
+          .and_return("react-server-client-manifest.json")
+        allow(Rails.env).to receive(:development?).and_return(false)
+      end
+
+      after do
+        described_class.instance_variable_set(:@react_server_manifest_path, nil)
+      end
+
+      context "when in development environment" do
+        before do
+          allow(Rails.env).to receive(:development?).and_return(true)
+          allow(described_class).to receive(:generated_assets_full_path)
+            .and_return("/path/to/generated/assets")
+        end
+
+        it "does not use cached path" do
+          # Call once to potentially set the cached path
+          described_class.react_server_client_manifest_file_path
+
+          # Change the configuration value
+          allow(ReactOnRails.configuration).to receive(:react_server_client_manifest_file)
+            .and_return("changed-manifest.json")
+
+          # Should use the new value
+          expect(described_class.react_server_client_manifest_file_path)
+            .to eq("/path/to/generated/assets/changed-manifest.json")
+        end
+      end
+
+      context "when not in development environment" do
+        before do
+          allow(described_class).to receive(:generated_assets_full_path)
+            .and_return("/path/to/generated/assets")
+        end
+
+        it "caches the path" do
+          # Call once to set the cached path
+          expected_path = "/path/to/generated/assets/react-server-client-manifest.json"
+          expect(described_class.react_server_client_manifest_file_path).to eq(expected_path)
+
+          # Change the configuration value
+          allow(ReactOnRails.configuration).to receive(:react_server_client_manifest_file)
+            .and_return("changed-manifest.json")
+
+          # Should still use the cached path
+          expect(described_class.react_server_client_manifest_file_path).to eq(expected_path)
+        end
+      end
+
+      context "with different manifest file names" do
+        before do
+          allow(described_class).to receive(:generated_assets_full_path)
+            .and_return("/path/to/generated/assets")
+        end
+
+        it "returns the correct path for default manifest name" do
+          allow(ReactOnRails.configuration).to receive(:react_server_client_manifest_file)
+            .and_return("react-server-client-manifest.json")
+
+          expect(described_class.react_server_client_manifest_file_path)
+            .to eq("/path/to/generated/assets/react-server-client-manifest.json")
+        end
+
+        it "returns the correct path for custom manifest name" do
+          allow(ReactOnRails.configuration).to receive(:react_server_client_manifest_file)
+            .and_return("custom-server-client-manifest.json")
+
+          expect(described_class.react_server_client_manifest_file_path)
+            .to eq("/path/to/generated/assets/custom-server-client-manifest.json")
+        end
+      end
+
+      context "with nil manifest file name" do
+        before do
+          allow(ReactOnRails.configuration).to receive(:react_server_client_manifest_file)
+            .and_return(nil)
+          allow(described_class).to receive(:generated_assets_full_path)
+            .and_return("/path/to/generated/assets")
+        end
+
+        it "raises an error when the manifest file name is nil" do
+          expect { described_class.react_server_client_manifest_file_path }
+            .to raise_error(ReactOnRails::Error, /react_server_client_manifest_file is nil/)
+        end
+      end
+    end
   end
 end
 # rubocop:enable Metrics/ModuleLength, Metrics/BlockLength