Update react-on-rails import to /client in 14.2.x (#1731)

* Update the optimization opportunity warning

* Update react-on-rails import to /client as needed

* Update pack generator

* Fix remaining warning

* Fix generator tests (#1706)

* Allow for different shakapacker versions in convert script

* Fix the generator tests

---------

Co-authored-by: Alexey Romanov <[email protected]>
Co-authored-by: Judah Meek <[email protected]>

---------

Co-authored-by: Alexey Romanov <[email protected]>
Co-authored-by: Alexey Romanov <[email protected]>
Co-authored-by: Judah Meek <[email protected]>

Author: 4 people

CHANGELOG.md

@@ -22,6 +22,10 @@ Changes since the last non-beta release.
 
 #### Fixed
 - Fixed a bug where the `load` event was not firing in Safari by postponing hydration to the next JavaScript task using `setTimeout(callback, 0)`. [PR 1729](https://github.com/shakacode/react_on_rails/pull/1729) by [Romex91](https://github.com/Romex91).
+- Generated client packs now import from `react-on-rails/client` instead of `react-on-rails`. [PR 1706](https://github.com/shakacode/react_on_rails/pull/1706) by [alexeyr-ci](https://github.com/alexeyr-ci).
+  - The "optimization opportunity" message when importing the server-side `react-on-rails` instead of `react-on-rails/client` in browsers is now a warning for two reasons:
+    - Make it more prominent
+    - Include a stack trace when clicked
 
 ### [14.2.0] - 2025-03-03
 

Gemfile.lock

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

docs/guides/how-to-use-different-files-for-client-and-server-rendering.md

@@ -8,7 +8,7 @@ Many projects will have different entry points for client and server rendering.
 Your Client Entry can look like this:
 
 ```js
-import ReactOnRails from 'react-on-rails';
+import ReactOnRails from 'react-on-rails/client';
 import App from './ClientApp';
 ReactOnRails.register({ App })
 ```
@@ -21,7 +21,7 @@ import App from './ServerApp';
 ReactOnRails.register({ App })
 ```
 
-Note that the only difference is on the second line of each of these examples.
+Note that the only difference is in the imports.
 
 ## B. Two Options for Using Webpack Resolve Alias in the Webpack Config
 Per [Webpack Docs](https://webpack.js.org/configuration/resolve/#resolve-alias).

docs/javascript/code-splitting.md

@@ -37,7 +37,7 @@ Here's an example of how you might use this in practice:
 
 #### clientRegistration.js
 ```js
-import ReactOnRails from 'node_package/lib/ReactOnRails';
+import ReactOnRails from 'react-on-rails/client';
 import NavigationApp from './NavigationApp';
 
 // Note that we're importing a different RouterApp than in serverRegistration.js
@@ -71,7 +71,7 @@ Note that you should not register a renderer on the server, since there won't be
 
 #### RouterAppRenderer.jsx
 ```jsx
-import ReactOnRails from 'react-on-rails';
+import ReactOnRails from 'react-on-rails/client';
 import React from 'react';
 import ReactDOM from 'react-dom';
 import Router from 'react-router/lib/Router';

lib/generators/react_on_rails/dev_tests_generator.rb

@@ -47,14 +47,10 @@ def replace_prerender_if_server_rendering
 
       def add_yarn_relative_install_script_in_package_json
         package_json = File.join(destination_root, "package.json")
-        contents = File.read(package_json)
-        replacement_value = <<-STRING
-  "scripts": {
-    "postinstall": "yalc link react-on-rails",
-        STRING
-        new_client_package_json_contents = contents.gsub(/ {2}"scripts": {/,
-                                                         replacement_value)
-        File.open(package_json, "w+") { |f| f.puts new_client_package_json_contents }
+        contents = JSON.parse(File.read(package_json))
+        contents["scripts"] ||= {}
+        contents["scripts"]["postinstall"] = "yalc link react-on-rails"
+        File.open(package_json, "w+") { |f| f.puts JSON.pretty_generate(contents) }
       end
     end
   end

lib/generators/react_on_rails/templates/base/base/app/javascript/packs/registration.js.tt

@@ -1,4 +1,4 @@
-import ReactOnRails from 'react-on-rails';
+import ReactOnRails from 'react-on-rails/client';
 
 import <%= config[:component_name] %> from '<%= config[:app_relative_path] %>';
 

lib/react_on_rails/packs_generator.rb

@@ -47,7 +47,7 @@ def create_pack(file_path)
     def pack_file_contents(file_path)
       registered_component_name = component_name(file_path)
       <<~FILE_CONTENT
-        import ReactOnRails from 'react-on-rails';
+        import ReactOnRails from 'react-on-rails/client';
         import #{registered_component_name} from '#{relative_component_path_from_generated_pack(file_path)}';
 
         ReactOnRails.register({#{registered_component_name}});

node_package/src/ReactOnRails.full.ts

@@ -9,7 +9,10 @@ import type {
 import Client from './ReactOnRails.client';
 
 if (typeof window !== 'undefined') {
-  console.log('Optimization opportunity: "react-on-rails" includes ~14KB of server-rendering code. Browsers may not need it. See https://forum.shakacode.com/t/how-to-use-different-versions-of-a-file-for-client-and-server-rendering/1352 (Requires creating a free account)');
+  // warn to include a collapsed stack trace
+  console.warn(
+    'Optimization opportunity: "react-on-rails" includes ~14KB of server-rendering code. Browsers may not need it. See https://forum.shakacode.com/t/how-to-use-different-versions-of-a-file-for-client-and-server-rendering/1352 (Requires creating a free account). Click this for the stack trace.',
+  );
 }
 
 /**

script/convert

@@ -13,13 +13,13 @@ new_config = File.expand_path("../spec/dummy/config/webpacker.yml", __dir__)
 
 File.rename(old_config, new_config)
 
-gsub_file_content("../Gemfile.development_dependencies", 'gem "shakapacker", "8.0.0"', 'gem "shakapacker", "6.6.0"')
+gsub_file_content("../Gemfile.development_dependencies", /gem "shakapacker", "[^"]*"/, 'gem "shakapacker", "6.6.0"')
 
 # The below packages don't work on the oldest supported Node version and aren't needed there anyway
 gsub_file_content("../package.json", /"knip": "[^"]*",/, "")
 gsub_file_content("../package.json", %r{"@arethetypeswrong/cli": "[^"]*",}, "")
 
-gsub_file_content("../spec/dummy/package.json", '"shakapacker": "8.0.0",', '"shakapacker": "6.6.0",')
+gsub_file_content("../spec/dummy/package.json", /"shakapacker": "[^"]*",/, '"shakapacker": "6.6.0",')
 
 gsub_file_content("../spec/dummy/config/webpack/commonWebpackConfig.js", /generateWebpackConfig(\(\))?/,
                   "webpackConfig")

spec/dummy/app/views/pages/client_side_hello_world.html.erb

@@ -22,7 +22,7 @@
     <br/>
     <pre>
       import HelloWorld from '../components/HelloWorld';
-      import ReactOnRails from 'react-on-rails';
+      import ReactOnRails from 'react-on-rails/client';
       ReactOnRails.register({ HelloWorld });
     </pre>
   </li>