resumable_job 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8f854f34208a918c0a0ef31c56c7fb4948c6049d
+  data.tar.gz: 5d55ec698d3f0647f613b989e17b13fd0c7bfeeb
+SHA512:
+  metadata.gz: 97a12e2d542b4f891f61af9c9a4381679296f5d87780093c4e6ea312d0a63642c03d759159bccef3068ad054db9ccade026db5c99ac044f88728f56f73a2a2be
+  data.tar.gz: 6976695e4357d114cb31cf53fcaa6bd838e140b14cbeb316edc61b851508015bcee3b847832e75cdc985de2d022d827f24a4618661cfd797a60570fea74451ba

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.rakeTasks

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.4
+before_install: gem install bundler -v 1.16.2

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in resumable_job.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,22 @@
+PATH
+  remote: .
+  specs:
+    resumable_job (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.11.3)
+    rake (10.5.0)
+
+PLATFORMS
+  x64-mingw32
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  minitest (~> 5.0)
+  rake (~> 10.0)
+  resumable_job!
+
+BUNDLED WITH
+   1.16.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Derk-Jan Karrenbeld
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,114 @@
+# ResumableJob
+
+Make any `ActiveJob` resumable.
+
+Use exception flow to make jobs exceptionally resumable, whilst retaining other state, with automatic exponential
+backoff handling. ActiveJob is not a dependency, so this could be used with "anything". Adds a `module` to `include`
+somewhere that adds a method which yields a block. During this block, you can throw a `ResumableJob::ResumeLater` to 
+call the following:
+
+```Ruby
+self.class
+    .set(wait_until: resume_at || ResumableJob::Backoff.to_time(attempt))
+    .perform_later(pause(state).merge(attempt: attempt + 1))
+````
+
+State is passed through `pause` and when `pause` is not overridden will be all the arguments you passed to your job plus
+an `attempt` argument that is steadily increased in order to to exponential backoff.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'resumable_job'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install resumable_job
+
+## Usage
+
+### Make a job resumable
+
+Simple example to implement pagination that resumes later if you receive a "Rate Limit Exceeded".
+
+```Ruby
+class FetchDataJob < ApplicationJob
+  include ResumableJob::Resumable
+  
+  def perform(state)
+    page = state.fetch(:page) { 1 }
+    
+    resumable(state) do
+      loop do
+        result = DataFetcher.call(page: page)
+        raise ResumableJob::ResumeLater(state: state.merge(page: page)) if result.status == 429
+        break unless result.next_page?
+          
+        page = result.next_page
+      end
+    end
+  end
+end
+```
+
+### Turn inner exception into resumable
+
+When the exception has more information (for example a "rate limit reset" value), it can be turned into a resume later.
+Additionally, the `state` of the resume later exception will me merged into the original state, and then into the pause
+state.
+ 
+
+```Ruby
+class FetchDataJob < ApplicationJob
+  include ResumableJob::Resumable
+
+  def perform(state)
+    resumable(state) do
+      fetch_data(state)
+    end
+  end
+
+  private
+
+  def fetch_data(state)
+    RateLimitableFetcher.call(state)
+  rescue RateLimitableFetcher::RateLimited => ex
+    raise ResumableJob::ResumeLater.new(state: state, utc: ex.retry_at, message: ex.message)
+  end
+end
+```
+
+### Filter out keys from the state
+Some state is not serializable. You may be calling your job with `perform_now`, but when it resumes later, some
+arguments can not be serialized. Use the `pause` override to include state not originally present, modify state that is
+not passed by your exception (ResumeLater exception state), or remove state. 
+
+```Ruby
+class FetchDataJob < ApplicationJob
+  include ResumableJob::Resumable
+  
+  def pause(state)
+    state.slice(:attempt, :page, :token)
+  end
+end
+```
+  
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can
+also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the
+version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version,
+push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/SleeplessByte/resumable_job.

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'resumable_job'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/resumable_job/backoff.rb

@@ -0,0 +1,35 @@
+module ResumableJob
+  class Backoff
+    DEFAULT_BASE_IN_MINUTES = 1
+    SECONDS_PER_MINUTE = 60
+
+    class << self
+      def to_i(*args)
+        new(*args).to_i
+      end
+
+      def to_time(*args)
+        new(*args).to_time
+      end
+    end
+
+    delegate :to_i, to: :to_time
+
+    def initialize(attempt, base: DEFAULT_BASE_IN_MINUTES)
+      self.attempt = attempt
+      self.base = base
+    end
+
+    def to_time
+      Time.now + delay
+    end
+
+    private
+
+    attr_accessor :attempt, :base
+
+    def delay
+      (2**attempt) * base * SECONDS_PER_MINUTE
+    end
+  end
+end

data/lib/resumable_job/resumable.rb

@@ -0,0 +1,117 @@
+module ResumableJob
+
+  ##
+  # Include in an {ActiveJob::Job} to make resumable.
+  #
+  # Adds a yield guard resumable that catches any thrown instance of {ResumeLater}, which enqueues the job at a
+  #   later time, either by getting a utc in the future from the exception or using a backoff algorithm.
+  #
+  module Resumable
+    private
+
+    ##
+    # Resumable guard
+    #
+    # @param state [Hash] the job state
+    #
+    # @example Make a job resumable
+    #
+    #   class FetchDataJob < ApplicationJob
+    #     include ResumableJob::Resumable
+    #
+    #     def perform(state)
+    #       page = state.fetch(:page) { 1 }
+    #
+    #       resumable(state) do
+    #         loop do
+    #           result = DataFetcher.call(page: page)
+    #           raise ResumableJob::ResumeLater(state: state.merge(page: page)) if result.status == 429
+    #           break unless result.next_page?
+    #
+    #           page = result.next_page
+    #         end
+    #       end
+    #     end
+    #   end
+    #
+    # @example Filter out state
+    #
+    #   class FetchDataJob < ApplicationJob
+    #     include ResumableJob::Resumable
+    #
+    #     def pause(state)
+    #       state.slice(:attempt, :page, :token)
+    #     end
+    #
+    #   end
+    #
+    # @example Turn inner exception into resumable
+    #
+    #   class FetchDataJob < ApplicationJob
+    #     include ResumableJob::Resumable
+    #     def perform(state)
+    #       resumable(state) do
+    #         fetch_data(state)
+    #       end
+    #     end
+    #
+    #     private
+    #
+    #     def fetch_data(state)
+    #       RateLimitableFetcher.call(state)
+    #     rescue RateLimitableFetcher::RateLimited => ex
+    #       raise ResumableJob::ResumeLater.new(state: state, utc: ex.retry_at, message: ex.message)
+    #     end
+    #   end
+    #
+    def resumable(state)
+      attempt = state.fetch(:attempt) { 0 }
+      yield attempt
+    rescue ResumableJob::ResumeLater => ex
+      resume_later(
+        resume_at: ex.utc,
+        state: state.merge(ex.state),
+        attempt: attempt
+      )
+    end
+
+    ##
+    # Schedules the current job to +resume_at+ a later time, either given or calculated from +attempt+.
+    #
+    # @see #pause
+    # @see ResumableJob::Backoff.to_time
+    #
+    # @param [NilClass, Numeric] resume_at
+    # @param [Numeric] attempt the current attempt
+    # @param [Hash] state state to merge with the state from {#pause}
+    #
+    def resume_later(resume_at: nil, state: {}, attempt: 0)
+      self.class
+          .set(wait_until: resume_at || ResumableJob::Backoff.to_time(attempt))
+          .perform_later(pause(state).merge(attempt: attempt + 1))
+    end
+
+    ##
+    # Calculates the state to be passed for rescheduling this job.
+    #   By default outputs input, override {#pause} to change what is passed to the job.
+    #
+    # @param [Hash] state
+    # @return [Hash] state
+    #
+    # @example Remove a key from the state
+    #
+    #   def pause(state)
+    #     state.except(:key_to_exclude)
+    #   end
+    #
+    # @example Update the state before pausing
+    #
+    #   def pause(state)
+    #     state.merge!(foo: state[:foo] * 2)
+    #   end
+    #
+    def pause(state)
+      state
+    end
+  end
+end

data/lib/resumable_job/resume_later.rb

@@ -0,0 +1,12 @@
+module ResumableJob
+  class ResumeLater < RuntimeError
+    def initialize(state: {}, utc: nil, message:)
+      self.state = state || {}
+      self.utc = utc
+
+      super message
+    end
+
+    attr_accessor :state, :utc
+  end
+end

data/lib/resumable_job/version.rb

@@ -0,0 +1,3 @@
+module ResumableJob
+  VERSION = '0.1.0'.freeze
+end

data/lib/resumable_job.rb

@@ -0,0 +1,8 @@
+require 'resumable_job/version'
+
+require 'resumable_job/backoff'
+require 'resumable_job/resumable'
+require 'resumable_job/resume_later'
+
+module ResumableJob
+end

data/resumable_job.gemspec

@@ -0,0 +1,41 @@
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'resumable_job/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'resumable_job'
+  spec.version       = ResumableJob::VERSION
+  spec.authors       = ['Derk-Jan Karrenbeld']
+  spec.email         = ['derk-jan+github@karrenbeld.info']
+
+  spec.summary       = 'Make an ActiveJob resumable'
+  spec.license       = 'MIT'
+
+  spec.metadata = {
+    'bug_tracker_uri'   => 'https://github.com/SleeplessByte/resumable_job/issues',
+    'changelog_uri'     => 'https://github.com/SleeplessByte/resumable_job/CHANGELOG.md',
+    'homepage_uri'      => 'https://github.com/SleeplessByte/resumable_job',
+    'source_code_uri'   => 'https://github.com/SleeplessByte/resumable_job'
+  }
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    # spec.metadata['allowed_push_host'] = 'https://gems.sleeplessbyte.technology'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: resumable_job
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Derk-Jan Karrenbeld
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-06-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: 
+email:
+- derk-jan+github@karrenbeld.info
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/resumable_job.rb
+- lib/resumable_job/backoff.rb
+- lib/resumable_job/resumable.rb
+- lib/resumable_job/resume_later.rb
+- lib/resumable_job/version.rb
+- resumable_job.gemspec
+homepage: 
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/SleeplessByte/resumable_job/issues
+  changelog_uri: https://github.com/SleeplessByte/resumable_job/CHANGELOG.md
+  homepage_uri: https://github.com/SleeplessByte/resumable_job
+  source_code_uri: https://github.com/SleeplessByte/resumable_job
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14.1
+signing_key: 
+specification_version: 4
+summary: Make an ActiveJob resumable
+test_files: []