skiplock 1.0.21 → 1.0.22

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 69e771cf5508d4a5a648dab43eb33b980370e317a1bf370ceaff62ecee4592e3
-  data.tar.gz: d1df71a515d871073b8d039f1bcbc3fb00b398806ed9f3bd82dc0169737e2f52
+  metadata.gz: 3b99466d7f1848f9dcd750a4dceb6a39d7124707e941c74b6c75f0b3a57944ff
+  data.tar.gz: 3f3ed1c9327d41e675d5c170590b52fe32f1facc5b57667dba513e5324e6ee20
 SHA512:
-  metadata.gz: cca4a86fc4c31e4054a920b32740f294e3f54e9de65fe3a0c31b43258fee6e6f1a790ae1a95f79d9b719119936fedac953afd695ef5e7ce9e990b7f29fa1c397
-  data.tar.gz: 6bdc5a38218b052a825ab2b5f5ef2c73a2c9a6a2d981d8aed7cc61244f8806fdad06876278aa320bafb956c9dc2f15b705d87a2f171cbb2bc3805bfada640ce4
+  metadata.gz: '0129296507b0479ba28a6e4e0bce810340f0ff2559004da1385cf02b6d6023f7be5cb1543f3fb24cebdeb579d6be6ed1e5d7d72d43245de5374926607b23d7df'
+  data.tar.gz: 163faf212d06b6d7f8045eb347ccab77de5b16bfe77fe8780a5d73176ce3c5804cc25cbca8f962d92bc5dfccc1ada223d03fc0b443d0df48125a12bf4ec7ddeb

data/lib/skiplock/job.rb

@@ -1,7 +1,10 @@
 module Skiplock
   class Job < ActiveRecord::Base
     self.implicit_order_column = 'updated_at'
-    attr_accessor :activejob_error
+    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)
@@ -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.data.key?('activejob_error')
-        if (self.executions.to_i >= @max_retries + 1) || self.data.key?('activejob_error') || @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"))
@@ -109,9 +112,9 @@ module Skiplock
       self.data.delete('result')
       self.exception_executions ||= {}
       self.activejob_error = nil
-      @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.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
@@ -119,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_error
+        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 @exception
-            Skiplock.logger.error(@exception.to_s)
-            Skiplock.logger.error(@exception.backtrace.join("\n"))
+          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)
@@ -139,7 +142,7 @@ 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
-      @exception || self.activejob_error || self.data['result']
+      self.exception || self.activejob_error || self.data['result']
     ensure
       self.finished_at ||= Time.now if self.data.key?('result') && !self.activejob_error
       self.dispose

data/lib/skiplock/manager.rb

@@ -4,12 +4,18 @@ 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
       async if (caller.any?{ |l| l =~ %r{/rack/} } && @config[:workers] == 0)
     end
 
     def async
-      configure
       setup_logger
+      configure
       Worker.cleanup(@hostname)
       @worker = Worker.generate(capacity: @config[:max_threads], hostname: @hostname)
       @worker.start(**@config)
@@ -21,22 +27,20 @@ module Skiplock
 
     def standalone(**options)
       @config.merge!(options)
-      configure
-      setup_logger
-      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|
-        sleep 0.2
         fork do
           sleep 1
           worker = Worker.generate(capacity: @config[:max_threads], hostname: @hostname, master: false)
@@ -48,6 +52,7 @@ module Skiplock
           worker.shutdown
         end
       end
+      ActiveRecord::Base.establish_connection if @config[:workers] > 1
       @worker.start(**@config)
       loop do
         sleep 0.5
@@ -107,12 +112,6 @@ module Skiplock
           raise "Unable to detect any known exception notification library. Please define custom 'on_error' event callbacks and change to 'custom' notification in 'config/skiplock.yml'"
         end
       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
       case @config[:notification]
       when 'airbrake'
         raise 'airbrake gem not found' unless defined?(Airbrake)
@@ -144,6 +143,10 @@ module Skiplock
         @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.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/version.rb

@@ -1,4 +1,4 @@
 module Skiplock
-  VERSION = Version = '1.0.21'
+  VERSION = Version = '1.0.22'
 end
 

data/lib/skiplock/worker.rb

@@ -32,37 +32,39 @@ module Skiplock
       @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: :discard)
-      if self.master
-        Job.flush
-        Cron.setup
-      end
       @executor.post { run }
       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}]") if @config[:standalone]
     end
 
     private
 
-    def reloader_post
-      Rails.application.reloader.wrap { @executor.post { Rails.application.executor.wrap { yield } } } if block_given?
-    end
-
     def run
       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}..."
+      connection = nil
       error = false
+      listen = false
       next_schedule_at = Time.now.to_f
       pg_exception_timestamp = nil
       timestamp = Process.clock_gettime(Process::CLOCK_MONOTONIC)
-      ActiveRecord::Base.connection_pool.with_connection do |connection|
-        connection.exec_query('LISTEN "skiplock::jobs"')
-        while @running
+      while @running
+        Rails.application.reloader.wrap do
           begin
+            unless listen
+              connection = self.class.connection
+              connection.exec_query('LISTEN "skiplock::jobs"')
+              if self.master
+                Job.flush
+                Cron.setup
+              end
+              listen = true
+            end
             if error
               unless connection.active?
                 connection.reconnect!
                 sleep(0.5)
                 connection.exec_query('LISTEN "skiplock::jobs"')
-                reloader_post { Job.flush } if self.master
+                Job.flush if self.master
                 pg_exception_timestamp = nil
                 next_schedule_at = Time.now.to_f
               end
@@ -75,7 +77,9 @@ module Skiplock
                 result = connection.select_all("UPDATE skiplock.jobs SET running = TRUE, worker_id = '#{self.id}', updated_at = NOW() WHERE id = '#{result['id']}' RETURNING *").first if result && result['scheduled_at'].to_f <= Time.now.to_f
               end
               if result && result['running']
-                reloader_post { Job.instantiate(result).execute(purge_completion: @config[:purge_completion], max_retries: @config[:max_retries]) }
+                @executor.post do
+                  Rails.application.executor.wrap { Job.instantiate(result).execute(purge_completion: @config[:purge_completion], max_retries: @config[:max_retries]) }
+                end
               else
                 next_schedule_at = (result ? result['scheduled_at'].to_f : Float::INFINITY)
               end
@@ -103,7 +107,7 @@ module Skiplock
             Skiplock.logger.error(ex.backtrace.join("\n"))
             report_exception = true
             # if error is with database connection then only report if it persists longer than 1 minute
-            if ex.is_a?(::PG::ConnectionBad)
+            if ex.is_a?(::PG::ConnectionBad) ||ex.is_a?(::PG::UnableToSend) || ex.message.include?('Bad file descriptor')
               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
@@ -113,8 +117,8 @@ module Skiplock
           end
           sleep(0.3)
         end
-        connection.exec_query('UNLISTEN *')
       end
+      connection.exec_query('UNLISTEN *')
     end
 
     def wait(timeout)

metadata

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