wayfarer 0.4.5 → 0.4.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e7d0560732b7b89dd2bb7d86ed4d5c6a07f240c246c864bb067060cbd5fe7156
-  data.tar.gz: cc58bdc83b09293caa5eea587f437d14333a20c399be586fc4d2216cc9c0ae39
+  metadata.gz: 6b5aceb6e67a298f9ddc3bffecf24446b2e95850e2bfe31f0d245fbb8a4e17f0
+  data.tar.gz: db7323a6cb7942319478753d3060b54cdc7551c3ac6fb0c32bf49015d6f29c68
 SHA512:
-  metadata.gz: 5427038da9468be757d11709c5a08879063af448be881d881a288aedf8b6930a49755d4e89e1701dc68cfb1f2be6de613ae04b466669901a281a6f4f268c3671
-  data.tar.gz: 23a208e0eb8c72d12273660010fa19d9b8fb7a304508a5b051c348b23720d2a1d1aecc7836d93aac91466065048a36b1bc126193165f47b59c77979c55a00f68
+  metadata.gz: 016a9d535cf7a3c02afc1bb2503d701328cb6ac55e8c8bdfdeda782c6c8d2eab8528ef30c1b05e4241b8f439f98617865b7d00ff7fd6b49683d288d431e37936
+  data.tar.gz: 748d79ed7028e114dc2aff3cb1d31b4163bc7ff289ea9f20f78bec4c5941622ecf40e58330e7e5c678884f37cbb800b8bd2acb8aca106916e8daccc510567e85

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    wayfarer (0.4.5)
+    wayfarer (0.4.6)
       activejob (>= 6.0)
       addressable (~> 2.8)
       capybara (~> 3.0)

data/docs/guides/error_handling.md

@@ -5,7 +5,7 @@
 * Wayfarer never swallows exceptions.
 * Jobs with unhandled exceptions are not retried.
 
-## Retrying and discarding
+## Retrying or discarding failing jobs
 
 Wayfarer relies on [Active Job's two error handling facilities](https://guides.rubyonrails.org/active_job_basics.html#exceptions).
 
@@ -16,6 +16,8 @@ Wayfarer relies on [Active Job's two error handling facilities](https://guides.r
       retry_on MyError, attempts: 3 do |job, error|
         # This block runs once all 3 attempts have failed
         # (1 initial attempt + 2 retries)
+
+        raise error
       end
     end
     ```
@@ -26,6 +28,26 @@ Wayfarer relies on [Active Job's two error handling facilities](https://guides.r
     class DummyJob < Wayfarer::Base
       discard_on MyError do |job, error|
         # This block runs once and buries the job
+
+        raise error
       end
     end
     ```
+
+!!! attention "Always re-raise errors"
+
+    You should always re-raise errors from `retry_on` and `discard_on` blocks,
+    otherwise jobs will not get retried!
+
+## Renewing agents on certain errors
+
+```ruby
+Wayfarer.config.network.renew_on = [MyError]
+```
+
+For example, if you use the Capybara
+[Cuprite](https://github.com/rubycdp/cuprite) driver:
+
+```ruby
+Wayfarer.config.network.renew_on = [Ferrum::DeadBrowserError]
+```

data/docs/reference/configuration_keys.md

@@ -13,6 +13,7 @@ hide:
 | `network.pool_size`    | `WAYFARER_NETWORK_POOL_SIZE`         | How many user agents to spawn.              | 1                                | Integers                            |
 | `network.pool_timeout` | `WAYFARER_NETWORK_POOL_TIMEOUT`      | How long jobs may use an agent in seconds.  | 10                               | Integers                            |
 | `network.http_headers` | `WAYFARER_NETWORK_HTTP_HEADERS`      | HTTP headers to append to requests.         | `{}`                             | Hashes                              |
+| `network.renew_on`     |                                      | Exception classes to renew agents on.       | `[]`                             | Classes                             |
 
 ## `Wayfarer.config.ferrum`
 

data/lib/wayfarer/config/networking.rb

@@ -21,6 +21,9 @@ module Wayfarer
                               env_key: "WAYFARER_NETWORK_HTTP_HEADERS",
                               type: Hash,
                               default: {}
+                            },
+                            renew_on: {
+                              default: []
                             })
   end
 end

data/lib/wayfarer/networking/context.rb

@@ -25,7 +25,7 @@ module Wayfarer
 
       def supervise
         yield
-      rescue *strategy.renew_on => e
+      rescue *strategy.renew_on, *Wayfarer.config.network.renew_on => e
         renew
       ensure
         # If renewing raises, re-raise the originally caught exception

data/lib/wayfarer.rb

@@ -38,7 +38,7 @@ module Wayfarer
   module VERSION
     MAJOR = 0
     MINOR = 4
-    TINY = 5
+    TINY = 6
     STRING = [MAJOR, MINOR, TINY].join(".")
   end
 

data/spec/networking/context_spec.rb

@@ -45,6 +45,23 @@ describe Wayfarer::Networking::Context do
       end
     end
 
+    context "with configured renewing exception raised" do
+      let(:other_error) { Class.new(StandardError) }
+
+      before do
+        Wayfarer.config.network.renew_on = [other_error]
+        allow(strategy).to receive(:fetch).and_raise(other_error)
+      end
+
+      it "renews and reraises" do
+        expect(context).to receive(:renew)
+
+        expect {
+          context.fetch(url)
+        }.to raise_error(other_error)
+      end
+    end
+
     context "with non-renewing exception raised" do
       before do
         allow(strategy).to receive(:fetch).and_raise(StandardError)

data/wayfarer.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = "wayfarer"
-  s.version = "0.4.5"
+  s.version = "0.4.6"
   s.license = "MIT"
 
   s.homepage = "http://github.com/bauerd/wayfarer"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wayfarer
 version: !ruby/object:Gem::Version
-  version: 0.4.5
+  version: 0.4.6
 platform: ruby
 authors:
 - Dominic Bauer