schked 1.1.2 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fe971fe49c1279ffd4cbc39948faea2fb82fa58434aa90814e1c1cbe2ebd99e2
-  data.tar.gz: 2b8800aa8128347a42e1f7fe2d73930293baae1ff258d6f1ddd24f21dff297c4
+  metadata.gz: 3cb8172851d135726e8cf5ae569e378c4855de6b78466fc19786a81fcd08045a
+  data.tar.gz: 0d448a52410312f3b0c6132059bc43a6f4f147b242ad4f7bfb1a47742df07990
 SHA512:
-  metadata.gz: a8dcdca1dad927793b3c0f6356a1f6222a9e4081b20baca7df9391c93ea044f8f2f9bf7fa2db05c330616a0692597abbf8e2807a07d5c6f80bff0687bfd90911
-  data.tar.gz: 370cab83d6e000cbc0cb2c19be884738315434d3dd42d0bf718c1b094194231b77f8356d2782f6a7c773b98aa64f3eedc6de39f3a34206f8a3aa381645f5012e
+  metadata.gz: 89be3ba061cc48c06024ca0f1697dc74d2dd383e5e1c73dbe14ffeb3d781862004341d45643db09081a7997c753912e3fb7e3af1d8fb778a9a768582302af3ab
+  data.tar.gz: 430bdb484f6962a1e41efeef2b47112614f98356cfe6d4e68eabb0f871c566bbca368e0f19e438383c680184740c32087f50757bdf31f0a7440506ae97c71287

data/README.md

@@ -79,7 +79,7 @@ When you deploy your schedule to production, you want to start new instance befo
 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"]
+Schked.config.redis = {url: ENV.fetch("REDIS_URL") }
 ```
 
 ### Callbacks
@@ -94,7 +94,19 @@ Schked.config.register_callback(:on_error) do |job, error|
 end
 ```
 
-There are `:before_start` and `:after_finish` callbacks as well.
+There are `:before_start`, `:after_finish` and `:around_job` callbacks as well.
+
+Warning: `:before_start` and `:after_finish` callbacks are executed in the scheduler thread, not in the work threads (the threads where the job execution really happens).
+
+`:around_job` callback is executed in the job's thread.
+
+```ruby
+Schked.config.register_callback(:around_job) do |job, &block|
+  ...
+  block.call
+  ...
+end
+```
 
 ### Logging
 

data/lib/schked/config.rb

@@ -6,7 +6,7 @@ module Schked
   class Config
     attr_writer :logger,
       :do_not_load_root_schedule,
-      :redis_servers,
+      :redis,
       :standalone
 
     def paths
@@ -35,8 +35,36 @@ module Schked
       end
     end
 
-    def redis_servers
-      @redis_servers ||= [ENV.fetch("REDIS_URL", "redis://127.0.0.1:6379")]
+    def fire_around_callback(name, job, calls = callbacks[name], &block)
+      return yield if calls.none?
+
+      calls.first.call(job) do
+        calls = calls.drop(1)
+        if calls.any?
+          fire_around_callback(name, job, calls, &block)
+        else
+          yield
+        end
+      end
+    end
+
+    def redis
+      @redis ||= {url: ENV.fetch("REDIS_URL", "redis://127.0.0.1:6379")}
+    end
+
+    def redis_servers=(val)
+      val = val.first
+
+      if val.is_a?(String)
+        self.redis = {url: val}
+      elsif val.respond_to?(:_client)
+        conf = val._client.config
+        self.redis = {url: conf.server_url, username: conf.username, password: conf.password}
+      else
+        raise ArgumentError, "Schked `redis_servers=` config option is deprecated. Please use `redis=` with a Hash"
+      end
+
+      warn "🔥 Schked `redis_servers=` config option is deprecated. Please use `redis=` with a Hash. Called from #{caller(1..1).first}"
     end
 
     def standalone?

data/lib/schked/redis_client_factory.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "redis-client"
+
+module Schked
+  module RedisClientFactory
+    def self.build(options)
+      unless options.key?(:reconnect_attempts)
+        options[:reconnect_attempts] = 3
+      end
+
+      if options.key?(:sentinels)
+        if (url = options.delete(:url))
+          uri = URI.parse(url)
+          if !options.key?(:name) && uri.host
+            options[:name] = uri.host
+          end
+
+          if !options.key?(:password) && uri.password && !uri.password.empty?
+            options[:password] = uri.password
+          end
+
+          if !options.key?(:username) && uri.user && !uri.user.empty?
+            options[:username] = uri.user
+          end
+        end
+
+        RedisClient.sentinel(**options).new_client
+      else
+        RedisClient.config(**options).new_client
+      end
+    end
+  end
+end

data/lib/schked/redis_locker.rb

@@ -10,8 +10,8 @@ module Schked
     LOCK_KEY = "schked:redis_locker"
     LOCK_TTL = 60_000 # ms
 
-    def initialize(redis_servers, lock_ttl: LOCK_TTL, logger: Logger.new($stdout))
-      @lock_manager = Redlock::Client.new(redis_servers, retry_count: 0)
+    def initialize(redis_conf, lock_ttl: LOCK_TTL, logger: Logger.new($stdout))
+      @lock_manager = Redlock::Client.new([redis_client(redis_conf)], retry_count: 0)
       @lock_ttl = lock_ttl
       @logger = logger
     end
@@ -49,6 +49,14 @@ module Schked
 
     private
 
+    def redis_client(redis_conf)
+      if Gem::Version.new(Redlock::VERSION) >= Gem::Version.new("2.0.0")
+        ConnectionPool::Wrapper.new { RedisClientFactory.build(redis_conf) }
+      else
+        ConnectionPool::Wrapper.new { Redis.new(**redis_conf) }
+      end
+    end
+
     def try_lock
       @lock_id = lock_manager.lock(LOCK_KEY, lock_ttl)
     end

data/lib/schked/version.rb

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

data/lib/schked/worker.rb

@@ -7,7 +7,8 @@ module Schked
     def initialize(config:)
       @config = config
 
-      @locker = RedisLocker.new(config.redis_servers, lock_ttl: 40_000, logger: config.logger) unless config.standalone?
+      @locker = RedisLocker.new(config.redis, lock_ttl: 40_000, logger: config.logger) unless config.standalone?
+
       @scheduler = Rufus::Scheduler.new(trigger_lock: locker)
 
       watch_signals
@@ -67,6 +68,10 @@ module Schked
         cfg.fire_callback(:before_start, job, time)
       end
 
+      scheduler.define_singleton_method(:around_trigger) do |job, &block|
+        cfg.fire_around_callback(:around_job, job, &block)
+      end
+
       scheduler.define_singleton_method(:on_post_trigger) do |job, time|
         cfg.logger.info("Finished task: #{extract_job_name(job)}")
 

data/lib/schked.rb

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

metadata

@@ -1,29 +1,49 @@
 --- !ruby/object:Gem::Specification
 name: schked
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.3.0
 platform: ruby
 authors:
 - Misha Merkushin
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-12-16 00:00:00.000000000 Z
+date: 2023-09-06 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: connection_pool
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: redlock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rufus-scheduler
   requirement: !ruby/object:Gem::Requirement
@@ -95,33 +115,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
-  name: pry-byebug
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.9'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.9'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: redis-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '0.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '0.10'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -165,6 +185,7 @@ files:
 - lib/schked/cli.rb
 - lib/schked/config.rb
 - lib/schked/railtie.rb
+- lib/schked/redis_client_factory.rb
 - lib/schked/redis_locker.rb
 - lib/schked/version.rb
 - lib/schked/worker.rb
@@ -179,9 +200,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="