sidekiq-cron 1.10.0 → 2.4.0

data/lib/sidekiq/cron/web_extension.rb

@@ -1,68 +1,136 @@
 module Sidekiq
   module Cron
     module WebExtension
+      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
+
+        # 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 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)
-        app.settings.locales << File.join(File.expand_path("..", __FILE__), "locales")
+        locales = if Gem::Version.new(Sidekiq::VERSION) >= Gem::Version.new("8.0.0")
+                    Sidekiq::Web.configure.locales
+                  else
+                    app.settings.locales
+                  end
 
-        # Index page of cron jobs.
+        locales << File.join(File.expand_path("..", __FILE__), "locales")
+
+        app.helpers(Helpers)
+
+        # Index page.
         app.get '/cron' do
-          view_path    = File.join(File.expand_path("..", __FILE__), "views")
+          @current_namespace = 'default'
+          @cron_jobs = Sidekiq::Cron::Job.all(@current_namespace)
+
+          render_erb(:cron)
+        end
 
-          @cron_jobs = Sidekiq::Cron::Job.all
+        # Detail page for a specific namespace.
+        app.get '/cron/namespaces/:name' do
+          @current_namespace = cron_route_params(:name)
+          @cron_jobs = Sidekiq::Cron::Job.all(@current_namespace)
 
-          render(:erb, File.read(File.join(view_path, "cron.erb")))
+          render_erb(:cron)
         end
 
         # Display job detail + jid history.
-        app.get '/cron/:name' do
-          view_path = File.join(File.expand_path("..", __FILE__), "views")
+        app.get '/cron/namespaces/:namespace/jobs/:name' do
+          @current_namespace = cron_route_params(:namespace)
+          @job = Sidekiq::Cron::Job.find(cron_route_params(:name), @current_namespace)
 
-          @job = Sidekiq::Cron::Job.find(route_params[:name])
           if @job
-            render(:erb, File.read(File.join(view_path, "cron_show.erb")))
+            render_erb(:cron_show)
           else
-            redirect "#{root_path}cron"
+            redirect namespace_redirect_path
           end
         end
 
+        # Enqueue all cron jobs.
+        app.post '/cron/namespaces/:namespace/all/enqueue' do
+          Sidekiq::Cron::Job.all(cron_route_params(:namespace)).each(&:enqueue!)
+
+          redirect_to_previous_or_default
+        end
+
         # Enqueue cron job.
-        app.post '/cron/:name/enque' do
-          if route_params[:name] === '__all__'
-            Sidekiq::Cron::Job.all.each(&:enque!)
-          elsif job = Sidekiq::Cron::Job.find(route_params[:name])
-            job.enque!
+        app.post '/cron/namespaces/:namespace/jobs/:name/enqueue' do
+          if job = Sidekiq::Cron::Job.find(cron_route_params(:name), cron_route_params(:namespace))
+            job.enqueue!
           end
-          redirect params['redirect'] || "#{root_path}cron"
+
+          redirect_to_previous_or_default
+        end
+
+        # Delete all schedules.
+        app.post '/cron/namespaces/:namespace/all/delete' do
+          Sidekiq::Cron::Job.all(cron_route_params(:namespace)).each(&:destroy)
+
+          redirect_to_previous_or_default
         end
 
         # Delete schedule.
-        app.post '/cron/:name/delete' do
-          if route_params[:name] === '__all__'
-            Sidekiq::Cron::Job.all.each(&:destroy)
-          elsif job = Sidekiq::Cron::Job.find(route_params[:name])
+        app.post '/cron/namespaces/:namespace/jobs/:name/delete' do
+          if job = Sidekiq::Cron::Job.find(cron_route_params(:name), cron_route_params(:namespace))
             job.destroy
           end
-          redirect "#{root_path}cron"
+
+          redirect_to_previous_or_default
+        end
+
+        # Enable all jobs.
+        app.post '/cron/namespaces/:namespace/all/enable' do
+          Sidekiq::Cron::Job.all(cron_route_params(:namespace)).each(&:enable!)
+
+          redirect_to_previous_or_default
         end
 
         # Enable job.
-        app.post '/cron/:name/enable' do
-          if route_params[:name] === '__all__'
-            Sidekiq::Cron::Job.all.each(&:enable!)
-          elsif job = Sidekiq::Cron::Job.find(route_params[:name])
+        app.post '/cron/namespaces/:namespace/jobs/:name/enable' do
+          if job = Sidekiq::Cron::Job.find(cron_route_params(:name), cron_route_params(:namespace))
             job.enable!
           end
-          redirect params['redirect'] || "#{root_path}cron"
+
+          redirect_to_previous_or_default
+        end
+
+        # Disable all jobs.
+        app.post '/cron/namespaces/:namespace/all/disable' do
+          Sidekiq::Cron::Job.all(cron_route_params(:namespace)).each(&:disable!)
+
+          redirect_to_previous_or_default
         end
 
         # Disable job.
-        app.post '/cron/:name/disable' do
-          if route_params[:name] === '__all__'
-            Sidekiq::Cron::Job.all.each(&:disable!)
-          elsif job = Sidekiq::Cron::Job.find(route_params[:name])
+        app.post '/cron/namespaces/:namespace/jobs/:name/disable' do
+          if job = Sidekiq::Cron::Job.find(cron_route_params(:name), cron_route_params(:namespace))
             job.disable!
           end
-          redirect params['redirect'] || "#{root_path}cron"
+
+          redirect_to_previous_or_default
         end
       end
     end

data/lib/sidekiq/cron.rb

@@ -1,9 +1,99 @@
-require "sidekiq/cron/job"
-require "sidekiq/cron/poller"
-require "sidekiq/cron/launcher"
-require "sidekiq/cron/schedule_loader"
-
 module Sidekiq
   module Cron
+    class << self
+      attr_accessor :configuration
+    end
+
+    def self.configure
+      self.configuration ||= Configuration.new
+      yield(configuration) if block_given?
+    end
+
+    def self.reset!
+      self.configuration = Configuration.new
+    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
+
+      # The path to a YAML file containing multiple cron job schedules.
+      attr_accessor :cron_schedule_file
+
+      # The maximum number of recent cron job execution histories to retain.
+      # 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)
+      # :strict -- raise an error if multiple cron lines are parsed from one string
+      attr_reader :natural_cron_parsing_mode
+
+      # The poller will not enqueue jobs that are late by more than this amount of seconds.
+      # Defaults to 60 seconds.
+      #
+      # This is useful when Sidekiq (and Sidekiq-Cron) is not used in zero downtime deployments and
+      # when the deployment is done and Sidekiq-Cron starts to catch up, it will consider older
+      # jobs that missed their schedules during the deployment. E.g., jobs that run once a day.
+      attr_accessor :reschedule_grace_period
+
+      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
+      end
+
+      def natural_cron_parsing_mode=(mode)
+        unless %i[single strict].include?(mode)
+          raise ArgumentError, "Unknown natural cron parsing mode: #{mode.inspect}"
+        end
+
+        @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
+
+Sidekiq::Cron.configure

data/lib/sidekiq/options.rb

@@ -1,24 +1,26 @@
-require 'sidekiq'
-
+# Module to access Sidekiq config
 module Sidekiq
   module Options
     def self.[](key)
-      options_field ? Sidekiq.public_send(options_field)[key] : Sidekiq[key]
+      self.config[key]
     end
 
     def self.[]=(key, value)
-      options_field ? Sidekiq.public_send(options_field)[key] = value : Sidekiq[key] = value
+      self.config[key] = value
+    end
+
+    def self.config
+      options_field ? Sidekiq.public_send(options_field) : Sidekiq
     end
 
     def self.options_field
       return @options_field unless @options_field.nil?
+
       sidekiq_version = Gem::Version.new(Sidekiq::VERSION)
       @options_field = if sidekiq_version >= Gem::Version.new('7.0')
         :default_configuration
-      elsif sidekiq_version >= Gem::Version.new('6.5')
-        false
       else
-        :options
+        false
       end
     end
   end

data/lib/sidekiq-cron.rb

@@ -1,2 +1,8 @@
 require "sidekiq"
 require "sidekiq/cron"
+require "sidekiq/options"
+require "sidekiq/cron/job"
+require "sidekiq/cron/namespace"
+require "sidekiq/cron/poller"
+require "sidekiq/cron/launcher"
+require "sidekiq/cron/schedule_loader"

data/sidekiq-cron.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |s|
     "LICENSE.txt",
     "README.md"
   ]
-  s.files = Dir.glob('lib/**/*') + Dir.glob('test/**/*') + [
+  s.files = Dir.glob('lib/**/*') + [
     "CHANGELOG.md",
     "Gemfile",
     "LICENSE.txt",
@@ -26,15 +26,16 @@ Gem::Specification.new do |s|
 
   s.required_ruby_version = ">= 2.7"
 
-  s.add_dependency("fugit", "~> 1.8")
-  s.add_dependency("sidekiq", ">= 6")
+  s.add_dependency("cronex", ">= 0.13.0")
+  s.add_dependency("fugit", "~> 1.8", ">= 1.11.1")
   s.add_dependency("globalid", ">= 1.0.1")
+  s.add_dependency("sidekiq", ">= 6.5.0")
 
   s.add_development_dependency("minitest", "~> 5.15")
-  s.add_development_dependency("mocha", "~> 1.14")
-  s.add_development_dependency("rack", "~> 2.2")
-  s.add_development_dependency("rack-test", "~> 1.1")
+  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("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,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-cron
 version: !ruby/object:Gem::Version
-  version: 1.10.0
+  version: 2.4.0
 platform: ruby
 authors:
 - Ondrej Bartas
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-13 00:00:00.000000000 Z
+date: 2026-05-06 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: cronex
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.13.0
 - !ruby/object:Gem::Dependency
   name: fugit
   requirement: !ruby/object:Gem::Requirement
@@ -17,6 +31,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.11.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -24,34 +41,37 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.11.1
 - !ruby/object:Gem::Dependency
-  name: sidekiq
+  name: globalid
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6'
+        version: 1.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6'
+        version: 1.0.1
 - !ruby/object:Gem::Dependency
-  name: globalid
+  name: sidekiq
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: 6.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: 6.5.0
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -72,40 +92,40 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   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
@@ -142,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
@@ -170,33 +190,26 @@ files:
 - lib/sidekiq/cron/launcher.rb
 - lib/sidekiq/cron/locales/de.yml
 - lib/sidekiq/cron/locales/en.yml
+- lib/sidekiq/cron/locales/es.yml
+- lib/sidekiq/cron/locales/id.yml
 - lib/sidekiq/cron/locales/it.yml
 - lib/sidekiq/cron/locales/ja.yml
 - lib/sidekiq/cron/locales/pt.yml
 - lib/sidekiq/cron/locales/ru.yml
 - lib/sidekiq/cron/locales/zh-CN.yml
+- lib/sidekiq/cron/namespace.rb
 - lib/sidekiq/cron/poller.rb
 - lib/sidekiq/cron/schedule_loader.rb
 - lib/sidekiq/cron/support.rb
 - 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
 - sidekiq-cron.gemspec
-- test/integration/performance_test.rb
-- test/models/person.rb
-- test/test_helper.rb
-- test/unit/fixtures/schedule_array.yml
-- test/unit/fixtures/schedule_erb.yml
-- test/unit/fixtures/schedule_hash.yml
-- test/unit/fixtures/schedule_string.yml
-- test/unit/job_test.rb
-- test/unit/launcher_test.rb
-- test/unit/poller_test.rb
-- test/unit/schedule_loader_test.rb
-- test/unit/web_extension_test.rb
 homepage: https://github.com/sidekiq-cron/sidekiq-cron
 licenses:
 - MIT
@@ -216,7 +229,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
+rubygems_version: 3.5.16
 signing_key:
 specification_version: 4
 summary: Scheduler/Cron for Sidekiq jobs

data/test/integration/performance_test.rb

@@ -1,46 +0,0 @@
-require './test/test_helper'
-require 'benchmark'
-
-describe 'Performance Poller' do
-  JOBS_NUMBER = 10_000
-  MAX_SECONDS = 60
-
-  before do
-    # Clear all previous saved data from Redis.
-    Sidekiq.redis do |conn|
-      conn.flushdb
-    end
-
-    args = {
-      queue: "default",
-      cron: "*/2 * * * *",
-      klass: "CronTestClass"
-    }
-
-    JOBS_NUMBER.times do |i|
-      Sidekiq::Cron::Job.create(args.merge(name: "Test#{i}"))
-    end
-
-    @poller = Sidekiq::Cron::Poller.new(Sidekiq.const_defined?(:Config) ? Sidekiq::Config.new : {})
-    now = Time.now.utc + 3600
-    enqueued_time = Time.new(now.year, now.month, now.day, now.hour, 10, 5)
-    Time.stubs(:now).returns(enqueued_time)
-  end
-
-  it "should enqueue #{JOBS_NUMBER} jobs in less than #{MAX_SECONDS}s" do
-    Sidekiq.redis do |conn|
-      assert_equal 0, conn.llen("queue:default"), 'Queue should be empty'
-    end
-
-    bench = Benchmark.measure {
-      @poller.enqueue
-    }
-
-    Sidekiq.redis do |conn|
-      assert_equal JOBS_NUMBER, conn.llen("queue:default"), 'Queue should be full'
-    end
-
-    puts "Performance test finished in #{bench.real}"
-    assert_operator bench.real, :<, MAX_SECONDS
-  end
-end

data/test/models/person.rb

@@ -1,21 +0,0 @@
-class Person
-  include GlobalID::Identification
-
-  attr_reader :id
-
-  def self.find(id)
-    new(id)
-  end
-
-  def initialize(id)
-    @id = id
-  end
-
-  def to_global_id(options = {})
-    super app: "app"
-  end
-
-  def ==(other_person)
-    other_person.is_a?(Person) && id.to_s == other_person.id.to_s
-  end
-end