skiplock 1.0.23 → 1.0.24

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 275e1ddd1a59648e86378889e2e2cc6a4e22943a3fb4211209f20a674744b1b3
-  data.tar.gz: 7327f5893f36cc4b05163cfd0df47992344b2ca6b97c2ef10ca4f00b219a9ac9
+  metadata.gz: a43b01cedd94ea395b0b173e2da3c5c7ab0baf6ccbd35e599127544084ca5589
+  data.tar.gz: a908c4eea5b2b75727a70fe5efc248f0b0183e9fe97a37c068b185b9f259a4ba
 SHA512:
-  metadata.gz: e9b8afd563ec4ff46838e73ae031a75a69142ee392a05d0e5b612008153b10a6a62a931e22643e817722d0017548573f9cafed6ba943f41da3cf8d0872d76481
-  data.tar.gz: 8b04173649d9e4a21edb9d47e23d37d5c8d0b08ba8658f46c0fd8341270abf1148a2131e3f57251421caf024d5ce8d9bfb35a648ee9a904f999d6b21bf0fe5ec
+  metadata.gz: c5ae8b9bd79e37426710d707fadd2e4d658e541ffdd109a760687f2c14dacfa9d61614130d25be801264ecee86ea63d54ce4d6604c4cc80c7a47ac31752618f6
+  data.tar.gz: 42ba6d9047ac028c24389d1915f686f5d553751244bd557a98a8b28af311a53702d6c69078abafcb6696d5d00e441fd8eca43d2e18b11530945fa10a42d15cea

data/README.md

@@ -50,12 +50,14 @@ The library is quite small compared to other PostgreSQL job queues (eg. *delay_j
     ```yaml
     # config/skiplock.yml (default settings)
     ---
+    graceful_shutdown: 15
     min_threads: 1
     max_threads: 10
     max_retries: 20
     logfile: skiplock.log
     loglevel: info
     notification: custom
+    actioncable: false
     extensions: false
     purge_completion: true
     queues:
@@ -64,12 +66,14 @@ The library is quite small compared to other PostgreSQL job queues (eg. *delay_j
     workers: 0
     ```
     Available configuration options are:
+    - **graceful_shutdown** (*integer*): sets the number of seconds to wait for jobs to finish before being killed during shutdown
     - **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`)
     - **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
+    - **actioncable** (*boolean*): enable or disable usage of ActionCable notification
     - **extensions** (*multi*): enable or disable the class method extension.  See `ClassMethod extension` for more details
     - **purge_completion** (*boolean*): when set to **true** will delete jobs after they were completed successfully; if set to **false** then the completed jobs should be purged periodically to maximize performance (eg. clean up old jobs after 3 months); queued jobs can manually override using `purge` option
     - **queues** (*hash*): defines the set of queues with priorities; lower priority takes precedence
@@ -83,6 +87,7 @@ The library is quite small compared to other PostgreSQL job queues (eg. *delay_j
     ```
     $ bundle exec skiplock -h
     Usage: skiplock [options]
+      -a, --actioncable YESNO          Actioncable notification
       -e, --environment STRING         Rails environment
       -l, --logfile STRING             Log filename
       -L, --loglevel STRING            Log level (debug, info, warn, error, fatal, unknown)
@@ -238,6 +243,10 @@ Code examples of gathering counters information:
     ```ruby
     Skiplock::Counter.sum(:expiries)
     ```
+  - get all information in one query
+    ```ruby
+    Skiplock::Counter.pluck("sum(completions), sum(dispatches), sum(expiries), sum(failures), sum(retries)").first
+    ```
 
 ## Contributing
 

data/bin/skiplock

@@ -5,6 +5,7 @@ options = {}
 begin
   op = OptionParser.new do |opts|
     opts.banner = "Usage: #{File.basename($0)} [options]"
+    opts.on('-a', '--actioncable YESNO', TrueClass, 'Actioncable notification')
     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)')

data/lib/skiplock/cron.rb

@@ -19,6 +19,7 @@ module Skiplock
       query = Job.where('cron IS NOT NULL')
       query = query.where('job_class NOT IN (?)', cronjobs) if cronjobs.count > 0
       query.delete_all
+    rescue
     end
 
     def self.next_schedule_at(cron)

data/lib/skiplock/manager.rb

@@ -10,6 +10,7 @@ module Skiplock
       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)
       (caller.any?{ |l| l =~ %r{/rack/} } && @config[:workers] == 0) ? async : Cron.setup
     end
 
@@ -17,7 +18,7 @@ module Skiplock
       setup_logger
       configure
       Worker.cleanup(@hostname)
-      @worker = Worker.generate(capacity: @config[:max_threads], hostname: @hostname)
+      @worker = Worker.generate(capacity: @config[:max_threads], hostname: @hostname, actioncable: @config[:actioncable])
       Cron.setup if @worker.master
       @worker.start(**@config)
       at_exit { @worker.shutdown }
@@ -39,13 +40,13 @@ module Skiplock
       Signal.trap('TERM') { @shutdown = true }
       Signal.trap('HUP') { setup_logger }
       Worker.cleanup(@hostname)
-      @worker = Worker.generate(capacity: @config[:max_threads], hostname: @hostname)
+      @worker = Worker.generate(capacity: @config[:max_threads], hostname: @hostname, actioncable: @config[:actioncable])
       ActiveRecord::Base.connection.disconnect! if @config[:workers] > 1
       (@config[:workers] - 1).times do |n|
         fork do
           sleep(0.25*n + 1)
           ActiveRecord::Base.establish_connection
-          worker = Worker.generate(capacity: @config[:max_threads], hostname: @hostname, master: false)
+          worker = Worker.generate(capacity: @config[:max_threads], hostname: @hostname, master: false, actioncable: @config[:actioncable])
           worker.start(worker_num: n + 1, **@config)
           loop do
             sleep 0.5
@@ -75,24 +76,25 @@ module Skiplock
       @logger.info "-"*(title.length)
       @logger.info title
       @logger.info "-"*(title.length)
-      @logger.info "ClassMethod extensions: #{@config[:extensions]}"
-      @logger.info "      Purge completion: #{@config[:purge_completion]}"
-      @logger.info "          Notification: #{@config[:notification]}"
-      @logger.info "           Max retries: #{@config[:max_retries]}"
-      @logger.info "           Min threads: #{@config[:min_threads]}"
-      @logger.info "           Max threads: #{@config[:max_threads]}"
-      @logger.info "           Environment: #{Rails.env}"
-      @logger.info "              Loglevel: #{@config[:loglevel]}"
-      @logger.info "               Logfile: #{@config[:logfile] || '(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}"
+      @logger.info "ActionCable notification: #{@config[:actioncable]}#{' (not available)' unless defined?(ActionCable)}"
+      @logger.info "  ClassMethod extensions: #{@config[:extensions]}"
+      @logger.info "        Purge completion: #{@config[:purge_completion]}"
+      @logger.info "            Notification: #{@config[:notification]}"
+      @logger.info "             Max retries: #{@config[:max_retries]}"
+      @logger.info "             Min threads: #{@config[:min_threads]}"
+      @logger.info "             Max threads: #{@config[:max_threads]}"
+      @logger.info "             Environment: #{Rails.env}"
+      @logger.info "                Loglevel: #{@config[:loglevel]}"
+      @logger.info "                 Logfile: #{@config[:logfile] || '(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}"
       @logger.info "-"*(title.length)
       @logger.warn "[Skiplock] Custom notification has no registered 'on_error' callback" if Skiplock.on_errors.count == 0
     end
 
     def configure
-      @hostname = Socket.ip_address_list.reject(&:ipv4_loopback?).reject(&:ipv6?).map(&:ip_address).join('|')
+      @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
       @config[:graceful_shutdown] = nil if @config[:graceful_shutdown] < 0
@@ -133,6 +135,7 @@ module Skiplock
       else
         @config[:notification] = 'custom'
       end
+      @logger.error 'ActionCable is not found!' if @config[:actioncable] && !defined?(ActionCable)
       Skiplock.on_errors.freeze
     end
 

data/lib/skiplock/version.rb

@@ -1,4 +1,4 @@
 module Skiplock
-  VERSION = Version = '1.0.23'
+  VERSION = Version = '1.0.24'
 end
 

data/lib/skiplock/worker.rb

@@ -12,16 +12,19 @@ module Skiplock
       self.where(id: delete_ids).delete_all if delete_ids.count > 0
     end
 
-    def self.generate(capacity:, hostname:, master: true)
-      self.create!(pid: Process.pid, sid: Process.getsid(), master: master, hostname: hostname, capacity: capacity)
+    def self.generate(capacity:, hostname:, master: true, actioncable: false)
+      worker = self.create!(pid: Process.pid, sid: Process.getsid(), master: master, hostname: hostname, capacity: capacity)
     rescue
-      self.create!(pid: Process.pid, sid: Process.getsid(), master: false, hostname: hostname, capacity: capacity)
+      worker = self.create!(pid: Process.pid, sid: Process.getsid(), master: false, hostname: hostname, capacity: capacity)
+    ensure
+      ActionCable.server.broadcast('skiplock', { worker: { op: 'CREATE', id: worker.id, hostname: worker.hostname, master: worker.master, capacity: worker.capacity, pid: worker.pid, sid: worker.sid, created_at: worker.created_at.to_f, updated_at: worker.updated_at.to_f } }) if actioncable && defined?(ActionCable)
     end
 
     def shutdown
       @running = false
       @executor.shutdown
       @executor.kill unless @executor.wait_for_termination(@config[:graceful_shutdown])
+      ActionCable.server.broadcast('skiplock', { worker: { op: 'DELETE', id: self.id, hostname: self.hostname, master: self.master, capacity: self.capacity, pid: self.pid, sid: self.sid, created_at: self.created_at.to_f, updated_at: self.updated_at.to_f } }) if @config[:actioncable] && defined?(ActionCable)
       self.delete
       Skiplock.logger.info "[Skiplock] Shutdown of #{self.master ? 'master' : 'cluster'} worker#{(' ' + @num.to_s) if @num > 0 && @config[:workers] > 2} (PID: #{self.pid}) was completed."
     end
@@ -32,7 +35,15 @@ module Skiplock
       @pg_config = ActiveRecord::Base.connection.raw_connection.conninfo_hash.compact
       @queues_order_query = @config[:queues].map { |q,v| "WHEN queue_name = '#{q}' THEN #{v}" }.join(' ') if @config[:queues].is_a?(Hash) && @config[:queues].count > 0
       @running = true
-      @executor = Concurrent::ThreadPoolExecutor.new(min_threads: @config[:min_threads] + 1, max_threads: @config[:max_threads] + 1, max_queue: @config[:max_threads] + 1, idletime: 60, auto_terminate: true, fallback_policy: :abort)
+      @map = ::PG::TypeMapByOid.new
+      @map.add_coder(::PG::TextDecoder::Boolean.new(oid: 16, name: 'bool'))
+      @map.add_coder(::PG::TextDecoder::Integer.new(oid: 20, name: 'int8'))
+      @map.add_coder(::PG::TextDecoder::Integer.new(oid: 21, name: 'int2'))
+      @map.add_coder(::PG::TextDecoder::Integer.new(oid: 23, name: 'int4'))
+      @map.add_coder(::PG::TextDecoder::TimestampUtc.new(oid: 1114, name: 'timestamp'))
+      @map.add_coder(::PG::TextDecoder::String.new(oid: 2950, name: 'uuid'))
+      @map.add_coder(::PG::TextDecoder::JSON.new(oid: 3802, name: 'jsonb'))
+      @executor = Concurrent::ThreadPoolExecutor.new(min_threads: @config[:min_threads] + 1, max_threads: @config[:max_threads] + 1, max_queue: @config[:max_threads] + 1, idletime: 60, auto_terminate: false, fallback_policy: :abort)
       @executor.post { run }
       if @config[:standalone]
         Process.setproctitle("skiplock: #{self.master ? 'master' : 'cluster'} worker#{(' ' + @num.to_s) if @num > 0 && @config[:workers] > 2} [#{Rails.application.class.name.deconstantize.downcase}:#{Rails.env}]")
@@ -43,17 +54,10 @@ module Skiplock
     private
 
     def establish_connection
-      map = ::PG::TypeMapByOid.new
-      map.add_coder(::PG::TextDecoder::Boolean.new(oid: 16, name: 'bool'))
-      map.add_coder(::PG::TextDecoder::Integer.new(oid: 20, name: 'int8'))
-      map.add_coder(::PG::TextDecoder::Integer.new(oid: 21, name: 'int2'))
-      map.add_coder(::PG::TextDecoder::Integer.new(oid: 23, name: 'int4'))
-      map.add_coder(::PG::TextDecoder::TimestampUtc.new(oid: 1114, name: 'timestamp'))
-      map.add_coder(::PG::TextDecoder::String.new(oid: 2950, name: 'uuid'))
-      map.add_coder(::PG::TextDecoder::JSON.new(oid: 3802, name: 'jsonb'))
       @connection = ::PG.connect(@pg_config)
-      @connection.type_map_for_results = map
+      @connection.type_map_for_results = @map
       @connection.exec('LISTEN "skiplock::jobs"').clear
+      @connection.exec('LISTEN "skiplock::workers"').clear
     end
 
     def run
@@ -85,19 +89,26 @@ module Skiplock
                 next_schedule_at = (result ? result['scheduled_at'].to_f : Float::INFINITY)
               end
             end
-            job_notifications = []
+            notifications = { 'skiplock::jobs' => [], 'skiplock::workers' => [] }
             @connection.wait_for_notify(0.2) do |channel, pid, payload|
-              job_notifications << payload if payload
+              notifications[channel] << payload if payload
               loop do
                 payload = @connection.notifies
                 break unless @running && payload
-                job_notifications << payload[:extra]
+                notifications[payload[:relname]] << payload[:extra]
               end
-              job_notifications.each do |n|
+              notifications['skiplock::jobs'].each do |n|
                 op, id, worker_id, job_class, queue_name, running, expired_at, finished_at, scheduled_at = n.split(',')
+                ActionCable.server.broadcast('skiplock', { job: { op: op, id: id, worker_id: worker_id, job_class: job_class, queue_name: queue_name, running: (running == 'true'), expired_at: expired_at.to_f, finished_at: finished_at.to_f, scheduled_at: scheduled_at.to_f } }) if self.master && @config[:actioncable] && defined?(ActionCable)
                 next if op == 'DELETE' || running == 'true' || expired_at.to_f > 0 || finished_at.to_f > 0
                 next_schedule_at = scheduled_at.to_f if scheduled_at.to_f < next_schedule_at
               end
+              if self.master && @config[:actioncable] && defined?(ActionCable)
+                notifications['skiplock::workers'].each do |w|
+                  op, id, hostname, master, capacity, pid, sid, created_at, updated_at = w.split(',')
+                  ActionCable.server.broadcast('skiplock', { worker: { op: op, id: id, hostname: hostname, master: (master == 'true'), capacity: capacity.to_i, pid: pid.to_i, sid: sid.to_i, created_at: created_at.to_f, updated_at: updated_at.to_f } })
+                end
+              end
             end
             if Process.clock_gettime(Process::CLOCK_MONOTONIC) - timestamp > 60
               @connection.exec("UPDATE skiplock.workers SET updated_at = NOW() WHERE id = '#{self.id}'").clear

data/lib/skiplock.rb

@@ -11,7 +11,7 @@ require 'skiplock/worker'
 require 'skiplock/version'
 
 module Skiplock
-  DEFAULT_CONFIG = { 'extensions' => false, 'logfile' => 'skiplock.log', 'loglevel' => 'info', 'graceful_shutdown' => 15, 'min_threads' => 1, 'max_threads' => 10, 'max_retries' => 20, 'notification' => 'custom', '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, 'logfile' => 'skiplock.log', 'loglevel' => 'info', 'notification' => 'custom', 'actioncable' => false, 'extensions' => false, 'purge_completion' => true, 'queues' => { 'default' => 100, 'mailers' => 999 }, 'workers' => 0 }.freeze
 
   def self.logger=(l)
     @logger = l
@@ -34,5 +34,4 @@ module Skiplock
   def self.table_name_prefix
     'skiplock.'
   end
-end
-ActiveJob::Base.__send__(:include, Skiplock::Patch)
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: skiplock
 version: !ruby/object:Gem::Version
-  version: 1.0.23
+  version: 1.0.24
 platform: ruby
 authors:
 - Tin Vo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-18 00:00:00.000000000 Z
+date: 2021-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob