chained_job 0.1.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0174385a9a25b2f075952147d50294614ae4dfc744acc4ce155cf9bfa5ba91af'
-  data.tar.gz: e6f2366519f09f0c11ede71e9270190ab12f7e5f6657c16e44523a4feb6bc595
+  metadata.gz: 2754a3795b49b29119699d834fa7fd30a3618c5c9b9e4e13c0d806f1e681b1c7
+  data.tar.gz: cd5a4e01156701bb5c232a67d1731bc592b4caafd3bc1c09ec11e23acb10efd3
 SHA512:
-  metadata.gz: b17c3a986b31c8c6eb1f01445d96615d1970db038a8b608d60ce9aceabe3194f57be9df3f908b31bccfed5d961ada85b530c64f57dd8dd0660add5265816fb09
-  data.tar.gz: edd731cfe81e89c3954ec3f3f2c2144ff99e0a27b015a43bc7526c728e12bdd0a9ba685a744b0ecd0be3cc17f07127f54c2c47b5fbedbb61284890f94554e657
+  metadata.gz: 012b685a5f4b0a457d70125e4d49f1fba4634650ec8b684d34cffafe35b4327807de56670ec6026ec87a773fdb641477452474205629104be846d6757ff9444c
+  data.tar.gz: 122694c013a12d28b1c781b8b593bcf7e1dd40209642d8c3879a69821792c0258dadaf0f7b3b1dd06990ae802489256699a42abbb8eed2cadbfe2e3efc0099dc

data/lib/chained_job/clean_up_queue.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'chained_job/helpers'
+
+module ChainedJob
+  class CleanUpQueue
+    def self.run(job_class)
+      new(job_class).run
+    end
+
+    TRIM_STEP_SIZE = 1_000
+
+    attr_reader :job_class
+
+    def initialize(job_class)
+      @job_class = job_class
+    end
+
+    # rubocop:disable Metrics/AbcSize
+    def run
+      loop do
+        tag = ChainedJob.redis.spop(tag_list)
+
+        break unless tag
+
+        redis_key = Helpers.redis_key(job_key, tag)
+        size = ChainedJob.redis.llen(redis_key)
+        (size / TRIM_STEP_SIZE).times { ChainedJob.redis.ltrim(redis_key, 0, -TRIM_STEP_SIZE) }
+
+        ChainedJob.redis.del(redis_key)
+      end
+    end
+    # rubocop:enable Metrics/AbcSize
+
+    private
+
+    def tag_list
+      @tag_list ||= Helpers.tag_list(job_key)
+    end
+
+    def job_key
+      @job_key ||= Helpers.job_key(job_class)
+    end
+  end
+end

data/lib/chained_job/config.rb

@@ -12,9 +12,12 @@ module ChainedJob
       :arguments_queue_expiration,
       :around_start_chains,
       :around_chain_process,
+      :around_array_of_job_arguments,
+      :after_worker_finished,
       :debug,
       :logger,
       :redis,
+      :queue,
     )
 
     def initialize
@@ -25,6 +28,8 @@ module ChainedJob
 
       self.around_start_chains = ->(_options, &block) { block.call }
       self.around_chain_process = ->(_options, &block) { block.call }
+      self.around_array_of_job_arguments = ->(_options, &block) { block.call }
+      self.after_worker_finished = ->(_options) {}
 
       self.debug = true
     end

data/lib/chained_job/helpers.rb

@@ -4,8 +4,16 @@ module ChainedJob
   module Helpers
     module_function
 
-    def redis_key(job_class)
+    def job_key(job_class)
       "chained_job:#{job_class}"
     end
+
+    def redis_key(job_key, tag)
+      "#{job_key}:#{tag}"
+    end
+
+    def tag_list(prefix)
+      "#{prefix}:tags"
+    end
   end
 end

data/lib/chained_job/middleware.rb

@@ -5,14 +5,23 @@ require 'chained_job/process'
 
 module ChainedJob
   module Middleware
-    def perform(worker_id = nil)
+    def self.included(base)
+      base.queue_as ChainedJob.config.queue if ChainedJob.config.queue
+    end
+
+    def perform(worker_id = nil, tag = nil)
       if worker_id
-        ChainedJob::Process.run(self, worker_id)
+        ChainedJob::Process.run(self, worker_id, tag)
       else
-        ChainedJob::StartChains.run(self.class, array_of_job_arguments, parallelism)
+        ChainedJob::StartChains.run(self.class, arguments_array, parallelism)
       end
     end
 
+    def arguments_array
+      options = { job_class: self.class }
+      ChainedJob.config.around_array_of_job_arguments.call(options) { array_of_job_arguments }
+    end
+
     def array_of_job_arguments
       raise NoMethodError, 'undefined method array_of_job_arguments'
     end

data/lib/chained_job/process.rb

@@ -4,23 +4,24 @@ require 'chained_job/helpers'
 
 module ChainedJob
   class Process
-    def self.run(job_instance, worker_id)
-      new(job_instance, worker_id).run
+    def self.run(job_instance, worker_id, job_tag)
+      new(job_instance, worker_id, job_tag).run
     end
 
-    attr_reader :job_instance, :worker_id
+    attr_reader :job_instance, :worker_id, :job_tag
 
-    def initialize(job_instance, worker_id)
+    def initialize(job_instance, worker_id, job_tag)
       @job_instance = job_instance
       @worker_id = worker_id
+      @job_tag = job_tag
     end
 
     def run
       with_hooks do
-        return log_finished_worker unless argument
+        return finished_worker unless argument
 
         job_instance.process(argument)
-        job_instance.class.perform_later(worker_id)
+        job_instance.class.perform_later(worker_id, job_tag)
       end
     end
 
@@ -31,12 +32,18 @@ module ChainedJob
     end
 
     def options
-      { job_class: job_instance.class, worker_id: worker_id }
+      @options ||= { job_class: job_instance.class, worker_id: worker_id }
+    end
+
+    def finished_worker
+      log_finished_worker
+
+      ChainedJob.config.after_worker_finished&.call(options)
     end
 
     def log_finished_worker
       ChainedJob.logger.info(
-        "#{job_instance.class} worker #{worker_id} finished"
+        "#{job_instance.class}:#{job_tag} worker #{worker_id} finished"
       )
     end
 
@@ -45,7 +52,11 @@ module ChainedJob
     end
 
     def redis_key
-      Helpers.redis_key(job_instance.class)
+      Helpers.redis_key(job_key, job_tag)
+    end
+
+    def job_key
+      Helpers.job_key(job_instance.class)
     end
   end
 end

data/lib/chained_job/start_chains.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require 'chained_job/helpers'
+require 'chained_job/clean_up_queue'
+require 'chained_job/store_job_arguments'
 
 module ChainedJob
   class StartChains
@@ -16,19 +18,23 @@ module ChainedJob
       @parallelism = parallelism
     end
 
+    # rubocop:disable Metrics/AbcSize
     def run
       with_hooks do
-        redis.del(redis_key)
+        log_chained_job_cleanup
 
-        return unless array_of_job_arguments.count.positive?
+        ChainedJob::CleanUpQueue.run(job_class)
 
-        store_job_arguments
+        next unless array_of_job_arguments.count.positive?
+
+        ChainedJob::StoreJobArguments.run(job_class, job_tag, array_of_job_arguments)
 
         log_chained_job_start
 
-        parallelism.times { |worked_id| job_class.perform_later(worked_id) }
+        parallelism.times { |worked_id| job_class.perform_later(worked_id, job_tag) }
       end
     end
+    # rubocop:enable Metrics/AbcSize
 
     private
 
@@ -44,31 +50,21 @@ module ChainedJob
       }
     end
 
-    def store_job_arguments
-      array_of_job_arguments.each_slice(config.arguments_batch_size) do |sublist|
-        redis.rpush(redis_key, sublist)
-      end
-
-      redis.expire(redis_key, config.arguments_queue_expiration)
+    def job_tag
+      @job_tag ||= Time.now.to_f.to_s
     end
 
     def log_chained_job_start
       ChainedJob.logger.info(
-        "#{job_class} starting #{parallelism} workers "\
+        "#{job_class}:#{job_tag} starting #{parallelism} workers "\
         "processing #{array_of_job_arguments.count} items"
       )
     end
 
-    def redis
-      ChainedJob.redis
-    end
-
-    def redis_key
-      Helpers.redis_key(job_class)
-    end
-
-    def config
-      ChainedJob.config
+    def log_chained_job_cleanup
+      ChainedJob.logger.info(
+        "#{job_class}:#{job_tag} cleanup"
+      )
     end
   end
 end

data/lib/chained_job/store_job_arguments.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'chained_job/helpers'
+
+module ChainedJob
+  class StoreJobArguments
+    def self.run(job_class, job_tag, array_of_job_arguments)
+      new(job_class, job_tag, array_of_job_arguments).run
+    end
+
+    attr_reader :job_class, :job_tag, :array_of_job_arguments
+
+    def initialize(job_class, job_tag, array_of_job_arguments)
+      @job_class = job_class
+      @job_tag = job_tag
+      @array_of_job_arguments = array_of_job_arguments
+    end
+
+    def run
+      set_tag_list
+
+      array_of_job_arguments.each_slice(config.arguments_batch_size) do |sublist|
+        ChainedJob.redis.rpush(redis_key, sublist)
+      end
+
+      ChainedJob.redis.expire(redis_key, config.arguments_queue_expiration)
+    end
+
+    private
+
+    def set_tag_list
+      ChainedJob.redis.sadd(tag_list, job_tag)
+    end
+
+    def tag_list
+      Helpers.tag_list(job_key)
+    end
+
+    def redis_key
+      @redis_key ||= Helpers.redis_key(job_key, job_tag)
+    end
+
+    def job_key
+      @job_key ||= Helpers.job_key(job_class)
+    end
+
+    def config
+      ChainedJob.config
+    end
+  end
+end

data/lib/chained_job/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ChainedJob
-  VERSION = '0.1.1'
+  VERSION = '0.4.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chained_job
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Mantas Kūjalis
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-24 00:00:00.000000000 Z
+date: 2020-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -77,11 +77,13 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/chained_job.rb
+- lib/chained_job/clean_up_queue.rb
 - lib/chained_job/config.rb
 - lib/chained_job/helpers.rb
 - lib/chained_job/middleware.rb
 - lib/chained_job/process.rb
 - lib/chained_job/start_chains.rb
+- lib/chained_job/store_job_arguments.rb
 - lib/chained_job/version.rb
 homepage: https://github.com/vinted/chained_job
 licenses: