restify 1.6.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4c8ac98ab3e0dab023e3ab8d312e9c1e88a58dd13b05652097bc514a3c1e6d23
-  data.tar.gz: eaad6494cb221afc8a3ee4175da1c754fa4cc0ca69c5fa4e12af54162672ae7b
+  metadata.gz: f2f418e5e5915c208da950884e753c70e0c6da648978dde9eb75f067ba6feedc
+  data.tar.gz: 98d1d14d29a06ac14ecaf564b0788d7054a7685ddc3126b4c24e80771ab95e86
 SHA512:
-  metadata.gz: 6a323d105962242cc5254373f7c6481956d04dbd3cc1baada59154bcc0256e44ddae3714f184c50d99632bd4f2ceff5e16c1d27fb826c5c07f0edbfaf7e19fc7
-  data.tar.gz: d215812e63850c400efe4339ec7ef6d770f844bf1990344a074c8811fe5c0868d92b432ad573f6ae0e2d716f48e191101c3321b889e6cf4d934bcd593fa245b0
+  metadata.gz: eb15fbef6af84a77badcfea901c83676952359a509e3d7a91a8b46db4d2808fd7f4c552e151d9a2b7ede68b0f46aaca5c33c77f78bd4aaa614d10a04c31862f6
+  data.tar.gz: 858169275d7a141d641cf1ef492692c6546057aaa6c865b1c5277038d417448b12288ac57cdc7a3e26a260b90275c6fe448deb135154ebe48dca95787ebdbf84

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 1.7.0
+
+* Introduce promise dependency timeouts (#15)
+
 ## 1.6.0
 
 * Specify headers on restify clients and individual requests (#14)

data/lib/restify.rb

@@ -12,6 +12,7 @@ require 'addressable/template'
 module Restify
   require 'restify/error'
   require 'restify/logging'
+  require 'restify/timeout'
 
   require 'restify/promise'
   require 'restify/registry'

data/lib/restify/error.rb

@@ -3,24 +3,12 @@
 module Restify
   #
 
-  # A {Timeout} is raised when a request or promise times out.
-  #
-  class Timeout < StandardError
-    attr_reader :source
-
-    def initialize(source)
-      super "Operation with #{source.class} has timed out"
-
-      @source = source
-    end
-  end
-
   # A {NetworkError} is raised on unusual network exceptions such as
   # unresolvable hosts or disconnects.
   #
   class NetworkError < StandardError
     attr_reader :request
-    
+
     def initialize(request, message)
       @request = request
       super("[#{request.uri}] #{message}")

data/lib/restify/promise.rb

@@ -11,8 +11,13 @@ module Restify
     end
 
     def wait(timeout = nil)
-      execute if pending?
+      t = Timeout.new(timeout, self)
+
+      execute(t) if pending?
+
       super
+      raise t if incomplete?
+      self
     end
 
     def then(&block)
@@ -26,25 +31,28 @@ module Restify
     protected
 
     # @!visibility private
-    def ns_execute(_timeout)
+    def ns_execute(timeout = nil)
       return unless compare_and_set_state(:processing, :pending)
       return unless @task || @dependencies.any?
 
       executor = Concurrent::SafeTaskExecutor.new \
         method(:ns_exec), rescue_exception: true
 
-      success, value, reason = executor.execute
+      success, value, reason = executor.execute(timeout)
 
       complete success, value, reason
     end
 
     # @!visibility private
-    def ns_exec
-      args  = @dependencies.any? ? @dependencies.map(&:value!) : []
-      value = @task ? @task.call(*args) : args
+    def ns_exec(timeout = nil)
+      t = Timeout.new(timeout, self)
 
-      value = value.value! while value.is_a? Restify::Promise
+      args = @dependencies.map do |d|
+        t.wait_on!(d)
+      end
 
+      value = @task ? @task.call(*args) : args
+      value = t.wait_on!(value) while value.is_a?(Promise)
       value
     end
 

data/lib/restify/timeout.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require 'hitimes'
+
+module Restify
+  class Timeout
+    class << self
+      attr_accessor :default_timeout
+    end
+
+    # Default wait timeout of 300 seconds.
+    self.default_timeout = 300
+
+    def initialize(timeout, target = nil)
+      @timeout = parse_timeout(timeout)
+      @target = target
+
+      @interval = ::Hitimes::Interval.new
+      @interval.start
+    end
+
+    def wait_on!(ivar)
+      ivar.value!(wait_interval).tap do
+        raise self unless ivar.complete?
+      end
+    rescue ::Timeout::Error
+      raise self
+    end
+
+    def timeout!
+      raise self if wait_interval <= 0
+    end
+
+    def exception
+      Error.new(@target)
+    end
+
+    private
+
+    def wait_interval
+      @timeout - @interval.to_f
+    end
+
+    def parse_timeout(value)
+      return self.class.default_timeout if value.nil?
+
+      begin
+        value = Float(value)
+      rescue ArgumentError
+        raise ArgumentError.new \
+          "Timeout must be an number but is #{value}"
+      end
+
+      unless value > 0
+        raise ArgumentError.new "Timeout must be > 0 but is #{value.inspect}."
+      end
+
+      value
+    end
+
+    class << self
+      def new(timeout, *args)
+        return timeout if timeout.is_a?(self)
+        super
+      end
+    end
+
+    class Error < ::Timeout::Error
+      attr_reader :target
+
+      def initialize(target)
+        @target = target
+
+        if @target
+          super "Operation on #{@target} timed out"
+        else
+          super 'Operation timed out'
+        end
+      end
+    end
+  end
+end

data/lib/restify/version.rb

@@ -3,7 +3,7 @@
 module Restify
   module VERSION
     MAJOR = 1
-    MINOR = 6
+    MINOR = 7
     PATCH = 0
     STAGE = nil
     STRING = [MAJOR, MINOR, PATCH, STAGE].reject(&:nil?).join('.').freeze

data/spec/restify/promise_spec.rb

@@ -3,6 +3,8 @@
 require 'spec_helper'
 
 describe Restify::Promise do
+  let(:promise) { described_class.new }
+
   describe 'factory methods' do
     describe '#fulfilled' do
       subject { described_class.fulfilled(fulfill_value) }
@@ -162,4 +164,22 @@ describe Restify::Promise do
       end
     end
   end
+
+  describe '#wait' do
+    it 'can time out' do
+      expect { promise.wait(0.1) }.to raise_error ::Timeout::Error
+    end
+  end
+
+  describe '#value' do
+    it 'can time out' do
+      expect { promise.value!(0.1) }.to raise_error ::Timeout::Error
+    end
+  end
+
+  describe '#value!' do
+    it 'can time out' do
+      expect { promise.value!(0.1) }.to raise_error ::Timeout::Error
+    end
+  end
 end

data/spec/restify/timeout_spec.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Restify::Timeout do
+  let(:timer) { described_class.new(0.2) }
+
+  describe '#timeout!' do
+    context 'before having timed out' do
+      it 'do nothing' do
+        expect { timer.timeout! }.to_not raise_error
+      end
+    end
+
+    context 'after having timed out' do
+      it 'calls given block' do
+        expect { timer.timeout! }.to_not raise_error
+        sleep timer.send(:wait_interval)
+        expect { timer.timeout! }.to raise_error ::Restify::Timeout::Error
+      end
+    end
+  end
+
+  describe '#wait_on!' do
+    it 'calls block on IVar timeout' do
+      expect {
+        timer.wait_on!(Concurrent::IVar.new)
+      }.to raise_error ::Restify::Timeout::Error
+    end
+
+    it 'calls block on Promise timeout' do
+      expect {
+        timer.wait_on!(Restify::Promise.new)
+      }.to raise_error ::Restify::Timeout::Error
+    end
+
+    it 'does nothing on successful IVar' do
+      expect {
+        Concurrent::IVar.new.tap do |ivar|
+          Thread.new { ivar.set :success }
+          expect(timer.wait_on!(ivar)).to eq :success
+        end
+      }.to_not raise_error
+    end
+
+    it 'does nothing on successful Promise' do
+      expect {
+        Restify::Promise.fulfilled(:success).tap do |p|
+          expect(timer.wait_on!(p)).to eq :success
+        end
+      }.to_not raise_error
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: restify
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.7.0
 platform: ruby
 authors:
 - Jan Graichen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-09 00:00:00.000000000 Z
+date: 2018-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -122,6 +122,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: hitimes
+  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
@@ -168,6 +182,7 @@ files:
 - lib/restify/request.rb
 - lib/restify/resource.rb
 - lib/restify/response.rb
+- lib/restify/timeout.rb
 - lib/restify/version.rb
 - spec/restify/cache_spec.rb
 - spec/restify/context_spec.rb
@@ -181,6 +196,7 @@ files:
 - spec/restify/registry_spec.rb
 - spec/restify/relation_spec.rb
 - spec/restify/resource_spec.rb
+- spec/restify/timeout_spec.rb
 - spec/restify_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/jgraichen/restify
@@ -220,5 +236,6 @@ test_files:
 - spec/restify/registry_spec.rb
 - spec/restify/relation_spec.rb
 - spec/restify/resource_spec.rb
+- spec/restify/timeout_spec.rb
 - spec/restify_spec.rb
 - spec/spec_helper.rb