rekiq 0.9.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dd9eb984f52070bc25eb6b801d09e6bfd4131042
-  data.tar.gz: 0c8efe50023481085da80b2f0a420ddab4d9b4d2
+  metadata.gz: c35103e24fdf19a9103b5413045b7b9519f31b5c
+  data.tar.gz: d370ec60d8dfa653b1fc2baab31b4bc9e63ec459
 SHA512:
-  metadata.gz: b7a0a66f5caa4b38e28e78f2b71653e8550b25a35c21dd8294c5de5d3e954c00f645cc0202557ac3faeba3cbe1dfeaa9906d1d72f5a9f5a7a364fc651060c090
-  data.tar.gz: 18b1364a70c24c790e7b2971ac379958a7dd6a81661c8b496cd7eabce7fb75428ad10bd7e42e078c7e156c19a74a86f4a8b3df607afd77570473547ca550385c
+  metadata.gz: 8cce22c704902a039b2dfdf721109c292199310a1bcab75398e4d3bcaa2c4cee1109f922ab34f85c59d8d3fbdf61fac02701091dde78f3709f56bbfade159205
+  data.tar.gz: afd6108ae9af9a7285b8aa8afc7ec4af58892d0dcba5c71e1208150c36169230e6cb58207885e5aa889a7611e8b736c932157a97b8e3e23c38e13711992497bf

data/lib/rekiq/configuration.rb

@@ -4,28 +4,34 @@ module Rekiq
   class Configuration
     include Validator
 
-    attr_accessor :shift, :schedule_post_work, :schedule_expired,
-                  :expiration_margin
+    attr_accessor :schedule_post_work, :work_time_shift, :work_time_tolerance,
+                  :schedule_expired
 
-    validate :shift, :numeric
-    validate :schedule_post_work, :bool
-    validate :expiration_margin, :numeric, greater_than_or_equal_to: 0
-    validate :schedule_expired, :bool
+    validate :schedule_post_work,  :bool
+    validate :work_time_shift,     :numeric
+    validate :work_time_tolerance, :numeric, greater_than_or_equal_to: 0
+    validate :schedule_expired,    :bool
 
     def initialize
-      # the value of the shift to apply relative to time returned by schedule
-      self.shift = 0
-
-      # if next work is scheduled after or before the worker completes
-      self.schedule_post_work = false
-
-      # indicates the margin after which a work is considered expired
-      # default to 0
-      self.expiration_margin = 0
-
-      # if expired works are to be scheduled
-      # an expired work is a work that has a time bellow current_time - margin
-      self.schedule_expired = false
+      # indicates if next work is scheduled after or before the worker completes
+      # this is relevant when we want to guarantee that workers do not run in paralel
+      # default false
+      @schedule_post_work = false
+
+      # indicates a shift, in seconds, to apply to event time returned from schedule
+      # to calculate the work_time
+      # default 0
+      @work_time_shift = 0
+
+      # indicates the tolerance, in seconds, for work_time relative to current time
+      # default 0 and must be greater than or equal to 0
+      @work_time_tolerance = 0
+
+      # indicates if expired work_times are to be scheduled
+      # a work_time is considered expired when it's before current time minus
+      # work_time_tolerance
+      # default false
+      @schedule_expired = false
     end
   end
 

data/lib/rekiq/contract.rb

@@ -0,0 +1,115 @@
+require 'rekiq/validator'
+require 'rekiq/configuration'
+
+module Rekiq
+  class Contract
+    include Validator
+
+    attr_accessor :schedule, :cancel_args, :addon, :schedule_post_work,
+                  :work_time_shift, :work_time_tolerance, :schedule_expired
+
+    validate :schedule,            :schedule
+    validate :schedule_post_work,  :bool,    allow_nil: true
+    validate :work_time_shift,     :numeric, allow_nil: true
+    validate :work_time_tolerance, :numeric, allow_nil: true,
+             greater_than_or_equal_to: 0
+    validate :schedule_expired,    :bool,    allow_nil: true
+
+    class << self
+      def from_hash(hash)
+        new \
+          'schedule'            => Marshal.load(hash['s'].encode('ISO-8859-1')),
+          'cancel_args'         => hash['ca'],
+          'addon'               => hash['ao'],
+          'schedule_post_work'  => hash['pw'],
+          'work_time_shift'     => hash['ws'],
+          'work_time_tolerance' => hash['wt'],
+          'schedule_expired'    => hash['se']
+      end
+    end
+
+    def initialize(attributes = {})
+      @schedule            = attributes['schedule']
+      @cancel_args         = attributes['cancel_args']
+      @addon               = attributes['addon']
+      @schedule_post_work  = attributes['schedule_post_work']
+      @work_time_shift     = attributes['work_time_shift']
+      @work_time_tolerance = attributes['work_time_tolerance']
+      @schedule_expired    = attributes['schedule_expired']
+    end
+
+    def to_hash
+      {
+        's'  => Marshal.dump(schedule).force_encoding('ISO-8859-1').encode('UTF-8'),
+        'ca' => cancel_args,
+        'ao' => addon,
+        'pw' => schedule_post_work,
+        'ws' => work_time_shift,
+        'wt' => work_time_tolerance,
+        'se' => schedule_expired
+      }.delete_if { |k, v| v.nil? }
+    end
+
+    def initial_work_time(from)
+      from = (shift > 0 ? from - shift : from) - tolerance
+      calculate_work_time(from)
+    end
+
+    def next_work_time(previous_work_time)
+      from = previous_work_time - shift
+      calculate_work_time(from)
+    end
+
+    def schedule_post_work?
+      unless schedule_post_work.nil?
+        schedule_post_work
+      else
+        Rekiq.configuration.schedule_post_work
+      end
+    end
+
+  protected
+
+    def calculate_work_time(from)
+      if schedule_expired?
+        from      = schedule.next_occurrence(from)
+        work_time = from.nil? ? nil : from + shift
+      else
+        begin
+          from      = schedule.next_occurrence(from)
+          work_time = from.nil? ? nil : from + shift
+        end until work_time.nil? || work_time > expiration_time
+      end
+
+      work_time
+    end
+
+    def expiration_time
+      Time.now - tolerance
+    end
+
+    def shift
+      unless work_time_shift.nil?
+        work_time_shift
+      else
+        Rekiq.configuration.work_time_shift
+      end
+    end
+
+    def tolerance
+      unless work_time_tolerance.nil?
+        work_time_tolerance
+      else
+        Rekiq.configuration.work_time_tolerance
+      end
+    end
+
+    def schedule_expired?
+      unless schedule_expired.nil?
+        schedule_expired
+      else
+        Rekiq.configuration.schedule_expired
+      end
+    end
+  end
+end

data/lib/rekiq/middleware/utils.rb

@@ -2,8 +2,7 @@ module Rekiq
   module Middleware
     class Utils
       def call(worker, msg, queue)
-        if worker.respond_to?(:scheduled_work_time) and
-           msg.key?('rq:at')
+        if msg.key?('rq:at')
           worker.scheduled_work_time = Time.at(msg['rq:at'].to_f).utc
         end
 

data/lib/rekiq/middleware/work_overseer.rb

@@ -1,6 +1,6 @@
 require 'sidekiq'
 require 'sidekiq/util'
-require 'rekiq/job'
+require 'rekiq/contract'
 require 'rekiq/scheduler'
 
 module Rekiq
@@ -9,60 +9,49 @@ module Rekiq
       include ::Sidekiq::Util
 
       def call(worker, msg, queue)
-        return yield unless msg.key?('rq:job')
+        return yield unless msg.key?('rq:ctr')
 
-        setup_vars(worker, msg, queue)
+        @worker      = worker
+        @worker_name = worker.class.name
+        @msg         = msg
+        @queue       = queue
+        @contract    = Contract.from_hash(msg['rq:ctr'])
 
         if cancel_worker?
-          return logger.info 'worker canceled by rekiq cancel method'
+          return logger.info "worker #{@worker_name} was canceled"
         end
 
-        return yield unless msg.key?('rq:schdlr')
-
-        msg.delete('rq:schdlr')
+        if msg.key?('rq:sdl')
+          msg.delete('rq:sdl')
+        else
+          return yield
+        end
 
         begin
-          reschedule unless @job.schedule_post_work?
+          reschedule unless @contract.schedule_post_work?
           yield
         ensure
-          reschedule if @job.schedule_post_work?
+          reschedule if @contract.schedule_post_work?
         end
       end
 
     protected
 
-      def setup_vars(worker, msg, queue)
-        @cancel_method = worker.rekiq_cancel_method
-        @cancel_args   = msg['rq:ca']
-        @worker      = worker
-        @worker_name = worker.class.name
-        @queue       = queue
-        @args        = msg['args']
-        @job         = Job.from_array(msg['rq:job'])
-        @addon       = msg['rq:addon']
-        @scheduled_work_time = Time.at(msg['rq:at'].to_f)
-      end
-
       def cancel_worker?
-        !@cancel_method.nil? and @worker.send(@cancel_method, *@cancel_args)
-      rescue StandardError => s
-        raise CancelMethodInvocationError,
-              "error while invoking rekiq_cancel_method with message " \
-              "#{s.message}",
-              s.backtrace
+        @worker.cancel_rekiq_worker?(*@contract.cancel_args)
       end
 
       def reschedule
         jid, work_time =
           Rekiq::Scheduler
-            .new(@worker_name, @queue, @args, @job, @addon, @cancel_args)
-            .schedule_from_work_time(@scheduled_work_time)
+            .new(@worker_name, @queue, @msg['args'], @contract)
+            .schedule_next_work(Time.at(@msg['rq:at'].to_f))
 
         unless jid.nil?
-          logger.info "recurring work for #{@worker_name} scheduled for " \
+          logger.info "worker #{@worker_name} scheduled for " \
                       "#{work_time} with jid #{jid}"
         else
-          logger.info 'recurrence terminated, job terminated'
+          logger.info 'recurrence terminated, worker terminated'
         end
       end
     end

data/lib/rekiq/scheduler.rb

@@ -1,41 +1,38 @@
 module Rekiq
   class Scheduler
-    def initialize(worker_name, queue, args, job, addon, cancel_args)
+    def initialize(worker_name, queue, args, contract)
       @worker_name = worker_name
       @queue       = queue
       @args        = args
-      @job         = job
-      @addon       = addon
-      @cancel_args = cancel_args
+      @contract    = contract
     end
 
-    def schedule(from = Time.now)
-      @work_time = @job.next_work_time(from)
-
-      @work_time.nil? ? nil : [schedule_work, @work_time]
+    def schedule_initial_work(from = Time.now)
+      @work_time = @contract.initial_work_time(from)
+      schedule_work
     end
 
-    def schedule_from_work_time(from)
-      @work_time = @job.next_work_time_from_work_time(from)
-
-      @work_time.nil? ? nil : [schedule_work, @work_time]
+    def schedule_next_work(previous_work_time)
+      @work_time = @contract.next_work_time(previous_work_time)
+      schedule_work
     end
 
-  private
+  protected
 
     def schedule_work
+      @work_time.nil? ? nil : [push_to_redis, @work_time]
+    end
+
+    def push_to_redis
       client_args = {
-          'at'     => @work_time.to_f,
-          'queue'  => @queue,
-          'class'  => @worker_name,
-          'args'   => @args,
-          'rq:job' => @job.to_array,
-          'rq:at'  => @work_time.to_f,
-          'rq:schdlr' => nil
-        }.tap do |hash|
-          hash['rq:addon'] = @addon unless @addon.nil?
-          hash['rq:ca']    = @cancel_args unless @cancel_args.nil?
-        end
+        'at'     => @work_time.to_f,
+        'queue'  => @queue,
+        'class'  => @worker_name,
+        'args'   => @args,
+        'rq:ctr' => @contract.to_hash,
+        'rq:sdl' => nil,
+        'rq:at'  => @work_time.to_f # this needs to be here because the key 'at' is removed by sidekiq
+      }
 
       Sidekiq::Client.push(client_args)
     end

data/lib/rekiq/validator.rb

@@ -6,12 +6,12 @@ module Rekiq
       attr_accessor :for_validation
 
       def validate(attribute_name, type, options = {})
-        options[:allow_nil] = true if options[:allow_nil].nil?
+        options[:allow_nil] = false if options[:allow_nil].nil?
 
         self.for_validation << {
             attribute_name: attribute_name,
-            type:    type,
-            options: options
+            type:           type,
+            options:        options
           }
       end
     end
@@ -28,11 +28,11 @@ module Rekiq
     def validate!
       self.class.for_validation.each do |v|
         attribute_name = v[:attribute_name]
-        type    = v[:type]
-        options = v[:options]
-        value   = send(attribute_name)
+        type           = v[:type]
+        options        = v[:options]
+        value          = instance_variable_get("@#{attribute_name}")
 
-        unless options[:allow_nil] and send(attribute_name).nil?
+        unless options[:allow_nil] and value.nil?
           send("validate_#{type}!", attribute_name, value, options)
         end
       end
@@ -62,7 +62,7 @@ module Rekiq
     def validate_schedule!(attribute_name, value, options)
       unless value.respond_to?(:next_occurrence) and
              value.method(:next_occurrence).arity.abs == 1
-        raise InvalidConf, '#attribute_name must respond to next_occurrence ' \
+        raise InvalidConf, "#{attribute_name} must respond to next_occurrence " \
                            'and receive one argument of type Time'
       end
     end

data/lib/rekiq/version.rb

@@ -1,3 +1,3 @@
 module Rekiq
-  VERSION = '0.9.3'
+  VERSION = '1.0.0'
 end

data/lib/rekiq/worker.rb

@@ -1,12 +1,12 @@
 require 'rekiq/exceptions'
-require 'rekiq/job'
+require 'rekiq/contract'
 require 'rekiq/scheduler'
 
 module Rekiq
   module Worker
     class Configuration
-      attr_accessor :shift, :schedule_post_work, :schedule_expired,
-                    :expiration_margin, :addon, :cancel_args
+      attr_accessor :cancel_args, :addon, :schedule_post_work, :work_time_shift,
+                    :work_time_tolerance, :schedule_expired, :starting_at
 
       def rekiq_cancel_args(*args)
         @cancel_args = args
@@ -15,51 +15,49 @@ module Rekiq
 
     module ClassMethods
       def perform_recurringly(schedule, *args)
-        @config = Configuration.new
-        yield @config if block_given?
-
         validate!
 
-        job =
-          Rekiq::Job
-            .new 'schedule'           => schedule,
-                 'shift'              => @config.shift,
-                 'schedule_post_work' => @config.schedule_post_work,
-                 'schedule_expired'   => @config.schedule_expired,
-                 'expiration_margin'  => @config.expiration_margin
+        config = Configuration.new
+        yield config if block_given?
+
+        contract =
+          Rekiq::Contract
+            .new 'schedule'            => schedule,
+                 'cancel_args'         => config.cancel_args,
+                 'addon'               => config.addon,
+                 'schedule_post_work'  => config.schedule_post_work,
+                 'work_time_shift'     => config.work_time_shift,
+                 'work_time_tolerance' => config.work_time_tolerance,
+                 'schedule_expired'    => config.schedule_expired
 
-        job.validate!
+        contract.validate!
 
         queue = get_sidekiq_options['queue']
 
         jid, work_time =
           Rekiq::Scheduler
-            .new(name, queue, args, job, @config.addon, @config.cancel_args)
-            .schedule
+            .new(self.name, queue, args, contract)
+            .schedule_initial_work(config.starting_at || Time.now)
 
         unless jid.nil?
           ::Sidekiq.logger.info \
-            "recurring work for #{name} scheduled for " \
-            "#{work_time} with jid #{jid}"
+            "recurring work for #{self.name} scheduled for #{work_time} " \
+            "with jid #{jid}"
         end
 
         jid
       end
 
-      def rekiq_cancel_method
-        get_sidekiq_options['rekiq_cancel_method']
-      end
-
     protected
 
       def validate!
-        unless rekiq_cancel_method.nil? or
-               self.method_defined?(rekiq_cancel_method)
-          raise CancelMethodMissing,
-                'rekiq cancel method name defined as '                         \
-                "#{rekiq_cancel_method}, but worker does not have "            \
-                'a method with that name, either remove definition or define ' \
-                'missing method'
+        method_name = get_sidekiq_options['rekiq_cancel_method']
+
+        unless method_name.nil? or method_defined?(method_name)
+          raise ::Rekiq::CancelMethodMissing,
+                "rekiq cancel method name defined as #{method_name}, but " \
+                'worker has no method with that name, either remove '      \
+                'definition or define missing method'
         end
       end
     end
@@ -77,8 +75,14 @@ module Sidekiq
       base.extend(Rekiq::Worker::ClassMethods)
     end
 
-    def rekiq_cancel_method
-      self.class.rekiq_cancel_method
+    def cancel_rekiq_worker?(*method_args)
+      method_name = self.class.get_sidekiq_options['rekiq_cancel_method']
+
+      !method_name.nil? and send(method_name, *method_args)
+    rescue StandardError => s
+      raise ::Rekiq::CancelMethodInvocationError,
+            "error while invoking rekiq_cancel_method: #{s.message}",
+            s.backtrace
     end
   end
 end

data/rekiq.gemspec

@@ -26,7 +26,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'simplecov', '~> 0.9'
   spec.add_development_dependency 'codeclimate-test-reporter', '~> 0.4'
   spec.add_development_dependency 'factory_girl', '~> 4.4'
-  spec.add_development_dependency 'jazz_hands', '~> 0.5'
   spec.add_development_dependency 'ice_cube', '~> 0.12'
   spec.add_development_dependency 'sidekiq', '~> 3.2'
+
+  # spec.add_development_dependency 'jazz_hands', '~> 0.5'
 end

data/spec/factories/configuration.rb

@@ -1,8 +1,8 @@
 FactoryGirl.define do
   factory :configuration, class: Rekiq::Configuration do
-    shift              [*-100..100].sample
-    schedule_post_work [true, false].sample
-    expiration_margin  [*0..100].sample
-    schedule_expired   [true, false].sample
+    schedule_post_work  [true, false].sample
+    work_time_shift     [*-100..100].sample
+    work_time_tolerance [*0..100].sample
+    schedule_expired    [true, false].sample
   end
 end

data/spec/factories/contract.rb

@@ -0,0 +1,17 @@
+require 'ice_cube'
+
+FactoryGirl.define do
+  factory :contract, class: Rekiq::Contract do
+    work_time_shift 0
+    schedule        IceCube::Schedule.new(Time.now + 3600)
+
+    trait :randomized_attributes do
+      cancel_args         [nil, 'asd', ['d', 'dsa']].sample
+      addon               [nil, '2121', 'dasdas'].sample
+      schedule_post_work  [nil, false, true].sample
+      work_time_shift     [nil, *0..100].sample
+      work_time_tolerance [nil, *0..100].sample
+      schedule_expired    [nil, false, true].sample
+    end
+  end
+end

data/spec/rekiq/configuration_spec.rb

@@ -5,16 +5,16 @@ describe Rekiq::Configuration do
     context 'for created Configuration instance' do
       before { @configuration = Rekiq::Configuration.new }
 
-      it 'sets shift as 0 by default' do
-        expect(@configuration.shift).to eq(0)
+      it 'sets work_time_shift as 0 by default' do
+        expect(@configuration.work_time_shift).to eq(0)
       end
 
       it 'sets schedule_post_work as false by default' do
         expect(@configuration.schedule_post_work).to eq(false)
       end
 
-      it 'sets expiration_margin as 0 by default' do
-        expect(@configuration.expiration_margin).to eq(0)
+      it 'sets work_time_tolerance as 0 by default' do
+        expect(@configuration.work_time_tolerance).to eq(0)
       end
 
       it 'sets schedule_expired as false by default' do
@@ -24,8 +24,8 @@ describe Rekiq::Configuration do
   end
 
   describe '#validate!' do
-    context 'for instance with non numeric shift' do
-      before { @configuration = build(:configuration, shift: [1]) }
+    context 'for instance with non numeric work_time_shift' do
+      before { @configuration = build(:configuration, work_time_shift: [1]) }
 
       it 'raises error' do
         expect do
@@ -34,7 +34,7 @@ describe Rekiq::Configuration do
       end
     end
 
-    context 'for instance with numeric shift' do
+    context 'for instance with numeric work_time_shift' do
       before { @configuration = build(:configuration) }
 
       it 'does not raise error' do
@@ -66,8 +66,8 @@ describe Rekiq::Configuration do
       end
     end
 
-    context 'for instance with non numeric expiration_margin' do
-      before { @configuration = build(:configuration, expiration_margin: '1') }
+    context 'for instance with non numeric work_time_tolerance' do
+      before { @configuration = build(:configuration, work_time_tolerance: '1') }
 
       it 'raises error' do
         expect do
@@ -76,8 +76,8 @@ describe Rekiq::Configuration do
       end
     end
 
-    context 'for instance with negative expiration_margin' do
-      before { @configuration = build(:configuration, expiration_margin: -1) }
+    context 'for instance with negative work_time_tolerance' do
+      before { @configuration = build(:configuration, work_time_tolerance: -1) }
 
       it 'raises error' do
         expect do
@@ -86,7 +86,7 @@ describe Rekiq::Configuration do
       end
     end
 
-    context 'for instance with 0 or positive expiration_margin' do
+    context 'for instance with 0 or positive work_time_tolerance' do
       before { @configuration = build(:configuration) }
 
       it 'does not raise error' do