sidekiq-cron 0.6.3 → 1.4.0

data/Rakefile

@@ -1,43 +1,10 @@
-# encoding: utf-8
-
-require 'rubygems'
-require 'bundler/setup'
-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
-require 'rake'
-
-require 'jeweler'
-Jeweler::Tasks.new do |gem|
-  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
-  gem.name = "sidekiq-cron"
-  gem.homepage = "http://github.com/ondrejbartas/sidekiq-cron"
-  gem.license = "MIT"
-  gem.summary = %Q{Sidekiq Cron helps to add repeated scheduled jobs}
-  gem.description = %Q{Enables to set jobs to be run in specified time (using CRON notation)}
-  gem.email = "ondrej@bartas.cz"
-  gem.authors = ["Ondrej Bartas"]
-  # dependencies defined in Gemfile
-end
-Jeweler::RubygemsDotOrgTasks.new
-
-#TESTING
-
-task :doc do
-  system 'sdoc -N .'
-end
-
+require 'bundler/gem_tasks'
 require 'rake/testtask'
+
 task :default => :test
 
 Rake::TestTask.new(:test) do |t|
-  t.test_files = FileList['test/functional/**/*_test.rb', 'test/unit/**/*_test.rb','test/integration/**/*_test.rb']
+  t.test_files = FileList['test/unit/**/*_test.rb', 'test/integration/**/*_test.rb']
   t.warning = false
   t.verbose = false
 end
@@ -49,12 +16,6 @@ namespace :test do
     t.verbose = false
   end
 
-  Rake::TestTask.new(:functional) do |t|
-    t.test_files = FileList['test/functional/**/*_test.rb']
-    t.warning = false
-    t.verbose = false
-  end
-
   Rake::TestTask.new(:integration) do |t|
     t.test_files = FileList['test/integration/**/*_test.rb']
     t.warning = false

data/lib/sidekiq/cron/job.rb

@@ -1,6 +1,6 @@
+require 'fugit'
 require 'sidekiq'
 require 'sidekiq/util'
-require 'rufus-scheduler'
 require 'sidekiq/cron/support'
 
 module Sidekiq
@@ -12,6 +12,10 @@ module Sidekiq
 
       #how long we would like to store informations about previous enqueues
       REMEMBER_THRESHOLD = 24 * 60 * 60
+      LAST_ENQUEUE_TIME_FORMAT = '%Y-%m-%d %H:%M:%S %z'
+
+      # Use the exists? method if we're on a newer version of redis.
+      REDIS_EXISTS_METHOD = Gem.loaded_specs['redis'].version < Gem::Version.new('4.2') ? :exists : :exists?
 
       #crucial part of whole enquing job
       def should_enque? time
@@ -46,7 +50,7 @@ module Sidekiq
 
       #enque cron job to queue
       def enque! time = Time.now.utc
-        @last_enqueue_time = time
+        @last_enqueue_time = time.strftime(LAST_ENQUEUE_TIME_FORMAT)
 
         klass_const =
             begin
@@ -55,21 +59,23 @@ module Sidekiq
               nil
             end
 
-        if klass_const
-          if defined?(ActiveJob::Base) && klass_const < ActiveJob::Base
-            enqueue_active_job(klass_const)
-          else
-            enqueue_sidekiq_worker(klass_const)
-          end
-        else
-          if @active_job
-            Sidekiq::Client.push(active_job_message)
+        jid =
+          if klass_const
+            if defined?(ActiveJob::Base) && klass_const < ActiveJob::Base
+              enqueue_active_job(klass_const).try :provider_job_id
+            else
+              enqueue_sidekiq_worker(klass_const)
+            end
           else
-            Sidekiq::Client.push(sidekiq_worker_message)
+            if @active_job
+              Sidekiq::Client.push(active_job_message)
+            else
+              Sidekiq::Client.push(sidekiq_worker_message)
+            end
           end
-        end
 
         save_last_enqueue_time
+        add_jid_history jid
         logger.debug { "enqueued #{@name}: #{@message}" }
       end
 
@@ -81,14 +87,10 @@ module Sidekiq
 
       def enqueue_active_job(klass_const)
         klass_const.set(queue: @queue).perform_later(*@args)
-
-        true
       end
 
       def enqueue_sidekiq_worker(klass_const)
         klass_const.set(queue: queue_name_with_prefix).perform_async(*@args)
-
-        true
       end
 
       # siodekiq worker message
@@ -123,6 +125,7 @@ module Sidekiq
       def active_job_message
         {
           'class'        => 'ActiveJob::QueueAdapters::SidekiqAdapter::JobWrapper',
+          'wrapped'      => @klass,
           'queue'        => @queue_name_with_prefix,
           'description'  => @description,
           'args'         => [{
@@ -203,9 +206,9 @@ module Sidekiq
         job_hashes = nil
         Sidekiq.redis do |conn|
           set_members = conn.smembers(jobs_key)
-          job_hashes = conn.pipelined do
+          job_hashes = conn.pipelined do |pipeline|
             set_members.each do |key|
-              conn.hgetall(key)
+              pipeline.hgetall(key)
             end
           end
         end
@@ -233,7 +236,7 @@ module Sidekiq
             output = Job.new conn.hgetall( redis_key(name) )
           end
         end
-        output
+        output if output && output.valid?
       end
 
       # create new instance of cron job
@@ -273,13 +276,15 @@ module Sidekiq
 
         #set last enqueue time - from args or from existing job
         if args['last_enqueue_time'] && !args['last_enqueue_time'].empty?
-          @last_enqueue_time = Time.parse(args['last_enqueue_time'])
+          @last_enqueue_time = parse_enqueue_time(args['last_enqueue_time'])
         else
           @last_enqueue_time = last_enqueue_time_from_redis
         end
 
         #get right arguments for job
+        @symbolize_args = args["symbolize_args"] == true || ("#{args["symbolize_args"]}" =~ (/^(true|t|yes|y|1)$/i)) == 0 || false
         @args = args["args"].nil? ? [] : parse_args( args["args"] )
+        @args += [Time.now.to_f] if args["date_as_argument"]
 
         @active_job = args["active_job"] == true || ("#{args["active_job"]}" =~ (/^(true|t|yes|y|1)$/i)) == 0 || false
         @active_job_queue_name_prefix = args["queue_name_prefix"]
@@ -347,6 +352,12 @@ module Sidekiq
         !enabled?
       end
 
+      def pretty_message
+        JSON.pretty_generate Sidekiq.load_json(message)
+      rescue JSON::ParserError
+        message
+      end
+
       def status_from_redis
         out = "enabled"
         if fetch_missing_args
@@ -362,12 +373,24 @@ module Sidekiq
         out = nil
         if fetch_missing_args
           Sidekiq.redis do |conn|
-            out = Time.parse(conn.hget(redis_key, "last_enqueue_time")) rescue nil
+            out = parse_enqueue_time(conn.hget(redis_key, "last_enqueue_time")) rescue nil
           end
         end
         out
       end
 
+      def jid_history_from_redis
+        out =
+          Sidekiq.redis do |conn|
+            conn.lrange(jid_history_key, 0, -1) rescue nil
+          end
+
+        # returns nil if out nil
+        out && out.map do |jid_history_raw|
+          Sidekiq.load_json jid_history_raw
+        end
+      end
+
       #export job data to hash
       def to_hash
         {
@@ -382,6 +405,7 @@ module Sidekiq
           queue_name_prefix: @active_job_queue_name_prefix,
           queue_name_delimiter: @active_job_queue_name_delimiter,
           last_enqueue_time: @last_enqueue_time,
+          symbolize_args: @symbolize_args,
         }
       end
 
@@ -390,7 +414,7 @@ module Sidekiq
       end
 
       def valid?
-        #clear previos errors
+        #clear previous errors
         @errors = []
 
         errors << "'name' must be set" if @name.nil? || @name.size == 0
@@ -398,21 +422,15 @@ module Sidekiq
           errors << "'cron' must be set"
         else
           begin
-            cron = Rufus::Scheduler::CronLine.new(@cron)
-            cron.next_time(Time.now.utc).utc
-          rescue Exception => e
-            #fix for different versions of cron-parser
-            if e.message == "Bad Vixie-style specification bad"
-              errors << "'cron' -> #{@cron}: not a valid cronline"
-            else
-              errors << "'cron' -> #{@cron}: #{e.message}"
-            end
+            @parsed_cron = Fugit.do_parse_cron(@cron)
+          rescue => e
+            errors << "'cron' -> #{@cron.inspect} -> #{e.class}: #{e.message}"
           end
         end
 
         errors << "'klass' (or class) must be set" unless klass_valid
 
-        !errors.any?
+        errors.empty?
       end
 
       def klass_valid
@@ -448,9 +466,9 @@ module Sidekiq
 
           #add information about last time! - don't enque right after scheduler poller starts!
           time = Time.now.utc
-          conn.zadd(job_enqueued_key, time.to_f.to_s, formated_last_time(time).to_s) unless conn.exists(job_enqueued_key)
+          conn.zadd(job_enqueued_key, time.to_f.to_s, formated_last_time(time).to_s) unless conn.public_send(REDIS_EXISTS_METHOD, job_enqueued_key)
         end
-        logger.info { "Cron Jobs - add job with name: #{@name}" }
+        logger.info { "Cron Jobs - added job with name: #{@name}" }
       end
 
       def save_last_enqueue_time
@@ -460,6 +478,20 @@ module Sidekiq
         end
       end
 
+      def add_jid_history(jid)
+        jid_history = {
+          jid: jid,
+          enqueued: @last_enqueue_time
+        }
+        @history_size ||= (Sidekiq.options[:cron_history_size] || 10).to_i - 1
+        Sidekiq.redis do |conn|
+          conn.lpush jid_history_key,
+                     Sidekiq.dump_json(jid_history)
+          # keep only last 10 entries in a fifo manner
+          conn.ltrim jid_history_key, 0, @history_size
+        end
+      end
+
       # remove job from cron jobs by name
       # input:
       #   first arg: name (string) - name of job (must be same - case sensitive)
@@ -471,6 +503,9 @@ module Sidekiq
           #delete runned timestamps
           conn.del job_enqueued_key
 
+          # delete jid_history
+          conn.del jid_history_key
+
           #delete main job
           conn.del redis_key
         end
@@ -496,7 +531,7 @@ module Sidekiq
       # Parse cron specification '* * * * *' and returns
       # time when last run should be performed
       def last_time now = Time.now.utc
-        Rufus::Scheduler::CronLine.new(@cron).previous_time(now.utc).utc
+        parsed_cron.previous_time(now.utc).utc
       end
 
       def formated_enqueue_time now = Time.now.utc
@@ -510,7 +545,7 @@ module Sidekiq
       def self.exists? name
         out = false
         Sidekiq.redis do |conn|
-          out = conn.exists redis_key name
+          out = conn.public_send(REDIS_EXISTS_METHOD, redis_key(name))
         end
         out
       end
@@ -525,6 +560,10 @@ module Sidekiq
 
       private
 
+      def parsed_cron
+        @parsed_cron ||= Fugit.parse_cron(@cron)
+      end
+
       def not_enqueued_after?(time)
         @last_enqueue_time.nil? || @last_enqueue_time.to_i < last_time(time).to_i
       end
@@ -537,21 +576,50 @@ module Sidekiq
         case args
         when String
           begin
-            Sidekiq.load_json(args)
+            parsed_args = Sidekiq.load_json(args)
+            symbolize_args? ? symbolize_args(parsed_args) : parsed_args
           rescue JSON::ParserError
             [*args]   # cast to string array
           end
         when Hash
-          [args]      # just put hash into array
+          symbolize_args? ? [symbolize_args(args)] : [args]
         when Array
-          args        # do nothing, already array
+          symbolize_args? ? symbolize_args(args) : args
         else
           [*args]     # cast to string array
         end
       end
 
+      def symbolize_args?
+        @symbolize_args
+      end
+
+      def symbolize_args(input)
+        if input.is_a?(Array)
+          input.map do |arg|
+            if arg.respond_to?(:symbolize_keys)
+              arg.symbolize_keys
+            else
+              arg
+            end
+          end
+        elsif input.is_a?(Hash) && input.respond_to?(:symbolize_keys)
+          input.symbolize_keys
+        else
+          input
+        end
+      end
+
+      def parse_enqueue_time(timestamp)
+        DateTime.strptime(timestamp, LAST_ENQUEUE_TIME_FORMAT).to_time.utc
+      rescue ArgumentError
+        DateTime.parse(timestamp).to_time.utc
+      end
+
       def not_past_scheduled_time?(current_time)
-        last_cron_time = Rufus::Scheduler::CronLine.new(@cron).previous_time(current_time).utc
+        last_cron_time = parsed_cron.previous_time(current_time).utc
+          # or could it be?
+        #last_cron_time = last_time(current_time)
         return false if (current_time.to_i - last_cron_time.to_i) > 60
         true
       end
@@ -577,12 +645,20 @@ module Sidekiq
         "cron_job:#{name}:enqueued"
       end
 
+      def self.jid_history_key name
+        "cron_job:#{name}:jid_history"
+      end
+
       # Redis key for storing one cron job run times
       # (when poller added job to queue)
       def job_enqueued_key
         self.class.job_enqueued_key @name
       end
 
+      def jid_history_key
+        self.class.jid_history_key @name
+      end
+
       # Give Hash
       # returns array for using it for redis.hmset
       def hash_to_redis hash

data/lib/sidekiq/cron/launcher.rb

@@ -1,6 +1,3 @@
-# require  Sidekiq original launcher
-require 'sidekiq/launcher'
-
 # require cron poller
 require 'sidekiq/cron/poller'
 
@@ -10,44 +7,41 @@ require 'sidekiq/cron/poller'
 # we are creating new cron poller instance and
 # adding start and stop commands to launcher
 module Sidekiq
-  class Launcher
-    # Add cron poller to launcher
-    attr_reader :cron_poller
-
-    # remember old initialize
-    alias_method :old_initialize, :initialize
-
-    # add cron poller and execute normal initialize of Sidekiq launcher
-    def initialize(options)
-      @cron_poller = Sidekiq::Cron::Poller.new
-      old_initialize options
-    end
-
-    # remember old run
-    alias_method :old_run, :run
-
-    # execute normal run of launcher and run cron poller
-    def run
-      old_run
-      cron_poller.start
-    end
-
-    # remember old quiet
-    alias_method :old_quiet, :quiet
-
-    # execute normal quiet of launcher and quiet cron poller
-    def quiet
-      cron_poller.terminate
-      old_quiet
+  module Cron
+    module Launcher
+      # 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
+        super(options)
+      end
+
+      # execute normal run of launcher and run cron poller
+      def run
+        super
+        cron_poller.start
+      end
+
+      # execute normal quiet of launcher and quiet cron poller
+      def quiet
+        cron_poller.terminate
+        super
+      end
+
+      # execute normal stop of launcher and stop cron poller
+      def stop
+        cron_poller.terminate
+        super
+      end
     end
+  end
+end
 
-    # remember old stop
-    alias_method :old_stop, :stop
+Sidekiq.configure_server do
+  # require  Sidekiq original launcher
+  require 'sidekiq/launcher'
 
-    # execute normal stop of launcher and stop cron poller
-    def stop
-      cron_poller.terminate
-      old_stop
-    end
-  end
+  ::Sidekiq::Launcher.prepend(Sidekiq::Cron::Launcher)
 end

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

@@ -5,9 +5,9 @@ de:
   EnqueueNow: In Warteschlange
   'Cron string': Cron
   AreYouSureDeleteCronJob: Sind Sie sicher, dass sie den Cronjob %{job} löschen wollen?
-  NoCronJobsFound: "Keine Cronjobs gefunden"
+  NoCronJobsWereFound: Keine Cronjobs gefunden
   Enable: Aktivieren
   Disable: Deaktivieren
-  'Last enque': Eingereiht
+  'Last enqueued': Eingereiht
   disabled: deaktiviert
   enabled: aktiviert

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

@@ -8,11 +8,15 @@ en:
   EnqueueAll: Enqueue All
   DeleteAll: Delete All
   'Cron string': Cron
+  AreYouSureEnqueueCronJobs: Are you sure you want to enqueue ALL cron jobs?
+  AreYouSureEnqueueCronJob: Are you sure you want to enqueue the %{job} cron job?
   AreYouSureDeleteCronJobs: Are you sure you want to delete ALL cron jobs?
   AreYouSureDeleteCronJob: Are you sure you want to delete the %{job} cron job?
-  NoCronJobsFound: "No cron jobs found"
+  NoCronJobsWereFound: No cron jobs were found
   Enable: Enable
   Disable: Disable
-  'Last enque': Last enqueued
+  'Last enqueued': Last enqueued
   disabled: disabled
   enabled: enabled
+  NoHistoryWereFound: No history were found
+  Description: Description

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

@@ -0,0 +1,18 @@
+ja:
+  Job: ジョブ
+  Cron: Cron
+  CronJobs: Cronジョブ
+  EnqueueNow: すぐにキューに入れる
+  EnableAll: すべて有効にする
+  DisableAll: すべて無効にする
+  EnqueueAll: すべてキューに入れる
+  DeleteAll: すべて削除
+  'Cron string': Cron
+  AreYouSureDeleteCronJobs: 本当にすべてのcronジョブを削除しますか？
+  AreYouSureDeleteCronJob: 本当に%{job}のcronジョブを削除しますか？
+  NoCronJobsWereFound: Cronジョブが見つかりませんでした
+  Enable: 有効にする
+  Disable: 無効にする
+  'Last enqueued': 最後のキュー
+  disabled: 無効
+  enabled: 有効

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

@@ -6,9 +6,9 @@ ru:
   'Cron string': Периодичность (синтаксис Cron)
   EnqueueNow: Запустить
   AreYouSureDeleteCronJob: Вы действительно хотите удалить задачу «%{job}»?
-  NoCronJobsFound: "Не найдено периодических задач"
+  NoCronJobsWereFound: Не найдено периодических задач
   Enable: Включить
   Disable: Отключить
-  'Last enque': Последний запуск
+  'Last enqueued': Последний запуск
   disabled: отключено
   enabled: включено

data/lib/sidekiq/cron/locales/zh-CN.yml

@@ -0,0 +1,19 @@
+zh-CN:
+  Job: 任务
+  Cron: 定时任务
+  CronJobs: 定时任务列表
+  EnqueueNow: 立刻执行
+  EnableAll: 启用所有
+  DisableAll: 禁用所有
+  EnqueueAll: 执行所有
+  DeleteAll: 删除所有
+  'Cron string': 定时策略
+  AreYouSureDeleteCronJobs: 你确定删除所有的定时任务吗？
+  AreYouSureDeleteCronJob: 你确定删除定时任务（%{job}）吗？
+  NoCronJobsWereFound: 没有定时任务
+  Enable: 启用
+  Disable: 禁用
+  'Last enqueued': 放入队列时间
+  disabled: 已禁用
+  enabled: 已启用
+

data/lib/sidekiq/cron/poller.rb

@@ -17,8 +17,9 @@ module Sidekiq
       rescue => ex
         # Most likely a problem with redis networking.
         # Punt and try again at the next interval
-        logger.error ex.message
-        logger.error ex.backtrace.first
+        Sidekiq.logger.error ex.message
+        Sidekiq.logger.error ex.backtrace.first
+        handle_exception(ex) if respond_to?(:handle_exception)
       end
 
       private
@@ -27,12 +28,13 @@ module Sidekiq
         job.test_and_enque_for_time! time if job && job.valid?
       rescue => ex
         # problem somewhere in one job
-        logger.error "CRON JOB: #{ex.message}"
-        logger.error "CRON JOB: #{ex.backtrace.first}"
+        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
-         Sidekiq.options[:poll_interval] || POLL_INTERVAL
+         Sidekiq.options[:average_scheduled_poll_interval] || POLL_INTERVAL
       end
     end
   end

data/lib/sidekiq/cron/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Sidekiq
+  module Cron
+    VERSION = "1.4.0"
+  end
+end