sidekiq-cron 1.7.0 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d16f511a8148eadb1246263f53b596b643f9a653e0fb7877e8eaa6e0d0f2f57c
-  data.tar.gz: 874babda0f4da8f7928b69a226b967d79d59eacc79c101d0e087f064d31e6423
+  metadata.gz: 7df934577b0740b3e977ffd0e361f6333de6958921659d78bf4c4e4a0015aad9
+  data.tar.gz: 6ae3317c56ff984bf0b651df9117121b4cf67cf36d715eee56a7521f47fe0770
 SHA512:
-  metadata.gz: c23cfaf18069f8e85b777807e2ceaab25d7a0d58983541044e84791e5f484998d00b5042f1f25222f050f7900d182c371227c03270cd66243c440d02cf98065b
-  data.tar.gz: 4e809ad13f7cde7f02a3e3ea44c6500e3e430c95e8ae12136b7625bc8ab7a452748e3769adbbef619d033a4346800693b329c40c1f4836594e8c242e4089737f
+  metadata.gz: 8948ce194538c052c1761b921a4df485bc99ab5ce9b2e4c12b576d90e10bb6bb1691d7fe111d8ecc6b54e3324d53b8c5c45c0be561d58c4adb4414f08db576b8
+  data.tar.gz: 2fcccab9c996fe7a6c79c0090875dd81fca30ba6de130af3cf300d1d745e0212e056afe4ea05a8912191703cddf47800f5e3ea6092e1e751091ecf4a3baffc15

data/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 All notable changes to this project will be documented in this file.
 
+## 1.8.0
+
+- Fix deprecation warnings with redis-rb v4.8.0 (https://github.com/ondrejbartas/sidekiq-cron/pull/356)
+- Fix poller affecting Sidekiq scheduled set poller (https://github.com/ondrejbartas/sidekiq-cron/pull/359)
+- Fix default polling interval (https://github.com/ondrejbartas/sidekiq-cron/pull/362)
+- Add italian locale (https://github.com/ondrejbartas/sidekiq-cron/pull/367)
+- Allow disabling of cron polling (https://github.com/ondrejbartas/sidekiq-cron/pull/368)
+
 ## 1.7.0
 
 - Enable to use cron notation in natural language (ie `every 30 minutes`) (https://github.com/ondrejbartas/sidekiq-cron/pull/312)

data/README.md

@@ -105,7 +105,7 @@ For example: `"*/30 * * * * *"` would schedule a job to run every 30 seconds.
 Note that if you plan to schedule jobs with second precision you may need to override the default schedule poll interval so it is lower than the interval of your jobs:
 
 ```ruby
-Sidekiq[:average_scheduled_poll_interval] = 10
+Sidekiq[:cron_poll_interval] = 10
 ```
 
 The default value at time of writing is 30 seconds. See [under the hood](#under-the-hood) for more details.
@@ -332,11 +332,13 @@ Sidekiq-Cron adds itself into this start procedure and starts another thread wit
 Sidekiq-Cron is checking jobs to be enqueued every 30s by default, you can change it by setting:
 
 ```ruby
-Sidekiq[:average_scheduled_poll_interval] = 10
+Sidekiq[:cron_poll_interval] = 10
 ```
 
 Sidekiq-Cron is safe to use with multiple Sidekiq processes or nodes. It uses a Redis sorted set to determine that only the first process who asks can enqueue scheduled jobs into the queue.
 
+When running with many Sidekiq processes, the polling can add significant load to Redis. You can disable polling on some processes by setting `Sidekiq[:cron_poll_interval] = 0` on these processes.
+
 ## Contributing
 
 **Thanks to all [contributors](https://github.com/ondrejbartas/sidekiq-cron/graphs/contributors), you’re awesome and this wouldn’t be possible without you!**

data/lib/sidekiq/cron/job.rb

@@ -465,7 +465,7 @@ module Sidekiq
         Sidekiq.redis do |conn|
 
           # Add to set of all jobs
-          conn.sadd self.class.jobs_key, redis_key
+          conn.sadd self.class.jobs_key, [redis_key]
 
           # Add informations for this job!
           conn.hmset redis_key, *hash_to_redis(to_hash)
@@ -502,7 +502,7 @@ module Sidekiq
       def destroy
         Sidekiq.redis do |conn|
           # Delete from set.
-          conn.srem self.class.jobs_key, redis_key
+          conn.srem self.class.jobs_key, [redis_key]
 
           # Delete runned timestamps.
           conn.del job_enqueued_key

data/lib/sidekiq/cron/launcher.rb

@@ -8,30 +8,34 @@ require 'sidekiq/cron/poller'
 module Sidekiq
   module Cron
     module Launcher
+      DEFAULT_POLL_INTERVAL = 30
+
       # Add cron poller to launcher.
       attr_reader :cron_poller
 
       # Add cron poller and execute normal initialize of Sidekiq launcher.
       def initialize(options)
-        @cron_poller = Sidekiq::Cron::Poller.new
+        options[:cron_poll_interval] = DEFAULT_POLL_INTERVAL if options[:cron_poll_interval].nil?
+
+        @cron_poller = Sidekiq::Cron::Poller.new(options) if options[:cron_poll_interval] > 0
         super(options)
       end
 
       # Execute normal run of launcher and run cron poller.
       def run
         super
-        cron_poller.start
+        cron_poller.start if @cron_poller
       end
 
       # Execute normal quiet of launcher and quiet cron poller.
       def quiet
-        cron_poller.terminate
+        cron_poller.terminate if @cron_poller
         super
       end
 
       # Execute normal stop of launcher and stop cron poller.
       def stop
-        cron_poller.terminate
+        cron_poller.terminate if @cron_poller
         super
       end
     end

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

@@ -0,0 +1,23 @@
+it:
+  Job: Job
+  Cron: Cron
+  CronJobs: Cron job
+  EnqueueNow: Accoda
+  EnableAll: Attiva tutto
+  DisableAll: Disattiva tutto
+  EnqueueAll: Accoda tutto
+  DeleteAll: Cancella tutto
+  "Cron string": Cron
+  AreYouSureEnqueueCronJobs: Vuoi accodare TUTTI i cron job?
+  AreYouSureEnqueueCronJob: "Vuoi accodare il cron job '%{job}'?"
+  AreYouSureDeleteCronJobs: Vuoi cancellare TUTTI i cron job?
+  AreYouSureDeleteCronJob: "Vuoi cancellare il cron job '%{job}'?"
+  NoCronJobsWereFound: Nessun cron job trovato
+  Enable: Attiva
+  Disable: Disattiva
+  "Last enqueued": Ultimo accodamento
+  disabled: disattivato
+  enabled: attivato
+  NoHistoryWereFound: Nessun evento in cronologia
+  Description: Descrizione
+  Message: Payload

data/lib/sidekiq/cron/poller.rb

@@ -5,20 +5,15 @@ require 'sidekiq/options'
 
 module Sidekiq
   module Cron
-    POLL_INTERVAL = Sidekiq::Options[:average_scheduled_poll_interval] || 30
-
     # The Poller checks Redis every N seconds for sheduled cron jobs.
     class Poller < Sidekiq::Scheduled::Poller
-      def initialize
-        Sidekiq.configure_server do
-          Sidekiq::Options[:poll_interval_average] = POLL_INTERVAL
-        end
-
+      def initialize(options = {})
         if Gem::Version.new(Sidekiq::VERSION) >= Gem::Version.new('6.5.0')
-          # Sidekiq Poller init requires a config argument.
-          super(Sidekiq)
-        else
           super
+        else
+          # Old version of Sidekiq does not accept a config argument.
+          @config = options
+          super()
         end
       end
 
@@ -45,6 +40,10 @@ module Sidekiq
         Sidekiq.logger.error "CRON JOB: #{ex.backtrace.first}"
         handle_exception(ex) if respond_to?(:handle_exception)
       end
+
+      def poll_interval_average(process_count = 1)
+        @config[:cron_poll_interval]
+      end
     end
   end
 end

data/lib/sidekiq/cron/version.rb

@@ -2,6 +2,6 @@
 
 module Sidekiq
   module Cron
-    VERSION = "1.7.0"
+    VERSION = "1.8.0"
   end
 end

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

@@ -42,7 +42,7 @@
           <td style="<%= style %>"><%= t job.status %></td>
           <td style="<%= style %>">
             <a href="<%= root_path %>cron/<%= CGI.escape(job.name).gsub('+', '%20') %>">
-              <b><%= job.name %></b>
+              <b style="<%= style %>"><%= job.name %></b>
             </a>
             <hr style="margin:3px;border:0;">
             <small>

data/test/unit/job_test.rb

@@ -929,7 +929,7 @@ describe "Cron Job" do
       Sidekiq::Cron::Job.create(@args.merge(name: "Test3"))
 
       Sidekiq.redis do |conn|
-        conn.sadd Sidekiq::Cron::Job.jobs_key, "some_other_key"
+        conn.sadd Sidekiq::Cron::Job.jobs_key, ["some_other_key"]
       end
 
       assert_equal Sidekiq::Cron::Job.all.size, 3, "All have to return only valid 3 jobs"

data/test/unit/launcher_test.rb

@@ -0,0 +1,33 @@
+require './test/test_helper'
+
+describe 'Cron launcher' do
+  describe 'initialization' do
+    before do
+      Sidekiq[:cron_poll_interval] = nil
+    end
+
+    it 'initializes poller with default poll interval when not configured' do
+      Sidekiq::Cron::Poller.expects(:new).with do |options|
+        assert_equal Sidekiq::Cron::Launcher::DEFAULT_POLL_INTERVAL, options[:cron_poll_interval]
+      end
+
+      Sidekiq::Launcher.new(Sidekiq)
+    end
+
+    it 'initializes poller with the configured poll interval' do
+      Sidekiq::Cron::Poller.expects(:new).with do |options|
+        assert_equal 99, options[:cron_poll_interval]
+      end
+
+      Sidekiq[:cron_poll_interval] = 99
+      Sidekiq::Launcher.new(Sidekiq)
+    end
+
+    it 'does not initialize the poller when interval is 0' do
+      Sidekiq::Cron::Poller.expects(:new).never
+
+      Sidekiq[:cron_poll_interval] = 0
+      Sidekiq::Launcher.new(Sidekiq)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-cron
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 1.8.0
 platform: ruby
 authors:
 - Ondrej Bartas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-07-23 00:00:00.000000000 Z
+date: 2022-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fugit
@@ -156,6 +156,7 @@ files:
 - lib/sidekiq/cron/launcher.rb
 - lib/sidekiq/cron/locales/de.yml
 - lib/sidekiq/cron/locales/en.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
@@ -176,6 +177,7 @@ files:
 - 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
@@ -198,7 +200,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Scheduler/Cron for Sidekiq jobs