sidekiq-cron 0.6.3 → 1.2.0

data/lib/sidekiq/cron/web_extension.rb

@@ -20,6 +20,23 @@ module Sidekiq
           end
         end
 
+        # display job detail + jid history
+        app.get '/cron/:name' do
+          view_path = File.join(File.expand_path("..", __FILE__), "views")
+
+          @job = Sidekiq::Cron::Job.find(route_params[:name])
+          if @job
+            #if Slim renderer exists and sidekiq has layout.slim in views
+            if defined?(Slim) && File.exists?(File.join(settings.views,"layout.slim"))
+              render(:slim, File.read(File.join(view_path, "cron_show.slim")))
+            else
+              render(:erb, File.read(File.join(view_path, "cron_show.erb")))
+            end
+          else
+            redirect "#{root_path}cron"
+          end
+        end
+
         #enque cron job
         app.post '/cron/:name/enque' do
           if route_params[:name] === '__all__'
@@ -27,7 +44,7 @@ module Sidekiq
           elsif job = Sidekiq::Cron::Job.find(route_params[:name])
             job.enque!
           end
-          redirect "#{root_path}cron"
+          redirect params['redirect'] || "#{root_path}cron"
         end
 
         #delete schedule
@@ -47,7 +64,7 @@ module Sidekiq
           elsif job = Sidekiq::Cron::Job.find(route_params[:name])
             job.enable!
           end
-          redirect "#{root_path}cron"
+          redirect params['redirect'] || "#{root_path}cron"
         end
 
         #disable job
@@ -57,7 +74,7 @@ module Sidekiq
           elsif job = Sidekiq::Cron::Job.find(route_params[:name])
             job.disable!
           end
-          redirect "#{root_path}cron"
+          redirect params['redirect'] || "#{root_path}cron"
         end
 
       end

data/sidekiq-cron.gemspec

@@ -2,18 +2,18 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: sidekiq-cron 0.6.3 ruby lib
+# stub: sidekiq-cron 1.2.0 ruby lib
 
 Gem::Specification.new do |s|
-  s.name = "sidekiq-cron"
-  s.version = "0.6.3"
+  s.name = "sidekiq-cron".freeze
+  s.version = "1.2.0"
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.require_paths = ["lib"]
-  s.authors = ["Ondrej Bartas"]
-  s.date = "2017-06-20"
-  s.description = "Enables to set jobs to be run in specified time (using CRON notation)"
-  s.email = "ondrej@bartas.cz"
+  s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib".freeze]
+  s.authors = ["Ondrej Bartas".freeze]
+  s.date = "2020-04-03"
+  s.description = "Enables to set jobs to be run in specified time (using CRON notation)".freeze
+  s.email = "ondrej@bartas.cz".freeze
   s.extra_rdoc_files = [
     "LICENSE.txt",
     "README.md"
@@ -37,11 +37,15 @@ Gem::Specification.new do |s|
     "lib/sidekiq/cron/launcher.rb",
     "lib/sidekiq/cron/locales/de.yml",
     "lib/sidekiq/cron/locales/en.yml",
+    "lib/sidekiq/cron/locales/ja.yml",
     "lib/sidekiq/cron/locales/ru.yml",
+    "lib/sidekiq/cron/locales/zh-CN.yml",
     "lib/sidekiq/cron/poller.rb",
     "lib/sidekiq/cron/support.rb",
     "lib/sidekiq/cron/views/cron.erb",
     "lib/sidekiq/cron/views/cron.slim",
+    "lib/sidekiq/cron/views/cron_show.erb",
+    "lib/sidekiq/cron/views/cron_show.slim",
     "lib/sidekiq/cron/web.rb",
     "lib/sidekiq/cron/web_extension.rb",
     "sidekiq-cron.gemspec",
@@ -51,75 +55,75 @@ Gem::Specification.new do |s|
     "test/unit/poller_test.rb",
     "test/unit/web_extension_test.rb"
   ]
-  s.homepage = "http://github.com/ondrejbartas/sidekiq-cron"
-  s.licenses = ["MIT"]
-  s.rubygems_version = "2.5.1"
-  s.summary = "Sidekiq Cron helps to add repeated scheduled jobs"
+  s.homepage = "http://github.com/ondrejbartas/sidekiq-cron".freeze
+  s.licenses = ["MIT".freeze]
+  s.rubygems_version = "2.5.2.3".freeze
+  s.summary = "Sidekiq Cron helps to add repeated scheduled jobs".freeze
 
   if s.respond_to? :specification_version then
     s.specification_version = 4
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<sidekiq>, [">= 4.2.1"])
-      s.add_runtime_dependency(%q<rufus-scheduler>, [">= 3.3.0"])
-      s.add_development_dependency(%q<bundler>, [">= 0"])
-      s.add_development_dependency(%q<simplecov>, [">= 0"])
-      s.add_development_dependency(%q<redis-namespace>, [">= 1.5.2"])
-      s.add_development_dependency(%q<shoulda-context>, [">= 0"])
-      s.add_development_dependency(%q<rack>, [">= 0"])
-      s.add_development_dependency(%q<rack-test>, [">= 0"])
-      s.add_development_dependency(%q<jeweler>, [">= 0"])
-      s.add_development_dependency(%q<minitest>, [">= 0"])
-      s.add_development_dependency(%q<test-unit>, [">= 0"])
-      s.add_development_dependency(%q<sdoc>, [">= 0"])
-      s.add_development_dependency(%q<slim>, [">= 0"])
-      s.add_development_dependency(%q<sinatra>, [">= 0"])
-      s.add_development_dependency(%q<mocha>, [">= 0"])
-      s.add_development_dependency(%q<coveralls>, [">= 0"])
-      s.add_development_dependency(%q<shotgun>, [">= 0"])
-      s.add_development_dependency(%q<guard>, [">= 0"])
-      s.add_development_dependency(%q<guard-minitest>, [">= 0"])
+      s.add_runtime_dependency(%q<sidekiq>.freeze, [">= 4.2.1"])
+      s.add_runtime_dependency(%q<fugit>.freeze, ["~> 1.1"])
+      s.add_development_dependency(%q<bundler>.freeze, [">= 0"])
+      s.add_development_dependency(%q<simplecov>.freeze, [">= 0"])
+      s.add_development_dependency(%q<redis-namespace>.freeze, [">= 1.5.2"])
+      s.add_development_dependency(%q<shoulda-context>.freeze, [">= 0"])
+      s.add_development_dependency(%q<rack>.freeze, [">= 0"])
+      s.add_development_dependency(%q<rack-test>.freeze, [">= 0"])
+      s.add_development_dependency(%q<jeweler>.freeze, [">= 0"])
+      s.add_development_dependency(%q<minitest>.freeze, [">= 0"])
+      s.add_development_dependency(%q<test-unit>.freeze, [">= 0"])
+      s.add_development_dependency(%q<sdoc>.freeze, [">= 0"])
+      s.add_development_dependency(%q<slim>.freeze, [">= 0"])
+      s.add_development_dependency(%q<sinatra>.freeze, [">= 0"])
+      s.add_development_dependency(%q<mocha>.freeze, [">= 0"])
+      s.add_development_dependency(%q<coveralls>.freeze, [">= 0"])
+      s.add_development_dependency(%q<shotgun>.freeze, [">= 0"])
+      s.add_development_dependency(%q<guard>.freeze, [">= 0"])
+      s.add_development_dependency(%q<guard-minitest>.freeze, [">= 0"])
     else
-      s.add_dependency(%q<sidekiq>, [">= 4.2.1"])
-      s.add_dependency(%q<rufus-scheduler>, [">= 3.3.0"])
-      s.add_dependency(%q<bundler>, [">= 0"])
-      s.add_dependency(%q<simplecov>, [">= 0"])
-      s.add_dependency(%q<redis-namespace>, [">= 1.5.2"])
-      s.add_dependency(%q<shoulda-context>, [">= 0"])
-      s.add_dependency(%q<rack>, [">= 0"])
-      s.add_dependency(%q<rack-test>, [">= 0"])
-      s.add_dependency(%q<jeweler>, [">= 0"])
-      s.add_dependency(%q<minitest>, [">= 0"])
-      s.add_dependency(%q<test-unit>, [">= 0"])
-      s.add_dependency(%q<sdoc>, [">= 0"])
-      s.add_dependency(%q<slim>, [">= 0"])
-      s.add_dependency(%q<sinatra>, [">= 0"])
-      s.add_dependency(%q<mocha>, [">= 0"])
-      s.add_dependency(%q<coveralls>, [">= 0"])
-      s.add_dependency(%q<shotgun>, [">= 0"])
-      s.add_dependency(%q<guard>, [">= 0"])
-      s.add_dependency(%q<guard-minitest>, [">= 0"])
+      s.add_dependency(%q<sidekiq>.freeze, [">= 4.2.1"])
+      s.add_dependency(%q<fugit>.freeze, ["~> 1.1"])
+      s.add_dependency(%q<bundler>.freeze, [">= 0"])
+      s.add_dependency(%q<simplecov>.freeze, [">= 0"])
+      s.add_dependency(%q<redis-namespace>.freeze, [">= 1.5.2"])
+      s.add_dependency(%q<shoulda-context>.freeze, [">= 0"])
+      s.add_dependency(%q<rack>.freeze, [">= 0"])
+      s.add_dependency(%q<rack-test>.freeze, [">= 0"])
+      s.add_dependency(%q<jeweler>.freeze, [">= 0"])
+      s.add_dependency(%q<minitest>.freeze, [">= 0"])
+      s.add_dependency(%q<test-unit>.freeze, [">= 0"])
+      s.add_dependency(%q<sdoc>.freeze, [">= 0"])
+      s.add_dependency(%q<slim>.freeze, [">= 0"])
+      s.add_dependency(%q<sinatra>.freeze, [">= 0"])
+      s.add_dependency(%q<mocha>.freeze, [">= 0"])
+      s.add_dependency(%q<coveralls>.freeze, [">= 0"])
+      s.add_dependency(%q<shotgun>.freeze, [">= 0"])
+      s.add_dependency(%q<guard>.freeze, [">= 0"])
+      s.add_dependency(%q<guard-minitest>.freeze, [">= 0"])
     end
   else
-    s.add_dependency(%q<sidekiq>, [">= 4.2.1"])
-    s.add_dependency(%q<rufus-scheduler>, [">= 3.3.0"])
-    s.add_dependency(%q<bundler>, [">= 0"])
-    s.add_dependency(%q<simplecov>, [">= 0"])
-    s.add_dependency(%q<redis-namespace>, [">= 1.5.2"])
-    s.add_dependency(%q<shoulda-context>, [">= 0"])
-    s.add_dependency(%q<rack>, [">= 0"])
-    s.add_dependency(%q<rack-test>, [">= 0"])
-    s.add_dependency(%q<jeweler>, [">= 0"])
-    s.add_dependency(%q<minitest>, [">= 0"])
-    s.add_dependency(%q<test-unit>, [">= 0"])
-    s.add_dependency(%q<sdoc>, [">= 0"])
-    s.add_dependency(%q<slim>, [">= 0"])
-    s.add_dependency(%q<sinatra>, [">= 0"])
-    s.add_dependency(%q<mocha>, [">= 0"])
-    s.add_dependency(%q<coveralls>, [">= 0"])
-    s.add_dependency(%q<shotgun>, [">= 0"])
-    s.add_dependency(%q<guard>, [">= 0"])
-    s.add_dependency(%q<guard-minitest>, [">= 0"])
+    s.add_dependency(%q<sidekiq>.freeze, [">= 4.2.1"])
+    s.add_dependency(%q<fugit>.freeze, ["~> 1.1"])
+    s.add_dependency(%q<bundler>.freeze, [">= 0"])
+    s.add_dependency(%q<simplecov>.freeze, [">= 0"])
+    s.add_dependency(%q<redis-namespace>.freeze, [">= 1.5.2"])
+    s.add_dependency(%q<shoulda-context>.freeze, [">= 0"])
+    s.add_dependency(%q<rack>.freeze, [">= 0"])
+    s.add_dependency(%q<rack-test>.freeze, [">= 0"])
+    s.add_dependency(%q<jeweler>.freeze, [">= 0"])
+    s.add_dependency(%q<minitest>.freeze, [">= 0"])
+    s.add_dependency(%q<test-unit>.freeze, [">= 0"])
+    s.add_dependency(%q<sdoc>.freeze, [">= 0"])
+    s.add_dependency(%q<slim>.freeze, [">= 0"])
+    s.add_dependency(%q<sinatra>.freeze, [">= 0"])
+    s.add_dependency(%q<mocha>.freeze, [">= 0"])
+    s.add_dependency(%q<coveralls>.freeze, [">= 0"])
+    s.add_dependency(%q<shotgun>.freeze, [">= 0"])
+    s.add_dependency(%q<guard>.freeze, [">= 0"])
+    s.add_dependency(%q<guard-minitest>.freeze, [">= 0"])
   end
 end
 

data/test/integration/performance_test.rb

@@ -2,13 +2,11 @@
 require './test/test_helper'
 require 'benchmark'
 
-describe 'Perfromance Poller' do
+describe 'Performance Poller' do
   X = 10000
   before do
     Sidekiq.redis = REDIS
-    Sidekiq.redis do |conn|
-      conn.flushdb
-    end
+    Redis.current.flushdb
 
     #clear all previous saved data from redis
     Sidekiq.redis do |conn|
@@ -28,12 +26,12 @@ describe 'Perfromance Poller' do
     end
 
     @poller = Sidekiq::Cron::Poller.new
-    now = Time.now.utc
-    enqueued_time = Time.new(now.year, now.month, now.day, now.hour + 1, 10, 5)
+    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 10000 jobs in less than 30s' do
+  it 'should enqueue 10000 jobs in less than 40s' do
     Sidekiq.redis do |conn|
       assert_equal 0, conn.llen("queue:default"), 'Queue should be empty'
     end
@@ -46,7 +44,7 @@ describe 'Perfromance Poller' do
       assert_equal X, conn.llen("queue:default"), 'Queue should be full'
     end
 
-    puts "Perfomance test finished in #{bench.real}"
-    assert_operator 30, :>, bench.real
+    puts "Performance test finished in #{bench.real}"
+    assert_operator bench.real, :<, 40
   end
 end

data/test/test_helper.rb

@@ -20,7 +20,7 @@ Coveralls.wear!
 require "minitest/autorun"
 require 'shoulda-context'
 require "rack/test"
-require "mocha/setup"
+require 'mocha/minitest'
 
 ENV['RACK_ENV'] = 'test'
 
@@ -66,6 +66,13 @@ end
 
 module ActiveJob
   class Base
+    attr_accessor *%i[job_class provider_job_id queue_name arguments]
+
+    def initialize
+      yield self if block_given?
+      self.provider_job_id ||= SecureRandom.hex(12)
+    end
+
     def self.queue_name_prefix
       @queue_name_prefix
     end
@@ -80,12 +87,16 @@ module ActiveJob
       self
     end
 
+    def try(method, *args, &block)
+      send method, *args, &block if respond_to? method
+    end
+
     def self.perform_later(*args)
-      {
-        "job_class"  => self.class.name,
-        "queue_name" => @queue,
-        "args"  => [*args],
-      }
+      new do |instance|
+        instance.job_class = self.class.name
+        instance.queue_name = @queue
+        instance.arguments = [*args]
+      end
     end
   end
 end

data/test/unit/job_test.rb

@@ -131,6 +131,28 @@ describe "Cron Job" do
     end
   end
 
+  describe 'parse_enqueue_time' do
+    before do
+      @args = {
+        name: "Test",
+        cron: "* * * * *"
+      }
+      @job = Sidekiq::Cron::Job.new(@args)
+    end
+
+    it 'should correctly parse new format' do
+      assert_equal @job.send(:parse_enqueue_time, '2017-01-02 15:23:43 UTC'), Time.new(2017, 1, 2, 15, 23, 43, '+00:00')
+    end
+
+    it 'should correctly parse new format with different timezone' do
+      assert_equal @job.send(:parse_enqueue_time, '2017-01-02 15:23:43 +01:00'), Time.new(2017, 1, 2, 15, 23, 43, '+01:00')
+    end
+
+    it 'should correctly parse old format' do
+      assert_equal @job.send(:parse_enqueue_time, '2017-01-02 15:23:43'), Time.new(2017, 1, 2, 15, 23, 43, '+00:00')
+    end
+  end
+
   describe 'formatted time' do
     before do
       @args = {
@@ -201,6 +223,34 @@ describe "Cron Job" do
                                  "class"=>"CronTestClassWithQueue",
                                  "args"=>[]}
     end
+
+    it "be initialized with 'class' and date_as_argument" do
+      job = Sidekiq::Cron::Job.new('class' => 'CronTestClassWithQueue', "date_as_argument" => true)
+
+      job_message = job.message
+      job_args    = job_message.delete("args")
+      assert_equal job_message, {"retry"=>false,
+                                 "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)
+    end
+
+    it "be initialized with 'class', 2 arguments and date_as_argument" do
+      job = Sidekiq::Cron::Job.new('class' => 'CronTestClassWithQueue', "date_as_argument" => true, "args"=> ["arg1", :arg2])
+
+      job_message = job.message
+      job_args    = job_message.delete("args")
+      assert_equal job_message, {"retry"=>false,
+                                 "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
+
   end
 
   describe "cron test" do
@@ -210,24 +260,24 @@ describe "Cron Job" do
 
     it "return previous minute" do
       @job.cron = "* * * * *"
-      time = Time.now.utc
+      time = Time.new(2018, 8, 10, 13, 24, 56).utc
       assert_equal @job.last_time(time).strftime("%Y-%m-%d-%H-%M-%S"), time.strftime("%Y-%m-%d-%H-%M-00")
     end
 
     it "return previous hour" do
       @job.cron = "1 * * * *"
-      time = Time.now.utc
+      time = Time.new(2018, 8, 10, 13, 24, 56).utc
       assert_equal @job.last_time(time).strftime("%Y-%m-%d-%H-%M-%S"), time.strftime("%Y-%m-%d-%H-01-00")
     end
 
     it "return previous day" do
       @job.cron = "1 2 * * * Etc/GMT"
-      time = Time.now.utc
+      time = Time.new(2018, 8, 10, 13, 24, 56).utc
 
       if time.hour >= 2
         assert_equal @job.last_time(time).strftime("%Y-%m-%d-%H-%M-%S"), time.strftime("%Y-%m-%d-02-01-00")
       else
-        yesterday = (Date.today - 1)
+        yesterday = time - 1.day
         assert_equal @job.last_time(time).strftime("%Y-%m-%d-%H-%M-%S"), yesterday.strftime("%Y-%m-%d-02-01-00")
       end
     end
@@ -299,6 +349,7 @@ describe "Cron Job" do
     it 'should return valid payload for Sidekiq::Client' do
       payload = {
         'class'       => 'ActiveJob::QueueAdapters::SidekiqAdapter::JobWrapper',
+        'wrapped'     => 'ActiveJobCronTestClass',
         'queue'       => 'super_queue',
         'description' => nil,
         'args'        => [{
@@ -330,10 +381,11 @@ describe "Cron Job" do
 
     it 'should return valid payload for Sidekiq::Client' do
       payload = {
-        'class' => 'ActiveJob::QueueAdapters::SidekiqAdapter::JobWrapper',
-        'queue' => 'prefix_super_queue',
+        'class'       => 'ActiveJob::QueueAdapters::SidekiqAdapter::JobWrapper',
+        'wrapped'     => 'ActiveJobCronTestClass',
+        'queue'       => 'prefix_super_queue',
         'description' => nil,
-        'args'  =>[{
+        'args'        => [{
           'job_class'  => 'ActiveJobCronTestClass',
           'job_id'     => 'XYZ',
           'queue_name' => 'prefix_super_queue',
@@ -357,7 +409,7 @@ describe "Cron Job" do
 
       it 'pushes to queue active jobs message' do
         @job.expects(:enqueue_active_job)
-            .returns(true)
+            .returns(ActiveJobCronTestClass.new)
         @job.enque!
       end
     end
@@ -375,7 +427,7 @@ describe "Cron Job" do
 
       it 'pushes to queue active jobs message with queue_name_prefix' do
         @job.expects(:enqueue_active_job)
-            .returns(true)
+            .returns(ActiveJobCronTestClass.new)
         @job.enque!
       end
     end
@@ -522,7 +574,6 @@ describe "Cron Job" do
       assert @job.save
     end
 
-
     it "be saved and found by name" do
       assert @job.save, "not saved"
       assert Sidekiq::Cron::Job.find("Test").is_a?(Sidekiq::Cron::Job)
@@ -599,14 +650,15 @@ describe "Cron Job" do
 
     it "last_enqueue_time shouldn't be rewritten after save" do
       #adding last_enqueue_time to initialize is only for test purpose
-      last_enqueue_time = '2013-01-01 23:59:59'
+      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))
       job = Sidekiq::Cron::Job.find(@args)
-      assert_equal job.last_enqueue_time, Time.parse(last_enqueue_time)
+      assert_equal job.last_enqueue_time, expected_enqueue_time
 
       Sidekiq::Cron::Job.create(@args)
       job = Sidekiq::Cron::Job.find(@args)
-      assert_equal job.last_enqueue_time, Time.parse(last_enqueue_time), "after second create should have same time"
+      assert_equal job.last_enqueue_time, expected_enqueue_time, "after second create should have same time"
     end
   end
 
@@ -883,7 +935,8 @@ describe "Cron Job" do
         @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"
-        assert_equal ({"name_of_job"=>["'cron' -> bad cron: not a valid cronline : 'bad cron'"]}), out
+        assert_includes out['name_of_job'].first, "bad cron"
+        assert_includes out['name_of_job'].first, "ArgumentError:"
         assert_equal 1, Sidekiq::Cron::Job.all.size, "Should have only 1 job after load"
       end