backoff 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e93372cda8a2116f0dace4167a3131fbad40d698
-  data.tar.gz: f50dce4eaf961a130c13b8f2722d767130c3bf3c
+SHA256:
+  metadata.gz: 45f9a9163265dfffac8ccf2c29570c753ac8957dcb1b936f14ea371ab4ef40e8
+  data.tar.gz: 0f21d4ef04ccd63b38d69bc873a7f0aba8c3786351bb7fd895477ff2534a11fe
 SHA512:
-  metadata.gz: 45c4bbdc4e4119712a3c1ce297a9c0bfc94127976f5c34664464dbb8c5d0a085fd549bdc65ccf0a090180a5c6af27d65aecd5a50d805ddde2c2e48ac2501dc5d
-  data.tar.gz: 1a4476bc07c93795841ee23a717be2e30ec1735ec1003fadade3a768fef9a0274d367366c856702000fe31a40f0c00982e05b98e3e11d573ee16eda30204014a
+  metadata.gz: 35722d025e81e3c098d2e45c82e6089dce30aaab4395c6f5b884c38b186a5131faa6a89ce86d0c49de479dba0bc03309dd3cf6824343839cff728f867eec766a
+  data.tar.gz: c51554f49e3e90821a8992ccf74eb8e53cc8f3f92fffedc859d0a24bde72d9ff1ea29e576549d5df3c0bfb5d2ab090d6847e4d93ac792e002665302f61fe81cb

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    backoff (0.1.1)
+    backoff (0.2.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,8 +1,6 @@
 # Backoff
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/backoff`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Add exponential full jitter backoff to any object by proxy
 
 ## Installation
 
@@ -29,21 +27,27 @@ logger = Logger.new($stderr)
 class Foo
   class MyError < StandardError; end
   class MyErrorTwo < StandardError; end
+
+  def initialize
+    @i = 0
+  end
+
   def bar
-    raise MyError if rand < 0.3
-    raise MyErrorTwo if rand < 0.1
+    @i += 1
+    raise MyError if @i < 2
+    raise MyErrorTwo if @i < 4
     true
   end
 end
 # The second argument may be a exception class or a list of exception classes
 foo_with_backoff = Backoff.wrap(Foo.new, [Foo::MyError, Foo::MyErrorTwo], logger, initial_backoff: 1, multiplier: 2)
 p foo_with_backoff.bar
-# E, [2018-06-09T14:37:53.943201 #23986] ERROR -- : Got Foo::MyErrorTwo, sleeping 1
-# I, [2018-06-09T14:37:54.943928 #23986]  INFO -- : Woke up after Foo::MyErrorTwo retrying again
-# E, [2018-06-09T14:37:54.944066 #23986] ERROR -- : Got Foo::MyError, sleeping 2
-# I, [2018-06-09T14:37:56.944181 #23986]  INFO -- : Woke up after Foo::MyError retrying again
-# E, [2018-06-09T14:37:56.944346 #23986] ERROR -- : Got Foo::MyError, sleeping 4
-# I, [2018-06-09T14:38:00.947363 #23986]  INFO -- : Woke up after Foo::MyError retrying again
+# E, [2018-11-08T10:17:16.199572 #33699] ERROR -- : Got Foo::MyError, sleeping 0.5672605987514756
+# I, [2018-11-08T10:17:17.204727 #33699]  INFO -- : Woke up after Foo::MyError retrying again
+# E, [2018-11-08T10:17:17.204903 #33699] ERROR -- : Got Foo::MyErrorTwo, sleeping 1.6799593245880358
+# I, [2018-11-08T10:17:19.205967 #33699]  INFO -- : Woke up after Foo::MyErrorTwo retrying again
+# E, [2018-11-08T10:17:19.206074 #33699] ERROR -- : Got Foo::MyErrorTwo, sleeping 3.732148747396218
+# I, [2018-11-08T10:17:23.206237 #33699]  INFO -- : Woke up after Foo::MyErrorTwo retrying again
 # => true
 ```
 

data/backoff.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "backoff"
-  spec.version       = "0.1.1"
+  spec.version       = "0.2.0"
   spec.authors       = ["Fonsan"]
   spec.email         = ["fonsan@gmail.com"]
 

data/lib/backoff.rb

@@ -12,6 +12,8 @@ class Backoff < Delegator
     @sleeper = options[:sleeper] || Kernel.method(:sleep)
     @initial_backoff = options[:initial_backoff] || 1
     @multiplier = options[:multiplier] || 2
+    @random = options[:random] || Random.new
+    @jitter = options[:jitter] || lambda {|delay| @random.rand(0..delay.to_f) }
   end
 
   def __getobj__
@@ -25,7 +27,8 @@ class Backoff < Delegator
   def _with_backoff(backoff = @initial_backoff)
     yield
   rescue *@exception_classes => e
-    @logger.error "Got #{e.class}, sleeping #{backoff}"
+    jittered_backoff = @jitter.call(backoff)
+    @logger.error "Got #{e.class}, sleeping #{jittered_backoff}"
     @sleeper.call(backoff)
     @logger.info "Woke up after #{e.class} retrying again"
     backoff *= @multiplier

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: backoff
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Fonsan
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-06-09 00:00:00.000000000 Z
+date: 2018-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -92,7 +92,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Implements exponential backoff when matching exception is caught