uncharted-scheduler 0.1.1

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 13ba89193b2308a7f209d7a244f546e441195900
4
+ data.tar.gz: 6d1e9b925ebe75fa018a51e5b2df99c14df4ec06
5
+ SHA512:
6
+ metadata.gz: ca2c328ede4a51b0e0a9fe4ed2beb56bbc6bf4ac55345015dc0296d7a4428586c1ce2ca843edbfa92f4bc69e54b29d1dceaa513bcd6efafddfcfd7008a122b8c
7
+ data.tar.gz: ea426629326cf6389cfb16ee78b62d752d49e086479066aaf3853693d717b885f7eb7f899864737d0b7c0295fc08faf23c0fcece55d24bd2a8d3c76381be0307
data/.gitignore ADDED
@@ -0,0 +1,9 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
data/.rspec ADDED
@@ -0,0 +1,2 @@
1
+ --format documentation
2
+ --color
data/.travis.yml ADDED
@@ -0,0 +1,4 @@
1
+ language: ruby
2
+ rvm:
3
+ - 2.1.5
4
+ before_install: gem install bundler -v 1.10.5
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in scheduler.gemspec
4
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2015 Sam Saffron, Nathan Palmer
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,55 @@
1
+ # Uncharted Scheduler
2
+
3
+ [![Build Status](https://travis-ci.org/unchartedcode/scheduler.svg?branch=master)](https://travis-ci.org/unchartedcode/scheduler)
4
+ [![Coverage Status](https://coveralls.io/repos/unchartedcode/scheduler/badge.svg?branch=master&service=github)](https://coveralls.io/github/unchartedcode/scheduler?branch=master)
5
+
6
+ Uncharted Scheduler allows for scheduling of recurring jobs with [Sidekiq](https://github.com/mperham/sidekiq). This library was extracted out of [Discourse](https://github.com/discourse/discourse).
7
+
8
+ ## Installation
9
+
10
+ Add this line to your application's Gemfile:
11
+
12
+ ```ruby
13
+ gem 'uncharted-scheduler',
14
+ git: 'https://github.com/unchartedcode/scheduler'
15
+ ```
16
+
17
+ And then execute:
18
+
19
+ $ bundle
20
+
21
+ ## Usage
22
+
23
+ Add this to the bottom fo your `sidekiq.rb` initializer.
24
+
25
+ ```ruby
26
+ require 'scheduler'
27
+ Scheduler::Clock.start!
28
+ ```
29
+
30
+ Then for each Sidekiq job that you want to schedule add
31
+
32
+ ```ruby
33
+ extend Scheduler::Schedule
34
+ ```
35
+
36
+ along with an interval for how often you want it to run
37
+
38
+ ```ruby
39
+ every 2.hours
40
+ ```
41
+
42
+ ## Development
43
+
44
+ After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
45
+
46
+ To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
47
+
48
+ ## Contributing
49
+
50
+ Bug reports and pull requests are welcome on GitHub at https://github.com/unchartedcode/scheduler.
51
+
52
+
53
+ ## License
54
+
55
+ The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
data/Rakefile ADDED
@@ -0,0 +1,6 @@
1
+ require "bundler/gem_tasks"
2
+ require "rspec/core/rake_task"
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+
6
+ task :default => :spec
data/bin/console ADDED
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "scheduler"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require "irb"
14
+ IRB.start
data/bin/setup ADDED
@@ -0,0 +1,7 @@
1
+ #!/bin/bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+
5
+ bundle install
6
+
7
+ # Do any other automated setup that you need to do here
@@ -0,0 +1,10 @@
1
+ default: &default
2
+ adapter: sqlite3
3
+ encoding: unicode
4
+ database: ":memory:"
5
+
6
+ test:
7
+ <<: *default
8
+
9
+ development:
10
+ <<: *default
@@ -0,0 +1,52 @@
1
+ # Cross-process locking using Redis.
2
+ class DistributedMutex
3
+
4
+ def self.synchronize(key, redis=nil, &blk)
5
+ self.new(key, redis).synchronize(&blk)
6
+ end
7
+
8
+ def initialize(key, redis=nil)
9
+ @key = key
10
+ @redis = redis || $redis
11
+ @mutex = Mutex.new
12
+ end
13
+
14
+ # NOTE wrapped in mutex to maintain its semantics
15
+ def synchronize
16
+ @mutex.lock
17
+ while !try_to_get_lock
18
+ sleep 0.001
19
+ end
20
+
21
+ yield
22
+
23
+ ensure
24
+ @redis.del @key
25
+ @mutex.unlock
26
+ end
27
+
28
+ private
29
+
30
+ def try_to_get_lock
31
+ got_lock = false
32
+ if @redis.setnx @key, Time.now.to_i + 60
33
+ @redis.expire @key, 60
34
+ got_lock = true
35
+ else
36
+ begin
37
+ @redis.watch @key
38
+ time = @redis.get @key
39
+ if time && time.to_i < Time.now.to_i
40
+ got_lock = @redis.multi do
41
+ @redis.set @key, Time.now.to_i + 60
42
+ end
43
+ end
44
+ ensure
45
+ @redis.unwatch
46
+ end
47
+ end
48
+
49
+ got_lock
50
+ end
51
+
52
+ end
data/lib/scheduler.rb ADDED
@@ -0,0 +1,50 @@
1
+ require "scheduler/configuration"
2
+
3
+ module Scheduler
4
+ # Configuration
5
+ class << self
6
+ attr_writer :configuration
7
+ end
8
+
9
+ def self.configuration
10
+ @configuration ||= Configuration.new
11
+ end
12
+
13
+ def self.configure
14
+ yield(configuration)
15
+ end
16
+
17
+ require 'sidekiq/exception_handler'
18
+ class SidekiqExceptionHandler
19
+ extend Sidekiq::ExceptionHandler
20
+ end
21
+
22
+ # Log an exception.
23
+ #
24
+ # If your code is in a scheduled job, it is recommended to use the
25
+ # error_context() method in Jobs::Base to pass the job arguments and any
26
+ # other desired context.
27
+ # See app/jobs/base.rb for the error_context function.
28
+ def self.handle_job_exception(ex, context = {}, parent_logger = nil)
29
+ context ||= {}
30
+ parent_logger ||= SidekiqExceptionHandler
31
+
32
+ parent_logger.handle_exception(ex, {
33
+ current_db: Scheduler::Connection.current_db,
34
+ current_hostname: Scheduler::Connection.current_hostname
35
+ }.merge(context))
36
+ end
37
+ end
38
+
39
+ require "active_support/dependencies"
40
+ require "active_record"
41
+ require "rails"
42
+ require "redis"
43
+ require "scheduler/version"
44
+
45
+ require_dependency 'scheduler/connection'
46
+ require_dependency 'scheduler/clock'
47
+ require_dependency 'scheduler/schedule'
48
+ require_dependency 'scheduler/schedule_info'
49
+ require_dependency 'scheduler/manager'
50
+ require_dependency 'scheduler/defer'
@@ -0,0 +1,22 @@
1
+ module Scheduler
2
+ class Clock
3
+ def self.start!
4
+ manager = Scheduler::Manager.new
5
+ Scheduler::Manager.discover_schedules.each do |schedule|
6
+ manager.ensure_schedule!(schedule)
7
+ end
8
+
9
+ Thread.new do
10
+ while true
11
+ begin
12
+ manager.tick
13
+ rescue => e
14
+ # the show must go on
15
+ Scheduler::Manager.handle_exception(e)
16
+ end
17
+ sleep 1
18
+ end
19
+ end
20
+ end
21
+ end
22
+ end
@@ -0,0 +1,8 @@
1
+ module Scheduler
2
+ class Configuration
3
+ attr_accessor :current_db
4
+ attr_accessor :current_hostname
5
+ attr_accessor :establish_connection
6
+ attr_accessor :with_connection
7
+ end
8
+ end
@@ -0,0 +1,36 @@
1
+ module Scheduler
2
+ class Connection
3
+ class << self
4
+ def current_db
5
+ ActiveRecord::Base.connection_pool.spec.config[:db_key] || "default"
6
+ end
7
+
8
+ def current_hostname
9
+ config = ActiveRecord::Base.connection_pool.spec.config
10
+ config[:host_names].nil? ? config[:host] : config[:host_names].first
11
+ end
12
+
13
+ def establish_connection(db)
14
+ config = ActiveRecord::Base.configurations[db]
15
+ ActiveRecord::Base.establish_connection(config)
16
+ end
17
+
18
+ def with_connection(db)
19
+ old = current_db
20
+ connected = ActiveRecord::Base.connection_pool.connected?
21
+
22
+ establish_connection(:db => db) unless connected && db == old
23
+ rval = yield db
24
+
25
+ unless connected && db == old
26
+ ActiveRecord::Base.connection_handler.clear_active_connections!
27
+
28
+ establish_connection(:db => old)
29
+ ActiveRecord::Base.connection_handler.clear_active_connections! unless connected
30
+ end
31
+
32
+ rval
33
+ end
34
+ end
35
+ end
36
+ end
@@ -0,0 +1,93 @@
1
+ module Scheduler
2
+ module Deferrable
3
+ def initialize
4
+ @async = !Rails.env.test?
5
+ @queue = Queue.new
6
+ @mutex = Mutex.new
7
+ @paused = false
8
+ @thread = nil
9
+ end
10
+
11
+ def pause
12
+ stop!
13
+ @paused = true
14
+ end
15
+
16
+ def resume
17
+ @paused = false
18
+ end
19
+
20
+ # for test
21
+ def async=(val)
22
+ @async = val
23
+ end
24
+
25
+ def later(desc = nil, db=Scheduler.configuration.current_db, &blk)
26
+ if @async
27
+ start_thread unless (@thread && @thread.alive?) || @paused
28
+ @queue << [db, blk, desc]
29
+ else
30
+ blk.call
31
+ end
32
+ end
33
+
34
+ def stop!
35
+ @thread.kill if @thread && @thread.alive?
36
+ @thread = nil
37
+ end
38
+
39
+ # test only
40
+ def stopped?
41
+ !(@thread && @thread.alive?)
42
+ end
43
+
44
+ def do_all_work
45
+ while !@queue.empty?
46
+ do_work(_non_block=true)
47
+ end
48
+ end
49
+
50
+ private
51
+
52
+ def start_thread
53
+ @mutex.synchronize do
54
+ return if @thread && @thread.alive?
55
+ @thread = Thread.new {
56
+ while true
57
+ do_work
58
+ end
59
+ }
60
+ end
61
+ end
62
+
63
+ # using non_block to match Ruby #deq
64
+ def do_work(non_block=false)
65
+ db, job, desc = @queue.deq(non_block)
66
+ begin
67
+ Scheduler::Connection.establish_connection(db: db) if db
68
+ job.call
69
+ rescue => ex
70
+ Scheduler.handle_job_exception(ex, {message: "Running deferred code '#{desc}'"})
71
+ end
72
+ rescue => ex
73
+ Scheduler.handle_job_exception(ex, {message: "Processing deferred code queue"})
74
+ ensure
75
+ ActiveRecord::Base.connection_handler.clear_active_connections!
76
+ end
77
+
78
+ end
79
+
80
+ class Defer
81
+ module Unicorn
82
+ def process_client(client)
83
+ Defer.pause
84
+ super(client)
85
+ Defer.do_all_work
86
+ Defer.resume
87
+ end
88
+ end
89
+
90
+ extend Deferrable
91
+ initialize
92
+ end
93
+ end
@@ -0,0 +1,306 @@
1
+ # Initially we used sidetiq, this was a problem:
2
+ #
3
+ # 1. No mechnism to add "randomisation" into job execution
4
+ # 2. No stats about previous runs or failures
5
+ # 3. Dependency on ice_cube gem causes runaway CPU
6
+
7
+ require_dependency 'distributed_mutex'
8
+
9
+ module Scheduler
10
+ class Manager
11
+ attr_accessor :random_ratio, :redis
12
+
13
+ class Runner
14
+ def initialize(manager)
15
+ @mutex = Mutex.new
16
+ @queue = Queue.new
17
+ @manager = manager
18
+ @reschedule_orphans_thread = Thread.new do
19
+ while true
20
+ sleep 1.minute
21
+ @mutex.synchronize do
22
+ reschedule_orphans
23
+ end
24
+ end
25
+ end
26
+ @keep_alive_thread = Thread.new do
27
+ while true
28
+ @mutex.synchronize do
29
+ keep_alive
30
+ end
31
+ sleep (@manager.keep_alive_duration / 2)
32
+ end
33
+ end
34
+ @thread = Thread.new do
35
+ while true
36
+ process_queue
37
+ end
38
+ end
39
+ end
40
+
41
+ def keep_alive
42
+ @manager.keep_alive
43
+ rescue => ex
44
+ Scheduler.handle_job_exception(ex, {message: "Scheduling manager keep-alive"})
45
+ end
46
+
47
+ def reschedule_orphans
48
+ @manager.reschedule_orphans!
49
+ rescue => ex
50
+ Scheduler.handle_job_exception(ex, {message: "Scheduling manager orphan rescheduler"})
51
+ end
52
+
53
+ def process_queue
54
+ klass = @queue.deq
55
+ # hack alert, I need to both deq and set @running atomically.
56
+ @running = true
57
+ failed = false
58
+ start = Time.now.to_f
59
+ info = @mutex.synchronize { @manager.schedule_info(klass) }
60
+ begin
61
+ info.prev_result = "RUNNING"
62
+ @mutex.synchronize { info.write! }
63
+ klass.new.perform
64
+ rescue Jobs::HandledExceptionWrapper
65
+ # Discourse.handle_exception was already called, and we don't have any extra info to give
66
+ failed = true
67
+ rescue => e
68
+ Scheduler.handle_job_exception(e, {message: "Running a scheduled job", job: klass})
69
+ failed = true
70
+ end
71
+ duration = ((Time.now.to_f - start) * 1000).to_i
72
+ info.prev_duration = duration
73
+ info.prev_result = failed ? "FAILED" : "OK"
74
+ info.current_owner = nil
75
+ attempts(3) do
76
+ @mutex.synchronize { info.write! }
77
+ end
78
+ rescue => ex
79
+ Scheduler.handle_job_exception(ex, {message: "Processing scheduled job queue"})
80
+ ensure
81
+ @running = false
82
+ end
83
+
84
+ def stop!
85
+ @mutex.synchronize do
86
+ @thread.kill
87
+ @keep_alive_thread.kill
88
+ @reschedule_orphans_thread.kill
89
+ end
90
+ end
91
+
92
+ def enq(klass)
93
+ @queue << klass
94
+ end
95
+
96
+ def wait_till_done
97
+ while !@queue.empty? && !(@queue.num_waiting > 0)
98
+ sleep 0.001
99
+ end
100
+ # this is a hack, but is only used for test anyway
101
+ sleep 0.001
102
+ while @running
103
+ sleep 0.001
104
+ end
105
+ end
106
+
107
+ def attempts(n)
108
+ n.times {
109
+ begin
110
+ yield; break
111
+ rescue
112
+ sleep Random.rand
113
+ end
114
+ }
115
+ end
116
+
117
+ end
118
+
119
+ def self.without_runner(redis=nil)
120
+ self.new(redis, skip_runner: true)
121
+ end
122
+
123
+ def initialize(redis = nil, options=nil)
124
+ @redis = $redis || redis
125
+ @random_ratio = 0.1
126
+ unless options && options[:skip_runner]
127
+ @runner = Runner.new(self)
128
+ self.class.current = self
129
+ end
130
+
131
+ @hostname = options && options[:hostname]
132
+ @manager_id = SecureRandom.hex
133
+ end
134
+
135
+ def self.current
136
+ @current
137
+ end
138
+
139
+ def self.current=(manager)
140
+ @current = manager
141
+ end
142
+
143
+ def hostname
144
+ @hostname ||= `hostname`.strip
145
+ end
146
+
147
+ def schedule_info(klass)
148
+ ScheduleInfo.new(klass, self)
149
+ end
150
+
151
+ def next_run(klass)
152
+ schedule_info(klass).next_run
153
+ end
154
+
155
+ def ensure_schedule!(klass)
156
+ lock do
157
+ schedule_info(klass).schedule!
158
+ end
159
+
160
+ end
161
+
162
+ def remove(klass)
163
+ lock do
164
+ schedule_info(klass).del!
165
+ end
166
+ end
167
+
168
+ def reschedule_orphans!
169
+ lock do
170
+ reschedule_orphans_on!
171
+ reschedule_orphans_on!(hostname)
172
+ end
173
+ end
174
+
175
+ def reschedule_orphans_on!(hostname=nil)
176
+ redis.zrange(Manager.queue_key(hostname), 0, -1).each do |key|
177
+ klass = get_klass(key)
178
+ next unless klass
179
+ info = schedule_info(klass)
180
+
181
+ if ['QUEUED', 'RUNNING'].include?(info.prev_result) &&
182
+ (info.current_owner.blank? || !redis.get(info.current_owner))
183
+ info.prev_result = 'ORPHAN'
184
+ info.next_run = Time.now.to_i
185
+ info.write!
186
+ end
187
+ end
188
+ end
189
+
190
+ def get_klass(name)
191
+ name.constantize
192
+ rescue NameError
193
+ nil
194
+ end
195
+
196
+ def tick
197
+ lock do
198
+ schedule_next_job
199
+ schedule_next_job(hostname)
200
+ end
201
+ end
202
+
203
+ def schedule_next_job(hostname=nil)
204
+ (key, due), _ = redis.zrange Manager.queue_key(hostname), 0, 0, withscores: true
205
+
206
+ return unless key
207
+ if due.to_i <= Time.now.to_i
208
+ klass = get_klass(key)
209
+ unless klass
210
+ # corrupt key, nuke it (renamed job or something)
211
+ redis.zrem Manager.queue_key(hostname), key
212
+ return
213
+ end
214
+
215
+ unless klass.respond_to?(:daily) &&
216
+ klass.respond_to?(:every)
217
+ # job klass exists but no longer extends from the base
218
+ redis.zrem Manager.queue_key(hostname), key
219
+ return
220
+ end
221
+
222
+ info = schedule_info(klass)
223
+ info.prev_run = Time.now.to_i
224
+ info.prev_result = "QUEUED"
225
+ info.prev_duration = -1
226
+ info.next_run = nil
227
+ info.current_owner = identity_key
228
+ info.schedule!
229
+ @runner.enq(klass)
230
+ end
231
+ end
232
+
233
+ def blocking_tick
234
+ tick
235
+ @runner.wait_till_done
236
+ end
237
+
238
+ def stop!
239
+ @runner.stop!
240
+ self.class.current = nil
241
+ end
242
+
243
+ def keep_alive_duration
244
+ 60
245
+ end
246
+
247
+ def keep_alive
248
+ redis.setex identity_key, keep_alive_duration, ""
249
+ end
250
+
251
+ def lock
252
+ DistributedMutex.new(Manager.lock_key).synchronize do
253
+ yield
254
+ end
255
+ end
256
+
257
+
258
+ def self.discover_schedules
259
+ # hack for developemnt reloader is crazytown
260
+ # multiple classes with same name can be in
261
+ # object space
262
+ unique = Set.new
263
+ schedules = []
264
+ ObjectSpace.each_object(Scheduler::Schedule) do |schedule|
265
+ if schedule.scheduled?
266
+ next if unique.include?(schedule.to_s)
267
+ schedules << schedule
268
+ unique << schedule.to_s
269
+ end
270
+ end
271
+ schedules
272
+ end
273
+
274
+ @mutex = Mutex.new
275
+ def self.seq
276
+ @mutex.synchronize do
277
+ @i ||= 0
278
+ @i += 1
279
+ end
280
+ end
281
+
282
+ def identity_key
283
+ @identity_key ||= "_scheduler_#{hostname}:#{Process.pid}:#{self.class.seq}:#{SecureRandom.hex}"
284
+ end
285
+
286
+ def self.lock_key
287
+ "_scheduler_lock_"
288
+ end
289
+
290
+ def self.queue_key(hostname=nil)
291
+ if hostname
292
+ "_scheduler_queue_#{hostname}_"
293
+ else
294
+ "_scheduler_queue_"
295
+ end
296
+ end
297
+
298
+ def self.schedule_key(klass,hostname=nil)
299
+ if hostname
300
+ "_scheduler_#{klass}_#{hostname}"
301
+ else
302
+ "_scheduler_#{klass}"
303
+ end
304
+ end
305
+ end
306
+ end
@@ -0,0 +1,36 @@
1
+ module Scheduler::Schedule
2
+ def daily(options=nil)
3
+ if options
4
+ @daily = options
5
+ end
6
+ @daily
7
+ end
8
+
9
+ def every(duration=nil)
10
+ if duration
11
+ @every = duration
12
+ if manager = Scheduler::Manager.current
13
+ manager.ensure_schedule!(self)
14
+ end
15
+ end
16
+ @every
17
+ end
18
+
19
+ # schedule job indepndently on each host (looking at hostname)
20
+ def per_host
21
+ @per_host = true
22
+ end
23
+
24
+ def is_per_host
25
+ @per_host
26
+ end
27
+
28
+ def schedule_info
29
+ manager = Scheduler::Manager.without_runner
30
+ manager.schedule_info self
31
+ end
32
+
33
+ def scheduled?
34
+ !!@every || !!@daily
35
+ end
36
+ end
@@ -0,0 +1,134 @@
1
+ module Scheduler
2
+ class ScheduleInfo
3
+ attr_accessor :next_run,
4
+ :prev_run,
5
+ :prev_duration,
6
+ :prev_result,
7
+ :current_owner
8
+
9
+ def initialize(klass, manager)
10
+ @klass = klass
11
+ @manager = manager
12
+
13
+ data = nil
14
+
15
+ if data = $redis.get(key)
16
+ data = JSON.parse(data)
17
+ end
18
+
19
+ if data
20
+ @next_run = data["next_run"]
21
+ @prev_run = data["prev_run"]
22
+ @prev_result = data["prev_result"]
23
+ @prev_duration = data["prev_duration"]
24
+ @current_owner = data["current_owner"]
25
+ end
26
+ rescue
27
+ # corrupt redis
28
+ @next_run = @prev_run = @prev_result = @prev_duration = @current_owner = nil
29
+ end
30
+
31
+ def valid?
32
+ return false unless @next_run
33
+ (!@prev_run && @next_run < Time.now.to_i + 5.minutes) || valid_every? || valid_daily?
34
+ end
35
+
36
+ def valid_every?
37
+ return false unless @klass.every
38
+ !!@prev_run &&
39
+ @prev_run <= Time.now.to_i &&
40
+ @next_run < @prev_run + @klass.every * (1 + @manager.random_ratio)
41
+ end
42
+
43
+ def valid_daily?
44
+ return false unless @klass.daily
45
+ !!@prev_run &&
46
+ @prev_run <= Time.now.to_i &&
47
+ @next_run < @prev_run + 1.day
48
+ end
49
+
50
+ def schedule_every!
51
+ if !valid? && @prev_run
52
+ mixup = @klass.every * @manager.random_ratio
53
+ mixup = (mixup * Random.rand - mixup / 2).to_i
54
+ @next_run = @prev_run + mixup + @klass.every
55
+ end
56
+
57
+ if !valid?
58
+ @next_run = Time.now.to_i + 5.minutes * Random.rand
59
+ end
60
+ end
61
+
62
+ def schedule_daily!
63
+ return if valid?
64
+
65
+ at = @klass.daily[:at] || 0
66
+ today_begin = Time.now.midnight.to_i
67
+ today_offset = DateTime.now.seconds_since_midnight
68
+
69
+ # If it's later today
70
+ if at > today_offset
71
+ @next_run = today_begin + at
72
+ else
73
+ # Otherwise do it tomorrow
74
+ @next_run = today_begin + 1.day + at
75
+ end
76
+ end
77
+
78
+ def schedule!
79
+ if @klass.every
80
+ schedule_every!
81
+ elsif @klass.daily
82
+ schedule_daily!
83
+ end
84
+
85
+ write!
86
+ end
87
+
88
+ def write!
89
+
90
+ clear!
91
+ redis.set key, {
92
+ next_run: @next_run,
93
+ prev_run: @prev_run,
94
+ prev_duration: @prev_duration,
95
+ prev_result: @prev_result,
96
+ current_owner: @current_owner
97
+ }.to_json
98
+
99
+ redis.zadd queue_key, @next_run , @klass
100
+ end
101
+
102
+ def del!
103
+ clear!
104
+ @next_run = @prev_run = @prev_result = @prev_duration = @current_owner = nil
105
+ end
106
+
107
+ def key
108
+ if @klass.is_per_host
109
+ Manager.schedule_key(@klass, @manager.hostname)
110
+ else
111
+ Manager.schedule_key(@klass)
112
+ end
113
+ end
114
+
115
+ def queue_key
116
+ if @klass.is_per_host
117
+ Manager.queue_key(@manager.hostname)
118
+ else
119
+ Manager.queue_key
120
+ end
121
+ end
122
+
123
+ def redis
124
+ @manager.redis
125
+ end
126
+
127
+ private
128
+ def clear!
129
+ redis.del key
130
+ redis.zrem queue_key, @klass
131
+ end
132
+
133
+ end
134
+ end
@@ -0,0 +1,3 @@
1
+ module Scheduler
2
+ VERSION = "0.1.1"
3
+ end
@@ -0,0 +1,72 @@
1
+ <header class="row">
2
+ <% if Sidekiq.respond_to?(:paused?) && Sidekiq.paused? %>
3
+ <div class="col-sm-12">
4
+ <div class="alert alert-danger text-center">
5
+ <h2>SIDEKIQ IS PAUSED!</h2>
6
+ </div>
7
+ </div>
8
+ <% end %>
9
+ <div class="col-sm-12">
10
+ <h3>Recurring Jobs</h3>
11
+ </div>
12
+ </header>
13
+
14
+ <div class="container">
15
+ <div class="row">
16
+
17
+ <div class="col-md-9">
18
+ <% if @schedules.length > 0 %>
19
+ <table class="table table-striped table-bordered table-white" style="width: 100%; margin: 0; table-layout:fixed;">
20
+ <thead>
21
+ <th style="width: 30%">Worker</th>
22
+ <th style="width: 15%">Last Run</th>
23
+ <th style="width: 15%">Last Result</th>
24
+ <th style="width: 15%">Last Duration</th>
25
+ <th style="width: 15%">Last Owner</th>
26
+ <th style="width: 15%">Next Run Due</th>
27
+ <th style="width: 10%">Actions</th>
28
+ </thead>
29
+ <% @schedules.each do |schedule| %>
30
+ <% @info = schedule.schedule_info %>
31
+ <tr>
32
+ <td>
33
+ <%= schedule %>
34
+ <td>
35
+ <% prev = @info.prev_run %>
36
+ <% if prev.nil? %>
37
+ Never
38
+ <% else %>
39
+ <%= relative_time(Time.at(prev)) %>
40
+ <% end %>
41
+ </td>
42
+ <td>
43
+ <%= @info.prev_result %>
44
+ </td>
45
+ <td>
46
+ <%= @info.prev_duration %>
47
+ </td>
48
+ <td>
49
+ <%= @info.current_owner %>
50
+ </td>
51
+ <td>
52
+ <% next_run = @info.next_run %>
53
+ <% if next_run.nil? %>
54
+ Not Scheduled Yet
55
+ <% else %>
56
+ <%= relative_time(Time.at(next_run)) %>
57
+ <% end %>
58
+ </td>
59
+ <td>
60
+ <form action="<%= "#{root_path}scheduler/#{schedule}/trigger" %>" method="post">
61
+ <input class="btn btn-danger btn-small" type="submit" name="trigger" value="Trigger" data-confirm="Are you sure you want to trigger this job?" />
62
+ </form>
63
+ </td>
64
+ </tr>
65
+ <% end %>
66
+ </table>
67
+ <% else %>
68
+ <div class="alert alert-success">No recurring jobs found.</div>
69
+ <% end %>
70
+ </div>
71
+ </div>
72
+ </div>
@@ -0,0 +1,43 @@
1
+ # Based off sidetiq https://github.com/tobiassvn/sidetiq/blob/master/lib/sidetiq/web.rb
2
+ module Scheduler
3
+ module Web
4
+ VIEWS = File.expand_path('views', File.dirname(__FILE__)) unless defined? VIEWS
5
+
6
+ def self.registered(app)
7
+ app.get "/scheduler" do
8
+ Scheduler::Connection.with_connection("default") do
9
+ @manager = Scheduler::Manager.without_runner
10
+ @schedules = Scheduler::Manager.discover_schedules.sort do |a,b|
11
+ a_next = a.schedule_info.next_run
12
+ b_next = b.schedule_info.next_run
13
+ if a_next && b_next
14
+ a_next <=> b_next
15
+ elsif a_next
16
+ -1
17
+ else
18
+ 1
19
+ end
20
+ end
21
+ erb File.read(File.join(VIEWS, 'scheduler.erb')), locals: {view_path: VIEWS}
22
+ end
23
+ end
24
+
25
+ app.post "/scheduler/:name/trigger" do
26
+ halt 404 unless (name = params[:name])
27
+
28
+ Scheduler::Connection.with_connection("default") do
29
+ klass = name.constantize
30
+ info = klass.schedule_info
31
+ info.next_run = Time.now.to_f
32
+ info.write!
33
+
34
+ redirect "#{root_path}scheduler"
35
+ end
36
+ end
37
+
38
+ end
39
+ end
40
+ end
41
+
42
+ Sidekiq::Web.register(Scheduler::Web)
43
+ Sidekiq::Web.tabs["Scheduler"] = "scheduler"
data/scheduler.gemspec ADDED
@@ -0,0 +1,33 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'scheduler/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "uncharted-scheduler"
8
+ spec.version = Scheduler::VERSION
9
+ spec.authors = ["Sam Saffron", "Nathan Palmer"]
10
+ spec.email = ["nathan@nathanpalmer.com"]
11
+
12
+ spec.summary = %q{Performance friendly recurring jobs for Sidekiq}
13
+ spec.description = %q{Allows you to define recurring workers for Sidekiq without requiring a dedicated job server}
14
+ spec.homepage = ""
15
+ spec.license = "MIT"
16
+
17
+ spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
18
+ spec.bindir = "exe"
19
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
20
+ spec.require_paths = ["lib"]
21
+
22
+ spec.add_development_dependency "bundler", "~> 1.10"
23
+ spec.add_development_dependency "rake", "~> 10.0"
24
+ spec.add_development_dependency "rspec"
25
+ spec.add_development_dependency "sqlite3"
26
+ spec.add_development_dependency "mock_redis"
27
+ spec.add_development_dependency "byebug"
28
+ spec.add_development_dependency "coveralls"
29
+
30
+ spec.add_dependency "rails"
31
+ spec.add_dependency "redis"
32
+ spec.add_dependency "sidekiq"
33
+ end
metadata ADDED
@@ -0,0 +1,209 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: uncharted-scheduler
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.1
5
+ platform: ruby
6
+ authors:
7
+ - Sam Saffron
8
+ - Nathan Palmer
9
+ autorequire:
10
+ bindir: exe
11
+ cert_chain: []
12
+ date: 2015-11-23 00:00:00.000000000 Z
13
+ dependencies:
14
+ - !ruby/object:Gem::Dependency
15
+ name: bundler
16
+ requirement: !ruby/object:Gem::Requirement
17
+ requirements:
18
+ - - "~>"
19
+ - !ruby/object:Gem::Version
20
+ version: '1.10'
21
+ type: :development
22
+ prerelease: false
23
+ version_requirements: !ruby/object:Gem::Requirement
24
+ requirements:
25
+ - - "~>"
26
+ - !ruby/object:Gem::Version
27
+ version: '1.10'
28
+ - !ruby/object:Gem::Dependency
29
+ name: rake
30
+ requirement: !ruby/object:Gem::Requirement
31
+ requirements:
32
+ - - "~>"
33
+ - !ruby/object:Gem::Version
34
+ version: '10.0'
35
+ type: :development
36
+ prerelease: false
37
+ version_requirements: !ruby/object:Gem::Requirement
38
+ requirements:
39
+ - - "~>"
40
+ - !ruby/object:Gem::Version
41
+ version: '10.0'
42
+ - !ruby/object:Gem::Dependency
43
+ name: rspec
44
+ requirement: !ruby/object:Gem::Requirement
45
+ requirements:
46
+ - - ">="
47
+ - !ruby/object:Gem::Version
48
+ version: '0'
49
+ type: :development
50
+ prerelease: false
51
+ version_requirements: !ruby/object:Gem::Requirement
52
+ requirements:
53
+ - - ">="
54
+ - !ruby/object:Gem::Version
55
+ version: '0'
56
+ - !ruby/object:Gem::Dependency
57
+ name: sqlite3
58
+ requirement: !ruby/object:Gem::Requirement
59
+ requirements:
60
+ - - ">="
61
+ - !ruby/object:Gem::Version
62
+ version: '0'
63
+ type: :development
64
+ prerelease: false
65
+ version_requirements: !ruby/object:Gem::Requirement
66
+ requirements:
67
+ - - ">="
68
+ - !ruby/object:Gem::Version
69
+ version: '0'
70
+ - !ruby/object:Gem::Dependency
71
+ name: mock_redis
72
+ requirement: !ruby/object:Gem::Requirement
73
+ requirements:
74
+ - - ">="
75
+ - !ruby/object:Gem::Version
76
+ version: '0'
77
+ type: :development
78
+ prerelease: false
79
+ version_requirements: !ruby/object:Gem::Requirement
80
+ requirements:
81
+ - - ">="
82
+ - !ruby/object:Gem::Version
83
+ version: '0'
84
+ - !ruby/object:Gem::Dependency
85
+ name: byebug
86
+ requirement: !ruby/object:Gem::Requirement
87
+ requirements:
88
+ - - ">="
89
+ - !ruby/object:Gem::Version
90
+ version: '0'
91
+ type: :development
92
+ prerelease: false
93
+ version_requirements: !ruby/object:Gem::Requirement
94
+ requirements:
95
+ - - ">="
96
+ - !ruby/object:Gem::Version
97
+ version: '0'
98
+ - !ruby/object:Gem::Dependency
99
+ name: coveralls
100
+ requirement: !ruby/object:Gem::Requirement
101
+ requirements:
102
+ - - ">="
103
+ - !ruby/object:Gem::Version
104
+ version: '0'
105
+ type: :development
106
+ prerelease: false
107
+ version_requirements: !ruby/object:Gem::Requirement
108
+ requirements:
109
+ - - ">="
110
+ - !ruby/object:Gem::Version
111
+ version: '0'
112
+ - !ruby/object:Gem::Dependency
113
+ name: rails
114
+ requirement: !ruby/object:Gem::Requirement
115
+ requirements:
116
+ - - ">="
117
+ - !ruby/object:Gem::Version
118
+ version: '0'
119
+ type: :runtime
120
+ prerelease: false
121
+ version_requirements: !ruby/object:Gem::Requirement
122
+ requirements:
123
+ - - ">="
124
+ - !ruby/object:Gem::Version
125
+ version: '0'
126
+ - !ruby/object:Gem::Dependency
127
+ name: redis
128
+ requirement: !ruby/object:Gem::Requirement
129
+ requirements:
130
+ - - ">="
131
+ - !ruby/object:Gem::Version
132
+ version: '0'
133
+ type: :runtime
134
+ prerelease: false
135
+ version_requirements: !ruby/object:Gem::Requirement
136
+ requirements:
137
+ - - ">="
138
+ - !ruby/object:Gem::Version
139
+ version: '0'
140
+ - !ruby/object:Gem::Dependency
141
+ name: sidekiq
142
+ requirement: !ruby/object:Gem::Requirement
143
+ requirements:
144
+ - - ">="
145
+ - !ruby/object:Gem::Version
146
+ version: '0'
147
+ type: :runtime
148
+ prerelease: false
149
+ version_requirements: !ruby/object:Gem::Requirement
150
+ requirements:
151
+ - - ">="
152
+ - !ruby/object:Gem::Version
153
+ version: '0'
154
+ description: Allows you to define recurring workers for Sidekiq without requiring
155
+ a dedicated job server
156
+ email:
157
+ - nathan@nathanpalmer.com
158
+ executables: []
159
+ extensions: []
160
+ extra_rdoc_files: []
161
+ files:
162
+ - ".gitignore"
163
+ - ".rspec"
164
+ - ".travis.yml"
165
+ - Gemfile
166
+ - LICENSE.txt
167
+ - README.md
168
+ - Rakefile
169
+ - bin/console
170
+ - bin/setup
171
+ - config/database.yml
172
+ - lib/distributed_mutex.rb
173
+ - lib/scheduler.rb
174
+ - lib/scheduler/clock.rb
175
+ - lib/scheduler/configuration.rb
176
+ - lib/scheduler/connection.rb
177
+ - lib/scheduler/defer.rb
178
+ - lib/scheduler/manager.rb
179
+ - lib/scheduler/schedule.rb
180
+ - lib/scheduler/schedule_info.rb
181
+ - lib/scheduler/version.rb
182
+ - lib/scheduler/views/scheduler.erb
183
+ - lib/scheduler/web.rb
184
+ - scheduler.gemspec
185
+ homepage: ''
186
+ licenses:
187
+ - MIT
188
+ metadata: {}
189
+ post_install_message:
190
+ rdoc_options: []
191
+ require_paths:
192
+ - lib
193
+ required_ruby_version: !ruby/object:Gem::Requirement
194
+ requirements:
195
+ - - ">="
196
+ - !ruby/object:Gem::Version
197
+ version: '0'
198
+ required_rubygems_version: !ruby/object:Gem::Requirement
199
+ requirements:
200
+ - - ">="
201
+ - !ruby/object:Gem::Version
202
+ version: '0'
203
+ requirements: []
204
+ rubyforge_project:
205
+ rubygems_version: 2.4.3
206
+ signing_key:
207
+ specification_version: 4
208
+ summary: Performance friendly recurring jobs for Sidekiq
209
+ test_files: []