schked 0.4.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8543c91732ed3147359b2b6c5c8ebef8ddb2f467766a8c143072ac403341647
-  data.tar.gz: d85da0ba7c7f001d9682c9423a59bb35a8ff4c3581583fbf1ed31cc11650c866
+  metadata.gz: 660370465a4ff279d9bc26184108c07637d0fcd69f071e22e8dea9b5b79b29ae
+  data.tar.gz: 9e54efb1455b8e48af9d67011008cb821aefe6bb691ec0325f1f0a9c8425ed10
 SHA512:
-  metadata.gz: 4e87e77de1530b23d680660806edafba03eb191c72da03d8b37b2b0a3845916ce700924e9d51806a20fbba58d8c1c9403e2a9c8d7c33103ab0eb4ceeaa76cdd1
-  data.tar.gz: 4408c7dfb6b03b73018d2d80cd005e52b6ddfc28635fd6eca972c670f17add271e2e89501452220dec116d48c529cb4d5f43761cc7416ddd6a247a3444ee713d
+  metadata.gz: f0ee5ac189460a35c87da4c6a889482f824985abd5561f5541e01157b6574e7d28957b9082cab272fc2cce04e779850ced784858e91da02554b3816a37483fee
+  data.tar.gz: 68754d88a2fcc870c6e161d951b2ff2a00749d0c345401e9608c69cfde4055554f1275157b1e7af7c3a2f07efff037eb690619834daa3d289293ef33c27be6ac

data/README.md

@@ -41,7 +41,7 @@ gem install schked
 config/schedule.rb
 
 ```ruby
-cron "*/30 * * * *", as: "CleanOrphanAttachmentsJob" do
+cron "*/30 * * * *", as: "CleanOrphanAttachmentsJob", timeout: "60s", overlap: false do
   CleanOrphanAttachmentsJob.perform_later
 end
 ```
@@ -72,6 +72,16 @@ To show schedule:
 bundle exec schked show
 ```
 
+### Duplicate scheduling
+
+When you deploy your schedule to production, you want to start new instance before you shut down the current. And you don't want simultaneous working of both. To achieve a seamless transition, Schked is using Redis for locks.
+
+You can configure Redis client as the following:
+
+```ruby
+Schked.config.redis_servers = ["redis://127.0.0.1:7777", "redis://127.0.0.1:7778", "redis://127.0.0.1:7779"]
+```
+
 ### Callbacks
 
 Also, you can define callbacks for errors handling:

data/lib/schked/cli.rb

@@ -45,9 +45,7 @@ module Schked
     private
 
     def load_requires
-      if options[:require]&.any?
-        options[:require].each { |file| load(File.join(Dir.pwd, file)) }
-      end
+      options[:require].each { |file| load(File.join(Dir.pwd, file)) } if options[:require]&.any?
 
       # We have to load Schked at here, because of Rails and our railtie.
       require "schked"

data/lib/schked/config.rb

@@ -5,7 +5,9 @@ require "logger"
 module Schked
   class Config
     attr_writer :logger,
-      :do_not_load_root_schedule
+      :do_not_load_root_schedule,
+      :redis_servers,
+      :standalone
 
     def paths
       @paths ||= []
@@ -33,6 +35,16 @@ module Schked
       end
     end
 
+    def redis_servers
+      @redis_servers ||= [ENV.fetch("REDIS_URL", "redis://127.0.0.1:6379")]
+    end
+
+    def standalone?
+      @standalone = ENV["RAILS_ENV"] == "test" || ENV["RACK_ENV"] == "test" if @standalone.nil?
+
+      !!@standalone
+    end
+
     private
 
     def callbacks

data/lib/schked/redis_locker.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Schked
+  class RedisLocker
+    attr_reader :lock_manager,
+      :lock_id,
+      :lock_ttl
+
+    LOCK_KEY = "schked:redis_locker"
+    LOCK_TTL = 60_000 # ms
+
+    def initialize(redis_servers, lock_ttl: LOCK_TTL)
+      @lock_manager = Redlock::Client.new(redis_servers, retry_count: 0)
+      @lock_ttl = lock_ttl
+    end
+
+    def lock
+      valid_lock? || !!try_lock
+    end
+
+    def unlock
+      lock_manager.unlock(lock_id) if valid_lock?
+    end
+
+    def extend_lock
+      return false unless valid_lock?
+
+      @lock_id = lock_manager.lock(LOCK_KEY, lock_ttl, extend: lock_id, extend_only_if_locked: true)
+
+      !!@lock_id
+    end
+
+    def valid_lock?
+      return false unless lock_id
+
+      lock_manager.valid_lock?(lock_id)
+    end
+
+    private
+
+    def try_lock
+      @lock_id = lock_manager.lock(LOCK_KEY, lock_ttl)
+    end
+  end
+end

data/lib/schked/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Schked
-  VERSION = "0.4.0"
+  VERSION = "1.1.0"
 end

data/lib/schked/worker.rb

@@ -7,9 +7,12 @@ module Schked
     def initialize(config:)
       @config = config
 
-      @scheduler = Rufus::Scheduler.new
+      @locker = RedisLocker.new(config.redis_servers, lock_ttl: 40_000) unless config.standalone?
+      @scheduler = Rufus::Scheduler.new(trigger_lock: locker)
 
+      watch_signals
       define_callbacks
+      define_extend_lock unless config.standalone?
       load_schedule
     end
 
@@ -38,7 +41,7 @@ module Schked
 
     private
 
-    attr_reader :config, :scheduler
+    attr_reader :config, :scheduler, :locker
 
     def define_callbacks
       cfg = config
@@ -63,6 +66,31 @@ module Schked
       end
     end
 
+    def watch_signals
+      Signal.trap("TERM") do
+        config.logger.info("Going to shut down...")
+        @shutdown = true
+      end
+
+      Signal.trap("INT") do
+        config.logger.info("Going to shut down...")
+        @shutdown = true
+      end
+
+      Thread.new do
+        loop do
+          scheduler.shutdown(wait: 5) if @shutdown
+          sleep 0.2
+        end
+      end
+    end
+
+    def define_extend_lock
+      scheduler.every("10s", as: "Schked::Worker#extend_lock", timeout: "5s", overlap: false) do
+        locker.extend_lock
+      end
+    end
+
     def load_schedule
       scheduler.instance_eval(schedule)
     end

data/lib/schked.rb

@@ -1,8 +1,11 @@
 # frozen_string_literal: true
 
+require "redlock"
+
 require "schked/version"
 require "schked/config"
 require "schked/worker"
+require "schked/redis_locker"
 require "schked/railtie" if defined?(Rails)
 
 module Schked

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: schked
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Misha Merkushin
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-08-12 00:00:00.000000000 Z
+date: 2022-10-19 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: redlock
+  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
@@ -151,6 +165,7 @@ files:
 - lib/schked/cli.rb
 - lib/schked/config.rb
 - lib/schked/railtie.rb
+- lib/schked/redis_locker.rb
 - lib/schked/version.rb
 - lib/schked/worker.rb
 homepage: https://github.com/bibendi/schked