sidekiq-cron 2.3.1 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e088e2cce323ffd21798bdaf3818e6b49bb5dd7ae98e4005899df45603c9529
-  data.tar.gz: b3771467c144d7ac4de9f30f00f15fdff4fba7750ee3b0e74df09a3fd88215ba
+  metadata.gz: 24a9263df38117d217eaff38d09f5cc69029d2998a3cc07fd5f21878b340305c
+  data.tar.gz: 9cf118cc907fd84abdc0c0123fb23d6745b9fee021557560e35c55f9ff99fd35
 SHA512:
-  metadata.gz: 25cf2dc9507fc3b8a8e65b9a0e14bbc52449be13c4e7083f059b3cd1d07b0bac8006a3db5c77d37a18372cce12241e99c46f8d370c39ed8bcfc3a9791429c013
-  data.tar.gz: 60126836a12d6d1df44f76f2fdf4c473b1ec4e5dc723582e092cb6ac5e47178cffa7bf048b2afa7bf2fcf7f1428dd9ea1f4a8eb5ffe1c9b868a733fed12d0d0a
+  metadata.gz: 238cd9ccbf1f621090eca667e9e1b4c198589897869c7e8d89746886297bac0456dcd0452aa91f0e5e07af5e4e686d93f140089a44cd676cdf1711c45ced4e40
+  data.tar.gz: 404d91026a551fefd3e2a4c37bae8220e522b9a38a377cbbdc2f692331926495835feb2a4decf8dfe4a059e84ff6c45fc99e6c96c0f6156d53130586bf70b1bb

data/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 All notable changes to this project will be documented in this file.
 
+## 2.4.0
+
+- Fix reflected XSS on Sidekiq-UI (https://github.com/sidekiq-cron/sidekiq-cron/pull/568)
+- Add `cron_process_count_override` config option (https://github.com/sidekiq-cron/sidekiq-cron/pull/572)
+- Fix Spanish translation for enabled/disabled states (https://github.com/sidekiq-cron/sidekiq-cron/pull/575)
+- Allow to conditionally disable Sidekiq-Cron (https://github.com/sidekiq-cron/sidekiq-cron/pull/574)
+
 ## 2.3.1
 
 - Fix manually launch enqueue job not working from web UI (https://github.com/sidekiq-cron/sidekiq-cron/pull/564)

data/README.md

@@ -69,6 +69,7 @@ All configuration options:
 
 ```ruby
 Sidekiq::Cron.configure do |config|
+  config.enabled = false # Default is true
   config.cron_poll_interval = 10 # Default is 30
   config.cron_schedule_file = 'config/my_schedule.yml' # Default is 'config/schedule.yml'
   config.cron_history_size = 20 # Default is 10
@@ -521,6 +522,22 @@ Sidekiq::Cron.configure do |config|
 end
 ```
 
+You can also disable the entire engine by setting `enabled` to `false`. When disabled, Sidekiq-Cron will skip loading the schedule file on startup, which is useful for environments or specific Sidekiq processes where you don't need cron job scheduling at all:
+
+```ruby
+Sidekiq::Cron.configure do |config|
+  config.enabled = false
+end
+```
+
+Sidekiq will internally determine the process count by checking Redis but if polling has been disabled from some Sidekiq processes by setting the cron poll interval to zero, as explained above, that count might be incorrect. In that case, it is possible to override the default process count for Sidekiq Cron. This affects the way the random poll interval is calculated internally.
+
+```ruby
+Sidekiq::Cron.configure do |config|
+  config.cron_poll_process_count = 2
+end
+```
+
 ## Testing your configuration
 
 You can test your application's configuration by loading the schedule in your test suite. Below is an example using RSpec in a Rails project:

data/lib/sidekiq/cron/launcher.rb

@@ -13,6 +13,7 @@ module Sidekiq
       # Add cron poller and execute normal initialize of Sidekiq launcher.
       def initialize(config, **kwargs)
         config[:cron_poll_interval] = Sidekiq::Cron.configuration.cron_poll_interval.to_i
+        config[:cron_poll_process_count] = Sidekiq::Cron.configuration.cron_poll_process_count
 
         @cron_poller = Sidekiq::Cron::Poller.new(config) if config[:cron_poll_interval] > 0
         super

data/lib/sidekiq/cron/locales/es.yml

@@ -18,5 +18,5 @@ es:
   LastEnqueued: Último trabajo en cola
   NoCronJobsWereFound: No se encontraron trabajos
   NoHistoryWereFound: No se encontró histórico de trabajos
-  disabled: activo
-  enabled: inactivo
+  disabled: inactivo
+  enabled: activo

data/lib/sidekiq/cron/poller.rb

@@ -43,6 +43,10 @@ module Sidekiq
       def poll_interval_average(process_count = 1)
         @config[:cron_poll_interval]
       end
+
+      def process_count
+        @config[:cron_poll_process_count] || super
+      end
     end
   end
 end

data/lib/sidekiq/cron/schedule_loader.rb

@@ -50,6 +50,11 @@ end
 
 Sidekiq.configure_server do |config|
   config.on(:startup) do
+    unless Sidekiq::Cron.configuration.enabled
+      Sidekiq.logger.info { "Cron Jobs - skipping schedule loading, Sidekiq-Cron is disabled" }
+      next
+    end
+
     schedule_loader = Sidekiq::Cron::ScheduleLoader.new
     next unless schedule_loader.has_schedule_file?
     schedule_loader.load_schedule

data/lib/sidekiq/cron/version.rb

@@ -2,6 +2,6 @@
 
 module Sidekiq
   module Cron
-    VERSION = "2.3.1"
+    VERSION = "2.4.0"
   end
 end

data/lib/sidekiq/cron/views/cron.erb

@@ -2,23 +2,24 @@
   <header>
     <h2>
       <%= t('CronJobs') %>
-      <small>(<%= @current_namespace %>)</small>
+      <small>(<%= CGI.escapeHTML(@current_namespace.to_s) %>)</small>
     </h2>
     <% if @cron_jobs.size > 0 %>
+      <% escaped_current_namespace = CGI.escape(@current_namespace) %>
       <div class="filter buttons-row">
-        <form action="<%= root_path %>cron/namespaces/<%= @current_namespace %>/all/delete" method="post">
+        <form action="<%= root_path %>cron/namespaces/<%= escaped_current_namespace %>/all/delete" method="post">
           <%= csrf_tag %>
           <input class="btn btn-danger" type="submit" name="delete" value="<%= t('DeleteAll') %>" data-confirm="<%= t('AreYouSureDeleteCronJobs') %>" />
         </form>
-        <form action="<%= root_path %>cron/namespaces/<%= @current_namespace %>/all/disable" method="post">
+        <form action="<%= root_path %>cron/namespaces/<%= escaped_current_namespace %>/all/disable" method="post">
           <%= csrf_tag %>
           <input class="btn btn-primary" type="submit" name="enqueue" value="<%= t('DisableAll') %>" />
         </form>
-        <form action="<%= root_path %>cron/namespaces/<%= @current_namespace %>/all/enable" method="post">
+        <form action="<%= root_path %>cron/namespaces/<%= escaped_current_namespace %>/all/enable" method="post">
           <%= csrf_tag %>
           <input class="btn btn-primary" type="submit" name="enqueue" value="<%= t('EnableAll') %>" />
         </form>
-        <form action="<%= root_path %>cron/namespaces/<%= @current_namespace %>/all/enqueue" method="post">
+        <form action="<%= root_path %>cron/namespaces/<%= escaped_current_namespace %>/all/enqueue" method="post">
           <%= csrf_tag %>
           <input class="btn btn-primary" type="submit" name="enqueue" value="<%= t('EnqueueAll') %>" data-confirm="<%= t('AreYouSureEnqueueCronJobs') %>" />
         </form>

data/lib/sidekiq/cron/views/legacy/cron.erb

@@ -2,24 +2,25 @@
   <div class='col-sm-5 pull-left'>
     <h3>
       <%= t('CronJobs') %>
-      <small><%= @current_namespace %></small>
+      <small><%= CGI.escapeHTML(@current_namespace.to_s) %></small>
     </h3>
   </div>
   <div class='col-sm-7 pull-right h2'>
     <% if @cron_jobs.size > 0 %>
-      <form action="<%= root_path %>cron/namespaces/<%= @current_namespace %>/all/delete" method="post" class="pull-right">
+      <% escaped_current_namespace = CGI.escape(@current_namespace) %>
+      <form action="<%= root_path %>cron/namespaces/<%= escaped_current_namespace %>/all/delete" method="post" class="pull-right">
         <%= csrf_tag %>
         <input class="btn btn-danger" type="submit" name="delete" value="<%= t('DeleteAll') %>" data-confirm="<%= t('AreYouSureDeleteCronJobs') %>" />
       </form>
-      <form action="<%= root_path %>cron/namespaces/<%= @current_namespace %>/all/disable" method="post" class="pull-right">
+      <form action="<%= root_path %>cron/namespaces/<%= escaped_current_namespace %>/all/disable" method="post" class="pull-right">
         <%= csrf_tag %>
         <input class="btn btn-warn" type="submit" name="enqueue" value="<%= t('DisableAll') %>" />
       </form>
-      <form action="<%= root_path %>cron/namespaces/<%= @current_namespace %>/all/enable" method="post" class="pull-right">
+      <form action="<%= root_path %>cron/namespaces/<%= escaped_current_namespace %>/all/enable" method="post" class="pull-right">
         <%= csrf_tag %>
         <input class="btn btn-warn" type="submit" name="enqueue" value="<%= t('EnableAll') %>" />
       </form>
-      <form action="<%= root_path %>cron/namespaces/<%= @current_namespace %>/all/enqueue" method="post" class="pull-right">
+      <form action="<%= root_path %>cron/namespaces/<%= escaped_current_namespace %>/all/enqueue" method="post" class="pull-right">
         <%= csrf_tag %>
         <input class="btn btn-warn" type="submit" name="enqueue" value="<%= t('EnqueueAll') %>" data-confirm="<%= t('AreYouSureEnqueueCronJobs') %>" />
       </form>

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,6 +29,15 @@ 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
 
@@ -54,6 +67,7 @@ module Sidekiq
       attr_accessor :reschedule_grace_period
 
       def initialize
+        @enabled = true
         @cron_poll_interval = 30
         @cron_schedule_file = 'config/schedule.yml'
         @cron_history_size = 10
@@ -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

@@ -37,5 +37,5 @@ Gem::Specification.new do |s|
   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.3.1
+  version: 2.4.0
 platform: ruby
 authors:
 - Ondrej Bartas
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-08-08 00:00:00.000000000 Z
+date: 2026-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cronex
@@ -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
@@ -229,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