jobba 1.8.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 489a463b81e0d1dc9d7f8c79b1aacd25ab66358cea92a2692e4428e0f7b30a54
-  data.tar.gz: c8eb29ef8b368390b1f78eec40a04aaa06cc4dee3b45453355d9109eace62fa7
+  metadata.gz: 1fd0ebb186e9eca18861196616b9d2e6518d1193e5672ae68d783762e3a1f6f7
+  data.tar.gz: af77889b9e09fd57d965fe8b8b8c619b13d6b21ce249d7c4d5677f9f537d41ab
 SHA512:
-  metadata.gz: 16abf20ee8428d89b11c1e76315e957a357bf4f4381b4c072efdfd90365d5863a558f2a92f0b051fda32bde52f58d012b17000a5602050be77e9202a609f7cd3
-  data.tar.gz: 6b63cffc85fa57a36b454913a016b6b745e7975c3741868644735505315068086f01e5dd07cb1613304dafce896a4e537f2c169c55a4926ea0d833b4949efabd
+  metadata.gz: 0c1ef1efbc0496d339e79d188a56718b9db416b28e62ac6e247e91ab0c43ce0313e02a7dee103b8cfe1dc034005567a55fd8db1811487c331d2396bc5de555b0
+  data.tar.gz: 668c4722c4bd2505d84cad9860dec70a028acee23d980ce99d67d0969d4e9164ae5d9dca08ef15ec465c226046242429c95e18c3cd94a6e60efabacd5323a2d8

data/.github/workflows/tests.yml

@@ -12,12 +12,12 @@ on:
 jobs:
   tests:
     timeout-minutes: 30
-    runs-on: ubuntu-18.04
+    runs-on: ubuntu-22.04
     strategy:
       fail-fast: false
       matrix:
         os: [ubuntu]
-        ruby: [ '2.5', '2.6', '2.7' ]
+        ruby: [ '2.6', '2.7', '3.0', '3.1' ]
     services:
       # Label used to access the service container
       redis:
@@ -32,7 +32,7 @@ jobs:
           # Maps port 6379 on service container to the host
           - 6379:6379
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}

data/jobba.gemspec

@@ -1,30 +1,29 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'jobba/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "jobba"
+  spec.name          = 'jobba'
   spec.version       = Jobba::VERSION
-  spec.authors       = ["JP Slavinsky"]
-  spec.email         = ["jps@kindlinglabs.com"]
+  spec.authors       = ['JP Slavinsky']
+  spec.email         = ['jps@kindlinglabs.com']
 
-  spec.summary       = %q{Redis-based background job status tracking.}
-  spec.description   = %q{Redis-based background job status tracking.}
-  spec.homepage      = "https://github.com/openstax/jobba"
-  spec.license       = "MIT"
+  spec.summary       = 'Redis-based background job status tracking.'
+  spec.description   = 'Redis-based background job status tracking.'
+  spec.homepage      = 'https://github.com/openstax/jobba'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency "redis"
-  spec.add_runtime_dependency "oj"
-  spec.add_runtime_dependency "redis-namespace"
+  spec.add_runtime_dependency 'oj'
+  spec.add_runtime_dependency 'redis', '>= 4.0'
+  spec.add_runtime_dependency 'redis-namespace'
 
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec"
-  spec.add_development_dependency "byebug"
-  spec.add_development_dependency "fakeredis"
+  spec.add_development_dependency 'byebug'
+  spec.add_development_dependency 'fakeredis'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
 end

data/lib/jobba/common.rb

@@ -1,9 +1,12 @@
 module Jobba::Common
-
   def redis
     Jobba.redis
   end
 
+  def transaction(&block)
+    Jobba.transaction(&block)
+  end
+
   module ClassMethods
     def redis
       Jobba.redis
@@ -13,5 +16,4 @@ module Jobba::Common
   def self.included(base)
     base.extend(ClassMethods)
   end
-
 end

data/lib/jobba/query.rb

@@ -3,14 +3,13 @@ require 'jobba/id_clause'
 require 'jobba/clause_factory'
 
 class Jobba::Query
-
   include Jobba::Common
 
   attr_reader :_limit, :_offset
 
   def where(options)
-    options.each do |kk,vv|
-      clauses.push(Jobba::ClauseFactory.new_clause(kk,vv))
+    options.each do |kk, vv|
+      clauses.push(Jobba::ClauseFactory.new_clause(kk, vv))
     end
 
     self
@@ -72,20 +71,20 @@ class Jobba::Query
     end
 
     # Standalone method that gives the final result when the query is one clause
-    def handle_single_clause(clause)
-      raise "AbstractMethod"
+    def handle_single_clause(_clause)
+      raise 'AbstractMethod'
     end
 
     # When the query is multiple clauses, this method is called on the final set
     # that represents the ANDing of all clauses.  It is called inside a `redis.multi`
     # block.
-    def multi_clause_last_redis_op(result_set)
-      raise "AbstractMethod"
+    def multi_clause_last_redis_op(_result_set)
+      raise 'AbstractMethod'
     end
 
     # Called on the output from the redis multi block for multi-clause queries.
-    def multi_clause_postprocess(redis_output)
-      raise "AbstractMethod"
+    def multi_clause_postprocess(_redis_output)
+      raise 'AbstractMethod'
     end
   end
 
@@ -121,9 +120,7 @@ class Jobba::Query
   end
 
   def _run(operations)
-    if _limit.nil? && !_offset.nil?
-      raise ArgumentError, "`limit` must be set if `offset` is set", caller
-    end
+    raise ArgumentError, '`limit` must be set if `offset` is set', caller if _limit.nil? && !_offset.nil?
 
     load_default_clause if clauses.empty?
 
@@ -145,8 +142,7 @@ class Jobba::Query
       #
       # This code also works for the single clause case, but it is less efficient
 
-      multi_result = redis.multi do
-
+      multi_result = transaction do |trn|
         working_set = nil
 
         clauses.each do |clause|
@@ -155,15 +151,15 @@ class Jobba::Query
           if working_set.nil?
             working_set = clause_set
           else
-            redis.zinterstore(working_set, [working_set, clause_set], weights: [0, 0])
-            redis.del(clause_set)
+            trn.zinterstore(working_set, [working_set, clause_set], weights: [0, 0])
+            trn.del(clause_set)
           end
         end
 
         # This is later accessed as `multi_result[-2]` since it is the second to last output
         operations.multi_clause_last_redis_op(working_set)
 
-        redis.del(working_set)
+        trn.del(working_set)
       end
 
       operations.multi_clause_postprocess(multi_result[-2])
@@ -173,5 +169,4 @@ class Jobba::Query
   def load_default_clause
     where(state: Jobba::State::ALL.collect(&:name))
   end
-
 end

data/lib/jobba/status.rb

@@ -3,7 +3,6 @@ require 'oj'
 
 module Jobba
   class Status
-
     include Jobba::Common
 
     def self.all
@@ -40,8 +39,8 @@ module Jobba
     end
 
     def self.local_attrs
-      %w(id state progress errors data kill_requested_at
-        job_name job_args provider_job_id attempt prior_attempts) +
+      %w[id state progress errors data kill_requested_at
+         job_name job_args provider_job_id attempt prior_attempts] +
         State::ALL.collect(&:timestamp_name)
     end
 
@@ -56,7 +55,7 @@ module Jobba
     # As an extra step, convert state names into State objects.
 
     local_attrs.each do |attribute|
-      class_eval <<-eoruby
+      class_eval <<-EORUBY, __FILE__, __LINE__ + 1
         def #{attribute}
           @#{attribute} ||= load_from_json_encoded_attrs('#{attribute}')
         end
@@ -64,12 +63,12 @@ module Jobba
         protected
 
         attr_writer :#{attribute}
-      eoruby
+      EORUBY
     end
 
     State::ENTERABLE.each do |state|
       define_method("#{state.name}!") do
-        redis.multi do
+        transaction do
           if state == State::STARTED && did_start?
             restart!
           elsif state != self.state
@@ -96,14 +95,14 @@ module Jobba
     end
 
     def did_start?
-      !self.started_at.nil?
+      !started_at.nil?
     end
 
     def request_kill!
       time, usec_int = now
-      if redis.hsetnx(job_key, :kill_requested_at, usec_int)
-        @kill_requested_at = time
-      end
+      return unless redis.hsetnx(job_key, :kill_requested_at, usec_int)
+
+      @kill_requested_at = time
     end
 
     def kill_requested?
@@ -116,24 +115,26 @@ module Jobba
     end
 
     def set_job_name(job_name)
-      raise ArgumentError, "`job_name` must not be blank", caller \
+      raise ArgumentError, '`job_name` must not be blank', caller \
         if job_name.nil? || job_name.empty?
 
-      redis.multi do
-        redis.srem(job_name_key, id)
+      transaction do |trn|
+        trn.srem(job_name_key, id)
         set(job_name: job_name)
-        redis.sadd(job_name_key, id)
+        trn.sadd(job_name_key, id)
       end
     end
 
-    def set_job_args(args_hash={})
-      raise ArgumentError,
-            "All values in the hash passed to `set_job_args` must be strings",
-            caller if args_hash.values.any?{|val| !val.is_a?(String)}
+    def set_job_args(args_hash = {})
+      if args_hash.values.any? { |val| !val.is_a?(String) }
+        raise ArgumentError,
+              'All values in the hash passed to `set_job_args` must be strings',
+              caller
+      end
 
       args_hash = normalize_for_json(args_hash)
 
-      redis.multi do
+      transaction do
         delete_self_from_job_args_set!
         set(job_args: args_hash)
         add_self_to_job_args_set!
@@ -141,18 +142,18 @@ module Jobba
     end
 
     def set_provider_job_id(provider_job_id)
-      raise ArgumentError, "`provider_job_id` must not be blank", caller \
+      raise ArgumentError, '`provider_job_id` must not be blank', caller \
         if provider_job_id.nil? || (provider_job_id.respond_to?(:empty?) && provider_job_id.empty?)
 
-      redis.multi do
-        redis.srem(provider_job_id_key, id)
+      transaction do |trn|
+        trn.srem(provider_job_id_key, id)
         set(provider_job_id: provider_job_id)
-        redis.sadd(provider_job_id_key, id)
+        trn.sadd(provider_job_id_key, id)
       end
     end
 
     def add_error(error)
-      raise ArgumentError, "The argument to `add_error` cannot be nil", caller if error.nil?
+      raise ArgumentError, 'The argument to `add_error` cannot be nil', caller if error.nil?
 
       errors.push(normalize_for_json(error))
       set(errors: errors)
@@ -171,11 +172,13 @@ module Jobba
     end
 
     def delete
-      completed? ?
-        delete! :
-        raise(NotCompletedError, "This status cannot be deleted because it " \
-                                 "isn't complete.  Use `delete!` if you want to " \
-                                 "delete anyway.")
+      if completed?
+        delete!
+      else
+        raise(NotCompletedError, 'This status cannot be deleted because it ' \
+                                       "isn't complete.  Use `delete!` if you want to " \
+                                       'delete anyway.')
+      end
     end
 
     def delete!
@@ -184,7 +187,7 @@ module Jobba
     end
 
     def prior_attempts
-      @prior_attempts ||= [*0..attempt-1].collect{|ii| self.class.find!("#{id}:#{ii}")}
+      @prior_attempts ||= [*0..attempt - 1].collect { |ii| self.class.find!("#{id}:#{ii}") }
     end
 
     protected
@@ -204,14 +207,14 @@ module Jobba
 
       restarted_values = {
         id: id,
-        attempt: attempt+1,
+        attempt: attempt + 1,
         recorded_at: recorded_at,
         queued_at: queued_at,
         progress: 0,
         errors: [],
         job_name: job_name,
         job_args: job_args,
-        provider_job_id: provider_job_id
+        provider_job_id: provider_job_id,
       }
 
       archive_attempt!
@@ -236,29 +239,28 @@ module Jobba
 
       @json_encoded_attrs = attrs[:raw]
 
-      if @json_encoded_attrs.nil? || @json_encoded_attrs.empty?
-
-        @id       = attrs[:id]       || SecureRandom.uuid
-        @state    = attrs[:state]    || State::UNKNOWN
-        @progress = attrs[:progress] || 0
-        @errors   = attrs[:errors]   || []
-        @data     = attrs[:data]
-        @attempt  = attrs[:attempt]  || 0
-        @job_args = attrs[:job_args] || {}
-        @job_name = attrs[:job_name]
-        @provider_job_id = attrs[:provider_job_id]
-
-        if attrs[:persist]
-          redis.multi do
-            set(
-              id: id,
-              progress: progress,
-              errors: errors,
-              attempt: attempt
-            )
-            move_to_state!(state)
-          end
-        end
+      return unless @json_encoded_attrs.nil? || @json_encoded_attrs.empty?
+
+      @id       = attrs[:id]       || SecureRandom.uuid
+      @state    = attrs[:state]    || State::UNKNOWN
+      @progress = attrs[:progress] || 0
+      @errors   = attrs[:errors]   || []
+      @data     = attrs[:data]
+      @attempt  = attrs[:attempt]  || 0
+      @job_args = attrs[:job_args] || {}
+      @job_name = attrs[:job_name]
+      @provider_job_id = attrs[:provider_job_id]
+
+      return unless attrs[:persist]
+
+      transaction do
+        set(
+          id: id,
+          progress: progress,
+          errors: errors,
+          attempt: attempt
+        )
+        move_to_state!(state)
       end
     end
 
@@ -310,6 +312,7 @@ module Jobba
 
     def set_state_in_redis(hash)
       return unless hash[:state]
+
       redis.srem(state.name, id) unless state.nil? # leave old state if set
       redis.sadd(hash[:state].name, id)            # enter new state
     end
@@ -324,11 +327,11 @@ module Jobba
     end
 
     def set_hash_locally(hash)
-      hash.each{ |key, value| self.send("#{key}=", value) }
+      hash.each { |key, value| send("#{key}=", value) }
     end
 
     def delete_in_redis!
-      redis.multi do
+      transaction do
         redis.del(job_key)
 
         State::ALL.each do |state|
@@ -353,31 +356,32 @@ module Jobba
     end
 
     def delete_self_from_job_args_set!
-      self.job_args.values.each do |arg|
+      job_args.values.each do |arg|
         redis.srem(job_arg_key(arg), id)
       end
     end
 
     def add_self_to_job_args_set!
-      self.job_args.values.each do |arg|
+      job_args.values.each do |arg|
         redis.sadd(job_arg_key(arg), id)
       end
     end
 
     def clear_attrs
-      self.class.local_attrs.each{|aa| send("#{aa}=",nil)}
+      self.class.local_attrs.each { |aa| send("#{aa}=", nil) }
     end
 
     def job_name_key
       "job_name:#{job_name}"
     end
 
-    def job_key(attempt=nil)
+    def job_key(attempt = nil)
       self.class.job_key(id, attempt)
     end
 
-    def self.job_key(id, attempt=nil)
-      raise ArgumentError, "`id` cannot be nil", caller if id.nil?
+    def self.job_key(id, attempt = nil)
+      raise ArgumentError, '`id` cannot be nil', caller if id.nil?
+
       attempt.nil? ? "id:#{id}" : "id:#{id}:#{attempt}"
     end
 
@@ -390,20 +394,21 @@ module Jobba
     end
 
     def job_errors_key(id)
-      raise ArgumentError, "`id` cannot be nil", caller if id.nil?
+      raise ArgumentError, '`id` cannot be nil', caller if id.nil?
+
       "#{id}:errors"
     end
 
     def compute_fractional_progress(at, out_of)
       if at.nil?
-        raise ArgumentError, "Must specify at least `at` argument to `progress` call", caller
+        raise ArgumentError, 'Must specify at least `at` argument to `progress` call', caller
       elsif at < 0
         raise ArgumentError, "progress cannot be negative (at=#{at})", caller
       elsif out_of && out_of < at
-        raise ArgumentError, "`out_of` must be greater than `at` in `progress` calls", caller
+        raise ArgumentError, '`out_of` must be greater than `at` in `progress` calls', caller
       elsif out_of.nil? && (at < 0 || at > 1)
         raise ArgumentError,
-              "If `out_of` not specified, `at` must be in the range [0.0, 1.0]",
+              'If `out_of` not specified, `at` must be in the range [0.0, 1.0]',
               caller
       end
 
@@ -413,6 +418,5 @@ module Jobba
     def now
       [time = Jobba::Time.now, Utils.time_to_usec_int(time)]
     end
-
   end
 end

data/lib/jobba/statuses.rb

@@ -1,5 +1,4 @@
 class Jobba::Statuses
-
   include Jobba::Common
   extend Forwardable
 
@@ -26,7 +25,7 @@ class Jobba::Statuses
     if any?(&:incomplete?)
       raise(Jobba::NotCompletedError,
             "This status cannot be deleted because it isn't complete.  Use " \
-            "`delete_all!` if you want to delete anyway.")
+            '`delete_all!` if you want to delete anyway.')
     end
 
     delete_all!
@@ -38,7 +37,7 @@ class Jobba::Statuses
     # preload prior attempts because loading them is not `multi`-friendly
     @cache.each { |cache| cache.prior_attempts.each(&:prior_attempts) }
 
-    redis.multi do
+    transaction do
       @cache.each(&:delete!)
     end
     @cache = []
@@ -47,15 +46,15 @@ class Jobba::Statuses
 
   def request_kill_all!
     load
-    redis.multi do
+    transaction do
       @cache.each(&:request_kill!)
     end
   end
 
   def multi(&block)
     load
-    redis.multi do
-      @cache.each{|status| block.call(status, redis)}
+    transaction do
+      @cache.each { |status| block.call(status, redis) }
     end
   end
 
@@ -66,11 +65,11 @@ class Jobba::Statuses
   end
 
   def get_all!
-    id_keys = @ids.collect{|id| "id:#{id}"}
+    id_keys = @ids.collect { |id| "id:#{id}" }
 
-    raw_statuses = redis.pipelined do
+    raw_statuses = redis.pipelined do |pipe|
       id_keys.each do |key|
-        redis.hgetall(key)
+        pipe.hgetall(key)
       end
     end
 
@@ -83,6 +82,7 @@ class Jobba::Statuses
 
   def modify!(method, &block)
     raise Jobba::NotImplemented unless block_given?
+
     load
     if @cache.send(method, &block).nil?
       nil
@@ -96,5 +96,4 @@ class Jobba::Statuses
     @ids = [ids].flatten.compact
     @cache = nil
   end
-
 end

data/lib/jobba/version.rb

@@ -1,3 +1,3 @@
 module Jobba
-  VERSION = "1.8.1"
+  VERSION = '2.0.0'
 end

data/lib/jobba.rb

@@ -2,23 +2,22 @@ require 'delegate'
 require 'forwardable'
 require 'securerandom'
 
-require "redis"
-require "redis-namespace"
+require 'redis'
+require 'redis-namespace'
 
-require "jobba/version"
-require "jobba/exceptions"
-require "jobba/time"
-require "jobba/utils"
-require "jobba/configuration"
-require "jobba/common"
-require "jobba/redis_with_expiration"
-require "jobba/state"
-require "jobba/status"
-require "jobba/statuses"
-require "jobba/query"
+require 'jobba/version'
+require 'jobba/exceptions'
+require 'jobba/time'
+require 'jobba/utils'
+require 'jobba/configuration'
+require 'jobba/common'
+require 'jobba/redis_with_expiration'
+require 'jobba/state'
+require 'jobba/status'
+require 'jobba/statuses'
+require 'jobba/query'
 
 module Jobba
-
   class << self
     extend Forwardable
 
@@ -34,6 +33,8 @@ module Jobba
   end
 
   def self.redis
+    return @transaction if @transaction
+
     @redis ||= Jobba::RedisWithExpiration.new(
       Redis::Namespace.new(
         configuration.namespace,
@@ -42,7 +43,24 @@ module Jobba
     )
   end
 
-  def self.cleanup(seconds_ago: 60*60*24*30*12, batch_size: 1000)
+  def self.transaction(&block)
+    return @transaction unless block_given?
+
+    if @transaction
+      block.call(@transaction)
+    else
+      redis.multi do |trn|
+        @transaction = trn
+        begin
+          block.call(@transaction)
+        ensure
+          @transaction = nil
+        end
+      end
+    end
+  end
+
+  def self.cleanup(seconds_ago: 60 * 60 * 24 * 30 * 12, batch_size: 1000)
     start_time = Jobba::Time.now
     delete_before = start_time - seconds_ago
 
@@ -62,5 +80,4 @@ module Jobba
   def self.clear_all_jobba_data!
     cleanup(seconds_ago: 0)
   end
-
 end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: jobba
 version: !ruby/object:Gem::Version
-  version: 1.8.1
+  version: 2.0.0
 platform: ruby
 authors:
 - JP Slavinsky
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-10-21 00:00:00.000000000 Z
+date: 2023-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: redis
+  name: oj
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -25,19 +25,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: oj
+  name: redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: redis-namespace
   requirement: !ruby/object:Gem::Requirement
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: fakeredis
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: byebug
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -95,7 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: fakeredis
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -160,7 +160,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.33
 signing_key:
 specification_version: 4
 summary: Redis-based background job status tracking.