sidekiq-dejavu 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: db1fce872db7e71c8d3fa6b819efd20a2c82ec1e
+  data.tar.gz: d777847b463d571f05dacfc66d37802fa804f9d4
+SHA512:
+  metadata.gz: 41ef48ae1fdee04195a2cf5d3456b9d0825ebe5c084a8f6f8eb7595e522dad1a531aec15ae5ee0894fe23bf9dd03cc0bcc720cc43e8aa9bde174e7c516285707
+  data.tar.gz: cf5bcf503c9199f5721ec7e3539d9c77d91a61d1a90a71ca91ed4f51131de62b834a7d07cfb3d8d556b2fb3e8d09605fc878ce46315e41d2b4821d20a55fa322

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sidekiq-dejavu.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Felix Buenemann
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,78 @@
+# Sidekiq::Dejavu
+
+Dejavu is a clockless scheduler that uses Sidekiq's built-in scheduling.
+
+Most scheduling solutions for Sidekiq require either a separate cron like process
+or run an internal clock thread inside sidekiq server to manage schedules.
+
+Dejavu uses Sidekiq's internal scheduling, like `Sidekiq::Worker.perform_in`
+and `Sidekiq::Worker.perform_at` so it doesn't need its own clock process/thread
+and integrates nicely with Sidekiq without duplicating any functionality.
+
+Scheduled jobs can be controlled through the Scheduled page in the Sidekiq::Web UI.
+
+## Note
+
+This is **ALPHA** quality code and doesn't yet have any specs, so make sure you test it well.
+Requires Sidekiq 3.0 or later. Compatibility with older versions could probably be added.
+
+## Known Bugs
+
+- Incompatible with sidekiq-unique-jobs (jobs don't get scheduled)
+- It's currently possible to have multiple workers from the same schedule running in parallel
+and all re-scheduling themselves. This is because jobs get re-scheduled if there is no existing
+schedule with the same name, but only the scheduled jobs queue is inspected.
+Depending on the intervals used it is possible that the job gets scheduled and run again before
+the other jobs can see the scheduled job, so they get re-scheduled as well.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sidekiq-dejavu'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sidekiq-dejavu
+
+## Usage
+
+You can configure schedule tasks in your config/sidekiq.yml:
+
+    :schedule:
+      hello_world:
+        interval: 10
+        class: HelloWorldWorker
+        queue: hello
+        retry: false
+        backtrace: false
+        args:
+          - Hello
+          - World
+      cleanup:
+        interval: '30 5 * * *' # every day at 5:30
+        class: HelloWorldWorker
+        queue: hello
+        retry: false
+        backtrace: false
+        args:
+          - Hello
+          - World
+
+Interval can be specified in seconds or as a cron expression, including vixie cron syntax.
+
+If a job fails or takes longer than an interval it will be retried at the next interval. In most cases you should set jour jobs to `retry: false` to keep Sidekiq's retries from competing with the scheduled jobs.
+
+You also need to set all options for the job, because currently a workers `sidekiq_options` are ignored. The minium required options for a schedule are `interval` and `class`. The same worker can be scheduled multiple times by using different schedule names (keys) in the config.
+
+## Contributing
+
+1. Fork it ( https://github.com/felixbuenemann/sidekiq-dejavu/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/sidekiq-dejavu.rb

@@ -0,0 +1,18 @@
+require "sidekiq/dejavu"
+
+Sidekiq.configure_server do |config|
+  config.server_middleware do |chain|
+    chain.add Sidekiq::Dejavu::Middleware::Server::Scheduler
+  end
+
+  config.on(:startup) do
+    schedules = config.options.fetch(:schedule, {})
+    Sidekiq.logger.debug "Sidekiq::Dejavu: schedules: #{schedules.inspect}"
+    if schedules.empty?
+      Sidekiq.logger.warn "Sidekiq::Dejavu: No schedule found."
+    else
+      Sidekiq.logger.info "Sidekiq::Dejavu: Loading schedules #{schedules.keys.join ','}."
+      Sidekiq::Dejavu::Manager.new(schedules).reload_schedule!
+    end
+  end
+end

data/lib/sidekiq/dejavu.rb

@@ -0,0 +1,4 @@
+require 'sidekiq/dejavu/version'
+require 'sidekiq/dejavu/helper'
+require 'sidekiq/dejavu/manager'
+require 'sidekiq/dejavu/middleware/server/scheduler'

data/lib/sidekiq/dejavu/helper.rb

@@ -0,0 +1,19 @@
+require 'parse-cron'
+
+module Sidekiq
+  module Dejavu
+    module Helper
+      def next_timestamp(interval, time = Time.now)
+        CronParser.new(interval).next(time).to_f
+      rescue ArgumentError
+        time.to_f + interval.to_f
+      end
+
+      def next_randomized_timestamp(interval, time = Time.now)
+        CronParser.new(interval).next(time).to_f
+      rescue ArgumentError
+        time.to_f + Random.rand(interval.to_f)
+      end
+    end
+  end
+end

data/lib/sidekiq/dejavu/manager.rb

@@ -0,0 +1,53 @@
+module Sidekiq
+  module Dejavu
+    class Manager
+      include Helper
+
+      attr_reader :schedules
+
+      def initialize(schedules)
+        @schedules = schedules
+      end
+
+      def reload_schedule!
+        clear_changed_schedules
+        add_new_schedules
+      end
+
+      private
+
+      def clear_changed_schedules
+        scheduled_jobs.each do |job|
+          item = job.item
+          name = item['schedule']
+          schedule_options = schedules[name]
+          schedule_options['args'] = Array(schedule_options['args'])
+          item_options = item.select { |k,v| schedule_options.keys.include? k }
+
+          if item_options != schedule_options
+            Sidekiq.logger.info "Clearing schedule #{name} (config changed)."
+            job.delete
+          else
+            schedules.delete(name)
+          end
+        end
+      end
+
+      def add_new_schedules
+        schedules.each do |name, options|
+          args = Array(options['args'])
+          interval = options['interval']
+          first_run = next_randomized_timestamp(interval)
+          job = options.merge('args' => args, 'schedule' => name, 'at' => first_run)
+
+          Sidekiq.logger.info "Scheduling #{name} for first run at #{Time.at first_run}."
+          Sidekiq::Client.push(job)
+        end
+      end
+
+      def scheduled_jobs
+        Sidekiq::ScheduledSet.new.select { |job| schedules.keys.include? job.item['schedule'] }
+      end
+    end
+  end
+end

data/lib/sidekiq/dejavu/middleware/server/scheduler.rb

@@ -0,0 +1,50 @@
+module Sidekiq
+  module Dejavu
+    module Middleware
+      module Server
+        class Scheduler
+          include Helper
+
+          attr_reader :schedules, :options
+
+          def initialize(options = {})
+            # Sidekiq.logger.info "Intialized #{self.class} with options #{options.inspect}"
+            @schedules = Sidekiq::ScheduledSet.new
+            @options = options
+          end
+
+          def call(worker, item, queue)
+            start = Time.now
+            interval = item['interval']
+            schedule = item['schedule']
+
+            yield
+
+          ensure
+            if interval && not_already_scheduled?(schedule)
+              time = relative_to_start? ? start : Time.now
+              schedule_next_run(worker, item, interval, time)
+            end
+          end
+
+          private
+
+          def not_already_scheduled?(schedule)
+            !!schedule && schedules.select{ |job| job.item['schedule'] == schedule }.empty?
+          end
+
+          def schedule_next_run(worker, item, interval, from_time)
+            timestamp = next_timestamp(interval, from_time)
+            Sidekiq.logger.info "Scheduling #{worker.class} for #{Time.at timestamp}"
+            item['at'] = timestamp
+            worker.class.client_push(item)
+          end
+
+          def relative_to_start?
+            !!options[:relative]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sidekiq/dejavu/version.rb

@@ -0,0 +1,5 @@
+module Sidekiq
+  module Dejavu
+    VERSION = "0.0.1"
+  end
+end

data/sidekiq-dejavu.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sidekiq/dejavu/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sidekiq-dejavu"
+  spec.version       = Sidekiq::Dejavu::VERSION
+  spec.authors       = ["Felix Buenemann"]
+  spec.email         = ["buenemann@louis.info"]
+  spec.summary       = %q{Dejavu is a clockless scheduler that uses Sidekiq's built-in scheduling}
+  spec.description   = %q{Dejavu uses Sidkiq's internal scheduling so it doesn't need its own clock and integrates nicely with Sidekiq's native scheduled jobs.}
+  spec.homepage      = "https://github.com/felixbuenemann/sidekiq-dejavu"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "sidekiq", "~> 3.0"
+  spec.add_dependency "parse-cron", "~> 0.1.4"
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq-dejavu
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Felix Buenemann
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: parse-cron
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.4
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Dejavu uses Sidkiq's internal scheduling so it doesn't need its own clock
+  and integrates nicely with Sidekiq's native scheduled jobs.
+email:
+- buenemann@louis.info
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sidekiq-dejavu.rb
+- lib/sidekiq/dejavu.rb
+- lib/sidekiq/dejavu/helper.rb
+- lib/sidekiq/dejavu/manager.rb
+- lib/sidekiq/dejavu/middleware/server/scheduler.rb
+- lib/sidekiq/dejavu/version.rb
+- sidekiq-dejavu.gemspec
+homepage: https://github.com/felixbuenemann/sidekiq-dejavu
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Dejavu is a clockless scheduler that uses Sidekiq's built-in scheduling
+test_files: []