mini_scheduler 0.8.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8f80dba7428c2a8aa9ab7993aaedc20623997a4710fe13856826361b23d3b2b7
+  data.tar.gz: 42eeeafbf3c3764883560f4fc38cfdf59cf9ea7eea30b95111582ff81b98a452
+SHA512:
+  metadata.gz: 195412471e37e96582ef2ee9b2ee0d7107f5d2113c918aacd4cf85fb9135d751ae189f8a32beca9bd9719cf0acb54c47a008527585eb48265be239cca54e4bb1
+  data.tar.gz: b5ee5701360abf05b16179200dcc56bcbc0bc9203edf2a8cd2038f527dd8dab0513f0563f381ebfbb601d550a0c365ab22ed8f8879434d98caaabf5f6cb1e6fa

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock
+.DS_Store
+*.swp

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper --color

data/.rubocop.yml

@@ -0,0 +1,113 @@
+AllCops:
+  TargetRubyVersion: 2.4
+  DisabledByDefault: true
+  Exclude:
+    - 'db/schema.rb'
+    - 'bundle/**/*'
+    - 'vendor/**/*'
+    - 'node_modules/**/*'
+    - 'public/**/*'
+
+# Prefer &&/|| over and/or.
+Style/AndOr:
+  Enabled: true
+
+# Do not use braces for hash literals when they are the last argument of a
+# method call.
+Style/BracesAroundHashParameters:
+  Enabled: true
+
+# Align `when` with `case`.
+Layout/CaseIndentation:
+  Enabled: true
+
+# Align comments with method definitions.
+Layout/CommentIndentation:
+  Enabled: true
+
+# No extra empty lines.
+Layout/EmptyLines:
+  Enabled: true
+
+# Use Ruby >= 1.9 syntax for hashes. Prefer { a: :b } over { :a => :b }.
+Style/HashSyntax:
+  Enabled: true
+
+# Two spaces, no tabs (for indentation).
+Layout/IndentationWidth:
+  Enabled: true
+
+Layout/SpaceAfterColon:
+  Enabled: true
+
+Layout/SpaceAfterComma:
+  Enabled: true
+
+Layout/SpaceAroundEqualsInParameterDefault:
+  Enabled: true
+
+Layout/SpaceAroundKeyword:
+  Enabled: true
+
+Layout/SpaceAroundOperators:
+  Enabled: true
+
+Layout/SpaceBeforeFirstArg:
+    Enabled: true
+
+# Defining a method with parameters needs parentheses.
+Style/MethodDefParentheses:
+  Enabled: true
+
+# Use `foo {}` not `foo{}`.
+Layout/SpaceBeforeBlockBraces:
+  Enabled: true
+
+# Use `foo { bar }` not `foo {bar}`.
+Layout/SpaceInsideBlockBraces:
+  Enabled: true
+
+# Use `{ a: 1 }` not `{a:1}`.
+Layout/SpaceInsideHashLiteralBraces:
+  Enabled: true
+
+Layout/SpaceInsideParens:
+  Enabled: true
+
+# Detect hard tabs, no hard tabs.
+Layout/Tab:
+  Enabled: true
+
+# Blank lines should not have any spaces.
+Layout/TrailingBlankLines:
+  Enabled: true
+
+# No trailing whitespace.
+Layout/TrailingWhitespace:
+  Enabled: true
+
+Lint/Debugger:
+  Enabled: true
+
+Lint/BlockAlignment:
+  Enabled: true
+
+# Align `end` with the matching keyword or starting expression except for
+# assignments, where it should be aligned with the LHS.
+Lint/EndAlignment:
+  Enabled: true
+  EnforcedStyleAlignWith: variable
+
+# Use my_method(my_arg) not my_method( my_arg ) or my_method my_arg.
+Lint/RequireParentheses:
+  Enabled: true
+
+Layout/MultilineMethodCallIndentation:
+  Enabled: true
+  EnforcedStyle: indented
+
+Layout/AlignHash:
+  Enabled: true
+
+Bundler/OrderedGems:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+git_source(:github) { 'https://github.com/discourse/mini_scheduler' }
+
+gemspec

data/README.md

@@ -0,0 +1,50 @@
+# mini_scheduler
+
+MiniScheduler adds recurring jobs to [Sidekiq](https://sidekiq.org/).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mini_scheduler'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mini_scheduler
+
+In a Rails application, create files needed in your application to configure mini_scheduler:
+
+    bin/rails g mini_scheduler:install
+    rake db:migrate
+
+An initializer is created named `config/initializers/mini_scheduler.rb` which lists all the configuration options.
+
+## Usage
+
+Create jobs with a recurring schedule like this:
+
+```ruby
+class MyHourlyJob
+  include Sidekiq::Worker
+  extend MiniScheduler::Schedule
+
+  every 1.hour
+
+  def execute(args)
+    # some tasks
+  end
+end
+```
+
+Options for schedules:
+
+* **every** followed by a duration in seconds, like "every 1.hour".
+* **daily at:** followed by a duration since midnight, like "daily at: 12.hours", to run only once per day at a specific time.
+
+To view the scheduled jobs, their history, and the schedule, go to sidekiq's web UI and look for the "Scheduler" tab at the top.

data/app/models/mini_scheduler/stat.rb

@@ -0,0 +1,10 @@
+module MiniScheduler
+  class Stat < ActiveRecord::Base
+
+    self.table_name = 'scheduler_stats'
+
+    def self.purge_old
+      where('started_at < ?', 1.months.ago).delete_all
+    end
+  end
+end

data/lib/generators/mini_scheduler/install/install_generator.rb

@@ -0,0 +1,25 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+module MiniScheduler
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      include Rails::Generators::Migration
+      source_root File.expand_path('../templates', __FILE__)
+      desc "Generate files for MiniScheduler"
+
+      def self.next_migration_number(path)
+        next_migration_number = current_migration_number(path) + 1
+        ActiveRecord::Migration.next_migration_number(next_migration_number)
+      end
+
+      def copy_migrations
+        migration_template("create_mini_scheduler_stats.rb", "db/migrate/create_mini_scheduler_stats.rb")
+      end
+
+      def copy_initializer_file
+        copy_file "mini_scheduler_initializer.rb", "config/initializers/mini_scheduler.rb"
+      end
+    end
+  end
+end

data/lib/generators/mini_scheduler/install/templates/create_mini_scheduler_stats.rb

@@ -0,0 +1,15 @@
+class CreateMiniSchedulerStats < ActiveRecord::Migration[4.2]
+  def change
+    create_table :scheduler_stats do |t|
+      t.string :name, null: false
+      t.string :hostname, null: false
+      t.integer :pid, null: false
+      t.integer :duration_ms
+      t.integer :live_slots_start
+      t.integer :live_slots_finish
+      t.datetime :started_at, null: false
+      t.boolean :success
+      t.text :error
+    end
+  end
+end

data/lib/generators/mini_scheduler/install/templates/mini_scheduler_initializer.rb

@@ -0,0 +1,31 @@
+MiniScheduler.configure do |config|
+  # An instance of Redis. See https://github.com/redis/redis-rb
+
+  # config.redis = $redis
+
+  # Define a custom exception handler when an exception is raised
+  # by a scheduled job. By default, SidekiqExceptionHandler is used.
+
+  # config.job_exception_handler do |ex, context|
+  #   ...
+  # end
+
+  # Add code to be called after a scheduled job runs. An argument
+  # with stats about the execution is passed, including these fields:
+  # name, hostname, pid, started_at, duration_ms, live_slots_start,
+  # live_slots_finish, success, error
+
+  # config.job_ran do |stats|
+  #   ...
+  # end
+end
+
+if Sidekiq.server? && defined?(Rails)
+  Rails.application.config.after_initialize do
+    scheduler_hostname = ENV["UNICORN_SCHEDULER_HOSTNAME"]
+
+    if !scheduler_hostname || scheduler_hostname.split(',').include?(`hostname`.strip)
+      MiniScheduler.start
+    end
+  end
+end

data/lib/mini_scheduler/distributed_mutex.rb

@@ -0,0 +1,61 @@
+module MiniScheduler
+  class DistributedMutex
+
+    @default_redis = nil
+
+    def self.redis=(redis)
+      @default_redis = redis
+    end
+
+    def self.synchronize(key, redis = nil, &blk)
+      self.new(key, redis || @default_redis).synchronize(&blk)
+    end
+
+    def initialize(key, redis)
+      raise ArgumentError.new('redis argument is nil') if redis.nil?
+      @key = key
+      @redis = redis
+      @mutex = Mutex.new
+    end
+
+    # NOTE wrapped in mutex to maintain its semantics
+    def synchronize
+      @mutex.lock
+      while !try_to_get_lock
+        sleep 0.001
+      end
+
+      yield
+
+    ensure
+      @redis.del @key
+      @mutex.unlock
+    end
+
+    private
+
+    def try_to_get_lock
+      got_lock = false
+      if @redis.setnx @key, Time.now.to_i + 60
+        @redis.expire @key, 60
+        got_lock = true
+      else
+        begin
+          @redis.watch @key
+          time = @redis.get @key
+          if time && time.to_i < Time.now.to_i
+            got_lock = @redis.multi do
+              @redis.set @key, Time.now.to_i + 60
+            end
+          end
+        ensure
+          @redis.unwatch
+        end
+      end
+
+      got_lock
+    end
+
+  end
+
+end

data/lib/mini_scheduler/engine.rb

@@ -0,0 +1,7 @@
+if defined?(::Rails)
+  module MiniScheduler
+    class Engine < ::Rails::Engine
+      isolate_namespace MiniScheduler
+    end
+  end
+end

data/lib/mini_scheduler/manager.rb

@@ -0,0 +1,348 @@
+module MiniScheduler
+  class Manager
+    attr_accessor :random_ratio, :redis, :enable_stats
+
+    class Runner
+      def initialize(manager)
+        @stopped = false
+        @mutex = Mutex.new
+        @queue = Queue.new
+        @manager = manager
+        @reschedule_orphans_thread = Thread.new do
+          while !@stopped
+            sleep 1.minute
+            @mutex.synchronize do
+              reschedule_orphans
+            end
+          end
+        end
+        @keep_alive_thread = Thread.new do
+          while !@stopped
+            @mutex.synchronize do
+              keep_alive
+            end
+            sleep (@manager.keep_alive_duration / 2)
+          end
+        end
+        @thread = Thread.new do
+          while !@stopped
+            process_queue
+          end
+        end
+      end
+
+      def keep_alive
+        @manager.keep_alive
+      rescue => ex
+        MiniScheduler.handle_job_exception(ex, message: "Scheduling manager keep-alive")
+      end
+
+      def reschedule_orphans
+        @manager.reschedule_orphans!
+      rescue => ex
+        MiniScheduler.handle_job_exception(ex, message: "Scheduling manager orphan rescheduler")
+      end
+
+      def hostname
+        @hostname ||= begin
+                        `hostname`
+                      rescue
+                        "unknown"
+                      end
+      end
+
+      def process_queue
+
+        klass = @queue.deq
+        return unless klass
+
+        # hack alert, I need to both deq and set @running atomically.
+        @running = true
+        failed = false
+        start = Time.now.to_f
+        info = @mutex.synchronize { @manager.schedule_info(klass) }
+        stat = nil
+        error = nil
+
+        begin
+          info.prev_result = "RUNNING"
+          @mutex.synchronize { info.write! }
+
+          if @manager.enable_stats
+            stat = MiniScheduler::Stat.create!(
+              name: klass.to_s,
+              hostname: hostname,
+              pid: Process.pid,
+              started_at: Time.now,
+              live_slots_start: GC.stat[:heap_live_slots]
+            )
+          end
+
+          klass.new.perform
+        rescue => e
+          MiniScheduler.handle_job_exception(e, message: "Running a scheduled job", job: klass)
+
+          error = "#{e.class}: #{e.message} #{e.backtrace.join("\n")}"
+          failed = true
+        end
+        duration = ((Time.now.to_f - start) * 1000).to_i
+        info.prev_duration = duration
+        info.prev_result = failed ? "FAILED" : "OK"
+        info.current_owner = nil
+        if stat
+          stat.update!(
+            duration_ms: duration,
+            live_slots_finish: GC.stat[:heap_live_slots],
+            success: !failed,
+            error: error
+          )
+          MiniScheduler.job_ran&.call(stat)
+        end
+        attempts(3) do
+          @mutex.synchronize { info.write! }
+        end
+      rescue => ex
+        MiniScheduler.handle_job_exception(ex, message: "Processing scheduled job queue")
+      ensure
+        @running = false
+        if defined?(ActiveRecord::Base)
+          ActiveRecord::Base.connection_handler.clear_active_connections!
+        end
+      end
+
+      def stop!
+        return if @stopped
+
+        @mutex.synchronize do
+          @stopped = true
+
+          @keep_alive_thread.kill
+          @reschedule_orphans_thread.kill
+
+          @keep_alive_thread.join
+          @reschedule_orphans_thread.join
+
+          enq(nil)
+
+          kill_thread = Thread.new do
+            sleep 0.5
+            @thread.kill
+          end
+
+          @thread.join
+          kill_thread.kill
+          kill_thread.join
+        end
+      end
+
+      def enq(klass)
+        @queue << klass
+      end
+
+      def wait_till_done
+        while !@queue.empty? && !(@queue.num_waiting > 0)
+          sleep 0.001
+        end
+        # this is a hack, but is only used for test anyway
+        sleep 0.001
+        while @running
+          sleep 0.001
+        end
+      end
+
+      def attempts(n)
+        n.times {
+          begin
+            yield; break
+          rescue
+            sleep Random.rand
+          end
+        }
+      end
+
+    end
+
+    def self.without_runner
+      self.new(skip_runner: true)
+    end
+
+    def initialize(options = nil)
+      @redis = MiniScheduler.redis
+      @random_ratio = 0.1
+      unless options && options[:skip_runner]
+        @runner = Runner.new(self)
+        self.class.current = self
+      end
+
+      @hostname = options && options[:hostname]
+      @manager_id = SecureRandom.hex
+
+      if options && options.key?(:enable_stats)
+        @enable_stats = options[:enable_stats]
+      else
+        @enable_stats = true # doesn't work !!defined?(MiniScheduler::Stat)
+      end
+    end
+
+    def self.current
+      @current
+    end
+
+    def self.current=(manager)
+      @current = manager
+    end
+
+    def hostname
+      @hostname ||= `hostname`.strip
+    end
+
+    def schedule_info(klass)
+      MiniScheduler::ScheduleInfo.new(klass, self)
+    end
+
+    def next_run(klass)
+      schedule_info(klass).next_run
+    end
+
+    def ensure_schedule!(klass)
+      lock do
+        schedule_info(klass).schedule!
+      end
+    end
+
+    def remove(klass)
+      lock do
+        schedule_info(klass).del!
+      end
+    end
+
+    def reschedule_orphans!
+      lock do
+        reschedule_orphans_on!
+        reschedule_orphans_on!(hostname)
+      end
+    end
+
+    def reschedule_orphans_on!(hostname = nil)
+      redis.zrange(Manager.queue_key(hostname), 0, -1).each do |key|
+        klass = get_klass(key)
+        next unless klass
+        info = schedule_info(klass)
+
+        if ['QUEUED', 'RUNNING'].include?(info.prev_result) &&
+          (info.current_owner.blank? || !redis.get(info.current_owner))
+          info.prev_result = 'ORPHAN'
+          info.next_run = Time.now.to_i
+          info.write!
+        end
+      end
+    end
+
+    def get_klass(name)
+      name.constantize
+    rescue NameError
+      nil
+    end
+
+    def tick
+      lock do
+        schedule_next_job
+        schedule_next_job(hostname)
+      end
+    end
+
+    def schedule_next_job(hostname = nil)
+      (key, due), _ = redis.zrange Manager.queue_key(hostname), 0, 0, withscores: true
+      return unless key
+
+      if due.to_i <= Time.now.to_i
+        klass = get_klass(key)
+        unless klass
+          # corrupt key, nuke it (renamed job or something)
+          redis.zrem Manager.queue_key(hostname), key
+          return
+        end
+        info = schedule_info(klass)
+        info.prev_run = Time.now.to_i
+        info.prev_result = "QUEUED"
+        info.prev_duration = -1
+        info.next_run = nil
+        info.current_owner = identity_key
+        info.schedule!
+        @runner.enq(klass)
+      end
+    end
+
+    def blocking_tick
+      tick
+      @runner.wait_till_done
+    end
+
+    def stop!
+      @runner.stop!
+      self.class.current = nil
+    end
+
+    def keep_alive_duration
+      60
+    end
+
+    def keep_alive
+      redis.setex identity_key, keep_alive_duration, ""
+    end
+
+    def lock
+      MiniScheduler::DistributedMutex.synchronize(Manager.lock_key, MiniScheduler.redis) do
+        yield
+      end
+    end
+
+    def self.discover_schedules
+      # hack for developemnt reloader is crazytown
+      # multiple classes with same name can be in
+      # object space
+      unique = Set.new
+      schedules = []
+      ObjectSpace.each_object(MiniScheduler::Schedule) do |schedule|
+        if schedule.scheduled?
+          next if unique.include?(schedule.to_s)
+          schedules << schedule
+          unique << schedule.to_s
+        end
+      end
+      schedules
+    end
+
+    @mutex = Mutex.new
+    def self.seq
+      @mutex.synchronize do
+        @i ||= 0
+        @i += 1
+      end
+    end
+
+    def identity_key
+      @identity_key ||= "_scheduler_#{hostname}:#{Process.pid}:#{self.class.seq}:#{SecureRandom.hex}"
+    end
+
+    def self.lock_key
+      "_scheduler_lock_"
+    end
+
+    def self.queue_key(hostname = nil)
+      if hostname
+        "_scheduler_queue_#{hostname}_"
+      else
+        "_scheduler_queue_"
+      end
+    end
+
+    def self.schedule_key(klass, hostname = nil)
+      if hostname
+        "_scheduler_#{klass}_#{hostname}"
+      else
+        "_scheduler_#{klass}"
+      end
+    end
+  end
+end

data/lib/mini_scheduler/schedule.rb

@@ -0,0 +1,37 @@
+module MiniScheduler::Schedule
+
+  def daily(options = nil)
+    if options
+      @daily = options
+    end
+    @daily
+  end
+
+  def every(duration = nil)
+    if duration
+      @every = duration
+      if manager = MiniScheduler::Manager.current
+        manager.ensure_schedule!(self)
+      end
+    end
+    @every
+  end
+
+  # schedule job independently on each host (looking at hostname)
+  def per_host
+    @per_host = true
+  end
+
+  def is_per_host
+    @per_host
+  end
+
+  def schedule_info
+    manager = MiniScheduler::Manager.without_runner
+    manager.schedule_info self
+  end
+
+  def scheduled?
+    !!@every || !!@daily
+  end
+end

data/lib/mini_scheduler/schedule_info.rb

@@ -0,0 +1,138 @@
+module MiniScheduler
+  class ScheduleInfo
+    attr_accessor :next_run,
+                  :prev_run,
+                  :prev_duration,
+                  :prev_result,
+                  :current_owner
+
+    def initialize(klass, manager)
+      @klass = klass
+      @manager = manager
+
+      data = nil
+
+      if data = @manager.redis.get(key)
+        data = JSON.parse(data)
+      end
+
+      if data
+        @next_run = data["next_run"]
+        @prev_run = data["prev_run"]
+        @prev_result = data["prev_result"]
+        @prev_duration = data["prev_duration"]
+        @current_owner = data["current_owner"]
+      end
+    rescue
+      # corrupt redis
+      @next_run = @prev_run = @prev_result = @prev_duration = @current_owner = nil
+    end
+
+    # this means the schedule is going to fire, it is setup correctly.
+    # invalid schedules are fixed by running "schedule!"
+    # this happens automatically after if fire by the manager.
+    def valid?
+      return false unless @next_run
+      (!@prev_run && @next_run < Time.now.to_i + 5.minutes) || valid_every? || valid_daily?
+    end
+
+    def valid_every?
+      return false unless @klass.every
+      !!@prev_run &&
+        @prev_run <= Time.now.to_i &&
+        @next_run < @prev_run + @klass.every * (1 + @manager.random_ratio)
+    end
+
+    def valid_daily?
+      return false unless @klass.daily
+      return true if !@prev_run && @next_run && @next_run <= (Time.now + 1.day).to_i
+      !!@prev_run &&
+        @prev_run <= Time.now.to_i &&
+        @next_run < @prev_run + 1.day
+    end
+
+    def schedule_every!
+      if !valid? && @prev_run
+        mixup = @klass.every * @manager.random_ratio
+        mixup = (mixup * Random.rand - mixup / 2).to_i
+        @next_run = @prev_run + mixup + @klass.every
+      end
+
+      if !valid?
+        @next_run = Time.now.to_i + 5.minutes * Random.rand
+      end
+    end
+
+    def schedule_daily!
+      return if valid?
+
+      at = @klass.daily[:at] || 0
+      today_begin = Time.now.midnight.to_i
+      today_offset = DateTime.now.seconds_since_midnight
+
+      # If it's later today
+      if at > today_offset
+        @next_run = today_begin + at
+      else
+        # Otherwise do it tomorrow
+        @next_run = today_begin + 1.day + at
+      end
+    end
+
+    def schedule!
+      if @klass.every
+        schedule_every!
+      elsif @klass.daily
+        schedule_daily!
+      end
+
+      write!
+    end
+
+    def write!
+
+      clear!
+      redis.set key, {
+        next_run: @next_run,
+        prev_run: @prev_run,
+        prev_duration: @prev_duration,
+        prev_result: @prev_result,
+        current_owner: @current_owner
+      }.to_json
+
+      redis.zadd queue_key, @next_run, @klass if @next_run
+    end
+
+    def del!
+      clear!
+      @next_run = @prev_run = @prev_result = @prev_duration = @current_owner = nil
+    end
+
+    def key
+      if @klass.is_per_host
+        Manager.schedule_key(@klass, @manager.hostname)
+      else
+        Manager.schedule_key(@klass)
+      end
+    end
+
+    def queue_key
+      if @klass.is_per_host
+        Manager.queue_key(@manager.hostname)
+      else
+        Manager.queue_key
+      end
+    end
+
+    def redis
+      @manager.redis
+    end
+
+    private
+    def clear!
+      redis.del key
+      redis.zrem queue_key, @klass
+    end
+
+  end
+end

data/lib/mini_scheduler/version.rb

@@ -0,0 +1,3 @@
+module MiniScheduler
+  VERSION = "0.8.0"
+end

data/lib/mini_scheduler/views/history.erb

@@ -0,0 +1,47 @@
+<header class="row">
+  <div class="col-sm-12">
+    <h3>Scheduler History</h3>
+  </div>
+</header>
+
+<div class="container">
+  <div class="row">
+    <div class="col-md-9">
+      <% if @scheduler_stats.length > 0 %>
+
+      <table class="table table-striped table-bordered table-white" style="width: 100%; margin: 0; table-layout:fixed;">
+        <thead>
+          <th style="width: 30%">Job Name</th>
+          <th style="width: 15%">Hostname:Pid</th>
+          <th style="width: 15%">Live Slots delta</th>
+          <th style="width: 15%">Started At</th>
+          <th style="width: 15%">Duration</th>
+          <th style="width: 15%"></th>
+        </thead>
+        <tbody>
+          <% @scheduler_stats.each do |stat| %>
+          <tr>
+            <td><%= stat.name %></td>
+            <td><%= stat.hostname %>:<%= stat.pid %></td>
+            <td>
+              <% if stat.live_slots_start && stat.live_slots_finish %>
+                <%= stat.live_slots_finish - stat.live_slots_start %>
+              <% end %>
+            </td>
+            <td><%= sane_time stat.started_at %></td>
+            <td><%= sane_duration stat.duration_ms %></td>
+            <td>
+              <% if stat.success.nil? %>
+                RUNNING
+              <% elsif !stat.success %>
+                FAILED
+              <% end %>
+            </td>
+          </tr>
+          <% end %>
+        </tbody>
+      </table>
+      <% end %>
+    </div>
+  </div>
+</div>

data/lib/mini_scheduler/views/scheduler.erb

@@ -0,0 +1,73 @@
+<header class="row">
+  <% if Sidekiq.respond_to?(:paused?) && Sidekiq.paused? %>
+    <div class="col-sm-12">
+      <div class="alert alert-danger text-center">
+        <h2>SIDEKIQ IS PAUSED!</h2>
+      </div>
+    </div>
+  <% end %>
+  <div class="col-sm-12">
+    <h3>Recurring Jobs <a style='font-size:50%; margin-left: 30px' href='scheduler/history'>history</a></h3>
+  </div>
+</header>
+
+<div class="container">
+  <div class="row">
+
+    <div class="col-md-9">
+      <% if @schedules.length > 0 %>
+      <table class="table table-striped table-bordered table-white" style="width: 100%; margin: 0; table-layout:fixed;">
+        <thead>
+          <th style="width: 30%">Worker</th>
+          <th style="width: 15%">Last Run</th>
+          <th style="width: 15%">Last Result</th>
+          <th style="width: 15%">Last Duration</th>
+          <th style="width: 15%">Last Owner</th>
+          <th style="width: 15%">Next Run Due</th>
+          <th style="width: 10%">Actions</th>
+        </thead>
+        <% @schedules.each do |schedule| %>
+        <% @info = schedule.schedule_info %>
+        <tr>
+          <td>
+            <%= schedule %>
+            <td>
+              <% prev = @info.prev_run %>
+              <% if prev.nil? %>
+              Never
+              <% else %>
+              <%= relative_time(Time.at(prev)) %>
+              <% end %>
+            </td>
+            <td>
+              <%= @info.prev_result %>
+            </td>
+            <td>
+              <%= sane_duration @info.prev_duration %>
+            </td>
+            <td>
+              <%= @info.current_owner %>
+            </td>
+            <td>
+              <% next_run = @info.next_run %>
+              <% if next_run.nil? %>
+              Not Scheduled Yet
+              <% else %>
+              <%= relative_time(Time.at(next_run)) %>
+              <% end %>
+            </td>
+            <td>
+              <form action="<%= "#{root_path}scheduler/#{schedule}/trigger" %>" method="post">
+                <%= csrf_tag if respond_to?(:csrf_tag) %>
+                <input class="btn btn-danger btn-small" type="submit" name="trigger" value="Trigger" data-confirm="Are you sure you want to trigger this job?" />
+              </form>
+            </td>
+        </tr>
+        <% end %>
+      </table>
+      <% else %>
+      <div class="alert alert-success">No recurring jobs found.</div>
+      <% end %>
+    </div>
+  </div>
+</div>

data/lib/mini_scheduler/web.rb

@@ -0,0 +1,60 @@
+# Based off sidetiq https://github.com/tobiassvn/sidetiq/blob/master/lib/sidetiq/web.rb
+module MiniScheduler
+  module Web
+    VIEWS = File.expand_path('views', File.dirname(__FILE__)) unless defined? VIEWS
+
+    def self.registered(app)
+
+      app.helpers do
+        def sane_time(time)
+          return unless time
+          time
+        end
+
+        def sane_duration(duration)
+          return unless duration
+          if duration < 1000
+            "#{duration}ms"
+          elsif duration < 60 * 1000
+            "#{'%.2f' % (duration / 1000.0)} secs"
+          end
+        end
+      end
+
+      app.get "/scheduler" do
+        @schedules = Manager.discover_schedules.sort do |a, b|
+          a_next = a.schedule_info.next_run
+          b_next = b.schedule_info.next_run
+          if a_next && b_next
+            a_next <=> b_next
+          elsif a_next
+            -1
+          else
+            1
+          end
+        end
+        erb File.read(File.join(VIEWS, 'scheduler.erb')), locals: { view_path: VIEWS }
+      end
+
+      app.get "/scheduler/history" do
+        @scheduler_stats = Stat.order('started_at desc').limit(200)
+        erb File.read(File.join(VIEWS, 'history.erb')), locals: { view_path: VIEWS }
+      end
+
+      app.post "/scheduler/:name/trigger" do
+        halt 404 unless (name = params[:name])
+
+        klass = name.constantize
+        info = klass.schedule_info
+        info.next_run = Time.now.to_i
+        info.write!
+
+        redirect "#{root_path}scheduler"
+      end
+
+    end
+  end
+end
+
+Sidekiq::Web.register(MiniScheduler::Web)
+Sidekiq::Web.tabs["Scheduler"] = "scheduler"

data/lib/mini_scheduler.rb

@@ -0,0 +1,63 @@
+require "mini_scheduler/engine"
+require 'mini_scheduler/schedule'
+require 'mini_scheduler/schedule_info'
+require 'mini_scheduler/manager'
+require 'mini_scheduler/distributed_mutex'
+
+require 'sidekiq/exception_handler'
+
+module MiniScheduler
+
+  def self.configure
+    yield self
+  end
+
+  class SidekiqExceptionHandler
+    extend Sidekiq::ExceptionHandler
+  end
+
+  def self.job_exception_handler(&blk)
+    @job_exception_handler = blk if blk
+    @job_exception_handler
+  end
+
+  def self.handle_job_exception(ex, context = {})
+    if job_exception_handler
+      job_exception_handler.call(ex, context)
+    else
+      SidekiqExceptionHandler.handle_exception(ex, context)
+    end
+  end
+
+  def self.redis=(r)
+    @redis = r
+  end
+
+  def self.redis
+    @redis
+  end
+
+  def self.job_ran(&blk)
+    @job_ran = blk if blk
+    @job_ran
+  end
+
+  def self.start
+    manager = Manager.new
+    Manager.discover_schedules.each do |schedule|
+      manager.ensure_schedule!(schedule)
+    end
+    Thread.new do
+      while true
+        begin
+          manager.tick
+        rescue => e
+          # the show must go on
+          handle_job_exception(e, message: "While ticking scheduling manager")
+        end
+        sleep 1
+      end
+    end
+  end
+
+end

data/mini_scheduler.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "mini_scheduler/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "mini_scheduler"
+  spec.version       = MiniScheduler::VERSION
+  spec.authors       = ["Sam Saffron", "Neil Lalonde"]
+  spec.email         = ["neil.lalonde@discourse.org"]
+
+  spec.summary       = %q{Adds recurring jobs for Sidekiq}
+  spec.description   = %q{Adds recurring jobs for Sidekiq}
+  spec.homepage      = "https://github.com/discourse/mini_scheduler"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "pg", "~> 1.0.0"
+  spec.add_development_dependency "guard", "~> 2.14"
+  spec.add_development_dependency "guard-minitest", "~> 2.4"
+  spec.add_development_dependency "activesupport", "~> 5.2"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "mocha"
+  spec.add_development_dependency "mock_redis"
+  spec.add_development_dependency "sidekiq"
+end

metadata

@@ -0,0 +1,219 @@
+--- !ruby/object:Gem::Specification
+name: mini_scheduler
+version: !ruby/object:Gem::Version
+  version: 0.8.0
+platform: ruby
+authors:
+- Sam Saffron
+- Neil Lalonde
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-07-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: guard-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !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: mocha
+  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: mock_redis
+  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: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Adds recurring jobs for Sidekiq
+email:
+- neil.lalonde@discourse.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- README.md
+- app/models/mini_scheduler/stat.rb
+- lib/generators/mini_scheduler/install/install_generator.rb
+- lib/generators/mini_scheduler/install/templates/create_mini_scheduler_stats.rb
+- lib/generators/mini_scheduler/install/templates/mini_scheduler_initializer.rb
+- lib/mini_scheduler.rb
+- lib/mini_scheduler/distributed_mutex.rb
+- lib/mini_scheduler/engine.rb
+- lib/mini_scheduler/manager.rb
+- lib/mini_scheduler/schedule.rb
+- lib/mini_scheduler/schedule_info.rb
+- lib/mini_scheduler/version.rb
+- lib/mini_scheduler/views/history.erb
+- lib/mini_scheduler/views/scheduler.erb
+- lib/mini_scheduler/web.rb
+- mini_scheduler.gemspec
+homepage: https://github.com/discourse/mini_scheduler
+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.7.7
+signing_key: 
+specification_version: 4
+summary: Adds recurring jobs for Sidekiq
+test_files: []