Class: CanvasSync::JobBatches::Batch
- Inherits:
-
Object
- Object
- CanvasSync::JobBatches::Batch
- Includes:
- RedisModel
- Defined in:
- lib/canvas_sync/job_batches/batch.rb,
lib/canvas_sync/job_batches/status.rb,
lib/canvas_sync/job_batches/callback.rb
Defined Under Namespace
Modules: Callback Classes: NoBlockGivenError, RedisProxy, Status
Constant Summary collapse
- BID_EXPIRE_TTL =
90.days.to_i
- INDEX_ALL_BATCHES =
false
- SCHEDULE_CALLBACK =
RedisScript.new(Pathname.new(__FILE__) + "../schedule_callback.lua")
- BID_HIERARCHY =
RedisScript.new(Pathname.new(__FILE__) + "../hier_batch_ids.lua")
Instance Attribute Summary collapse
-
#bid ⇒ Object
readonly
Returns the value of attribute bid.
Class Method Summary collapse
- .bid_hierarchy(bid, depth: 4, per_depth: 5, slice: nil) ⇒ Object
- .cleanup_redis(bid) ⇒ Object
-
.cleanup_redis_index! ⇒ Object
Administrative/console method to cleanup expired batches from the WebUI.
-
.cleanup_redis_index_for(key, suffixes = [""]) ⇒ Object
Internal method to cleanup a Redis Hash and related keys.
- .current ⇒ Object
- .current_context ⇒ Object
- .delete_prematurely!(bid) ⇒ Object
- .enqueue_callbacks(event, bid) ⇒ Object
- .logger ⇒ Object
-
.process_dead_job(bid, jid) ⇒ Object
Dead jobs are a Sidekiq feature.
- .process_failed_job(bid, jid) ⇒ Object
- .process_successful_job(bid, jid) ⇒ Object
- .push_callbacks(args, queue) ⇒ Object
- .redis(&blk) ⇒ Object
- .with_batch(batch) ⇒ Object
-
.without_batch(&blk) ⇒ Object
Any Batches or Jobs created in the given block won’t be assocaiated to the current batch.
Instance Method Summary collapse
- #context ⇒ Object
- #context=(value) ⇒ Object
- #increment_job_queue(jid) ⇒ Object
-
#initialize(existing_bid = nil) ⇒ Batch
constructor
A new instance of Batch.
- #invalidate_all ⇒ Object
- #jobs ⇒ Object
- #keep_open! ⇒ Object
- #let_close! ⇒ Object
- #on(event, callback, options = {}) ⇒ Object
- #parent ⇒ Object
- #parent_bid ⇒ Object
- #save_context_changes ⇒ Object
- #valid?(batch = self) ⇒ Boolean
Methods included from RedisModel
#persist_bid_attr, #read_bid_attr
Constructor Details
#initialize(existing_bid = nil) ⇒ Batch
Returns a new instance of Batch.
45 46 47 48 49 50 51 |
# File 'lib/canvas_sync/job_batches/batch.rb', line 45 def initialize(existing_bid = nil) @bid = existing_bid || SecureRandom.urlsafe_base64(10) @existing = !(!existing_bid || existing_bid.empty?) # Basically existing_bid.present? @initialized = false @bidkey = "BID-" + @bid.to_s self.created_at = Time.now.utc.to_f unless @existing end |
Instance Attribute Details
#bid ⇒ Object (readonly)
Returns the value of attribute bid.
35 36 37 |
# File 'lib/canvas_sync/job_batches/batch.rb', line 35 def bid @bid end |
Class Method Details
.bid_hierarchy(bid, depth: 4, per_depth: 5, slice: nil) ⇒ Object
476 477 478 479 480 481 482 |
# File 'lib/canvas_sync/job_batches/batch.rb', line 476 def bid_hierarchy(bid, depth: 4, per_depth: 5, slice: nil) args = [bid, depth, per_depth] args << slice if slice redis do |r| BID_HIERARCHY.call(r, [], args) end end |
.cleanup_redis(bid) ⇒ Object
388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 |
# File 'lib/canvas_sync/job_batches/batch.rb', line 388 def cleanup_redis(bid) logger.debug {"Cleaning redis of batch #{bid}"} redis do |r| r.zrem("batches", bid) r.zrem("BID-ROOT-bids", bid) r.unlink( "BID-#{bid}", "BID-#{bid}-callbacks-complete", "BID-#{bid}-callbacks-success", "BID-#{bid}-failed", "BID-#{bid}-dead", "BID-#{bid}-batches-success", "BID-#{bid}-batches-complete", "BID-#{bid}-batches-failed", "BID-#{bid}-bids", "BID-#{bid}-jids", "BID-#{bid}-pending_callbacks", ) end end |
.cleanup_redis_index! ⇒ Object
Administrative/console method to cleanup expired batches from the WebUI
440 441 442 443 444 445 446 447 448 449 450 451 |
# File 'lib/canvas_sync/job_batches/batch.rb', line 440 def cleanup_redis_index! suffixes = ["", "-callbacks-complete", "-callbacks-success", "-failed", "-dead", "-batches-success", "-batches-complete", "-batches-failed", "-bids", "-jids", "-pending_callbacks"] cleanup_index = ->(index) { r.zrangebyscore(index, "0", BID_EXPIRE_TTL.seconds.ago.to_i).each do |bid| r.zrem(index, bid) if cleanup_redis_index_for("BID-#{bid}", suffixes) end } cleanup_index.call("BID-ROOT-bids") cleanup_index.call("batches") end |
.cleanup_redis_index_for(key, suffixes = [""]) ⇒ Object
Internal method to cleanup a Redis Hash and related keys
421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 |
# File 'lib/canvas_sync/job_batches/batch.rb', line 421 def cleanup_redis_index_for(key, suffixes = [""]) if r.hget(k, "created_at").present? r.multi do |r| suffixes.each do |suffix| r.expire(key + suffix, BID_EXPIRE_TTL) end end false else r.multi do |r| suffixes.each do |suffix| r.unlink(key + suffix) end end true end end |
.current ⇒ Object
37 38 39 |
# File 'lib/canvas_sync/job_batches/batch.rb', line 37 def self.current Thread.current[CURRENT_BATCH_THREAD_KEY] end |
.current_context ⇒ Object
41 42 43 |
# File 'lib/canvas_sync/job_batches/batch.rb', line 41 def self.current_context self.current&.context end |
.delete_prematurely!(bid) ⇒ Object
410 411 412 413 414 415 416 417 418 |
# File 'lib/canvas_sync/job_batches/batch.rb', line 410 def delete_prematurely!(bid) child_bids = redis do |r| r.zrange("BID-#{bid}-bids", 0, -1) end child_bids.each do |cbid| delete_prematurely!(cbid) end cleanup_redis(bid) end |
.enqueue_callbacks(event, bid) ⇒ Object
318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 |
# File 'lib/canvas_sync/job_batches/batch.rb', line 318 def enqueue_callbacks(event, bid) batch_key = "BID-#{bid}" callback_key = "#{batch_key}-callbacks-#{event}" callbacks, queue, parent_bid, callback_params = redis do |r| return unless r.exists?(batch_key) return if r.hget(batch_key, 'keep_open') == 'true' r.multi do |r| r.smembers(callback_key) r.hget(batch_key, "callback_queue") r.hget(batch_key, "parent_bid") r.hget(batch_key, "callback_params") end end queue ||= "default" parent_bid = !parent_bid || parent_bid.empty? ? nil : parent_bid # Basically parent_bid.blank? # Internal callback params. If this is present, we're trying to enqueue callbacks for a callback, which is a special case that # indicates that the callback completed and we need to close the triggering batch (which is in a done-but-not-cleaned state) callback_params = JSON.parse(callback_params) if callback_params.present? # User-configured parameters/arguments to pass to the callback callback_args = callbacks.reduce([]) do |memo, jcb| cb = JSON.load(jcb) memo << [cb['callback'], event.to_s, cb['opts'], bid, parent_bid] end opts = {"bid" => bid, "event" => event} should_schedule_batch = callback_args.present? && !callback_params.present? already_processed = redis do |r| SCHEDULE_CALLBACK.call(r, [batch_key], [event.to_s, should_schedule_batch.to_s, BID_EXPIRE_TTL]) end return if already_processed == 'true' if should_schedule_batch logger.debug {"Enqueue callback bid: #{bid} event: #{event} args: #{callback_args.inspect}"} # Create a new Batch to handle the callbacks and add it to the _parent_ batch # (this ensures that the parent's lifecycle status can't change until the child's callbacks are done) with_batch(parent_bid) do cb_batch = self.new cb_batch.callback_params = { for_bid: bid, event: event, } opts['callback_bid'] = cb_batch.bid logger.debug {"Adding callback batch: #{cb_batch.bid} for batch: #{bid}"} cb_batch.jobs do push_callbacks(callback_args, queue) end end end if callback_params.present? # This is a callback for a callback. Passing `origin` to the Finalizer allows it to also cleanup the original/callback-triggering batch opts['origin'] = callback_params end # The Finalizer marks this batch as complete, bumps any necessary counters, cleans up this Batch _if_ no callbacks were scheduled, # and enqueues parent-Batch callbacks if needed. logger.debug {"Run batch finalizer bid: #{bid} event: #{event} args: #{callback_args.inspect}"} finalizer = Batch::Callback::Finalize.new status = Status.new bid finalizer.dispatch(status, opts) end |
.logger ⇒ Object
468 469 470 |
# File 'lib/canvas_sync/job_batches/batch.rb', line 468 def logger ::CanvasSync.logger end |
.process_dead_job(bid, jid) ⇒ Object
Dead jobs are a Sidekiq feature. If this is called for a job, process_failed_job was also called
275 276 277 278 279 280 281 282 283 284 285 286 287 |
# File 'lib/canvas_sync/job_batches/batch.rb', line 275 def process_dead_job(bid, jid) _, dead_count = redis do |r| return unless r.exists?("BID-#{bid}") r.multi do |r| r.sadd("BID-#{bid}-dead", jid) r.scard("BID-#{bid}-dead") r.expire("BID-#{bid}-dead", BID_EXPIRE_TTL) end end enqueue_callbacks(:death, bid) end |
.process_failed_job(bid, jid) ⇒ Object
251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 |
# File 'lib/canvas_sync/job_batches/batch.rb', line 251 def process_failed_job(bid, jid) _, pending, failed, children, complete, parent_bid = redis do |r| return unless r.exists?("BID-#{bid}") r.multi do |r| r.sadd("BID-#{bid}-failed", jid) r.hincrby("BID-#{bid}", "pending", 0) r.scard("BID-#{bid}-failed") r.hincrby("BID-#{bid}", "children", 0) r.scard("BID-#{bid}-batches-complete") r.hget("BID-#{bid}", "parent_bid") r.expire("BID-#{bid}-failed", BID_EXPIRE_TTL) end end if pending.to_i == failed.to_i && children == complete enqueue_callbacks(:complete, bid) end end |
.process_successful_job(bid, jid) ⇒ Object
289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 |
# File 'lib/canvas_sync/job_batches/batch.rb', line 289 def process_successful_job(bid, jid) _, failed, pending, children, complete, success, parent_bid, keep_open = redis do |r| return unless r.exists?("BID-#{bid}") r.multi do |r| r.srem("BID-#{bid}-failed", jid) r.scard("BID-#{bid}-failed") r.hincrby("BID-#{bid}", "pending", -1) r.hincrby("BID-#{bid}", "children", 0) r.scard("BID-#{bid}-batches-complete") r.scard("BID-#{bid}-batches-success") r.hget("BID-#{bid}", "parent_bid") r.hget("BID-#{bid}", "keep_open") r.hincrby("BID-#{bid}", "successful-jobs", 1) r.zrem("BID-#{bid}-jids", jid) r.expire("BID-#{bid}", BID_EXPIRE_TTL) end end all_success = pending.to_i.zero? && children == success # if complete or successfull call complete callback (the complete callback may then call successful) if (pending.to_i == failed.to_i && children == complete) || all_success enqueue_callbacks(:complete, bid) enqueue_callbacks(:success, bid) if all_success end end |
.push_callbacks(args, queue) ⇒ Object
472 473 474 |
# File 'lib/canvas_sync/job_batches/batch.rb', line 472 def push_callbacks(args, queue) Batch::Callback::worker_class.enqueue_all(args, queue) end |
.redis(&blk) ⇒ Object
453 454 455 456 457 458 459 460 461 462 463 464 465 466 |
# File 'lib/canvas_sync/job_batches/batch.rb', line 453 def redis(&blk) return RedisProxy.new unless block_given? if Thread.current[:job_batches_redis] yield Thread.current[:job_batches_redis] else ::Bearcat.redis do |r| Thread.current[:job_batches_redis] = r yield r ensure Thread.current[:job_batches_redis] = nil end end end |
.with_batch(batch) ⇒ Object
192 193 194 195 196 197 198 199 |
# File 'lib/canvas_sync/job_batches/batch.rb', line 192 def self.with_batch(batch) batch = self.new(batch) if batch.is_a?(String) parent = Thread.current[CURRENT_BATCH_THREAD_KEY] Thread.current[CURRENT_BATCH_THREAD_KEY] = batch yield ensure Thread.current[CURRENT_BATCH_THREAD_KEY] = parent end |
.without_batch(&blk) ⇒ Object
Any Batches or Jobs created in the given block won’t be assocaiated to the current batch
202 203 204 |
# File 'lib/canvas_sync/job_batches/batch.rb', line 202 def self.without_batch(&blk) with_batch(nil, &blk) end |
Instance Method Details
#context ⇒ Object
59 60 61 62 63 64 65 66 67 |
# File 'lib/canvas_sync/job_batches/batch.rb', line 59 def context return @context if defined?(@context) if (@initialized || @existing) @context = ContextHash.new(bid) else @context = ContextHash.new(bid, {}) end end |
#context=(value) ⇒ Object
69 70 71 72 73 74 75 76 77 78 79 80 |
# File 'lib/canvas_sync/job_batches/batch.rb', line 69 def context=(value) raise "context is read-only once the batch has been started" if (@initialized || @existing) # && !allow_context_changes raise "context must be a Hash" unless value.is_a?(Hash) || value.nil? return nil if value.nil? && @context.nil? value = {} if value.nil? value = value.local if value.is_a?(ContextHash) @context ||= ContextHash.new(bid, {}) @context.set_local(value) # persist_bid_attr('context', JSON.unparse(@context.local)) end |
#increment_job_queue(jid) ⇒ Object
136 137 138 139 |
# File 'lib/canvas_sync/job_batches/batch.rb', line 136 def increment_job_queue(jid) assert_batch_is_open append_jobs([jid]) end |
#invalidate_all ⇒ Object
141 142 143 |
# File 'lib/canvas_sync/job_batches/batch.rb', line 141 def invalidate_all redis.setex("invalidated-bid-#{bid}", BID_EXPIRE_TTL, 1) end |
#jobs ⇒ Object
98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 |
# File 'lib/canvas_sync/job_batches/batch.rb', line 98 def jobs raise NoBlockGivenError unless block_given? if !@existing && !@initialized parent_bid = Thread.current[CURRENT_BATCH_THREAD_KEY]&.bid redis.multi do |r| r.hset(@bidkey, "parent_bid", parent_bid.to_s) if parent_bid r.expire(@bidkey, BID_EXPIRE_TTL) if parent_bid r.hincrby("BID-#{parent_bid}", "children", 1) r.expire("BID-#{parent_bid}", BID_EXPIRE_TTL) r.zadd("BID-#{parent_bid}-bids", created_at, bid) else r.zadd("BID-ROOT-bids", created_at, bid) end end flush_pending_attrs @context&.save! @initialized = true else assert_batch_is_open end begin parent = Thread.current[CURRENT_BATCH_THREAD_KEY] Thread.current[CURRENT_BATCH_THREAD_KEY] = self yield ensure Thread.current[CURRENT_BATCH_THREAD_KEY] = parent end nil end |
#keep_open! ⇒ Object
160 161 162 163 164 165 166 167 168 169 170 171 |
# File 'lib/canvas_sync/job_batches/batch.rb', line 160 def keep_open! if block_given? begin keep_open! yield ensure let_close! end else redis.hset(@bidkey, 'keep_open', "true") end end |
#let_close! ⇒ Object
173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 |
# File 'lib/canvas_sync/job_batches/batch.rb', line 173 def let_close! _, failed, pending, children, complete, success = redis.multi do |r| r.hset(@bidkey, 'keep_open', "false") r.scard("BID-#{bid}-failed") r.hincrby("BID-#{bid}", "pending", 0) r.hincrby("BID-#{bid}", "children", 0) r.scard("BID-#{bid}-batches-complete") r.scard("BID-#{bid}-batches-success") end all_success = pending.to_i.zero? && children == success # if complete or successfull call complete callback (the complete callback may then call successful) if (pending.to_i == failed.to_i && children == complete) || all_success self.class.enqueue_callbacks(:complete, bid) self.class.enqueue_callbacks(:success, bid) if all_success end end |
#on(event, callback, options = {}) ⇒ Object
86 87 88 89 90 91 92 93 94 95 96 |
# File 'lib/canvas_sync/job_batches/batch.rb', line 86 def on(event, callback, = {}) return unless Callback::VALID_CALLBACKS.include?(event.to_s) callback_key = "#{@bidkey}-callbacks-#{event}" redis.multi do |r| r.sadd(callback_key, JSON.unparse({ callback: callback, opts: })) r.expire(callback_key, BID_EXPIRE_TTL) end end |
#parent ⇒ Object
149 150 151 152 153 |
# File 'lib/canvas_sync/job_batches/batch.rb', line 149 def parent if parent_bid Batch.new(parent_bid) end end |
#parent_bid ⇒ Object
145 146 147 |
# File 'lib/canvas_sync/job_batches/batch.rb', line 145 def parent_bid redis.hget(@bidkey, "parent_bid") end |
#save_context_changes ⇒ Object
82 83 84 |
# File 'lib/canvas_sync/job_batches/batch.rb', line 82 def save_context_changes @context&.save! end |
#valid?(batch = self) ⇒ Boolean
155 156 157 158 |
# File 'lib/canvas_sync/job_batches/batch.rb', line 155 def valid?(batch = self) valid = !redis.exists?("invalidated-bid-#{batch.bid}") batch.parent ? valid && valid?(batch.parent) : valid end |