react_on_rails 16.0.1.rc.2 → 16.1.0

data/lib/react_on_rails/packs_generator.rb

@@ -9,6 +9,8 @@ module ReactOnRails
     CONTAINS_CLIENT_OR_SERVER_REGEX = /\.(server|client)($|\.)/
     COMPONENT_EXTENSIONS = /\.(jsx?|tsx?)$/
     MINIMUM_SHAKAPACKER_VERSION = "6.5.1"
+    # Auto-registration requires nested_entries support which was added in 7.0.0
+    MINIMUM_SHAKAPACKER_VERSION_FOR_AUTO_BUNDLING = "7.0.0"
 
     def self.instance
       @instance ||= PacksGenerator.new
@@ -164,6 +166,7 @@ module ReactOnRails
 
     def add_generated_pack_to_server_bundle
       return if ReactOnRails.configuration.make_generated_server_bundle_the_entrypoint
+      return if ReactOnRails.configuration.server_bundle_js_file.blank?
 
       relative_path_to_generated_server_bundle = relative_path(server_bundle_entrypoint,
                                                                generated_server_bundle_file_path)

data/lib/react_on_rails/prerender_error.rb

@@ -83,6 +83,10 @@ module ReactOnRails
         MSG
 
       end
+
+      # Add help and support information
+      message << "\n#{Utils.default_troubleshooting_section}\n"
+
       [backtrace, message]
     end
   end

data/lib/react_on_rails/server_rendering_pool/ruby_embedded_java_script.rb

@@ -77,6 +77,7 @@ module ReactOnRails
             if err.message.include?("ReferenceError: self is not defined")
               msg << "\nError indicates that you may have code-splitting incorrectly enabled.\n"
             end
+            msg << "\n#{Utils.default_troubleshooting_section}\n"
             raise ReactOnRails::Error, msg, err.backtrace
           end
 
@@ -122,7 +123,7 @@ module ReactOnRails
         rescue StandardError => e
           msg = "You specified server rendering JS file: #{server_js_file}, but it cannot be " \
                 "read. You may set the server_bundle_js_file in your configuration to be \"\" to " \
-                "avoid this warning.\nError is: #{e}"
+                "avoid this warning.\nError is: #{e}\n\n#{Utils.default_troubleshooting_section}"
           raise ReactOnRails::Error, msg
         end
 
@@ -149,7 +150,8 @@ module ReactOnRails
             msg = "ERROR when compiling base_js_code! " \
                   "See file #{file_name} to " \
                   "correlate line numbers of error. Error is\n\n#{e.message}" \
-                  "\n\n#{e.backtrace.join("\n")}"
+                  "\n\n#{e.backtrace.join("\n")}" \
+                  "\n\n#{Utils.default_troubleshooting_section}"
             Rails.logger.error(msg)
             trace_js_code_used("Error when compiling JavaScript code for the context.", base_js_code,
                                file_name, force: true)
@@ -227,7 +229,7 @@ module ReactOnRails
           encoding_type = match[:encoding]
           response.body.force_encoding(encoding_type)
         rescue StandardError => e
-          msg = "file_url_to_string #{url} failed\nError is: #{e}"
+          msg = "file_url_to_string #{url} failed\nError is: #{e}\n\n#{Utils.default_troubleshooting_section}"
           raise ReactOnRails::Error, msg
         end
 

data/lib/react_on_rails/system_checker.rb

@@ -618,14 +618,14 @@ module ReactOnRails
           version = shakapacker_match[1].strip
 
           begin
-            # Use proper semantic version comparison
-            version_obj = Gem::Version.new(version)
-            threshold_version = Gem::Version.new("8.2")
+            # Validate version string format
+            Gem::Version.new(version)
 
-            if version_obj >= threshold_version
-              add_success("✅ Shakapacker #{version} (supports React on Rails auto-registration)")
+            if ReactOnRails::PackerUtils.supports_autobundling?
+              add_success("✅ Shakapacker #{version} (supports React on Rails auto-bundling)")
             else
-              add_warning("⚠️  Shakapacker #{version} - Version 8.2+ needed for React on Rails auto-registration")
+              add_warning("⚠️  Shakapacker #{version} - Version 7.0+ with nested_entries support needed " \
+                          "for React on Rails auto-bundling")
             end
           rescue ArgumentError
             # Fallback for invalid version strings

data/lib/react_on_rails/test_helper/webpack_assets_compiler.rb

@@ -16,7 +16,7 @@ module ReactOnRails
 
             React on Rails is aborting your test run
 
-            If you wish to use the config/#{ReactOnRails::PackerUtils.packer_type}.yml compile option for tests
+            If you wish to use the config/shakapacker.yml compile option for tests
             them remove your call to the ReactOnRails test helper.
           MSG
           puts Rainbow(msg).red

data/lib/react_on_rails/test_helper/webpack_assets_status_checker.rb

@@ -31,8 +31,7 @@ module ReactOnRails
       end
 
       def stale_generated_files(files)
-        manifest_needed = ReactOnRails::PackerUtils.using_packer? &&
-                          !ReactOnRails::PackerUtils.manifest_exists?
+        manifest_needed = !ReactOnRails::PackerUtils.manifest_exists?
 
         return ["manifest.json"] if manifest_needed
 

data/lib/react_on_rails/test_helper.rb

@@ -86,10 +86,9 @@ module ReactOnRails
           puts
           @printed_once = true
 
-          if ReactOnRails::PackerUtils.using_packer? &&
-             ReactOnRails::Utils.using_packer_source_path_is_not_defined_and_custom_node_modules?
+          if ReactOnRails::Utils.using_packer_source_path_is_not_defined_and_custom_node_modules?
             msg = <<-MSG.strip_heredoc
-              WARNING: Define config/#{ReactOnRails::PackerUtils.packer_type}.yml to include sourcePath to configure
+              WARNING: Define config/shakapacker.yml to include sourcePath to configure
               the location of your JavaScript source for React on Rails.
               Default location of #{source_path} is used.
             MSG

data/lib/react_on_rails/utils.rb

@@ -6,8 +6,9 @@ require "rainbow"
 require "active_support"
 require "active_support/core_ext/string"
 
+# rubocop:disable Metrics/ModuleLength
 module ReactOnRails
-  module Utils # rubocop:disable Metrics/ModuleLength
+  module Utils
     TRUNCATION_FILLER = "\n... TRUNCATED #{
       Rainbow('To see the full output, set FULL_TEXT_ERRORS=true.').red
     } ...\n".freeze
@@ -57,6 +58,8 @@ module ReactOnRails
         MSG
 
         puts wrap_message(msg)
+        puts ""
+        puts default_troubleshooting_section
 
         # Rspec catches exit without! in the exit callbacks
         exit!(1)
@@ -69,34 +72,72 @@ module ReactOnRails
     end
 
     def self.bundle_js_file_path(bundle_name)
-      # Either:
-      # 1. Using same bundle for both server and client, so server bundle will be hashed in manifest
-      # 2. Using a different bundle (different Webpack config), so file is not hashed, and
-      #    bundle_js_path will throw so the default path is used without a hash.
-      # 3. The third option of having the server bundle hashed and a different configuration than
-      #    the client bundle is not supported for 2 reasons:
-      #    a. The webpack manifest plugin would have a race condition where the same manifest.json
-      #       is edited by both the webpack-dev-server
-      #    b. There is no good reason to hash the server bundle name.
-      if ReactOnRails::PackerUtils.using_packer? && bundle_name != "manifest.json"
-        begin
-          ReactOnRails::PackerUtils.bundle_js_uri_from_packer(bundle_name)
-        rescue Object.const_get(
-          ReactOnRails::PackerUtils.packer_type.capitalize
-        )::Manifest::MissingEntryError
-          File.expand_path(
-            File.join(ReactOnRails::PackerUtils.packer_public_output_path,
-                      bundle_name)
-          )
-        end
-      else
+      # Priority order depends on bundle type:
+      # SERVER BUNDLES (normal case): Try private non-public locations first, then manifest, then legacy
+      # CLIENT BUNDLES (normal case): Try manifest first, then fallback locations
+      if bundle_name == "manifest.json"
         # Default to the non-hashed name in the specified output directory, which, for legacy
         # React on Rails, this is the output directory picked up by the asset pipeline.
         # For Shakapacker, this is the public output path defined in the (shaka/web)packer.yml file.
-        File.join(generated_assets_full_path, bundle_name)
+        File.join(public_bundles_full_path, bundle_name)
+      else
+        bundle_js_file_path_with_packer(bundle_name)
       end
     end
 
+    private_class_method def self.bundle_js_file_path_with_packer(bundle_name)
+      is_server_bundle = server_bundle?(bundle_name)
+      config = ReactOnRails.configuration
+      root_path = Rails.root || "."
+
+      # If server bundle and server_bundle_output_path is configured, return that path directly
+      if is_server_bundle && config.server_bundle_output_path.present?
+        private_server_bundle_path = File.expand_path(File.join(root_path, config.server_bundle_output_path,
+                                                                bundle_name))
+
+        # Don't fall back to public directory if enforce_private_server_bundles is enabled
+        if config.enforce_private_server_bundles || File.exist?(private_server_bundle_path)
+          return private_server_bundle_path
+        end
+      end
+
+      # Try manifest lookup for all bundles
+      begin
+        ReactOnRails::PackerUtils.bundle_js_uri_from_packer(bundle_name)
+      rescue Shakapacker::Manifest::MissingEntryError
+        handle_missing_manifest_entry(bundle_name, is_server_bundle)
+      end
+    end
+
+    private_class_method def self.server_bundle?(bundle_name)
+      config = ReactOnRails.configuration
+      bundle_name == config.server_bundle_js_file ||
+      bundle_name == config.rsc_bundle_js_file
+    end
+
+    private_class_method def self.handle_missing_manifest_entry(bundle_name, is_server_bundle)
+      config = ReactOnRails.configuration
+      root_path = Rails.root || "."
+
+      # For server bundles with server_bundle_output_path configured, use that
+      if is_server_bundle && config.server_bundle_output_path.present?
+        candidate_paths = [File.expand_path(File.join(root_path, config.server_bundle_output_path, bundle_name))]
+        unless config.enforce_private_server_bundles
+          candidate_paths << File.expand_path(File.join(ReactOnRails::PackerUtils.packer_public_output_path,
+                                                        bundle_name))
+        end
+
+        candidate_paths.each do |path|
+          return path if File.exist?(path)
+        end
+        return candidate_paths.first
+      end
+
+      # For client bundles and server bundles without special config, use packer's public path
+      # This returns the environment-specific path configured in shakapacker.yml
+      File.expand_path(File.join(ReactOnRails::PackerUtils.packer_public_output_path, bundle_name))
+    end
+
     def self.server_bundle_js_file_path
       return @server_bundle_path if @server_bundle_path && !Rails.env.development?
 
@@ -115,11 +156,7 @@ module ReactOnRails
       return @react_client_manifest_path if @react_client_manifest_path && !Rails.env.development?
 
       file_name = ReactOnRails.configuration.react_client_manifest_file
-      @react_client_manifest_path = if ReactOnRails::PackerUtils.using_packer?
-                                      ReactOnRails::PackerUtils.asset_uri_from_packer(file_name)
-                                    else
-                                      File.join(generated_assets_full_path, file_name)
-                                    end
+      @react_client_manifest_path = ReactOnRails::PackerUtils.asset_uri_from_packer(file_name)
     end
 
     # React Server Manifest is generated by the server bundle.
@@ -133,7 +170,7 @@ module ReactOnRails
               "react_server_client_manifest_file is nil, ensure it is set in your configuration"
       end
 
-      @react_server_manifest_path = File.join(generated_assets_full_path, asset_name)
+      @react_server_manifest_path = File.join(public_bundles_full_path, asset_name)
     end
 
     def self.running_on_windows?
@@ -161,26 +198,21 @@ module ReactOnRails
     end
 
     def self.source_path
-      if ReactOnRails::PackerUtils.using_packer?
-        ReactOnRails::PackerUtils.packer_source_path
-      else
-        ReactOnRails.configuration.node_modules_location
-      end
+      ReactOnRails::PackerUtils.packer_source_path
     end
 
     def self.using_packer_source_path_is_not_defined_and_custom_node_modules?
-      return false unless ReactOnRails::PackerUtils.using_packer?
-
       !ReactOnRails::PackerUtils.packer_source_path_explicit? &&
         ReactOnRails.configuration.node_modules_location.present?
     end
 
+    def self.public_bundles_full_path
+      ReactOnRails::PackerUtils.packer_public_output_path
+    end
+
+    # DEPRECATED: Use public_bundles_full_path for clarity about public vs private bundle paths
     def self.generated_assets_full_path
-      if ReactOnRails::PackerUtils.using_packer?
-        ReactOnRails::PackerUtils.packer_public_output_path
-      else
-        File.expand_path(ReactOnRails.configuration.generated_assets_dir)
-      end
+      public_bundles_full_path
     end
 
     def self.gem_available?(name)
@@ -278,5 +310,16 @@ module ReactOnRails
 
       puts "Prepended\n#{text_to_prepend}to #{file}."
     end
+
+    def self.default_troubleshooting_section
+      <<~DEFAULT
+        📞 Get Help & Support:
+           • 🚀 Professional Support: react_on_rails@shakacode.com (fastest resolution)
+           • 💬 React + Rails Slack: https://invite.reactrails.com
+           • 🆓 GitHub Issues: https://github.com/shakacode/react_on_rails/issues
+           • 📖 Discussions: https://github.com/shakacode/react_on_rails/discussions
+      DEFAULT
+    end
   end
 end
+# rubocop:enable Metrics/ModuleLength

data/lib/react_on_rails/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ReactOnRails
-  VERSION = "16.0.1.rc.2"
+  VERSION = "16.1.0"
 end

data/lib/tasks/generate_packs.rake

@@ -83,7 +83,7 @@ namespace :react_on_rails do
       puts Rainbow("   • Keep only the client/server specific files " \
                    "(Component.client.jsx, Component.server.jsx)").white
       puts Rainbow("   • See: https://www.shakacode.com/react-on-rails/docs/guides/" \
-                   "file-system-based-automated-bundle-generation.md").cyan
+                   "auto-bundling-file-system-based-automated-bundle-generation.md").cyan
 
     when /Cannot find component/
       puts Rainbow("   • Check that your component file exists in the expected location").white
@@ -118,11 +118,29 @@ namespace :react_on_rails do
     puts ""
     puts Rainbow("📚 DOCUMENTATION:").magenta.bold
     puts Rainbow("   • File-system based components: https://www.shakacode.com/react-on-rails/docs/" \
-                 "guides/file-system-based-automated-bundle-generation.md").cyan
+                 "guides/auto-bundling-file-system-based-automated-bundle-generation.md").cyan
     puts Rainbow("   • Component registration: https://www.shakacode.com/react-on-rails/docs/").cyan
     puts Rainbow("=" * 80).red
   end
 
+  def show_help_and_support
+    puts ""
+    troubleshooting_content = ReactOnRails::Utils.default_troubleshooting_section
+    # Display the troubleshooting content with color formatting
+    troubleshooting_content.split("\n").each do |line|
+      case line
+      when /^📞/
+        puts Rainbow(line).magenta.bold
+      when /^\s*•\s*🚀/
+        puts Rainbow(line).yellow
+      when /^\s*•/
+        puts Rainbow(line).cyan
+      else
+        puts Rainbow(line).white unless line.strip.empty?
+      end
+    end
+  end
+
   # rubocop:disable Metrics/AbcSize
   def handle_standard_error(error)
     puts ""
@@ -142,11 +160,7 @@ namespace :react_on_rails do
     puts Rainbow("   2. Check Rails logs: tail -f log/development.log").white
     puts Rainbow("   3. Verify all dependencies are installed: bundle install && npm install").white
     puts Rainbow("   4. Clear cache: rm -rf tmp/cache").white
-    puts ""
-    puts Rainbow("📞 GET HELP:").magenta.bold
-    puts Rainbow("   • Create an issue: https://github.com/shakacode/react_on_rails/issues").cyan
-    puts Rainbow("   • Community discussions: https://github.com/shakacode/react_on_rails/discussions").cyan
-    puts Rainbow("   • Professional support: https://www.shakacode.com/react-on-rails-pro").cyan
+    show_help_and_support
     puts Rainbow("=" * 80).red
   end
   # rubocop:enable Metrics/AbcSize

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: react_on_rails
 version: !ruby/object:Gem::Version
-  version: 16.0.1.rc.2
+  version: 16.1.0
 platform: ruby
 authors:
 - Justin Gordon
@@ -114,6 +114,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- AI_AGENT_INSTRUCTIONS.md
 - CHANGELOG.md
 - CLAUDE.md
 - CODING_AGENTS.md
@@ -242,7 +243,6 @@ files:
 - lib/tasks/doctor.rake
 - lib/tasks/generate_packs.rake
 - lib/tasks/locale.rake
-- package-lock.json
 - react_on_rails.gemspec
 - tsconfig.eslint.json
 - tsconfig.json