skiplock 1.0.17 → 1.0.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d9533e3df15a24e784000c160588b96207271986bf927bff095752e556c3376a
-  data.tar.gz: dcc40ab796f55fc41363d671d5e4f73600c58c468d7c4543e496fad38c3e9a8a
+  metadata.gz: 8112589dcbdf58a743529ec9bf5ddd8371791e83e79c0d455ed42cbca05ee5eb
+  data.tar.gz: 149f826e93ecd8ac6165a8db46a8e7e234636a4481e68bf09d208b04a1dea1ce
 SHA512:
-  metadata.gz: 0a0c21835b52f749022d7f3a135f041d122425defffaf6aebb6d8510d4dd0836aed2fb9977daff9e7d3bf2547e139d2dd3ea49f5f55a869ce851c93aaeb56a12
-  data.tar.gz: d94c6801c82e1bddb12cff0152b71e8554d03de4d28f51ec0d742807311adecca1b3b142aeadf3cd5e81336416b03206d81848f6da6abf8e0f8c726631a5d898
+  metadata.gz: 437f622f2398a0a6c965ea1720f77f11b9241373f277e249e4f3d39afbd3bccc7d8ad2b919abd141ebc5bc6a2543408a7940e53f2968c3cda9fc0519ac387910
+  data.tar.gz: '0473939dc2497842ff66fb02e2f74371f7281d58cc5ac82f1999b669f5b45e526d5d75054a3cc95594e26fc5f4e4aafc42e15d2f7336b88223256d6f7ac46d4e'

data/README.md

@@ -106,7 +106,7 @@ Inside the Rails application:
     MyJob.set(wait_until: Day.tomorrow.noon).perform_later(1,2,3)
     ```
 - Skiplock supports custom options which override the global `Skiplock` configuration options for specified jobs
-    - **purge** (*boolean*): whether to remove this job after it has ran successfully
+    - **purge** (*boolean*): whether to remove this job after it has completed successfully
     - **max_retries** (*integer*): set maximum retry attempt for this job
     ```ruby
     MyJob.set(purge: false, max_retries: 5).perform_later(1,2,3)
@@ -119,7 +119,8 @@ Outside the Rails application:
 - with scheduling, priority, queue, arguments and custom options
     ```sql
     INSERT INTO skiplock.jobs(job_class, queue_name, priority, scheduled_at, data)
-      VALUES ('MyJob', 'my_queue', 10, NOW() + INTERVAL '5 min', '{"arguments":[1,2,3],"options":{"purge":false,"max_retries":5}}');
+      VALUES ('MyJob', 'my_queue', 10, NOW() + INTERVAL '5 min',
+      '{"arguments":[1,2,3],"options":{"purge":false,"max_retries":5}}');
     ```
 ## Queue priority vs Job priority
 *Why do queues use priorities when jobs already have priorities?*
@@ -183,10 +184,14 @@ If the `retry_on` block is not defined, then the built-in retry system of `Skipl
   # supports multiple 'on_error' event callbacks
 ```
 ## ClassMethod extension
-`Skiplock` can add extension to allow class methods to be performed as a background job; it is disabled in the default configuration.  To enable globally for all classes and modules, edit the `config/skiplock.yml` configuration file and change `extensions` to `true`; this can expose remote execution if the `skiplock.jobs` database table is not secured properly.  To enable extension for specific classes and modules only then set the configuration to an array of names of the classes and modules eg. `['MyClass', 'MyModule']`
-- An example of remote execution if the extension is enabled globally (ie: configuration is set to `true`) and attacker can insert `skiplock.jobs`
+`Skiplock` can add extension to allow class methods to be performed as a background job; it is disabled in the default configuration.  To enable globally for all classes and modules, edit the `config/skiplock.yml` configuration file and change `extensions` to `true`; this can expose remote code execution if the `skiplock.jobs` database table is not secured properly.
+
+To enable extension for specific classes and modules only then set the configuration to an array of names of the classes and modules eg. `['MyClass', 'MyModule']`
+- An example of remote code execution if the extension is enabled globally (ie: configuration is set to `true`) and attacker can insert `skiplock.jobs`
   ```sql
-  INSERT INTO skiplock.jobs(job_class, data) VALUES ('Skiplock::Extension::ProxyJob', '{"arguments":["---\n- !ruby/module ''Kernel''\n- :system\n- - rm -rf /tmp/*\n"]}');
+  INSERT INTO skiplock.jobs(job_class, data)
+    VALUES ('Skiplock::Extension::ProxyJob',
+    '{"arguments":["---\n- !ruby/module ''Kernel''\n- :system\n- - rm -rf /tmp/*\n"]}');
   ```
 - Queue class method `generate_thumbnails` of class `Image` as background job to run as soon as possible
   ```ruby

data/lib/skiplock/cron.rb

@@ -11,7 +11,7 @@ module Skiplock
         if time
           job.cron = cron
           job.running = false
-          job.scheduled_at = Time.at(time)
+          job.scheduled_at = Time.at(time) unless job.try(:executions).to_i > 0  # do not update schedule of retrying cron jobs
           job.save
           cronjobs << j.name
         end

data/lib/skiplock/extension.rb

@@ -11,9 +11,12 @@ module Skiplock
       end
     end
 
+    class ProxyError < StandardError; end
+
     class ProxyJob < ActiveJob::Base
       def perform(yml)
-        target, method_name, args = ::YAML.load(yml)
+        target, method_name, args = ::YAML.load(yml) rescue nil
+        raise ProxyError, "Skiplock extension is not allowed for:\n#{yml}" unless target.respond_to?(:skiplock)
         target.__send__(method_name, *args)
       end
     end

data/lib/skiplock/job.rb

@@ -1,6 +1,6 @@
 module Skiplock
   class Job < ActiveRecord::Base
-    self.implicit_order_column = 'created_at'
+    self.implicit_order_column = 'updated_at'
     attr_accessor :activejob_retry
     belongs_to :worker, inverse_of: :jobs, required: false
 
@@ -22,6 +22,7 @@ module Skiplock
       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].executions = activejob.executions
         Thread.current[:skiplock_job].exception_executions = activejob.exception_executions
         Thread.current[:skiplock_job].scheduled_at = timestamp
@@ -33,7 +34,7 @@ module Skiplock
       end
     end
 
-    # resynchronize jobs that could not commit to database and retry any abandoned jobs
+    # resynchronize jobs that could not commit to database and reset any abandoned jobs for retry
     def self.flush
       Dir.mkdir('tmp/skiplock') unless Dir.exist?('tmp/skiplock')
       Dir.glob('tmp/skiplock/*').each do |f|
@@ -61,7 +62,7 @@ module Skiplock
       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.activejob_retry
+        if (self.executions.to_i >= @max_retries + 1) || self.data.key?('activejob_retry') || @exception.is_a?(Skiplock::Extension::ProxyError)
           self.expired_at = Time.now
         else
           self.scheduled_at = Time.now + (5 * 2**self.executions.to_i)
@@ -71,6 +72,7 @@ module Skiplock
           self.data['cron'] ||= {}
           self.data['cron']['executions'] = self.data['cron']['executions'].to_i + 1
           self.data['cron']['last_finished_at'] = self.finished_at.utc.to_s
+          self.data['cron']['last_result'] = self.data['result']
           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
@@ -78,6 +80,7 @@ module Skiplock
             self.finished_at = nil
             self.executions = nil
             self.exception_executions = nil
+            self.data.delete('result')
             self.scheduled_at = Time.at(next_cron_at)
           else
             Skiplock.logger.error("[Skiplock] ERROR: Invalid CRON '#{self.cron}' for Job #{self.job_class}") if Skiplock.logger

data/lib/skiplock/manager.rb

@@ -1,11 +1,10 @@
 module Skiplock
   class Manager
-    def initialize(**config)
+    def initialize
       @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)
       @hostname = Socket.gethostname
       configure
       setup_logger
@@ -22,7 +21,7 @@ module Skiplock
 
     def standalone(**options)
       @config.merge!(options)
-      Rails.logger.reopen('/dev/null')
+      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

data/lib/skiplock/version.rb

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

data/lib/skiplock/worker.rb

@@ -1,6 +1,6 @@
 module Skiplock
   class Worker < ActiveRecord::Base
-    self.implicit_order_column = 'created_at'
+    self.implicit_order_column = 'updated_at'
     has_many :jobs, inverse_of: :worker
 
     def self.cleanup(hostname = nil)
@@ -42,7 +42,7 @@ module Skiplock
 
     def get_next_available_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
+        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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: skiplock
 version: !ruby/object:Gem::Version
-  version: 1.0.17
+  version: 1.0.18
 platform: ruby
 authors:
 - Tin Vo