skiplock 1.1.5 → 1.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 251899d30b6c22a82be564d61da33bca7734fd67516eec5d6cc122ebde93ccaa
-  data.tar.gz: fa090c287d2f3fcbe03a45a324832d4d5a1fa800e26c26deb40091789c712df5
+  metadata.gz: 2ff56b97e28d0f5b162dfb538e33461569af6aa19ba062a85d7efb4ad0d129f2
+  data.tar.gz: 32472f59ee0ed8422fadfa52bb4cb59a15518c0211d58f562006748e30a1d72c
 SHA512:
-  metadata.gz: bd62845a436ea37e27da889beecec6f2b16b4d3be745c3d336da4a3a9aacf34867e586e9ecb186e816e9784969dfee754d1fccb3e0ba8dedb8d63fada1eb9304
-  data.tar.gz: ef58e25457ac5ef98c385d122ca3252b161ddf62a589cfefb04286aaec5c2def0f52b6b334e554e8451adfe044f7be7c010a00d9c42a801731e6a7a6b3c5836d
+  metadata.gz: 3b1a4e1314d300ae26e93f77256c6d543d46a425a44ab12d20b07e6c14e5d8d070db8cab532e6fd0fcb0b636fdde7cbee78aff65651e2ee9694b2eab03bfc276
+  data.tar.gz: e549e1db28766922325f8ef7b3b59e205df5bc6a6a5b3ca5b40899861c6baf732d973144aa0de2a09bc4d0fa42dc2fe3ec45958696fbbcb93fd60a8bc8b866cc

data/README.md

@@ -54,8 +54,10 @@ The library is quite small compared to other PostgreSQL job queues (eg. *delay_j
     min_threads: 1
     max_threads: 10
     max_retries: 20
-    logfile: skiplock.log
-    loglevel: info
+    log_file: skiplock.log
+    log_level: info
+    log_count: 5
+    log_size: 10485760
     namespace:
     notification: custom
     extensions: false
@@ -70,8 +72,10 @@ The library is quite small compared to other PostgreSQL job queues (eg. *delay_j
     - **min_threads** (*integer*): sets minimum number of threads staying idle
     - **max_threads** (*integer*): sets the maximum number of threads allowed to run jobs
     - **max_retries** (*integer*): sets the maximum attempt a job will be retrying before it is marked expired.  See `Retry system` for more details
-    - **logfile** (*string*): filename for skiplock logs; empty logfile will disable logging
-    - **loglevel** (*string*): sets logging level (`debug, info, warn, error, fatal, unknown`)
+    - **log_file** (*string*): filename for skiplock logs; empty logfile will disable logging
+    - **log_level** (*string*): sets logging level (`debug, info, warn, error, fatal, unknown`)
+    - **log_count** (*integer*): number of log files to keep (ie: log rotation)
+    - **log_size** (*integer*): maximum size per log file (in bytes)
     - **namespace** (*string*): sets namespace for jobs (workers will only process jobs of specified namespace)
     - **notification** (*string*): sets the library to be used for notifying errors and exceptions (`auto, airbrake, bugsnag, exception_notification, custom`); using `auto` will detect library if available.  See `Notification system` for more details
     - **extensions** (*multi*): enable or disable the class method extension.  See `ClassMethod extension` for more details

data/bin/skiplock

@@ -6,8 +6,10 @@ begin
   op = OptionParser.new do |opts|
     opts.banner = "Usage: #{File.basename($0)} [options]"
     opts.on('-e', '--environment STRING', String, 'Rails environment')
-    opts.on('-l', '--logfile STRING', String, 'Log filename')
-    opts.on('-L', '--loglevel STRING', String, 'Log level (debug, info, warn, error, fatal, unknown)')
+    opts.on('-l', '--log-file STRING', String, 'Log filename')
+    opts.on('-L', '--log-level STRING', String, 'Log level (debug, info, warn, error, fatal, unknown)')
+    opts.on('-m', '--log-count NUM', Integer, 'Log maximum count (default = 5)')
+    opts.on('-M', '--log-size NUM', Integer, 'Log maximum size (in bytes, default = 10485760)')
     opts.on('-n', '--namespace STRING', String, 'Job namespace')
     opts.on('-s', '--graceful-shutdown NUM', Integer, 'Number of seconds to wait for graceful shutdown')
     opts.on('-r', '--max-retries NUM', Integer, 'Number of maxixum retries')

data/lib/skiplock/cron.rb

@@ -3,6 +3,7 @@ module Skiplock
   class Cron
     def self.setup
       cronjobs = []
+      Rails.application.eager_load!
       ActiveJob::Base.descendants.each do |j|
         next unless j.const_defined?('CRON')
         cron = j.const_get('CRON')

data/lib/skiplock/job.rb

@@ -108,7 +108,6 @@ module Skiplock
     def execute(purge_completion: true, max_retries: 20)
       raise 'Job has already been completed' if self.finished_at
       self.update_columns(running: true, updated_at: Time.now) unless self.running
-      Skiplock.logger.info("[Skiplock] Performing #{self.job_class} (#{self.id}) from queue '#{self.queue_name || 'default'}'...") if Skiplock.logger
       self.data ||= {}
       self.data.delete('result')
       self.exception_executions ||= {}
@@ -141,7 +140,6 @@ module Skiplock
             target, method_name = ::YAML.load(self.data['arguments'].first)
             job_name = "'#{target.name}.#{method_name}'"
           end
-          Skiplock.logger.info "[Skiplock] Performed #{job_name} (#{self.id}) from queue '#{self.queue_name || 'default'}' in #{end_time - start_time} seconds"
         end
       end
       self.exception || self.activejob_error || self.data['result']

data/lib/skiplock/manager.rb

@@ -4,15 +4,7 @@ module Skiplock
       @config = Skiplock::DEFAULT_CONFIG.dup
       @config.merge!(YAML.load_file('config/skiplock.yml')) rescue nil
       @config.symbolize_keys!
-      Rails.application.eager_load! if Rails.env.development?
-      if @config[:extensions] == true
-        Module.__send__(:include, Skiplock::Extension)
-      elsif @config[:extensions].is_a?(Array)
-        @config[:extensions].each { |n| n.constantize.__send__(:extend, Skiplock::Extension) if n.safe_constantize }
-      end
-      ActiveJob::Base.__send__(:include, Skiplock::Patch)
-      Skiplock.namespace = @config[:namespace]
-      (caller.any?{ |l| l =~ %r{/rack/} } && @config[:workers] == 0) ? async : Cron.setup
+      async if (caller.any?{ |l| l =~ %r{/rack/} } && @config[:workers] == 0)
     end
 
     def async
@@ -85,8 +77,12 @@ module Skiplock
       @logger.info "             Max threads: #{@config[:max_threads]}"
       @logger.info "             Environment: #{Rails.env}"
       @logger.info "               Namespace: #{@config[:namespace] || '(nil)'}"
-      @logger.info "                Loglevel: #{@config[:loglevel]}"
-      @logger.info "                 Logfile: #{@config[:logfile] || '(disabled)'}"
+      @logger.info "               Log level: #{@config[:log_level]}"
+      if @config[:log_file]
+        @logger.info "               Log count: #{@config[:log_count]}"
+        @logger.info "                Log size: #{@config[:log_size]}"
+      end
+      @logger.info "                Log file: #{@config[:log_file] || '(disabled)'}"
       @logger.info "                 Workers: #{@config[:workers]}"
       @logger.info "                  Queues: #{@config[:queues].map {|k,v| k + '(' + v.to_s + ')'}.join(', ')}" if @config[:queues].is_a?(Hash)
       @logger.info "                     PID: #{Process.pid}"
@@ -95,6 +91,13 @@ module Skiplock
     end
 
     def configure
+      if @config[:extensions] == true
+        Module.__send__(:include, Skiplock::Extension)
+      elsif @config[:extensions].is_a?(Array)
+        @config[:extensions].each { |n| n.constantize.__send__(:extend, Skiplock::Extension) if n.safe_constantize }
+      end
+      ActiveJob::Base.__send__(:include, Skiplock::Patch)
+      Skiplock.namespace = @config[:namespace]
       @hostname = "#{`hostname -f`.strip}|#{Socket.ip_address_list.reject(&:ipv4_loopback?).reject(&:ipv6?).map(&:ip_address).join('|')}"
       @config.transform_values! {|v| v.is_a?(String) ? v.downcase : v}
       @config[:graceful_shutdown] = 300 if @config[:graceful_shutdown] > 300
@@ -140,21 +143,21 @@ module Skiplock
     end
 
     def setup_logger
-      @config[:loglevel] = 'info' unless ['debug','info','warn','error','fatal','unknown'].include?(@config[:loglevel].to_s)
+      @config[:log_level] = 'info' unless ['debug','info','warn','error','fatal','unknown'].include?(@config[:log_level].to_s)
       if defined?(ActiveSupport::BroadcastLogger)
         @logger = ActiveSupport::BroadcastLogger.new(::Logger.new(STDOUT))
       else
         @logger = ActiveSupport::Logger.new(STDOUT)
       end
-      @logger.level = @config[:loglevel].to_sym
+      @logger.level = @config[:log_level].to_sym
       Skiplock.logger = @logger
-      if @config[:logfile].to_s.length > 0
+      if @config[:log_file].to_s.length > 0
         if defined?(ActiveSupport::BroadcastLogger)
-          @logger.broadcast_to(::Logger.new(File.join(Rails.root, 'log', @config[:logfile].to_s), 'daily'))
+          @logger.broadcast_to(::Logger.new(File.join(Rails.root, 'log', @config[:log_file].to_s), @config[:log_count] || 5, @config[:log_size] || 10485760))
         else
-          @logger.extend(ActiveSupport::Logger.broadcast(::Logger.new(File.join(Rails.root, 'log', @config[:logfile].to_s), 'daily')))
+          @logger.extend(ActiveSupport::Logger.broadcast(::Logger.new(File.join(Rails.root, 'log', @config[:log_file].to_s), @config[:log_count] || 5, @config[:log_size] || 10485760)))
         end
-        ActiveJob::Base.logger = nil
+        ActiveJob::Base.logger = @logger
       end
       if @config[:standalone]
         if defined?(ActiveSupport::BroadcastLogger)

data/lib/skiplock/version.rb

@@ -1,4 +1,3 @@
 module Skiplock
-  VERSION = Version = '1.1.5'
+  VERSION = Version = '1.1.8'
 end
-

data/lib/skiplock.rb

@@ -11,7 +11,7 @@ require 'skiplock/worker'
 require 'skiplock/version'
 
 module Skiplock
-  DEFAULT_CONFIG = { 'graceful_shutdown' => 15, 'min_threads' => 1, 'max_threads' => 10, 'max_retries' => 20, 'logfile' => 'skiplock.log', 'loglevel' => 'info', 'namespace' => nil, 'notification' => 'custom', 'extensions' => false, 'purge_completion' => true, 'queues' => { 'default' => 100, 'mailers' => 999 }, 'workers' => 0 }.freeze
+  DEFAULT_CONFIG = { 'graceful_shutdown' => 15, 'min_threads' => 1, 'max_threads' => 10, 'max_retries' => 20, 'log_file' => 'skiplock.log', 'log_level' => 'info', 'log_count' => 5, 'log_size' => 10485760, 'namespace' => nil, 'notification' => 'custom', 'extensions' => false, 'purge_completion' => true, 'queues' => { 'default' => 100, 'mailers' => 999 }, 'workers' => 0 }.freeze
 
   def self.logger=(l)
     @logger = l

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: skiplock
 version: !ruby/object:Gem::Version
-  version: 1.1.5
+  version: 1.1.8
 platform: ruby
 authors:
 - Tin Vo
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-12 00:00:00.000000000 Z
+date: 2024-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob
@@ -94,7 +94,7 @@ homepage: https://github.com/vtt/skiplock
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -109,8 +109,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
-signing_key: 
+rubygems_version: 3.5.16
+signing_key:
 specification_version: 4
 summary: ActiveJob Queue Adapter for PostgreSQL
 test_files: []