sidekiq-cron 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fcff473f7500a6ff2d006bb8af760d697b93aec6090b18e891f63a7b491396e2
-  data.tar.gz: 03a0e5508ee4f31e9c437c253bef8411a25de83deeb6e8c5eb18ccf84e836b50
+  metadata.gz: e256288ae9e2ffd550dfd47aa2d2776cb75edff89c2c7605bbd11685afba79b2
+  data.tar.gz: 84eded49d6d3e3da996a73902daf9f27010394b334c769fdebad789acdc006c9
 SHA512:
-  metadata.gz: 10d1500431656322f8f33feeec633bda703f601b98f1bc3e7f35e4ccfc93fef4fa4608d750a488282c0d02d274d9b2775969c1c072ebdd74292b00a6687593b8
-  data.tar.gz: 99aa76218a9acf896e10b801398ba5a6b4935ed33b24bf8fa5be25b0a30bf2c3c5afe2dd7cc30b7ad4b665ed827c1adc9fb48e5bb3987de60513ce334895fbda
+  metadata.gz: a329899c823ee69c96a8849eddb5abcfac3d99d5ac0003e2066f7e919c3bc25fa071518d0fe98c308d75d9076925ca22ec77c1fbc66acd1d740f14086c4c6a97
+  data.tar.gz: 917fd615b9855cfa55a90624be4769febc0de1d7e0012f928471f1ba5fa1aa543a39a212b8cd725f6be8eeb7d7494df5a3fb74b532abb8a5d970563ceb3b8da6

data/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 All notable changes to this project will be documented in this file.
 
+## 2.3.0
+
+- **WARNING** The default value for `available_namespaces` has changed from `nil` to `[default_namespace]`. Please refer to the [migration guide](https://github.com/sidekiq-cron/sidekiq-cron/blob/master/README.md#migrating-to-23) for further details (https://github.com/sidekiq-cron/sidekiq-cron/pull/552)
+- Fix deprecation warning for using raw params in WEB extension (https://github.com/sidekiq-cron/sidekiq-cron/pull/547)
+- Allow for sidekiq embedded configuration (https://github.com/sidekiq-cron/sidekiq-cron/pull/549)
+- Load schedule file within sidekiq callback (https://github.com/sidekiq-cron/sidekiq-cron/pull/550)
+- Fix missing default namespace if namespaces are explicitly provided (https://github.com/sidekiq-cron/sidekiq-cron/pull/551)
+
 ## 2.2.0
 
 - Add support for Sidekiq v8 (https://github.com/sidekiq-cron/sidekiq-cron/pull/531, https://github.com/sidekiq-cron/sidekiq-cron/pull/538)

data/README.md

@@ -56,7 +56,7 @@ gem "sidekiq-cron"
   'active_job' => true,  # enqueue job through Active Job interface
   'queue_name_prefix' => 'prefix', # Active Job queue with prefix
   'queue_name_delimiter' => '.', # Active Job queue with custom delimiter (default: '_')
-  'description' => 'A sentence describing what work this job performs'
+  'description' => 'A sentence describing what work this job performs',
   'status' => 'disabled' # default: enabled
 }
 ```
@@ -73,7 +73,7 @@ Sidekiq::Cron.configure do |config|
   config.cron_schedule_file = 'config/my_schedule.yml' # Default is 'config/schedule.yml'
   config.cron_history_size = 20 # Default is 10
   config.default_namespace = 'statistics' # Default is 'default'
-  config.available_namespaces = %w[statistics maintenance billing] # Default is `nil`
+  config.available_namespaces = %w[statistics maintenance billing] # Default is `[config.default_namespace]`
   config.natural_cron_parsing_mode = :strict # Default is :single
   config.reschedule_grace_period = 300 # Default is 60
 end
@@ -163,7 +163,7 @@ In the case you'd like to change this value, you can change it via the following
 
 ```ruby
 Sidekiq::Cron.configure do |config|
-  config.default_namespace = 'statics'
+  config.default_namespace = 'statistics'
 end
 ```
 
@@ -179,11 +179,21 @@ Sidekiq::Cron::Job.all('YOUR_OLD_NAMESPACE_NAME').each { |job| job.destroy }
 
 #### Available namespaces
 
-By default, Sidekiq Cron retrieves all existing jobs from Redis to determine the namespaces your application uses. However, this approach may not be suitable for large Redis installations. To address this, you can explicitly specify the list of available namespaces using the `available_namespaces` configuration option.
+By default, Sidekiq Cron uses the available_namespaces configuration option to determine which namespaces your application utilizes. The default namespace (`"default"`, by default) is always included in the list of available namespaces.
 
-If `available_namespaces` is set and a job is created with an unexpected namespace, a warning will be printed, and the job will be assigned to the default namespace.
+If you want Sidekiq Cron to automatically detect existing namespaces from the Redis database, you can set `available_namespaces` to the special option `:auto`.
 
-For more details and discussion, see [this issue](https://github.com/sidekiq-cron/sidekiq-cron/issues/516).
+If available_namespaces is explicitly set and a job is created with an unexpected namespace, a warning will be printed, and the job will be assigned to the default namespace.
+
+#### Migrating to 2.3
+
+As discussed in [this issue](https://github.com/sidekiq-cron/sidekiq-cron/issues/516), the approach introduced in Sidekiq Cron 2.0 for determining available namespaces using the `KEYS` command is not acceptable. Therefore, starting from version 2.3, namespacing has been reworked:
+
+- If you were not using the namespacing feature, no action is required. You can even remove `available_namespaces = %w[default]`, as it is now the default.
+
+- If you were using the namespacing feature and explicitly specified available namespaces as a list, no changes are needed.
+
+- If you were using the namespacing feature and relied on automatic namespace inference, you should either specify all used namespaces explicitly or set `available_namespaces` to `:auto` to maintain automatic detection. However, note that this approach does not scale well (see the referenced issue for details).
 
 #### Usage
 
@@ -530,18 +540,18 @@ RSpec.describe "Cron Schedule" do
 
   # Confirms that no jobs in the schedule have an invalid cron string.
   it "does not return any errors" do
-    expect(schedule_loader.load).to be_empty
+    expect(schedule_loader.load_schedule).to be_empty
   end
 
   # May be subject to churn, but adds confidence.
   it "adds the expected number of jobs" do
-    schedule_loader.load
+    schedule_loader.load_schedule
     expect(all_jobs.size).to eq 5
   end
 
   # Confirms that all job classes exist.
   it "has a valid class for each added job" do
-    schedule_loader.load
+    schedule_loader.load_schedule
     # Shows that all classes exist (as we can constantize the names without raising).
     job_classes = all_jobs.map { |job| job.klass.constantize }
     # Naive check that classes are sidekiq jobs (as they all have `.perfrom_async`).

data/lib/sidekiq/cron/job.rb

@@ -32,7 +32,7 @@ module Sidekiq
 
         default_namespace = Sidekiq::Cron.configuration.default_namespace
         @namespace = args["namespace"] || default_namespace
-        if Sidekiq::Cron::Namespace.available_namespaces_provided? && !Sidekiq::Cron::Namespace.all.include?(@namespace) && @namespace != default_namespace
+        if Sidekiq::Cron::Namespace.available_namespaces_provided? && !Sidekiq::Cron::Namespace.all.include?(@namespace)
           Sidekiq.logger.warn { "Cron Jobs - unexpected namespace #{@namespace} encountered. Assigning to default namespace." }
           @namespace = default_namespace
         end
@@ -693,7 +693,7 @@ module Sidekiq
       def self.job_keys_from_namespace(namespace = Sidekiq::Cron.configuration.default_namespace)
         Sidekiq.redis do |conn|
           if namespace == '*'
-            namespaces = Sidekiq::Cron.configuration.available_namespaces&.map { jobs_key(_1) } || conn.keys(jobs_key(namespace))
+            namespaces = Sidekiq::Cron::Namespace.all.map { jobs_key(_1) }
             namespaces.flat_map { |name| conn.smembers(name) }
           else
             conn.smembers(jobs_key(namespace))

data/lib/sidekiq/cron/namespace.rb

@@ -2,25 +2,20 @@ module Sidekiq
   module Cron
     class Namespace
       def self.all
-        namespaces = Sidekiq::Cron.configuration.available_namespaces
-        return namespaces if namespaces
-
-        Sidekiq.redis do |conn|
-          namespaces = conn.keys('cron_jobs:*').collect do |key|
-            key.split(':').last
+        namespaces = case (available_namespaces = Sidekiq::Cron.configuration.available_namespaces)
+          when NilClass then []
+          when Array then available_namespaces
+          when :auto
+            Sidekiq.redis do |conn|
+              conn.keys('cron_jobs:*').collect do |key|
+                key.split(':').last
+              end
+            end
+          else
+            raise ArgumentError, "Unexpected value provided for `available_namespaces`: #{available_namespaces.inspect}"
           end
-        end
-
-        # Adds the default namespace if not present
-        has_default = namespaces.detect do |name|
-          name == Sidekiq::Cron.configuration.default_namespace
-        end
-
-        unless has_default
-          namespaces << Sidekiq::Cron.configuration.default_namespace
-        end
 
-        namespaces
+        namespaces | [Sidekiq::Cron.configuration.default_namespace]
       end
 
       def self.all_with_count
@@ -33,15 +28,15 @@ module Sidekiq
       end
 
       def self.count(name = Sidekiq::Cron.configuration.default_namespace)
-        out = 0
         Sidekiq.redis do |conn|
-          out = conn.scard("cron_jobs:#{name}")
+          conn.scard("cron_jobs:#{name}")
         end
-        out
       end
 
       def self.available_namespaces_provided?
-        !!Sidekiq::Cron.configuration.available_namespaces
+        available_namespaces = Sidekiq::Cron.configuration.available_namespaces
+
+        available_namespaces != nil && available_namespaces != :auto
       end
     end
   end

data/lib/sidekiq/cron/schedule_loader.rb

@@ -49,8 +49,9 @@ module Sidekiq
 end
 
 Sidekiq.configure_server do |config|
-  schedule_loader = Sidekiq::Cron::ScheduleLoader.new
-  break unless schedule_loader.has_schedule_file?
-
-  config.on(:startup) { schedule_loader.load_schedule }
+  config.on(:startup) do
+    schedule_loader = Sidekiq::Cron::ScheduleLoader.new
+    next unless schedule_loader.has_schedule_file?
+    schedule_loader.load_schedule
+  end
 end

data/lib/sidekiq/cron/version.rb

@@ -2,6 +2,6 @@
 
 module Sidekiq
   module Cron
-    VERSION = "2.2.0"
+    VERSION = "2.3.0"
   end
 end

data/lib/sidekiq/cron/web_extension.rb

@@ -16,7 +16,11 @@ module Sidekiq
         end
 
         def redirect_to_previous_or_default
-          redirect params['redirect'] || namespace_redirect_path
+          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)

data/lib/sidekiq/cron.rb

@@ -58,7 +58,7 @@ module Sidekiq
         @cron_schedule_file = 'config/schedule.yml'
         @cron_history_size = 10
         @default_namespace = 'default'
-        @available_namespaces = nil
+        @available_namespaces = [@default_namespace]
         @natural_cron_parsing_mode = :single
         @reschedule_grace_period = 60
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-cron
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Ondrej Bartas
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-03-20 00:00:00.000000000 Z
+date: 2025-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cronex