sidekiq-cron 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f6e739f09f2271ea9904b73771ac03701be57e5eae64e3dd3963e772cda7bdb2
-  data.tar.gz: 2ab0776fd2dad66b0db9ba38904a3edfbc540e854187f7a59ca205a748b4fd74
+  metadata.gz: 1d5f570d2d2d72cdb4fc1a2458dc6cae7abfa5a0da1f27915310b5d5dc835e89
+  data.tar.gz: 514d74f88c65af3db1956190ca9092d4f1a95d6bce4b0a9191463e2bb0f9181a
 SHA512:
-  metadata.gz: 9231cf42e072213083e19c924a09838185faf20d240db195cba87db8f406443ac83172622e4ed89652d09f669e6ce04b7bae3a7836755b28043350c1e2ca056a
-  data.tar.gz: 9b63c398a1e129701a20330c5e801f8f36a04651366ed3f38d01061d86033774eb9fe845097af0041f465083d433f4ef783e1be8abf1d083a43f6e3e714c3057
+  metadata.gz: 61f4af041526789dcf51264baa88a5e1855fa124a0fe9f2c5ed04eec36bd4b617aae1152890ab281d5938914725ba9cce812f70bc258a6e4b8d82b642882212a
+  data.tar.gz: 9e82488bd6459b3ce373e52c94fc3607631b5fc67fa58e578d190368a09f4edc3b4502318646d5285e9fb9d139a080d90d560b28ad31a56e9d01d81d1dc0a2f8

data/CHANGELOG.md

@@ -2,6 +2,16 @@
 
 All notable changes to this project will be documented in this file.
 
+## 2.1.0
+
+- Add `available_namespaces` configuration option (https://github.com/sidekiq-cron/sidekiq-cron/pull/524)
+- I18n fixes and enhancements (https://github.com/sidekiq-cron/sidekiq-cron/pull/520, https://github.com/sidekiq-cron/sidekiq-cron/pull/522)
+
+## 2.0.1
+
+- Fix usage of ActiveJob::Base.queue_name (https://github.com/sidekiq-cron/sidekiq-cron/pull/517)
+- Fix: Add quotes to Japanese translations containing multi-byte symbols (https://github.com/sidekiq-cron/sidekiq-cron/pull/515)
+
 ## 2.0.0
 
 Sidekiq-Cron v2 is here! In this release we refactored some internals, plus:

data/Gemfile

@@ -4,3 +4,6 @@ gemspec
 
 # To test different Sidekiq versions
 gem "sidekiq", ENV.fetch("SIDEKIQ_VERSION", ">= 6")
+
+# To test different Active Job versions
+gem "activejob", ENV.fetch("ACTIVE_JOB_VERSION", "~> 7")

data/README.md

@@ -1,7 +1,7 @@
 ![Sidekiq-Cron](logos/cover.png)
 
 [![Gem Version](https://badge.fury.io/rb/sidekiq-cron.svg)](https://badge.fury.io/rb/sidekiq-cron)
-[![Build Status](https://github.com/sidekiq-cron/sidekiq-cron/workflows/CI/badge.svg?branch=master)](https://github.com/sidekiq-cron/sidekiq-cron/actions)
+[![CI](https://github.com/sidekiq-cron/sidekiq-cron/actions/workflows/ci.yml/badge.svg)](https://github.com/sidekiq-cron/sidekiq-cron/actions/workflows/ci.yml)
 [![codecov](https://codecov.io/gh/sidekiq-cron/sidekiq-cron/branch/master/graph/badge.svg?token=VK9IVLIaY8)](https://codecov.io/gh/sidekiq-cron/sidekiq-cron)
 
 > A scheduling add-on for [Sidekiq](https://sidekiq.org/)
@@ -75,6 +75,7 @@ Sidekiq::Cron.configure do |config|
   config.default_namespace = 'statistics' # Default is 'default'
   config.natural_cron_parsing_mode = :strict # Default is :single
   config.reschedule_grace_period = 300 # Default is 60
+  config.available_namespaces = %w[maintenance billing] # Default is `nil`
 end
 ```
 
@@ -166,6 +167,24 @@ Sidekiq::Cron.configure do |config|
 end
 ```
 
+#### Renaming namespace
+
+If you rename the namespace of a job that is already running, the gem will not automatically delete the cron job associated with the old namespace. This means you could end up with two cron jobs running simultaneously.
+
+To avoid this, it is recommended to delete all existing cron jobs associated with the old namespace before making the change. You can achieve this with the following code:
+
+```ruby
+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.
+
+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.
+
+For more details and discussion, see [this issue](https://github.com/sidekiq-cron/sidekiq-cron/issues/516).
+
 #### Usage
 
 When creating a new job, you can optionally give a `namespace` attribute, and then you can pass it too in the `find` or `destroy` methods.

data/lib/sidekiq/cron/job.rb

@@ -26,11 +26,17 @@ module Sidekiq
         @fetch_missing_args = true if @fetch_missing_args.nil?
 
         @name = args["name"]
-        @namespace = args["namespace"] || Sidekiq::Cron.configuration.default_namespace
         @cron = args["cron"]
         @description = args["description"] if args["description"]
         @source = args["source"] == "schedule" ? "schedule" : "dynamic"
 
+        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
+          Sidekiq.logger.warn { "Cron Jobs - unexpected namespace #{@namespace} encountered. Assigning to default namespace." }
+          @namespace = default_namespace
+        end
+
         # Get class from klass or class.
         @klass = args["klass"] || args["class"]
 
@@ -70,7 +76,7 @@ module Sidekiq
 
           # Get right data for message,
           # only if message wasn't specified before.
-          klass_data = get_job_class_options(@klass)
+          klass_data = get_job_options(@klass, @args)
           message_data = klass_data.merge(message_data)
 
           # Override queue and retry if set in config,
@@ -687,7 +693,7 @@ module Sidekiq
       def self.job_keys_from_namespace(namespace = Sidekiq::Cron.configuration.default_namespace)
         Sidekiq.redis do |conn|
           if namespace == '*'
-            namespaces = conn.keys(jobs_key(namespace))
+            namespaces = Sidekiq::Cron.configuration.available_namespaces&.map { jobs_key(_1) } || conn.keys(jobs_key(namespace))
             namespaces.flat_map { |name| conn.smembers(name) }
           else
             conn.smembers(jobs_key(namespace))
@@ -793,7 +799,7 @@ module Sidekiq
         end
       end
 
-      def get_job_class_options(klass)
+      def get_job_options(klass, args)
         klass = klass.is_a?(Class) ? klass : begin
           Sidekiq::Cron::Support.constantize(klass)
         rescue NameError
@@ -804,7 +810,9 @@ module Sidekiq
           # Unknown class
           {"queue"=>"default"}
         elsif is_active_job?(klass)
-          {"queue"=>klass.queue_name}
+          job = klass.new(args)
+
+          {"queue"=>job.queue_name}
         else
           klass.get_sidekiq_options
         end

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

@@ -0,0 +1,22 @@
+es:
+  AreYouSureDeleteCronJob: ¿Estás seguro de que quieres borrar el trabajo cron %{job}?
+  AreYouSureDeleteCronJobs: ¿Estás seguro de que quieres borrar TODOS los trabajos cron?
+  AreYouSureEnqueueCronJob: ¿Estás seguro de que quieres poner en cola el trabajo cron %{job}?
+  AreYouSureEnqueueCronJobs: ¿Estás seguro de que quieres poner en cola TODOS los trabajos cron?
+  Cron: Cron
+  CronJobs: Trabajos cron programados
+  CronString: Cron
+  DeleteAll: Borrar todo
+  Description: Descripción
+  Disable: Desactivar
+  DisableAll: Desactivar todos
+  Enable: Activar
+  EnableAll: Activar todos
+  EnqueueAll: Poner todos en cola
+  EnqueueNow: Poner en cola ahora
+  Job: Trabajo
+  LastEnqueued: Último trabajo en cola
+  NoCronJobsWereFound: No se encontraron trabajos
+  NoHistoryWereFound: No se encontró histórico de trabajos
+  disabled: activo
+  enabled: inactivo

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

@@ -1,8 +1,8 @@
 ja:
-  AreYouSureDeleteCronJob: 本当に%{job}のcronジョブを削除しますか？
-  AreYouSureDeleteCronJobs: 本当にすべてのcronジョブを削除しますか？
-  AreYouSureEnqueueCronJob: %{job} の クロン ジョブをキューに入れてもよろしいですか？
-  AreYouSureEnqueueCronJobs: すべての クロン ジョブをキューに入れてもよろしいですか？
+  AreYouSureDeleteCronJob: "本当に%{job}のcronジョブを削除しますか？"
+  AreYouSureDeleteCronJobs: "本当にすべてのcronジョブを削除しますか？"
+  AreYouSureEnqueueCronJob: "%{job} の cronジョブをキューに入れてもよろしいですか？"
+  AreYouSureEnqueueCronJobs: "すべての cronジョブをキューに入れてもよろしいですか？"
   Cron: Cron
   CronJobs: Cronジョブ
   CronString: Cron

data/lib/sidekiq/cron/namespace.rb

@@ -2,7 +2,8 @@ module Sidekiq
   module Cron
     class Namespace
       def self.all
-        namespaces = nil
+        namespaces = Sidekiq::Cron.configuration.available_namespaces
+        return namespaces if namespaces
 
         Sidekiq.redis do |conn|
           namespaces = conn.keys('cron_jobs:*').collect do |key|
@@ -38,6 +39,10 @@ module Sidekiq
         end
         out
       end
+
+      def self.available_namespaces_provided?
+        !!Sidekiq::Cron.configuration.available_namespaces
+      end
     end
   end
 end

data/lib/sidekiq/cron/version.rb

@@ -2,6 +2,6 @@
 
 module Sidekiq
   module Cron
-    VERSION = "2.0.0"
+    VERSION = "2.1.0"
   end
 end

data/lib/sidekiq/cron.rb

@@ -42,6 +42,17 @@ 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
         @cron_poll_interval = 30
         @cron_schedule_file = 'config/schedule.yml'
@@ -49,6 +60,7 @@ module Sidekiq
         @default_namespace = 'default'
         @natural_cron_parsing_mode = :single
         @reschedule_grace_period = 60
+        @available_namespaces = nil
       end
 
       def natural_cron_parsing_mode=(mode)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-cron
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Ondrej Bartas
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-11 00:00:00.000000000 Z
+date: 2025-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cronex
@@ -190,6 +190,7 @@ 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
@@ -226,7 +227,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.16
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Scheduler/Cron for Sidekiq jobs