sidekiq-cron 1.0.4 → 1.3.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/lib/sidekiq/cron.rb

@@ -4,5 +4,6 @@ require "sidekiq/cron/launcher"
 
 module Sidekiq
   module Cron
+    Redis.respond_to?(:exists_returns_integer) && Redis.exists_returns_integer =  false
   end
 end

data/sidekiq-cron.gemspec

@@ -1,127 +1,48 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
-# -*- encoding: utf-8 -*-
-# stub: sidekiq-cron 1.0.4 ruby lib
+# frozen_string_literal: true
+
+require './lib/sidekiq/cron/version'
 
 Gem::Specification.new do |s|
   s.name = "sidekiq-cron".freeze
-  s.version = "1.0.4"
+  s.version = Sidekiq::Cron::VERSION
 
-  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 = "2018-08-15"
-  s.description = "Enables to set jobs to be run in specified time (using CRON notation)".freeze
-  s.email = "ondrej@bartas.cz".freeze
+  s.required_ruby_version = ">= 2.5"
+  s.require_paths = ["lib"]
+  s.authors = ["Ondrej Bartas"]
+  s.date = "2020-04-03"
+  s.description = "Enables to set jobs to be run in specified time (using CRON notation)"
+  s.email = "ondrej@bartas.cz"
   s.extra_rdoc_files = [
     "LICENSE.txt",
     "README.md"
   ]
-  s.files = [
+  s.files = Dir.glob('lib/**/*') + Dir.glob('test/**/*') + [
     ".document",
-    ".travis.yml",
     "Changes.md",
     "Dockerfile",
-    "Gemfile",
-    "LICENSE.txt",
-    "README.md",
-    "Rakefile",
-    "VERSION",
     "config.ru",
     "docker-compose.yml",
     "examples/web-cron-ui.png",
-    "lib/sidekiq-cron.rb",
-    "lib/sidekiq/cron.rb",
-    "lib/sidekiq/cron/job.rb",
-    "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/web.rb",
-    "lib/sidekiq/cron/web_extension.rb",
+    "Gemfile",
+    "LICENSE.txt",
+    "Rakefile",
+    "README.md",
     "sidekiq-cron.gemspec",
-    "test/integration/performance_test.rb",
-    "test/test_helper.rb",
-    "test/unit/job_test.rb",
-    "test/unit/poller_test.rb",
-    "test/unit/web_extension_test.rb"
   ]
-  s.homepage = "http://github.com/ondrejbartas/sidekiq-cron".freeze
-  s.licenses = ["MIT".freeze]
-  s.rubygems_version = "2.5.2.1".freeze
-  s.summary = "Sidekiq Cron helps to add repeated scheduled jobs".freeze
+ 
+  s.homepage = "https://github.com/ondrejbartas/sidekiq-cron"
+  s.licenses = ["MIT"]
+  s.summary = "Sidekiq Cron helps to add repeated scheduled jobs"
 
-  if s.respond_to? :specification_version then
-    s.specification_version = 4
+  s.add_dependency("fugit", ">= 1.1")
+  s.add_dependency("sidekiq", ">= 4.2.1")
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      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>.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>.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
+  s.add_development_dependency("minitest", ">= 0")
+  s.add_development_dependency("mocha", ">= 0")
+  s.add_development_dependency("redis-namespace", ">= 1.5.2")
+  s.add_development_dependency("rack", "~> 2.0")
+  s.add_development_dependency("rack-test", "~> 1.0")
+  s.add_development_dependency("rake", "~> 13.0")
+  s.add_development_dependency("shoulda-context", ">= 0")
+  s.add_development_dependency("simplecov", ">= 0")
 end
-

data/test/integration/performance_test.rb

@@ -5,10 +5,8 @@ require 'benchmark'
 describe 'Performance Poller' do
   X = 10000
   before do
+    REDIS.with { |c| c.respond_to?(:redis) ? c.redis.flushdb : c.flushdb }
     Sidekiq.redis = REDIS
-    Sidekiq.redis do |conn|
-      conn.flushdb
-    end
 
     #clear all previous saved data from redis
     Sidekiq.redis do |conn|
@@ -33,7 +31,7 @@ describe 'Performance Poller' do
     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 50s' do
     Sidekiq.redis do |conn|
       assert_equal 0, conn.llen("queue:default"), 'Queue should be empty'
     end
@@ -47,6 +45,6 @@ describe 'Performance Poller' do
     end
 
     puts "Performance test finished in #{bench.real}"
-    assert_operator bench.real, :<, 30
+    assert_operator bench.real, :<, 50
   end
 end

data/test/test_helper.rb

@@ -1,12 +1,4 @@
-require 'rubygems'
-require 'bundler'
-begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
-end
+$TESTING = true
 
 require 'simplecov'
 SimpleCov.start do
@@ -14,24 +6,25 @@ SimpleCov.start do
 
   add_group 'SidekiqCron', 'lib/'
 end
-require 'coveralls'
-Coveralls.wear!
 
 require "minitest/autorun"
 require 'shoulda-context'
 require "rack/test"
-require "mocha/setup"
+require 'mocha/minitest'
 
 ENV['RACK_ENV'] = 'test'
 
 #SIDEKIQ Require - need to have sidekiq running!
 require 'sidekiq'
-require 'sidekiq/util'
+require "sidekiq-pro" if ENV['SIDEKIQ_PRO_VERSION']
+require "sidekiq/processor"
+require "sidekiq/fetch"
+require "sidekiq/cli"
+
 require 'sidekiq/web'
 
 Sidekiq.logger.level = Logger::ERROR
 
-require 'sidekiq/redis_connection'
 redis_url = ENV['REDIS_URL'] || 'redis://0.0.0.0:6379'
 REDIS = Sidekiq::RedisConnection.create(:url => redis_url, :namespace => 'testy')
 
@@ -46,6 +39,13 @@ require 'sidekiq-cron'
 require 'sidekiq/cron/web'
 require 'pp'
 
+# For testing os symbilize args!
+class Hash
+  def symbolize_keys
+    transform_keys { |key| key.to_sym rescue key }
+  end
+end
+
 class CronTestClass
   include Sidekiq::Worker
   sidekiq_options retry: true
@@ -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

@@ -223,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
@@ -335,6 +363,108 @@ describe "Cron Job" do
     end
   end
 
+  describe '#active_job_message - unknown Active Job Worker class' do
+    before do
+      SecureRandom.stubs(:uuid).returns('XYZ')
+      ActiveJob::Base.queue_name_prefix = ''
+
+      @args = {
+        name:  'Test',
+        cron:  '* * * * *',
+        klass: 'UnknownActiveJobCronTestClass',
+        active_job: true,
+        queue: 'super_queue',
+        description: nil,
+        args:  { foo: 'bar' }
+      }
+      @job = Sidekiq::Cron::Job.new(@args)
+    end
+
+    it 'should return valid payload for Sidekiq::Client' do
+      payload = {
+        'class'       => 'ActiveJob::QueueAdapters::SidekiqAdapter::JobWrapper',
+        'wrapped'     => 'UnknownActiveJobCronTestClass',
+        'queue'       => 'super_queue',
+        'description' => nil,
+        'args'        => [{
+          'job_class'  => 'UnknownActiveJobCronTestClass',
+          'job_id'     => 'XYZ',
+          'queue_name' => 'super_queue',
+          'arguments'  => [{foo: 'bar'}]
+        }]
+      }
+      assert_equal @job.active_job_message, payload
+    end
+  end
+
+  describe '#active_job_message with symbolize_args (hash)' do
+    before do
+      SecureRandom.stubs(:uuid).returns('XYZ')
+      ActiveJob::Base.queue_name_prefix = ''
+
+      @args = {
+        name:  'Test',
+        cron:  '* * * * *',
+        klass: 'ActiveJobCronTestClass',
+        queue: 'super_queue',
+        description: nil,
+        symbolize_args: true,
+        args: { 'foo' => 'bar' }
+      }
+      @job = Sidekiq::Cron::Job.new(@args)
+    end
+
+    it 'should return valid payload for Sidekiq::Client' do
+      payload = {
+        'class'       => 'ActiveJob::QueueAdapters::SidekiqAdapter::JobWrapper',
+        'wrapped'     => 'ActiveJobCronTestClass',
+        'queue'       => 'super_queue',
+        'description' => nil,
+        'args'        => [{
+          'job_class'  => 'ActiveJobCronTestClass',
+          'job_id'     => 'XYZ',
+          'queue_name' => 'super_queue',
+          'arguments'  => [{foo: 'bar'}]
+        }]
+      }
+      assert_equal @job.active_job_message, payload
+    end
+  end
+
+  describe '#active_job_message with symbolize_args (array)' do
+    before do
+      SecureRandom.stubs(:uuid).returns('XYZ')
+      ActiveJob::Base.queue_name_prefix = ''
+
+      @args = {
+        name:  'Test',
+        cron:  '* * * * *',
+        klass: 'ActiveJobCronTestClass',
+        queue: 'super_queue',
+        description: nil,
+        symbolize_args: true,
+        args: [{ 'foo' => 'bar' }]
+      }
+      @job = Sidekiq::Cron::Job.new(@args)
+    end
+
+    it 'should return valid payload for Sidekiq::Client' do
+      payload = {
+        'class'       => 'ActiveJob::QueueAdapters::SidekiqAdapter::JobWrapper',
+        'wrapped'     => 'ActiveJobCronTestClass',
+        'queue'       => 'super_queue',
+        'description' => nil,
+        'args'        => [{
+          'job_class'  => 'ActiveJobCronTestClass',
+          'job_id'     => 'XYZ',
+          'queue_name' => 'super_queue',
+          'arguments'  => [{foo: 'bar'}]
+        }]
+      }
+      assert_equal @job.active_job_message, payload
+    end
+  end
+
   describe '#active_job_message with queue_name_prefix' do
     before do
       SecureRandom.stubs(:uuid).returns('XYZ')
@@ -381,7 +511,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
@@ -399,7 +529,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
@@ -907,7 +1037,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\" -> ArgumentError: not a cron string \"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
 

data/test/unit/poller_test.rb

@@ -4,10 +4,8 @@ require './test/test_helper'
 
 describe 'Cron Poller' do
   before do
+    REDIS.with { |c| c.respond_to?(:redis) ? c.redis.flushdb : c.flushdb }
     Sidekiq.redis = REDIS
-    Sidekiq.redis do |conn|
-      conn.flushdb
-    end
 
     #clear all previous saved data from redis
     Sidekiq.redis do |conn|