sidekiq-cron 1.6.0 → 1.8.0

data/lib/sidekiq/cron/launcher.rb

@@ -1,38 +1,41 @@
-# require cron poller
 require 'sidekiq/cron/poller'
 
 # For Cron we need to add some methods to Launcher
 # so look at the code bellow.
 #
-# we are creating new cron poller instance and
-# adding start and stop commands to launcher
+# We are creating new cron poller instance and
+# adding start and stop commands to launcher.
 module Sidekiq
   module Cron
     module Launcher
-      # Add cron poller to launcher
+      DEFAULT_POLL_INTERVAL = 30
+
+      # Add cron poller to launcher.
       attr_reader :cron_poller
 
-      # add cron poller and execute normal initialize of Sidekiq launcher
+      # 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
+      # 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
+      # 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
+      # Execute normal stop of launcher and stop cron poller.
       def stop
-        cron_poller.terminate
+        cron_poller.terminate if @cron_poller
         super
       end
     end
@@ -40,7 +43,6 @@ module Sidekiq
 end
 
 Sidekiq.configure_server do
-  # require  Sidekiq original launcher
   require 'sidekiq/launcher'
 
   ::Sidekiq::Launcher.prepend(Sidekiq::Cron::Launcher)

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

@@ -1,27 +1,19 @@
 require 'sidekiq'
 require 'sidekiq/cron'
 require 'sidekiq/scheduled'
+require 'sidekiq/options'
 
 module Sidekiq
   module Cron
-    POLL_INTERVAL = 30
-
-    # The Poller checks Redis every N seconds for sheduled cron jobs
+    # The Poller checks Redis every N seconds for sheduled cron jobs.
     class Poller < Sidekiq::Scheduled::Poller
-      def initialize
-        Sidekiq.configure_server do |config|
-          if config.respond_to?(:[])
-            config[:poll_interval_average] = config[:average_scheduled_poll_interval] || POLL_INTERVAL
-          else
-            config.options[:poll_interval_average] = config.options[:average_scheduled_poll_interval] || POLL_INTERVAL
-          end
-        end
-
-        if Gem::Version.new(Sidekiq::VERSION) >= Gem::Version.new("6.5.0")
-          # Sidekiq Poller init requires a config argument
-          super(Sidekiq)
-        else
+      def initialize(options = {})
+        if Gem::Version.new(Sidekiq::VERSION) >= Gem::Version.new('6.5.0')
           super
+        else
+          # Old version of Sidekiq does not accept a config argument.
+          @config = options
+          super()
         end
       end
 
@@ -32,7 +24,7 @@ module Sidekiq
         end
       rescue => ex
         # Most likely a problem with redis networking.
-        # Punt and try again at the next interval
+        # Punt and try again at the next interval.
         Sidekiq.logger.error ex.message
         Sidekiq.logger.error ex.backtrace.first
         handle_exception(ex) if respond_to?(:handle_exception)
@@ -43,11 +35,15 @@ module Sidekiq
       def enqueue_job(job, time = Time.now.utc)
         job.test_and_enque_for_time! time if job && job.valid?
       rescue => ex
-        # problem somewhere in one job
+        # Problem somewhere in one job.
         Sidekiq.logger.error "CRON JOB: #{ex.message}"
         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/schedule_loader.rb

@@ -1,13 +1,21 @@
-require "sidekiq"
-require "sidekiq/cron/job"
+require 'sidekiq'
+require 'sidekiq/cron/job'
+require 'sidekiq/options'
 
 if Sidekiq.server?
   Sidekiq.configure_server do |config|
-    schedule_file = config.options[:cron_schedule_file] || "config/schedule.yml"
+    schedule_file = Sidekiq::Options[:cron_schedule_file] || 'config/schedule.yml'
 
     if File.exist?(schedule_file)
       config.on(:startup) do
-        Sidekiq::Cron::Job.load_from_hash YAML.load_file(schedule_file)
+        schedule = YAML.load_file(schedule_file)
+        if schedule.kind_of?(Hash)
+          Sidekiq::Cron::Job.load_from_hash schedule
+        elsif schedule.kind_of?(Array)
+          Sidekiq::Cron::Job.load_from_array schedule
+        else
+          raise "Not supported schedule format. Confirm your #{schedule_file}"
+        end
       end
     end
   end

data/lib/sidekiq/cron/support.rb

@@ -28,7 +28,6 @@ module Sidekiq
               const
             end
 
-            # owner is in Object, so raise
             constant.const_get(name, false)
           end
         end

data/lib/sidekiq/cron/version.rb

@@ -2,6 +2,6 @@
 
 module Sidekiq
   module Cron
-    VERSION = "1.6.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/lib/sidekiq/cron/web_extension.rb

@@ -1,12 +1,10 @@
 module Sidekiq
   module Cron
     module WebExtension
-
       def self.registered(app)
-
         app.settings.locales << File.join(File.expand_path("..", __FILE__), "locales")
 
-        #index page of cron jobs
+        # Index page of cron jobs.
         app.get '/cron' do
           view_path    = File.join(File.expand_path("..", __FILE__), "views")
 
@@ -15,7 +13,7 @@ module Sidekiq
           render(:erb, File.read(File.join(view_path, "cron.erb")))
         end
 
-        # display job detail + jid history
+        # Display job detail + jid history.
         app.get '/cron/:name' do
           view_path = File.join(File.expand_path("..", __FILE__), "views")
 
@@ -27,7 +25,7 @@ module Sidekiq
           end
         end
 
-        #enque cron job
+        # Enqueue cron job.
         app.post '/cron/:name/enque' do
           if route_params[:name] === '__all__'
             Sidekiq::Cron::Job.all.each(&:enque!)
@@ -37,7 +35,7 @@ module Sidekiq
           redirect params['redirect'] || "#{root_path}cron"
         end
 
-        #delete schedule
+        # Delete schedule.
         app.post '/cron/:name/delete' do
           if route_params[:name] === '__all__'
             Sidekiq::Cron::Job.all.each(&:destroy)
@@ -47,7 +45,7 @@ module Sidekiq
           redirect "#{root_path}cron"
         end
 
-        #enable job
+        # Enable job.
         app.post '/cron/:name/enable' do
           if route_params[:name] === '__all__'
             Sidekiq::Cron::Job.all.each(&:enable!)
@@ -57,7 +55,7 @@ module Sidekiq
           redirect params['redirect'] || "#{root_path}cron"
         end
 
-        #disable job
+        # Disable job.
         app.post '/cron/:name/disable' do
           if route_params[:name] === '__all__'
             Sidekiq::Cron::Job.all.each(&:disable!)
@@ -66,7 +64,6 @@ module Sidekiq
           end
           redirect params['redirect'] || "#{root_path}cron"
         end
-
       end
     end
   end

data/lib/sidekiq/options.rb

@@ -0,0 +1,18 @@
+require 'sidekiq'
+
+module Sidekiq
+  module Options
+    def self.[](key)
+      new_version? ? Sidekiq[key] : Sidekiq.options[key]
+    end
+
+    def self.[]=(key, value)
+      new_version? ? Sidekiq[key] = value : Sidekiq.options[key] = value
+    end
+
+    # sidekiq --version >= 6.5.0
+    def self.new_version?
+      @new_version ||= Sidekiq.respond_to?(:[])
+    end
+  end
+end

data/sidekiq-cron.gemspec

@@ -5,12 +5,12 @@ require './lib/sidekiq/cron/version'
 Gem::Specification.new do |s|
   s.name = "sidekiq-cron"
   s.version = Sidekiq::Cron::VERSION
-
-  s.required_ruby_version = ">= 2.6"
-  s.require_paths = ["lib"]
+  s.summary = "Scheduler/Cron for Sidekiq jobs"
+  s.description = "Enables to set jobs to be run in specified time (using CRON notation or natural language)"
+  s.homepage = "https://github.com/ondrejbartas/sidekiq-cron"
   s.authors = ["Ondrej Bartas"]
-  s.description = "Enables to set jobs to be run in specified time (using CRON notation)"
   s.email = "ondrej@bartas.cz"
+  s.licenses = ["MIT"]
   s.extra_rdoc_files = [
     "LICENSE.txt",
     "README.md"
@@ -24,9 +24,7 @@ Gem::Specification.new do |s|
     "sidekiq-cron.gemspec",
   ]
 
-  s.homepage = "https://github.com/ondrejbartas/sidekiq-cron"
-  s.licenses = ["MIT"]
-  s.summary = "Sidekiq-Cron helps to add repeated scheduled jobs"
+  s.required_ruby_version = ">= 2.6"
 
   s.add_dependency("fugit", "~> 1")
   s.add_dependency("sidekiq", ">= 4.2.1")

data/test/integration/performance_test.rb

@@ -7,7 +7,7 @@ describe 'Performance Poller' do
     REDIS.with { |c| c.respond_to?(:redis) ? c.redis.flushdb : c.flushdb }
     Sidekiq.redis = REDIS
 
-    #clear all previous saved data from redis
+    # Clear all previous saved data from Redis.
     Sidekiq.redis do |conn|
       conn.keys("cron_job*").each do |key|
         conn.del(key)

data/test/test_helper.rb

@@ -13,6 +13,7 @@ require 'mocha/minitest'
 require 'sidekiq'
 require "sidekiq-pro" if ENV['SIDEKIQ_PRO_VERSION']
 require 'sidekiq/web'
+require "sidekiq/cli"
 
 Sidekiq.logger.level = Logger::ERROR
 

data/test/unit/fixtures/schedule_array.yml

@@ -0,0 +1,13 @@
+---
+-
+  name: "my_first_job"
+  cron: "*/5 * * * *"
+  class: "HardWorker"
+  queue: "hard_worker"
+-
+  name: "second_job"
+  cron: "*/30 * * * *"
+  class: "HardWorker"
+  queue: "hard_worker_long"
+  args:
+    hard: "stuff"

data/test/unit/fixtures/schedule_hash.yml

@@ -0,0 +1,12 @@
+---
+my_first_job:
+  cron: "*/5 * * * *"
+  class: "HardWorker"
+  queue: hard_worker
+
+second_job:
+  cron: "*/30 * * * *"
+  class: "HardWorker"
+  queue: hard_worker_long
+  args:
+    hard: "stuff"

data/test/unit/fixtures/schedule_string.yml

@@ -0,0 +1 @@
+--- string

data/test/unit/job_test.rb

@@ -2,14 +2,14 @@ require './test/test_helper'
 
 describe "Cron Job" do
   before do
-    #clear all previous saved data from redis
+    # Clear all previous saved data from Redis.
     Sidekiq.redis do |conn|
       conn.keys("cron_job*").each do |key|
         conn.del(key)
       end
     end
 
-    #clear all queues
+    # Clear all queues.
     Sidekiq::Queue.all.each do |queue|
       queue.clear
     end
@@ -75,7 +75,6 @@ describe "Cron Job" do
   end
 
   describe "invalid job" do
-
     before do
       @job = Sidekiq::Cron::Job.new()
     end
@@ -130,6 +129,22 @@ describe "Cron Job" do
     end
   end
 
+  describe 'cron formats' do
+    before do
+      @args = {
+        name: "Test",
+        klass: "CronTestClass"
+      }
+    end
+
+    it 'should support natural language format' do
+      @args[:cron] = "every 3 hours"
+      @job = Sidekiq::Cron::Job.new(@args)
+      assert @job.valid?
+      assert_equal Fugit::Cron.new("0 */3 * * *"), @job.send(:parsed_cron)
+    end
+  end
+
   describe 'parse_enqueue_time' do
     before do
       @args = {
@@ -232,8 +247,11 @@ describe "Cron Job" do
                                  "queue"=>:super,
                                  "backtrace"=>true,
                                  "class"=>"CronTestClassWithQueue"}
-      assert job_args[-1].is_a?(Float)
-      assert job_args[-1].between?(Time.now.to_f - 1, Time.now.to_f)
+      assert job_args.empty?
+
+      enqueue_args = job.enqueue_args
+      assert enqueue_args[-1].is_a?(Float)
+      assert enqueue_args[-1].between?(Time.now.to_f - 1, Time.now.to_f)
     end
 
     it "be initialized with 'class', 2 arguments and date_as_argument" do
@@ -245,11 +263,13 @@ describe "Cron Job" do
                                  "queue"=>:super,
                                  "backtrace"=>true,
                                  "class"=>"CronTestClassWithQueue"}
-      assert job_args[-1].is_a?(Float)
-      assert job_args[-1].between?(Time.now.to_f - 1, Time.now.to_f)
-      assert_equal job_args[0..-2], ["arg1", :arg2]
-    end
+      assert_equal job_args, ["arg1", :arg2]
 
+      enqueue_args = job.enqueue_args
+      assert_equal enqueue_args[0..-2], ["arg1", :arg2]
+      assert enqueue_args[-1].is_a?(Float)
+      assert enqueue_args[-1].between?(Time.now.to_f - 1, Time.now.to_f)
+    end
   end
 
   describe "cron test" do
@@ -303,6 +323,21 @@ describe "Cron Job" do
       }
       assert_equal @job.sidekiq_worker_message, payload
     end
+
+    describe 'with date_as_argument' do
+      before do
+        @args.merge!(date_as_argument: true)
+        @job = Sidekiq::Cron::Job.new(@args)
+      end
+
+      let(:args) { @job.sidekiq_worker_message['args'] }
+
+      it 'should add timestamp to args' do
+        assert_equal args[0], {foo: 'bar'}
+        assert args[-1].is_a?(Float)
+        assert args[-1].between?(Time.now.to_f - 1, Time.now.to_f)
+      end
+    end
   end
 
   describe '#sidekiq_worker_message settings overwrite queue name' do
@@ -360,6 +395,22 @@ describe "Cron Job" do
       }
       assert_equal @job.active_job_message, payload
     end
+
+    describe 'with date_as_argument' do
+      before do
+        @args.merge!(date_as_argument: true)
+        @job = Sidekiq::Cron::Job.new(@args)
+      end
+
+      let(:args) { @job.active_job_message['args'][0]['arguments'] }
+
+      it 'should add timestamp to args' do
+        args = @job.active_job_message['args'][0]['arguments']
+        assert_equal args[0], {foo: 'bar'}
+        assert args[-1].is_a?(Float)
+        assert args[-1].between?(Time.now.to_f - 1, Time.now.to_f)
+      end
+    end
   end
 
   describe '#active_job_message - unknown Active Job Worker class' do
@@ -513,6 +564,23 @@ describe "Cron Job" do
             .returns(ActiveJobCronTestClass.new)
         @job.enque!
       end
+
+      describe 'with date_as_argument' do
+        before do
+          @args.merge!(date_as_argument: true)
+          @job = Sidekiq::Cron::Job.new(@args)
+        end
+
+        it 'should add timestamp to args' do
+          ActiveJobCronTestClass.expects(:perform_later)
+                                .returns(ActiveJobCronTestClass.new)
+                                .with { |*args|
+                                  assert args[-1].is_a?(Float)
+                                  assert args[-1].between?(Time.now.to_f - 1, Time.now.to_f)
+                                }
+          @job.enque!
+        end
+      end
     end
 
     describe 'active job with queue_name_prefix' do
@@ -640,6 +708,24 @@ describe "Cron Job" do
             .returns(true)
         @job.enque!
       end
+
+      describe 'with date_as_argument' do
+        before do
+          @args.merge!(date_as_argument: true)
+          @job = Sidekiq::Cron::Job.new(@args)
+        end
+
+        it 'should add timestamp to args' do
+          CronTestClass::Setter.any_instance
+                               .expects(:perform_async)
+                               .returns(true)
+                               .with { |*args|
+                                 assert args[-1].is_a?(Float)
+                                 assert args[-1].between?(Time.now.to_f - 1, Time.now.to_f)
+                               }
+          @job.enque!
+        end
+      end
     end
 
     describe 'sidekiq worker unknown class' do
@@ -750,7 +836,7 @@ describe "Cron Job" do
     end
 
     it "last_enqueue_time shouldn't be rewritten after save" do
-      #adding last_enqueue_time to initialize is only for test purpose
+      # Adding last_enqueue_time to initialize is only for testing purposes.
       last_enqueue_time = '2013-01-01 23:59:59 +0000'
       expected_enqueue_time = DateTime.parse(last_enqueue_time).to_time.utc
       Sidekiq::Cron::Job.create(@args.merge('last_enqueue_time' => last_enqueue_time))
@@ -776,6 +862,7 @@ describe "Cron Job" do
         assert_equal job.name, "Test"
       end
     end
+
     it "from String" do
       args = {
         name: "Test",
@@ -788,6 +875,7 @@ describe "Cron Job" do
         assert_equal job.name, "Test"
       end
     end
+
     it "from Array" do
       args = {
         name: "Test",
@@ -841,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"
@@ -859,7 +947,6 @@ describe "Cron Job" do
       Sidekiq::Cron::Job.create(@args)
       assert Sidekiq::Cron::Job.find('name' => "Test"), "String keys"
     end
-
   end
 
   describe "destroy" do
@@ -896,7 +983,6 @@ describe "Cron Job" do
       Sidekiq::Cron::Job.create(@args)
       assert Sidekiq::Cron::Job.destroy('name' => "Test"), "String keys"
     end
-
   end
 
   describe "destroy_removed_jobs" do
@@ -928,10 +1014,10 @@ describe "Cron Job" do
         cron: "* * * * *",
         klass: "CronTestClass"
       }
-      #first time is always
-      #after next cron time!
+      # First time is always after next cron time!
       @time = Time.now.utc + 120
     end
+
     it "be always false when status is disabled" do
       refute Sidekiq::Cron::Job.new(@args.merge(status: 'disabled')).should_enque? @time
       refute Sidekiq::Cron::Job.new(@args.merge(status: 'disabled')).should_enque? @time - 60
@@ -953,7 +1039,6 @@ describe "Cron Job" do
       assert Sidekiq::Cron::Job.new(@args).should_enque? @time + 235
       refute Sidekiq::Cron::Job.new(@args).should_enque? @time + 235
 
-      #just for check
       refute Sidekiq::Cron::Job.new(@args).should_enque? @time
       refute Sidekiq::Cron::Job.new(@args).should_enque? @time + 135
       refute Sidekiq::Cron::Job.new(@args).should_enque? @time + 235
@@ -969,7 +1054,7 @@ describe "Cron Job" do
       assert job.test_and_enque_for_time!(@time), "should enqueue"
 
       future_now = @time + 1 * 60 * 60
-      Time.stubs(:now).returns(future_now) # save uses Time.now.utc
+      Time.stubs(:now).returns(future_now) # Save uses Time.now.utc
       job.save
       assert Sidekiq::Cron::Job.new(@args).test_and_enque_for_time!(future_now + 30), "should enqueue"
     end
@@ -986,7 +1071,7 @@ describe "Cron Job" do
       end
       assert_equal Sidekiq::Queue.all.first.size, 1, "Sidekiq queue 1 job in queue"
 
-      # 20 hours after
+      # 20 hours after.
       assert Sidekiq::Cron::Job.new(@args).test_and_enque_for_time! @time + 1 * 60 * 60
       refute Sidekiq::Cron::Job.new(@args).test_and_enque_for_time! @time + 1 * 60 * 60
 
@@ -995,7 +1080,7 @@ describe "Cron Job" do
       end
       assert_equal Sidekiq::Queue.all.first.size, 2, "Sidekiq queue 2 jobs in queue"
 
-      # 26 hour after
+      # 26 hour after.
       assert Sidekiq::Cron::Job.new(@args).test_and_enque_for_time! @time + 26 * 60 * 60
       refute Sidekiq::Cron::Job.new(@args).test_and_enque_for_time! @time + 26 * 60 * 60
 
@@ -1007,7 +1092,6 @@ describe "Cron Job" do
   end
 
   describe "load" do
-
     describe "from hash" do
       before do
         @jobs_hash = {
@@ -1042,7 +1126,7 @@ describe "Cron Job" do
 
       it "return errors on loaded jobs" do
         assert_equal Sidekiq::Cron::Job.all.size, 0, "Should have 0 jobs before load"
-        #set something bag to hash
+        # Set something bad to hash.
         @jobs_hash['name_of_job']['cron'] = "bad cron"
         out = Sidekiq::Cron::Job.load_from_hash @jobs_hash
         assert_equal 1, out.size, "should have 1 error"
@@ -1092,6 +1176,16 @@ describe "Cron Job" do
         assert_equal Sidekiq::Cron::Job.all.size, 2, "Should have 2 jobs after load"
       end
 
+      it "duplicate jobs are not loaded" do
+        out = Sidekiq::Cron::Job.load_from_array @jobs_array
+        assert_equal out.size, 0, "should have no errors"
+        assert_equal Sidekiq::Cron::Job.all.size, 2, "Should have 2 jobs after load"
+
+        out_2 = Sidekiq::Cron::Job.load_from_array @jobs_array
+        assert_equal out_2.size, 0, "should have no errors"
+        assert_equal Sidekiq::Cron::Job.all.size, 2, "Should have 2 jobs after loading again"
+      end
+
       it "create new jobs and update old one with same settings with load_from_array" do
         assert_equal Sidekiq::Cron::Job.all.size, 0, "Should have 0 jobs before load"
         out = Sidekiq::Cron::Job.load_from_array! @jobs_array