schked 0.3.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d63d5c90dcb6ba4e576ebd9ac7f07d8f8169473836bd38d656a69d550e08c304
-  data.tar.gz: b33124e9bd3125d1cf93d418c165e275d6ab89d727938313fdb7b492cd35861e
+  metadata.gz: 49298780af4e1af7294623211a41bf0e0bbe2fa3238ac28d24074a8ce7102b36
+  data.tar.gz: 5320ec84af3ba28e82627f28c68ef3278542ab1e37191b48d7feaf65cdaef354
 SHA512:
-  metadata.gz: 83dd4020439f63a22f1cf3226b538a408adb5b444df1bb6e9def70d07f56d18c6084dfc58d5d3c7f226e3edeb61192d825ff556a5f56c8996195331bfee82670
-  data.tar.gz: 002453deb8896a3c248148cd904fac48910118c3cee0b1e2485ad0b98db39ea36550d623501e4eaa51d52c3f3150ada08915fe385ea99509f34bc7f4a7d98928
+  metadata.gz: 4efb829f41f8c13b94bf509b1b89688294142c61ada430d929a4a48322ee1be0d094a6492709348796b36aaf0479f3038c4db77402f169dcfa1e4343d5f31b30
+  data.tar.gz: a3d24f54e91d2dc3c470749ebbd37e21d3a804befd00f46c43e32f6a85885f70c1cdd1bf052fa928497c619da1921e700c20b312f2088e2eeffdd618adbac370

data/README.md

@@ -3,7 +3,7 @@
 
 # Schked
 
-Framework agnostic Rufus-scheduler wrapper to run recurring jobs.
+Framework agnostic [Rufus-scheduler](https://github.com/jmettraux/rufus-scheduler) wrapper to run recurring jobs.
 
 <a href="https://evilmartians.com/?utm_source=schked">
 <img src="https://evilmartians.com/badges/sponsored-by-evil-martians.svg" alt="Sponsored by Evil Martians" width="236" height="54"></a>
@@ -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

@@ -4,7 +4,9 @@ require "logger"
 
 module Schked
   class Config
-    attr_writer :logger
+    attr_writer :logger,
+      :do_not_load_root_schedule,
+      :redis_servers
 
     def paths
       @paths ||= []
@@ -18,6 +20,10 @@ module Schked
       @logger ||= Logger.new($stdout).tap { |l| l.level = Logger::INFO }
     end
 
+    def do_not_load_root_schedule?
+      !!@do_not_load_root_schedule
+    end
+
     def register_callback(name, &block)
       callbacks[name] << block
     end
@@ -28,6 +34,10 @@ module Schked
       end
     end
 
+    def redis_servers
+      @redis_servers ||= [ENV["REDIS_URL"]]
+    end
+
     private
 
     def callbacks

data/lib/schked/railtie.rb

@@ -6,7 +6,10 @@ module Schked
   class Railtie < Rails::Railtie
     class PathsConfig
       def self.call(app)
-        if (root_schedule = app.root.join("config", "schedule.rb")).exist?
+        return if Schked.config.do_not_load_root_schedule?
+
+        root_schedule = app.root.join("config", "schedule.rb")
+        if root_schedule.exist?
           path = root_schedule.to_s
           Schked.config.paths << path unless Schked.config.paths.include?(path)
         end

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.3.3"
+  VERSION = "1.0.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)
+      @scheduler = Rufus::Scheduler.new(trigger_lock: locker)
 
+      watch_signals
       define_callbacks
+      define_extend_lock
       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.3.3
+  version: 1.0.0
 platform: ruby
 authors:
 - Misha Merkushin
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-07-09 00:00:00.000000000 Z
+date: 2022-10-10 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
@@ -173,7 +188,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.32
 signing_key:
 specification_version: 4
 summary: Ruby Scheduler