schked 1.1.1 → 1.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 47adc31caf1ee8f69ba27c7b3e0a6e8f476d80186bd63fbfa8a4aa3cbb413852
4
- data.tar.gz: 17d5c4f8845c2c5e4a8556506dd39b5940b06e74a56b796c4d81a9e17c7c00fe
3
+ metadata.gz: b3a998f39285529b65c224e884f0ddf35c60cf14c27aadf76898424286d1b339
4
+ data.tar.gz: 2d9b8d5af4b547c9829030d74b66252cc22326db47073faffa230c992ab4427a
5
5
  SHA512:
6
- metadata.gz: b94ce175fb4bdb168e69a7dd660fc293fb5706363f525179fd70cc336fb9bb0e8f2d5e5c5727bbdca64428ca528be2d1b769b77ee3bf38e057bf6f12291fd165
7
- data.tar.gz: ec253428e530078ed21ce7edc77f49c9946ee2714ebb9b00671cbf87671f9cfe6c4a6ab5bfa0a9743671f016c8ad4e59b2fca80ad6e4c5a0be996ab2d66b97d3
6
+ metadata.gz: 1f7148205a8ca6f3f5ebfa971187544e447bb753c3d1214fe84dacd705e6c1046db3e523f7402a05a7c35325205feeefcbd47428f4a42ff036d8ac4dd8dfff2a
7
+ data.tar.gz: 5c3e8b3af739d7359cd9d5114171eabe7fef0b6fc3f02fcec6353ada371958e372ee8e46c3ae6939757a02a7c43497dbf642c33f1b01a6ff5ec6069c11b36130
data/README.md CHANGED
@@ -94,7 +94,19 @@ Schked.config.register_callback(:on_error) do |job, error|
94
94
  end
95
95
  ```
96
96
 
97
- There are `:before_start` and `:after_finish` callbacks as well.
97
+ There are `:before_start`, `:after_finish` and `:around_job` callbacks as well.
98
+
99
+ 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).
100
+
101
+ `:around_job` callback is executed in the job's thread.
102
+
103
+ ```ruby
104
+ Schked.config.register_callback(:around_job) do |job, &block|
105
+ ...
106
+ block.call
107
+ ...
108
+ end
109
+ ```
98
110
 
99
111
  ### Logging
100
112
 
data/lib/schked/config.rb CHANGED
@@ -35,6 +35,19 @@ module Schked
35
35
  end
36
36
  end
37
37
 
38
+ def fire_around_callback(name, job, calls = callbacks[name], &block)
39
+ return yield if calls.none?
40
+
41
+ calls.first.call(job) do
42
+ calls = calls.drop(1)
43
+ if calls.any?
44
+ fire_around_callback(name, job, calls, &block)
45
+ else
46
+ yield
47
+ end
48
+ end
49
+ end
50
+
38
51
  def redis_servers
39
52
  @redis_servers ||= [ENV.fetch("REDIS_URL", "redis://127.0.0.1:6379")]
40
53
  end
@@ -4,22 +4,30 @@ module Schked
4
4
  class RedisLocker
5
5
  attr_reader :lock_manager,
6
6
  :lock_id,
7
- :lock_ttl
7
+ :lock_ttl,
8
+ :logger
8
9
 
9
10
  LOCK_KEY = "schked:redis_locker"
10
11
  LOCK_TTL = 60_000 # ms
11
12
 
12
- def initialize(redis_servers, lock_ttl: LOCK_TTL)
13
+ def initialize(redis_servers, lock_ttl: LOCK_TTL, logger: Logger.new($stdout))
13
14
  @lock_manager = Redlock::Client.new(redis_servers, retry_count: 0)
14
15
  @lock_ttl = lock_ttl
16
+ @logger = logger
15
17
  end
16
18
 
17
19
  def lock
18
20
  valid_lock? || !!try_lock
21
+ rescue => e
22
+ logger.error("Failed to acquire a lock with error: #{e.message}")
23
+ false
19
24
  end
20
25
 
21
26
  def unlock
22
27
  lock_manager.unlock(lock_id) if valid_lock?
28
+ rescue => e
29
+ logger.error("Failed to release the lock with error: #{e.message}")
30
+ false
23
31
  end
24
32
 
25
33
  def extend_lock
@@ -28,6 +36,9 @@ module Schked
28
36
  @lock_id = lock_manager.lock(LOCK_KEY, lock_ttl, extend: lock_id, extend_only_if_locked: true)
29
37
 
30
38
  !!@lock_id
39
+ rescue => e
40
+ logger.error("Failed to extend the lock with error: #{e.message}")
41
+ false
31
42
  end
32
43
 
33
44
  def valid_lock?
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Schked
4
- VERSION = "1.1.1"
4
+ VERSION = "1.2.0"
5
5
  end
data/lib/schked/worker.rb CHANGED
@@ -7,7 +7,7 @@ module Schked
7
7
  def initialize(config:)
8
8
  @config = config
9
9
 
10
- @locker = RedisLocker.new(config.redis_servers, lock_ttl: 40_000) unless config.standalone?
10
+ @locker = RedisLocker.new(config.redis_servers, lock_ttl: 40_000, logger: config.logger) unless config.standalone?
11
11
  @scheduler = Rufus::Scheduler.new(trigger_lock: locker)
12
12
 
13
13
  watch_signals
@@ -46,26 +46,33 @@ module Schked
46
46
  def define_callbacks
47
47
  cfg = config
48
48
 
49
- scheduler.define_singleton_method(:on_error) do |job, error|
50
- name = if job
49
+ scheduler.define_singleton_method(:extract_job_name) do |job|
50
+ if job
51
51
  job.opts[:as] || job.job_id
52
52
  else
53
53
  "unknown"
54
54
  end
55
- cfg.logger.fatal("Task #{name} failed with error: #{error.message}")
55
+ end
56
+
57
+ scheduler.define_singleton_method(:on_error) do |job, error|
58
+ cfg.logger.fatal("Task #{extract_job_name(job)} failed with error: #{error.message}")
56
59
  cfg.logger.error(error.backtrace.join("\n")) if error.backtrace
57
60
 
58
61
  cfg.fire_callback(:on_error, job, error)
59
62
  end
60
63
 
61
64
  scheduler.define_singleton_method(:on_pre_trigger) do |job, time|
62
- cfg.logger.info("Started task: #{job.opts[:as] || job.job_id}")
65
+ cfg.logger.info("Started task: #{extract_job_name(job)}")
63
66
 
64
67
  cfg.fire_callback(:before_start, job, time)
65
68
  end
66
69
 
70
+ scheduler.define_singleton_method(:around_trigger) do |job, &block|
71
+ cfg.fire_around_callback(:around_job, job, &block)
72
+ end
73
+
67
74
  scheduler.define_singleton_method(:on_post_trigger) do |job, time|
68
- cfg.logger.info("Finished task: #{job.opts[:as] || job.job_id}")
75
+ cfg.logger.info("Finished task: #{extract_job_name(job)}")
69
76
 
70
77
  cfg.fire_callback(:after_finish, job, time)
71
78
  end
@@ -85,7 +92,7 @@ module Schked
85
92
  Thread.new do
86
93
  loop do
87
94
  scheduler.shutdown(wait: 5) if @shutdown
88
- sleep 0.2
95
+ sleep 1
89
96
  end
90
97
  end
91
98
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: schked
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.1.1
4
+ version: 1.2.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Misha Merkushin
8
8
  autorequire:
9
9
  bindir: exe
10
10
  cert_chain: []
11
- date: 2022-11-15 00:00:00.000000000 Z
11
+ date: 2023-06-09 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: redlock
@@ -122,6 +122,20 @@ dependencies:
122
122
  - - "~>"
123
123
  - !ruby/object:Gem::Version
124
124
  version: '13.0'
125
+ - !ruby/object:Gem::Dependency
126
+ name: redis
127
+ requirement: !ruby/object:Gem::Requirement
128
+ requirements:
129
+ - - "~>"
130
+ - !ruby/object:Gem::Version
131
+ version: '5.0'
132
+ type: :development
133
+ prerelease: false
134
+ version_requirements: !ruby/object:Gem::Requirement
135
+ requirements:
136
+ - - "~>"
137
+ - !ruby/object:Gem::Version
138
+ version: '5.0'
125
139
  - !ruby/object:Gem::Dependency
126
140
  name: rspec
127
141
  requirement: !ruby/object:Gem::Requirement