react_on_rails 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b19c93747fab84bdc395c8f9dc2d664581863fca
-  data.tar.gz: 57488190d54beecdbc25296efd1d4ad0bc769cae
+  metadata.gz: 829e8c7c5f08f5a219d996d2356c0bc6a0125b42
+  data.tar.gz: 1d5bf7c969a5f182e2f81bee3626f4f2acd0ff85
 SHA512:
-  metadata.gz: 480d293755f22424befb537760ccce6e3e148ce82adf015efa5a2fa3699486d615c7ab332e3b980bb22f423355c15027d706b6423824d24f3755e56bf605cf59
-  data.tar.gz: 5eeecc42bbe0e439ad468b42b683632101608fa4b0fbba72e4c01fd6619c673ac3f18716d6aa39df121021a4fee4555ea2b4e1e5916c3433830848d11ac5582c
+  metadata.gz: fa2ef614a94bba6bcda082f6398889732ade8cc7c8885ba305fdee9638a599ac3b0e85d77175c4c2a05875463c3a654b76037de58830276c9b144ccb2bec9e39
+  data.tar.gz: 468c2014a1132b53ee9de227a10a30a4f4a07f435b1caa4ee64311541d1bb8ce034c235aaa5b51497e60f7ed852bf7fec499eed7b2d90b72e4e3b5bb50751ff8

data/README.md

@@ -159,9 +159,19 @@ ReactOnRails.configure do |config|
   # For server rendering. This can be set to false so that server side messages are discarded.
   config.replay_console = true # Default is true. Be cautious about turning this off.
   config.logging_on_server = true # Default is true. Logs server rendering messags to Rails.logger.info
+  
+  # Settings for the pool of renderers:
+  config.server_renderer_pool_size  ||= 1  # ExecJS doesn't allow more than one on MRI
+  config.server_renderer_timeout    ||= 20 # seconds
 end
 ```
 
+You can configure your pool of JS virtual machines and specify where it should load code:
+
+- On MRI, use `therubyracer` for the best performance (see [discussion](https://github.com/reactjs/react-rails/pull/290))
+- On MRI, you'll get a deadlock with `pool_size` > 1
+- If you're using JRuby, you can increase `pool_size` to have real multi-threaded rendering.
+
 # Try it out in the simple sample app
 Contributions and pull requests welcome!
 

data/app/helpers/react_on_rails_helper.rb

@@ -112,6 +112,8 @@ module ReactOnRailsHelper
     else
       ["",""]
     end
+  rescue ExecJS::ProgramError => err
+    raise ReactOnRails::ServerRenderingPool::PrerenderError.new(react_component_name, props_string, err)
   end
 
   # Takes javascript code and returns the output from it. This is called by react_component, which
@@ -132,8 +134,8 @@ module ReactOnRailsHelper
   def render_js_internal(js_expression, options = {})
     # TODO: This should be changed so that we don't create a new context every time
     # Example of doing this here: https://github.com/reactjs/react-rails/tree/master/lib/react/rails
-    ReactOnRails::ReactRenderer.new(options).render_js(js_expression,
-                                                       options)
+    ReactOnRails::ReactRenderer.render_js(js_expression,
+                                          options)
   end
 
 

data/lib/react_on_rails.rb

@@ -2,8 +2,11 @@ require "rails"
 
 require "react_on_rails/version"
 require "react_on_rails/configuration"
-
+require "react_on_rails/server_rendering_pool"
 module ReactOnRails
   class Engine < ::Rails::Engine
+    config.to_prepare do
+      ReactOnRails::ServerRenderingPool.reset_pool
+    end
   end
 end

data/lib/react_on_rails/configuration.rb

@@ -11,15 +11,17 @@ module ReactOnRails
       logging_on_server: true,
       generator_function: false,
       trace: Rails.env.development?,
-    )
+      server_renderer_pool_size: 1,
+      server_renderer_timeout: 20)
   end
 
   class Configuration
     attr_accessor :server_bundle_js_file, :prerender, :replay_console, :generator_function, :trace,
-                  :logging_on_server
+                  :logging_on_server, :server_renderer_pool_size, :server_renderer_timeout
 
     def initialize(server_bundle_js_file: nil, prerender: nil, replay_console: nil,
-                   generator_function: nil, trace: nil, logging_on_server: nil)
+                   generator_function: nil, trace: nil, logging_on_server: nil,
+                   server_renderer_pool_size: nil, server_renderer_timeout: nil)
       if File.exist?(server_bundle_js_file)
         self.server_bundle_js_file = server_bundle_js_file
       else
@@ -31,6 +33,10 @@ module ReactOnRails
       self.logging_on_server = logging_on_server
       self.generator_function = generator_function
       self.trace = trace.nil? ? Rails.env.development? : trace
+
+      # Server rendering:
+      self.server_renderer_pool_size = server_renderer_pool_size # increase if you're on JRuby
+      self.server_renderer_timeout = server_renderer_timeout # seconds
     end
   end
 end

data/lib/react_on_rails/react_renderer.rb

@@ -1,22 +1,10 @@
 # Kudos to react-rails for how to do the polyfill of the console!
 # https://github.com/reactjs/react-rails/blob/master/lib/react/server_rendering/sprockets_renderer.rb
 
+# require 'react_on_rails/server_rendering_pool'
+
 module ReactOnRails
   class ReactRenderer
-    # Reimplement console methods for replaying on the client
-    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
-
     # Script to write to the browser console.
     # NOTE: result comes from enclosing closure and is the server generated HTML
     # that we intend to write to the browser. Thus, the script tag will get executed right after
@@ -36,17 +24,13 @@ var console = { history: [] };
       if (typeof window !== 'undefined') { debugger; }
     JS
 
-    def initialize(options)
-      @replay_console = options.fetch(:replay_console) { ReactOnRails.configuration.replay_console }
-    end
-
     # js_code: JavaScript expression that returns a string.
     # Returns an Array:
     # [0]: string of HTML for direct insertion on the page by evaluating js_code
     # [1]: console messages
     #   Note, js_code does not have to be based on React.
     # Calling code will probably call 'html_safe' on return value before rendering to the view.
-    def render_js(js_code, options = {})
+    def self.render_js(js_code, options = {})
       component_name = options.fetch(:react_component_name, "")
       server_side = options.fetch(:server_side, false)
 
@@ -57,7 +41,7 @@ var console = { history: [] };
     var htmlResult = '';
     var consoleReplay = '';
 #{ReactOnRails::ReactRenderer.wrap_code_with_exception_handler(result_js_code, component_name)}
-      #{console_replay_js_code}
+#{console_replay_js_code(options)}
     return JSON.stringify([htmlResult, consoleReplay]);
   })()
       JS
@@ -70,13 +54,10 @@ var console = { history: [] };
         puts "ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ"
       end
 
-      if js_context
-        json_string = js_context.eval(js_code_wrapper)
-      else
-        json_string = ExecJS.eval(js_code_wrapper)
-      end
+      json_string = ReactOnRails::ServerRenderingPool.render(js_code_wrapper)
       # element 0 is the html, element 1 is the script tag for the server console output
       result = JSON.parse(json_string)
+
       if ReactOnRails.configuration.logging_on_server
         console_script = result[1]
         console_script_lines = console_script.split("\n")
@@ -148,33 +129,9 @@ var console = { history: [] };
       JS
     end
 
-    def console_replay_js_code
-      (@replay_console || ReactOnRails.configuration.logging_on_server) ? CONSOLE_REPLAY : ""
-    end
-
-    def base_js_code(bundle_js_code)
-      <<-JS
-#{CONSOLE_POLYFILL}
-      #{bundle_js_code};
-      JS
-    end
-
-    def js_context
-      if @js_context.nil?
-        @js_context = begin
-          server_js_file = ReactOnRails.configuration.server_bundle_js_file
-          if server_js_file.present? && File.exist?(server_js_file)
-            bundle_js_code = File.read(server_js_file)
-            ExecJS.compile(base_js_code(bundle_js_code))
-          else
-            if server_js_file.present?
-              Rails.logger.warn("You specified server rendering JS file: #{server_js_file}, but it cannot be read.")
-            end
-            false # using false so we don't try every time if no server_js file
-          end
-        end
-      end
-      @js_context
+    def self.console_replay_js_code(options)
+      replay_console = options.fetch(:replay_console) { ReactOnRails.configuration.replay_console }
+      (replay_console || ReactOnRails.configuration.logging_on_server) ? CONSOLE_REPLAY : ""
     end
   end
 end

data/lib/react_on_rails/server_rendering_pool.rb

@@ -0,0 +1,57 @@
+require 'connection_pool'
+
+# Based on the react-rails gem
+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.render(js_code)
+      @@js_context_pool.with do |js_context|
+        js_context.eval(js_code)
+      end
+    end
+
+    def self.create_js_context
+      server_js_file = ReactOnRails.configuration.server_bundle_js_file
+      if server_js_file.present? && File.exist?(server_js_file)
+        bundle_js_code = File.read(server_js_file)
+        base_js_code = <<-JS
+#{CONSOLE_POLYFILL}
+#{bundle_js_code};
+        JS
+        ExecJS.compile(base_js_code)
+      else
+        if server_js_file.present?
+          Rails.logger.warn("You specified server rendering JS file: #{server_js_file}, but it cannot be read.")
+        end
+        ExecJS.compile("")
+      end
+    end
+
+    # Reimplement console methods for replaying on the client
+    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
+
+    class PrerenderError < RuntimeError
+      def initialize(component_name, props, js_message)
+        message = ["Encountered error \"#{js_message}\" when prerendering #{component_name} with #{props}",
+                    js_message.backtrace.join("\n")].join("\n")
+        super(message)
+      end
+    end
+  end
+end

data/lib/react_on_rails/version.rb

@@ -1,3 +1,3 @@
 module ReactOnRails
-  VERSION = "0.1.6"
+  VERSION = "0.1.7"
 end

data/react_on_rails.gemspec

@@ -3,28 +3,29 @@ lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'react_on_rails/version'
 
-Gem::Specification.new do |spec|
-  spec.name          = "react_on_rails"
-  spec.version       = ReactOnRails::VERSION
-  spec.authors       = ["Justin Gordon"]
-  spec.email         = ["justin@shakacode.com"]
+Gem::Specification.new do |s|
+  s.name          = "react_on_rails"
+  s.version       = ReactOnRails::VERSION
+  s.authors       = ["Justin Gordon"]
+  s.email         = ["justin@shakacode.com"]
 
-  spec.summary       = %q{Rails with react server rendering with webpack. }
-  spec.description   = %q{See README.md}
-  spec.homepage      = "https://github.com/shakacode/react_on_rails"
-  spec.license       = "MIT"
+  s.summary       = %q{Rails with react server rendering with webpack. }
+  s.description   = %q{See README.md}
+  s.homepage      = "https://github.com/shakacode/react_on_rails"
+  s.license       = "MIT"
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  s.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  s.bindir        = "exe"
+  s.executables   = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  s.require_paths = ["lib"]
 
-  spec.add_dependency "rails", "~> 4.2"
-  spec.add_dependency "execjs", "~> 2.5"
+  s.add_dependency "rails", ">= 4.0"
+  s.add_dependency "execjs", "~> 2.5"
+  s.add_dependency "connection_pool"
 
-  spec.add_development_dependency "bundler", "~> 1.10"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec"
-  spec.add_development_dependency "rubocop"
-  spec.add_development_dependency "coveralls"
+  s.add_development_dependency "bundler", "~> 1.10"
+  s.add_development_dependency "rake", "~> 10.0"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "rubocop"
+  s.add_development_dependency "coveralls"
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: react_on_rails
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - Justin Gordon
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-09-27 00:00:00.000000000 Z
+date: 2015-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: execjs
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: connection_pool
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -136,6 +150,7 @@ files:
 - lib/react_on_rails.rb
 - lib/react_on_rails/configuration.rb
 - lib/react_on_rails/react_renderer.rb
+- lib/react_on_rails/server_rendering_pool.rb
 - lib/react_on_rails/version.rb
 - react_on_rails.gemspec
 - ruby-lint.yml