resque-scheduler 4.10.2 → 4.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6cf8e385c64ab6efafcc8f3a499ec2dc8d7be736604e7d4578dd356f1c19d6e9
-  data.tar.gz: a564652590bf3c5dc85695cbbb57fb4ca85873de78c94f0580a104ef5d98cf55
+  metadata.gz: c4ecd4f957b7c3df8c89bc85ffb8951b5df6cc18b004379b29ebcfc3be982621
+  data.tar.gz: 7aacc351234c1f367d8b73cda10d43b97ff26e89a3319e0afa76b51abea70430
 SHA512:
-  metadata.gz: 2ab0cea69751963f68055eae115c349a885439a5b33c1c3046a5abd4fc30b676233964d430fa5aeb3eb7960d9339772d41ca31c575156eb4e6583cc66de7497e
-  data.tar.gz: f0a4ab726ea640f9df76bbb824078252fb90de9d40c90220611c71069363025933f4a97200c73c13c7c91ff4f02a8c64c735372bbd2e0510e4e5bd021ec081fb
+  metadata.gz: e668259967505827e06a40a83cb2e3b7c7c165df440c914c8e688c4d871594c46ac512ebb8a99856f4e3cf37f45625f5144bc6beeda1157c7b2d146eec9055cc
+  data.tar.gz: 32e7b921643fb62600d133db156c5f4c28d863a893a92d18ba1b1f7317b0371dd38cd11b0a1e2adcccfa211265f9d285b452d2e524d3637487e7c982c8563032

data/.github/workflows/codeql-analysis.yml

@@ -31,7 +31,7 @@ jobs:
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
-      uses: github/codeql-action/init@v2
+      uses: github/codeql-action/init@v3
       with:
         languages: ${{ matrix.language }}
         # If you wish to specify custom queries, you can do so here or in a config file.
@@ -42,7 +42,7 @@ jobs:
     # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
     # If this step fails, then you should remove it and run the build manually (see below)
     - name: Autobuild
-      uses: github/codeql-action/autobuild@v2
+      uses: github/codeql-action/autobuild@v3
 
     # ℹ️ Command-line programs to run using the OS shell.
     # 📚 https://git.io/JvXDl
@@ -56,4 +56,4 @@ jobs:
     #   make release
 
     - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v2
+      uses: github/codeql-action/analyze@v3

data/.github/workflows/ruby.yml

@@ -27,6 +27,7 @@ jobs:
           - "3.0"
           - 3.1
           - 3.2
+          - 3.3
         resque-version:
           - "master"
           - "~> 2.4.0"

data/CHANGELOG.md

@@ -2,6 +2,22 @@
 
 **ATTN**: This project uses [semantic versioning](http://semver.org/).
 
+## [4.10.3] - 2024-12-30
+### Added
+* Expose timeout for lock via environment variable configuration by @pmm4654 in #786
+* Add Ruby 3.3 to the CI matrix by @santiagorodriguez96 in #797
+
+### Fixed
+* Fix schedule hooks when enqueuing configured job by @codealchemy in #792
+* Fix undefined `header` method CI failures by @codealchemy in #793
+
+### Documentation
+* Fix typo by @dijonkitchen in #789
+* Fix links to generated docs by @dijonkitchen in #790
+
+### Security
+* Bump github/codeql-action from 2 to 3 by @dependabot in #785
+
 ## [4.10.2] - 2023-12-15
 ### Fixed
 * Finish fixing CVE-2022-44303, XSS in delayed_schedules by @PatrickTulskie in #783

data/README.md

@@ -28,7 +28,7 @@ Resque.enqueue_at(5.days.from_now, SomeJob, argument) # runs a job at a specific
 
 This `README` covers what most people need to know.  If you're looking
 for details on individual methods, you might want to try the
-[rdoc](http://rdoc.info/github/resque/resque-scheduler/master/frames).
+[rubydoc](https://rubydoc.info/github/resque/resque-scheduler/master/frames).
 
 ### Installation
 
@@ -86,7 +86,7 @@ namespace :resque do
     # If your schedule already has +queue+ set for each job, you don't
     # need to require your jobs.  This can be an advantage since it's
     # less code that resque-scheduler needs to know about. But in a small
-    # project, it's usually easier to just include you job classes here.
+    # project, it's usually easier to just include your job classes here.
     # So, something like this:
     require 'jobs'
   end

data/lib/resque/scheduler/cli.rb

@@ -15,7 +15,8 @@ module Resque
       quiet: 'QUIET',
       pidfile: 'PIDFILE',
       poll_sleep_amount: 'RESQUE_SCHEDULER_INTERVAL',
-      verbose: 'VERBOSE'
+      verbose: 'VERBOSE',
+      lock_timeout: 'LOCK_TIMEOUT'
     }.freeze
 
     class Cli

data/lib/resque/scheduler/configuration.rb

@@ -80,6 +80,13 @@ module Resque
           Float(environment.fetch('RESQUE_SCHEDULER_INTERVAL', '5'))
       end
 
+      # Sets timeout for Resque::Scheduler::Lock::Base
+      attr_writer :lock_timeout
+
+      def lock_timeout
+        @lock_timeout ||= environment.fetch('LOCK_TIMEOUT', 60 * 3).to_i
+      end
+
       private
 
       # Copied from https://github.com/rails/rails/blob/main/activemodel/lib/active_model/type/boolean.rb#L17

data/lib/resque/scheduler/delaying_extensions.rb

@@ -22,24 +22,22 @@ module Resque
       # timestamp has passed. It respects Resque.inline option, by
       # creating the job right away instead of adding to the queue.
       def enqueue_at_with_queue(queue, timestamp, klass, *args)
-        return false unless plugin.run_before_schedule_hooks(klass, *args)
-
-        if Resque.inline? || timestamp.to_i <= Time.now.to_i
-          # Just create the job and let resque perform it right away with
-          # inline.  If the class is a custom job class, call self#scheduled
-          # on it. This allows you to do things like
-          # Resque.enqueue_at(timestamp, CustomJobClass, :opt1 => val1).
-          # Otherwise, pass off to Resque.
-          if klass.respond_to?(:scheduled)
-            klass.scheduled(queue, klass.to_s, *args)
+        plugin.process_schedule_hooks(klass, *args) do
+          if Resque.inline? || timestamp.to_i <= Time.now.to_i
+            # Just create the job and let resque perform it right away with
+            # inline.  If the class is a custom job class, call self#scheduled
+            # on it. This allows you to do things like
+            # Resque.enqueue_at(timestamp, CustomJobClass, :opt1 => val1).
+            # Otherwise, pass off to Resque.
+            if klass.respond_to?(:scheduled)
+              klass.scheduled(queue, klass.to_s, *args)
+            else
+              Resque.enqueue_to(queue, klass, *args)
+            end
           else
-            Resque.enqueue_to(queue, klass, *args)
+            delayed_push(timestamp, job_to_hash_with_queue(queue, klass, args))
           end
-        else
-          delayed_push(timestamp, job_to_hash_with_queue(queue, klass, args))
         end
-
-        plugin.run_after_schedule_hooks(klass, *args)
       end
 
       # Identical to enqueue_at but takes number_of_seconds_from_now

data/lib/resque/scheduler/env.rb

@@ -54,6 +54,7 @@ module Resque
         at_exit { cleanup_pid_file }
       end
 
+      # rubocop:disable Metrics/AbcSize
       def setup_scheduler_configuration
         Resque::Scheduler.configure do |c|
           c.app_name = options[:app_name] if options.key?(:app_name)
@@ -66,6 +67,8 @@ module Resque
 
           c.logformat = options[:logformat] if options.key?(:logformat)
 
+          c.lock_timeout = options[:lock_timeout] if options.key?(:lock_timeout)
+
           if (psleep = options[:poll_sleep_amount]) && !psleep.nil?
             c.poll_sleep_amount = Float(psleep)
           end
@@ -73,6 +76,7 @@ module Resque
           c.verbose = !!options[:verbose] if options.key?(:verbose)
         end
       end
+      # rubocop:enable Metrics/AbcSize
 
       def cleanup_pid_file
         return unless pidfile_path

data/lib/resque/scheduler/lock/base.rb

@@ -11,7 +11,7 @@ module Resque
           @key = key
 
           # 3 minute default timeout
-          @timeout = options[:timeout] || 60 * 3
+          @timeout = options[:timeout] || Resque::Scheduler.lock_timeout
         end
 
         # Attempts to acquire the lock. Returns true if successfully acquired.

data/lib/resque/scheduler/plugin.rb

@@ -3,6 +3,15 @@
 module Resque
   module Scheduler
     module Plugin
+      def self.process_schedule_hooks(klass, *args)
+        # the documentation states that if any before_schedule hook returns
+        # false, the process should not be enqueued
+        return unless run_before_schedule_hooks(klass, *args)
+
+        yield
+        run_after_schedule_hooks(klass, *args)
+      end
+
       def self.hooks(job, pattern)
         job.methods.grep(/^#{pattern}/).sort
       end

data/lib/resque/scheduler/version.rb

@@ -2,6 +2,6 @@
 
 module Resque
   module Scheduler
-    VERSION = '4.10.2'.freeze
+    VERSION = '4.11.0'.freeze
   end
 end

data/lib/resque/scheduler.rb

@@ -331,17 +331,16 @@ module Resque
           # for non-existent classes (for example: running scheduler in
           # one app that schedules for another.
           if Class === klass
-            Resque::Scheduler::Plugin.run_before_delayed_enqueue_hooks(
-              klass, *params
-            )
-
-            # If the class is a custom job class, call self#scheduled on it.
-            # This allows you to do things like Resque.enqueue_at(timestamp,
-            # CustomJobClass). Otherwise, pass off to Resque.
-            if klass.respond_to?(:scheduled)
-              klass.scheduled(queue, klass_name, *params)
-            else
-              Resque.enqueue_to(queue, klass, *params)
+            Resque::Scheduler::Plugin.process_schedule_hooks(klass, *params) do
+              Resque::Scheduler::Plugin.run_before_delayed_enqueue_hooks(klass, *params)
+              # If the class is a custom job class, call self#scheduled on it.
+              # This allows you to do things like Resque.enqueue_at(timestamp,
+              # CustomJobClass). Otherwise, pass off to Resque.
+              if klass.respond_to?(:scheduled)
+                klass.scheduled(queue, klass_name, *params)
+              else
+                Resque.enqueue_to(queue, klass, *params)
+              end
             end
           else
             # This will not run the before_hooks in rescue, but will at least

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: resque-scheduler
 version: !ruby/object:Gem::Version
-  version: 4.10.2
+  version: 4.11.0
 platform: ruby
 authors:
 - Ben VandenBos
@@ -13,7 +13,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-12-15 00:00:00.000000000 Z
+date: 2024-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler