Make the dummy use private server bundle path and migrate to react on rails v16.1.1 (#558)

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

- New Features
- Added SSR configurables: new server bundle output path and enforcement
of private server bundles.

- Chores
- Raised minimum ReactOnRails compatibility to >= 16 and updated
development dependency source/version.
- Ignored SSR-generated artifacts; CI caching/cleanup and build/clean
now handle SSR output.

- Tests
- Updated test setup and bundle paths to use the new SSR output location
and adjusted a test expectation attribute.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: Justin Gordon <[email protected]>
Co-authored-by: Claude <[email protected]>

Author: 3 people

.circleci/config.yml

@@ -224,6 +224,7 @@ jobs:
           key: v4-dummy-app-webpack-bundle-{{ .Revision }}
           paths:
             - spec/dummy/public/webpack/test
+            - spec/dummy/ssr-generated
 
   # Run JS unit tests for Renderer package.
   package-js-tests:
@@ -234,6 +235,7 @@ jobs:
       - run: *print-system-info
       - restore_cache: *restore-package-node-modules-cache
       - run: rm -rf spec/dummy/public/webpack
+      - run: rm -rf spec/dummy/ssr-generated
       - restore_cache: *restore-dummy-app-webpack-bundle-cache
       - run: *install-package-node-modules
       # https://circleci.com/docs/collect-test-data/#jest
@@ -279,6 +281,7 @@ jobs:
       - restore_cache: *restore-dummy-app-node-modules-cache
       - restore_cache: *restore-dummy-app-gem-cache
       - run: rm -rf spec/dummy/public/webpack
+      - run: rm -rf spec/dummy/ssr-generated
       - restore_cache: *restore-dummy-app-webpack-bundle-cache
       - run: *install-dummy-app-ruby-gems
       - run: *install-package-node-modules

.gitignore

@@ -54,6 +54,7 @@ yarn-debug.*
 spec/dummy/client/yarn-debug.log*
 npm-debug.*
 spec/dummy/client/npm-debug.log*
+spec/dummy/ssr-generated/
 
 /gen-examples
 

Gemfile.development_dependencies

@@ -5,7 +5,7 @@ git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 
 ruby '3.3.7'
 
-gem "react_on_rails", "15.0.0" # keep in sync with package.json files
+gem "react_on_rails", "16.1.1"
 
 # For local development
 # Add the following line to the Gemfile.local file

Gemfile.lock

@@ -15,7 +15,7 @@ PATH
       execjs (~> 2.9)
       httpx (~> 1.5)
       rainbow
-      react_on_rails (>= 15.0.0)
+      react_on_rails (>= 16.0.0)
 
 GEM
   remote: https://rubygems.org/
@@ -288,12 +288,13 @@ GEM
       ffi (~> 1.0)
     rdoc (6.12.0)
       psych (>= 4.0.0)
-    react_on_rails (15.0.0)
+    react_on_rails (16.1.1)
       addressable
       connection_pool
       execjs (~> 2.5)
       rails (>= 5.2)
       rainbow (~> 3.0)
+      shakapacker (>= 6.0)
     regexp_parser (2.9.2)
     reline (0.6.0)
       io-console (~> 0.5)
@@ -468,7 +469,7 @@ DEPENDENCIES
   pry-theme
   puma (~> 6)
   rails (~> 7.1)
-  react_on_rails (= 15.0.0)
+  react_on_rails (= 16.1.1)
   react_on_rails_pro!
   rspec-rails
   rspec-retry

lib/react_on_rails_pro/utils.rb

@@ -67,10 +67,6 @@ def self.rsc_bundle_hash
 
     # Returns the hashed file name when using webpacker. Useful for creating cache keys.
     def self.bundle_file_name(bundle_name)
-      unless ReactOnRails::PackerUtils.using_packer?
-        raise ReactOnRailsPro::Error, "Only call bundle_file_name if using webpacker"
-      end
-
       # bundle_js_uri_from_packer can return a file path or a HTTP URL (for files served from the dev server)
       # Pathname can handle both cases
       full_path = ReactOnRails::PackerUtils.bundle_js_uri_from_packer(bundle_name)

package.json

@@ -85,7 +85,7 @@
     "nps": "^5.9.12",
     "pino-pretty": "^13.0.0",
     "prettier": "^3.2.5",
-    "react-on-rails": "15.0.0",
+    "react-on-rails": "16.1.1",
     "redis": "^5.0.1",
     "release-it": "^17.6.0",
     "sentry-testkit": "^5.0.6",

packages/node-renderer/tests/htmlStreaming.test.js

@@ -43,7 +43,8 @@ const createForm = ({ project = 'spec-dummy', commit = '', props = {}, throwJsEr
   }
   form.append('renderingRequest', renderingRequestCode);
 
-  const testBundlesDirectory = path.join(__dirname, '../../../spec/dummy/public/webpack/test');
+  const testBundlesDirectory = path.join(__dirname, '../../../spec/dummy/ssr-generated');
+  const testClientBundlesDirectory = path.join(__dirname, '../../../spec/dummy/public/webpack/test');
   const bundlePath = path.join(testBundlesDirectory, 'server-bundle.js');
   form.append(`bundle_${SERVER_BUNDLE_TIMESTAMP}`, fs.createReadStream(bundlePath), {
     contentType: 'text/javascript',
@@ -54,7 +55,7 @@ const createForm = ({ project = 'spec-dummy', commit = '', props = {}, throwJsEr
     contentType: 'text/javascript',
     filename: 'rsc-bundle.js',
   });
-  const clientManifestPath = path.join(testBundlesDirectory, 'react-client-manifest.json');
+  const clientManifestPath = path.join(testClientBundlesDirectory, 'react-client-manifest.json');
   form.append('asset1', fs.createReadStream(clientManifestPath), {
     contentType: 'application/json',
     filename: 'react-client-manifest.json',

packages/node-renderer/tests/serverRenderRSCReactComponent.test.js

@@ -1,4 +1,5 @@
 import path from 'path';
+import fs from 'fs';
 import { Readable } from 'stream';
 import { buildVM, getVMContext, resetVM } from '../src/worker/vm';
 import { getConfig } from '../src/shared/configBuilder';
@@ -17,6 +18,36 @@ const ComponentWithAsyncError = async () => {
 };
 
 describe('serverRenderRSCReactComponent', () => {
+  let tempDir;
+  let tempRscBundlePath;
+  let tempManifestPath;
+
+  beforeAll(async () => {
+    // Create temporary directory
+    tempDir = path.join(process.cwd(), 'tmp/node-renderer-bundles-test/testing-bundle');
+    fs.mkdirSync(tempDir, { recursive: true });
+
+    // Copy rsc-bundle.js to temp directory
+    const originalRscBundlePath = path.join(__dirname, '../../../spec/dummy/ssr-generated/rsc-bundle.js');
+    tempRscBundlePath = path.join(tempDir, 'rsc-bundle.js');
+    fs.copyFileSync(originalRscBundlePath, tempRscBundlePath);
+
+    // Copy react-client-manifest.json to temp directory
+    const originalManifestPath = path.join(
+      __dirname,
+      '../../../spec/dummy/public/webpack/test/react-client-manifest.json',
+    );
+    tempManifestPath = path.join(tempDir, 'react-client-manifest.json');
+    fs.copyFileSync(originalManifestPath, tempManifestPath);
+  });
+
+  afterAll(async () => {
+    // Clean up temporary directory
+    if (tempDir && fs.existsSync(tempDir)) {
+      fs.rmSync(tempDir, { recursive: true, force: true });
+    }
+  });
+
   beforeEach(async () => {
     const config = getConfig();
     config.supportModules = true;
@@ -31,10 +62,9 @@ describe('serverRenderRSCReactComponent', () => {
   // The serverRenderRSCReactComponent function should only be called when the bundle is compiled with the `react-server` condition.
   // Therefore, we cannot call it directly in the test files. Instead, we run the RSC bundle through the VM and call the method from there.
   const getReactOnRailsRSCObject = async () => {
-    const testBundlesDirectory = path.join(__dirname, '../../../spec/dummy/public/webpack/test');
-    const rscBundlePath = path.join(testBundlesDirectory, 'rsc-bundle.js');
-    await buildVM(rscBundlePath);
-    const vmContext = getVMContext(rscBundlePath);
+    // Use the copied rsc-bundle.js file from temp directory
+    await buildVM(tempRscBundlePath);
+    const vmContext = getVMContext(tempRscBundlePath);
     const { ReactOnRails, React } = vmContext.context;
 
     function SuspensedComponentWithAsyncError() {
@@ -68,7 +98,7 @@ describe('serverRenderRSCReactComponent', () => {
       throwJsErrors,
       railsContext: {
         serverSide: true,
-        reactClientManifestFileName: 'react-client-manifest.json',
+        reactClientManifestFileName: path.basename(tempManifestPath),
         reactServerClientManifestFileName: 'react-server-client-manifest.json',
         renderingReturnsPromises: true,
       },

react_on_rails_pro.gemspec

@@ -33,7 +33,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency "execjs", "~> 2.9"
   s.add_runtime_dependency "httpx", "~> 1.5"
   s.add_runtime_dependency "rainbow"
-  s.add_runtime_dependency "react_on_rails", ">= 15.0.0"
+  s.add_runtime_dependency "react_on_rails", ">= 16.0.0"
   s.add_development_dependency "bundler"
   s.add_development_dependency "commonmarker"
   s.add_development_dependency "gem-release"

spec/dummy/.rubocop.yml

@@ -11,6 +11,7 @@ AllCops:
     - 'node_modules/react-on-rails'
     - 'node_modules/**/*'
     - 'public/webpack/**/*'
+    - 'ssr-generated/**/*'
 
 Metrics/BlockLength:
   Exclude: