sidekiq-scheduler-multihost 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c36082185e806939a9d43c695771a65377bdc9b0
+  data.tar.gz: bcfa74e8d3b3b140159f7056a1d0d4dee9407370
+SHA512:
+  metadata.gz: 61f88407c9d3bbe9259fe5faf48e3d1de3aa21acc5ca205bbf9c7fa5c80834ac72da2b96d10d3eebe3361154e7d288d4623d51c2e4df035ec54404772d9286f8
+  data.tar.gz: 2592768691658b4cac49b1f95e2866e9aa18d92ca7e6b0483f0037ee128dcaefdec19678d467ee704984cce22f162f7803fbff3bfbad2d4b69b26a760d5cc845

data/.gitignore

@@ -0,0 +1,37 @@
+*.gem
+*.rbc
+.DS_Store
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,59 @@
+PATH
+  remote: .
+  specs:
+    sidekiq-scheduler-multihost (0.1.0)
+      rufus-scheduler
+      sidekiq
+      sidekiq-scheduler
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.0)
+    concurrent-ruby (1.0.1)
+    connection_pool (2.2.0)
+    diff-lcs (1.2.5)
+    method_source (0.8.2)
+    multi_json (1.11.2)
+    pry (0.9.12.6)
+      coderay (~> 1.0)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rake (10.4.2)
+    redis (3.3.0)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.8)
+    rspec-expectations (2.14.5)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.6)
+    rufus-scheduler (3.1.10)
+    sidekiq (4.1.1)
+      concurrent-ruby (~> 1.0)
+      connection_pool (~> 2.2, >= 2.2.0)
+      redis (~> 3.2, >= 3.2.1)
+    sidekiq-scheduler (2.0.6)
+      multi_json (~> 1)
+      redis (~> 3)
+      rufus-scheduler (~> 3.1.8)
+      sidekiq (>= 3)
+      tilt (>= 1.4.0)
+    slop (3.6.0)
+    tilt (2.0.2)
+    timecop (0.6.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.10)
+  pry
+  rake (~> 10.0)
+  rspec
+  sidekiq-scheduler-multihost!
+  timecop
+
+BUNDLED WITH
+   1.11.2

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 Womply
+
+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,53 @@
+# Sidekiq::Scheduler::Multihost
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/sidekiq/scheduler/multihost`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sidekiq-scheduler-multihost', require: sidekiq_scheduler_multihost
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sidekiq-scheduler-multihost
+
+## Usage
+
+This gem is intended to be a plug-and-play solution for running sidekiq-scheduler in a multi-host environment. It relies on Sidekiq's Redis instance for storing a heartbeat, rufus-scheduler (a depedency of sidekiq-scheduler) for the actual heartbeating, and Sidekiq for running a task called Defibrillator which will cause another host to take over if the current scheduler goes down.
+
+Just include the gem and it will set up the heartbeat, place a defibrillator job in the queue, and start sidekiq-scheduler. You will still need to load the schedule yourself, with an initializer that does something like:
+
+```ruby
+config.on(:startup) do
+  Sidekiq.schedule = YAML.load_file(File.expand_path("../../scheduler.yml",__FILE__))
+end
+```
+
+See the sidekiq-scheduler and sidekiq docs for more information.
+
+## Known Issues
+
+  * There could be a race condition, if multiple hosts write the exact same heartbeat timestamp at the exact same time. It's not likely as the resolution is pretty high but it could happen.
+
+  * There's not currently a way to configure the heartbeat frequency.
+
+  * When the host that is running the schedule dies, no schedule will be run for a period of time up to two heartbeats. Heartbeats happen every 30 seconds currently.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Womply/sidekiq-scheduler-multihost.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sidekiq_scheduler_multihost"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/sidekiq_scheduler_multihost.rb

@@ -0,0 +1,19 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'rufus-scheduler'
+require 'sidekiq'
+require 'sidekiq/api'
+require 'sidekiq-scheduler'
+require "sidekiq_scheduler_multihost/version"
+require "sidekiq_scheduler_multihost/heartbeat"
+require "sidekiq_scheduler_multihost/workers/defibrillator"
+
+Sidekiq.configure_server do |config|
+  config.on(:startup) do
+    SidekiqSchedulerMultihost::Heartbeat.start
+  end
+
+  config.on(:shutdown) do
+    SidekiqSchedulerMultihost::Heartbeat.stop
+  end
+end

data/lib/sidekiq_scheduler_multihost/heartbeat.rb

@@ -0,0 +1,91 @@
+module SidekiqSchedulerMultihost
+  class Heartbeat
+    TIMEOUT = 60 #seconds
+    HEARTBEAT = TIMEOUT/2
+
+    CACHE_KEY = :sidekiq_scheduler_heartbeat_timestamp
+
+    @@timestamp = -1.0
+    @@rufus = Rufus::Scheduler.new
+
+    def start
+      if i_own_the_scheduler?
+        @@timestamp = set_timestamp! #update from heartbeat
+        # App.logger.debug "container ##{ENV['DOCKER_INSTANCE']}: scheduler is MINE!"
+        reset_failover_job!
+        schedule_heartbeat
+      elsif schedule_owner_exists? && timestamp_current?
+        # App.logger.debug "container ##{ENV['DOCKER_INSTANCE']}: scheduler is NOT mine!"
+        clear_schedules!
+      else
+        # App.logger.debug "container ##{ENV['DOCKER_INSTANCE']}: no owner found! I am taking over scheduling!"
+        take_over_scheduling!
+      end
+    end
+
+    def stop
+      clear_schedules!
+    end
+
+    private
+
+    def get_timestamp
+      Sidekiq.redis{|r| r.get CACHE_KEY}
+    end
+
+    def set_timestamp!
+      t = Time.now.to_f.to_s
+      Sidekiq.redis{|r| r.set CACHE_KEY, t}
+      t
+    end
+
+    def i_own_the_scheduler?
+      @@timestamp == get_timestamp
+    end
+
+    def schedule_owner_exists?
+      timestamp = Float(get_timestamp) rescue 0.0
+      !timestamp.nil? && timestamp != 0.0
+    end
+
+    def timestamp_current?
+      timestamp = get_timestamp
+      # App.logger.debug "container ##{ENV['DOCKER_INSTANCE']}: timestamp is #{timestamp}, current is #{Time.now.to_f}!"
+      (Time.now.to_f - Float(timestamp)) < TIMEOUT
+    end
+
+    def take_over_scheduling!
+      @@timestamp = set_timestamp!
+      # App.logger.debug "container ##{ENV['DOCKER_INSTANCE']}: timestamp set to #{@@timestamp}"
+      sleep(rand 0.99) # sleep for a random amount of time, under a second
+      if i_own_the_scheduler? #if not, no problem... someone else has it
+        confirm_takeover!
+      else
+        # App.logger.debug "container ##{ENV['DOCKER_INSTANCE']}: someone else took over scheduling. My timestamp is #{@@timestamp}, and I found #{get_timestamp}"
+      end
+    end
+
+    def confirm_takeover!
+      # App.logger.debug "container ##{ENV['DOCKER_INSTANCE']}: I took over scheduling!"
+      # App.logger.warn "A container has taken over the scheduler!"
+      Sidekiq::Scheduler.enabled = true
+      Sidekiq::Scheduler.reload_schedule!
+      reset_failover_job!
+      schedule_heartbeat
+    end
+
+    def reset_failover_job!
+      SidekiqSchedulerMultihost::Workers::Defibrillator.clear_jobs!
+      SidekiqSchedulerMultihost::Workers::Defibrillator.perform_in(TIMEOUT)
+    end
+
+    def clear_schedules!
+      Sidekiq::Scheduler.enabled = false
+      Sidekiq::Scheduler.clear_schedule! # in case we owned it previously and someone came in after
+    end
+
+    def schedule_heartbeat
+      @@rufus.in("#{HEARTBEAT}s"){self.class.new.start}
+    end
+  end
+end

data/lib/sidekiq_scheduler_multihost/version.rb

@@ -0,0 +1,3 @@
+module SidekiqSchedulerMultihost
+  VERSION = "0.1.0"
+end

data/lib/sidekiq_scheduler_multihost/workers/defibrillator.rb

@@ -0,0 +1,18 @@
+module SidekiqSchedulerMultihost
+  module Workers
+    class Defibrillator
+      include Sidekiq::Worker
+      sidekiq_options :queue => :defibrillator
+
+      def perform
+        SidekiqSchedulerMultihost::Heartbeat.new.start
+      end
+
+      def self.clear_jobs!
+        Sidekiq::ScheduledSet.new.each do |scheduled_job|
+          scheduled_job.delete if scheduled_job.klass == 'SidekiqSchedulerMultihost::Workers::Defibrillator'
+        end
+      end
+    end
+  end
+end

data/sidekiq-scheduler-multihost.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sidekiq_scheduler_multihost/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sidekiq-scheduler-multihost"
+  spec.version       = SidekiqSchedulerMultihost::VERSION
+  spec.authors       = ["Bill Abney"]
+  spec.email         = ["babney@womply.com"]
+
+  spec.summary       = 'Allows multiple hosts to handle sidekiq scheduler'
+  spec.homepage      = "https://github.com/OtoAnalytics/sidekiq-scheduler-multihost"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "timecop"
+
+  spec.add_dependency 'sidekiq'
+  spec.add_dependency 'sidekiq-scheduler'
+  spec.add_dependency 'rufus-scheduler'
+end

metadata

@@ -0,0 +1,171 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq-scheduler-multihost
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Bill Abney
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-04-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  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'
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sidekiq-scheduler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rufus-scheduler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- babney@womply.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sidekiq_scheduler_multihost.rb
+- lib/sidekiq_scheduler_multihost/heartbeat.rb
+- lib/sidekiq_scheduler_multihost/version.rb
+- lib/sidekiq_scheduler_multihost/workers/defibrillator.rb
+- sidekiq-scheduler-multihost.gemspec
+homepage: https://github.com/OtoAnalytics/sidekiq-scheduler-multihost
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+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.4.3
+signing_key: 
+specification_version: 4
+summary: Allows multiple hosts to handle sidekiq scheduler
+test_files: []
+has_rdoc: