react_on_rails 14.2.1 → 16.1.1

data/lib/react_on_rails/pro/helper.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+# /*
+#  * Copyright (c) 2025 Shakacode LLC
+#  *
+#  * This file is NOT licensed under the MIT (open source) license.
+#  * It is part of the React on Rails Pro offering and is licensed separately.
+#  *
+#  * Unauthorized copying, modification, distribution, or use of this file,
+#  * via any medium, is strictly prohibited without a valid license agreement
+#  * from Shakacode LLC.
+#  *
+#  * For licensing terms, please see:
+#  * https://github.com/shakacode/react_on_rails/blob/master/REACT-ON-RAILS-PRO-LICENSE.md
+#  */
+
+module ReactOnRails
+  module Pro
+    module Helper
+      IMMEDIATE_HYDRATION_PRO_WARNING = "[REACT ON RAILS] The 'immediate_hydration' feature requires a " \
+                                        "React on Rails Pro license. " \
+                                        "Please visit https://shakacode.com/react-on-rails-pro to learn more."
+
+      # Generates the complete component specification script tag.
+      # Handles both immediate hydration (Pro feature) and standard cases.
+      def generate_component_script(render_options)
+        # Setup the page_loaded_js, which is the same regardless of prerendering or not!
+        # The reason is that React is smart about not doing extra work if the server rendering did its job.
+        component_specification_tag = content_tag(:script,
+                                                  json_safe_and_pretty(render_options.client_props).html_safe,
+                                                  type: "application/json",
+                                                  class: "js-react-on-rails-component",
+                                                  id: "js-react-on-rails-component-#{render_options.dom_id}",
+                                                  "data-component-name" => render_options.react_component_name,
+                                                  "data-trace" => (render_options.trace ? true : nil),
+                                                  "data-dom-id" => render_options.dom_id,
+                                                  "data-store-dependencies" =>
+                                                    render_options.store_dependencies&.to_json,
+                                                  "data-immediate-hydration" =>
+                                                    (render_options.immediate_hydration ? true : nil))
+
+        # Add immediate invocation script if immediate hydration is enabled
+        spec_tag = if render_options.immediate_hydration
+                     # Escape dom_id for JavaScript context
+                     escaped_dom_id = escape_javascript(render_options.dom_id)
+                     immediate_script = content_tag(:script, %(
+          typeof ReactOnRails === 'object' && ReactOnRails.reactOnRailsComponentLoaded('#{escaped_dom_id}');
+        ).html_safe)
+                     "#{component_specification_tag}\n#{immediate_script}"
+                   else
+                     component_specification_tag
+                   end
+
+        pro_warning_badge = pro_warning_badge_if_needed(render_options.explicitly_disabled_pro_options)
+        "#{pro_warning_badge}\n#{spec_tag}".html_safe
+      end
+
+      # Generates the complete store hydration script tag.
+      # Handles both immediate hydration (Pro feature) and standard cases.
+      def generate_store_script(redux_store_data)
+        pro_options_check_result = ReactOnRails::Pro::Utils.disable_pro_render_options_if_not_licensed(redux_store_data)
+        redux_store_data = pro_options_check_result[:raw_options]
+        explicitly_disabled_pro_options = pro_options_check_result[:explicitly_disabled_pro_options]
+
+        store_hydration_data = content_tag(:script,
+                                           json_safe_and_pretty(redux_store_data[:props]).html_safe,
+                                           type: "application/json",
+                                           "data-js-react-on-rails-store" => redux_store_data[:store_name].html_safe,
+                                           "data-immediate-hydration" =>
+                                             (redux_store_data[:immediate_hydration] ? true : nil))
+
+        # Add immediate invocation script if immediate hydration is enabled and Pro license is valid
+        store_hydration_scripts = if redux_store_data[:immediate_hydration]
+                                    # Escape store_name for JavaScript context
+                                    escaped_store_name = escape_javascript(redux_store_data[:store_name])
+                                    immediate_script = content_tag(:script, <<~JS.strip_heredoc.html_safe
+                                      typeof ReactOnRails === 'object' && ReactOnRails.reactOnRailsStoreLoaded('#{escaped_store_name}');
+                                    JS
+                                    )
+                                    "#{store_hydration_data}\n#{immediate_script}"
+                                  else
+                                    store_hydration_data
+                                  end
+
+        pro_warning_badge = pro_warning_badge_if_needed(explicitly_disabled_pro_options)
+        "#{pro_warning_badge}\n#{store_hydration_scripts}".html_safe
+      end
+
+      def pro_warning_badge_if_needed(explicitly_disabled_pro_options)
+        return "" unless explicitly_disabled_pro_options.any?
+
+        disabled_features_message = disabled_pro_features_message(explicitly_disabled_pro_options)
+        warning_message = "[REACT ON RAILS] #{disabled_features_message}\n" \
+                          "Please visit https://shakacode.com/react-on-rails-pro to learn more."
+        puts warning_message
+        Rails.logger.warn warning_message
+
+        tooltip_text = "#{disabled_features_message} Click to learn more."
+
+        <<~HTML.strip
+          <a href="https://shakacode.com/react-on-rails-pro" target="_blank" rel="noopener noreferrer" title="#{tooltip_text}">
+            <div style="position: fixed; top: 0; right: 0; width: 180px; height: 180px; overflow: hidden; z-index: 9999; pointer-events: none;">
+              <div style="position: absolute; top: 50px; right: -40px; transform: rotate(45deg); background-color: rgba(220, 53, 69, 0.85); color: white; padding: 7px 40px; text-align: center; font-weight: bold; font-family: sans-serif; font-size: 12px; box-shadow: 0 2px 8px rgba(0,0,0,0.3); pointer-events: auto;">
+                React On Rails Pro Required
+              </div>
+            </div>
+          </a>
+        HTML
+      end
+
+      def disabled_pro_features_message(explicitly_disabled_pro_options)
+        return "".html_safe unless explicitly_disabled_pro_options.any?
+
+        feature_list = explicitly_disabled_pro_options.join(", ")
+        feature_word = explicitly_disabled_pro_options.size == 1 ? "feature" : "features"
+        "The '#{feature_list}' #{feature_word} " \
+          "#{explicitly_disabled_pro_options.size == 1 ? 'requires' : 'require'} a " \
+          "React on Rails Pro license. "
+      end
+    end
+  end
+end

data/lib/react_on_rails/pro/utils.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+# /*
+#  * Copyright (c) 2025 Shakacode LLC
+#  *
+#  * This file is NOT licensed under the MIT (open source) license.
+#  * It is part of the React on Rails Pro offering and is licensed separately.
+#  *
+#  * Unauthorized copying, modification, distribution, or use of this file,
+#  * via any medium, is strictly prohibited without a valid license agreement
+#  * from Shakacode LLC.
+#  *
+#  * For licensing terms, please see:
+#  * https://github.com/shakacode/react_on_rails/blob/master/REACT-ON-RAILS-PRO-LICENSE.md
+#  */
+
+module ReactOnRails
+  module Pro
+    module Utils
+      PRO_ONLY_OPTIONS = %i[immediate_hydration].freeze
+
+      # Checks if React on Rails Pro features are available
+      # @return [Boolean] true if Pro license is valid, false otherwise
+      def self.support_pro_features?
+        ReactOnRails::Utils.react_on_rails_pro_licence_valid?
+      end
+
+      def self.disable_pro_render_options_if_not_licensed(raw_options)
+        if support_pro_features?
+          return {
+            raw_options: raw_options,
+            explicitly_disabled_pro_options: []
+          }
+        end
+
+        raw_options_after_disable = raw_options.dup
+
+        explicitly_disabled_pro_options = PRO_ONLY_OPTIONS.select do |option|
+          # Use global configuration if it's not overridden in the options
+          next ReactOnRails.configuration.send(option) if raw_options[option].nil?
+
+          raw_options[option]
+        end
+        explicitly_disabled_pro_options.each { |option| raw_options_after_disable[option] = false }
+
+        {
+          raw_options: raw_options_after_disable,
+          explicitly_disabled_pro_options: explicitly_disabled_pro_options
+        }
+      end
+    end
+  end
+end

data/lib/react_on_rails/react_component/render_options.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "react_on_rails/utils"
+require "react_on_rails/pro/utils"
 
 module ReactOnRails
   module ReactComponent
@@ -14,10 +15,13 @@ module ReactOnRails
       # TODO: remove the required for named params
       def initialize(react_component_name: required("react_component_name"), options: required("options"))
         @react_component_name = react_component_name.camelize
-        @options = options
+
+        result = ReactOnRails::Pro::Utils.disable_pro_render_options_if_not_licensed(options)
+        @options = result[:raw_options]
+        @explicitly_disabled_pro_options = result[:explicitly_disabled_pro_options]
       end
 
-      attr_reader :react_component_name
+      attr_reader :react_component_name, :explicitly_disabled_pro_options
 
       def throw_js_errors
         options.fetch(:throw_js_errors, false)
@@ -95,8 +99,8 @@ module ReactOnRails
         retrieve_configuration_value_for(:logging_on_server)
       end
 
-      def force_load
-        retrieve_configuration_value_for(:force_load)
+      def immediate_hydration
+        retrieve_configuration_value_for(:immediate_hydration)
       end
 
       def to_s
@@ -111,8 +115,36 @@ module ReactOnRails
         options[key] = value
       end
 
-      def stream?
-        options[:stream?]
+      def render_mode
+        # Determines the React rendering strategy:
+        # - :sync: Synchronous SSR using renderToString (blocking and rendering in one shot)
+        # - :html_streaming: Progressive SSR using renderToPipeableStream (non-blocking and rendering incrementally)
+        # - :rsc_payload_streaming: Server Components serialized in React flight format
+        #   (non-blocking and rendering incrementally).
+        options.fetch(:render_mode, :sync)
+      end
+
+      def streaming?
+        # Returns true if the component should be rendered incrementally
+        %i[html_streaming rsc_payload_streaming].include?(render_mode)
+      end
+
+      def rsc_payload_streaming?
+        # Returns true if the component should be rendered as a React Server Component
+        render_mode == :rsc_payload_streaming
+      end
+
+      def html_streaming?
+        # Returns true if the component should be rendered incrementally
+        render_mode == :html_streaming
+      end
+
+      def store_dependencies
+        options[:store_dependencies]
+      end
+
+      def self.generate_request_id
+        SecureRandom.uuid
       end
 
       private

data/lib/react_on_rails/server_rendering_js_code.rb

@@ -18,7 +18,6 @@ module ReactOnRails
         react_component_name: nil,
         render_options: nil
       )
-
         config_server_bundle_js = ReactOnRails.configuration.server_bundle_js_file
 
         if render_options.prerender == true && config_server_bundle_js.blank?

data/lib/react_on_rails/server_rendering_pool/ruby_embedded_java_script.rb

@@ -19,6 +19,10 @@ module ReactOnRails
         def reset_pool_if_server_bundle_was_modified
           return unless ReactOnRails.configuration.development_mode
 
+          # RSC (React Server Components) bundle changes are not monitored here since:
+          # 1. RSC is only supported in the Pro version of React on Rails
+          # 2. This RubyEmbeddedJavaScript pool is used exclusively in the non-Pro version
+          # 3. This pool uses ExecJS for JavaScript evaluation which does not support RSC
           if ReactOnRails::Utils.server_bundle_path_is_http?
             return if @server_bundle_url == ReactOnRails::Utils.server_bundle_js_file_path
 
@@ -56,7 +60,7 @@ module ReactOnRails
             @file_index += 1
           end
           begin
-            result = if render_options.stream?
+            result = if render_options.streaming?
                        js_evaluator.eval_streaming_js(js_code, render_options)
                      else
                        js_evaluator.eval_js(js_code, render_options)
@@ -73,10 +77,11 @@ module ReactOnRails
             if err.message.include?("ReferenceError: self is not defined")
               msg << "\nError indicates that you may have code-splitting incorrectly enabled.\n"
             end
+            msg << "\n#{Utils.default_troubleshooting_section}\n"
             raise ReactOnRails::Error, msg, err.backtrace
           end
 
-          return parse_result_and_replay_console_messages(result, render_options) unless render_options.stream?
+          return parse_result_and_replay_console_messages(result, render_options) unless render_options.streaming?
 
           # Streamed component is returned as stream of strings.
           # We need to parse each chunk and replay the console messages.
@@ -118,7 +123,7 @@ module ReactOnRails
         rescue StandardError => e
           msg = "You specified server rendering JS file: #{server_js_file}, but it cannot be " \
                 "read. You may set the server_bundle_js_file in your configuration to be \"\" to " \
-                "avoid this warning.\nError is: #{e}"
+                "avoid this warning.\nError is: #{e}\n\n#{Utils.default_troubleshooting_section}"
           raise ReactOnRails::Error, msg
         end
 
@@ -145,7 +150,8 @@ module ReactOnRails
             msg = "ERROR when compiling base_js_code! " \
                   "See file #{file_name} to " \
                   "correlate line numbers of error. Error is\n\n#{e.message}" \
-                  "\n\n#{e.backtrace.join("\n")}"
+                  "\n\n#{e.backtrace.join("\n")}" \
+                  "\n\n#{Utils.default_troubleshooting_section}"
             Rails.logger.error(msg)
             trace_js_code_used("Error when compiling JavaScript code for the context.", base_js_code,
                                file_name, force: true)
@@ -210,6 +216,7 @@ module ReactOnRails
 
         if defined?(ScoutApm)
           include ScoutApm::Tracer
+
           instrument_method :exec_server_render_js, type: "ReactOnRails", name: "ExecJs React Server Rendering"
         end
 
@@ -222,7 +229,7 @@ module ReactOnRails
           encoding_type = match[:encoding]
           response.body.force_encoding(encoding_type)
         rescue StandardError => e
-          msg = "file_url_to_string #{url} failed\nError is: #{e}"
+          msg = "file_url_to_string #{url} failed\nError is: #{e}\n\n#{Utils.default_troubleshooting_section}"
           raise ReactOnRails::Error, msg
         end