cuetip 1.4.1 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 88a557995f20eba12cbcd542972965dd5ab6c3b92743310e62937a4e13408a13
-  data.tar.gz: 736a0226918e83ec7015f54381ac382319d215ce0b6d9cf8e51032775dbab5f3
+  metadata.gz: 846dd406c3144f1548c2385b57854e02fc58a28c198557fbac1e5525390c4851
+  data.tar.gz: 4ccc211f14f69ebe8828ef6089bc5a4179672cdff7e8c91bf1199f30c9ab7893
 SHA512:
-  metadata.gz: be4412c26b425f915d70904cbafd1a3f23287d84072ef4080f22efe99ecb2e9fbacc8554bcce5a00d96536c48e75b74d775d7b780cb6a07be3cb4724f013b5e9
-  data.tar.gz: 45691a899f3116c96e5eb432fa174029faea2ad76b148dcd0c367baba1878c343a98c6a41fe319eb610f61730ac18bc9d55ead808b6a29ab3c88f9ac262ff18a
+  metadata.gz: 21def25a628be5d6698b8254093acc612fa68dc549a674e0b495f9c91dfcc82bb2d1bfa2a863830caf3009c8d41fd35724f66f1ec10a6c2a75d15a31688053f5
+  data.tar.gz: 073ad3cfca0e29f854df84bffbba65120302aa29ad6a2e3d0c258fa8c24ef648764e808f25e4bce9693a63016a8062a16c578606e40073b79df4283aba95af63

data/lib/cuetip/config.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'klogger'
 require 'active_support'
 require 'active_support/core_ext/numeric/bytes'
 require 'active_support/core_ext/numeric/time'
@@ -20,7 +21,7 @@ module Cuetip
 
     # Return the logger
     def logger
-      @logger ||= Logger.new(STDOUT)
+      @logger ||= Klogger.new(:cuetip)
     end
     attr_writer :logger
 

data/lib/cuetip/models/job.rb

@@ -49,11 +49,11 @@ module Cuetip
       def remove_from_queue
         queued_job&.destroy
         self.queued_job = nil
-        log 'Removed from queue'
+        Cuetip.logger.debug 'Removed from queue'
 
         if delete_after_execution?
           destroy
-          log 'Removed job from database'
+          Cuetip.logger.debug 'Removed job from database'
         end
 
       end
@@ -61,74 +61,78 @@ module Cuetip
       # Log some text about this job
       #
       # @param text [String]
-      def log(text)
-        Cuetip.logger.info "[#{id}] #{text}"
+      def log(text, **tags)
+        Cuetip.logger.info text, **tags
       end
 
       # Execute the job
       #
       # @return [Boolean] whether the job executed successfully or not
       def execute(&block)
-        log "Beginning execution of job #{id} with #{class_name}"
-        # Initialize a new instance of the job we wish to execute
-        job_klass = class_name.constantize.new(self)
-
-        # If the job has expired, we should not be executing this so we'll just
-        # remove it from the queue and mark it as expired.
-        if expired?
-          log 'Job has expired'
-          self.status = 'Expired'
-          remove_from_queue
-          Cuetip.config.emit(:expired, self, job_klass)
-          return false
-        end
+        Klogger.tagged(job_id: id, job_class: class_name) do
+          begin
+          Cuetip.logger.info "Executing"
+          # Initialize a new instance of the job we wish to execute
+          job_klass = class_name.constantize.new(self)
+
+          # If the job has expired, we should not be executing this so we'll just
+          # remove it from the queue and mark it as expired.
+          if expired?
+            Cuetip.logger.warn 'Job has expired, removed from queue'
+            self.status = 'Expired'
+            remove_from_queue
+            Cuetip.config.emit(:expired, self, job_klass)
+            return false
+          end
 
-        Cuetip.config.emit(:before_perform, self, job_klass)
+          Cuetip.config.emit(:before_perform, self, job_klass)
 
-        # If we have a block, call this so we can manipulate our actual job class
-        # before execution if needed (mostly for testing)
-        block.call(job_klass) if block_given?
+          # If we have a block, call this so we can manipulate our actual job class
+          # before execution if needed (mostly for testing)
+          block.call(job_klass) if block_given?
 
-        # Mark the job as runnign
-        update!(status: 'Running', started_at: Time.now, executions: executions + 1)
+          # Mark the job as runnign
+          update!(status: 'Running', started_at: Time.now, executions: executions + 1)
 
-        begin
-          # Perform the job within a timeout
-          Timeout.timeout(maximum_execution_time || 1.year) do
-            job_klass.perform
-          end
-          # Mark the job as complete and remove it from the queue
-          self.status = 'Complete'
-          log 'Job completed successfully'
-          remove_from_queue
-
-          Cuetip.config.emit(:completed, self, job_klass)
-
-          true
-        rescue Exception, Timeout::TimeoutError => e
-          log "Job failed with #{e.class} (#{e.message})"
-
-          # If there's an error, mark the job as failed and copy exception
-          # data into the job
-          self.status = 'Failed'
-          self.exception_class = e.class.name
-          self.exception_message = e.message
-          self.exception_backtrace = e.backtrace.join("\n")
-
-          # Handle requeing the job if needed.
-          if requeue_on_failure?
-            # Requeue this job for execution again after the retry interval.
-            new_job = queued_job.requeue(run_after: Time.now + retry_interval.to_i)
-            log "Requeing job to run after #{new_job.run_after.to_s(:long)}"
-            self.status = 'Pending'
-          else
-            # We're done with this job. We can't do any more retries.
-            remove_from_queue
-          end
+          begin
+            # Perform the job within a timeout
+            Timeout.timeout(maximum_execution_time || 1.year) do
+              job_klass.perform
+            end
 
-          Cuetip.config.emit(:exception, e, self, job_klass)
+            # Mark the job as complete and remove it from the queue
+            self.status = 'Complete'
+            Cuetip.logger.info 'Execution complete'
+            remove_from_queue
 
-          false
+            Cuetip.config.emit(:completed, self, job_klass)
+
+            true
+          rescue Exception, Timeout::TimeoutError => e
+            Cuetip.logger.exception(e, "Job failed")
+
+            # If there's an error, mark the job as failed and copy exception
+            # data into the job
+            self.status = 'Failed'
+            self.exception_class = e.class.name
+            self.exception_message = e.message
+            self.exception_backtrace = e.backtrace.join("\n")
+
+            # Handle requeing the job if needed.
+            if requeue_on_failure?
+              # Requeue this job for execution again after the retry interval.
+              new_job = queued_job.requeue(run_after: Time.now + retry_interval.to_i)
+              Cuetip.logger.info "Requeueing job", run_after: new_job.run_after.to_s(:long)
+              self.status = 'Pending'
+            else
+              # We're done with this job. We can't do any more retries.
+              remove_from_queue
+            end
+
+            Cuetip.config.emit(:exception, e, self, job_klass)
+
+            false
+          end
         end
       ensure
         unless destroyed?
@@ -136,8 +140,9 @@ module Cuetip
           save!
         end
         Cuetip.config.emit(:finished, self, job_klass)
-        log 'Finished processing'
+        Cuetip.logger.debug 'Finished processing'
       end
     end
+    end
   end
 end

data/lib/cuetip/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Cuetip
-  VERSION = '1.4.1'
+  VERSION = '2.0.1'
 end

data/lib/cuetip/worker_group.rb

@@ -6,6 +6,7 @@ module Cuetip
   class WorkerGroup
     include ActiveSupport::Callbacks
 
+    define_callbacks :run_worker_group
     define_callbacks :run_worker
 
     attr_reader :quantity
@@ -20,30 +21,36 @@ module Cuetip
     end
 
     def start
-      Cuetip.logger.info "Starting #{@quantity} Cuetip workers"
-      if @queues.any?
-        @queues.each { |q| Cuetip.logger.info "-> Joined queue: #{q.to_s}" }
-      end
-
-      exit_trap = proc do
-        @workers.each { |_, worker| worker.request_exit! }
-        puts 'Exiting...'
-      end
+      Klogger.tagged(pid: Process.pid) do
+        Cuetip.logger.info "Starting workers", quantity: @quantity
+        if @queues.any?
+          @queues.each { |q| Cuetip.logger.info "Joined queue", queue: q }
+        end
 
-      trap('INT', &exit_trap)
-      trap('TERM', &exit_trap)
+        exit_trap = proc do
+          @workers.each { |_, worker| worker.request_exit! }
+          puts 'Exiting...'
+        end
 
-      @quantity.times do |i|
-        @workers[i] = Worker.new(self, i, @queues)
-        Cuetip.logger.info "-> Starting worker #{i}"
-        @threads[i] = Thread.new(@workers[i]) do |worker|
-          run_callbacks :run_worker do
-            worker.run
+        trap('INT', &exit_trap)
+        trap('TERM', &exit_trap)
+
+        run_callbacks :run_worker_group do
+          @quantity.times do |i|
+            @workers[i] = Worker.new(self, i, @queues)
+            Klogger.tagged worker_index: i do
+              Cuetip.logger.info "Starting worker"
+              @threads[i] = Thread.new(@workers[i]) do |worker|
+                run_callbacks :run_worker do
+                  worker.run
+                end
+              end
+            end
+            @threads[i].abort_on_exception = true
           end
+          @threads.values.each(&:join)
         end
-        @threads[i].abort_on_exception = true
       end
-      @threads.values.each(&:join)
     end
 
     def set_process_name

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cuetip
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 2.0.1
 platform: ruby
 authors:
 - Adam Cooke
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-12-11 00:00:00.000000000 Z
+date: 2023-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -38,6 +38,26 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: klogger-logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 description: An ActiveRecord job queueing system
 email:
 - me@adamcooke.io
@@ -66,7 +86,7 @@ homepage: https://github.com/adamcooke/cuetip
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -81,8 +101,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.4.6
+signing_key:
 specification_version: 4
 summary: An ActiveRecord job queueing system
 test_files: []