react_on_rails 5.2.0 → 6.0.0.beta.1

data/lib/react_on_rails.rb

@@ -6,6 +6,7 @@ require "react_on_rails/version_checker"
 require "react_on_rails/configuration"
 require "react_on_rails/server_rendering_pool"
 require "react_on_rails/engine"
+require "react_on_rails/react_component/options"
 require "react_on_rails/version_syntax_converter"
 require "react_on_rails/test_helper"
 require "react_on_rails/git_utils"
@@ -13,5 +14,5 @@ require "react_on_rails/utils"
 require "react_on_rails/test_helper"
 require "react_on_rails/test_helper/webpack_assets_compiler"
 require "react_on_rails/test_helper/webpack_assets_status_checker"
-require "react_on_rails/test_helper/webpack_process_checker"
 require "react_on_rails/test_helper/ensure_assets_compiled"
+require "react_on_rails/test_helper/node_process_launcher"

data/lib/react_on_rails/configuration.rb

@@ -8,7 +8,7 @@ module ReactOnRails
 
   def self.setup_config_values
     if @configuration.webpack_generated_files.empty?
-      files = ["client-bundle.js"]
+      files = ["webpack-bundle.js"]
       if @configuration.server_bundle_js_file.present?
         files << @configuration.server_bundle_js_file
       end
@@ -44,7 +44,6 @@ module ReactOnRails
 
       # generated_assets_dirs is deprecated
       generated_assets_dir: "",
-
       server_bundle_js_file: "",
       prerender: false,
       replay_console: true,
@@ -56,7 +55,11 @@ module ReactOnRails
       server_renderer_timeout: 20,
       skip_display_none: false,
       webpack_generated_files: [],
-      rendering_extension: nil
+      rendering_extension: nil,
+      server_render_method: "",
+      symlink_non_digested_assets_regex: /\.(png|jpg|jpeg|gif|tiff|woff|ttf|eot|svg)/,
+      npm_build_test_command: "",
+      npm_build_production_command: ""
     )
   end
 
@@ -66,7 +69,9 @@ module ReactOnRails
                   :logging_on_server, :server_renderer_pool_size,
                   :server_renderer_timeout, :raise_on_prerender_error,
                   :skip_display_none, :generated_assets_dirs, :generated_assets_dir,
-                  :webpack_generated_files, :rendering_extension
+                  :webpack_generated_files, :rendering_extension, :npm_build_test_command,
+                  :npm_build_production_command,
+                  :server_render_method, :symlink_non_digested_assets_regex
 
     def initialize(server_bundle_js_file: nil, prerender: nil, replay_console: nil,
                    trace: nil, development_mode: nil,
@@ -74,10 +79,14 @@ module ReactOnRails
                    server_renderer_timeout: nil, raise_on_prerender_error: nil,
                    skip_display_none: nil, generated_assets_dirs: nil,
                    generated_assets_dir: nil, webpack_generated_files: nil,
-                   rendering_extension: nil)
+                   rendering_extension: nil, npm_build_test_command: nil,
+                   npm_build_production_command: nil,
+                   server_render_method: nil, symlink_non_digested_assets_regex: nil)
       self.server_bundle_js_file = server_bundle_js_file
       self.generated_assets_dirs = generated_assets_dirs
       self.generated_assets_dir = generated_assets_dir
+      self.npm_build_test_command = npm_build_test_command
+      self.npm_build_production_command = npm_build_production_command
 
       self.prerender = prerender
       self.replay_console = replay_console
@@ -97,6 +106,9 @@ module ReactOnRails
 
       self.webpack_generated_files = webpack_generated_files
       self.rendering_extension = rendering_extension
+
+      self.server_render_method = server_render_method
+      self.symlink_non_digested_assets_regex = symlink_non_digested_assets_regex
     end
   end
 end

data/lib/react_on_rails/react_component/options.rb

@@ -0,0 +1,76 @@
+module ReactOnRails
+  module ReactComponent
+    class Options
+      NO_PROPS = {}.freeze
+      HIDDEN = "display:none".freeze
+
+      attr_reader :index
+
+      def initialize(name:, index:, options:)
+        @name = name
+        @index = index
+        @options = options
+      end
+
+      def props
+        options.fetch(:props) { NO_PROPS }
+      end
+
+      def name
+        @name.camelize
+      end
+
+      def dom_id
+        options.fetch(:id) { default_dom_id }
+      end
+
+      def html_options
+        options[:html_options].to_h
+      end
+
+      def prerender
+        retrieve_key(:prerender)
+      end
+
+      def trace
+        retrieve_key(:trace)
+      end
+
+      def replay_console
+        retrieve_key(:replay_console)
+      end
+
+      def raise_on_prerender_error
+        retrieve_key(:raise_on_prerender_error)
+      end
+
+      def data
+        {
+          component_name: name,
+          props: props,
+          trace: trace,
+          dom_id: dom_id
+        }
+      end
+
+      def style
+        return nil if ReactOnRails.configuration.skip_display_none
+        HIDDEN
+      end
+
+      private
+
+      attr_reader :options
+
+      def default_dom_id
+        "#{@name}-react-component-#{@index}"
+      end
+
+      def retrieve_key(key)
+        options.fetch(key) do
+          ReactOnRails.configuration.public_send(key)
+        end
+      end
+    end
+  end
+end

data/lib/react_on_rails/server_rendering_pool.rb

@@ -1,165 +1,23 @@
 require "connection_pool"
+require_relative "server_rendering_pool/exec"
+require_relative "server_rendering_pool/node"
 
 # Based on the react-rails gem.
 # None of these methods should be called directly.
 # See app/helpers/react_on_rails_helper.rb
 module ReactOnRails
-  class ServerRenderingPool
-    def self.reset_pool
-      options = { size: ReactOnRails.configuration.server_renderer_pool_size,
-                  timeout: ReactOnRails.configuration.server_renderer_pool_size }
-      @js_context_pool = ConnectionPool.new(options) { create_js_context }
-    end
-
-    def self.reset_pool_if_server_bundle_was_modified
-      return unless ReactOnRails.configuration.development_mode
-      file_mtime = File.mtime(ReactOnRails::Utils.default_server_bundle_js_file_path)
-      @server_bundle_timestamp ||= file_mtime
-      return if @server_bundle_timestamp == file_mtime
-      ReactOnRails::ServerRenderingPool.reset_pool
-      @server_bundle_timestamp = file_mtime
-    end
-
-    # js_code: JavaScript expression that returns a string.
-    # Returns a Hash:
-    #   html: string of HTML for direct insertion on the page by evaluating js_code
-    #   consoleReplayScript: script for replaying console
-    #   hasErrors: true if server rendering errors
-    # Note, js_code does not have to be based on React.
-    # 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?
-        @file_index ||= 1
-        trace_messsage(js_code, "tmp/server-generated-#{@file_index % 10}.js")
-        @file_index += 1
-      end
-      json_string = eval_js(js_code)
-      result = JSON.parse(json_string)
-
-      if ReactOnRails.configuration.logging_on_server
-        console_script = result["consoleReplayScript"]
-        console_script_lines = console_script.split("\n")
-        console_script_lines = console_script_lines[2..-2]
-        re = /console\.log\.apply\(console, \["\[SERVER\] (?<msg>.*)"\]\);/
-        if console_script_lines
-          console_script_lines.each do |line|
-            match = re.match(line)
-            Rails.logger.info { "[react_on_rails] #{match[:msg]}" } if match
-          end
-        end
-      end
-      result
-    end
-
+  module ServerRenderingPool
     class << self
-      private
-
-      def trace_messsage(js_code, file_name = "tmp/server-generated.js", force = false)
-        return unless trace_react_on_rails? || 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?
-      end
-
-      def eval_js(js_code)
-        @js_context_pool.with do |js_context|
-          result = js_context.eval(js_code)
-          js_context.eval("console.history = []")
-          result
-        end
-      end
-
-      def create_js_context
-        server_js_file = ReactOnRails::Utils.default_server_bundle_js_file_path
-        if server_js_file.present? && File.exist?(server_js_file)
-          bundle_js_code = File.read(server_js_file)
-          base_js_code = <<-JS
-#{console_polyfill}
-#{execjs_timer_polyfills}
-          #{bundle_js_code};
-          JS
-          file_name = "tmp/base_js_code.js"
-          begin
-            trace_messsage(base_js_code, file_name)
-            ExecJS.compile(base_js_code)
-          rescue => 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)
-            raise e
-          end
-        else
-          if server_js_file.present?
-            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"
-            Rails.logger.warn msg
-            puts msg
-          end
-          ExecJS.compile("")
-        end
-      end
-
-      def execjs_timer_polyfills
-        <<-JS
-function getStackTrace () {
-  var stack;
-  try {
-    throw new Error('');
-  }
-  catch (error) {
-    stack = error.stack || '';
-  }
-  stack = stack.split('\\n').map(function (line) { return line.trim(); });
-  return stack.splice(stack[0] == 'Error' ? 2 : 1);
-}
-
-function setInterval() {
-  #{undefined_for_exec_js_logging('setInterval')}
-}
-
-function setTimeout() {
-  #{undefined_for_exec_js_logging('setTimeout')}
-}
-        JS
-      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'));"
+      def pool
+        if ReactOnRails.configuration.server_render_method == "NodeJS"
+          ServerRenderingPool::Node
         else
-          ""
+          ServerRenderingPool::Exec
         end
       end
 
-      # Reimplement console methods for replaying on the client
-      def console_polyfill
-        <<-JS
-var console = { history: [] };
-['error', 'log', 'info', 'warn'].forEach(function (level) {
-  console[level] = function () {
-    var argArray = Array.prototype.slice.call(arguments);
-    if (argArray.length > 0) {
-      argArray[0] = '[SERVER] ' + argArray[0];
-    }
-    console.history.push({level: level, arguments: argArray});
-  };
-});
-        JS
+      def method_missing(sym, *args, &block)
+        pool.send sym, *args, &block
       end
     end
   end

data/lib/react_on_rails/server_rendering_pool/exec.rb

@@ -0,0 +1,166 @@
+module ReactOnRails
+  module ServerRenderingPool
+    # This implementation of the rendering pool uses ExecJS to execute javasript code
+    class Exec
+      def self.reset_pool
+        options = {
+          size: ReactOnRails.configuration.server_renderer_pool_size,
+          timeout: ReactOnRails.configuration.server_renderer_timeout
+        }
+        @js_context_pool = ConnectionPool.new(options) { create_js_context }
+      end
+
+      def self.reset_pool_if_server_bundle_was_modified
+        return unless ReactOnRails.configuration.development_mode
+        file_mtime = File.mtime(ReactOnRails::Utils.default_server_bundle_js_file_path)
+        @server_bundle_timestamp ||= file_mtime
+        return if @server_bundle_timestamp == file_mtime
+        ReactOnRails::ServerRenderingPool.reset_pool
+        @server_bundle_timestamp = file_mtime
+      end
+
+      # js_code: JavaScript expression that returns a string.
+      # Returns a Hash:
+      #   html: string of HTML for direct insertion on the page by evaluating js_code
+      #   consoleReplayScript: script for replaying console
+      #   hasErrors: true if server rendering errors
+      # Note, js_code does not have to be based on React.
+      # 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?
+          @file_index ||= 1
+          trace_messsage(js_code, "tmp/server-generated-#{@file_index % 10}.js")
+          @file_index += 1
+        end
+        json_string = eval_js(js_code)
+        result = JSON.parse(json_string)
+
+        if ReactOnRails.configuration.logging_on_server
+          console_script = result["consoleReplayScript"]
+          console_script_lines = console_script.split("\n")
+          console_script_lines = console_script_lines[2..-2]
+          re = /console\.log\.apply\(console, \["\[SERVER\] (?<msg>.*)"\]\);/
+          if console_script_lines
+            console_script_lines.each do |line|
+              match = re.match(line)
+              Rails.logger.info { "[react_on_rails] #{match[:msg]}" } if match
+            end
+          end
+        end
+        result
+      end
+
+      class << self
+        private
+
+        def trace_messsage(js_code, file_name = "tmp/server-generated.js", force = false)
+          return unless trace_react_on_rails? || 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?
+        end
+
+        def eval_js(js_code)
+          @js_context_pool.with do |js_context|
+            result = js_context.eval(js_code)
+            js_context.eval("console.history = []")
+            result
+          end
+        end
+
+        def create_js_context
+          server_js_file = ReactOnRails::Utils.default_server_bundle_js_file_path
+          if server_js_file.present? && File.exist?(server_js_file)
+            bundle_js_code = File.read(server_js_file)
+            base_js_code = <<-JS
+#{console_polyfill}
+            #{execjs_timer_polyfills}
+            #{bundle_js_code};
+            JS
+            file_name = "tmp/base_js_code.js"
+            begin
+              trace_messsage(base_js_code, file_name)
+              ExecJS.compile(base_js_code)
+            rescue => 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)
+              raise e
+            end
+          else
+            if server_js_file.present?
+              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"
+              Rails.logger.warn msg
+              puts msg
+            end
+            ExecJS.compile("")
+          end
+        end
+
+        def execjs_timer_polyfills
+          <<-JS
+function getStackTrace () {
+  var stack;
+  try {
+    throw new Error('');
+  }
+  catch (error) {
+    stack = error.stack || '';
+  }
+  stack = stack.split('\\n').map(function (line) { return line.trim(); });
+  return stack.splice(stack[0] == 'Error' ? 2 : 1);
+}
+
+function setInterval() {
+  #{undefined_for_exec_js_logging('setInterval')}
+}
+
+function setTimeout() {
+  #{undefined_for_exec_js_logging('setTimeout')}
+}
+          JS
+        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'));"
+          else
+            ""
+          end
+        end
+
+        # Reimplement console methods for replaying on the client
+        def console_polyfill
+          <<-JS
+var console = { history: [] };
+['error', 'log', 'info', 'warn'].forEach(function (level) {
+  console[level] = function () {
+    var argArray = Array.prototype.slice.call(arguments);
+    if (argArray.length > 0) {
+      argArray[0] = '[SERVER] ' + argArray[0];
+    }
+    console.history.push({level: level, arguments: argArray});
+  };
+});
+          JS
+        end
+      end
+    end
+  end
+end