react_on_rails 15.0.0.alpha.1 → 15.0.0.alpha.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7d60051000fbd817b3499b1de6f13c9abeaf5627bee250c50bf0d748ce3532a5
-  data.tar.gz: 4eccfe81e12b647503fa6e690c514d4d14d6704ab1e5c7f64282cafa7709d6e2
+  metadata.gz: b8be0076e31792c3b46d9c518eb59b087de8400c822b92d4edcf8df5e7bea1dd
+  data.tar.gz: 05bbe89b0d5d5ce19347e0970c41a8643f92c54a71ce7a5b0ce9e41d66d18509
 SHA512:
-  metadata.gz: 99004f6792fe209d21474c7b5b311ac8a02cce27740b69164e44079983a5852895aa99ed12530043ba64ad6920d189cb6b19ce3957aca83b6bab06f75bf702ee
-  data.tar.gz: 2be5eb3178a913c90c7b4e640812bccc479245d0052d95751317f543c80e7bf9429f9fd61cbc1c5edb917aafbead33502c75fb63fd8ab183480aaa44124f3dc5
+  metadata.gz: b3c76f79b5f4a8d55b484d85294b3252df79e7e1ee29e855b6300aa4b5caf90ff57fb1fbcbec4185aea125694865c9231f8d823f680313d129792d47cc0b8a6c
+  data.tar.gz: dfe6da1e900b8c74db2a3c2d1f7c61659afec2021f35ecc89503de33a7c5f26ae9d93ceb2071f9adb1552012712ed697f8612d6f35508c3f7c6d85d6778b266b

data/CHANGELOG.md

@@ -18,7 +18,47 @@ Please follow the recommendations outlined at [keepachangelog.com](http://keepac
 ### [Unreleased]
 Changes since the last non-beta release.
 
-#### Added(https://github.com/AbanoubGhadban).
+See [Release Notes](docs/release-notes/15.0.0.md) for full details.
+
+#### Added
+- React Server Components Support (Pro Feature) [PR 1644](https://github.com/shakacode/react_on_rails/pull/1644) by [AbanoubGhadban](https://github.com/AbanoubGhadban).
+- Improved component and store hydration performance [PR 1656](https://github.com/shakacode/react_on_rails/pull/1656) by [AbanoubGhadban](https://github.com/AbanoubGhadban).
+
+#### Breaking Changes
+- `ReactOnRails.reactOnRailsPageLoaded` is now an async function
+- `force_load` configuration now defaults to `true`
+- `defer_generated_component_packs` configuration now defaults to `false`
+
+### [14.2.0] - 2025-03-03
+
+#### Added
+- Add export option 'react-on-rails/client' to avoid shipping server-rendering code to browsers (~5KB improvement) [PR 1697](https://github.com/shakacode/react_on_rails/pull/1697) by [Romex91](https://github.com/Romex91).
+
+#### Fixed
+- Fix obscure errors by introducing FULL_TEXT_ERRORS [PR 1695](https://github.com/shakacode/react_on_rails/pull/1695) by [Romex91](https://github.com/Romex91).
+- Disable `esModuleInterop` to increase interoperability [PR 1699](https://github.com/shakacode/react_on_rails/pull/1699) by [alexeyr-ci](https://github.com/alexeyr-ci).
+- Resolved 14.1.1 incompatibility with eslint & made sure that spec/dummy is linted by eslint. [PR 1693](https://github.com/shakacode/react_on_rails/pull/1693) by [judahmeek](https://github.com/judahmeek).
+
+#### Changed
+- More up-to-date TS config [PR 1700](https://github.com/shakacode/react_on_rails/pull/1700) by [alexeyr-ci](https://github.com/alexeyr-ci).
+
+### [14.1.1] - 2025-01-15
+
+#### Fixed
+
+- Separated streamServerRenderedReactComponent from the ReactOnRails object in order to stop users from getting errors during webpack compilation about needing the `stream-browserify` package. [PR 1680](https://github.com/shakacode/react_on_rails/pull/1680) by [judahmeek](https://github.com/judahmeek).
+- Removed obsolete `js-yaml` peer dependency. [PR 1678](https://github.com/shakacode/react_on_rails/pull/1678) by [alexeyr-ci](https://github.com/alexeyr-ci).
+
+### [14.1.0] - 2025-01-06
+
+#### Fixed
+
+- Incorrect type and confusing name for `ReactOnRails.registerStore`, use `registerStoreGenerators` instead. [PR 1651](https://github.com/shakacode/react_on_rails/pull/1651) by [alexeyr-ci](https://github.com/alexeyr-ci).
+- Changed the ReactOnRails' version checker to use `ReactOnRails.configuration.node_modules_location` to determine the location of the package.json that the `react-on-rails` dependency is expected to be set by.
+- Also, all errors that would be raised by the version checking have been converted to `Rails.Logger` warnings to avoid any breaking changes. [PR 1657](https://github.com/shakacode/react_on_rails/pull/1657) by [judahmeek](https://github.com/judahmeek).
+- Enable use as a `git:` dependency. [PR 1664](https://github.com/shakacode/react_on_rails/pull/1664) by [alexeyr-ci](https://github.com/alexeyr-ci).
+
+#### Added
 - Added streaming server rendering support:
   - [PR #1633](https://github.com/shakacode/react_on_rails/pull/1633) by [AbanoubGhadban](https://github.com/AbanoubGhadban).
     - New `stream_react_component` helper for adding streamed components to views
@@ -26,13 +66,11 @@ Changes since the last non-beta release.
     - Enables progressive page loading and improved performance for server-rendered React components
   - Added support for replaying console logs that occur during server rendering of streamed React components. This enables debugging of server-side rendering issues by capturing and displaying console output on the client and on the server output. [PR #1647](https://github.com/shakacode/react_on_rails/pull/1647) by [AbanoubGhadban](https://github.com/AbanoubGhadban).
   - Added support for handling errors happening during server rendering of streamed React components. It handles errors that happen during the initial render and errors that happen inside suspense boundaries. [PR #1648](https://github.com/shakacode/react_on_rails/pull/1648) by [AbanoubGhadban](https://github.com/AbanoubGhadban).
+  - Added support for passing options to `YAML.safe_load` when loading locale files with `config.i18n_yml_safe_load_options`. [PR #1668](https://github.com/shakacode/react_on_rails/pull/1668) by [dzirtusss](https://github.com/dzirtusss).
 
 #### Changed
 - Console replay script generation now awaits the render request promise before generating, allowing it to capture console logs from asynchronous operations. This requires using a version of the Node renderer that supports replaying async console logs. [PR #1649](https://github.com/shakacode/react_on_rails/pull/1649) by [AbanoubGhadban](https://github.com/AbanoubGhadban).
 
-#### Fixed
-- Incorrect type and confusing name for `ReactOnRails.registerStore`, use `registerStoreGenerators` instead. [PR 1651](https://github.com/shakacode/react_on_rails/pull/1651) by [alexeyr-ci](https://github.com/alexeyr-ci).
-
 ### [14.0.5] - 2024-08-20
 #### Fixed
 - Should force load react-components which send over turbo-stream [PR #1620](https://github.com/shakacode/react_on_rails/pull/1620) by [theforestvn88](https://github.com/theforestvn88).
@@ -1167,7 +1205,10 @@ Best done with Object destructing:
 ##### Fixed
 - Fix several generator-related issues.
 
-[Unreleased]: https://github.com/shakacode/react_on_rails/compare/14.0.5...master
+[Unreleased]: https://github.com/shakacode/react_on_rails/compare/14.2.0...master
+[14.2.0]: https://github.com/shakacode/react_on_rails/compare/14.1.1...14.2.0
+[14.1.1]: https://github.com/shakacode/react_on_rails/compare/14.1.0...14.1.1
+[14.1.0]: https://github.com/shakacode/react_on_rails/compare/14.0.5...14.1.0
 [14.0.5]: https://github.com/shakacode/react_on_rails/compare/14.0.4...14.0.5
 [14.0.4]: https://github.com/shakacode/react_on_rails/compare/14.0.3...14.0.4
 [14.0.3]: https://github.com/shakacode/react_on_rails/compare/14.0.2...14.0.3

data/CONTRIBUTING.md

@@ -6,20 +6,14 @@
 
 ## To run tests:
 * [Yalc](https://github.com/whitecolor/yalc) must be installed globally for most local development.
-* After updating code via git, to prepare all examples and run all tests:
-
+* After updating code via Git, to prepare all examples:
 ```sh
 cd react_on_rails/
-bundle && yarn && rake examples:gen_all && rake node_package && rake
+bundle && yarn && rake shakapacker_examples:gen_all && rake node_package && rake
 ```
 
-In order to run tests in browser
-```
-yarn global add  browserify babelify tape-run faucet
-browserify -t babelify node_package/tests/*.js | tape-run | faucet
-```
-
-See Dev Initial Setup, below for, well... initial setup.
+See [Dev Initial Setup](#dev-initial-setup) below for, well... initial setup,
+and [Running tests](#running-tests) for more details on running tests.
 
 # IDE/IDE SETUP
 It's critical to configure your IDE/editor to ignore certain directories. Otherwise your IDE might slow to a crawl!
@@ -153,21 +147,23 @@ script/convert
 yarn run dummy:spec
 ```
 
-### Run NPM JS tests
+## Running tests
+
+### JS tests
 
 ```sh
 cd react_on_rails/
-yarn test
+yarn run test
 ```
 
-### Run spec/dummy tests
+### spec/dummy tests
 
 ```sh
 cd react_on_rails/spec/dummy
 rspec
 ```
 
-### Run most tests and linting
+### Linting, type checking and JS tests together
 
 ```sh
 cd react_on_rails/

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    react_on_rails (14.0.5)
+    react_on_rails (14.2.0)
       addressable
       connection_pool
       execjs (~> 2.5)

data/README.md

@@ -23,7 +23,7 @@
 
 -----
 
-*These are the docs for React on Rails 13. To see the older docs: [v12](https://github.com/shakacode/react_on_rails/tree/12.6.0) and [v11](https://github.com/shakacode/react_on_rails/tree/11.3.0).*
+*These are the docs for React on Rails 14. To see the older docs and code: [v13](https://github.com/shakacode/react_on_rails/tree/13.4.0), [v12](https://github.com/shakacode/react_on_rails/tree/12.6.0), and [v11](https://github.com/shakacode/react_on_rails/tree/11.3.0).*
 
 # About
 React on Rails integrates Rails with (server rendering of) [React](https://github.com/facebook/react).

data/knip.ts

@@ -0,0 +1,91 @@
+import type { KnipConfig } from 'knip';
+
+const config: KnipConfig = {
+  // ! at the end means files are used in production
+  workspaces: {
+    '.': {
+      entry: [
+        'node_package/src/ReactOnRails.node.ts!',
+        'node_package/src/ReactOnRailsRSC.ts!',
+        'node_package/src/registerServerComponent/client.ts!',
+        'node_package/src/registerServerComponent/server.ts!',
+        'node_package/src/RSCClientRoot.ts!',
+      ],
+      project: ['node_package/src/**/*.[jt]s{x,}!', 'node_package/tests/**/*.[jt]s{x,}'],
+      babel: {
+        config: ['node_package/babel.config.js'],
+      },
+      ignore: [
+        'node_package/tests/emptyForTesting.js',
+      ],
+      ignoreBinaries: [
+        // Knip fails to detect it's declared in devDependencies
+        'nps',
+        // local scripts
+        'node_package/scripts/.*',
+      ],
+      ignoreDependencies: [
+        // Required for TypeScript compilation, but we don't depend on Turbolinks itself.
+        '@types/turbolinks',
+        // used in package-scripts.yml
+        'concurrently',
+        // The Knip ESLint plugin fails to detect these are transitively required by a config,
+        // though we don't actually use its rules anywhere.
+        'eslint-plugin-jsx-a11y',
+        'eslint-plugin-react',
+        // Used in CI
+        '@arethetypeswrong/cli',
+        // used by Jest
+        'jsdom',
+      ],
+    },
+    'spec/dummy': {
+      entry: [
+        'app/assets/config/manifest.js!',
+        'client/app/packs/**/*.js!',
+        // Not sure why this isn't detected as a dependency of client/app/packs/server-bundle.js
+        'client/app/generated/server-bundle-generated.js!',
+        'spec/fixtures/automated_packs_generation/**/*.js{x,}',
+        'config/webpack/{production,development,test}.js',
+        // Declaring this as webpack.config instead doesn't work correctly
+        'config/webpack/webpack.config.js',
+      ],
+      project: ['**/*.{js,cjs,mjs,jsx,ts,cts,mts,tsx}!', 'config/webpack/*.js'],
+      paths: {
+        'Assets/*': ['client/app/assets/*'],
+      },
+      ignoreBinaries: [
+        // Has to be installed globally
+        'yalc',
+        // Local binaries
+        'bin/.*',
+      ],
+      ignoreDependencies: [
+        // Knip thinks it can be a devDependency, but it's supposed to be in dependencies.
+        '@babel/runtime',
+        // There's no ReScript plugin for Knip
+        '@rescript/react',
+        // The Babel plugin fails to detect it
+        'babel-plugin-transform-react-remove-prop-types',
+        // This one is weird. It's long-deprecated and shouldn't be necessary.
+        // Probably need to update the Webpack config.
+        'node-libs-browser',
+        // The below dependencies are not detected by the Webpack plugin
+        // due to the config issue.
+        'css-loader',
+        'expose-loader',
+        'file-loader',
+        'imports-loader',
+        'mini-css-extract-plugin',
+        'null-loader',
+        'sass',
+        'sass-loader',
+        'sass-resources-loader',
+        'style-loader',
+        'url-loader',
+      ],
+    },
+  },
+};
+
+export default config;

data/lib/react_on_rails/configuration.rb

@@ -9,6 +9,8 @@ module ReactOnRails
   end
 
   DEFAULT_GENERATED_ASSETS_DIR = File.join(%w[public webpack], Rails.env).freeze
+  DEFAULT_REACT_CLIENT_MANIFEST_FILE = "react-client-manifest.json"
+  DEFAULT_COMPONENT_REGISTRY_TIMEOUT = 5000
 
   def self.configuration
     @configuration ||= Configuration.new(
@@ -17,6 +19,8 @@ module ReactOnRails
       # generated_assets_dirs is deprecated
       generated_assets_dir: "",
       server_bundle_js_file: "",
+      rsc_bundle_js_file: "",
+      react_client_manifest_file: DEFAULT_REACT_CLIENT_MANIFEST_FILE,
       prerender: false,
       auto_load_bundle: false,
       replay_console: true,
@@ -39,9 +43,13 @@ module ReactOnRails
       i18n_output_format: nil,
       components_subdirectory: nil,
       make_generated_server_bundle_the_entrypoint: false,
-      defer_generated_component_packs: true,
+      defer_generated_component_packs: false,
       # forces the loading of React components
-      force_load: false
+      force_load: true,
+      # Maximum time in milliseconds to wait for client-side component registration after page load.
+      # If exceeded, an error will be thrown for server-side rendered components not registered on the client.
+      # Set to 0 to disable the timeout and wait indefinitely for component registration.
+      component_registry_timeout: DEFAULT_COMPONENT_REGISTRY_TIMEOUT
     )
   end
 
@@ -52,11 +60,12 @@ module ReactOnRails
                   :generated_assets_dirs, :generated_assets_dir, :components_subdirectory,
                   :webpack_generated_files, :rendering_extension, :build_test_command,
                   :build_production_command, :i18n_dir, :i18n_yml_dir, :i18n_output_format,
+                  :i18n_yml_safe_load_options,
                   :server_render_method, :random_dom_id, :auto_load_bundle,
                   :same_bundle_for_client_and_server, :rendering_props_extension,
                   :make_generated_server_bundle_the_entrypoint,
-                  :defer_generated_component_packs,
-                  :force_load
+                  :defer_generated_component_packs, :force_load, :rsc_bundle_js_file,
+                  :react_client_manifest_file, :component_registry_timeout
 
     # rubocop:disable Metrics/AbcSize
     def initialize(node_modules_location: nil, server_bundle_js_file: nil, prerender: nil,
@@ -69,9 +78,10 @@ module ReactOnRails
                    rendering_extension: nil, build_test_command: nil,
                    build_production_command: nil, defer_generated_component_packs: nil,
                    same_bundle_for_client_and_server: nil,
-                   i18n_dir: nil, i18n_yml_dir: nil, i18n_output_format: nil,
+                   i18n_dir: nil, i18n_yml_dir: nil, i18n_output_format: nil, i18n_yml_safe_load_options: nil,
                    random_dom_id: nil, server_render_method: nil, rendering_props_extension: nil,
-                   components_subdirectory: nil, auto_load_bundle: nil, force_load: nil)
+                   components_subdirectory: nil, auto_load_bundle: nil, force_load: nil,
+                   rsc_bundle_js_file: nil, react_client_manifest_file: nil, component_registry_timeout: nil)
       self.node_modules_location = node_modules_location.present? ? node_modules_location : Rails.root
       self.generated_assets_dirs = generated_assets_dirs
       self.generated_assets_dir = generated_assets_dir
@@ -80,6 +90,7 @@ module ReactOnRails
       self.i18n_dir = i18n_dir
       self.i18n_yml_dir = i18n_yml_dir
       self.i18n_output_format = i18n_output_format
+      self.i18n_yml_safe_load_options = i18n_yml_safe_load_options
 
       self.random_dom_id = random_dom_id
       self.prerender = prerender
@@ -94,9 +105,12 @@ module ReactOnRails
       self.raise_on_prerender_error = raise_on_prerender_error
       self.skip_display_none = skip_display_none
       self.rendering_props_extension = rendering_props_extension
+      self.component_registry_timeout = component_registry_timeout
 
       # Server rendering:
       self.server_bundle_js_file = server_bundle_js_file
+      self.rsc_bundle_js_file = rsc_bundle_js_file
+      self.react_client_manifest_file = react_client_manifest_file
       self.same_bundle_for_client_and_server = same_bundle_for_client_and_server
       self.server_renderer_pool_size = self.development_mode ? 1 : server_renderer_pool_size
       self.server_renderer_timeout = server_renderer_timeout # seconds
@@ -124,10 +138,19 @@ module ReactOnRails
       error_if_using_packer_and_generated_assets_dir_not_match_public_output_path
       # check_deprecated_settings
       adjust_precompile_task
+      check_component_registry_timeout
     end
 
     private
 
+    def check_component_registry_timeout
+      self.component_registry_timeout = DEFAULT_COMPONENT_REGISTRY_TIMEOUT if component_registry_timeout.nil?
+
+      return if component_registry_timeout.is_a?(Integer) && component_registry_timeout >= 0
+
+      raise ReactOnRails::Error, "component_registry_timeout must be a positive integer"
+    end
+
     def check_autobundling_requirements
       raise_missing_components_subdirectory if auto_load_bundle && !components_subdirectory.present?
       return unless components_subdirectory.present?
@@ -239,10 +262,12 @@ module ReactOnRails
     def ensure_webpack_generated_files_exists
       return unless webpack_generated_files.empty?
 
-      files = ["manifest.json"]
-      files << server_bundle_js_file if server_bundle_js_file.present?
-
-      self.webpack_generated_files = files
+      self.webpack_generated_files = [
+        "manifest.json",
+        server_bundle_js_file,
+        rsc_bundle_js_file,
+        react_client_manifest_file
+      ].compact_blank
     end
 
     def configure_skip_display_none_deprecation

data/lib/react_on_rails/engine.rb

@@ -5,9 +5,7 @@ require "rails/railtie"
 module ReactOnRails
   class Engine < ::Rails::Engine
     config.to_prepare do
-      if File.exist?(VersionChecker::NodePackageVersion.package_json_path)
-        VersionChecker.build.raise_if_gem_and_node_package_versions_differ
-      end
+      VersionChecker.build.log_if_gem_and_node_package_versions_differ
       ReactOnRails::ServerRenderingPool.reset_pool
     end
   end