forked 0.1.1 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1f591d8bc0b287d508ca0663dc5da9eaff43aaf9e52dd493650a415e2e8046a6
-  data.tar.gz: aad8dbad91f2ad51f369e05966ba99ae743c36f4e60d596df65f2db468c79e13
+  metadata.gz: 38857b0c3e238d585fc5dee12ef826e4015cc746eabc81f3d05eddecf29ee9a9
+  data.tar.gz: 83a3e12ceaeedfb96a2023231097162f27e1d75c5c97cadfd8beb9c16e718b19
 SHA512:
-  metadata.gz: bd13eeacb29d220bf95083e5339797ff4af2e930719461faa8271e68fffed1f58928db4d43d57e3d8dd6a767e96b328c926072363e797b078aa59b66b23d03fc
-  data.tar.gz: 03fcc1b66c0d23c224e00f84315ba789679fd07bd7ce9a1b61704a3bd1b58d8f8b70abc1ca8099c6cfc1cea1471f6ebfd3d4e22cc361bfd1d0cf9c5858f6ba97
+  metadata.gz: e828c5610cb58ef373c4e3384e83c5f55d3ba744d364ec91eddf3e7839feda8c837cc050815613db145f66e53e25d3e81c843b27792c02d5468cbd37936fff2e
+  data.tar.gz: 187b9ed0ec291b52236093055818042fb723b5a4708690080ba72b6607cdf574eeb60487df76437b753464615f4e67fba3b2ebf38af65107bb5f7794469ba989

data/Gemfile.lock

@@ -1,41 +1,41 @@
 PATH
   remote: .
   specs:
-    forked (0.1.1)
+    forked (0.1.4)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    coderay (1.1.2)
-    diff-lcs (1.3)
-    method_source (0.9.0)
-    pry (0.11.3)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
+    coderay (1.1.3)
+    diff-lcs (1.5.0)
+    method_source (1.0.0)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
     rake (10.5.0)
-    rspec (3.7.0)
-      rspec-core (~> 3.7.0)
-      rspec-expectations (~> 3.7.0)
-      rspec-mocks (~> 3.7.0)
-    rspec-core (3.7.0)
-      rspec-support (~> 3.7.0)
-    rspec-expectations (3.7.0)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-mocks (3.7.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-support (3.7.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
 
 PLATFORMS
-  ruby
+  arm64-darwin-21
 
 DEPENDENCIES
-  bundler (~> 1.15)
+  bundler (~> 2.1)
   forked!
   pry
   rake (~> 10.0)
   rspec (~> 3.0)
 
 BUNDLED WITH
-   1.16.1
+   2.3.26

data/README.md

@@ -1,5 +1,10 @@
 # Forked
 
+[![License MIT](https://img.shields.io/badge/license-MIT-brightgreen.svg)](https://github.com/envato/forked/blob/master/LICENSE.txt)
+[![Gem Version](https://img.shields.io/gem/v/forked.svg?maxAge=2592000)](https://rubygems.org/gems/forked)
+[![Gem Downloads](https://img.shields.io/gem/dt/forked.svg?maxAge=2592000)](https://rubygems.org/gems/forked)
+[![Test Suite](https://github.com/envato/forked/workflows/tests/badge.svg?branch=master)](https://github.com/envato/forked/actions?query=branch%3Amaster+workflow%3Atests)
+
 Forked manages long running worker processes.
 
 Processes that crash are restarted, whereas processes that exit successfully
@@ -18,16 +23,31 @@ require 'forked'
 
 process_manager = Forked::ProcessManager.new(logger: Logger.new(STDOUT), process_timeout: 5)
 
-process_manager.fork('monitor', on_error: ->(e) { puts e.inspect }) do
+# Default retry_strategy = Forked::RetryStrategies::Always
+# Calling `ready_to_stop` within the loop ensures a shutdown is triggered if a TERM/INT signal is received
+process_manager.fork('monitor', on_error: ->(e, tries) { puts e.inspect }) do |ready_to_stop|
   loop do
-    puts "hi"
-    sleep 1
+    ready_to_stop.call
+    # do something
   end
 end
 
+# Using the ExponentialBackoff retry_strategy
+# If there is an error, process_manager backs off for a time then restarts the loop
+# The back off time increases as the number of errors increase
 process_manager.fork('processor_1', retry_strategy: Forked::RetryStrategies::ExponentialBackoff) do |ready_to_stop|
   loop do
-    ready_to_stop.call # triggers a shutdown if a TERM/INT signal has been received
+    ready_to_stop.call
+    # do something
+  end
+end
+
+# Using the ExponentialBackoffWithLimit retry_strategy
+# Follows the ExponentialBackoff retry strategy, but if the error keeps occurring
+#   until a given limit (default: 8), the error bubbles up and the loop is not restarted
+process_manager.fork('processor_1', retry_strategy: Forked::RetryStrategies::ExponentialBackoffWithLimit, retry_backoff_limit: 10) do |ready_to_stop|
+  loop do
+    ready_to_stop.call
     # do something
   end
 end

data/forked.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "forked/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "forked"
+  spec.version       = Forked::VERSION
+  spec.authors       = ["Steve Hodgkiss"]
+  spec.email         = ["steve@hodgkiss.me"]
+
+  spec.summary       = %q{Manage long running forked processes}
+  spec.description   = %q{}
+  spec.homepage      = "https://github.com/envato/forked"
+
+  spec.files = Dir["lib/**/*.rb"]
+  spec.files += Dir['[A-Z]*']
+  spec.require_paths = ['lib']
+
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.1"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry"
+end

data/lib/forked/process_manager.rb

@@ -3,14 +3,22 @@ require 'timeout'
 
 module Forked
   class ProcessManager
+    ON_ERROR = -> (e, tries) { }
+
     def initialize(process_timeout: 5, logger: Logger.new(STDOUT))
       @process_timeout = process_timeout
       @workers = {}
       @logger = logger
     end
 
-    def fork(name = nil, retry_strategy: ::Forked::RetryStrategies::ExponentialBackoff, on_error: -> (e) {}, &block)
-      worker = Worker.new(name, retry_strategy, on_error, block)
+    def fork(name = nil, retry_strategy: ::Forked::RetryStrategies::ExponentialBackoff, retry_backoff_limit: nil, on_error: ON_ERROR, &block)
+      worker = Worker.new(
+        name: name,
+        retry_strategy: retry_strategy,
+        retry_backoff_limit: retry_backoff_limit,
+        on_error: on_error,
+        block: block,
+      )
       fork_worker(worker)
     end
 
@@ -35,7 +43,10 @@ module Forked
     private
 
     def fork_worker(worker)
-      retry_strategy = worker.retry_strategy.new(logger: @logger, on_error: worker.on_error)
+      retry_params = { logger: @logger, on_error: worker.on_error }
+      retry_params[:limit] = worker.retry_backoff_limit if worker.retry_strategy == RetryStrategies::ExponentialBackoffWithLimit
+      retry_strategy = worker.retry_strategy.new(**retry_params)
+
       pid = Kernel.fork do
         WithGracefulShutdown.run(logger: @logger) do |ready_to_stop|
           retry_strategy.run(ready_to_stop) do

data/lib/forked/retry_strategies/exponential_backoff_with_limit.rb

@@ -0,0 +1,33 @@
+module Forked
+  module RetryStrategies
+    class ExponentialBackoffWithLimit
+      def initialize(logger:, on_error:, backoff_factor: 2, limit: nil)
+        @logger = logger
+        @on_error = on_error
+        @backoff_factor = backoff_factor
+        @limit = limit || 8
+      end
+
+      def run(ready_to_stop, &block)
+        tries = 0
+        begin
+          block.call
+        rescue => e
+          tries += 1
+
+          @logger.error("#{e.class} #{e.message}")
+          @on_error.call(e, tries)
+          raise if tries > @limit
+
+          sleep_seconds = @backoff_factor**tries
+          sleep_seconds.times do
+            ready_to_stop.call
+            sleep 1
+          end
+
+          retry
+        end
+      end
+    end
+  end
+end

data/lib/forked/version.rb

@@ -1,3 +1,3 @@
 module Forked
-  VERSION = "0.1.1"
+  VERSION = "0.1.4"
 end

data/lib/forked/worker.rb

@@ -1,4 +1,10 @@
 module Forked
-  class Worker < Struct.new(:name, :retry_strategy, :on_error, :block)
+  class Worker < Struct.new(
+    :name,
+    :retry_strategy,
+    :retry_backoff_limit,
+    :on_error,
+    :block,
+    keyword_init: true)
   end
 end

data/lib/forked.rb

@@ -2,6 +2,7 @@ require 'forked/version'
 require 'forked/worker'
 require 'forked/retry_strategies/always'
 require 'forked/retry_strategies/exponential_backoff'
+require 'forked/retry_strategies/exponential_backoff_with_limit'
 require 'forked/process_manager'
 require 'forked/with_graceful_shutdown'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: forked
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.4
 platform: ruby
 authors:
 - Steve Hodgkiss
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2018-08-16 00:00:00.000000000 Z
+date: 2023-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -78,17 +78,19 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- forked.gemspec
 - lib/forked.rb
 - lib/forked/process_manager.rb
 - lib/forked/retry_strategies/always.rb
 - lib/forked/retry_strategies/exponential_backoff.rb
+- lib/forked/retry_strategies/exponential_backoff_with_limit.rb
 - lib/forked/version.rb
 - lib/forked/with_graceful_shutdown.rb
 - lib/forked/worker.rb
 homepage: https://github.com/envato/forked
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -103,9 +105,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.3
-signing_key: 
+rubygems_version: 3.3.26
+signing_key:
 specification_version: 4
 summary: Manage long running forked processes
 test_files: []