Update licensing information and enhance Pro features integration

AbanoubGhadban · AbanoubGhadban · commit 9c349eaeaf28 · 2025-09-18T23:23:59.000+03:00
- Updated LICENSE.md to clarify the MIT License applicability and introduce the React on Rails Pro License for specific directories.
- Refactored helper methods in `lib/react_on_rails/helper.rb` to utilize new Pro features, including immediate hydration support.
- Introduced `lib/react_on_rails/pro_features/helper.rb` to encapsulate Pro feature logic, including immediate hydration and warning badge generation.
- Adjusted imports in `node_package/src/ReactOnRails.node.ts` to reflect the new Pro directory structure.
- Added new files for React Server Component handling and RSC payload management in the Pro directory, enhancing server-side rendering capabilities.
- Improved error handling and stream management for RSC payloads to optimize performance and debugging.
diff --git a/LICENSE.md b/LICENSE.md
@@ -5,7 +5,12 @@
 
 ---
 
-# MIT License
+## MIT License for Core React on Rails
+
+This license applies to all files within this repository, with the exception of the code located in the following directories, which are licensed separately under the React on Rails Pro License:
+
+- `lib/react_on_rails/pro_features/`
+- `node_package/src/pro/`
 
 Copyright (c) 2017, 2018 Justin Gordon and ShakaCode  
 Copyright (c) 2015–2025 ShakaCode, LLC
@@ -31,3 +36,12 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
+
+---
+
+## React on Rails Pro License
+
+The code in the directories listed above is part of the React on Rails Pro framework and is licensed under the React on Rails Pro License.
+
+You can find the full text of the license agreement here:
+[REACT-ON-RAILS-PRO-LICENSE.md](./REACT-ON-RAILS-PRO-LICENSE.md)
diff --git a/lib/react_on_rails/helper.rb b/lib/react_on_rails/helper.rb
@@ -11,15 +11,14 @@
 require "react_on_rails/utils"
 require "react_on_rails/json_output"
 require "active_support/concern"
+require "react_on_rails/pro_features/helper"
 
 module ReactOnRails
   module Helper
     include ReactOnRails::Utils::Required
+    include ReactOnRails::ProFeatures::Helper
 
     COMPONENT_HTML_KEY = "componentHtml"
-    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."
 
     # react_component_name: can be a React function or class component or a "Render-Function".
     # "Render-Functions" differ from a React function in that they take two parameters, the
@@ -452,32 +451,6 @@ def load_pack_for_generated_component(react_component_name, render_options)
 
     # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity
 
-    # Checks if React on Rails Pro features are available
-    # @return [Boolean] true if Pro license is valid, false otherwise
-    def support_pro_features?
-      ReactOnRails::Utils.react_on_rails_pro_licence_valid?
-    end
-
-    def pro_warning_badge_if_needed(immediate_hydration)
-      return "".html_safe unless immediate_hydration
-      return "".html_safe if support_pro_features?
-
-      puts IMMEDIATE_HYDRATION_PRO_WARNING
-      Rails.logger.warn IMMEDIATE_HYDRATION_PRO_WARNING
-
-      tooltip_text = "The 'immediate_hydration' feature requires a React on Rails Pro license. Click to learn more."
-
-      badge_html = <<~HTML
-        <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
-      badge_html.strip.html_safe
-    end
 
     def run_stream_inside_fiber
       unless ReactOnRails::Utils.react_on_rails_pro?
@@ -689,17 +662,9 @@ def internal_react_component(react_component_name, options = {})
                                                 "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))
-
-      if render_options.immediate_hydration
-        component_specification_tag.concat(
-          content_tag(:script, %(
-typeof ReactOnRails === 'object' && ReactOnRails.reactOnRailsComponentLoaded('#{render_options.dom_id}');
-          ).html_safe)
-        )
-      end
+                                                "data-store-dependencies" => render_options.store_dependencies&.to_json)
+
+      component_specification_tag = apply_immediate_hydration_if_supported(component_specification_tag, render_options)
 
       load_pack_for_generated_component(react_component_name, render_options)
       # Create the HTML rendering part
@@ -717,18 +682,9 @@ def render_redux_store_data(redux_store_data)
       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))
-
-      if redux_store_data[:immediate_hydration]
-        store_hydration_data.concat(
-          content_tag(:script, <<~JS.strip_heredoc.html_safe
-            typeof ReactOnRails === 'object' && ReactOnRails.reactOnRailsStoreLoaded('#{redux_store_data[:store_name]}');
-          JS
-          )
-        )
-      end
+                                         "data-js-react-on-rails-store" => redux_store_data[:store_name].html_safe)
+
+      store_hydration_data = apply_store_immediate_hydration_if_supported(store_hydration_data, redux_store_data)
 
       prepend_render_rails_context(store_hydration_data)
     end
@@ -874,5 +830,3 @@ def raise_missing_autoloaded_bundle(react_component_name)
     end
   end
 end
-# rubocop:enable Metrics/ModuleLength
-# rubocop:enable Metrics/MethodLength
diff --git a/lib/react_on_rails/pro_features/helper.rb b/lib/react_on_rails/pro_features/helper.rb
@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+# /*
+#  * Copyright (c) 2025 Shakacode
+#  *
+#  * This file, and all other files in this directory, are NOT licensed under the MIT license.
+#  *
+#  * This file is part of React on Rails Pro.
+#  *
+#  * Unauthorized copying, modification, distribution, or use of this file, via any medium,
+#  * is strictly prohibited. It is proprietary and confidential.
+#  *
+#  * For the full license agreement, see:
+#  * https://github.com/shakacode/react_on_rails/blob/master/REACT-ON-RAILS-PRO-LICENSE.md
+#  */
+
+module ReactOnRails
+  module ProFeatures
+    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."
+
+      # This method is responsible for generating the necessary attributes and script tags
+      # for the immediate_hydration feature. It is enabled only when a valid
+      # React on Rails Pro license is detected.
+      def apply_immediate_hydration_if_supported(component_specification_tag, render_options)
+        return component_specification_tag unless render_options.immediate_hydration && support_pro_features?
+
+        # Add data attribute
+        component_specification_tag.gsub!(/>\z/, ' data-immediate-hydration="true">')
+
+        # Add immediate invocation script
+        component_specification_tag.concat(
+          content_tag(:script, %(
+            typeof ReactOnRails === 'object' && ReactOnRails.reactOnRailsComponentLoaded('#{render_options.dom_id}');
+          ).html_safe)
+        )
+      end
+
+      # Similar logic for redux_store
+      def apply_store_immediate_hydration_if_supported(store_hydration_data, redux_store_data)
+        return store_hydration_data unless redux_store_data[:immediate_hydration] && support_pro_features?
+
+        # Add data attribute
+        store_hydration_data.gsub!(/>\z/, ' data-immediate-hydration="true">')
+
+        # Add immediate invocation script
+        store_hydration_data.concat(
+          content_tag(:script, <<~JS.strip_heredoc.html_safe
+            typeof ReactOnRails === 'object' && ReactOnRails.reactOnRailsStoreLoaded('#{redux_store_data[:store_name]}');
+          JS
+          )
+        )
+      end
+
+      # Checks if React on Rails Pro features are available
+      # @return [Boolean] true if Pro license is valid, false otherwise
+      def support_pro_features?
+        ReactOnRails::Utils.react_on_rails_pro_licence_valid?
+      end
+
+      def pro_warning_badge_if_needed(immediate_hydration)
+        return "".html_safe unless immediate_hydration
+        return "".html_safe if support_pro_features?
+
+        puts IMMEDIATE_HYDRATION_PRO_WARNING
+        Rails.logger.warn IMMEDIATE_HYDRATION_PRO_WARNING
+
+        tooltip_text = "The 'immediate_hydration' feature requires a React on Rails Pro license. Click to learn more."
+
+        badge_html = <<~HTML
+          <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
+        badge_html.strip.html_safe
+      end
+    end
+  end
+end
diff --git a/node_package/src/ReactOnRails.node.ts b/node_package/src/ReactOnRails.node.ts
@@ -1,5 +1,5 @@
 import ReactOnRails from './ReactOnRails.full.ts';
-import streamServerRenderedReactComponent from './streamServerRenderedReactComponent.ts';
+import streamServerRenderedReactComponent from './pro/streamServerRenderedReactComponent.ts';
 
 ReactOnRails.streamServerRenderedReactComponent = streamServerRenderedReactComponent;
 
diff --git a/node_package/src/pro/ClientSideRenderer.ts b/node_package/src/pro/ClientSideRenderer.ts
@@ -1,7 +1,7 @@
 /* eslint-disable max-classes-per-file */
 
 import type { ReactElement } from 'react';
-import type { RailsContext, RegisteredComponent, RenderFunction, Root } from '../types/index';
+import type { RailsContext, RegisteredComponent, RenderFunction, Root } from '../types/index.ts';
 
 import { getRailsContext, resetRailsContext } from '../context.ts';
 import createReactOutput from '../createReactOutput.ts';
diff --git a/node_package/src/pro/PostSSRHookTracker.ts b/node_package/src/pro/PostSSRHookTracker.ts
diff --git a/node_package/src/pro/RSCProvider.tsx b/node_package/src/pro/RSCProvider.tsx
@@ -1,6 +1,6 @@
 import * as React from 'react';
 import type { ClientGetReactServerComponentProps } from './getReactServerComponent.client.ts';
-import { createRSCPayloadKey } from './utils.ts';
+import { createRSCPayloadKey } from '../utils.ts';
 
 type RSCContextType = {
   getComponent: (componentName: string, componentProps: unknown) => Promise<React.ReactNode>;
diff --git a/node_package/src/pro/RSCRequestTracker.ts b/node_package/src/pro/RSCRequestTracker.ts
@@ -1,10 +1,10 @@
 import { PassThrough, Readable } from 'stream';
-import { extractErrorMessage } from './utils.ts';
+import { extractErrorMessage } from '../utils.ts';
 import {
   RSCPayloadStreamInfo,
   RSCPayloadCallback,
   RailsContextWithServerComponentMetadata,
-} from './types/index.ts';
+} from '../types/index.ts';
 
 /**
  * Global function provided by React on Rails Pro for generating RSC payloads.
diff --git a/node_package/src/pro/RSCRoute.tsx b/node_package/src/pro/RSCRoute.tsx
diff --git a/node_package/src/pro/ReactOnRailsRSC.ts b/node_package/src/pro/ReactOnRailsRSC.ts
@@ -7,17 +7,17 @@ import {
   assertRailsContextWithServerStreamingCapabilities,
   StreamRenderState,
   StreamableComponentResult,
-} from './types/index.ts';
-import ReactOnRails from './ReactOnRails.full.ts';
-import handleError from './handleError.ts';
-import { convertToError } from './serverRenderUtils.ts';
+} from '../types/index.ts';
+import ReactOnRails from '../ReactOnRails.full.ts';
+import handleError from '../handleError.ts';
+import { convertToError } from '../serverRenderUtils.ts';
 
 import {
   streamServerRenderedComponent,
   StreamingTrackers,
   transformRenderStreamChunksToResultObject,
 } from './streamServerRenderedReactComponent.ts';
-import loadJsonFile from './loadJsonFile.ts';
+import loadJsonFile from '../loadJsonFile.ts';
 
 let serverRendererPromise: Promise<ReturnType<typeof buildServerRenderer>> | undefined;
 
@@ -93,5 +93,5 @@ ReactOnRails.serverRenderRSCReactComponent = (options: RSCRenderParams) => {
 
 ReactOnRails.isRSCBundle = true;
 
-export * from './types/index.ts';
+export * from '../types/index.ts';
 export default ReactOnRails;
diff --git a/node_package/src/pro/ServerComponentFetchError.ts b/node_package/src/pro/ServerComponentFetchError.ts
diff --git a/node_package/src/pro/getReactServerComponent.client.ts b/node_package/src/pro/getReactServerComponent.client.ts
@@ -1,8 +1,8 @@
 import * as React from 'react';
 import { createFromReadableStream } from 'react-on-rails-rsc/client.browser';
-import { createRSCPayloadKey, fetch, wrapInNewPromise, extractErrorMessage } from './utils.ts';
+import { createRSCPayloadKey, fetch, wrapInNewPromise, extractErrorMessage } from '../utils.ts';
 import transformRSCStreamAndReplayConsoleLogs from './transformRSCStreamAndReplayConsoleLogs.ts';
-import { RailsContext } from './types/index.ts';
+import { RailsContext } from '../types/index.ts';
 
 declare global {
   interface Window {
diff --git a/node_package/src/pro/getReactServerComponent.server.ts b/node_package/src/pro/getReactServerComponent.server.ts
@@ -1,8 +1,8 @@
 import { BundleManifest } from 'react-on-rails-rsc';
 import { buildClientRenderer } from 'react-on-rails-rsc/client.node';
 import transformRSCStream from './transformRSCNodeStream.ts';
-import loadJsonFile from './loadJsonFile.ts';
-import type { RailsContextWithServerStreamingCapabilities } from './types/index.ts';
+import loadJsonFile from '../loadJsonFile.ts';
+import type { RailsContextWithServerStreamingCapabilities } from '../types/index.ts';
 
 type GetReactServerComponentOnServerProps = {
   componentName: string;
diff --git a/node_package/src/pro/injectRSCPayload.ts b/node_package/src/pro/injectRSCPayload.ts
@@ -1,7 +1,7 @@
 import { PassThrough } from 'stream';
 import { finished } from 'stream/promises';
-import { createRSCPayloadKey } from './utils.ts';
-import { PipeableOrReadableStream } from './types/index.ts';
+import { createRSCPayloadKey } from '../utils.ts';
+import { PipeableOrReadableStream } from '../types/index.ts';
 import RSCRequestTracker from './RSCRequestTracker.ts';
 
 // In JavaScript, when an escape sequence with a backslash (\) is followed by a character
diff --git a/node_package/src/pro/registerServerComponent/client.tsx b/node_package/src/pro/registerServerComponent/client.tsx
@@ -1,7 +1,7 @@
 import * as React from 'react';
-import ReactOnRails from '../ReactOnRails.client.ts';
+import ReactOnRails from '../../ReactOnRails.client.ts';
 import RSCRoute from '../RSCRoute.tsx';
-import { ReactComponentOrRenderFunction } from '../types/index.ts';
+import { ReactComponentOrRenderFunction } from '../../types/index.ts';
 import wrapServerComponentRenderer from '../wrapServerComponentRenderer/client.tsx';
 
 /**
diff --git a/node_package/src/pro/registerServerComponent/server.rsc.ts b/node_package/src/pro/registerServerComponent/server.rsc.ts
@@ -1,5 +1,5 @@
-import ReactOnRails from '../ReactOnRails.client.ts';
-import { ReactComponent, RenderFunction } from '../types/index.ts';
+import ReactOnRails from '../../ReactOnRails.client.ts';
+import { ReactComponent, RenderFunction } from '../../types/index.ts';
 
 /**
  * Registers React Server Components in the RSC bundle.
diff --git a/node_package/src/pro/registerServerComponent/server.tsx b/node_package/src/pro/registerServerComponent/server.tsx
@@ -1,7 +1,7 @@
 import * as React from 'react';
-import ReactOnRails from '../ReactOnRails.client.ts';
+import ReactOnRails from '../../ReactOnRails.client.ts';
 import RSCRoute from '../RSCRoute.tsx';
-import { ReactComponent, RenderFunction } from '../types/index.ts';
+import { ReactComponent, RenderFunction } from '../../types/index.ts';
 import wrapServerComponentRenderer from '../wrapServerComponentRenderer/server.tsx';
 
 /**
diff --git a/node_package/src/pro/streamServerRenderedReactComponent.ts b/node_package/src/pro/streamServerRenderedReactComponent.ts
@@ -1,13 +1,13 @@
 import * as React from 'react';
 import { PassThrough, Readable } from 'stream';
 
-import * as ComponentRegistry from './pro/ComponentRegistry.ts';
-import createReactOutput from './createReactOutput.ts';
-import { isPromise, isServerRenderHash } from './isServerRenderResult.ts';
-import buildConsoleReplay from './buildConsoleReplay.ts';
-import handleError from './handleError.ts';
-import { renderToPipeableStream } from './ReactDOMServer.cts';
-import { createResultObject, convertToError, validateComponent } from './serverRenderUtils.ts';
+import * as ComponentRegistry from './ComponentRegistry.ts';
+import createReactOutput from '../createReactOutput.ts';
+import { isPromise, isServerRenderHash } from '../isServerRenderResult.ts';
+import buildConsoleReplay from '../buildConsoleReplay.ts';
+import handleError from '../handleError.ts';
+import { renderToPipeableStream } from '../ReactDOMServer.cjs';
+import { createResultObject, convertToError, validateComponent } from '../serverRenderUtils.ts';
 import {
   assertRailsContextWithServerStreamingCapabilities,
   RenderParams,
@@ -16,7 +16,7 @@ import {
   PipeableOrReadableStream,
   RailsContextWithServerStreamingCapabilities,
   assertRailsContextWithServerComponentMetadata,
-} from './types/index.ts';
+} from '../types/index.ts';
 import injectRSCPayload from './injectRSCPayload.ts';
 import PostSSRHookTracker from './PostSSRHookTracker.ts';
 import RSCRequestTracker from './RSCRequestTracker.ts';
diff --git a/node_package/src/pro/transformRSCNodeStream.ts b/node_package/src/pro/transformRSCNodeStream.ts
diff --git a/node_package/src/pro/transformRSCStreamAndReplayConsoleLogs.ts b/node_package/src/pro/transformRSCStreamAndReplayConsoleLogs.ts
@@ -1,4 +1,4 @@
-import { RSCPayloadChunk } from './types/index.ts';
+import { RSCPayloadChunk } from '../types/index.ts';
 
 /**
  * Transforms an RSC stream and replays console logs on the client.
diff --git a/node_package/src/pro/wrapServerComponentRenderer/client.tsx b/node_package/src/pro/wrapServerComponentRenderer/client.tsx
@@ -1,8 +1,8 @@
 import * as React from 'react';
 import * as ReactDOMClient from 'react-dom/client';
-import { ReactComponentOrRenderFunction, RenderFunction } from '../types/index.ts';
-import isRenderFunction from '../isRenderFunction.ts';
-import { ensureReactUseAvailable } from '../reactApis.cts';
+import { ReactComponentOrRenderFunction, RenderFunction } from '../../types/index.ts';
+import isRenderFunction from '../../isRenderFunction.ts';
+import { ensureReactUseAvailable } from '../../reactApis.cjs';
 import { createRSCProvider } from '../RSCProvider.tsx';
 import getReactServerComponent from '../getReactServerComponent.client.ts';
 
diff --git a/node_package/src/pro/wrapServerComponentRenderer/server.rsc.tsx b/node_package/src/pro/wrapServerComponentRenderer/server.rsc.tsx
diff --git a/node_package/src/pro/wrapServerComponentRenderer/server.tsx b/node_package/src/pro/wrapServerComponentRenderer/server.tsx
