sidekiq-cron 2.1.0 → 2.4.0

data/lib/sidekiq/cron/web_extension.rb

@@ -1,25 +1,46 @@
 module Sidekiq
   module Cron
     module WebExtension
-      def self.registered(app)
-        app.settings.locales << File.join(File.expand_path("..", __FILE__), "locales")
-
-        app.helpers do
-          # This method constructs the URL for the cron jobs page within the specified namespace.
-          def namespace_redirect_path
-            "#{root_path}cron/namespaces/#{route_params[:namespace]}"
+      module Helpers
+        def cron_route_params(key)
+          if Gem::Version.new(Sidekiq::VERSION) >= Gem::Version.new("8.0.0")
+            route_params(key)
+          else
+            route_params[key]
           end
+        end
 
-          def redirect_to_previous_or_default
-            redirect params['redirect'] || namespace_redirect_path
-          end
+        # This method constructs the URL for the cron jobs page within the specified namespace.
+        def namespace_redirect_path
+          "#{root_path}cron/namespaces/#{cron_route_params(:namespace)}"
+        end
 
-          def render_erb(view)
-            views_path = File.join(File.expand_path("..", __FILE__), "views")
-            erb(File.read(File.join(views_path, "#{view}.erb")))
+        def redirect_to_previous_or_default
+          if Gem::Version.new(Sidekiq::VERSION) >= Gem::Version.new("8.0.0")
+            redirect url_params('redirect') || namespace_redirect_path
+          else
+            redirect params["redirect"] || namespace_redirect_path
           end
         end
 
+        def render_erb(view)
+          path = Gem::Version.new(Sidekiq::VERSION) >= Gem::Version.new("8.0.0") ? "views" : "views/legacy"
+          views_path = File.join(File.expand_path("..", __FILE__), path)
+          erb(File.read(File.join(views_path, "#{view}.erb")))
+        end
+      end
+
+      def self.registered(app)
+        locales = if Gem::Version.new(Sidekiq::VERSION) >= Gem::Version.new("8.0.0")
+                    Sidekiq::Web.configure.locales
+                  else
+                    app.settings.locales
+                  end
+
+        locales << File.join(File.expand_path("..", __FILE__), "locales")
+
+        app.helpers(Helpers)
+
         # Index page.
         app.get '/cron' do
           @current_namespace = 'default'
@@ -30,7 +51,7 @@ module Sidekiq
 
         # Detail page for a specific namespace.
         app.get '/cron/namespaces/:name' do
-          @current_namespace = route_params[:name]
+          @current_namespace = cron_route_params(:name)
           @cron_jobs = Sidekiq::Cron::Job.all(@current_namespace)
 
           render_erb(:cron)
@@ -38,8 +59,8 @@ module Sidekiq
 
         # Display job detail + jid history.
         app.get '/cron/namespaces/:namespace/jobs/:name' do
-          @current_namespace = route_params[:namespace]
-          @job = Sidekiq::Cron::Job.find(route_params[:name], @current_namespace)
+          @current_namespace = cron_route_params(:namespace)
+          @job = Sidekiq::Cron::Job.find(cron_route_params(:name), @current_namespace)
 
           if @job
             render_erb(:cron_show)
@@ -50,14 +71,14 @@ module Sidekiq
 
         # Enqueue all cron jobs.
         app.post '/cron/namespaces/:namespace/all/enqueue' do
-          Sidekiq::Cron::Job.all(route_params[:namespace]).each(&:enqueue!)
+          Sidekiq::Cron::Job.all(cron_route_params(:namespace)).each(&:enqueue!)
 
           redirect_to_previous_or_default
         end
 
         # Enqueue cron job.
         app.post '/cron/namespaces/:namespace/jobs/:name/enqueue' do
-          if job = Sidekiq::Cron::Job.find(route_params[:name], route_params[:namespace])
+          if job = Sidekiq::Cron::Job.find(cron_route_params(:name), cron_route_params(:namespace))
             job.enqueue!
           end
 
@@ -66,14 +87,14 @@ module Sidekiq
 
         # Delete all schedules.
         app.post '/cron/namespaces/:namespace/all/delete' do
-          Sidekiq::Cron::Job.all(route_params[:namespace]).each(&:destroy)
+          Sidekiq::Cron::Job.all(cron_route_params(:namespace)).each(&:destroy)
 
           redirect_to_previous_or_default
         end
 
         # Delete schedule.
         app.post '/cron/namespaces/:namespace/jobs/:name/delete' do
-          if job = Sidekiq::Cron::Job.find(route_params[:name], route_params[:namespace])
+          if job = Sidekiq::Cron::Job.find(cron_route_params(:name), cron_route_params(:namespace))
             job.destroy
           end
 
@@ -82,14 +103,14 @@ module Sidekiq
 
         # Enable all jobs.
         app.post '/cron/namespaces/:namespace/all/enable' do
-          Sidekiq::Cron::Job.all(route_params[:namespace]).each(&:enable!)
+          Sidekiq::Cron::Job.all(cron_route_params(:namespace)).each(&:enable!)
 
           redirect_to_previous_or_default
         end
 
         # Enable job.
         app.post '/cron/namespaces/:namespace/jobs/:name/enable' do
-          if job = Sidekiq::Cron::Job.find(route_params[:name], route_params[:namespace])
+          if job = Sidekiq::Cron::Job.find(cron_route_params(:name), cron_route_params(:namespace))
             job.enable!
           end
 
@@ -98,14 +119,14 @@ module Sidekiq
 
         # Disable all jobs.
         app.post '/cron/namespaces/:namespace/all/disable' do
-          Sidekiq::Cron::Job.all(route_params[:namespace]).each(&:disable!)
+          Sidekiq::Cron::Job.all(cron_route_params(:namespace)).each(&:disable!)
 
           redirect_to_previous_or_default
         end
 
         # Disable job.
         app.post '/cron/namespaces/:namespace/jobs/:name/disable' do
-          if job = Sidekiq::Cron::Job.find(route_params[:name], route_params[:namespace])
+          if job = Sidekiq::Cron::Job.find(cron_route_params(:name), cron_route_params(:namespace))
             job.disable!
           end
 

data/lib/sidekiq/cron.rb

@@ -14,6 +14,10 @@ module Sidekiq
     end
 
     class Configuration
+      # Whether Sidekiq-Cron is enabled. When set to false, the schedule file will not be loaded
+      # on startup. Defaults to true.
+      attr_accessor :enabled
+
       # The interval, in seconds, at which to poll for scheduled cron jobs.
       # This determines how frequently the scheduler checks for jobs to enqueue.
       attr_accessor :cron_poll_interval
@@ -25,9 +29,29 @@ module Sidekiq
       # This value controls how many past job executions are stored.
       attr_accessor :cron_history_size
 
+      # The number of polling processes for Sidekiq Cron.
+      #
+      # It is configurable to handle the case where only a subset of Sidekiq process
+      # are used for Sidekiq Cron polling where the default would be to poll from all processes.
+      #
+      # @note The process count is used internally to determine the random poll interval.
+      # @see https://github.com/sidekiq/sidekiq/blob/e03b317f2070655c51fad838b0ecfb99c6d6f853/lib/sidekiq/scheduled.rb#L129-L160
+      attr_reader :cron_poll_process_count
+
       # The default namespace is used when no namespace is specified.
       attr_accessor :default_namespace
 
+      # List of available namespaces
+      #
+      # If not set, Sidekiq Cron will dynamically fetch available namespaces
+      # by retrieving existing jobs from Redis.
+      #
+      # This dynamic fetching can negatively impact performance in certain cases.
+      # To mitigate this, you can provide the list of namespaces explicitly.
+      # If a job specifies a namespace that is not included in the provided list,
+      # a warning will be logged, and the job will be assigned to the default namespace.
+      attr_accessor :available_namespaces
+
       # The parsing mode when using the natural language cron syntax from the `fugit` gem.
       #
       # :single -- use the first parsed cron line and ignore the rest (default)
@@ -42,25 +66,15 @@ module Sidekiq
       # jobs that missed their schedules during the deployment. E.g., jobs that run once a day.
       attr_accessor :reschedule_grace_period
 
-      # List of available namespaces
-      #
-      # If not set, Sidekiq Cron will dynamically fetch available namespaces
-      # by retrieving existing jobs from Redis.
-      #
-      # This dynamic fetching can negatively impact performance in certain cases.
-      # To mitigate this, you can provide the list of namespaces explicitly.
-      # If a job specifies a namespace that is not included in the provided list,
-      # a warning will be logged, and the job will be assigned to the default namespace.
-      attr_accessor :available_namespaces
-
       def initialize
+        @enabled = true
         @cron_poll_interval = 30
         @cron_schedule_file = 'config/schedule.yml'
         @cron_history_size = 10
         @default_namespace = 'default'
+        @available_namespaces = [@default_namespace]
         @natural_cron_parsing_mode = :single
         @reschedule_grace_period = 60
-        @available_namespaces = nil
       end
 
       def natural_cron_parsing_mode=(mode)
@@ -70,6 +84,14 @@ module Sidekiq
 
         @natural_cron_parsing_mode = mode
       end
+
+      def cron_poll_process_count=(count)
+        unless count.is_a?(Integer) && count.positive?
+          raise ArgumentError, "invalid cron process count: #{count.inspect}"
+        end
+
+        @cron_poll_process_count = count
+      end
     end
   end
 end

data/sidekiq-cron.gemspec

@@ -33,9 +33,9 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency("minitest", "~> 5.15")
   s.add_development_dependency("mocha", "~> 2.1")
-  s.add_development_dependency("rack", "~> 2.2")
-  s.add_development_dependency("rack-test", "~> 1.1")
+  s.add_development_dependency("rack", ">= 2.2")
+  s.add_development_dependency("rack-test", ">= 1.1")
   s.add_development_dependency("rake", "~> 13.0")
   s.add_development_dependency("simplecov", "~> 0.21")
-  s.add_development_dependency("simplecov-cobertura", "~> 2.1")
+  s.add_development_dependency("simplecov-cobertura", "~> 3.1")
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-cron
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.4.0
 platform: ruby
 authors:
 - Ondrej Bartas
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-20 00:00:00.000000000 Z
+date: 2026-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cronex
@@ -104,28 +104,28 @@ dependencies:
   name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.2'
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.1'
 - !ruby/object:Gem::Dependency
@@ -162,14 +162,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '3.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '3.1'
 description: Enables to set jobs to be run in specified time (using CRON notation
   or natural language)
 email: ondrej@bartas.cz
@@ -204,6 +204,8 @@ files:
 - lib/sidekiq/cron/version.rb
 - lib/sidekiq/cron/views/cron.erb
 - lib/sidekiq/cron/views/cron_show.erb
+- lib/sidekiq/cron/views/legacy/cron.erb
+- lib/sidekiq/cron/views/legacy/cron_show.erb
 - lib/sidekiq/cron/web.rb
 - lib/sidekiq/cron/web_extension.rb
 - lib/sidekiq/options.rb
@@ -227,7 +229,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.16
 signing_key:
 specification_version: 4
 summary: Scheduler/Cron for Sidekiq jobs