react_on_rails_pro 16.4.0.rc.7 → 16.4.0.rc.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8d5365a9653da4cdc8ea771167d5b26dd03602c4977d7fea747ec2a07cc6900
-  data.tar.gz: 57afd9dc58238f94d2d008cc01900596a18cb63894786cb60ce99471902500c9
+  metadata.gz: 717ead6ca9b9c1f7354820f063551a8403cabb9fafeb095bd46f35e3d368a483
+  data.tar.gz: 5062b202868b9106090becb6dd5f040761a2dd37ec2a1323053e43df111044ed
 SHA512:
-  metadata.gz: fb6bb5c6f0b45d62151be232c4ddf9b8343aaa086162e1f8292f9468b2902c146a5668c1b1e79753a919a6063eae8ddbf1a19ad4cb8e178734e77fb9303efa1d
-  data.tar.gz: 9da57b6e9750c1f5fe4f830b375bfd2dd7e7e07b6c2135b5e9a30ec5156f70c4e41180a8737a205150bf7b8687dfa1b16c035bb88eb03fd3d89dbdc71e25c625
+  metadata.gz: b2fc8c9ad613776be17f834f8a7c2d7ff07b123e6e703b8dd21ffdc4687ee51d0037b49c813c7f7b9596266bfa15885336b1f6ce9df6530e995c68d58557d745
+  data.tar.gz: 025cf054e18a200c61ad22199617ce0374889b1f825290ee13952f02bb993532cf8b1738c0df4a7295c4b9bf576782bf42abe04395f9071dd46b0686697c8c5b

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.8)
       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.8)
       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.8)
 
 GEM
   remote: https://rubygems.org/

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/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/version.rb

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

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.8
 platform: ruby
 authors:
 - Justin Gordon
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-03-09 00:00:00.000000000 Z
+date: 2026-03-11 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.8
   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.8
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -225,37 +225,6 @@ 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

data/docs/bundle-caching.md

@@ -1,219 +0,0 @@
-# Bundle Caching
-
-## Why?
-
-Building webpack bundles is often time-consuming, and the same bundles are built many times.
-For example, you might build the production bundles during CI, then for a Review app, then
-for Staging, and maybe even for Production. Or you might want to deploy a small Ruby-only
-change to production, but you will have to wait minutes for your bundles to be built again.
-
-## Solution
-
-React on Rails 2.1.0 introduces bundle caching based on a digest of all the source files, defined
-in the `config/shakapacker.yml` file, plus other files defined with `config.dependency_globs` and
-excluding any files from `config.excluded_dependency_globs`. Creating this hash key takes at most a
-few seconds for even large projects. Additionally, the cache key includes
-
-1. NODE_ENV
-2. Version of React on Rails Pro
-3. Configurable additional env values by supplying an array in method cache_keys on the `remote_bundle_cache_adapter`. See examples below.
-
-This cache key is used for saving files to some remote storage, typically S3.
-
-## Bonus for local development with multiple directories building production builds
-
-Bundle caching can help save time if you have multiple directories for the same repository.
-
-The bundles are cached in `Rails.root.join('tmp', 'bundle_cache')`
-
-So, if you have sibling directories for the same project, you can make a sym link so both directories use the same bundle cache directory.
-
-```
-cd my_project2/tmp
-ln -s ../../my_project/tmp/bundle_cache
-```
-
-## Configuration
-
-### 1. React on Rails Configuration
-
-First, we need to tell React on Rails to use a custom build module. In
-`config/initializers/react_on_rails`, set this value:
-
-```ruby
-config.build_production_command = ReactOnRailsPro::AssetsPrecompile
-```
-
-Alternatively, if you need to run something after the files are built or extracted from the cache, you can do something like this:
-
-```ruby
-ReactOnRails.configure do |config|
-  # This configures the script to run to build the production assets by webpack. Set this to nil
-  # if you don't want react_on_rails building this file for you.
-  config.build_production_command = CustomBuildCommand
-end
-```
-
-And define it like this:
-
-```ruby
-module CustomBuildCommand
-  def self.call
-    ReactOnRailsPro::AssetsPrecompile.call
-    Rake::Task['react_on_rails_pro:pre_stage_bundle_for_node_renderer'].invoke
-  end
-end
-```
-
-### 2. React on Rails Pro Configuration
-
-Next, we need to configure the `config/initializers/react_on_rails_pro.rb` with some module,
-say called S3BundleCacheAdapter.
-
-```
-config.remote_bundle_cache_adapter = S3BundleCacheAdapter
-```
-
-This module needs four class methods: `cache_keys` (optional), `build`, `fetch`, `upload`. See two
-examples of this below.
-
-Also, add whatever file the remote_bundle_cache_adapter module is defined in to `config.dependency_globs`.
-
-If there are any other files for which changes should bust the fragment cache for
-cached_react_component and cached_react_component_hash, add those as well to `config.dependency_globs`. This should include any files used to generate the JSON props, webpack and/or Shakapacker configuration files, and package lockfiles.
-
-To simplify your configuration, entire directories can be added to `config.dependency_globs` & then any irrelevant files or subdirectories can be added to `config.excluded_dependency_globs`
-
-For example:
-
-```ruby
-  config.dependency_globs = [ File.join(Rails.root, "app", "views", "**", "*.jbuilder") ]
-  config.excluded_dependency_globs = [ File.join(Rails.root, "app", "views", "**", "dont_hash_this.jbuilder") ]
-```
-
-will hash all files in `app/views` that have the `jbuilder` extension except for any file named `dont_hash_this.jbuilder`.
-
-The goal is that Ruby only changes that don't affect your webpack bundles don't change the cache keys, and anything that could affect the bundles MUST change the cache keys!
-
-### 3. Remove any call to rake task `react_on_rails_pro:pre_stage_bundle_for_node_renderer`
-
-This task is called automatically if you're using bundle caching.
-
-```ruby
-  Rake::Task['react_on_rails_pro:pre_stage_bundle_for_node_renderer'].invoke
-```
-
-#### Custom ENV cache keys
-
-Check your webpack config for the webpack.DefinePlugin. That allows JS code to use
-`process.env.MY_ENV_VAR` resulting in bundles that differ depending on the ENV value set.
-
-Thus, if you access these `process.env.MY_ENV_VAR` in your JS code, then you need to include such
-ENV vars in return value of the `cache keys` method.
-
-A much better approach than accessing `process.env` is to use the
-`config/initializers/react_on_rails.rb` setting for the`config.rendering_extension` to always
-pass some values into the rendering props.
-
-See [our railsContext docs](https://www.shakacode.com/react-on-rails/docs/basics/render-functions-and-railscontext/#customization-of-the-railscontext) for more details.
-
-Also, if your webpack build process depends on any ENV values, then you will also need to add those
-to return value of the `cache_keys` method.
-
-Note, the NODE_ENV value is always included in the cache_keys.
-
-Another use of the ENV values would be a cache version, so incrementing this ENV value
-would force a new cache value.
-
-## Disabling via an ENV value
-
-Once configured for bundle caching, ReactOnRailsPro::AssetsPrecompile's caching functionality
-can be disabled by setting ENV["DISABLE_PRECOMPILE_CACHE"] equal to "true"
-
-### Examples of `remote_bundle_cache_adapter`:
-
-#### S3BundleCacheAdapter
-
-Example of a module for custom methods for the `remote_bundle_cache_adapter`.
-
-Note, S3UploadService is your own code that fetches and uploads.
-
-```ruby
-class S3BundleCacheAdapter
-  # Optional
-  # return an Array of Strings that should get added to the cache key.
-  # These are values to put in the cache key based on either using the webpack.DefinePlugin
-  # or webpack compilation varying by the ENV values.
-  # See the use of the webpack.DefinePlugin. That allows JS code to use
-  # process.env.MY_ENV_VAR resulting in bundles that differ depending on the ENV value set
-  # when building the bundles.
-  # Note, NODE_ENV is automatically included in the default cache key.
-  # Also, we can have an ENV value be a cache version, so incrementing this ENV value
-  # would force a new cache value.
-  def self.cache_keys
-    [Rails.env, ENV['SOME_ENV_VALUE']]
-  end
-
-  # return value is unused
-  # This command should build the bundles
-  def self.build
-    Rake.sh(ReactOnRails::Utils.prepend_cd_node_modules_directory('yarn start build.prod').to_s)
-  end
-
-  # parameter zipped_bundles_filename will be a string
-  # should return the zipped file as a string if successful & nil if not
-  def self.fetch(zipped_bundles_filename:)
-    result = S3UploadService.new.fetch_object(zipped_bundles_filename)
-    result.get.body.read if result
-  end
-
-  # Optional: method to return an array of extra files paths, that require caching.
-  # These files get placed at the `extra_files` directory at the top of the zipfile
-  # and are moved to the original places after unzipping the bundles.
-  def self.extra_files_to_cache
-      [ Rails.root.join("app", "javascript", "utils", "operationStore.json") ]
-  end
-
-  # parameter zipped_bundles_filepath will be a Pathname
-  # return value is unused
-  def self.upload(zipped_bundles_filepath:)
-    return unless ENV['UPLOAD_BUNDLES_TO_S3'] == 'true'
-
-    zipped_bundles_filename = zipped_bundles_filepath.basename.to_s
-    puts "Bundles are being uploaded to s3 as #{zipped_bundles_filename}"
-    starting = Process.clock_gettime(Process::CLOCK_MONOTONIC)
-    S3UploadService.new.upload_object(zipped_bundles_filename,
-                                      File.read(zipped_bundles_filepath, mode: 'rb'),
-                                      'application/zip', expiration_months: 12)
-    ending = Process.clock_gettime(Process::CLOCK_MONOTONIC)
-    elapsed = (ending - starting).round(2)
-    puts "Bundles uploaded to s3 as #{zipped_bundles_filename} in #{elapsed} seconds"
-  end
-end
-```
-
-#### LocalBundleCacheAdapter
-
-Example of a module for custom methods for the `remote_bundle_cache_adapter` that does not save files
-remotely. Only local files are used.
-
-```ruby
-class LocalBundleCacheAdapter
-  def self.cache_keys
-    # if no additional cache keys, return an empty array
-    []
-  end
-
-  def self.build
-    Rake.sh(ReactOnRails::Utils.prepend_cd_node_modules_directory('yarn start build.prod').to_s)
-  end
-
-  def self.fetch(zipped_bundles_filename:)
-    # no-op
-  end
-
-  def self.upload(zipped_bundles_filepath:)
-    # no-op
-  end
-end
-```