retriable 2.0.0.beta1 → 2.0.0.beta2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 75d7bf8633f7cf7fe492aa7d1b001d68a2389b34
-  data.tar.gz: 92a103a316a6c12a01e5374f4656e7be57cc3c76
+  metadata.gz: b252298dcbaede9a87149f78cec0c067742b1167
+  data.tar.gz: b58875b898c832a5bd8ae3fd20d2eb62f80c7f84
 SHA512:
-  metadata.gz: 6bb179a0ae1696e706d42b3a1769e67396238011363a5c152cd48a376fca099bf03db84413ca3e982cbadb13a14693a271d5eb2aa91dc4587301e2570490ada4
-  data.tar.gz: 9f4de38db13683ead4e8b78abf5be5ce200b942e453cbc94c6a934bacd3b5e31e4060be9803b03590c856ab41062c82cfe4a94924489eb7582027236e6df3d28
+  metadata.gz: e216f86b87a3526982647c8a2c6d8733eb7c9e3f4e7a262f3f38ead6d36bd4bd3c494ef22409cdf06e195de23360eb6d5f12cfa1c4c0de2492c03c49f17fe005
+  data.tar.gz: 43505f1550318db78adcb85dd1c023280ca9b7be802ec3a331e56ae094648a9fcfd2b5879bfc90ddf840e13a3ce29e96c28e7a33cb5e12abaddf89f9a32f82c7

data/.travis.yml

@@ -7,4 +7,4 @@ rvm:
 
 matrix:
   allow_failures:
-    - rvm: rbx
+    - rvm: jruby

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 2.0.0.beta2
+* Raise not return on max elapsed time, also check for elapsed time after next interval is calculated and it goes over the max elapsed time
+* Add specs for max_elapsed_time and max_interval
+
 ## 2.0.0.beta1
 * Require ruby 2.0+.
 * Default to random exponential backoff, removes the `interval` option. Exponential backoff is configurable via arguments.

data/README.md

@@ -70,8 +70,11 @@ Here are the available options:
 
 `max_interval` (default: 60) - The maximum interval in seconds that any attempt can climb to.
 
-`rand_factor` (default: 0.25) - The percent range above and below the next interval is randomized between. The calculation is calculated like this: `randomized_interval =
-      retry_interval * (random value in range [1 - randomization_factor, 1 + randomization_factor])`
+`rand_factor` (default: 0.25) - The percent range above and below the next interval is randomized between. The calculation is calculated like this:
+
+```
+randomized_interval = retry_interval * (random value in range [1 - randomization_factor, 1 + randomization_factor])
+```
 
 `multiplier` (default: 1.5) - Each successive interval grows by this factor. A multipler of 1.5 means the next interval will be 1.5x the current interval.
 
@@ -133,7 +136,7 @@ end
 Exponential backoff is enabled by default, if you want to simply execute code every second, you can do this:
 
 ```ruby
-Retriable.retryable base_interval: 1.0, multiplier: 1.0, rand_factor: 0.0 do
+Retriable.retry base_interval: 1.0, multiplier: 1.0, rand_factor: 0.0 do
   # code here...
 end
 ```
@@ -141,7 +144,7 @@ end
 If you don't want exponential backoff, but you still want some randomization between intervals, this code will run every 1 seconds with a randomization factor of 0.2, which means each interval will be a random value between 0.8 and 1.2 (1 second +/- 0.2):
 
 ```ruby
-Retriable.retryable base_interval: 1.0, multiplier: 1.0, rand_factor: 0.2 do
+Retriable.retry base_interval: 1.0, multiplier: 1.0, rand_factor: 0.2 do
   # code here...
 end
 ```

data/lib/retriable.rb

@@ -27,8 +27,9 @@ module Retriable
     raise LocalJumpError unless block_given?
 
     attempt = 0
-    start_time = Time.now
     interval = base_interval
+    start_time = Time.now
+    elapsed_time = lambda { Time.now - start_time }
 
     begin
       attempt += 1
@@ -40,12 +41,12 @@ module Retriable
     rescue *[*on] => exception
       raise if attempt >= max_tries
 
-      return if (Time.now - start_time) > max_elapsed_time
-
       interval = randomized_interval(rand_factor, interval)
 
       on_retry.call(exception, attempt, Time.now - start_time, interval) if on_retry
 
+      raise if elapsed_time.call > max_elapsed_time || (elapsed_time.call + interval) > max_elapsed_time
+
       sleep interval if interval > 0 && config.sleep_disabled != true
 
       interval = if interval >= (max_interval / multiplier)

data/lib/retriable/version.rb

@@ -1,3 +1,3 @@
 module Retriable
-  VERSION = '2.0.0.beta1'
+  VERSION = '2.0.0.beta2'
 end

data/spec/retriable_spec.rb

@@ -7,105 +7,174 @@ describe Retriable do
     Retriable
   end
 
-  before do
-    Retriable.configure do |c|
-      c.sleep_disabled = true
+  describe 'with sleep disabled' do
+    before do
+      Retriable.configure do |c|
+        c.sleep_disabled = true
+      end
     end
-  end
 
-  it 'raises a LocalJumpError if retry is not given a block' do
-    lambda do
-      subject.retry on: EOFError
-    end.must_raise LocalJumpError
-  end
+    it 'raises a LocalJumpError if retry is not given a block' do
+      lambda do
+        subject.retry on: EOFError
+      end.must_raise LocalJumpError
+    end
 
-  describe 'retry block of code raising EOFError with no arguments' do
-    before do
-      @attempts = 0
+    describe 'retry block of code raising EOFError with no arguments' do
+      before do
+        @attempts = 0
+
+        subject.retry do
+          @attempts += 1
+          raise EOFError.new if @attempts < 3
+        end
+      end
 
-      subject.retry do
-        @attempts += 1
-        raise EOFError.new if @attempts < 3
+      it 'uses exponential backoff' do
+        @attempts.must_equal 3
       end
     end
 
-    it 'uses exponential backoff' do
-      @attempts.must_equal 3
+    it 'retry on custom exception and re-raises the exception' do
+      lambda do
+        subject.retry on: TestError do
+          raise TestError.new
+        end
+      end.must_raise TestError
     end
-  end
 
-  it 'retry on custom exception and re-raises the exception' do
-    lambda do
-      subject.retry on: TestError do
-        raise TestError.new
+    it 'retry with 10 max tries' do
+      attempts = 0
+
+      subject.retry(
+        max_tries: 10
+      ) do
+          attempts += 1
+          raise EOFError.new if attempts < 10
       end
-    end.must_raise TestError
-  end
 
-  it 'retry with 10 max tries' do
-    attempts = 0
+      attempts.must_equal 10
+    end
 
-    subject.retry(
-      max_tries: 10
-    ) do
-        attempts += 1
-        raise EOFError.new if attempts < 10
+    it 'retry will timeout after 1 second' do
+      lambda do
+        subject.retry timeout: 1 do
+          sleep 2
+        end
+      end.must_raise Timeout::Error
     end
 
-    attempts.must_equal 10
-  end
+    describe 'retries with an on_retry handler, 6 max retries, and a 0.0 rand_factor' do
+      before do
+        max_tries = 6
+        @attempts = 0
+        @time_table = {}
+
+        handler = Proc.new do |exception, attempt, elapsed_time, next_interval|
+          exception.class.must_equal ArgumentError
+          @time_table[attempt] = next_interval
+        end
+
+        Retriable.retry(
+          on: [EOFError, ArgumentError],
+          on_retry: handler,
+          rand_factor: 0.0,
+          max_tries: max_tries
+        ) do
+          @attempts += 1
+          raise ArgumentError.new if @attempts < max_tries
+        end
+      end
 
-  describe 'retries with an on_retry handler, 6 max retries, and a 0.0 rand_factor' do
-    before do
+      it 'makes 6 attempts' do
+        @attempts.must_equal 6
+      end
+
+      it 'applies a non-randomized exponential backoff to each attempt' do
+        @time_table.must_equal({
+          1 => 0.5,
+          2 => 0.75,
+          3 => 1.125,
+          4 => 1.6875,
+          5 => 2.53125
+        })
+      end
+    end
+
+    it 'retry has a max interval of 1.5 seconds' do
       max_tries = 6
-      @attempts = 0
-      @time_table = {}
+      attempts = 0
+      time_table = {}
 
       handler = Proc.new do |exception, attempt, elapsed_time, next_interval|
-        exception.class.must_equal ArgumentError
-        @time_table[attempt] = next_interval
+        time_table[attempt] = next_interval
       end
 
-      Retriable.retry(
-        on: [EOFError, ArgumentError],
+      subject.retry(
+        on: EOFError,
         on_retry: handler,
         rand_factor: 0.0,
-        max_tries: max_tries
+        max_tries: max_tries,
+        max_interval: 1.5
       ) do
-        @attempts += 1
-        raise ArgumentError.new if @attempts < max_tries
+        attempts += 1
+        raise EOFError.new if attempts < max_tries
       end
-    end
-
-    it 'makes 6 attempts' do
-      @attempts.must_equal 6
-    end
 
-    it 'applies a non-randomized exponential backoff to each attempt' do
-      @time_table.must_equal({
+      time_table.must_equal({
         1 => 0.5,
         2 => 0.75,
         3 => 1.125,
-        4 => 1.6875,
-        5 => 2.53125
+        4 => 1.5,
+        5 => 1.5
       })
     end
-  end
 
-  it 'can call #retriable in the global' do
-    lambda do
+    it 'can call #retriable in the global' do
+      lambda do
+        retriable do
+          puts 'should raise NoMethodError'
+        end
+      end.must_raise NoMethodError
+
+      require_relative '../lib/retriable/core_ext/kernel'
+
+      i = 0
       retriable do
-        puts 'should raise NoMethodError'
+        i += 1
+        raise EOFError.new if i < 3
       end
-    end.must_raise NoMethodError
+      i.must_equal 3
+    end
+  end
 
-    require_relative '../lib/retriable/core_ext/kernel'
+  it 'retry runs for a max elapsed time of 2 seconds' do
+    subject.configure do |c|
+      c.sleep_disabled = false
+    end
+
+    subject.config.sleep_disabled.must_equal false
+
+    attempts = 0
+    time_table = {}
 
-    i = 0
-    retriable do
-      i += 1
-      raise EOFError.new if i < 3
+    handler = Proc.new do |exception, attempt, elapsed_time, next_interval|
+      time_table[attempt] = elapsed_time
     end
-    i.must_equal 3
+
+    lambda do
+      subject.retry(
+        base_interval: 1.0,
+        multiplier: 1.0,
+        rand_factor: 0.0,
+        max_elapsed_time: 2.0,
+        on_retry: handler
+      ) do
+        attempts += 1
+        raise EOFError.new
+      end
+    end.must_raise EOFError
+
+    attempts.must_equal 2
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: retriable
 version: !ruby/object:Gem::Version
-  version: 2.0.0.beta1
+  version: 2.0.0.beta2
 platform: ruby
 authors:
 - Jack Chu