mini_scheduler 0.14.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 319678529749db26d855d097741f1ff271bb3f19e87276eb764ede430f831d0e
-  data.tar.gz: e01a47b807bb03ee1f2f97a36f55d95663cb9a79b5cb87bb6fef64c45969c961
+  metadata.gz: 6effd43f3f7ffcc5de91250409615a35ff593b5ac09e8d27be1cea78b26e990d
+  data.tar.gz: 6c3a1c9ddff976b3f250457c0da6322d61e75f811979ec3a8137b7276dcffb87
 SHA512:
-  metadata.gz: 581b32d6f15869169797af99f68c3ffc4c137e54404b77a2f62948d8e448e822821fa24a56571d66355c96e16d2e38e321995b2b9f606e01caaeeec8aa8bc74a
-  data.tar.gz: 81467c469e97e95510dff3749d3efeedd7eb58344bb7ff30357979c05b8398fc9a75f282f8a8a60f0f8241861edafbcf4a85ff1091557f44236cc19d6fba5a01
+  metadata.gz: 04b7f4b88b7e09a0a28af0046de1a34a1028313394a13abb7bdf2430020105cc44f999a725097e614eed4b16e4b30f51c847680ea55e9b9bc4f0e0cec81954e4
+  data.tar.gz: 496f8835eb262feb13c5c771a277431fd6a2aa11debbd74d7d18786a3a758b9b8d668e120f3d58f042b9fd86d5303317ba5fb4c281ac4463d362888557a8be45

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# 0.15.0 - 2022-11-17
+
+- Fix data inconsistencies when Redis fails during jobs (#19)
+- Update minimum Ruby version to 2.7
+
 # 0.14.0 - 2022-06-20
 
 - Fix compatibility with Sidekiq 6.5 (#15)

data/Gemfile

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

data/README.md

@@ -69,6 +69,15 @@ Options for schedules:
 
 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.
 
+To enable this view in Sidekiq, add `require "mini_scheduler/web"` to `routes.rb`:
+ 
+ ```ruby
+require "sidekiq/web"
+require "mini_scheduler/web"
+Rails.application.routes.draw do
+  ...
+  
+```
 ## How to reach us
 
 If you have questions about using mini_scheduler or found a problem, you can find us at https://meta.discourse.org.

data/Rakefile

@@ -14,6 +14,7 @@ rescue Bundler::BundlerError => error
 end
 
 RSpec::Core::RakeTask.new(:spec)
+task test: :spec
 
 desc "Default: run tests"
 task default: [ :spec ]

data/lib/mini_scheduler/manager.rb

@@ -19,6 +19,7 @@ module MiniScheduler
             @mutex.synchronize do
               repair_queue
               reschedule_orphans
+              ensure_worker_threads
             end
           end
         end
@@ -30,40 +31,67 @@ module MiniScheduler
             sleep (@manager.keep_alive_duration / 2)
           end
         end
-        @threads = []
-        manager.workers.times do
-          @threads << Thread.new do
-            while !@stopped
-              process_queue
-            end
-          end
-        end
+        ensure_worker_threads
       end
 
-      def keep_alive
-        @manager.keep_alive
+      def keep_alive(*ids)
+        @manager.keep_alive(*ids)
       rescue => ex
-        MiniScheduler.handle_job_exception(ex, message: "Scheduling manager keep-alive")
+        MiniScheduler.handle_job_exception(ex, message: "Error during MiniScheduler keep)alive")
       end
 
       def repair_queue
         @manager.repair_queue
       rescue => ex
-        MiniScheduler.handle_job_exception(ex, message: "Scheduling manager queue repair")
+        MiniScheduler.handle_job_exception(ex, message: "Error during MiniScheduler repair_queue")
       end
 
       def reschedule_orphans
         @manager.reschedule_orphans!
       rescue => ex
-        MiniScheduler.handle_job_exception(ex, message: "Scheduling manager orphan rescheduler")
+        MiniScheduler.handle_job_exception(ex, message: "Error during MiniScheduler reschedule_orphans")
+      end
+
+      def ensure_worker_threads
+        @threads ||= []
+        @threads.delete_if { |t| !t.alive? }
+        (@manager.workers - @threads.size).times do
+          @threads << Thread.new { worker_loop }
+        end
+      rescue => ex
+        MiniScheduler.handle_job_exception(ex, message: "Error during MiniScheduler ensure_worker_threads")
+      end
+
+      def worker_loop
+        set_current_worker_thread_id!
+        keep_alive(current_worker_thread_id)
+        while !@stopped
+          begin
+            process_queue
+          rescue => ex
+            MiniScheduler.handle_job_exception(ex, message: "Error during MiniScheduler worker_loop")
+            break # Data could be in a bad state - stop the thread
+          end
+        end
       end
 
       def hostname
         @hostname
       end
 
-      def process_queue
+      def current_worker_thread_id
+        Thread.current[:mini_scheduler_worker_thread_id]
+      end
+
+      def set_current_worker_thread_id!
+        Thread.current[:mini_scheduler_worker_thread_id] = "#{@manager.identity_key}:thread_#{SecureRandom.alphanumeric(10)}"
+      end
 
+      def worker_thread_ids
+        @threads.filter(&:alive?).filter_map { |t| t[:mini_scheduler_worker_thread_id] }
+      end
+
+      def process_queue
         klass = @queue.deq
         # hack alert, I need to both deq and set @running atomically.
         @running = true
@@ -78,6 +106,7 @@ module MiniScheduler
 
         begin
           info.prev_result = "RUNNING"
+          info.current_owner = current_worker_thread_id
           @mutex.synchronize { info.write! }
 
           if @manager.enable_stats
@@ -92,7 +121,7 @@ module MiniScheduler
 
           klass.new.perform
         rescue => e
-          MiniScheduler.handle_job_exception(e, message: "Running a scheduled job", job: { "class" => klass })
+          MiniScheduler.handle_job_exception(e, message: "Error while running a scheduled job", job: { "class" => klass })
 
           error = "#{e.class}: #{e.message} #{e.backtrace.join("\n")}"
           failed = true
@@ -113,8 +142,6 @@ module MiniScheduler
         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)
@@ -163,14 +190,16 @@ module MiniScheduler
         end
       end
 
-      def attempts(n)
-        n.times {
-          begin
-            yield; break
-          rescue
-            sleep Random.rand
-          end
-        }
+      def attempts(max_attempts)
+        attempt = 0
+        begin
+          yield
+        rescue
+          attempt += 1
+          raise if attempt >= max_attempts
+          sleep Random.rand
+          retry
+        end
       end
 
     end
@@ -314,8 +343,11 @@ module MiniScheduler
       60
     end
 
-    def keep_alive
-      redis.setex identity_key, keep_alive_duration, ""
+    def keep_alive(*ids)
+      ids = [identity_key, *@runner.worker_thread_ids] if ids.size == 0
+      ids.each do |identity_key|
+        redis.setex identity_key, keep_alive_duration, ""
+      end
     end
 
     def lock
@@ -344,16 +376,20 @@ module MiniScheduler
       schedules
     end
 
-    @mutex = Mutex.new
+    @class_mutex = Mutex.new
     def self.seq
-      @mutex.synchronize do
+      @class_mutex.synchronize do
         @i ||= 0
         @i += 1
       end
     end
 
+    @@identity_key_mutex = Mutex.new
     def identity_key
-      @identity_key ||= "_scheduler_#{hostname}:#{Process.pid}:#{self.class.seq}:#{SecureRandom.hex}"
+      return @identity_key if @identity_key
+      @@identity_key_mutex.synchronize do
+        @identity_key ||= "_scheduler_#{hostname}:#{Process.pid}:#{self.class.seq}:#{SecureRandom.hex}"
+      end
     end
 
     def self.lock_key(queue)

data/lib/mini_scheduler/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MiniScheduler
-  VERSION = "0.14.0"
+  VERSION = "0.15.0"
 end

data/mini_scheduler.gemspec

@@ -15,18 +15,20 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://github.com/discourse/mini_scheduler"
   spec.license       = "MIT"
 
+  spec.required_ruby_version = ">= 2.7.0"
+
   spec.files = `git ls-files`.split($/).reject { |s| s =~ /^(spec|\.)/ }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "sidekiq", ">= 4.2.3"
+  spec.add_runtime_dependency "sidekiq", ">= 4.2.3", "< 7.0"
 
-  spec.add_development_dependency "pg", ">= 1.0"
-  spec.add_development_dependency "activesupport", ">= 5.2"
-  spec.add_development_dependency "rspec"
-  spec.add_development_dependency "mocha"
-  spec.add_development_dependency "guard"
-  spec.add_development_dependency "guard-rspec"
-  spec.add_development_dependency "mock_redis"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency 'rubocop-discourse'
+  spec.add_development_dependency "pg", "~> 1.0"
+  spec.add_development_dependency "activesupport", "~> 7.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "mocha", "~> 2.0"
+  spec.add_development_dependency "guard", "~> 2.0"
+  spec.add_development_dependency "guard-rspec", "~> 4.0"
+  spec.add_development_dependency "redis", "~> 4.0"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rubocop-discourse", "= 2.4.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mini_scheduler
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.15.0
 platform: ruby
 authors:
 - Sam Saffron
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-06-20 00:00:00.000000000 Z
+date: 2022-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -18,6 +18,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 4.2.3
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -25,132 +28,135 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 4.2.3
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '7.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
-  name: mock_redis
+  name: redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rubocop-discourse
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.4.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.4.1
 description: Adds recurring jobs for Sidekiq
 email:
 - neil.lalonde@discourse.org
@@ -190,7 +196,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="