mini_scheduler 0.10.0 → 0.12.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 61de19d47b5090c36a179869a01800506ee364629db64f47df963426c1d9a8b6
-  data.tar.gz: faa1b86a2d625fa570b26dd8ad8a2ccdb15fcd6029f1d93ad67ddefb0301342a
+  metadata.gz: def18630479a6ca0133f7131ba4aa59c779f66bd7d979c84e43d90b9c7303927
+  data.tar.gz: 0bb8b699e224d2e3b47f9237fc9e9c68d71c6bb4c1ae82e67d55b7c442276997
 SHA512:
-  metadata.gz: 931ae1731d9c1b49b3c861ec5b401d317e436f9548494c6fc9cd7b242c5d9bd932459bdf5598f9e7ca24abe8c46d585a43d75cac8a2772f7a04bc77fcf6ad27d
-  data.tar.gz: 82ef45be2249b8c5d6834aeeb13f3f72e4b23604436a68246bba46350ad49255d0f9adf6ac262f685c189d9fc6670c8247776ab3b2d4eaf1f9b7e55b87a63515
+  metadata.gz: 9ebcc59b92f99824c503682fd33fc4ca11dfa47920ad7fb2b74d2c123534104e0cb3fcc44c1848c2ddac91a80f187a5800dff4536f245e0eac07ad6db01bb0c7
+  data.tar.gz: 06074fb819bdce384abee949ddb27b81361a2a42823a8c1a4c25b8e3f5b8854557f7222ed791fa0b4b343aa1467e97eb8eaac98a4c03ae98330a0245bc8cc09f

data/CHANGELOG.md

@@ -1,8 +1,29 @@
-# 0.9.2 - 26-04-2019
+# 0.12.3 - 2020-10-15
+
+- Fixes a problem where scheduler didn't recover from Redis flush
+
+# 0.12.2 - 2019-09-11
+
+- Allow sorting schedule history by schedule name
+
+# 0.12.1 - 2019-08-30
+
+- Jobs that change family from per host to non per host can cause a tight loop
+
+# 0.12.0 - 2019-08-29
+
+- Add support for multiple workers which allows avoiding queue starvation
+
+# 0.11.0 - 2019-06-24
+
+- Correct situation where distributed mutex could end in a tight loop when
+ redis could not be contacted
+
+# 0.9.2 - 2019-04-26
 
 - Correct UI so it displays durations that are longer than a minute
 
-# 0.9.1 - 21-01-2019
+# 0.9.1 - 2019-01-21
 
 - Remove dependency on ActiveSupport and add proper dependency for Sidekiq
 - Remove Discourse specific bits from Sidekiq web scheduler tab.

data/Gemfile

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 source 'https://rubygems.org'
 
 git_source(:github) { 'https://github.com/discourse/mini_scheduler' }

data/Guardfile

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # A sample Guardfile
 # More info at https://github.com/guard/guard#readme
 

data/README.md

@@ -1,4 +1,4 @@
-[![Build Status](https://travis-ci.org/discourse/mini_scheduler.svg?branch=master)](https://travis-ci.org/discourse/mini_scheduler)
+[![Build Status](https://github.com/discourse/mini_scheduler/workflows/CI/badge.svg)](https://github.com/discourse/mini_scheduler/actions)
 [![Gem Version](https://badge.fury.io/rb/mini_scheduler.svg)](https://rubygems.org/gems/mini_scheduler)
 
 # mini_scheduler
@@ -30,6 +30,20 @@ In a Rails application, create files needed in your application to configure min
 
 An initializer is created named `config/initializers/mini_scheduler.rb` which lists all the configuration options.
 
+## Configuring MiniScheduler
+
+By default each instance of MiniScheduler will run with a single worker. To amend this behavior:
+
+```
+if Sidekiq.server? && defined?(Rails)
+  Rails.application.config.after_initialize do
+    MiniScheduler.start(workers: 5)
+  end
+end
+```
+
+This is useful for cases where you have extremely long running tasks that you would prefer did not starve.
+
 ## Usage
 
 Create jobs with a recurring schedule like this:

data/Rakefile

@@ -1,6 +1,19 @@
-require "bundler/gem_tasks"
+#!/usr/bin/env rake
+# frozen_string_literal: true
+
 require "rspec/core/rake_task"
+require 'bundler'
+
+begin
+  Bundler.setup :default, :development
+  Bundler::GemHelper.install_tasks
+rescue Bundler::BundlerError => error
+  $stderr.puts error.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit error.status_code
+end
 
 RSpec::Core::RakeTask.new(:spec)
 
-task default: :spec
+desc "Default: run tests"
+task default: [ :spec ]

data/app/models/mini_scheduler/stat.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 if defined?(ActiveRecord::Base)
   module MiniScheduler
     class Stat < ActiveRecord::Base

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails/generators'
 require 'rails/generators/migration'
 require 'active_record'

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class CreateMiniSchedulerStats < ActiveRecord::Migration[4.2]
   def change
     create_table :scheduler_stats do |t|

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 MiniScheduler.configure do |config|
   # An instance of Redis. See https://github.com/redis/redis-rb
 

data/lib/mini_scheduler.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "mini_scheduler/engine"
 require 'mini_scheduler/schedule'
 require 'mini_scheduler/schedule_info'
@@ -51,11 +52,11 @@ module MiniScheduler
     @skip_schedule
   end
 
-  def self.start
+  def self.start(workers: 1)
     schedules = Manager.discover_schedules
 
     Manager.discover_queues.each do |queue|
-      manager = Manager.new(queue: queue)
+      manager = Manager.new(queue: queue, workers: workers)
 
       schedules.each do |schedule|
         if schedule.queue == queue

data/lib/mini_scheduler/distributed_mutex.rb

@@ -1,5 +1,8 @@
+# frozen_string_literal: true
+
 module MiniScheduler
   class DistributedMutex
+    class Timeout < StandardError; end
 
     @default_redis = nil
 
@@ -18,11 +21,26 @@ module MiniScheduler
       @mutex = Mutex.new
     end
 
+    MAX_POLLING_ATTEMPTS ||= 60
+    BASE_SLEEP_DURATION ||= 0.001
+    MAX_SLEEP_DURATION ||= 1
+
     # NOTE wrapped in mutex to maintain its semantics
     def synchronize
       @mutex.lock
+
+      attempts = 0
+      sleep_duration = BASE_SLEEP_DURATION
       while !try_to_get_lock
-        sleep 0.001
+
+        sleep(sleep_duration)
+
+        if sleep_duration < MAX_SLEEP_DURATION
+          sleep_duration = [sleep_duration * 2, MAX_SLEEP_DURATION].min
+        end
+
+        attempts += 1
+        raise Timeout if attempts >= MAX_POLLING_ATTEMPTS
       end
 
       yield

data/lib/mini_scheduler/engine.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 if defined?(::Rails)
   module MiniScheduler
     class Engine < ::Rails::Engine

data/lib/mini_scheduler/manager.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 module MiniScheduler
   class Manager
-    attr_accessor :random_ratio, :redis, :enable_stats, :queue
+    attr_accessor :random_ratio, :redis, :enable_stats, :queue, :workers
 
     class Runner
       def initialize(manager)
@@ -8,11 +10,14 @@ module MiniScheduler
         @mutex = Mutex.new
         @queue = Queue.new
         @manager = manager
-        @reschedule_orphans_thread = Thread.new do
+        @hostname = manager.hostname
+
+        @recovery_thread = Thread.new do
           while !@stopped
             sleep 60
 
             @mutex.synchronize do
+              repair_queue
               reschedule_orphans
             end
           end
@@ -25,9 +30,12 @@ module MiniScheduler
             sleep (@manager.keep_alive_duration / 2)
           end
         end
-        @thread = Thread.new do
-          while !@stopped
-            process_queue
+        @threads = []
+        manager.workers.times do
+          @threads << Thread.new do
+            while !@stopped
+              process_queue
+            end
           end
         end
       end
@@ -38,6 +46,12 @@ module MiniScheduler
         MiniScheduler.handle_job_exception(ex, message: "Scheduling manager keep-alive")
       end
 
+      def repair_queue
+        @manager.repair_queue
+      rescue => ex
+        MiniScheduler.handle_job_exception(ex, message: "Scheduling manager queue repair")
+      end
+
       def reschedule_orphans
         @manager.reschedule_orphans!
       rescue => ex
@@ -45,20 +59,17 @@ module MiniScheduler
       end
 
       def hostname
-        @hostname ||= begin
-                        `hostname`
-                      rescue
-                        "unknown"
-                      end
+        @hostname
       end
 
       def process_queue
 
         klass = @queue.deq
-        return unless klass
-
         # hack alert, I need to both deq and set @running atomically.
         @running = true
+
+        return if !klass
+
         failed = false
         start = Time.now.to_f
         info = @mutex.synchronize { @manager.schedule_info(klass) }
@@ -118,19 +129,19 @@ module MiniScheduler
           @stopped = true
 
           @keep_alive_thread.kill
-          @reschedule_orphans_thread.kill
+          @recovery_thread.kill
 
           @keep_alive_thread.join
-          @reschedule_orphans_thread.join
+          @recovery_thread.join
 
           enq(nil)
 
           kill_thread = Thread.new do
             sleep 0.5
-            @thread.kill
+            @threads.each(&:kill)
           end
 
-          @thread.join
+          @threads.each(&:join)
           kill_thread.kill
           kill_thread.join
         end
@@ -145,7 +156,8 @@ module MiniScheduler
           sleep 0.001
         end
         # this is a hack, but is only used for test anyway
-        sleep 0.001
+        # if tests fail that depend on this we are forced to increase it.
+        sleep 0.010
         while @running
           sleep 0.001
         end
@@ -169,7 +181,7 @@ module MiniScheduler
 
     def initialize(options = nil)
       @queue = options && options[:queue] || "default"
-
+      @workers = options && options[:workers] || 1
       @redis = MiniScheduler.redis
       @random_ratio = 0.1
       unless options && options[:skip_runner]
@@ -192,7 +204,11 @@ module MiniScheduler
     end
 
     def hostname
-      @hostname ||= `hostname`.strip
+      @hostname ||= begin
+                      `hostname`.strip
+                    rescue
+                      "unknown"
+                    end
     end
 
     def schedule_info(klass)
@@ -243,6 +259,15 @@ module MiniScheduler
       nil
     end
 
+    def repair_queue
+      return if redis.exists?(self.class.queue_key(queue)) ||
+        redis.exists?(self.class.queue_key(queue, hostname))
+
+      self.class.discover_schedules
+        .select { |schedule| schedule.queue == queue }
+        .each { |schedule| ensure_schedule!(schedule) }
+    end
+
     def tick
       lock do
         schedule_next_job
@@ -256,11 +281,14 @@ module MiniScheduler
 
       if due.to_i <= Time.now.to_i
         klass = get_klass(key)
-        unless klass
+        if !klass || (
+          (klass.is_per_host && !hostname) || (hostname && !klass.is_per_host)
+        )
           # corrupt key, nuke it (renamed job or something)
           redis.zrem Manager.queue_key(queue, hostname), key
           return
         end
+
         info = schedule_info(klass)
         info.prev_run = Time.now.to_i
         info.prev_result = "QUEUED"

data/lib/mini_scheduler/schedule.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module MiniScheduler::Schedule
 
   def queue(value = nil)

data/lib/mini_scheduler/schedule_info.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module MiniScheduler
   class ScheduleInfo
     attr_accessor :next_run,

data/lib/mini_scheduler/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module MiniScheduler
-  VERSION = "0.10.0"
+  VERSION = "0.12.3"
 end

data/lib/mini_scheduler/views/history.erb

@@ -2,7 +2,20 @@
   <div class="col-sm-12">
     <h3>Scheduler History</h3>
   </div>
+
+  <div class="col-sm-12">
+    <form>
+      <select name="filter">
+        <option value="All" <%= "selected" if !@filter %>>All</option>
+        <% @schedules.each do |schedule| %>
+          <option value="<%=schedule%>" <%= "selected" if @filter == schedule.to_s%>><%=schedule%></option>
+        <% end %>
+      </select>
+      <input type="submit" value="Filter">
+    </form>
+  </div>
 </header>
+<br>
 
 <div class="container">
   <div class="row">

data/lib/mini_scheduler/views/scheduler.erb

@@ -39,7 +39,7 @@
             <td>
               <%= sane_duration @info.prev_duration %>
             </td>
-            <td>
+            <td style="word-wrap: break-word">
               <%= @info.current_owner %>
             </td>
             <td>

data/lib/mini_scheduler/web.rb

@@ -1,8 +1,23 @@
+# frozen_string_literal: true
 # 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.find_schedules_by_time
+      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
+    end
+
     def self.registered(app)
 
       app.helpers do
@@ -23,23 +38,24 @@ module MiniScheduler
 
       app.get "/scheduler" do
         MiniScheduler.before_sidekiq_web_request&.call
-        @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
+        @schedules = Web.find_schedules_by_time
         erb File.read(File.join(VIEWS, 'scheduler.erb')), locals: { view_path: VIEWS }
       end
 
       app.get "/scheduler/history" do
         MiniScheduler.before_sidekiq_web_request&.call
-        @scheduler_stats = Stat.order('started_at desc').limit(200)
+        @schedules = Manager.discover_schedules
+        @schedules.sort_by!(&:to_s)
+        @scheduler_stats = Stat.order('started_at desc')
+
+        @filter = params[:filter]
+        names = @schedules.map(&:to_s)
+        @filter = nil if !names.include?(@filter)
+        if @filter
+          @scheduler_stats = @scheduler_stats.where(name: @filter)
+        end
+
+        @scheduler_stats = @scheduler_stats.limit(200)
         erb File.read(File.join(VIEWS, 'history.erb')), locals: { view_path: VIEWS }
       end
 

data/mini_scheduler.gemspec

@@ -15,11 +15,7 @@ Gem::Specification.new do |spec|
   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.files = `git ls-files`.split($/).reject { |s| s =~ /^(spec|\.)/ }
   spec.require_paths = ["lib"]
 
   spec.add_dependency "sidekiq"
@@ -32,4 +28,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "guard-rspec"
   spec.add_development_dependency "mock_redis"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency 'rubocop-discourse'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mini_scheduler
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.12.3
 platform: ruby
 authors:
 - Sam Saffron
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-23 00:00:00.000000000 Z
+date: 2020-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -137,6 +137,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-discourse
+  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
@@ -144,10 +158,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - Guardfile

data/.gitignore

@@ -1,13 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-Gemfile.lock
-.DS_Store
-*.swp
-
-.rubocop-https---raw-githubusercontent-com-discourse-discourse-master--rubocop-yml

data/.rspec

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

data/.rubocop.yml

@@ -1 +0,0 @@
-inherit_from: https://raw.githubusercontent.com/discourse/discourse/master/.rubocop.yml

data/.travis.yml

@@ -1,18 +0,0 @@
-language: ruby
-rvm:
-  - ruby-head
-  - 2.5
-  - 2.6
-
-before_install:
-  - gem install bundler
-
-cache: bundler
-sudo: false
-
-services:
-  - redis-server
-
-matrix:
-  allow_failures:
-    - rvm: ruby-head