rest-core 3.4.0 → 3.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ab6a9f5e489329946784228471a7647aac66bbdd
-  data.tar.gz: 4b8d30e22074977305146a9a0cc875334c473599
+  metadata.gz: 85f12b68843aae98a2ceaa7d85346e0c99627f21
+  data.tar.gz: d8ba6d00b676443be83d939f7b676ad75f96ec0a
 SHA512:
-  metadata.gz: 09378189003073e9e0fcde4b210c6ef3e5e7441388e006ba5f5e9bb916acd6b191ac7fd7e9649837dcd82e8e5d360a1efe41f3e6fa247fc9911e584b5dd074ce
-  data.tar.gz: cdf158fd0a2ca140d64792e7daa29575c9914ca5ede20b556ef04f64bc93792f053c3d2e49f59a6888823baa623fc467dbd41edac26544b9d97057e7b511b7e2
+  metadata.gz: 56f4c5e7e9b54d700947e99598fa889d1bea1d2a9e07a954fcf795109bf5935263b26db50e881ad71458671213d60961b367738b400d1abe5046ade10c05d6b5
+  data.tar.gz: bb5712b4ac86364fcbe05ca8ad938ef6635764e73695a02a982dfb3b6028f0752539063f80ecad5ff630f75c2b185e399e60780eeeeade4938e45066b7743aa1

data/CHANGES.md

@@ -1,5 +1,14 @@
 # CHANGES
 
+## rest-core 3.4.1 -- 2014-11-29
+
+### Bugs fixed
+
+* Handle errors for `RC::EventSource` more conservatively to avoid any
+  potential deadlock.
+
+* It would not deadlock even if logging failed.
+
 ## rest-core 3.4.0 -- 2014-11-26
 
 ### Incompatible changes

data/lib/rest-core/event_source.rb

@@ -12,12 +12,13 @@ class RestCore::EventSource < Struct.new(:client, :path, :query, :opts,
     @onmessage   ||= nil
     @onerror     ||= nil
     @onreconnect ||= nil
+    @closed      ||= false
     reconnect
     self
   end
 
   def closed?
-    !!(socket && socket.closed?)
+    !!(socket && socket.closed?) || @closed
   end
 
   def close
@@ -66,8 +67,11 @@ class RestCore::EventSource < Struct.new(:client, :path, :query, :opts,
       begin
         @onerror.call(error, sock) if @onerror
         onreconnect(error, sock)
-      rescue
-        condv.signal # so we can't be reconnecting, need to try to unblock
+      rescue Exception => e
+        mutex.synchronize do
+          @closed = true
+          condv.signal # so we can't be reconnecting, need to try to unblock
+        end
         raise
       end
     end
@@ -82,7 +86,10 @@ class RestCore::EventSource < Struct.new(:client, :path, :query, :opts,
     elsif closed? && @onreconnect && @onreconnect.call(error, sock)
       reconnect
     else
-      condv.signal # we could be closing, let's try to unblock it
+      mutex.synchronize do
+        @closed = true
+        condv.signal # we could be closing, let's try to unblock it
+      end
     end
     self
   end
@@ -110,6 +117,12 @@ class RestCore::EventSource < Struct.new(:client, :path, :query, :opts,
   def reconnect
     o = {REQUEST_HEADERS => {'Accept' => 'text/event-stream'},
          HIJACK          => true}.merge(opts)
-    client.get(path, query, o){ |sock| onopen(sock) }
+    client.get(path, query, o) do |sock|
+      if sock.nil? || sock.kind_of?(Exception)
+        onerror(sock)
+      else
+        onopen(sock)
+      end
+    end
   end
 end

data/lib/rest-core/middleware/error_handler.rb

@@ -32,7 +32,11 @@ class RestCore::ErrorHandler
   def process res, err
     RC::Promise.set_backtrace(err)
     if res[ASYNC]
-      res.merge(RESPONSE_BODY => err)
+      if res[HIJACK]
+        res.merge(RESPONSE_SOCKET => err)
+      else
+        res.merge(RESPONSE_BODY => err)
+      end
     else
       raise err
     end

data/lib/rest-core/promise.rb

@@ -25,6 +25,7 @@ class RestCore::Promise
     Thread.current[:backtrace] || []
   end
 
+  # should never raise!
   def self.set_backtrace e
     e.set_backtrace((e.backtrace || caller) + backtrace)
   end
@@ -154,18 +155,32 @@ class RestCore::Promise
   def protected_yield
     yield
   rescue Exception => e
-    # pray if timeout won't trigger here!
-    env[TIMER].cancel if env[TIMER]
     mutex.synchronize do
-      self.class.set_backtrace(e)
-      # nothing we can do here for an asynchronous exception,
-      # so we just log the error
-      # TODO: add error_log_method
-      warn "RestCore: ERROR: #{e}\n  from #{e.backtrace.inspect}"
-      rejecting(e) unless done?  # not done: i/o error; done: callback error
+      never_raise_yield do
+        env[TIMER].cancel if env[TIMER]
+        self.class.set_backtrace(e)
+        # TODO: add error_log_method
+        warn "RestCore: ERROR: #{e}\n  from #{e.backtrace.inspect}"
+      end
+
+      begin
+        rejecting(e) unless done? # not done: i/o error; done: callback error
+      rescue Exception => e
+        never_raise_yield do
+          warn "RestCore: ERROR: #{e}\n  from #{e.backtrace.inspect}"
+        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
+
   # called in client thread, when yield is called
   def callback
     return response if called

data/lib/rest-core/timer.rb

@@ -41,6 +41,7 @@ class RestCore::Timer
     self.block = block
   end
 
+  # should never raise!
   def cancel
     timer.cancel
     self.block = nil

data/lib/rest-core/version.rb

@@ -1,4 +1,4 @@
 
 module RestCore
-  VERSION = '3.4.0'
+  VERSION = '3.4.1'
 end

data/rest-core.gemspec

@@ -1,14 +1,14 @@
 # -*- encoding: utf-8 -*-
-# stub: rest-core 3.4.0 ruby lib
+# stub: rest-core 3.4.1 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "rest-core"
-  s.version = "3.4.0"
+  s.version = "3.4.1"
 
   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-11-26"
+  s.date = "2014-11-29"
   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_event_source.rb

@@ -4,6 +4,7 @@ require 'rest-core/test'
 
 describe RC::EventSource do
   after do
+    Muack.verify
     WebMock.reset!
   end
 
@@ -131,4 +132,34 @@ SSE
     end.start.wait
     m.should.empty?
   end
+
+  def mock_warning
+    mock(any_instance_of(RC::Promise)).warn(is_a(String)) do |msg|
+      msg.should.include?(Errno::ECONNREFUSED.new.message)
+    end
+  end
+
+  would 'not deadlock without ErrorHandler' do
+    mock_warning
+    c = RC::Simple.new.event_source('http://localhost:1')
+    c.onerror{ |e| e.should.eq nil }
+    c.start.wait
+  end
+
+  would 'not deadlock with ErrorHandler' do
+    mock_warning
+    c = RC::Universal.new(:log_method => false).
+               event_source('http://localhost:1')
+    c.onerror{ |e| e.should.kind_of?(Errno::ECONNREFUSED) }
+    c.start.wait
+  end
+
+  would 'not deadlock if errors in onmessage' do
+    err = nil
+    es, m, t = server.call
+    es.onmessage do |event, data|
+      raise err = "error"
+    end.start.wait
+    err.should.eq "error"
+  end
 end

metadata

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