rest-core 3.5.2 → 3.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0399835474967a9425ce60b8073d0b4a49e7c572
-  data.tar.gz: 6cac1d0a2fce2e8f5ea64e64b2b56343d8e61368
+  metadata.gz: fe0c761a5d6c0bc856f35b558c9f70a74ac36815
+  data.tar.gz: 27c1295dc0082285072cfcd618afca9f5bf3b39f
 SHA512:
-  metadata.gz: 5beda3343160e6e04d7df902f702a6d99aa02ef49c6e7d9085d398c76ec07d518e096af779bdbf336a6e2b80fe20438f630676b4c97cd20706d990d0a263c5db
-  data.tar.gz: 1ee0950dd782a66de5bf11fe8e5cf4f7a42da6717883a7d25c58be37abb7c38d7ad5b1334bef1325b45e42eafd46d250ae0b928d4846757af0bfc7fe90019c1d
+  metadata.gz: c771af63c6cbc5b9ab95043aafedf83aa1e56c56e0179696a828a03b41dcf61cfb7f934db1e40a9e31632ae263e29ad62cdc87223d759603b1be6ac7b9e29154
+  data.tar.gz: ae1f3a83d67d4790a0805fd77261d2eee610eb62680b076ff754691ce6cbf64b3a86871b84ebcf1f6a0b2d4247eb174784a65c7b0f8c76e5acd83008a3353050

data/CHANGES.md

@@ -1,5 +1,11 @@
 # CHANGES
 
+## rest-core 3.5.3 -- 2015-01-11
+
+### Bugs fixed
+
+* Fixed a regression where timeout is not properly handled for thread pool.
+
 ## rest-core 3.5.2 -- 2015-01-09
 
 ### Bugs fixed

data/lib/rest-core/promise.rb

@@ -68,12 +68,16 @@ class RestCore::Promise
       self.thread = Thread.current # set working thread
       protected_yield{ yield } # avoid any exception and do the job
     else
-      backtrace = caller + self.class.backtrace
+      backtrace = caller + self.class.backtrace # retain the backtrace so far
       if pool_size > 0
-        self.task = client_class.thread_pool.defer(mutex) do
-          Thread.current[:backtrace] = backtrace
-          protected_yield{ yield }
-          Thread.current[:backtrace] = nil
+        mutex.synchronize do
+          # still timing it out if the task never processed
+          env[TIMER].on_timeout{ cancel_task } if env[TIMER]
+          self.task = client_class.thread_pool.defer(mutex) do
+            Thread.current[:backtrace] = backtrace
+            protected_yield{ yield }
+            Thread.current[:backtrace] = nil
+          end
         end
       else
         self.thread = Thread.new do
@@ -162,7 +166,7 @@ class RestCore::Promise
         callback_error(e)
       else # IOError, SystemCallError, etc
         begin
-          rejecting(e)
+          rejecting(e) # would call user callback
         rescue Exception => f # log user callback error
           callback_error(f){ self.class.set_backtrace(f) }
         end
@@ -171,7 +175,8 @@ class RestCore::Promise
   end
 
   def timeout_protected_yield
-    env[TIMER].on_timeout{ cancel_task } # set timeout
+    # timeout might already be set for thread_pool (pool_size > 0)
+    env[TIMER].on_timeout{ cancel_task } unless env[TIMER].timer
     yield
   ensure
     env[TIMER].cancel
@@ -210,7 +215,7 @@ class RestCore::Promise
       if t = thread || task.thread
         t.raise(env[TIMER].error) # raise Timeout::Error to working thread
       else    # task was queued and never started, just cancel it and
-        begin # fulfil the promise with Timeout::Error
+        begin # fulfill the promise with Timeout::Error
           task.cancel
           rejecting(env[TIMER].error)
         rescue Exception => e # log user callback error

data/lib/rest-core/thread_pool.rb

@@ -88,12 +88,10 @@ class RestCore::ThreadPool
   end
 
   def defer mutex=nil, &job
-    mutex.synchronize do
-      task = Task.new(job, mutex)
-      queue << task
-      spawn_worker if waiting == 0 && workers.size < max_size
-      task
-    end
+    task = Task.new(job, mutex)
+    queue << task
+    spawn_worker if waiting == 0 && workers.size < max_size
+    task
   end
 
   def trim force=false

data/lib/rest-core/timer.rb

@@ -29,7 +29,7 @@ class RestCore::Timer
     end
   end
 
-  attr_accessor :timeout, :error
+  attr_accessor :timeout, :error, :timer
   def initialize timeout, error, &block
     self.timeout = timeout
     self.error   = error
@@ -54,5 +54,5 @@ class RestCore::Timer
   end
 
   protected
-  attr_accessor :block, :timer
+  attr_accessor :block
 end

data/lib/rest-core/version.rb

@@ -1,4 +1,4 @@
 
 module RestCore
-  VERSION = '3.5.2'
+  VERSION = '3.5.3'
 end

data/rest-core.gemspec

@@ -1,14 +1,14 @@
 # -*- encoding: utf-8 -*-
-# stub: rest-core 3.5.2 ruby lib
+# stub: rest-core 3.5.3 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "rest-core"
-  s.version = "3.5.2"
+  s.version = "3.5.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Lin Jen-Shin (godfat)"]
-  s.date = "2015-01-09"
+  s.date = "2015-01-11"
   s.description = "Modular Ruby clients interface for REST APIs.\n\nThere has been an explosion in the number of REST APIs available today.\nTo address the need for a way to access these APIs easily and elegantly,\nwe have developed rest-core, which consists of composable middleware\nthat allows you to build a REST client for any REST API. Or in the case of\ncommon APIs such as Facebook, Github, and Twitter, you can simply use the\ndedicated clients provided by [rest-more][].\n\n[rest-more]: https://github.com/godfat/rest-more"
   s.email = ["godfat (XD) godfat.org"]
   s.files = [

data/test/test_timeout.rb

@@ -28,36 +28,61 @@ describe RC::Timeout do
     lambda{ sleep 0.01      }.should.not.raise(Timeout::Error)
   end
 
-  would 'cancel the task if timing out' do
-    timer = Object.new.instance_eval do
-      def on_timeout; yield ; end
+  def fake_timer
+    Object.new.instance_eval do
+      @block = nil
+      def on_timeout; @block = true; Thread.new{yield}; end
       def error     ; 'boom'; end
       def cancel    ;       ; end
+      def timer     ; @block; end
       self
     end
-    app = RC::Builder.client do
+  end
+
+  def sleeping_app
+    RC::Builder.client do
       run Class.new(RC::Engine){
         def request _, _
           sleep
         end
       }
     end
+  end
+
+  would 'cancel the task if timing out for thread pool' do
+    timer = fake_timer
+    app   = sleeping_app
     app.pool_size = 1
     app.new.request(RC::TIMER => timer, RC::ASYNC => true).
       message.should.eq 'boom'
+    timer.timer.should.not.nil?
+  end
+
+  would 'still timeout if the task never processed for thread pool' do
+    app = sleeping_app
+    app.pool_size = 1
+    app.new.request(RC::TIMER => fake_timer, RC::ASYNC => true) do |e|
+      e.message.should.eq 'boom'
+      app.new.request(RC::TIMER => fake_timer, RC::ASYNC => true).tap{}
+    end
+    app.wait
   end
 
   would 'interrupt the task if timing out' do
     rd, wr = IO.pipe
     timer = Object.new.instance_eval do
+      @block = nil
       define_singleton_method :on_timeout do |&block|
+        @block = block
         Thread.new do
           rd.gets
           block.call
+          @block = nil
         end
       end
       def error     ; 'boom'; end
       def cancel    ;       ; end
+      def timer     ; @block; end
       self
     end
     app = RC::Builder.client do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rest-core
 version: !ruby/object:Gem::Version
-  version: 3.5.2
+  version: 3.5.3
 platform: ruby
 authors:
 - Lin Jen-Shin (godfat)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-09 00:00:00.000000000 Z
+date: 2015-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient