react_on_rails 10.1.4 → 11.0.0.beta.1

data/lib/react_on_rails/server_rendering_pool.rb

@@ -1,8 +1,7 @@
 # frozen_string_literal: true
 
 require "connection_pool"
-require_relative "server_rendering_pool/exec"
-require_relative "server_rendering_pool/node"
+require_relative "server_rendering_pool/ruby_embedded_java_script"
 
 # Based on the react-rails gem.
 # None of these methods should be called directly.
@@ -10,19 +9,30 @@ require_relative "server_rendering_pool/node"
 module ReactOnRails
   module ServerRenderingPool
     class << self
+      def react_on_rails_pro?
+        @react_on_rails_pro ||= gem_available?("react_on_rails_pro")
+      end
+
       def pool
-        if ReactOnRails.configuration.server_render_method == "NodeJS"
-          ServerRenderingPool::Node
-        else
-          ServerRenderingPool::Exec
-        end
+        @pool ||= if react_on_rails_pro?
+                    ReactOnRailsPro::ServerRenderingPool::ProRendering
+                  else
+                    ReactOnRails::ServerRenderingPool::RubyEmbeddedJavaScript
+                  end
       end
 
-      # rubocop:disable Style/MethodMissing
-      def method_missing(sym, *args, &block)
-        pool.send sym, *args, &block
+      delegate :server_render_js_with_console_logging, :reset_pool_if_server_bundle_was_modified,
+               :reset_pool, to: :pool
+
+      private
+
+      def gem_available?(name)
+        Gem::Specification.find_by_name(name)
+      rescue Gem::LoadError
+        false
+      rescue StandardError
+        Gem.available?(name)
       end
-      # rubocop:enable Style/MethodMissing
     end
   end
 end

data/lib/react_on_rails/server_rendering_pool/{exec.rb → ruby_embedded_java_script.rb}

@@ -4,8 +4,7 @@ require "open-uri"
 
 module ReactOnRails
   module ServerRenderingPool
-    # This implementation of the rendering pool uses ExecJS to execute javasript code
-    class Exec
+    class RubyEmbeddedJavaScript
       def self.reset_pool
         options = {
           size: ReactOnRails.configuration.server_renderer_pool_size,
@@ -17,18 +16,11 @@ module ReactOnRails
       def self.reset_pool_if_server_bundle_was_modified
         return unless ReactOnRails.configuration.development_mode
 
-        server_bundle_js_file_path = ReactOnRails::Utils.server_bundle_js_file_path
-
-        if Utils.using_webpacker? && Webpacker.dev_server.running?
-          return if @last_loaded_server_bundle == server_bundle_js_file_path
-          @last_loaded_server_bundle = server_bundle_js_file_path
-        else
-          # we're not hashing the server name and we can use the mtime
-          file_mtime = File.mtime(server_bundle_js_file_path)
-          @server_bundle_timestamp ||= file_mtime
-          return if @server_bundle_timestamp == file_mtime
-          @server_bundle_timestamp = file_mtime
-        end
+        file_mtime = File.mtime(ReactOnRails::Utils.server_bundle_js_file_path)
+        @server_bundle_timestamp ||= file_mtime
+        return if @server_bundle_timestamp == file_mtime
+
+        @server_bundle_timestamp = file_mtime
 
         ReactOnRails::ServerRenderingPool.reset_pool
       end
@@ -42,9 +34,10 @@ module ReactOnRails
       # js_code MUST RETURN json stringify Object
       # Calling code will probably call 'html_safe' on return value before rendering to the view.
       def self.server_render_js_with_console_logging(js_code)
-        if trace_react_on_rails?
+        if ReactOnRails.configuration.trace
           @file_index ||= 1
-          trace_messsage(js_code, "tmp/server-generated-#{@file_index % 10}.js")
+          trace_js_code_used("Evaluating code to server render.", js_code,
+                             "tmp/server-generated-#{@file_index % 10}.js")
           @file_index += 1
         end
         json_string = eval_js(js_code)
@@ -68,18 +61,21 @@ module ReactOnRails
       class << self
         private
 
-        def trace_messsage(js_code, file_name = "tmp/server-generated.js", force = false)
-          return unless trace_react_on_rails? || force
+        def trace_js_code_used(msg, js_code, file_name = "tmp/server-generated.js", force: false)
+          return unless ReactOnRails.configuration.trace || force
           # Set to anything to print generated code.
-          puts "Z" * 80
-          puts "react_renderer.rb: 92"
-          puts "wrote file #{file_name}"
           File.write(file_name, js_code)
-          puts "Z" * 80
-        end
-
-        def trace_react_on_rails?
-          ENV["TRACE_REACT_ON_RAILS"].present?
+          msg = <<-MSG.strip_heredoc
+            #{'Z' * 80}
+            [react_on_rails] #{msg}
+            JavaScript code used: #{file_name}
+            #{'Z' * 80}
+          MSG
+          if force
+            Rails.logger.error(msg)
+          else
+            Rails.logger.info(msg)
+          end
         end
 
         def eval_js(js_code)
@@ -95,34 +91,35 @@ module ReactOnRails
 
           server_js_file = ReactOnRails::Utils.server_bundle_js_file_path
 
-          # bundle_js_code = File.read(server_js_file)
           begin
-            bundle_js_code = open(server_js_file, &:read)
+            bundle_js_code = File.read(server_js_file)
           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}"
-            raise msg
+            raise ReactOnRails::Error, msg
           end
           # rubocop:disable Layout/IndentHeredoc
           base_js_code = <<-JS
 #{console_polyfill}
-          #{execjs_timer_polyfills}
-          #{bundle_js_code};
+#{execjs_timer_polyfills}
+#{bundle_js_code};
           JS
           # rubocop:enable Layout/IndentHeredoc
           file_name = "tmp/base_js_code.js"
           begin
-            trace_messsage(base_js_code, file_name)
+            if ReactOnRails.configuration.trace
+              Rails.logger.info { "[react_on_rails] Created JavaScript context with file #{server_js_file}" }
+            end
             ExecJS.compile(base_js_code)
           rescue StandardError => e
             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")}"
-            puts msg
             Rails.logger.error(msg)
-            trace_messsage(base_js_code, file_name, true)
+            trace_js_code_used("Error when compiling JavaScript code for the context.", base_js_code,
+                               file_name, force: true)
             raise e
           end
         end
@@ -158,10 +155,10 @@ function clearTimeout() {
         end
 
         def undefined_for_exec_js_logging(function_name)
-          if trace_react_on_rails?
-            "console.error('#{function_name} is not defined for execJS. See "\
-          "https://github.com/sstephenson/execjs#faq. Note babel-polyfill may call this.');\n"\
-          "  console.error(getStackTrace().join('\\n'));"
+          if ReactOnRails.configuration.trace
+            "console.error('[React on Rails Rendering] #{function_name} is not defined for execJS. See "\
+            "https://github.com/sstephenson/execjs#faq. Note babel-polyfill may call this.');\n"\
+            "  console.error(getStackTrace().join('\\n'));"
           else
             ""
           end

data/lib/react_on_rails/test_helper.rb

@@ -57,7 +57,7 @@ module ReactOnRails
                                     source_path: nil,
                                     generated_assets_dir: nil,
                                     webpack_generated_files: nil)
-      ReactOnRails::Utils.check_manifest_not_cached
+      ReactOnRails::WebpackerUtils.check_manifest_not_cached
       if webpack_assets_status_checker.nil?
         source_path ||= ReactOnRails::Utils.source_path
         generated_assets_dir ||= ReactOnRails::Utils.generated_assets_dir

data/lib/react_on_rails/test_helper/webpack_assets_status_checker.rb

@@ -26,8 +26,8 @@ module ReactOnRails
       end
 
       def stale_generated_webpack_files
-        manifest_needed = ReactOnRails::Utils.using_webpacker? &&
-                          !ReactOnRails::Utils.manifest_exists?
+        manifest_needed = ReactOnRails::WebpackerUtils.using_webpacker? &&
+                          !ReactOnRails::WebpackerUtils.manifest_exists?
 
         return ["manifest.json"] if manifest_needed
 

data/lib/react_on_rails/utils.rb

@@ -8,33 +8,6 @@ require "active_support/core_ext/string"
 
 module ReactOnRails
   module Utils
-    ###########################################################
-    # PUBLIC API
-    ###########################################################
-
-    # Returns the hashed file name when using webpacker. Useful for creating cache keys.
-    def self.bundle_file_name(bundle_name)
-      raise "Only call bundle_file_name if using webpacker" unless using_webpacker?
-      full_path = bundle_js_file_path_from_webpacker(bundle_name)
-      pathname = Pathname.new(full_path)
-      pathname.basename.to_s
-    end
-
-    # Returns the hashed file name of the server bundle when using webpacker.
-    # Nececessary fragment-caching keys.
-    def self.server_bundle_file_name
-      return @server_bundle_hash if @server_bundle_hash && !Rails.env.development?
-
-      @server_bundle_hash = begin
-        server_bundle_name = ReactOnRails.configuration.server_bundle_js_file
-        bundle_file_name(server_bundle_name)
-      end
-    end
-
-    ###########################################################
-    # PRIVATE API -- Subject to change
-    ###########################################################
-
     # 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
     def self.truthy_presence(obj)
@@ -99,7 +72,7 @@ exitstatus: #{status.exitstatus}#{stdout_msg}#{stderr_msg}
       return @server_bundle_path if @server_bundle_path && !Rails.env.development?
 
       bundle_name = ReactOnRails.configuration.server_bundle_js_file
-      @server_bundle_path = if using_webpacker?
+      @server_bundle_path = if ReactOnRails::WebpackerUtils.using_webpacker?
                               begin
                                 bundle_js_file_path(bundle_name)
                               rescue Webpacker::Manifest::MissingEntryError
@@ -112,8 +85,8 @@ exitstatus: #{status.exitstatus}#{stdout_msg}#{stderr_msg}
     end
 
     def self.bundle_js_file_path(bundle_name)
-      if using_webpacker? && bundle_name != "manifest.json"
-        bundle_js_file_path_from_webpacker(bundle_name)
+      if ReactOnRails::WebpackerUtils.using_webpacker? && bundle_name != "manifest.json"
+        ReactOnRails::WebpackerUtils.bundle_js_file_path_from_webpacker(bundle_name)
       else
         # 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.
@@ -141,7 +114,7 @@ exitstatus: #{status.exitstatus}#{stdout_msg}#{stderr_msg}
 
     module Required
       def required(arg_name)
-        raise ArgumentError, "#{arg_name} is required"
+        raise ReactOnRailsPro::Error, "#{arg_name} is required"
       end
     end
 
@@ -150,53 +123,19 @@ exitstatus: #{status.exitstatus}#{stdout_msg}#{stderr_msg}
     end
 
     def self.source_path
-      using_webpacker? ? webpacker_source_path : ReactOnRails.configuration.node_modules_location
+      if ReactOnRails::WebpackerUtils.using_webpacker?
+        ReactOnRails::WebpackerUtils.webpacker_source_path
+      else
+        ReactOnRails.configuration.node_modules_location
+      end
     end
 
     def self.generated_assets_dir
-      using_webpacker? ? webpacker_public_output_path : ReactOnRails.configuration.generated_assets_dir
-    end
-
-    ###########################################################################
-    # WEBPACKER WRAPPERS
-    ###########################################################################
-    def self.using_webpacker?
-      ActionController::Base.helpers.respond_to?(:asset_pack_path)
-    end
-
-    def self.bundle_js_file_path_from_webpacker(bundle_name)
-      possible_result = Webpacker.manifest.lookup(bundle_name)
-      hashed_bundle_name = possible_result.nil? ? Webpacker.manifest.lookup!(bundle_name) : possible_result
-      if Webpacker.dev_server.running?
-        result = "#{Webpacker.dev_server.protocol}://#{Webpacker.dev_server.host_with_port}#{hashed_bundle_name}"
-        result
+      if ReactOnRails::WebpackerUtils.using_webpacker?
+        ReactOnRails::WebpackerUtils.webpacker_public_output_path
       else
-        # Next line will throw if the file or manifest does not exist
-        Rails.root.join(File.join("public", hashed_bundle_name)).to_s
+        ReactOnRails.configuration.generated_assets_dir
       end
     end
-
-    def self.webpacker_source_path
-      Webpacker.config.source_path
-    end
-
-    def self.webpacker_public_output_path
-      Webpacker.config.public_output_path
-    end
-
-    def self.manifest_exists?
-      Webpacker.config.public_manifest_path.exist?
-    end
-
-    def self.check_manifest_not_cached
-      return unless using_webpacker? && Webpacker.config.cache_manifest?
-      msg = <<-MSG.strip_heredoc
-          ERROR: you have enabled cache_manifest in the #{Rails.env} env when using the
-          ReactOnRails::TestHelper.configure_rspec_to_compile_assets helper
-          To fix this: edit your config/webpacker.yml file and set cache_manifest to false for test.
-      MSG
-      puts wrap_message(msg)
-      exit!
-    end
   end
 end

data/lib/react_on_rails/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ReactOnRails
-  VERSION = "10.1.4".freeze
+  VERSION = "11.0.0.beta.1".freeze
 end

data/lib/react_on_rails/version_checker.rb

@@ -71,7 +71,7 @@ module ReactOnRails
            parsed_package_contents["dependencies"].key?("react-on-rails")
           parsed_package_contents["dependencies"]["react-on-rails"]
         else
-          raise "no 'react-on-rails' entry in package.json dependencies"
+          raise ReactOnRails::Error, "No 'react-on-rails' entry in package.json dependencies"
         end
       end
 
@@ -82,7 +82,9 @@ module ReactOnRails
       def major_minor_patch
         return if relative_path?
         match = raw.match(MAJOR_MINOR_PATCH_VERSION_REGEX)
-        raise "Cannot parse version number '#{raw}' (wildcard versions are not supported)" unless match
+        unless match
+          raise ReactOnRails::Error, "Cannot parse version number '#{raw}' (wildcard versions are not supported)"
+        end
         [match[1], match[2], match[3]]
       end
 

data/lib/react_on_rails/webpacker_utils.rb

@@ -0,0 +1,42 @@
+module ReactOnRails
+  module WebpackerUtils
+    def self.using_webpacker?
+      ActionController::Base.helpers.respond_to?(:asset_pack_path)
+    end
+
+    def self.bundle_js_file_path_from_webpacker(bundle_name)
+      possible_result = Webpacker.manifest.lookup(bundle_name)
+      hashed_bundle_name = possible_result.nil? ? Webpacker.manifest.lookup!(bundle_name) : possible_result
+      if Webpacker.dev_server.running?
+        result = "#{Webpacker.dev_server.protocol}://#{Webpacker.dev_server.host_with_port}#{hashed_bundle_name}"
+        result
+      else
+        # Next line will throw if the file or manifest does not exist
+        Rails.root.join(File.join("public", hashed_bundle_name)).to_s
+      end
+    end
+
+    def self.webpacker_source_path
+      Webpacker.config.source_path
+    end
+
+    def self.webpacker_public_output_path
+      Webpacker.config.public_output_path
+    end
+
+    def self.manifest_exists?
+      Webpacker.config.public_manifest_path.exist?
+    end
+
+    def self.check_manifest_not_cached
+      return unless using_webpacker? && Webpacker.config.cache_manifest?
+      msg = <<-MSG.strip_heredoc
+          ERROR: you have enabled cache_manifest in the #{Rails.env} env when using the
+          ReactOnRails::TestHelper.configure_rspec_to_compile_assets helper
+          To fix this: edit your config/webpacker.yml file and set cache_manifest to false for test.
+      MSG
+      puts wrap_message(msg)
+      exit!
+    end
+  end
+end

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-on-rails",
-  "version": "10.1.4",
+  "version": "11.0.0-beta.1",
   "description": "react-on-rails JavaScript for react_on_rails Ruby gem",
   "main": "node_package/lib/ReactOnRails.js",
   "directories": {

data/rakelib/example_type.rb

@@ -11,7 +11,7 @@ module ReactOnRails
   module TaskHelpers
     class ExampleType
       def self.all
-        @example_types ||= []
+        @all ||= []
       end
 
       def self.namespace_name

data/rakelib/examples.rake

@@ -12,7 +12,7 @@ require_relative "task_helpers"
 namespace :examples do # rubocop:disable Metrics/BlockLength
   include ReactOnRails::TaskHelpers
   # Loads data from examples_config.yml and instantiates corresponding ExampleType objects
-  examples_config_file = File.expand_path("../examples_config.yml", __FILE__)
+  examples_config_file = File.expand_path("examples_config.yml", __dir__)
   examples_config = symbolize_keys(YAML.safe_load(File.read(examples_config_file)))
   examples_config[:example_type_data].each { |example_type_data| ExampleType.new(symbolize_keys(example_type_data)) }
 

data/rakelib/release.rake

@@ -4,9 +4,6 @@ require_relative "task_helpers"
 require_relative File.join(gem_root, "lib", "react_on_rails", "version_syntax_converter")
 require_relative File.join(gem_root, "lib", "react_on_rails", "git_utils")
 require_relative File.join(gem_root, "lib", "react_on_rails", "utils")
-
-# rubocop:disable Lint/UnneededDisable
-# rubocop:disable Layout/EmptyLinesAroundArguments
 desc("Releases both the gem and node package using the given version.
 
 IMPORTANT: the gem version must be in valid rubygem format (no dashes).
@@ -22,8 +19,6 @@ which are installed via `bundle install` and `yarn`
 2nd argument: Perform a dry run by passing 'true' as a second argument.
 
 Example: `rake release[2.1.0,false]`")
-# rubocop:enable Layout/EmptyLinesAroundArguments
-# rubocop:enable Lint/UnneededDisable
 
 # rubocop:disable Metrics/BlockLength
 task :release, %i[gem_version dry_run tools_install] do |_t, args|