volt 0.9.3.pre4 → 0.9.3.pre5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3a512670034e9289a6697c10ad2c3cc15c25c53e
-  data.tar.gz: 1bb81b98a09cc8d568803e76ecddd95cfcdfa3b6
+  metadata.gz: 81532c9c3fda9af1ddf09bf56ff2c479f507f279
+  data.tar.gz: aa68ce3727fa3dda1d21bb86771070b93ce5b595
 SHA512:
-  metadata.gz: 0db33427235876fcd9d5f3f1c16ad38f3f0e30806febe59bce5da8d5516dbe7ee6c97163121b0f84de1c8e9fd8971d6cedd5bb1dbf27074b030c14fac90e5ab3
-  data.tar.gz: 5084fb2c133abb9a083964ef84cb63d3e338c2d1008a8b3636aedfac3f7a03fc3efffc91f4543574efa4b83779db8c3ebff364dd05a2c9a2418e622a0aaa710b
+  metadata.gz: 9079b50cbc1bf729c3c56a11fc30082edf7c846628fccc4cd8b468a5c7184f14c7c25dbcc16dc60ab6ad4a7c51e54ec3154a97c8a38aa8c313bffea7accc071d
+  data.tar.gz: 88abd17e264363c606421fbffa52621f01bc869147de950b0922b796ad7ff74da5a0f9b04e6a2aedb79adebf957f07da7af9807c329317c12e3f9638cadae1d8

data/CHANGELOG.md

@@ -18,6 +18,7 @@
 - .inspect for models is now cleaner
 - Volt.current_user now works in HttpController's
 - You can now add your own middleware to the middleware stack.  (see docs)
+- Added a threadpool for Tasks, and options to customize pool size in config/app.rb
 
 ### Changed
 - All methods on ArrayModel's under the store collection now return a Promise.

data/README.md

@@ -16,6 +16,7 @@ Pages HTML is written in a template language where you can put Ruby between `{{`
 See some demo videos here:
 - [Volt Todos Example](https://www.youtube.com/watch?v=KbFtIt7-ge8)
 - [What Is Volt in 6 Minutes](https://www.youtube.com/watch?v=P27EPQ4ne7o)
+- [Promises in 0.9.3 prerelease](https://www.youtube.com/watch?v=1RX9i8ivtWI)
 - [Pagination Example](https://www.youtube.com/watch?v=1uanfzMLP9g)
 - [Routes and Templates](https://www.youtube.com/watch?v=1yNMP3XR6jU)
 - [Isomorphic App Development - RubyConf 2014](https://www.youtube.com/watch?v=7i6AL7Walc4)

data/lib/volt/config.rb

@@ -60,7 +60,11 @@ else
 
           compress_javascript: Volt.env.production?,
           compress_css:        Volt.env.production?,
-          abort_on_exception:  true
+          abort_on_exception:  true,
+
+          min_worker_threads: 1,
+          max_worker_threads: 10,
+          worker_timeout: 60
         }
       end
 

data/lib/volt/extra_core/logger.rb

@@ -41,7 +41,10 @@ else
         if error
           text += "\n" + colorize(error.to_s, :red)
           if error.is_a?(Exception) && !error.is_a?(VoltUserError)
-            text += "\n" + colorize(error.backtrace.join("\n"), :red)
+            backtrace = error.try(:backtrace)
+            if backtrace
+              text += "\n" + colorize(error.backtrace.join("\n"), :red)
+            end
           end
         end
 
@@ -68,6 +71,11 @@ else
         Volt.logger.info(colorize(msg, color))
       end
 
+      def error(msg)
+        msg ||= yield
+        super(colorize(msg, :red))
+      end
+
       private
 
       def colorize(string, color)

data/lib/volt/server/middleware/default_middleware_stack.rb

@@ -46,6 +46,7 @@ module Volt
 
       # Serve the opal files
       opal_files = OpalFiles.new(rack_app, volt_app.app_path, volt_app.component_paths)
+      volt_app.sprockets = opal_files.environment
 
       # Serve the main html files from public, also figure out
       # which JS/CSS files to serve.

data/lib/volt/server/rack/http_response_renderer.rb

@@ -21,7 +21,7 @@ module Volt
 
     # Iterate through @renderes to find a matching renderer for the given
     # content and call the given proc.
-    # Other params fromt he content are returned as additional headers
+    # Other params from the content are returned as additional headers
     # Returns an empty string if no renderer could be found
     def render(content)
       content = content.symbolize_keys

data/lib/volt/tasks/dispatcher.rb

@@ -1,6 +1,7 @@
 # require 'ruby-prof'
 require 'volt/utils/logging/task_logger'
 require 'drb'
+require 'concurrent'
 
 module Volt
   # The task dispatcher is responsible for taking incoming messages
@@ -13,12 +14,69 @@ module Volt
 
     def initialize(volt_app)
       @volt_app = volt_app
+
+      if Volt.env.test?
+        # When testing, we want to run immediately so it blocks and doesn't
+        # start the next thread.
+        @worker_pool = Concurrent::ImmediateExecutor.new
+      else
+        @worker_pool = Concurrent::ThreadPoolExecutor.new(
+        min_threads: Volt.config.min_worker_threads,
+        max_threads: Volt.config.max_worker_threads
+      )
+      end
+
+      @worker_timeout = Volt.config.worker_timeout || 60
     end
 
     # Dispatch takes an incoming Task from the client and runs it on the
     # server, returning the result to the client.
     # Tasks returning a promise will wait to return.
     def dispatch(channel, message)
+      # Dispatch the task in the worker pool.  Pas in the meta data
+      @worker_pool.post do
+        begin
+          dispatch_in_thread(channel, message)
+        rescue => e
+          err = "Worker Thread Exception for #{message}\n"
+          err += e.inspect
+          err += e.backtrace.join("\n") if e.respond_to?(:backtrace)
+
+          Volt.logger.error(err)
+        end
+      end
+    end
+
+
+    # Check if it is safe to use this method
+    def safe_method?(klass, method_name)
+      # Make sure the class being called is a Task.
+      return false unless klass.ancestors.include?(Task)
+
+      # Make sure the method is defined on the klass we're using and not up the hiearchy.
+      #   ^ This check prevents methods like #send, #eval, #instance_eval, #class_eval, etc...
+      klass.ancestors.each do |ancestor_klass|
+        if ancestor_klass.instance_methods(false).include?(method_name)
+          return true
+        elsif ancestor_klass == Task
+          # We made it to Task and didn't find the method, that means it
+          # was defined above Task, so we reject the call.
+          return false
+        end
+      end
+
+      false
+    end
+
+    def close_channel(channel)
+      QueryTasks.new(@volt_app, channel).close!
+    end
+
+    private
+
+    # Do the actual dispatching, should be running inside of a worker thread at
+    # this point.
+    def dispatch_in_thread(channel, message)
       callback_id, class_name, method_name, meta_data, *args = message
       method_name = method_name.to_sym
 
@@ -36,10 +94,13 @@ module Volt
 
         # Init and send the method
         promise = promise.then do
-          Thread.current['meta'] = meta_data
-          result = klass.new(@volt_app, channel, self).send(method_name, *args)
+          result = nil
+          Concurrent.timeout(klass.__timeout || @worker_timeout) do
+            Thread.current['meta'] = meta_data
+            result = klass.new(@volt_app, channel, self).send(method_name, *args)
 
-          Thread.current['meta'] = nil
+            Thread.current['meta'] = nil
+          end
 
           result
         end
@@ -51,6 +112,10 @@ module Volt
 
       # Called after task runs or fails
       finish = proc do |error|
+        if error.is_a?(Concurrent::TimeoutError)
+          error = Concurrent::TimeoutError.new("Task Timed Out after #{@worker_timeout} seconds: #{message}")
+        end
+
         run_time = ((Time.now.to_f - start_time) * 1000).round(3)
         Volt.logger.log_dispatch(class_name, method_name, run_time, args, error)
       end
@@ -64,30 +129,7 @@ module Volt
         finish.call(error)
         channel.send_message('response', callback_id, nil, error)
       end
-    end
 
-    # Check if it is safe to use this method
-    def safe_method?(klass, method_name)
-      # Make sure the class being called is a Task.
-      return false unless klass.ancestors.include?(Task)
-
-      # Make sure the method is defined on the klass we're using and not up the hiearchy.
-      #   ^ This check prevents methods like #send, #eval, #instance_eval, #class_eval, etc...
-      klass.ancestors.each do |ancestor_klass|
-        if ancestor_klass.instance_methods(false).include?(method_name)
-          return true
-        elsif ancestor_klass == Task
-          # We made it to Task and didn't find the method, that means it
-          # was defined above Task, so we reject the call.
-          return false
-        end
-      end
-
-      false
-    end
-
-    def close_channel(channel)
-      QueryTasks.new(@volt_app, channel).close!
     end
   end
 end

data/lib/volt/tasks/task.rb

@@ -18,6 +18,8 @@ module Volt
     else
       include CollectionHelpers
 
+      class_attribute :__timeout
+
       def initialize(volt_app, channel = nil, dispatcher = nil)
         @volt_app   = volt_app
         @page       = volt_app.page
@@ -34,6 +36,12 @@ module Volt
         @subclasses ||= []
       end
 
+      # Set the timeout for method calls on this task.  (The default is
+      # Volt.config.worker_timeout)
+      def timeout(value)
+        self.__timeout = value
+      end
+
       # On the backend, we proxy all class methods like we would
       # on the front-end.  This returns a promise, even if the
       # original code did not.

data/lib/volt/version.rb

@@ -1,5 +1,5 @@
 module Volt
   module Version
-    STRING = '0.9.3.pre4'
+    STRING = '0.9.3.pre5'
   end
 end

data/lib/volt/volt/app.rb

@@ -39,6 +39,7 @@ module Volt
     attr_reader :component_paths, :router, :page, :live_query_pool,
                 :channel_live_queries, :app_path, :database, :message_bus,
                 :middleware
+    attr_accessor :sprockets
 
     def initialize(app_path=nil)
       if Volt.server? && !app_path

data/spec/server/message_bus/peer_to_peer/peer_connection_spec.rb

@@ -51,6 +51,10 @@ unless RUBY_PLATFORM == 'opal'
       def handle_message(message)
         @receiver << message
       end
+
+      def still_alive?(*args)
+        false
+      end
     end
 
     # Disable for jruby for now

data/spec/tasks/dispatcher_spec.rb

@@ -7,13 +7,20 @@ if RUBY_PLATFORM != 'opal'
     end
   end
 
+  class WorkerPoolStub
+    def post(*args)
+      yield(*args)
+    end
+  end
+
   describe Volt::Dispatcher do
+    let(:dispatcher) { Volt::Dispatcher.new(Volt.current_app) }
+
     before do
       Volt.logger = spy('Volt::VoltLogger')
+      allow(Concurrent::ThreadPoolExecutor).to receive(:new).and_return(WorkerPoolStub.new)
     end
 
-    let(:dispatcher) { Volt::Dispatcher.new(Volt.current_app) }
-
     after do
       # Cleanup, make volt make a new logger.  Otherwise this will leak out.
       Volt.logger = nil

data/templates/project/config/app.rb.tt

@@ -114,4 +114,19 @@ Volt.configure do |config|
   #
   # Bind Ip - specifies the ip address the message bus server should bind on.
   # config.message_bus.bind_ip = '127.0.0.1'
+
+  #############
+  # Concurrency
+  #############
+  # Volt provides a thread worker pool for incoming task requests (and all
+  # database requests, since those use tasks to do their work.)  The following
+  # lets you control the size of the worker pool.  Threads are only created as
+  # needed, and are removed after a certain amount of inactivity.
+  # config.min_worker_threads = 1
+  # config.max_worker_threads = 10
+  #
+  # You can also specify the amount of time a Task should run for before it
+  # timeout's.  Setting this to short can cause unexpected results, currently
+  # we recomend it be at least 10 seconds.
+  # config.worker_timeout = 60
 end

data/volt.gemspec

@@ -29,7 +29,10 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'opal', '~> 0.7.2'
   spec.add_dependency 'bundler', '>= 1.5'
   spec.add_dependency 'faye-websocket', '~> 0.9.2'
-  spec.add_dependency 'concurrent-ruby', '~> 0.8.0'
+
+  # Locking down concurrent-ruby because one currently used feature is going to
+  # be deprecated (which we need to build a work around for)
+  spec.add_dependency 'concurrent-ruby', '= 0.8.0'
 
 
   # For user passwords

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: volt
 version: !ruby/object:Gem::Version
-  version: 0.9.3.pre4
+  version: 0.9.3.pre5
 platform: ruby
 authors:
 - Ryan Stout
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-05 00:00:00.000000000 Z
+date: 2015-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -154,14 +154,14 @@ dependencies:
   name: concurrent-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
         version: 0.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
         version: 0.8.0
 - !ruby/object:Gem::Dependency
@@ -764,6 +764,7 @@ files:
 - templates/newgem/app/newgem/controllers/main_controller.rb.tt
 - templates/newgem/app/newgem/controllers/server/.empty_directory
 - templates/newgem/app/newgem/lib/.empty_directory
+- templates/newgem/app/newgem/models/.empty_directory
 - templates/newgem/app/newgem/views/main/index.html
 - templates/newgem/bin/newgem.tt
 - templates/newgem/gitignore.tt