rest-core 3.5.1 → 3.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0deea3c56ae01f19f5d7f7d6b32a6ea35259846b
-  data.tar.gz: ce45a4ddcadda96dfecec4ad2ad24079f5fedcb9
+  metadata.gz: 0399835474967a9425ce60b8073d0b4a49e7c572
+  data.tar.gz: 6cac1d0a2fce2e8f5ea64e64b2b56343d8e61368
 SHA512:
-  metadata.gz: 6b1f3bd1b3b254cd7c922dddebe618f134c4cf2d328b018584b0390410adc1218b8bf6333f163ddd9698a54d88347ef5d3fdb850e7b50c3cc7ba63b7a0797457
-  data.tar.gz: 0314d2a3658e30486a13d7e9ffbb9fd8d63d8fd1f5711fb38cd5c99b26576bb9af4698b337e1f97320b9ab35c51c0bffe556da73f6837483518971cfc414a9b8
+  metadata.gz: 5beda3343160e6e04d7df902f702a6d99aa02ef49c6e7d9085d398c76ec07d518e096af779bdbf336a6e2b80fe20438f630676b4c97cd20706d990d0a263c5db
+  data.tar.gz: 1ee0950dd782a66de5bf11fe8e5cf4f7a42da6717883a7d25c58be37abb7c38d7ad5b1334bef1325b45e42eafd46d250ae0b928d4846757af0bfc7fe90019c1d

data/.travis.yml

@@ -1,13 +1,12 @@
-language: ruby
 
+language: ruby
 rvm:
   - 2.0
   - 2.1
   - 2.2
   - rbx-2
   - jruby
+  - jruby-head
 
 install: 'bundle install --retry=3'
 script: 'ruby -r bundler/setup -S rake test'
-
-sudo: false

data/CHANGES.md

@@ -1,5 +1,16 @@
 # CHANGES
 
+## rest-core 3.5.2 -- 2015-01-09
+
+### Bugs fixed
+
+* Now callbacks would respect `RC::RESPONSE_KEY`.
+* Clear `Thread.current[:backtrace]` after done in thread pool to reduce
+  memory footprint.
+* Fixed backtrace for exception raised in callbacks.
+* Fixed some potential corner cases where errors are not properly handled
+  when timeout happened.
+
 ## rest-core 3.5.1 -- 2014-12-27
 
 * Ruby 2.2 compatibility.

data/lib/rest-core/client.rb

@@ -214,11 +214,7 @@ module RestCore::Client
       RC::Promise.set_backtrace(err) unless err.backtrace
       error_callback.call(err) if error_callback
       if res[ASYNC]
-        if res[HIJACK]
-          res.merge(RESPONSE_SOCKET => err)
-        else
-          res.merge(RESPONSE_BODY => err)
-        end
+        res.merge(response_key(res) => err)
       else
         raise err
       end

data/lib/rest-core/promise.rb

@@ -65,16 +65,15 @@ class RestCore::Promise
   # called in client thread
   def defer
     if pool_size < 0 # negative number for blocking call
-      self.thread = Thread.current
-      # set timeout after thread set, before yield (because yield is blocking)
-      env[TIMER].on_timeout{ cancel_task } if env[TIMER]
-      protected_yield{ yield }
+      self.thread = Thread.current # set working thread
+      protected_yield{ yield } # avoid any exception and do the job
     else
       backtrace = caller + self.class.backtrace
       if pool_size > 0
         self.task = client_class.thread_pool.defer(mutex) do
           Thread.current[:backtrace] = backtrace
           protected_yield{ yield }
+          Thread.current[:backtrace] = nil
         end
       else
         self.thread = Thread.new do
@@ -82,8 +81,6 @@ class RestCore::Promise
           protected_yield{ yield }
         end
       end
-      # set timeout after thread/task set
-      env[TIMER].on_timeout{ cancel_task } if env[TIMER]
     end
   end
 
@@ -153,32 +150,31 @@ class RestCore::Promise
   # called in a new thread if pool_size == 0, otherwise from the pool
   # i.e. requesting thread
   def protected_yield
-    yield
+    if env[TIMER]
+      timeout_protected_yield{ yield }
+    else
+      yield
+    end
   rescue Exception => e
     mutex.synchronize do
-      never_raise_yield do
-        env[TIMER].cancel if env[TIMER]
-        self.class.set_backtrace(e)
-      end
-
-      if done?
+      self.class.set_backtrace(e)
+      if done? # log user callback error
         callback_error(e)
-      else
+      else # IOError, SystemCallError, etc
         begin
-          rejecting(e) # i/o error
-        rescue Exception => e
-          callback_error(e)
+          rejecting(e)
+        rescue Exception => f # log user callback error
+          callback_error(f){ self.class.set_backtrace(f) }
         end
       end
     end
   end
 
-  # only use this for unimportant stuffs and in most critical section
-  # e.g. error logging in critical section
-  def never_raise_yield
+  def timeout_protected_yield
+    env[TIMER].on_timeout{ cancel_task } # set timeout
     yield
-  rescue Exception => e
-    Thread.main.raise(e) if !!$DEBUG
+  ensure
+    env[TIMER].cancel
   end
 
   # called in client thread, when yield is called
@@ -195,8 +191,10 @@ class RestCore::Promise
     self.called = true
   end
 
+  # log user callback error
   def callback_error e
     never_raise_yield do
+      yield if block_given?
       if env[CLIENT].error_callback
         env[CLIENT].error_callback.call(e)
       else
@@ -205,18 +203,31 @@ class RestCore::Promise
     end
   end
 
-  def cancel_task
+  # timeout!
+  def cancel_task backtrace=nil
     mutex.synchronize do
-      next if done?
+      next if done? # don't cancel if it's done
       if t = thread || task.thread
-        t.raise(env[TIMER].error)
-      else
-        task.cancel
-        rejecting(env[TIMER].error)
+        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
+          task.cancel
+          rejecting(env[TIMER].error)
+        rescue Exception => e # log user callback error
+          callback_error(e){e.set_backtrace(e.backtrace + (backtrace || []))}
+        end
       end
     end
   end
 
+  # only use this for unimportant stuffs and in most critical section
+  # e.g. error logging in critical section
+  def never_raise_yield
+    yield
+  rescue Exception => e
+    Thread.main.raise(e) if !!$DEBUG
+  end
+
   def client_class; env[CLIENT].class; end
   def pool_size
     @pool_size ||= if client_class.respond_to?(:pool_size)

data/lib/rest-core/timer.rb

@@ -34,16 +34,17 @@ class RestCore::Timer
     self.timeout = timeout
     self.error   = error
     self.block   = block
-    start
+    start if block_given?
   end
 
   def on_timeout &block
     self.block = block
+    start if block_given?
   end
 
   # should never raise!
   def cancel
-    timer.cancel
+    timer.cancel if timer
     self.block = nil
   end
 

data/lib/rest-core/version.rb

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

data/rest-core.gemspec

@@ -1,14 +1,14 @@
 # -*- encoding: utf-8 -*-
-# stub: rest-core 3.5.1 ruby lib
+# stub: rest-core 3.5.2 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "rest-core"
-  s.version = "3.5.1"
+  s.version = "3.5.2"
 
   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 = "2014-12-27"
+  s.date = "2015-01-09"
   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_httpclient.rb

@@ -40,8 +40,7 @@ describe RC::HttpClient do
 
     would 'not kill the thread if error was coming from the task' do
       mock(HTTPClient).new{ raise 'boom' }.with_any_args
-      c.request(RC::RESPONSE_KEY => RC::FAIL,
-                RC::ASYNC => true).first.message.should.eq 'boom'
+      c.request(RC::ASYNC => true).message.should.eq 'boom'
       Muack.verify
     end
   end

data/test/test_timeout.rb

@@ -43,9 +43,8 @@ describe RC::Timeout do
       }
     end
     app.pool_size = 1
-    app.new.request(RC::RESPONSE_KEY => RC::FAIL, RC::TIMER => timer,
-                    RC::ASYNC => true).
-      first.message.should.eq 'boom'
+    app.new.request(RC::TIMER => timer, RC::ASYNC => true).
+      message.should.eq 'boom'
   end
 
   would 'interrupt the task if timing out' do
@@ -71,9 +70,8 @@ describe RC::Timeout do
     end
     (-1..1).each do |size|
       app.pool_size = size
-      app.new.request(RC::RESPONSE_KEY => RC::FAIL, RC::TIMER => timer,
-                      RC::ASYNC => true, 'pipe' => wr).
-        first.message.should.eq 'boom'
+      app.new.request(RC::TIMER => timer, RC::ASYNC => true, 'pipe' => wr).
+        message.should.eq 'boom'
     end
   end
 end

metadata

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