skiplock 1.0.9 → 1.0.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7a975a3bb22318c6203edd59428a93d6a4abfa5ea1382f35abd774760467dc23
-  data.tar.gz: 79b787d23af0db0188aebf1b0361649d906d5f0cca4488d7cfcb3f61927d4781
+  metadata.gz: 89240e4318ca72cf30a3426948d9aa8479f59f85b82e4dca4ef5ee3b449b9894
+  data.tar.gz: b8f6799ccf4ba566379548dc4e9c90b6a1202842139b0ac0a3e0247875be00d9
 SHA512:
-  metadata.gz: 407469700b1fab6c4ea702b83df0571fd46322ad32c8c8fe8ffc0269e5e93cd9f774b8bd4658021320732ca4de6d7609a64430cbc26bddc14c9f14cf184f92e3
-  data.tar.gz: 69a5fe7f5c88f21585a4b581d34f44183cb12f25bc0df6e7982497fb63c088316a251cc55c4e712b3cad799ec9aa758c8045d911fbeda393267ed39bc694e9a5
+  metadata.gz: 3d8ec5ec2c3b0612fd3077fac5d6ff0c6e1b6826ed74b25b640ccc966874461b470f633c582af4f408f547586e30e1fdc5c22f158ca6fdf5c91000ec33c609a2
+  data.tar.gz: 27b6f4746f255777fdb6b3733d08a0592969a45d6d0f315d76231269255e532b51834fa79e1be89a0c18ac62509fe342266c9a8a5c7c038cc2b9e52b120e2469

data/README.md

@@ -48,43 +48,51 @@ The library is quite small compared to other PostgreSQL job queues (eg. *delay_j
     ```
 2. `Skiplock` configuration
     ```yaml
-    # config/skiplock.yml
+    # config/skiplock.yml (default settings)
     ---
-    logging: timestamp
     min_threads: 1
     max_threads: 5
     max_retries: 20
-    notification: auto
+    logfile: log/skiplock.log
+    loglevel: info
+    notification: custom
+    extensions: false
     purge_completion: true
     queues:
       default: 200
-      mailers: 100
+      mailers: 999
     workers: 0
     ```
     Available configuration options are:
-    - **logging** (*enumeration*): sets the logging capability to **true** or **false**; setting to **timestamp** will enable logging with timestamps. The log files are: log/skiplock.log and log/skiplock.error.log
     - **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)
-    - **notification** (*enumeration*): sets the library to be used for notifying errors and exceptions (`auto, airbrake, bugsnag, exception_notification, false`)
+    - **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*): path 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
+    - **extensions** (*boolean*): 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)
     - **queues** (*hash*): defines the set of queues with priorities; lower priority takes precedence
     - **workers** (*integer*) sets the maximum number of processes when running in standalone mode using the `skiplock` executable; setting this to **0** will enable **async mode**
-    
-    #### Async mode
-    When **workers** is set to **0** then the jobs will be performed in the web server process using separate threads.  If using multi-worker cluster mode web server like Puma, then it should be configured as below:
-    ```ruby
-    # config/puma.rb
-    # ...
-    on_worker_fork do |worker_index|
-      Skiplock::Manager.shutdown if worker_index == 1
-    end
 
-    after_worker_fork do |worker_index|
-      # restarts skiplock after all Puma workers have been started
-      Skiplock::Manager.start(restart: true) if defined?(Skiplock) && worker_index + 1 == @options[:workers]
-    end
+    #### **Async mode**
+    When **workers** is set to **0** then the jobs will be performed in the web server process using separate threads.  If using multi-worker cluster mode web server like Puma, then all the Puma workers will also be able to perform `Skiplock` jobs.
+
+    #### **Standalone mode**
+    `Skiplock` standalone mode can be launched by using the `skiplock` executable; command line options can be provided to override the `Skiplock` configuration file.  
+    ```
+    $ bundle exec skiplock -h
+    Usage: skiplock [options]
+      -e, --environment STRING         Rails environment
+      -l, --logfile STRING             Full path to logfile
+      -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
+      -T, --min-threads NUM            Number of minimum threads
+      -w, --workers NUM                Number of workers
+      -h, --help                       Show this message
     ```
+
 ## Usage
 Inside the Rails application:
 - queue your job
@@ -152,17 +160,32 @@ If the retry attempt limit configured in ActiveJob has been reached, then the co
 If the `retry_on` block is not defined, then the built-in retry system of `skiplock` will kick in automatically.  The retrying schedule is using an exponential formula (5 + 2**attempt).  The `skiplock` configuration `max_retries` determines the the limit of attempts before the failing job is marked as expired.  The maximum retry limit can be set as high as 20; this allows up to 12 days of retrying before the job is marked as expired.
 
 ## Notification system
-`Skiplock` can use existing exception notification library to notify errors and exceptions.  It supports `airbrake`, `bugsnag`, and `exception_notification` as shown in the **Configuration** section above.  Custom function can also be called whenever an exception occurs; it can be configured in an initializer like below:
+`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 custom email 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
     end
   end
-  # supports multiple on_error callbacks
+  # supports multiple 'on_error' event callbacks
 ```
+## ClassMethod extension
+`Skiplock` can add extension to allow all class methods to be performed as a background job; it is disabled in the default configuration.  To enable, edit the `config/skiplock.yml` configuration file and change `extensions` to `true`.
+- Queue class method `generate_thumbnails` of class `Image` as background job to run as soon as possible
+  ```ruby
+  Image.skiplock.generate_thumbnails(height: 100, ratio: true)
+  ```
+- Queue class method `cleanup` of class `Session` as background job on queue `maintenance` to run after 5 minutes
+  ```ruby
+  Session.skiplock(wait: 5.minutes, queue: 'maintenance').cleanup
+  ```
+- Queue class method `charge` of class `Subscription` as background job to run tomorrow at noon
+  ```ruby
+  Subscription.skiplock(wait_until: Date.tomorrow.noon).charge(amount: 100)
+  ```
 
 ## Contributing
 

data/bin/skiplock

@@ -5,10 +5,11 @@ begin
   op = OptionParser.new do |opts|
     opts.banner = "Usage: #{File.basename($0)} [options]"
     opts.on('-e', '--environment STRING', String, 'Rails environment')
-    opts.on('-l', '--logging STRING', String, 'Possible values: true, false, timestamp')
-    opts.on('-r', '--max_retries NUM', Integer, 'Number of maxixum retries')
-    opts.on('-t', '--max_threads NUM', Integer, 'Number of maximum threads')
-    opts.on('-T', '--min_threads NUM', Integer, 'Number of minimum threads')
+    opts.on('-l', '--logfile STRING', String, 'Full path to logfile')
+    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')
+    opts.on('-T', '--min-threads NUM', Integer, 'Number of minimum threads')
     opts.on('-w', '--workers NUM', Integer, 'Number of workers')
     opts.on_tail('-h', '--help', 'Show this message') do
       exit
@@ -20,7 +21,8 @@ rescue Exception => e
   puts op
   exit
 end
+options.transform_keys! { |k| k.to_s.gsub('-', '_').to_sym }
 env = options.delete(:environment)
 ENV['RAILS_ENV'] = env if env
 require File.expand_path("config/environment.rb")
-Skiplock::Manager.start(standalone: true, **options)
+Rails.application.config.skiplock.standalone(**options.merge(standalone: true))

data/lib/active_job/queue_adapters/skiplock_adapter.rb

@@ -2,7 +2,7 @@ module ActiveJob
   module QueueAdapters
     class SkiplockAdapter
       def initialize
-        Skiplock::Manager.start
+        Rails.application.config.after_initialize { Rails.application.config.skiplock = Skiplock::Manager.new }
       end
 
       def enqueue(job)

data/lib/generators/skiplock/install_generator.rb

@@ -12,7 +12,7 @@ module Skiplock
     end
 
     def create_config_file
-      create_file 'config/skiplock.yml', Skiplock::Settings.to_yaml
+      create_file 'config/skiplock.yml', Skiplock::DEFAULT_CONFIG.to_yaml
     end
 
     def create_migration_file

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

@@ -27,10 +27,11 @@ class CreateSkiplockSchema < ActiveRecord::Migration<%= "[#{ActiveRecord::VERSIO
       t.timestamps null: false, default: -> { 'now()' }
     end
     create_table 'skiplock.workers', id: :uuid do |t|
-      t.integer   :pid, null: false, index: true
-      t.integer   :ppid, index: true
+      t.integer   :pid, null: false
+      t.integer   :sid, null: false
       t.integer   :capacity, null: false
       t.string    :hostname, null: false, index: true
+      t.boolean   :master, null: false, default: false, index: true
       t.jsonb     :data
       t.timestamps null: false, index: true, default: -> { 'now()' }
     end    
@@ -59,7 +60,7 @@ class CreateSkiplockSchema < ActiveRecord::Migration<%= "[#{ActiveRecord::VERSIO
           ELSIF (record.executions IS NOT NULL AND record.scheduled_at IS NOT NULL) 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.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));
+          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;
         END;
       $$ LANGUAGE plpgsql
@@ -74,7 +75,7 @@ class CreateSkiplockSchema < ActiveRecord::Migration<%= "[#{ActiveRecord::VERSIO
           ELSE
             record = NEW;
           END IF;
-          PERFORM pg_notify('skiplock::workers', CONCAT(TG_OP,',',record.id::TEXT,',',record.hostname,',',record.capacity,',',record.pid,',',record.ppid));
+          PERFORM pg_notify('skiplock::workers', CONCAT(TG_OP,',',record.id::TEXT,',',record.hostname,',',record.master::TEXT,',',record.capacity,',',record.pid,',',record.sid,',',CAST(EXTRACT(EPOCH FROM record.created_at) AS FLOAT)::TEXT,',',CAST(EXTRACT(EPOCH FROM record.updated_at) AS FLOAT)::TEXT));
           RETURN NULL;
         END;
       $$ LANGUAGE plpgsql;
@@ -85,6 +86,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'"
   end
 
   def down

data/lib/skiplock/cron.rb

@@ -2,17 +2,18 @@ require 'cron_parser'
 module Skiplock
   class Cron
     def self.setup
+      Rails.application.eager_load! if Rails.env.development?
       cronjobs = []
       ActiveJob::Base.descendants.each do |j|
         next unless j.const_defined?('CRON')
         cron = j.const_get('CRON')
-        job = Job.find_by('job_class = ? AND cron IS NOT NULL', j.name) || Job.new(job_class: j.name, cron: cron)
+        job = Job.find_by('job_class = ? AND cron IS NOT NULL', j.name) || Job.new(job_class: j.name, cron: cron, locale: I18n.locale, timezone: Time.zone.name)
         time = self.next_schedule_at(cron)
         if time
           job.cron = cron
           job.running = false
           job.scheduled_at = Time.at(time)
-          job.save!
+          job.save
           cronjobs << j.name
         end
       end

data/lib/skiplock/extension.rb

@@ -0,0 +1,25 @@
+module Skiplock
+  module Extension
+    class Proxy < BasicObject
+      def initialize(target, options = {})
+        @target = target
+        @options = options
+      end
+
+      def method_missing(name, *args)
+        ProxyJob.set(@options).perform_later(::YAML.dump([ @target, name, args ]))
+      end
+    end
+
+    class ProxyJob < ActiveJob::Base
+      def perform(yml)
+        target, method_name, args = ::YAML.load(yml)
+        target.__send__(method_name, *args)
+      end
+    end
+
+    def skiplock(options = {})
+      Proxy.new(self, options)
+    end
+  end
+end

data/lib/skiplock/job.rb

@@ -1,27 +1,6 @@
 module Skiplock
   class Job < ActiveRecord::Base
-    def self.dispatch(queues_order_query: nil, worker_id: nil)
-      self.connection.exec_query('BEGIN')
-      job = self.find_by_sql("SELECT id, scheduled_at FROM #{self.table_name} 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.nil? || job.scheduled_at.to_f > Time.now.to_f
-        self.connection.exec_query('END')
-        return (job ? job.scheduled_at.to_f : Float::INFINITY)
-      end
-      job = Skiplock::Job.find_by_sql("UPDATE #{self.table_name} SET running = TRUE, worker_id = #{self.connection.quote(worker_id)}, updated_at = NOW() WHERE id = '#{job.id}' RETURNING *").first
-      self.connection.exec_query('END')
-      job.data ||= {}
-      job.exception_executions ||= {}
-      job_data = job.attributes.slice('job_class', 'queue_name', 'locale', 'timezone', 'priority', 'executions', 'exception_executions').merge('job_id' => job.id, 'enqueued_at' => job.updated_at, 'arguments' => (job.data['arguments'] || []))
-      job.executions = (job.executions || 0) + 1
-      Thread.current[:skiplock_dispatch_job] = job
-      begin
-        ActiveJob::Base.execute(job_data)
-      rescue Exception => ex
-      end
-      job.dispose(ex)
-    ensure
-      Thread.current[:skiplock_dispatch_job] = nil
-    end
+    self.implicit_order_column = 'created_at'
 
     def self.enqueue(activejob)
       self.enqueue_at(activejob, nil)
@@ -35,22 +14,28 @@ module Skiplock
         Thread.current[:skiplock_dispatch_job].scheduled_at = timestamp
         Thread.current[:skiplock_dispatch_job]
       else
-        Job.create!(id: activejob.job_id, job_class: activejob.class.name, queue_name: activejob.queue_name, locale: activejob.locale, timezone: activejob.timezone, priority: activejob.priority, data: { 'arguments' => activejob.serialize['arguments'] }, scheduled_at: timestamp)
+        serialize = activejob.serialize
+        self.create!(serialize.slice(*self.column_names).merge('id' => serialize['job_id'], 'data' => { 'arguments' => serialize['arguments'] }, 'scheduled_at' => timestamp))
       end
     end
 
-    def dispose(ex)
+    def self.reset_retry_schedules
+      self.where('scheduled_at > NOW() AND executions IS NOT NULL AND expired_at IS NULL AND finished_at IS NULL').update_all(scheduled_at: nil, updated_at: Time.now)
+    end
+
+    def dispose(ex, purge_completion: true, max_retries: 20)
+      yaml = [self, ex].to_yaml
       self.running = false
+      self.worker_id = nil
       self.updated_at = (Time.now > self.updated_at ? Time.now : self.updated_at + 1)
       if ex
         self.exception_executions["[#{ex.class.name}]"] = (self.exception_executions["[#{ex.class.name}]"] || 0) + 1 unless self.exception_executions.key?('activejob_retry')
-        if self.executions >= Settings['max_retries'] || self.exception_executions.key?('activejob_retry')
+        if self.executions >= max_retries || self.exception_executions.key?('activejob_retry')
           self.expired_at = Time.now
-          self.save!
         else
           self.scheduled_at = Time.now + (5 * 2**self.executions)
-          self.save!
         end
+        self.save!
         Skiplock.on_errors.each { |p| p.call(ex) }
       elsif self.exception_executions.try(:key?, 'activejob_retry')
         self.save!
@@ -65,9 +50,10 @@ module Skiplock
           self.scheduled_at = Time.at(next_cron_at)
           self.save!
         else
+          Skiplock.logger.error "[Skiplock] ERROR: Invalid CRON '#{self.cron}' for Job #{self.job_class}"
           self.delete
         end
-      elsif Settings['purge_completion']
+      elsif purge_completion
         self.delete
       else
         self.finished_at = Time.now
@@ -75,9 +61,42 @@ module Skiplock
         self.save!
       end
       self
-    rescue
-      File.write("tmp/skiplock/#{self.id}", [self, ex].to_yaml)
+    rescue Exception => e
+      Skiplock.logger.error(e.name)
+      Skiplock.logger.error(e.backtrace.join("\n"))
+      File.write("tmp/skiplock/#{self.id}", yaml)
       nil
     end
+
+    def execute(purge_completion: true, max_retries: 20)
+      Skiplock.logger.info "[Skiplock] Performing #{self.job_class} (#{self.id}) from queue '#{self.queue_name || 'default'}'..."
+      self.data ||= {}
+      self.exception_executions ||= {}
+      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 || 0) + 1
+      Thread.current[:skiplock_dispatch_job] = self
+      activejob = ActiveJob::Base.deserialize(job_data)
+      start_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+      begin
+        activejob.perform_now
+      rescue Exception => ex
+      end
+      if ex || self.exception_executions.key?('activejob_retry')
+        Skiplock.logger.error("[Skiplock] Job #{self.job_class} (#{self.id}) was interrupted by an exception#{ ' (rescued and retried by ActiveJob)' if self.exception_executions.key?('activejob_retry') }")
+        if ex
+          Skiplock.logger.error(ex)
+          Skiplock.logger.error(ex.backtrace.join("\n"))
+        end
+      else
+        end_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+        job_name = self.job_class
+        if self.job_class == 'Skiplock::Extension::ProxyJob'
+          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
+      self.dispose(ex, purge_completion: purge_completion, max_retries: max_retries)
+    end
   end
 end

data/lib/skiplock/manager.rb

@@ -1,62 +1,140 @@
 module Skiplock
   class Manager
-    def self.start(standalone: false, restart: false, workers: nil, max_retries: nil, max_threads: nil, min_threads: nil, logging: nil)
-      unless Settings.frozen?
-        load_settings
-        Settings['logging'] = logging if logging
-        Settings['max_retries'] = max_retries if max_retries
-        Settings['max_threads'] = max_threads if max_threads
-        Settings['min_threads'] = min_threads if min_threads
-        Settings['workers'] = workers if workers
-        Settings['max_retries'] = 20 if Settings['max_retries'] > 20
-        Settings['max_retries'] = 0 if Settings['max_retries'] < 0
-        Settings['max_threads'] = 1 if Settings['max_threads'] < 1
-        Settings['max_threads'] = 20 if Settings['max_threads'] > 20
-        Settings['min_threads'] = 0 if Settings['min_threads'] < 0
-        Settings['workers'] = 0 if Settings['workers'] < 0
-        Settings['workers'] = 1 if standalone && Settings['workers'] <= 0
-        Settings.freeze
+    def initialize(**config)
+      @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}
+      @config.merge!(config)
+      @config[:hostname] = `hostname -f`.strip
+      configure
+      Module.__send__(:include, Skiplock::Extension) if @config[:extensions] == true
+      if (caller.any?{ |l| l =~ %r{/rack/} } && (@config[:workers] == 0 || Rails.env.development?))
+        cleanup_workers
+        @worker = create_worker
+        @thread = @worker.run(**@config)
+        at_exit do
+          @worker.shutdown
+          @thread.join(@config[:graceful_shutdown])
+          @worker.delete
+        end
       end
-      return unless standalone || restart || (caller.any?{|l| l =~ %r{/rack/}} && Settings['workers'] == 0)
-      if standalone
-        self.standalone
-      else
-        @dispatcher = Dispatcher.new
-        @thread = @dispatcher.run
-        at_exit { self.shutdown }
+    rescue Exception => ex
+      @logger.error(ex.name)
+      @logger.error(ex.backtrace.join("\n"))
+    end
+
+    def standalone(**options)
+      @config.merge!(options)
+      Rails.logger.reopen('/dev/null')
+      Rails.logger.extend(ActiveSupport::Logger.broadcast(@logger))
+      @config[:workers] = 1 if @config[:workers] <= 0
+      banner
+      cleanup_workers
+      @worker = create_worker
+      @parent_id = Process.pid
+      @shutdown = false
+      Signal.trap("INT") { @shutdown = true }
+      Signal.trap("TERM") { @shutdown = true }
+      (@config[:workers] - 1).times do |n|
+        fork do
+          sleep 1
+          worker = create_worker(master: false)
+          thread = worker.run(worker_num: n + 1, **@config)
+          loop do
+            sleep 0.5
+            break if @shutdown || Process.ppid != @parent_id
+          end
+          worker.shutdown
+          thread.join(@config[:graceful_shutdown])
+          worker.delete
+          exit
+        end
+      end
+      @thread = @worker.run(**@config)
+      loop do
+        sleep 0.5
+        break if @shutdown
       end
-      ActiveJob::Base.logger = nil
+      @logger.info "[Skiplock] Terminating signal... Waiting for jobs to finish (up to #{@config[:graceful_shutdown]} seconds)..." if @config[:graceful_shutdown]
+      Process.waitall
+      @worker.shutdown
+      @thread.join(@config[:graceful_shutdown])
+      @worker.delete
+      @logger.info "[Skiplock] Shutdown completed."
+    end
+
+    private
+
+    def banner
+      title = "Skiplock #{Skiplock::VERSION} (Rails #{Rails::VERSION::STRING} | Ruby #{RUBY_VERSION}-p#{RUBY_PATCHLEVEL})"
+      @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 "-"*(title.length)
+      @logger.warn "[Skiplock] Custom notification has no registered 'on_error' callback" if Skiplock.on_errors.count == 0
     end
-    
-    def self.shutdown(wait: true)
-      if @dispatcher && @thread
-        @dispatcher.shutdown(wait: wait)
-        @thread.join
-        @dispatcher = nil
-        @thread = nil
+
+    def cleanup_workers
+      delete_ids = []
+      Worker.where(hostname: @config[:hostname]).each do |worker|
+        sid = Process.getsid(worker.pid) rescue nil
+        delete_ids << worker.id if worker.sid != sid || worker.updated_at < 30.minutes.ago
       end
+      Worker.where(id: delete_ids).delete_all if delete_ids.count > 0
+      Job.where(running: true).where.not(worker_id: Worker.ids).update_all(running: false, worker_id: nil)
     end
 
-  private
+    def create_worker(master: true)
+      Worker.create!(pid: Process.pid, sid: Process.getsid(), master: master, hostname: @config[:hostname], capacity: @config[:max_threads])
+    rescue
+      Worker.create!(pid: Process.pid, sid: Process.getsid(), master: false, hostname: @config[:hostname], capacity: @config[:max_threads])
+    end
 
-    def self.load_settings
-      config = YAML.load_file('config/skiplock.yml') rescue {}
-      Settings.merge!(config)
-      Settings['queues'].values.each { |v| raise 'Queue value must be an integer' unless v.is_a?(Integer) } if Settings['queues'].is_a?(Hash)
-      @notification = Settings['notification'] = Settings['notification'].to_s.downcase
-      if @notification == 'auto'
+    def configure
+      @config[:loglevel] = 'info' unless ['debug','info','warn','error','fatal','unknown'].include?(@config[:loglevel].to_s)
+      @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
+      @config[:max_retries] = 0 if @config[:max_retries] < 0
+      @config[:max_threads] = 1 if @config[:max_threads] < 1
+      @config[:max_threads] = 20 if @config[:max_threads] > 20
+      @config[:min_threads] = 0 if @config[:min_threads] < 0
+      @config[:workers] = 0 if @config[:workers] < 0
+      @logger = ActiveSupport::Logger.new(STDOUT)
+      @logger.level = @config[:loglevel].to_sym
+      Skiplock.logger = @logger
+      raise "Cannot create logfile '#{@config[:logfile]}'" if @config[:logfile] && !File.writable?(File.dirname(@config[:logfile]))
+      @config[:logfile] = nil if @config[:logfile].to_s.length == 0
+      if @config[:logfile]
+        @logger.extend(ActiveSupport::Logger.broadcast(::Logger.new(@config[:logfile])))
+        ActiveJob::Base.logger = nil
+      end
+      @config[:queues].values.each { |v| raise 'Queue value must be an integer' unless v.is_a?(Integer) } if @config[:queues].is_a?(Hash)
+      if @config[:notification] == 'auto'
         if defined?(Airbrake)
-          @notification = 'airbrake'
+          @config[:notification] = 'airbrake'
         elsif defined?(Bugsnag)
-          @notification = 'bugsnag'
+          @config[:notification] = 'bugsnag'
         elsif defined?(ExceptionNotifier)
-          @notification = 'exception_notification'
+          @config[:notification] = 'exception_notification'
         else
-          puts "Unable to detect any known exception notification gem. Please define custom 'on_error' callback function and disable 'auto' notification in 'config/skiplock.yml'"
-          exit
+          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
-      case @notification
+      case @config[:notification]
       when 'airbrake'
         raise 'airbrake gem not found' unless defined?(Airbrake)
         Skiplock.on_error do |ex, previous|
@@ -72,93 +150,10 @@ module Skiplock
         Skiplock.on_error do |ex, previous|
           ExceptionNotifier.notify_exception(ex) unless ex.backtrace == previous.try(:backtrace)
         end
+      else
+        @config[:notification] = 'custom'
       end
-    rescue Exception => e
-      STDERR.puts "Invalid configuration 'config/skiplock.yml': #{e.message}"
-      exit
-    end
-
-    def self.standalone
-      if Settings['logging']
-        log_timestamp = (Settings['logging'].to_s == 'timestamp')
-        logfile = File.open('log/skiplock.log', 'a')
-        logfile.sync = true
-        $stdout = Demux.new(logfile, STDOUT, timestamp: log_timestamp)
-        errfile = File.open('log/skiplock.error.log', 'a')
-        errfile.sync = true
-        $stderr = Demux.new(errfile, STDERR, timestamp: log_timestamp)
-        logger = ActiveSupport::Logger.new($stdout)
-        logger.level = Rails.logger.level
-        Rails.logger.reopen('/dev/null')
-        Rails.logger.extend(ActiveSupport::Logger.broadcast(logger))
-      end
-      title = "Skiplock version: #{Skiplock::VERSION} (Ruby #{RUBY_VERSION}-p#{RUBY_PATCHLEVEL})"
-      puts "-"*(title.length)
-      puts title
-      puts "-"*(title.length)
-      puts "Purge completion: #{Settings['purge_completion']}"
-      puts "    Notification: #{Settings['notification']}#{(' (' + @notification + ')') if Settings['notification'] == 'auto'}"
-      puts "     Max retries: #{Settings['max_retries']}"
-      puts "     Min threads: #{Settings['min_threads']}"
-      puts "     Max threads: #{Settings['max_threads']}"
-      puts "     Environment: #{Rails.env}"
-      puts "         Logging: #{Settings['logging']}"
-      puts "         Workers: #{Settings['workers']}"
-      puts "          Queues: #{Settings['queues'].map {|k,v| k + '(' + v.to_s + ')'}.join(', ')}" if Settings['queues'].is_a?(Hash)
-      puts "             PID: #{Process.pid}"
-      puts "-"*(title.length)
-      parent_id = Process.pid
-      shutdown = false
-      Signal.trap("INT") { shutdown = true }
-      Signal.trap("TERM") { shutdown = true }
-      worker_pids = []
-      (Settings['workers']-1).times do |n|
-        worker_pids << fork do
-          dispatcher = Dispatcher.new(master: false, worker_num: n+1)
-          thread = dispatcher.run
-          loop do
-            sleep 0.5
-            break if shutdown || Process.ppid != parent_id
-          end
-          dispatcher.shutdown(wait: true)
-          thread.join
-          exit
-        end
-      end
-      sleep 0.1
-      dispatcher = Dispatcher.new(worker_pids: worker_pids)
-      thread = dispatcher.run
-      loop do
-        sleep 0.5
-        break if shutdown
-      end
-      Process.waitall
-      dispatcher.shutdown(wait: true)
-      thread.join
-    end
-
-    class Demux
-      def initialize(*targets, timestamp: true)
-        @targets = targets
-        @timestamp = timestamp
-      end
-
-      def close
-        @targets.each(&:close)
-      end
-
-      def flush
-        @targets.each(&:flush)
-      end
-  
-      def tty?
-        true
-      end
-
-      def write(*args)
-        args.prepend("[#{Time.now.utc}]: ") if @timestamp
-        @targets.each {|t| t.write(*args)}
-      end
+      Skiplock.on_errors.freeze unless Skiplock.on_errors.frozen?
     end
   end
 end

data/lib/skiplock/version.rb

@@ -1,4 +1,4 @@
 module Skiplock
-  VERSION = Version = '1.0.9'
+  VERSION = Version = '1.0.13'
 end
 

data/lib/skiplock/worker.rb

@@ -1,4 +1,117 @@
 module Skiplock
   class Worker < ActiveRecord::Base
+    self.implicit_order_column = 'created_at'
+
+    def run(worker_num: 0, **config)
+      @config = config
+      @worker_num = worker_num
+      @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
+      @next_schedule_at = Time.now.to_f
+      @executor = Concurrent::ThreadPoolExecutor.new(min_threads: @config[:min_threads], max_threads: @config[:max_threads], max_queue: @config[:max_threads], idletime: 60, auto_terminate: true, fallback_policy: :discard)
+      @running = true
+      Process.setproctitle("skiplock-#{self.master ? 'master[0]' : 'worker[' + @worker_num.to_s + ']'}") if @config[:standalone]
+      Thread.new do
+        @connection = self.class.connection
+        @connection.exec_query('LISTEN "skiplock::jobs"')
+        if self.master
+          Dir.mkdir('tmp/skiplock') unless Dir.exist?('tmp/skiplock')
+          check_sync_errors
+          Cron.setup
+        end
+        error = false
+        timestamp = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+        while @running
+          Rails.application.reloader.wrap do
+            begin
+              if error
+                unless @connection.active?
+                  @connection.reconnect!
+                  sleep(0.5)
+                  @connection.exec_query('LISTEN "skiplock::jobs"')
+                  @next_schedule_at = Time.now.to_f
+                end
+                check_sync_errors if self.master
+                error = false
+              end
+              job_notifications = []
+              @connection.raw_connection.wait_for_notify(0.1) do |channel, pid, payload|
+                job_notifications << payload if payload
+                loop do
+                  payload = @connection.raw_connection.notifies
+                  break unless @running && payload
+                  job_notifications << payload[:extra]
+                end
+                job_notifications.each do |n|
+                  op, id, worker_id, job_class, queue_name, running, expired_at, finished_at, scheduled_at = n.split(',')
+                  next if op == 'DELETE' || running == 'true' || expired_at.to_f > 0 || finished_at.to_f > 0
+                  if scheduled_at.to_f <= Time.now.to_f
+                    @next_schedule_at = Time.now.to_f
+                  elsif scheduled_at.to_f < @next_schedule_at
+                    @next_schedule_at = scheduled_at.to_f
+                  end
+                end
+              end
+              if Time.now.to_f >= @next_schedule_at && @executor.remaining_capacity > 0
+                job = dispatch_job
+                if job.is_a?(Job)
+                  @executor.post(job, @config[:purge_completion], @config[:max_retries]) do |job, purge_completion, max_retries|
+                    job.execute(purge_completion: purge_completion, max_retries: max_retries)
+                  end
+                else
+                  @next_schedule_at = job
+                end
+              end
+              if Process.clock_gettime(Process::CLOCK_MONOTONIC) - timestamp > 60
+                self.touch
+                timestamp = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+              end
+            rescue Exception => ex
+              # most likely error with database connection
+              Skiplock.logger.error(ex.name)
+              Skiplock.logger.error(ex.backtrace.join("\n"))
+              Skiplock.on_errors.each { |p| p.call(ex, @last_exception) }
+              error = true
+              t = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+              while @running
+                sleep(0.5)
+                break if Process.clock_gettime(Process::CLOCK_MONOTONIC) - t > 5
+              end
+              @last_exception = ex
+            end
+            sleep(0.2)
+          end
+        end
+        @connection.exec_query('UNLISTEN *')
+        @executor.shutdown
+        @executor.kill unless @executor.wait_for_termination(@config[:graceful_shutdown])
+      end
+    end
+
+    def shutdown
+      @running = false
+    end
+
+    private
+
+    def check_sync_errors
+      # get performed jobs that could not sync with database
+      Dir.glob('tmp/skiplock/*').each do |f|
+        job_from_db = Job.find_by(id: File.basename(f), running: true)
+        disposed = true
+        if job_from_db
+          job, ex = YAML.load_file(f) rescue nil
+          disposed = job.dispose(ex, purge_completion: @config[:purge_completion], max_retries: @config[:max_retries])
+        end
+        File.delete(f) if disposed
+      end
+    end
+
+    def dispatch_job
+      @connection.transaction do
+        job = Job.find_by_sql("SELECT id, 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
+        return (job ? job.scheduled_at.to_f : Float::INFINITY) if job.nil? || job.scheduled_at.to_f > Time.now.to_f
+        Job.find_by_sql("UPDATE skiplock.jobs SET running = TRUE, worker_id = '#{self.id}', updated_at = NOW() WHERE id = '#{job.id}' RETURNING *").first
+      end
+    end
   end
 end

data/lib/skiplock.rb

@@ -3,30 +3,31 @@ require 'active_job/queue_adapters/skiplock_adapter'
 require 'active_record'
 require 'skiplock/counter'
 require 'skiplock/cron'
-require 'skiplock/dispatcher'
+require 'skiplock/extension'
 require 'skiplock/job'
 require 'skiplock/manager'
 require 'skiplock/worker'
 require 'skiplock/version'
 
 module Skiplock
-  Settings = { 
-    'logging' => 'timestamp',
-    'min_threads' => 1,
-    'max_threads' => 5,
-    'max_retries' => 20,
-    'notification' => 'auto',
-    'purge_completion' => true,
-    'queues' => {
-      'default' => 200,
-      'mailers' => 100
-    },
-    'workers' => 0
-  }
-  mattr_reader :on_errors, default: []
+  DEFAULT_CONFIG = { 'extensions' => false, 'logfile' => 'log/skiplock.log', 'loglevel' => 'info', 'graceful_shutdown' => 15, 'min_threads' => 1, 'max_threads' => 5, 'max_retries' => 20, 'notification' => 'custom', 'purge_completion' => true, 'queues' => { 'default' => 100, 'mailers' => 999 }, 'workers' => 0 }.freeze
+
+  def self.logger=(l)
+    @logger = l
+  end
+
+  def self.logger
+    @logger
+  end
 
   def self.on_error(&block)
-    @@on_errors << block
+    @on_errors ||= []
+    @on_errors << block
+    block
+  end
+
+  def self.on_errors
+    @on_errors || []
   end
 
   def self.table_name_prefix

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: skiplock
 version: !ruby/object:Gem::Version
-  version: 1.0.9
+  version: 1.0.13
 platform: ruby
 authors:
 - Tin Vo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-08 00:00:00.000000000 Z
+date: 2021-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob
@@ -84,7 +84,7 @@ files:
 - lib/skiplock.rb
 - lib/skiplock/counter.rb
 - lib/skiplock/cron.rb
-- lib/skiplock/dispatcher.rb
+- lib/skiplock/extension.rb
 - lib/skiplock/job.rb
 - lib/skiplock/manager.rb
 - lib/skiplock/version.rb

data/lib/skiplock/dispatcher.rb

@@ -1,145 +0,0 @@
-module Skiplock
-  class Dispatcher
-    def initialize(master: true, worker_num: nil, worker_pids: [])
-      @queues_order_query = Settings['queues'].map { |q,v| "WHEN queue_name = '#{q}' THEN #{v}" }.join(' ') if Settings['queues'].is_a?(Hash) && Settings['queues'].count > 0
-      @executor = Concurrent::ThreadPoolExecutor.new(min_threads: Settings['min_threads'], max_threads: Settings['max_threads'], max_queue: Settings['max_threads'], idletime: 60, auto_terminate: true, fallback_policy: :discard)
-      @master = master
-      if @master
-        @worker_pids = worker_pids + [ Process.pid ]
-      else
-        @worker_num = worker_num
-      end
-      @last_dispatch_at = 0
-      @next_schedule_at = Time.now.to_f
-      @running = true
-    end
-    
-    def run
-      Thread.new do
-        Rails.application.reloader.wrap do
-          sleep(1) while @running && !Rails.application.initialized?
-          Rails.application.eager_load!
-          Process.setproctitle("skiplock-#{@master ? 'master[0]' : 'worker[' + @worker_num.to_s + ']'}") if Settings['workers'] > 0 && !Rails.env.development?
-          ActiveRecord::Base.connection_pool.with_connection do |connection|
-            connection.exec_query('LISTEN "skiplock::jobs"')
-            hostname = `hostname -f`.strip
-            @worker = Worker.create!(pid: Process.pid, ppid: (@master ? nil : Process.ppid), capacity: Settings['max_threads'], hostname: hostname)
-            if @master
-              connection.exec_query('LISTEN "skiplock::workers"')
-              Dir.mkdir('tmp/skiplock') unless Dir.exist?('tmp/skiplock')
-              check_sync_errors
-              # get dead worker ids
-              dead_worker_ids = Worker.where(hostname: hostname).where.not(pid: @worker_pids).ids
-              if dead_worker_ids.count > 0
-                # reset orphaned jobs of the dead worker ids for retry
-                Job.where(running: true).where(worker_id: dead_worker_ids).update_all(running: false, worker_id: nil)
-                # remove dead workers
-                Worker.where(id: dead_worker_ids).delete_all
-              end
-              # reset retries schedules on startup
-              Job.where('scheduled_at > NOW() AND executions IS NOT NULL AND expired_at IS NULL AND finished_at IS NULL').update_all(scheduled_at: nil, updated_at: Time.now)
-              Cron.setup
-            end
-            error = false
-            while @running
-              begin
-                if error
-                  unless connection.active?
-                    connection.reconnect!
-                    sleep(0.5)
-                    connection.exec_query('LISTEN "skiplock::jobs"')
-                    connection.exec_query('LISTEN "skiplock::workers"') if @master
-                    @next_schedule_at = Time.now.to_f
-                  end
-                  check_sync_errors
-                  error = false
-                end
-                notifications = { 'skiplock::jobs' => [], 'skiplock::workers' => [] }
-                connection.raw_connection.wait_for_notify(0.1) do |channel, pid, payload|
-                  notifications[channel] << payload if payload
-                  loop do
-                    payload = connection.raw_connection.notifies
-                    break unless @running && payload
-                    notifications[payload[:relname]] << payload[:extra]
-                  end
-                  notifications['skiplock::jobs'].each do |n|
-                    op, id, worker_id, queue_name, running, expired_at, finished_at, scheduled_at = n.split(',')
-                    if @master
-                      # TODO: report job status to action cable
-                    end
-                    next if op == 'DELETE' || running == 'true' || expired_at.to_f > 0 || finished_at.to_f > 0  || scheduled_at.to_f < @last_dispatch_at
-                    if scheduled_at.to_f < Time.now.to_f
-                      @next_schedule_at = Time.now.to_f
-                    elsif scheduled_at.to_f < @next_schedule_at
-                      @next_schedule_at = scheduled_at.to_f
-                    end
-                  end
-                  if @master
-                    # TODO: report worker status to action cable
-                    notifications['skiplock::workers'].each do |n|
-                    end
-                  end
-                end
-                if Time.now.to_f >= @next_schedule_at && @executor.remaining_capacity > 0
-                  @executor.post { do_work }
-                end
-              rescue Exception => ex
-                # most likely error with database connection
-                STDERR.puts ex.message
-                STDERR.puts ex.backtrace
-                Skiplock.on_errors.each { |p| p.call(ex, @last_exception) }
-                error = true
-                t = Time.now
-                while @running
-                  sleep(0.5)
-                  break if Time.now - t > 5
-                end
-                @last_exception = ex
-              end
-              sleep(0.2)
-            end
-            connection.exec_query('UNLISTEN *')
-            @executor.shutdown
-            @executor.wait_for_termination if @wait
-            @worker.delete if @worker
-          end
-        end
-      end
-    end
-
-    def shutdown(wait: true)
-      @running = false
-      @wait = wait
-    end
-
-    private
-
-    def check_sync_errors
-      # get performed jobs that could not sync with database
-      Dir.glob('tmp/skiplock/*').each do |f|
-        job_from_db = Job.find_by(id: File.basename(f), running: true)
-        disposed = true
-        if job_from_db
-          job, ex = YAML.load_file(f) rescue nil
-          disposed = job.dispose(ex)
-        end
-        File.delete(f) if disposed
-      end
-    end
-
-    def do_work
-      while @running
-        @last_dispatch_at = Time.now.to_f - 1  # 1 second allowance for timedrift
-        result = Job.dispatch(queues_order_query: @queues_order_query, worker_id: @worker.id)
-        next if result.is_a?(Job)
-        @next_schedule_at = result if result.is_a?(Float)
-        break
-      end
-    rescue Exception => ex
-      STDERR.puts ex.message
-      STDERR.puts ex.backtrace
-      Skiplock.on_errors.each { |p| p.call(ex, @last_exception) }
-      @last_exception = ex
-    end
-  end
-end