react_on_rails_pro 16.4.0.rc.7 → 16.4.0.rc.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8d5365a9653da4cdc8ea771167d5b26dd03602c4977d7fea747ec2a07cc6900
-  data.tar.gz: 57afd9dc58238f94d2d008cc01900596a18cb63894786cb60ce99471902500c9
+  metadata.gz: c63303b689f4adb5d1be96c2415522aeb05fd210258535c2a8fe3421414870a9
+  data.tar.gz: d0e63c69ac3c6ca63021ed54fc6f8f1fa6c574f0a261e74d6d6b4b9970a05c8a
 SHA512:
-  metadata.gz: fb6bb5c6f0b45d62151be232c4ddf9b8343aaa086162e1f8292f9468b2902c146a5668c1b1e79753a919a6063eae8ddbf1a19ad4cb8e178734e77fb9303efa1d
-  data.tar.gz: 9da57b6e9750c1f5fe4f830b375bfd2dd7e7e07b6c2135b5e9a30ec5156f70c4e41180a8737a205150bf7b8687dfa1b16c035bb88eb03fd3d89dbdc71e25c625
+  metadata.gz: 920e935410da89b4bbd5951c70e1b4f528e7525bba8f2d27094fbe1ce0676ac17f1277a100d235d6d74186a3414765e40f471de7dd0b7bb7e4faa68d04c61426
+  data.tar.gz: a4d980d3b3bdb5ace4a9d18902dbfabb35c2c2c99a3c354e5cbc39bda05853500d466d34c748e612dea4e0f0886849ed255be92082274befbaabc971af6b327e

data/CONTRIBUTING.md

@@ -47,12 +47,12 @@ From [How to Write a Git Commit Message](http://chris.beams.io/posts/git-commit/
 ## Doc Changes
 
 When making doc changes, we want the change to work on both [the ShakaCode docs site](https://www.shakacode.com/react-on-rails-pro/docs/) and when browsing the GitHub repo.
-The issue is that the Shakacode site is generated only from files in [`docs`](./docs), so any references from them to non-doc files must use the full GitHub URL.
+The issue is that the ShakaCode site is generated only from files in [`../docs/pro`](../docs/pro), so any references from them to non-doc files must use the full GitHub URL.
 
 ### Links to other docs:
 
 - When making references to doc files, use a relative URL path like:
-  `[Installation Overview](docs/basics/installation-overview.md)`
+  `[Installation Guide](../docs/pro/installation.md)`
 
 - When making references to source code files, use a full url path like:
   `[spec/dummy/config/initializers/react_on_rails.rb](https://github.com/shakacode/react_on_rails/tree/master/react_on_rails_pro/spec/dummy/config/initializers/react_on_rails.rb)`

data/Gemfile.lock

@@ -9,7 +9,7 @@ GIT
 PATH
   remote: ..
   specs:
-    react_on_rails (16.4.0.rc.7)
+    react_on_rails (16.4.0.rc.9)
       addressable
       connection_pool
       execjs (~> 2.5)
@@ -20,7 +20,7 @@ PATH
 PATH
   remote: .
   specs:
-    react_on_rails_pro (16.4.0.rc.7)
+    react_on_rails_pro (16.4.0.rc.9)
       addressable
       async (>= 2.6)
       connection_pool
@@ -29,7 +29,7 @@ PATH
       httpx (~> 1.5)
       jwt (~> 2.7)
       rainbow
-      react_on_rails (= 16.4.0.rc.7)
+      react_on_rails (= 16.4.0.rc.9)
 
 GEM
   remote: https://rubygems.org/

data/LICENSE_SETUP.md

@@ -75,13 +75,16 @@ heroku config:set REACT_ON_RAILS_PRO_LICENSE="your_token"
 Configure your license token via the `REACT_ON_RAILS_PRO_LICENSE` environment variable.
 Never commit license tokens to version control.
 
-## License Validation
+## License Validation and Signals
 
-The license is validated at multiple points:
+License-related checks and signals occur at multiple points:
 
 1. **Ruby Gem**: When Rails application starts
 2. **Node Renderer**: When the Node renderer process starts
-3. **Browser Package**: Trusts server-side validation (via `railsContext.rorPro`)
+3. **Browser Package**: Receives Pro-installed signal via `railsContext.rorPro` (not license-valid state)
+
+The browser package does not perform independent license validation. A valid paid license is still required for
+production deployments.
 
 When no license is present, the application runs in **unlicensed mode**. This is fine for development, testing, and CI/CD. Production deployments should always have a valid paid license.
 
@@ -148,7 +151,7 @@ The task exits with code 0 on success and code 1 if the license is missing, inva
 | Field                  | Type            | Description                                         |
 | ---------------------- | --------------- | --------------------------------------------------- |
 | `status`               | string          | `"valid"`, `"expired"`, `"invalid"`, or `"missing"` |
-| `organization`         | string or null  | Organization name from the license                  |
+| `organization`         | string or null  | Organization name from the JWT `org` claim          |
 | `plan`                 | string or null  | License plan (`"paid"`, `"startup"`, etc.)          |
 | `expiration`           | string or null  | ISO 8601 expiration date                            |
 | `attribution_required` | boolean         | Whether attribution is required                     |
@@ -302,11 +305,13 @@ The license is a JWT (JSON Web Token) signed with RSA-256, containing:
   "iat": 1234567890, // Issued at timestamp (REQUIRED)
   "exp": 1234567890, // Expiration timestamp (REQUIRED)
   "plan": "paid", // License plan (Optional — only "paid" is valid for production)
-  "organization": "Your Company", // Organization name (Optional)
+  "org": "Your Company", // Organization name (Optional)
   "iss": "api" // Issuer identifier (Optional, standard JWT claim)
 }
 ```
 
+> Note: The JWT claim is `org`. The verify task output uses the field name `organization` for readability.
+
 ### Security
 
 - **Offline validation**: No internet connection required

data/README.md

@@ -156,7 +156,7 @@ end %>
 - Automatic cache invalidation based on props
 - Works with Rails fragment caching infrastructure
 
-**📖 Learn more**: [docs/caching.md](./docs/caching.md)
+**📖 Learn more**: [docs/pro/caching.md](../docs/pro/caching.md)
 
 ### 2. Prerender Caching
 
@@ -175,7 +175,7 @@ end
 - Caches across multiple requests
 - Complements fragment caching for maximum performance
 
-**📖 Learn more**: [docs/caching.md](./docs/caching.md)
+**📖 Learn more**: [docs/pro/caching.md](../docs/pro/caching.md)
 
 ### 3. React on Rails Pro Node Renderer
 
@@ -203,7 +203,7 @@ reactOnRailsProNodeRenderer({
 });
 ```
 
-**📖 Learn more**: [docs/node-renderer/basics.md](./docs/node-renderer/basics.md)
+**📖 Learn more**: [docs/pro/node-renderer/basics.md](../docs/pro/node-renderer/basics.md)
 
 ### 4. React Server Components (RSC)
 
@@ -236,7 +236,7 @@ Speed up webpack rebuilds by caching unchanged bundles.
 - **Faster development**: Hot reload only what changed
 - **Lower costs**: Reduce build server time
 
-**📖 Learn more**: [docs/bundle-caching.md](./docs/bundle-caching.md)
+**📖 Learn more**: [docs/pro/bundle-caching.md](../docs/pro/bundle-caching.md)
 
 ### 6. Global State Management
 
@@ -249,7 +249,7 @@ ReactOnRailsPro.configure do |config|
 end
 ```
 
-**📖 Learn more**: [docs/configuration.md](./docs/configuration.md)
+**📖 Learn more**: [docs/pro/configuration.md](../docs/pro/configuration.md)
 
 ---
 
@@ -326,9 +326,9 @@ rails console
 
 ### Next Steps
 
-- **Enable caching**: See [docs/caching.md](./docs/caching.md)
-- **Set up Node Renderer**: See [docs/node-renderer/basics.md](./docs/node-renderer/basics.md)
-- **Optimize performance**: See [docs/configuration.md](./docs/configuration.md)
+- **Enable caching**: See [docs/pro/caching.md](../docs/pro/caching.md)
+- **Set up Node Renderer**: See [docs/pro/node-renderer/basics.md](../docs/pro/node-renderer/basics.md)
+- **Optimize performance**: See [docs/pro/configuration.md](../docs/pro/configuration.md)
 - **Set up for your team**: See [LICENSE_SETUP.md](./LICENSE_SETUP.md#team-setup)
 
 ---
@@ -337,20 +337,20 @@ rails console
 
 ### Installation & Setup
 
-- **[Installation Guide](./docs/installation.md)** - Detailed installation instructions
+- **[Installation Guide](../docs/pro/installation.md)** - Detailed installation instructions
 - **[License Setup](./LICENSE_SETUP.md)** - Complete license configuration guide
-- **[Configuration Reference](./docs/configuration.md)** - All configuration options
+- **[Configuration Reference](../docs/pro/configuration.md)** - All configuration options
 
 ### Features
 
-- **[Caching Guide](./docs/caching.md)** - Fragment and prerender caching
-- **[Bundle Caching](./docs/bundle-caching.md)** - Speed up webpack builds
-- **[Node Renderer Basics](./docs/node-renderer/basics.md)** - Standalone Node.js server
-- **[Node Renderer Configuration](./docs/node-renderer/js-configuration.md)** - JavaScript config
+- **[Caching Guide](../docs/pro/caching.md)** - Fragment and prerender caching
+- **[Bundle Caching](../docs/pro/bundle-caching.md)** - Speed up webpack builds
+- **[Node Renderer Basics](../docs/pro/node-renderer/basics.md)** - Standalone Node.js server
+- **[Node Renderer Configuration](../docs/pro/node-renderer/js-configuration.md)** - JavaScript config
 
 ### API Reference
 
-- **[Ruby API](./docs/ruby-api.md)** - Helper methods and utilities
+- **[Ruby API](../docs/pro/ruby-api.md)** - Helper methods and utilities
 - **[CHANGELOG](./CHANGELOG.md)** - Version history and upgrade notes
 
 ### Upgrading
@@ -408,7 +408,7 @@ Check out these production applications using React on Rails Pro:
 
 - **📧 Email Support**: [support@shakacode.com](mailto:support@shakacode.com)
 - **💼 Sales & Licensing**: [justin@shakacode.com](mailto:justin@shakacode.com)
-- **📖 Documentation**: [docs/](./docs/)
+- **📖 Documentation**: [docs/pro/](../docs/pro/)
 - **🐛 Found a Bug?**: Email [support@shakacode.com](mailto:support@shakacode.com) (for Pro customers)
 
 ### Professional Services

data/lib/react_on_rails_pro/compression_middleware_guard.rb

@@ -0,0 +1,164 @@
+# frozen_string_literal: true
+
+require "stringio"
+require "timeout"
+
+module ReactOnRailsPro
+  class CompressionMiddlewareGuard
+    COMPATIBILITY_GUIDE_PATH =
+      "https://www.shakacode.com/react-on-rails/docs/building-features/" \
+      "streaming-server-rendering/#compression-middleware-compatibility"
+    PROBLEMATIC_MIDDLEWARES = %w[Rack::Deflater Rack::Brotli].freeze
+    PROBE_TIMEOUT_SECONDS = 1
+
+    Finding = Struct.new(:middleware_name, :source_location, keyword_init: true)
+
+    def initialize(middlewares:, logger: nil)
+      @middlewares = normalize_middlewares(middlewares)
+      @logger = logger
+    end
+
+    def findings
+      @findings ||= @middlewares.filter_map do |middleware|
+        next unless problematic_middleware?(middleware)
+
+        condition = middleware_condition(middleware)
+        next unless condition.respond_to?(:call)
+        next unless destructively_iterates_stream?(condition)
+
+        Finding.new(
+          middleware_name: middleware_name(middleware),
+          source_location: source_location_for(condition)
+        )
+      end
+    end
+
+    def warning_messages(root:)
+      findings.map do |finding|
+        "[React on Rails Pro] #{finding.middleware_name} has a custom `:if` callback" \
+          "#{formatted_source_location(finding, root: root)} that calls `body.each`. " \
+          "This is incompatible with streaming SSR/RSC and can deadlock `ActionController::Live` responses. " \
+          "Remove the custom `:if`, or guard it with " \
+          "`return true unless body.respond_to?(:to_ary)` before iterating. " \
+          "See #{COMPATIBILITY_GUIDE_PATH}."
+      end
+    end
+
+    private
+
+    def normalize_middlewares(middlewares)
+      if defined?(ActionDispatch::MiddlewareStack) && middlewares.is_a?(ActionDispatch::MiddlewareStack)
+        return middlewares.middlewares
+      end
+
+      Array(middlewares)
+    end
+
+    def problematic_middleware?(middleware)
+      PROBLEMATIC_MIDDLEWARES.include?(middleware_name(middleware))
+    end
+
+    def middleware_name(middleware)
+      middleware.klass.respond_to?(:name) ? middleware.klass.name : middleware.klass.to_s
+    end
+
+    def middleware_condition(middleware)
+      Array(middleware.args).filter_map do |arg|
+        next unless arg.is_a?(Hash)
+
+        arg[:if] || arg["if"]
+      end.first
+    end
+
+    def destructively_iterates_stream?(condition)
+      probe = StreamingBodyProbe.new
+
+      Timeout.timeout(PROBE_TIMEOUT_SECONDS) do
+        condition.call(probe_env, 200, probe_headers, probe)
+      end
+      probe.iterated?
+    rescue StreamingBodyProbe::BodyIteratedError
+      true
+    rescue Timeout::Error => e
+      return true if probe.iterated?
+
+      log_probe_failure(condition, e, reason: "timed out after #{PROBE_TIMEOUT_SECONDS}s")
+      false
+    rescue StandardError => e
+      return true if probe.iterated?
+
+      log_probe_failure(condition, e)
+      false
+    end
+
+    # Minimal Rack env used to probe `:if` callbacks.
+    # Callbacks that depend on application-specific keys can still raise here;
+    # those probe failures are logged at debug level and treated as non-findings.
+    # Path-gated callbacks can bypass this probe and yield false negatives.
+    def probe_env
+      {
+        "CONTENT_TYPE" => "text/html; charset=utf-8",
+        "HTTP_ACCEPT" => "text/html",
+        "REQUEST_METHOD" => "GET",
+        "PATH_INFO" => "/__react_on_rails_pro_stream_probe__",
+        "HTTP_ACCEPT_ENCODING" => "br, gzip, identity",
+        "HTTP_HOST" => "example.test",
+        "SERVER_NAME" => "example.test",
+        "rack.url_scheme" => "https",
+        "rack.errors" => StringIO.new,
+        "rack.input" => StringIO.new
+      }
+    end
+
+    def probe_headers
+      {
+        "Content-Type" => "text/html; charset=utf-8"
+      }
+    end
+
+    def formatted_source_location(finding, root:)
+      return "" unless finding.source_location
+
+      path, line = finding.source_location
+      root_prefix = "#{root}/"
+      display_path = path.start_with?(root_prefix) ? path.delete_prefix(root_prefix) : path
+
+      " (#{display_path}:#{line})"
+    end
+
+    def source_location_for(condition)
+      condition.respond_to?(:source_location) ? condition.source_location : nil
+    end
+
+    def log_probe_failure(condition, error, reason: nil)
+      return unless @logger.respond_to?(:debug)
+
+      identifier = source_location_for(condition)&.join(":") || condition.class.name || condition.inspect
+      backtrace_hint = error.backtrace&.first
+
+      @logger.debug do
+        message = "[React on Rails Pro] CompressionMiddlewareGuard could not probe `:if` callback " \
+                  "(#{identifier}): "
+        message += "#{reason}: " if reason
+        message += "#{error.class}: #{error.message}"
+        message += " (#{backtrace_hint})" if backtrace_hint
+        message
+      end
+    end
+
+    class StreamingBodyProbe
+      include Enumerable
+
+      class BodyIteratedError < StandardError; end
+
+      def iterated?
+        @iterated == true
+      end
+
+      def each
+        @iterated = true
+        raise BodyIteratedError, "Compression middleware `:if` callback called `body.each` on a streaming body."
+      end
+    end
+  end
+end

data/lib/react_on_rails_pro/concerns/rsc_payload_renderer.rb

@@ -27,7 +27,9 @@ module ReactOnRailsPro
         "[React on Rails Pro] RSC payload templates are now rendered with format :text. " \
         "If you override `custom_rsc_payload_template`, make sure the override resolves to " \
         "a text or format-neutral template (for example `rsc_payload.text.erb`) instead of " \
-        "only `.html.erb`. See react_on_rails_pro/docs/updating.md for upgrade notes.\n\n" \
+        "only `.html.erb`. See\n" \
+        "https://github.com/shakacode/react_on_rails/blob/master/docs/pro/updating.md " \
+        "for upgrade notes.\n\n" \
         "Original error: #{e.message}"
       )
     end

data/lib/react_on_rails_pro/engine.rb

@@ -7,10 +7,8 @@ module ReactOnRailsPro
     LICENSE_URL = "https://www.shakacode.com/react-on-rails-pro/"
     # TODO: Remove this legacy migration warning path after 16.5.0 stable release (target: 2026-05-31).
     LEGACY_LICENSE_FILE = "config/react_on_rails_pro_license.key"
-    RSC_STREAMING_MIDDLEWARE_WARNING_TARGETS = ["Rack::Deflater"].freeze
     private_constant :LICENSE_URL
     private_constant :LEGACY_LICENSE_FILE
-    private_constant :RSC_STREAMING_MIDDLEWARE_WARNING_TARGETS
 
     initializer "react_on_rails_pro.routes" do
       ActionDispatch::Routing::Mapper.include ReactOnRailsPro::Routes
@@ -22,8 +20,8 @@ module ReactOnRailsPro
       config.after_initialize { ReactOnRailsPro::Engine.log_license_status }
     end
 
-    initializer "react_on_rails_pro.check_rsc_streaming_middleware" do
-      config.after_initialize { ReactOnRailsPro::Engine.log_rsc_streaming_middleware_warning }
+    initializer "react_on_rails_pro.warn_on_problematic_compression_middleware" do
+      config.after_initialize { ReactOnRailsPro::Engine.log_problematic_compression_middleware_warnings }
     end
 
     class << self
@@ -46,22 +44,12 @@ module ReactOnRailsPro
         end
       end
 
-      def log_rsc_streaming_middleware_warning
-        return unless ReactOnRailsPro.configuration.enable_rsc_support
-        return if Rails.env.test?
-
-        middleware_names = middleware_stack_names
-        problematic = RSC_STREAMING_MIDDLEWARE_WARNING_TARGETS & middleware_names
-        return if problematic.empty?
-
-        route_path = ReactOnRailsPro.configuration.rsc_payload_generation_url_path
-        Rails.logger.warn(
-          "[React on Rails Pro] React Server Components support is enabled and the middleware " \
-          "stack includes #{problematic.join(', ')}. Compression and other response-transforming " \
-          "middleware can interfere with ActionController::Live NDJSON streaming. If your " \
-          "`#{route_path}` payload route is not already exempt, consider bypassing " \
-          "#{problematic.join(', ')} for that endpoint if you see stalled or corrupted RSC payloads."
-        )
+      def log_problematic_compression_middleware_warnings(logger: Rails.logger,
+                                                          middlewares: Rails.application.middleware,
+                                                          root: Rails.root)
+        CompressionMiddlewareGuard.new(middlewares: middlewares, logger: logger)
+                                  .warning_messages(root: root)
+                                  .each { |message| logger.warn(message) }
       end
 
       private
@@ -129,40 +117,6 @@ module ReactOnRailsPro
           Rails.logger.info message
         end
       end
-
-      def middleware_stack_names
-        middleware_stack = Rails.application&.middleware
-        return [] unless middleware_stack
-
-        entries =
-          if middleware_stack.respond_to?(:middlewares)
-            middleware_stack.middlewares
-          elsif middleware_stack.respond_to?(:to_a)
-            middleware_stack.to_a
-          else
-            Array(middleware_stack)
-          end
-
-        entries.filter_map { |entry| middleware_entry_name(entry) }.uniq
-      end
-
-      def middleware_entry_name(entry)
-        candidate =
-          if entry.respond_to?(:klass) && entry.klass
-            entry.klass
-          elsif entry.is_a?(Array)
-            entry.first
-          else
-            entry
-          end
-
-        case candidate
-        when Module
-          candidate.name
-        else
-          candidate.to_s.presence
-        end
-      end
     end
   end
 end

data/lib/react_on_rails_pro/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module ReactOnRailsPro
-  VERSION = "16.4.0.rc.7"
+  VERSION = "16.4.0.rc.9"
   PROTOCOL_VERSION = "2.0.0"
 end

data/lib/react_on_rails_pro.rb

@@ -6,6 +6,7 @@ require "react_on_rails"
 require "react_on_rails_pro/request"
 require "react_on_rails_pro/version"
 require "react_on_rails_pro/constants"
+require "react_on_rails_pro/compression_middleware_guard"
 require "react_on_rails_pro/engine"
 require "react_on_rails_pro/error"
 require "react_on_rails_pro/utils"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: react_on_rails_pro
 version: !ruby/object:Gem::Version
-  version: 16.4.0.rc.7
+  version: 16.4.0.rc.9
 platform: ruby
 authors:
 - Justin Gordon
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-03-09 00:00:00.000000000 Z
+date: 2026-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -128,14 +128,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 16.4.0.rc.7
+        version: 16.4.0.rc.9
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 16.4.0.rc.7
+        version: 16.4.0.rc.9
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -225,42 +225,12 @@ files:
 - app/helpers/react_on_rails_pro_helper.rb
 - app/views/react_on_rails_pro/rsc_payload.text.erb
 - babel.config.js
-- docs/bundle-caching.md
-- docs/caching.md
-- docs/code-splitting-loadable-components.md
-- docs/configuration.md
-- docs/home-pro.md
-- docs/installation.md
-- docs/js-memory-leaks.md
-- docs/node-renderer/basics.md
-- docs/node-renderer/debugging.md
-- docs/node-renderer/error-reporting-and-tracing.md
-- docs/node-renderer/heroku.md
-- docs/node-renderer/js-configuration.md
-- docs/node-renderer/troubleshooting.md
-- docs/profiling-server-side-rendering-code.md
-- docs/react-server-components/add-streaming-and-interactivity.md
-- docs/react-server-components/create-without-ssr.md
-- docs/react-server-components/flight-protocol-syntax.md
-- docs/react-server-components/glossary.md
-- docs/react-server-components/how-react-server-components-work.md
-- docs/react-server-components/inside-client-components.md
-- docs/react-server-components/purpose-and-benefits.md
-- docs/react-server-components/rendering-flow.md
-- docs/react-server-components/selective-hydration-in-streamed-components.md
-- docs/react-server-components/server-side-rendering.md
-- docs/react-server-components/tutorial.md
-- docs/release-notes/4.0.md
-- docs/release-notes/v4-react-server-components.md
-- docs/ruby-api.md
-- docs/streaming-server-rendering.md
-- docs/troubleshooting.md
-- docs/updating.md
 - eslint.config.mjs
 - lib/react_on_rails_pro.rb
 - lib/react_on_rails_pro/assets_precompile.rb
 - lib/react_on_rails_pro/async_value.rb
 - lib/react_on_rails_pro/cache.rb
+- lib/react_on_rails_pro/compression_middleware_guard.rb
 - lib/react_on_rails_pro/concerns/async_rendering.rb
 - lib/react_on_rails_pro/concerns/rsc_payload_renderer.rb
 - lib/react_on_rails_pro/concerns/stream.rb