react_on_rails 14.1.0 → 14.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8ff0817a7547720cf418f0f13cb7e6cdb681e14dd1e429710805534da73cffe
-  data.tar.gz: 963ac73c65c73a94d602488c63ba97073779100bfed64bb4c731cf24da37a192
+  metadata.gz: 5bcd1f3d6e521231a8435057a0979cf4d354b6ee075ca172dfa554e7837b516f
+  data.tar.gz: f3569c8499bfc239486670d24248523b311cf4a97ee616df7bd97c6c15d4ee33
 SHA512:
-  metadata.gz: 9793268e809976118cf7efe90b0dba1ebc32f3a58137c4e0fffec895c2f43c6c68fd0634f1452cca1aebc2776b89325cd945b1e6fa276d94c3576d32a8ad8124
-  data.tar.gz: 98013bd6cdfa9bb8eee1e7d7cda819f13a747e47e7fa8495f1bec73cca3bbaa363a92c18660948d0d6254d4936ca8bc947482882142e710fad902d88c22c29ea
+  metadata.gz: 929bc16300843b336cab3022fc3a681feea4cf1fba3dbdf35c88df9508058ba32f1f7eeb29ac0a044a1fa1254aca16ec216159e4c08a5c660e18df428348d01f
+  data.tar.gz: 8b3ba8b7608c2ced7cb314d2efcd944cd362ee7f1807472de601574b5237c66d9093dcd98741f235fddce0d9f84bb9bf9b60a846a4a4ce85c1fa2498d191552b

data/CHANGELOG.md

@@ -18,6 +18,26 @@ Please follow the recommendations outlined at [keepachangelog.com](http://keepac
 ### [Unreleased]
 Changes since the last non-beta release.
 
+#### 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).
@@ -1172,7 +1192,9 @@ 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.1.1...master
+[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 (15.0.0.alpha.1)
+    react_on_rails (14.1.1)
       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,80 @@
+import type { KnipConfig } from 'knip';
+
+const config: KnipConfig = {
+  // ! at the end means files are used in production
+  workspaces: {
+    '.': {
+      entry: ['node_package/src/ReactOnRails.ts!', 'node_package/src/ReactOnRails.node.ts!'],
+      project: ['node_package/src/**/*.[jt]s!', 'node_package/tests/**/*.[jt]s'],
+      babel: {
+        config: ['node_package/babel.config.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',
+      ],
+    },
+    '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/prerender_error.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "rainbow"
+
 # rubocop:disable: Layout/IndentHeredoc
 module ReactOnRails
   class PrerenderError < ::ReactOnRails::Error
@@ -51,11 +53,17 @@ module ReactOnRails
         message << <<~MSG
           Encountered error:
 
-          #{err}
+          #{err.inspect}
 
         MSG
 
-        backtrace = err.backtrace.first(15).join("\n")
+        backtrace = if Utils.full_text_errors_enabled?
+                      err.backtrace.join("\n")
+                    else
+                      "#{Rails.backtrace_cleaner.clean(err.backtrace).join("\n")}\n" +
+                        Rainbow("The rest of the backtrace is hidden. " \
+                                "To see the full backtrace, set FULL_TEXT_ERRORS=true.").red
+                    end
       else
         backtrace = nil
       end

data/lib/react_on_rails/utils.rb

@@ -8,7 +8,9 @@ require "active_support/core_ext/string"
 
 module ReactOnRails
   module Utils
-    TRUNCATION_FILLER = "\n... TRUNCATED ...\n"
+    TRUNCATION_FILLER = "\n... TRUNCATED #{
+      Rainbow('To see the full output, set FULL_TEXT_ERRORS=true.').red
+    } ...\n".freeze
 
     # https://forum.shakacode.com/t/yak-of-the-week-ruby-2-4-pathname-empty-changed-to-look-at-file-size/901
     # return object if truthy, else return nil
@@ -183,9 +185,14 @@ module ReactOnRails
                                     end
     end
 
+    def self.full_text_errors_enabled?
+      ENV["FULL_TEXT_ERRORS"] == "true"
+    end
+
     def self.smart_trim(str, max_length = 1000)
       # From https://stackoverflow.com/a/831583/1009332
       str = str.to_s
+      return str if full_text_errors_enabled?
       return str unless str.present? && max_length >= 1
       return str if str.length <= max_length
 

data/lib/react_on_rails/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ReactOnRails
-  VERSION = "14.1.0"
+  VERSION = "14.2.0"
 end

data/react_on_rails.gemspec

@@ -36,8 +36,8 @@ Gem::Specification.new do |s|
   s.post_install_message = '
 --------------------------------------------------------------------------------
 Checkout https://www.shakacode.com/react-on-rails-pro for information about
-"React on Rails Pro" which includes one hour a month of support and a gem for
-better performance, via caching helpers, and our node rendering server.
+"React on Rails Pro" which includes a gem for better performance, via caching helpers, and our
+node rendering server, support for React 19, and much more.
 --------------------------------------------------------------------------------
 '
 end

data/tsconfig.json

@@ -1,15 +1,17 @@
 {
+  "extends": "@tsconfig/node14",
   "compilerOptions": {
     "allowJs": true,
-    "esModuleInterop": true,
-    "jsx": "react",
-    "lib": ["dom", "es2015"],
-    "module": "CommonJS",
+    "esModuleInterop": false,
+    // needed for Jest tests even though we don't use .tsx
+    "jsx": "react-jsx",
+    "lib": ["dom", "es2020"],
+    "module": "node16",
     "noImplicitAny": true,
     "outDir": "node_package/lib",
     "strict": true,
     "incremental": true,
-    "target": "es5"
+    "target": "es2020"
   },
   "include": ["node_package/src/**/*"]
 }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: react_on_rails
 version: !ruby/object:Gem::Version
-  version: 14.1.0
+  version: 14.2.0
 platform: ruby
 authors:
 - Justin Gordon
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-01-06 00:00:00.000000000 Z
+date: 2025-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -117,6 +117,7 @@ files:
 - SUMMARY.md
 - app/helpers/react_on_rails_helper.rb
 - docker-compose.yml
+- knip.ts
 - lib/generators/USAGE
 - lib/generators/react_on_rails/adapt_for_older_shakapacker_generator.rb
 - lib/generators/react_on_rails/base_generator.rb
@@ -203,8 +204,8 @@ post_install_message: |2
 
   --------------------------------------------------------------------------------
   Checkout https://www.shakacode.com/react-on-rails-pro for information about
-  "React on Rails Pro" which includes one hour a month of support and a gem for
-  better performance, via caching helpers, and our node rendering server.
+  "React on Rails Pro" which includes a gem for better performance, via caching helpers, and our
+  node rendering server, support for React 19, and much more.
   --------------------------------------------------------------------------------
 rdoc_options: []
 require_paths:
@@ -220,7 +221,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: Rails with react server rendering with webpack.