skiplock 1.0.18 → 1.0.23

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8112589dcbdf58a743529ec9bf5ddd8371791e83e79c0d455ed42cbca05ee5eb
-  data.tar.gz: 149f826e93ecd8ac6165a8db46a8e7e234636a4481e68bf09d208b04a1dea1ce
+  metadata.gz: 275e1ddd1a59648e86378889e2e2cc6a4e22943a3fb4211209f20a674744b1b3
+  data.tar.gz: 7327f5893f36cc4b05163cfd0df47992344b2ca6b97c2ef10ca4f00b219a9ac9
 SHA512:
-  metadata.gz: 437f622f2398a0a6c965ea1720f77f11b9241373f277e249e4f3d39afbd3bccc7d8ad2b919abd141ebc5bc6a2543408a7940e53f2968c3cda9fc0519ac387910
-  data.tar.gz: '0473939dc2497842ff66fb02e2f74371f7281d58cc5ac82f1999b669f5b45e526d5d75054a3cc95594e26fc5f4e4aafc42e15d2f7336b88223256d6f7ac46d4e'
+  metadata.gz: e9b8afd563ec4ff46838e73ae031a75a69142ee392a05d0e5b612008153b10a6a62a931e22643e817722d0017548573f9cafed6ba943f41da3cf8d0872d76481
+  data.tar.gz: 8b04173649d9e4a21edb9d47e23d37d5c8d0b08ba8658f46c0fd8341270abf1148a2131e3f57251421caf024d5ce8d9bfb35a648ee9a904f999d6b21bf0fe5ec

data/README.md

@@ -85,6 +85,7 @@ The library is quite small compared to other PostgreSQL job queues (eg. *delay_j
     Usage: skiplock [options]
       -e, --environment STRING         Rails environment
       -l, --logfile STRING             Log filename
+      -L, --loglevel STRING            Log level (debug, info, warn, error, fatal, unknown)
       -s, --graceful-shutdown NUM      Number of seconds to wait for graceful shutdown
       -r, --max-retries NUM            Number of maxixum retries
       -t, --max-threads NUM            Number of maximum threads
@@ -172,14 +173,10 @@ If the `retry_on` block is not defined, then the built-in retry system of `Skipl
 `Skiplock` can use existing exception notification library to notify errors and exceptions.  It supports `airbrake`, `bugsnag`, and `exception_notification`.  Custom notification can also be called whenever an exception occurs; it can be configured in an initializer like below:
 ```ruby
   # config/initializers/skiplock.rb
-  Skiplock.on_error do |ex, previous|
-    if ex.backtrace != previous.try(:backtrace)
-      # sends text message using Amazon SNS on new exceptions only
-      # the same repeated exceptions will only be sent once to avoid SPAM
-      # NOTE: exceptions generated from Job executions will not provide 'previous' exceptions
-      sms = Aws::SNS::Client.new(region: 'us-west-2', access_key_id: Rails.application.credentials[:aws][:access_key_id], secret_access_key: Rails.application.credentials[:aws][:secret_access_key])
-      sms.publish({ phone_number: '+122233334444', message: "Exception: #{ex.message}"[0..130] })
-    end
+  Skiplock.on_error do |ex|
+    # sends text message using Amazon SNS
+    sms = Aws::SNS::Client.new(region: 'us-west-2', access_key_id: Rails.application.credentials[:aws][:access_key_id], secret_access_key: Rails.application.credentials[:aws][:secret_access_key])
+    sms.publish(phone_number: '+12223334444', message: "Exception: #{ex.message}"[0..130])
   end
   # supports multiple 'on_error' event callbacks
 ```
@@ -201,9 +198,9 @@ To enable extension for specific classes and modules only then set the configura
   ```ruby
   Session.skiplock(wait: 5.minutes, queue: 'maintenance').cleanup
   ```
-- Queue class method `charge` of class `Subscription` as background job to run tomorrow at noon
+- Queue class method `charge` of class `Subscription` as background job to run tomorrow at noon without purging
   ```ruby
-  Subscription.skiplock(wait_until: Date.tomorrow.noon).charge(amount: 100)
+  Subscription.skiplock(purge: false, wait_until: Date.tomorrow.noon).charge(amount: 100)
   ```
 
 ## Fault tolerant

data/bin/skiplock

@@ -7,6 +7,7 @@ begin
     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('-s', '--graceful-shutdown NUM', Integer, 'Number of seconds to wait for graceful shutdown')
     opts.on('-r', '--max-retries NUM', Integer, 'Number of maxixum retries')
     opts.on('-t', '--max-threads NUM', Integer, 'Number of maximum threads')

data/lib/generators/skiplock/templates/migration.rb.erb

@@ -46,18 +46,20 @@ class CreateSkiplockSchema < ActiveRecord::Migration<%= "[#{ActiveRecord::VERSIO
             IF (record.running = TRUE) THEN
               INSERT INTO skiplock.counters (day,completions) VALUES (NOW(),1) ON CONFLICT (day) DO UPDATE SET completions = skiplock.counters.completions + 1;
             END IF;
-          ELSIF (record.running = TRUE) THEN
-            IF (record.executions > 0) THEN
-              INSERT INTO skiplock.counters (day,retries) VALUES (NOW(),1) ON CONFLICT (day) DO UPDATE SET retries = skiplock.counters.retries + 1;
-            ELSE
-              INSERT INTO skiplock.counters (day,dispatches) VALUES (NOW(),1) ON CONFLICT (day) DO UPDATE SET dispatches = skiplock.counters.dispatches + 1;
+          ELSIF (TG_OP = 'UPDATE') THEN
+            IF (OLD.running = FALSE AND record.running = TRUE) THEN
+              IF (record.executions > 0) THEN
+                INSERT INTO skiplock.counters (day,retries) VALUES (NOW(),1) ON CONFLICT (day) DO UPDATE SET retries = skiplock.counters.retries + 1;
+              ELSE
+                INSERT INTO skiplock.counters (day,dispatches) VALUES (NOW(),1) ON CONFLICT (day) DO UPDATE SET dispatches = skiplock.counters.dispatches + 1;
+              END IF;
+            ELSIF (OLD.finished_at IS NULL AND record.finished_at IS NOT NULL) THEN
+              INSERT INTO skiplock.counters (day,completions) VALUES (NOW(),1) ON CONFLICT (day) DO UPDATE SET completions = skiplock.counters.completions + 1;
+            ELSIF (OLD.running = TRUE AND record.running = FALSE AND record.expired_at IS NOT NULL) THEN
+              INSERT INTO skiplock.counters (day,expiries) VALUES (NOW(),1) ON CONFLICT (day) DO UPDATE SET expiries = skiplock.counters.expiries + 1;
+            ELSIF (OLD.running = TRUE AND record.running = FALSE AND record.expired_at IS NULL AND record.finished_at IS NULL) THEN
+              INSERT INTO skiplock.counters (day,failures) VALUES (NOW(),1) ON CONFLICT (day) DO UPDATE SET failures = skiplock.counters.failures + 1;
             END IF;
-          ELSIF (record.finished_at IS NOT NULL) THEN
-            INSERT INTO skiplock.counters (day,completions) VALUES (NOW(),1) ON CONFLICT (day) DO UPDATE SET completions = skiplock.counters.completions + 1;
-          ELSIF (record.expired_at IS NOT NULL) THEN
-            INSERT INTO skiplock.counters (day,expiries) VALUES (NOW(),1) ON CONFLICT (day) DO UPDATE SET expiries = skiplock.counters.expiries + 1;
-          ELSIF (TG_OP = 'UPDATE' AND OLD.running = TRUE AND NEW.running = FALSE) THEN
-            INSERT INTO skiplock.counters (day,failures) VALUES (NOW(),1) ON CONFLICT (day) DO UPDATE SET failures = skiplock.counters.failures + 1;
           END IF;
           PERFORM pg_notify('skiplock::jobs', CONCAT(TG_OP,',',record.id::TEXT,',',record.worker_id::TEXT,',',record.job_class,',',record.queue_name,',',record.running::TEXT,',',CAST(EXTRACT(EPOCH FROM record.expired_at) AS FLOAT)::TEXT,',',CAST(EXTRACT(EPOCH FROM record.finished_at) AS FLOAT)::TEXT,',',CAST(EXTRACT(EPOCH FROM CASE WHEN record.scheduled_at IS NULL THEN record.updated_at ELSE record.scheduled_at END) AS FLOAT)::TEXT));
           RETURN NULL;
@@ -85,7 +87,7 @@ class CreateSkiplockSchema < ActiveRecord::Migration<%= "[#{ActiveRecord::VERSIO
     execute "CREATE INDEX jobs_retry_index ON skiplock.jobs(scheduled_at) WHERE running = FALSE AND executions IS NOT NULL AND expired_at IS NULL AND finished_at IS NULL"
     execute "CREATE INDEX jobs_cron_index ON skiplock.jobs(scheduled_at ASC NULLS FIRST, priority ASC NULLS LAST, created_at ASC) WHERE cron IS NOT NULL AND finished_at IS NULL"
     execute "CREATE UNIQUE INDEX jobs_unique_cron_index ON skiplock.jobs (job_class) WHERE cron IS NOT NULL"
-    execute "CREATE UNIQUE INDEX workers_unique_master_index ON skiplock.workers(hostname) WHERE master = 't'"
+    execute "CREATE UNIQUE INDEX workers_unique_master_index ON skiplock.workers(hostname) WHERE master = TRUE"
   end
 
   def down

data/lib/skiplock/job.rb

@@ -1,7 +1,10 @@
 module Skiplock
   class Job < ActiveRecord::Base
     self.implicit_order_column = 'updated_at'
-    attr_accessor :activejob_retry
+    attribute :activejob_error
+    attribute :exception
+    attribute :max_retries, :integer
+    attribute :purge, :boolean
     belongs_to :worker, inverse_of: :jobs, required: false
 
     def self.dispatch(purge_completion: true, max_retries: 20)
@@ -19,16 +22,16 @@ module Skiplock
     end
 
     def self.enqueue_at(activejob, timestamp)
+      options = activejob.instance_variable_get('@skiplock_options') || {}
       timestamp = Time.at(timestamp) if timestamp
       if Thread.current[:skiplock_job].try(:id) == activejob.job_id
-        Thread.current[:skiplock_job].activejob_retry = true
-        Thread.current[:skiplock_job].data['activejob_retry'] = true
+        Thread.current[:skiplock_job].activejob_error = options[:error]
+        Thread.current[:skiplock_job].data['activejob_error'] = true
         Thread.current[:skiplock_job].executions = activejob.executions
         Thread.current[:skiplock_job].exception_executions = activejob.exception_executions
         Thread.current[:skiplock_job].scheduled_at = timestamp
         Thread.current[:skiplock_job]
       else
-        options = activejob.instance_variable_get('@skiplock_options') || {}
         serialize = activejob.serialize
         self.create!(serialize.slice(*self.column_names).merge('id' => serialize['job_id'], 'data' => { 'arguments' => serialize['arguments'], 'options' => options }, 'scheduled_at' => timestamp))
       end
@@ -40,7 +43,7 @@ module Skiplock
       Dir.glob('tmp/skiplock/*').each do |f|
         disposed = true
         if self.exists?(id: File.basename(f), running: true)
-          job = Marshal.load(File.binread(f)) rescue nil
+          job = YAML.load_file(f) rescue nil
           disposed = job.dispose if job.is_a?(Skiplock::Job)
         end
         (File.delete(f) rescue nil) if disposed
@@ -54,15 +57,15 @@ module Skiplock
     end
 
     def dispose
-      return unless @max_retries
-      dump = Marshal.dump(self)
+      return unless self.max_retries
+      yaml = self.to_yaml
       purging = false
       self.running = false
       self.worker_id = nil
       self.updated_at = Time.now > self.updated_at ? Time.now : self.updated_at + 1 # in case of clock drifting
-      if @exception
-        self.exception_executions["[#{@exception.class.name}]"] = self.exception_executions["[#{@exception.class.name}]"].to_i + 1 unless self.activejob_retry
-        if (self.executions.to_i >= @max_retries + 1) || self.data.key?('activejob_retry') || @exception.is_a?(Skiplock::Extension::ProxyError)
+      if self.exception
+        self.exception_executions["[#{self.exception.class.name}]"] = self.exception_executions["[#{self.exception.class.name}]"].to_i + 1 unless self.data.key?('activejob_error')
+        if (self.executions.to_i >= self.max_retries + 1) || self.data.key?('activejob_error') || self.exception.is_a?(Skiplock::Extension::ProxyError)
           self.expired_at = Time.now
         else
           self.scheduled_at = Time.now + (5 * 2**self.executions.to_i)
@@ -76,7 +79,7 @@ module Skiplock
           next_cron_at = Cron.next_schedule_at(self.cron)
           if next_cron_at
             # update job to record completions counter before resetting finished_at to nil
-            self.update_columns(self.attributes.slice(*self.changes.keys))
+            self.update_columns(self.attributes.slice(*(self.changes.keys & self.class.column_names)))
             self.finished_at = nil
             self.executions = nil
             self.exception_executions = nil
@@ -86,13 +89,13 @@ module Skiplock
             Skiplock.logger.error("[Skiplock] ERROR: Invalid CRON '#{self.cron}' for Job #{self.job_class}") if Skiplock.logger
             purging = true
           end
-        elsif @purge == true
+        elsif self.purge == true
           purging = true
         end
       end
-      purging ? self.delete : self.update_columns(self.attributes.slice(*self.changes.keys))
+      purging ? self.delete : self.update_columns(self.attributes.slice(*(self.changes.keys & self.class.column_names)))
     rescue Exception => e
-      File.binwrite("tmp/skiplock/#{self.id}", dump) rescue nil
+      File.write("tmp/skiplock/#{self.id}", yaml) rescue nil
       if Skiplock.logger
         Skiplock.logger.error(e.to_s)
         Skiplock.logger.error(e.backtrace.join("\n"))
@@ -103,14 +106,15 @@ 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 ||= {}
-      self.activejob_retry = false
-      @max_retries = (self.data['options'].key?('max_retries') ? self.data['options']['max_retries'].to_i : max_retries) rescue max_retries
-      @max_retries = 20 if @max_retries < 0 || @max_retries > 20
-      @purge = (self.data['options'].key?('purge') ? self.data['options']['purge'] : purge_completion) rescue purge_completion
+      self.activejob_error = nil
+      self.max_retries = (self.data['options'].key?('max_retries') ? self.data['options']['max_retries'].to_i : max_retries) rescue max_retries
+      self.max_retries = 20 if self.max_retries < 0 || self.max_retries > 20
+      self.purge = (self.data['options'].key?('purge') ? self.data['options']['purge'] : purge_completion) rescue purge_completion
       job_data = self.attributes.slice('job_class', 'queue_name', 'locale', 'timezone', 'priority', 'executions', 'exception_executions').merge('job_id' => self.id, 'enqueued_at' => self.updated_at, 'arguments' => (self.data['arguments'] || []))
       self.executions = self.executions.to_i + 1
       Thread.current[:skiplock_job] = self
@@ -118,15 +122,15 @@ module Skiplock
       begin
         self.data['result'] = ActiveJob::Base.execute(job_data)
       rescue Exception => ex
-        @exception = ex
-        Skiplock.on_errors.each { |p| p.call(@exception) }
+        self.exception = ex
+        Skiplock.on_errors.each { |p| p.call(ex) }
       end
       if Skiplock.logger
-        if @exception || self.activejob_retry
-          Skiplock.logger.error("[Skiplock] Job #{self.job_class} (#{self.id}) was interrupted by an exception#{ ' (rescued and retried by ActiveJob)' if self.activejob_retry }")
-          if @exception
-            Skiplock.logger.error(@exception.to_s)
-            Skiplock.logger.error(@exception.backtrace.join("\n"))
+        if self.exception || self.activejob_error
+          Skiplock.logger.error("[Skiplock] Job #{self.job_class} (#{self.id}) was interrupted by an exception#{ ' (rescued and retried by ActiveJob)' if self.activejob_error }")
+          if self.exception
+            Skiplock.logger.error(self.exception.to_s)
+            Skiplock.logger.error(self.exception.backtrace.join("\n"))
           end
         else
           end_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)
@@ -138,8 +142,9 @@ module Skiplock
           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']
     ensure
-      self.finished_at ||= Time.now if self.data.key?('result') && !self.activejob_retry
+      self.finished_at ||= Time.now if self.data.key?('result') && !self.activejob_error
       self.dispose
     end
   end

data/lib/skiplock/manager.rb

@@ -4,16 +4,23 @@ module Skiplock
       @config = Skiplock::DEFAULT_CONFIG.dup
       @config.merge!(YAML.load_file('config/skiplock.yml')) rescue nil
       @config.symbolize_keys!
-      @config.transform_values! {|v| v.is_a?(String) ? v.downcase : v}
-      @hostname = Socket.gethostname
-      configure
-      setup_logger
-      if (caller.any?{ |l| l =~ %r{/rack/} } && @config[:workers] == 0)
-        Worker.cleanup(@hostname)
-        @worker = Worker.generate(capacity: @config[:max_threads], hostname: @hostname)
-        @worker.start(**@config)
-        at_exit { @worker.shutdown }
+      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
+      (caller.any?{ |l| l =~ %r{/rack/} } && @config[:workers] == 0) ? async : Cron.setup
+    end
+
+    def async
+      setup_logger
+      configure
+      Worker.cleanup(@hostname)
+      @worker = Worker.generate(capacity: @config[:max_threads], hostname: @hostname)
+      Cron.setup if @worker.master
+      @worker.start(**@config)
+      at_exit { @worker.shutdown }
     rescue Exception => ex
       @logger.error(ex.to_s)
       @logger.error(ex.backtrace.join("\n"))
@@ -21,21 +28,23 @@ module Skiplock
 
     def standalone(**options)
       @config.merge!(options)
-      Rails.logger.reopen('/dev/null') rescue Rails.logger.reopen('NUL') # supports Windows NUL device
-      Rails.logger.extend(ActiveSupport::Logger.broadcast(@logger))
-      @config[:workers] = 1 if @config[:workers] <= 0
       @config[:standalone] = true
+      @config[:workers] = 1 if @config[:workers] <= 0
+      setup_logger
+      configure
       banner
-      Worker.cleanup(@hostname)
-      @worker = Worker.generate(capacity: @config[:max_threads], hostname: @hostname)
       @parent_id = Process.pid
       @shutdown = false
       Signal.trap('INT') { @shutdown = true }
       Signal.trap('TERM') { @shutdown = true }
       Signal.trap('HUP') { setup_logger }
+      Worker.cleanup(@hostname)
+      @worker = Worker.generate(capacity: @config[:max_threads], hostname: @hostname)
+      ActiveRecord::Base.connection.disconnect! if @config[:workers] > 1
       (@config[:workers] - 1).times do |n|
         fork do
-          sleep 1
+          sleep(0.25*n + 1)
+          ActiveRecord::Base.establish_connection
           worker = Worker.generate(capacity: @config[:max_threads], hostname: @hostname, master: false)
           worker.start(worker_num: n + 1, **@config)
           loop do
@@ -45,6 +54,7 @@ module Skiplock
           worker.shutdown
         end
       end
+      ActiveRecord::Base.establish_connection if @config[:workers] > 1
       @worker.start(**@config)
       loop do
         sleep 0.5
@@ -53,7 +63,9 @@ module Skiplock
       @logger.info "[Skiplock] Terminating signal... Waiting for jobs to finish (up to #{@config[:graceful_shutdown]} seconds)..." if @config[:graceful_shutdown]
       Process.waitall
       @worker.shutdown
-      @logger.info "[Skiplock] Shutdown completed."
+    rescue Exception => ex
+      @logger.error(ex.to_s)
+      @logger.error(ex.backtrace.join("\n"))
     end
 
     private
@@ -80,6 +92,8 @@ module Skiplock
     end
 
     def configure
+      @hostname = 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
       @config[:max_retries] = 20 if @config[:max_retries] > 20
@@ -103,40 +117,39 @@ module Skiplock
       case @config[:notification]
       when 'airbrake'
         raise 'airbrake gem not found' unless defined?(Airbrake)
-        Skiplock.on_error do |ex, previous|
-          Airbrake.notify_sync(ex) unless ex.backtrace == previous.try(:backtrace)
+        Skiplock.on_error do |ex|
+          Airbrake.notify_sync(ex)
         end
       when 'bugsnag'
         raise 'bugsnag gem not found' unless defined?(Bugsnag)
-        Skiplock.on_error do |ex, previous|
-          Bugsnag.notify(ex) unless ex.backtrace == previous.try(:backtrace)
+        Skiplock.on_error do |ex|
+          Bugsnag.notify(ex)
         end
       when 'exception_notification'
         raise 'exception_notification gem not found' unless defined?(ExceptionNotifier)
-        Skiplock.on_error do |ex, previous|
-          ExceptionNotifier.notify_exception(ex) unless ex.backtrace == previous.try(:backtrace)
+        Skiplock.on_error do |ex|
+          ExceptionNotifier.notify_exception(ex)
         end
       else
         @config[:notification] = 'custom'
       end
-      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
-      Skiplock.on_errors.freeze unless Skiplock.on_errors.frozen?
+      Skiplock.on_errors.freeze
     end
 
     def setup_logger
-      @config[:loglevel] = 'info' unless ['debug','info','warn','error','fatal','unknown'].include?(@config[:loglevel].to_s.downcase)
+      @config[:loglevel] = 'info' unless ['debug','info','warn','error','fatal','unknown'].include?(@config[:loglevel].to_s)
       @logger = ActiveSupport::Logger.new(STDOUT)
-      @logger.level = @config[:loglevel].downcase.to_sym
+      @logger.level = @config[:loglevel].to_sym
       Skiplock.logger = @logger
       if @config[:logfile].to_s.length > 0
         @logger.extend(ActiveSupport::Logger.broadcast(::Logger.new(File.join(Rails.root, 'log', @config[:logfile].to_s), 'daily')))
         ActiveJob::Base.logger = nil
       end
+      if @config[:standalone]
+        Rails.logger.reopen('/dev/null') rescue Rails.logger.reopen('NUL') # supports Windows NUL device
+        Rails.logger.level = @logger.level
+        Rails.logger.extend(ActiveSupport::Logger.broadcast(@logger))
+      end
     rescue Exception => ex
       @logger.error "Exception with logger: #{ex.to_s}"
       @logger.error ex.backtrace.join("\n")

data/lib/skiplock/patch.rb

@@ -1,7 +1,7 @@
 module Skiplock
   module Patch
     def enqueue(options = {})
-      self.instance_variable_set('@skiplock_options', options)
+      @skiplock_options = options
       super
     end
   end

data/lib/skiplock/version.rb

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

data/lib/skiplock/worker.rb

@@ -18,74 +18,78 @@ module Skiplock
       self.create!(pid: Process.pid, sid: Process.getsid(), master: false, hostname: hostname, capacity: capacity)
     end
 
-    def start(worker_num: 0, **config)
-      if self.master
-        Job.flush
-        Cron.setup
-      end
-      @config = config
-      @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], idletime: 60, auto_terminate: true, fallback_policy: :discard)
-      @executor.post { run }
-      Process.setproctitle("skiplock-#{self.master ? 'master[0]' : 'worker[' + worker_num.to_s + ']'}") if @config[:standalone]
-    end
-
     def shutdown
       @running = false
       @executor.shutdown
       @executor.kill unless @executor.wait_for_termination(@config[:graceful_shutdown])
       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
+
+    def start(worker_num: 0, **config)
+      @num = worker_num
+      @config = config
+      @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)
+      @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}]")
+        ActiveRecord::Base.connection.throw_away!
+      end
     end
 
     private
 
-    def get_next_available_job
-      @connection.transaction do
-        job = Job.find_by_sql("SELECT id, running, scheduled_at FROM skiplock.jobs WHERE running = FALSE AND expired_at IS NULL AND finished_at IS NULL ORDER BY scheduled_at ASC NULLS FIRST,#{@queues_order_query ? ' CASE ' + @queues_order_query + ' ELSE NULL END ASC NULLS LAST,' : ''} priority ASC NULLS LAST, created_at ASC FOR UPDATE SKIP LOCKED LIMIT 1").first
-        if job && job.scheduled_at.to_f <= Time.now.to_f
-          job = Job.find_by_sql("UPDATE skiplock.jobs SET running = TRUE, worker_id = '#{self.id}', updated_at = NOW() WHERE id = '#{job.id}' RETURNING *").first
-        end
-        job
-      end
+    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.exec('LISTEN "skiplock::jobs"').clear
     end
 
     def run
-      error = false
-      listen = false
+      sleep 3
+      Skiplock.logger.info "[Skiplock] Starting in #{@config[:standalone] ? 'standalone' : 'async'} mode (PID: #{self.pid}) with #{@config[:max_threads]} max threads as #{self.master ? 'master' : 'cluster'} worker#{(' ' + @num.to_s) if @num > 0 && @config[:workers] > 2}..."
       next_schedule_at = Time.now.to_f
+      pg_exception_timestamp = nil
       timestamp = Process.clock_gettime(Process::CLOCK_MONOTONIC)
       while @running
         Rails.application.reloader.wrap do
           begin
-            unless listen
-              @connection = self.class.connection
-              @connection.exec_query('LISTEN "skiplock::jobs"')
-              listen = true
+            if @connection.nil? || @connection.status != ::PG::CONNECTION_OK
+              establish_connection
+              @executor.post { Rails.application.executor.wrap { Job.flush } } if self.master
+              pg_exception_timestamp = nil
+              next_schedule_at = Time.now.to_f
             end
-            if error
-              unless @connection.active?
-                @connection.reconnect!
-                sleep(0.5)
-                @connection.exec_query('LISTEN "skiplock::jobs"')
-                next_schedule_at = Time.now.to_f
+            if Time.now.to_f >= next_schedule_at && @executor.remaining_capacity > 1  # reserves 1 slot in queue for Job.flush in case of pg_connection error
+              result = nil
+              @connection.transaction do |conn|
+                conn.exec("SELECT id, running, scheduled_at FROM skiplock.jobs WHERE running = FALSE AND expired_at IS NULL AND finished_at IS NULL ORDER BY scheduled_at ASC NULLS FIRST,#{@queues_order_query ? ' CASE ' + @queues_order_query + ' ELSE NULL END ASC NULLS LAST,' : ''} priority ASC NULLS LAST, created_at ASC FOR UPDATE SKIP LOCKED LIMIT 1") do |r|
+                  result = r.first
+                  conn.exec("UPDATE skiplock.jobs SET running = TRUE, worker_id = '#{self.id}', updated_at = NOW() WHERE id = '#{result['id']}' RETURNING *") { |r| result = r.first } if result && result['scheduled_at'].to_f <= Time.now.to_f
+                end
               end
-              Job.flush if self.master
-              error = false
-            end
-            if Time.now.to_f >= next_schedule_at && @executor.remaining_capacity > 0
-              job = get_next_available_job
-              if job.try(:running)
-                @executor.post { Rails.application.reloader.wrap { job.execute(purge_completion: @config[:purge_completion], max_retries: @config[:max_retries]) } }
+              if result && result['running']
+                @executor.post { Rails.application.executor.wrap { Job.instantiate(result).execute(purge_completion: @config[:purge_completion], max_retries: @config[:max_retries]) } }
               else
-                next_schedule_at = (job ? job.scheduled_at.to_f : Float::INFINITY)
+                next_schedule_at = (result ? result['scheduled_at'].to_f : Float::INFINITY)
               end
             end
             job_notifications = []
-            @connection.raw_connection.wait_for_notify(0.4) do |channel, pid, payload|
+            @connection.wait_for_notify(0.2) do |channel, pid, payload|
               job_notifications << payload if payload
               loop do
-                payload = @connection.raw_connection.notifies
+                payload = @connection.notifies
                 break unless @running && payload
                 job_notifications << payload[:extra]
               end
@@ -96,25 +100,31 @@ module Skiplock
               end
             end
             if Process.clock_gettime(Process::CLOCK_MONOTONIC) - timestamp > 60
-              self.touch
+              @connection.exec("UPDATE skiplock.workers SET updated_at = NOW() WHERE id = '#{self.id}'").clear
               timestamp = Process.clock_gettime(Process::CLOCK_MONOTONIC)
             end
           rescue Exception => ex
-            # most likely error with database connection
-            Skiplock.logger.error(ex.to_s)
-            Skiplock.logger.error(ex.backtrace.join("\n"))
-            Skiplock.on_errors.each { |p| p.call(ex, @last_exception) }
-            error = true
+            report_exception = true
+            # if error is with database connection then only report if it persists longer than 1 minute
+            if @connection.nil? || @connection.status != ::PG::CONNECTION_OK
+              report_exception = false if pg_exception_timestamp.nil? || Process.clock_gettime(Process::CLOCK_MONOTONIC) - pg_exception_timestamp <= 60
+              pg_exception_timestamp ||= Process.clock_gettime(Process::CLOCK_MONOTONIC)
+            end
+            if report_exception
+              Skiplock.logger.error(ex.to_s)
+              Skiplock.logger.error(ex.backtrace.join("\n"))
+              Skiplock.on_errors.each { |p| p.call(ex) }
+            end
             wait(5)
-            @last_exception = ex
           end
           sleep(0.3)
         end
       end
-      @connection.exec_query('UNLISTEN *')
+    ensure
+      @connection.close if @connection && !@connection.finished?
     end
 
-    def wait(timeout)
+    def wait(timeout = 1)
       t = Process.clock_gettime(Process::CLOCK_MONOTONIC)
       while @running
         sleep(0.5)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: skiplock
 version: !ruby/object:Gem::Version
-  version: 1.0.18
+  version: 1.0.23
 platform: ruby
 authors:
 - Tin Vo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-12 00:00:00.000000000 Z
+date: 2021-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob
@@ -109,7 +109,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.22
 signing_key: 
 specification_version: 4
 summary: ActiveJob Queue Adapter for PostgreSQL