sidekiq-cron 0.6.3 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1c9490a07af91904810a5289c0899691f70bb56b
-  data.tar.gz: 4d79c982c22844a7f7fa887dde61925aaa26e48e
+  metadata.gz: cb2f152cb3faf85dbc089e10820fd48d7c23f6ad
+  data.tar.gz: 4ced419b5c9ddaeb43a6ebd62221cdbd95eb2c91
 SHA512:
-  metadata.gz: c9717f01b61187ffb9cc2024ac3de6a01a1641159ef5f0013f742858a932b01c5a89dcb37abb254484cc1ca9edb6da10cf96fa7d0b2b068199945db18e855c3b
-  data.tar.gz: a06735e8a699441b6b9a0218e99949710b44dc2a1fdf92725fe865594687e428cd7509efd04023a9a09d5f4580466ab117ad6ccc471ab2797fae804fef9a3ea8
+  metadata.gz: d882bd7a34f478fc9ea3eb591c6ffe01df2b360ba501ef2df13aa3d7631f77a97a393bc5a391ec682810766dbfe8790bb8a42ed29fc69a666623753103c4c994
+  data.tar.gz: 4bbdf927f3830a9a62e2bf622bf34492555e0a8051f303a0a712eda46a818a5dfd78b5de913e137e39b91f046a05247ae2a133cabe1573fa1b4f21307f721b24

data/.travis.yml

@@ -1,7 +1,10 @@
 language: ruby
 rvm:
-  - 2.3.1
-  - 2.2.2
+  - 2.6
+  - 2.5
+  - 2.4
+  - 2.3
+  - 2.2
 services:
   - redis-server
 branches:
@@ -13,7 +16,3 @@ notifications:
       - ondrej@bartas.cz
 env:
   travis: 'yes'
-matrix:
-  allow_failures:
-    - rvm: jruby-19mode
-    - rvm: rbx-19mode

data/Changes.md

@@ -1,3 +1,35 @@
+v 1.2.0
+-------
+
+- updated readme
+- fix problem with Sidekiq::Launcher and requiring it when not needed
+- better patching of Sidekiq::Launcher
+- fixed Dockerfile
+
+v 1.1.0
+-------
+
+- updated readme
+- fix unit tests - changed argument error when getting invalid cron format
+- when fallbacking old job enqueued time use `Time.parse` šwithout format (so ruby can decide best method to parse it)
+- add option `date_as_argument` which will add to your job arguments on last place `Time.now.to_f` when it was eneuqued
+- add option `description` which will allow you to add notes to your jobs so in web view you can see it
+- fixed translations
+
+v 1.0.4
+-------
+
+- fix problem with upgrading to 1.0.x - parsing last enqued time didn't count with old time format stored in redis
+
+v 1.0.0
+-------
+
+- use [fugit](https://github.com/floraison/fugit) instead of [rufus-scheduler](https://github.com/jmettraux/rufus-scheduler) - API of cron didn't change (rufus scheduler is using fugit)
+- better working with Timezones
+- translations for JA, zh-CN
+- cron without timezone are considered as UTC, to add Timezone to cron use format `* * * * * Europe/Berlin`
+- be aware that this release can change when your jobs are enqueued (for me it didn't change but it is in one project, in other it can shift by different timezone setup)
+
 v 0.6.0
 -------
 

data/Dockerfile

@@ -1,4 +1,4 @@
-FROM ruby:2.3.1
+FROM ruby:2.4
 MAINTAINER Joao Serra <joaopfserra@gmail.com>
 
 RUN apt-get update && \

data/Gemfile

@@ -1,7 +1,7 @@
 source 'https://rubygems.org'
 
 gem 'sidekiq', '>= 4.2.1'
-gem 'rufus-scheduler', '>= 3.3.0'
+gem 'fugit', '~> 1.1'
 
 group :development do
   gem 'bundler'

data/README.md

@@ -1,4 +1,4 @@
-Sidekiq-Cron [![Gem Version](https://badge.fury.io/rb/sidekiq-cron.svg)](http://badge.fury.io/rb/sidekiq-cron) [![Build Status](https://travis-ci.org/ondrejbartas/sidekiq-cron.svg?branch=master)](https://travis-ci.org/ondrejbartas/sidekiq-cron) [![Coverage Status](https://coveralls.io/repos/ondrejbartas/sidekiq-cron/badge.svg?branch=master)](https://coveralls.io/r/ondrejbartas/sidekiq-cron?branch=master) [![Dependency Status](https://dependencyci.com/github/ondrejbartas/sidekiq-cron/badge)](https://dependencyci.com/github/ondrejbartas/sidekiq-cron)
+Sidekiq-Cron [![Gem Version](https://badge.fury.io/rb/sidekiq-cron.svg)](http://badge.fury.io/rb/sidekiq-cron) [![Build Status](https://travis-ci.org/ondrejbartas/sidekiq-cron.svg?branch=master)](https://travis-ci.org/ondrejbartas/sidekiq-cron) [![Coverage Status](https://coveralls.io/repos/github/ondrejbartas/sidekiq-cron/badge.svg?branch=master)](https://coveralls.io/github/ondrejbartas/sidekiq-cron?branch=master)
 ================================================================================================================================================================================================================================================================================================================================================================================================================================================
 
 [![Join the chat at https://gitter.im/ondrejbartas/sidekiq-cron](https://badges.gitter.im/ondrejbartas/sidekiq-cron.svg)](https://gitter.im/ondrejbartas/sidekiq-cron?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
@@ -7,11 +7,11 @@ Sidekiq-Cron [![Gem Version](https://badge.fury.io/rb/sidekiq-cron.svg)](http://
 
 A scheduling add-on for [Sidekiq](http://sidekiq.org).
 
-Runs a thread alongside Sidekiq workers to schedule jobs at specified times (using cron notation `* * * * *` parsed by [Rufus-Scheduler](https://github.com/jmettraux/rufus-scheduler), more about [cron notation](http://www.nncron.ru/help/EN/working/cron-format.htm).
+Runs a thread alongside Sidekiq workers to schedule jobs at specified times (using cron notation `* * * * *` parsed by [Fugit](https://github.com/floraison/fugit), more about [cron notation](http://www.nncron.ru/help/EN/working/cron-format.htm).
 
-Checks for new jobs to schedule every 10 seconds and doesn't schedule the same job multiple times when more than one Sidekiq worker is running.
+Checks for new jobs to schedule every 30 seconds and doesn't schedule the same job multiple times when more than one Sidekiq worker is running.
 
-Scheduling jobs are added only when at least one Sidekiq process is running.
+Scheduling jobs are added only when at least one Sidekiq process is running, but it is safe to use Sidekiq-Cron in environments where multiple Sidekiq processes or nodes are running.
 
 If you want to know how scheduling work, check out [under the hood](#under-the-hood)
 
@@ -19,6 +19,11 @@ Works with ActiveJob (Rails 4.2+)
 
 You don't need Sidekiq PRO, you can use this gem with plain __Sidekiq__.
 
+Upgrade from <0.6x to 1.0.x
+---------------------------
+
+Please be aware that sidekiq-cron < 1.0 was relying on rufus-scheduler < 3.5. Using those older sidekiq-cron with rufus-scheduler >= 3.5 ends up with jobs failing on creation. Sidekiq-cron 1.0 includes a patch that switches from rufus-scheduler to rufus-scheduler's core dependency, fugit.
+
 Requirements
 -----------------
 
@@ -37,7 +42,7 @@ Installation
 
 or add to your `Gemfile`
 
-    gem "sidekiq-cron", "~> 0.4.0"
+    gem "sidekiq-cron", "~> 1.1"
 
 
 Getting Started
@@ -56,19 +61,25 @@ _Job properties_:
  #OPTIONAL
  'queue' => 'name of queue',
  'args'  => '[Array or Hash] of arguments which will be passed to perform method',
+ 'date_as_argument' => true, # add the time of execution as last argument of the perform method
  'active_job' => true,  # enqueue job through rails 4.2+ active job interface
  'queue_name_prefix' => 'prefix', # rails 4.2+ active job queue with prefix
- 'queue_name_delimiter' => '.'  # rails 4.2+ active job queue with custom delimiter
+ 'queue_name_delimiter' => '.',  # rails 4.2+ active job queue with custom delimiter
+ 'description' => 'A sentence describing what work this job performs.'  # Optional
 }
 ```
 
 ### Time, cron and sidekiq-cron
 
-sidekiq-cron uses [rufus-scheduler](https://github.com/jmettraux/rufus-scheduler) to parse the cronline.
-By default, the timezone this is evaluated against UTC.
+For testing your cron notation you can use [crontab.guru](https://crontab.guru).
+
+sidekiq-cron uses [Fugit](https://github.com/floraison/fugit) to parse the cronline.
+If using Rails, this is evaluated against the timezone configured in Rails, otherwise the default is UTC.
+
 If you want to have your jobs enqueued based on a different time zone you can specify a timezone in the cronline,
 like this `'0 22 * * 1-5 America/Chicago'`.
-See [rufus-scheduler documentation](https://github.com/jmettraux/rufus-scheduler#a-note-about-timezones) for more information.
+
+See [rufus-scheduler documentation](https://github.com/jmettraux/rufus-scheduler#a-note-about-timezones) for more information. (note. Rufus scheduler is using Fugit under the hood, so documentation for Rufus Scheduler can help you also)
 
 ### What objects/classes can be scheduled
 #### Sidekiq Worker
@@ -192,7 +203,7 @@ second_job:
 #initializers/sidekiq.rb
 schedule_file = "config/schedule.yml"
 
-if File.exists?(schedule_file) && Sidekiq.server?
+if File.exist?(schedule_file) && Sidekiq.server?
   Sidekiq::Cron::Job.load_from_hash YAML.load_file(schedule_file)
 end
 ```
@@ -263,13 +274,13 @@ before the process forks, causing the following exception
 
     Redis::InheritedError: Tried to use a connection from a child process without reconnecting. You need to reconnect to Redis after forking.
 
-to occcur. To avoid this, wrap your job creation in the call to `Sidekiq.configure_server`:
+to occur. To avoid this, wrap your job creation in the call to `Sidekiq.configure_server`:
 
 ```ruby
 Sidekiq.configure_server do |config|
   schedule_file = "config/schedule.yml"
 
-  if File.exists?(schedule_file)
+  if File.exist?(schedule_file)
     Sidekiq::Cron::Job.load_from_hash YAML.load_file(schedule_file)
   end
 end
@@ -288,6 +299,8 @@ Sidekiq-Cron is checking jobs to be enqueued every 30s by default, you can chang
 Sidekiq.options[: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.
+
 ## Thanks to
 * [@7korobi](https://github.com/7korobi)
 * [@antulik](https://github.com/antulik)

data/VERSION

@@ -1 +1 @@
-0.6.3
+1.2.0

data/docker-compose.yml

@@ -18,4 +18,6 @@ services:
     - redis:redis.test
     depends_on:
     - common
-    command: dockerize -wait tcp://redis.test:6379 -timeout 60s rake test
+    command: dockerize -wait tcp://redis.test:6379 -timeout 60s bundle exec rake test
+    volumes:
+    - .:/sidekiq-cron

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,7 @@ 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'
 
       #crucial part of whole enquing job
       def should_enque? time
@@ -46,7 +47,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 +56,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 +84,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 +122,7 @@ module Sidekiq
       def active_job_message
         {
           'class'        => 'ActiveJob::QueueAdapters::SidekiqAdapter::JobWrapper',
+          'wrapped'      => @klass,
           'queue'        => @queue_name_with_prefix,
           'description'  => @description,
           'args'         => [{
@@ -273,13 +273,14 @@ 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
         @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 +348,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 +369,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
         {
@@ -390,7 +409,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 +417,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
@@ -460,6 +473,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 +498,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 +526,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
@@ -525,6 +555,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
@@ -550,8 +584,16 @@ module Sidekiq
         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 +619,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