sidekiq-cron 0.2.0 → 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0e24b22d1f58e374c9ea85f606f3a86e01c204c6
+  data.tar.gz: af7f0ea32e39568a6f04981703088cf9c5fb4692
+SHA512:
+  metadata.gz: 4283ebe1d86984162381e640bad0d447b7fd2b4b25fd24f0a5750381fcd2aa74ab1432c3918015789bd549635928afbe84a102956c52a0ba79e7383850154854
+  data.tar.gz: 38e0734ff2253e123fe012687153cad465a06b187cda5806ac05baac3984ef24fbb14b072f522d2e759b821b0989c6cd4ca538c249efb43067946635d70d2911

data/.travis.yml

@@ -1,10 +1,9 @@
 language: ruby
 rvm:
-  - 1.9.3
   - jruby-19mode
   - rbx-19mode
   - 2.0.0
-  - 2.1.0
+  - 2.2.2
 services:
   - redis-server
 branches:
@@ -19,4 +18,4 @@ env:
 matrix:
   allow_failures:
     - rvm: jruby-19mode
-    - rvm: rbx-19mode
+    - rvm: rbx-19mode

data/Changes.md

@@ -1,8 +1,13 @@
+v 0.3.0
+-------
 
+- suport for Active Job
+- sidekiq cron web ui needs to be loaded by: require 'sidekiq/cron/web'
+- add load_from_hash! and load_from_array! which cleanup jobs before adding new ones
 
 v 0.1.1
 -------
 
 - add Web fontend with enabled/disable job, unqueue now, delete job
 - add cron poller - enqueu cro jobs
-- add cron job - save all needed data to redis
+- add cron job - save all needed data to redis

data/Gemfile

@@ -1,30 +1,31 @@
 source 'https://rubygems.org'
 
 gem 'tilt' , '< 2.0.0'
-gem "sidekiq", ">= 2.17.3"
+gem 'sidekiq', '>= 2.17.3'
 gem 'rufus-scheduler', '>= 2.0.24'
 
 group :development do
-  gem "bundler"
-  gem "simplecov"
+  gem 'bundler'
+  gem 'simplecov'
 
   gem 'shoulda-context'
-  gem "turn"
 
   gem 'rack'
   gem 'rack-test'
 
-  gem "jeweler", "~> 1.8.3"
+  gem 'jeweler', '~> 1.8.3'
 
-  gem "sdoc" # sdoc -N .
+  gem 'minitest'
+  gem 'test-unit'
+  gem 'sdoc' # sdoc -N .
 
-  gem "slim"
-  gem "sinatra"
+  gem 'slim'
+  gem 'sinatra'
 
   gem 'mocha'
   gem 'coveralls'
 
-  gem "shotgun"
+  gem 'shotgun'
 
   # gem 'guard'
   # gem 'guard-minitest'

data/README.md

@@ -2,16 +2,28 @@ Sidekiq-Cron [![Gem Version](https://badge.fury.io/rb/sidekiq-cron.png)](http://
 ================================================================================================================================================================================================================================================================================================================================================================================================================================================
 
 
-Add-on for [Sidekiq](http://sidekiq.org)
+An scheduling add-on for [Sidekiq](http://sidekiq.org).
 
-Allows you to schedule recurring jobs for sidekiq workers using cron notation _* * * * *_.
+Runs a thread along side 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).
+
+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.
+
+Scheduling jobs are added only when at least one sidekiq process is running.
+
+If you want to know how scheduling work check [out under the hood](#under-the-hood)
+
+Works with Active jobs (Rails 4.2+)
 
 Requirements
 -----------------
 
 - Redis 2.4 or greater is required.
-- Sidekiq 2.13.1 or grater is required.
+- Sidekiq 2.17.3 or grater is required.
 
+Change Log
+----------
+before upgrading to new version pls read:
+[Change Log](https://github.com/ondrejbartas/sidekiq-cron/raw/master/Changes.md)
 
 Installation
 ------------
@@ -20,7 +32,7 @@ Installation
 
 or add to your Gemfile
 
-    gem "sidekiq-cron", "~> 0.1.0"
+    gem "sidekiq-cron", "~> 0.3.0"
 
 
 Getting Started
@@ -42,6 +54,35 @@ _Job properties_:
 }
 ```
 
+### Time, cron and sidekiq-cron
+
+Cron line is allways evaluated against UTC time. So if you are Prague (timezone +02:00) and you want job to be qneueued at 8:30 AM
+You will need to adjust cronline to `30 6 * * *`.
+
+### What objects/classes can be scheduled
+#### Sidekiq Worker
+In example we were using: `HardWorker` which loooks like:
+```ruby
+class HardWorker
+  include Sidekiq::Worker
+  def perform(*args)
+    # do something
+  end
+end
+```
+
+#### Active Job Worker
+You can schedule: `ExampleJob` which loooks like:
+```ruby
+class ExampleJob < ActiveJob::Base
+  queue_as :default
+
+  def perform(*args)
+    # Do something
+  end
+end
+```
+
 #### Adding Cron job:
 ```ruby
 
@@ -111,9 +152,16 @@ array = [
 Sidekiq::Cron::Job.load_from_array array
 ```
 
+Bang methods will remove jobs that are not present in given hash/array
+updates jobs with same names and create new ones.
+```ruby
+Sidekiq::Cron::Job#load_from_hash! hash
+Sidekiq::Cron::Job#load_from_array! array
+```
+
 or from YML (same notation as Resque-scheduler)
 ```yaml
-#config/shedule.yml
+#config/schedule.yml
 
 my_first_job:
   cron: "*/5 * * * *"
@@ -124,7 +172,7 @@ second_job:
   cron: "*/30 * * * *"
   class: "HardWorker"
   queue: hard_worker_long
-  args: 
+  args:
     hard: "stuff"
 ```
 
@@ -137,8 +185,6 @@ if File.exists?(schedule_file)
 end
 ```
 
-
-
 #### Finding jobs
 ```ruby
 #return array of all jobs
@@ -191,10 +237,38 @@ Just start sidekiq workers by:
 ### Web Ui for Cron Jobs
 
 If you are using sidekiq web ui and you would like to add cron josb to web too,
-add `require 'sidekiq-cron'` after `require 'sidekiq/web'`.
+add `require 'sidekiq/cron/web'` after `require 'sidekiq/web'`.
 By this you will get:
 ![Web UI](https://github.com/ondrejbartas/sidekiq-cron/raw/master/examples/web-cron-ui.png)
 
+### Forking Processes
+
+If you're using a forking web server like Unicorn you may run into an issue where the Redis connection is used
+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 a call to `Sidekiq.configure_server`:
+
+```ruby
+Sidekiq.configure_server do |config|
+  schedule_file = "config/schedule.yml"
+
+  if File.exists?(schedule_file)
+    Sidekiq::Cron::Job.load_from_hash YAML.load_file(schedule_file)
+  end
+end
+```
+
+Note that this API is only available in Sidekiq 3.x.x.
+
+## Under the hood
+
+When you start sidekiq process it starts one thread with Sidekiq::Poller instance, which perform adding of scheduled jobs to queues, retryes etc.
+
+Sidekiq-Cron add itself into this start procedure and start another thread with Sidekiq::Cron::Poler which checks all enabled sidekiq cron jobs evry 10 seconds,
+if they should be added to queue (their cronline matches time of check).
+
 
 
 ## Contributing to sidekiq-cron

data/Rakefile

@@ -1,7 +1,9 @@
 # encoding: utf-8
 
 require 'rubygems'
+require 'bundler/setup'
 require 'bundler'
+
 begin
   Bundler.setup(:default, :development)
 rescue Bundler::BundlerError => e
@@ -58,4 +60,4 @@ namespace :test do
     t.warning = false
     t.verbose = false
   end
-end
+end

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.0

data/lib/sidekiq/cron.rb

@@ -1,14 +1,8 @@
-begin
-  require "sidekiq/web"
-rescue LoadError
-  # client-only usage
-end
-
 require "sidekiq/cron/job"
-require "sidekiq/cron/web_extension"
 
 #require poller only if celluloid is defined
 if defined?(Celluloid)
+  require 'celluloid/autostart'
   require "sidekiq/cron/poller"
   require "sidekiq/cron/launcher"
 end
@@ -17,14 +11,3 @@ module Sidekiq
   module Cron
   end
 end
-
-if defined?(Sidekiq::Web)
-  Sidekiq::Web.register Sidekiq::Cron::WebExtension
-
-  if Sidekiq::Web.tabs.is_a?(Array)
-    # For sidekiq < 2.5
-    Sidekiq::Web.tabs << "cron"
-  else
-    Sidekiq::Web.tabs["Cron"] = "cron"
-  end
-end

data/lib/sidekiq/cron/job.rb

@@ -11,7 +11,7 @@ module Sidekiq
       extend Util
 
       #how long we would like to store informations about previous enqueues
-      REMEMBER_THRESHOLD = 24 * 60 * 60 
+      REMEMBER_THRESHOLD = 24 * 60 * 60
 
       #crucial part of whole enquing job
       def should_enque? time
@@ -45,12 +45,36 @@ module Sidekiq
       def enque! time = Time.now
         @last_enqueue_time = time
 
-        Sidekiq::Client.push(@message.is_a?(String) ? Sidekiq.load_json(@message) : @message)
+        if defined?(ActiveJob::Base) && @klass.to_s.constantize < ActiveJob::Base
+          Sidekiq::Client.push(active_job_message)
+        else
+          Sidekiq::Client.push(sidekiq_worker_message)
+        end
 
         save
         logger.debug { "enqueued #{@name}: #{@message}" }
       end
 
+      # siodekiq worker message
+      def sidekiq_worker_message
+        @message.is_a?(String) ? Sidekiq.load_json(@message) : @message
+      end
+
+      # active job has different structure how it is loading data from sidekiq
+      # queue, it createaswrapper arround job
+      def active_job_message
+        {
+          'class' => 'ActiveJob::QueueAdapters::SidekiqAdapter::JobWrapper',
+          'queue' => @queue,
+          'args'  => [{
+            'job_class'  => @klass,
+            'job_id'     => SecureRandom.uuid,
+            'queue_name' => @queue,
+            'arguments'  => @args
+          }]
+        }
+      end
+
       # load cron jobs from Hash
       # input structure should look like:
       # {
@@ -73,6 +97,12 @@ module Sidekiq
         load_from_array array
       end
 
+      # like to {#load_from_hash}
+      # If exists old jobs in redis but removed from args, destroy old jobs
+      def self.load_from_hash! hash
+        destroy_removed_jobs(hash.keys)
+        load_from_hash(hash)
+      end
 
       # load cron jobs from Array
       # input structure should look like:
@@ -99,6 +129,13 @@ module Sidekiq
         errors
       end
 
+      # like to {#load_from_array}
+      # If exists old jobs in redis but removed from args, destroy old jobs
+      def self.load_from_array! array
+        job_names = array.map { |job| job["name"] }
+        destroy_removed_jobs(job_names)
+        load_from_array(array)
+      end
 
       # get all cron jobs
       def self.all
@@ -194,7 +231,7 @@ module Sidekiq
             when String
               begin
                 @klass.constantize.get_sidekiq_options.merge(message_data)
-              rescue 
+              rescue
                 #Unknown class
                 message_data.merge("queue"=>"default")
               end
@@ -203,7 +240,11 @@ module Sidekiq
 
           #override queue if setted in config
           #only if message is hash - can be string (dumped JSON)
-          message_data['queue'] = args['queue'] if args['queue']
+          if args['queue']
+            @queue = message_data['queue'] = args['queue']
+          else
+            @queue = message_data['queue'] || default
+          end
 
           #dump message as json
           @message = message_data
@@ -211,7 +252,7 @@ module Sidekiq
 
       end
 
-      def status 
+      def status
         @status
       end
 
@@ -258,7 +299,7 @@ module Sidekiq
         }
       end
 
-      def errors 
+      def errors
         @errors ||= []
       end
 
@@ -268,9 +309,9 @@ module Sidekiq
 
         errors << "'name' must be set" if @name.nil? || @name.size == 0
         if @cron.nil? || @cron.size == 0
-          errors << "'cron' must be set" 
+          errors << "'cron' must be set"
         else
-          begin 
+          begin
             cron = Rufus::Scheduler::CronLine.new(@cron)
             cron.next_time(Time.now)
           rescue Exception => e
@@ -283,11 +324,21 @@ module Sidekiq
           end
         end
 
-        errors << "'klass' (or class) must be set" if @klass.nil? || @klass.size == 0
+        errors << "'klass' (or class) must be set" unless klass_valid
 
         !errors.any?
       end
 
+      def klass_valid
+        case @klass
+          when Class
+            true
+          when String
+            @klass.size > 0
+          else
+        end
+      end
+
       # add job to cron jobs
       # input:
       #   name: (string) - name of job
@@ -315,7 +366,7 @@ module Sidekiq
         end
         logger.info { "Cron Jobs - add job with name: #{@name}" }
       end
-      
+
       # remove job from cron jobs by name
       # input:
       #   first arg: name (string) - name of job (must be same - case sensitive)
@@ -323,7 +374,7 @@ module Sidekiq
         Sidekiq.redis do |conn|
           #delete from set
           conn.srem self.class.jobs_key, redis_key
-          
+
           #delete runned timestamps
           conn.del job_enqueued_key
 
@@ -341,6 +392,14 @@ module Sidekiq
         logger.info { "Cron Jobs - deleted all jobs" }
       end
 
+      # remove "removed jobs" between current jobs and new jobs
+      def self.destroy_removed_jobs new_job_names
+        current_job_names = Sidekiq::Cron::Job.all.map(&:name)
+        removed_job_names = current_job_names - new_job_names
+        removed_job_names.each { |j| Sidekiq::Cron::Job.destroy(j) }
+        removed_job_names
+      end
+
       # Parse cron specification '* * * * *' and returns
       # time when last run should be performed
       def last_time now = Time.now
@@ -372,7 +431,7 @@ module Sidekiq
       def not_enqueued_after?(time)
         @last_enqueue_time.nil? || @last_enqueue_time < last_time(time)
       end
-      
+
       # Try parsing inbound args into an array.
       # args from Redis will be encoded JSON;
       # try to load JSON, then failover