canvas_sync 0.17.3.beta3 → 0.17.6.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 54feabc8f9154b633a70a11d15bfeebaf54ab9d9eb24b9a636c27844728ca1a3
-  data.tar.gz: 0c8d2692a83ebb37a518f61d11fb2970b3204f3d68c990c721fa23a7365a91b6
+  metadata.gz: ce407ae1dd566665cb8ae02856b61f033001cb25aadb903b5e9261846ad9e0c0
+  data.tar.gz: 349fa1f9e033101be253f2d5e5b8212f243a9ea28d143e683d6b2b6a877fcac6
 SHA512:
-  metadata.gz: 50efdad1e463d363463b72fa2fcc5581f877bdeb2c2440d688b10f451321996d95c7acd610d822fcc943d0220ed5520f4963de12341c1adb4238d131c5d8df04
-  data.tar.gz: 51d40bc898a58a0aab65a85d4c1820ca5da72bf22b4c11e0ee631ad2e815dc344dc4824a2ade24e7485ace7ad0d12692d71cc93054afcfc05269ac22a4f7b4c9
+  metadata.gz: 32f2b3b973fdeec88c0a231112c3b82a275baa97937d3788b865d4eb50147a973022e77271970c3c58eab8a4ddbc4bdf10108d7f4f2df2f13c098d007d3bab67
+  data.tar.gz: 854ab10f0092ca6edfb280429c6cb600d8192a5c1189078ecca45a19ec3301c7e6afc3fdceec638ead82e17eab523e5669da010a42cd34761c7753dd06a0d7fb

data/lib/canvas_sync/job_batches/batch.rb

@@ -99,7 +99,7 @@ module CanvasSync
               if parent_bid
                 r.hincrby("BID-#{parent_bid}", "children", 1)
                 r.expire("BID-#{parent_bid}", BID_EXPIRE_TTL)
-                r.sadd("BID-#{parent_bid}-bids", bid)
+                r.zadd("BID-#{parent_bid}-bids", created_at, bid)
               end
             end
           end
@@ -151,6 +151,42 @@ module CanvasSync
         batch.parent ? valid && valid?(batch.parent) : valid
       end
 
+      def keep_open!
+        if block_given?
+          begin
+            keep_open!
+            yield
+          ensure
+            let_close!
+          end
+        else
+          redis do |r|
+            r.hset(@bidkey, 'keep_open', true)
+          end
+        end
+      end
+
+      def let_close!
+        _, failed, pending, children, complete, success = redis do |r|
+          r.multi do
+            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
+        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
+
       def self.with_batch(batch)
         batch = self.new(batch) if batch.is_a?(String)
         parent = Thread.current[:batch]
@@ -171,6 +207,13 @@ module CanvasSync
         @bidkey
       end
 
+      def flush_pending_attrs
+        super
+        redis do |r|
+          r.zadd("batches", created_at, bid)
+        end
+      end
+
       private
 
       def assert_batch_is_open
@@ -184,15 +227,16 @@ module CanvasSync
 
       def append_jobs(jids)
         jids = jids.uniq
+        return unless jids.size > 0
+
         redis do |r|
+          tme = Time.now.utc.to_f
+          added = r.zadd(@bidkey + "-jids", jids.map{|jid| [tme, jid] }, nx: true)
           r.multi do
-            r.hincrby(@bidkey, "pending", jids.size)
+            r.hincrby(@bidkey, "pending", added)
+            r.hincrby(@bidkey, "job_count", added)
             r.expire(@bidkey, BID_EXPIRE_TTL)
-
-            if jids.size > 0
-              r.sadd(@bidkey + "-jids", jids)
-              r.expire(@bidkey + "-jids", BID_EXPIRE_TTL)
-            end
+            r.expire(@bidkey + "-jids", BID_EXPIRE_TTL)
           end
         end
       end
@@ -200,6 +244,8 @@ module CanvasSync
       class << self
         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.sadd("BID-#{bid}-failed", jid)
 
@@ -220,6 +266,8 @@ module CanvasSync
 
         def process_dead_job(bid, jid)
           _, failed, children, complete, parent_bid = redis do |r|
+            return unless r.exists?("BID-#{bid}")
+
             r.multi do
               r.sadd("BID-#{bid}-dead", jid)
 
@@ -245,7 +293,9 @@ module CanvasSync
         end
 
         def process_successful_job(bid, jid)
-          _, failed, pending, children, complete, success, parent_bid = redis do |r|
+          _, failed, pending, children, complete, success, parent_bid, keep_open = redis do |r|
+            return unless r.exists?("BID-#{bid}")
+
             r.multi do
               r.srem("BID-#{bid}-failed", jid)
 
@@ -255,15 +305,14 @@ module CanvasSync
               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.srem("BID-#{bid}-jids", jid)
+              r.zrem("BID-#{bid}-jids", jid)
               r.expire("BID-#{bid}", BID_EXPIRE_TTL)
             end
           end
 
-          # TODO - There seems to be an issue where a :complete callback batch will occasionally run its job, but won't enqueue_callbacks()
-
           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
@@ -277,6 +326,7 @@ module CanvasSync
           callback_key = "#{batch_key}-callbacks-#{event}"
           already_processed, _, 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.hget(batch_key, event)
               r.hset(batch_key, event, true)
@@ -302,6 +352,11 @@ module CanvasSync
           if callback_args.present? && !callback_params.present?
             logger.debug {"Enqueue callback bid: #{bid} event: #{event} args: #{callback_args.inspect}"}
 
+            redis do |r|
+              r.sadd("#{batch_key}-pending_callbacks", event)
+              r.expire("#{batch_key}-pending_callbacks", BID_EXPIRE_TTL)
+            end
+
             with_batch(parent_bid) do
               cb_batch = self.new
               cb_batch.callback_params = {
@@ -330,7 +385,8 @@ module CanvasSync
         def cleanup_redis(bid)
           logger.debug {"Cleaning redis of batch #{bid}"}
           redis do |r|
-            r.del(
+            r.zrem("batches", bid)
+            r.unlink(
               "BID-#{bid}",
               "BID-#{bid}-callbacks-complete",
               "BID-#{bid}-callbacks-success",
@@ -341,10 +397,21 @@ module CanvasSync
               "BID-#{bid}-batches-failed",
               "BID-#{bid}-bids",
               "BID-#{bid}-jids",
+              "BID-#{bid}-pending_callbacks",
             )
           end
         end
 
+        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
+
         def redis(*args, &blk)
           defined?(::Sidekiq) ? ::Sidekiq.redis(*args, &blk) : nil # TODO
         end
@@ -353,8 +420,6 @@ module CanvasSync
           defined?(::Sidekiq) ? ::Sidekiq.logger : Rails.logger
         end
 
-        private
-
         def push_callbacks(args, queue)
           Batch::Callback::worker_class.enqueue_all(args, queue)
         end

data/lib/canvas_sync/job_batches/batch_aware_job.rb

@@ -10,7 +10,7 @@ module CanvasSync
             begin
               Thread.current[:batch] = Batch.new(@bid)
               block.call
-              batch&.save_context_changes
+              Thread.current[:batch].save_context_changes
               Batch.process_successful_job(@bid, job_id)
             rescue
               Batch.process_failed_job(@bid, job_id)

data/lib/canvas_sync/job_batches/callback.rb

@@ -52,9 +52,6 @@ module CanvasSync
 
         class Finalize
           def dispatch(status, opts)
-            is_callback_batch = opts['origin'].present?
-            has_callback_batch = opts['callback_bid'].present?
-
             bid = opts["bid"]
             event = opts["event"].to_sym
 
@@ -63,12 +60,21 @@ module CanvasSync
             batch_status = Status.new bid
             send(event, bid, batch_status, batch_status.parent_bid)
 
-            if event == :success && !has_callback_batch
-              Batch.cleanup_redis(bid)
-            end
-
-            if event == :success && is_callback_batch && opts['origin']['event'].to_sym == :success
-              Batch.cleanup_redis(opts['origin']['for_bid'])
+            if event == :success
+              if opts['origin'].present?
+                origin_bid = opts['origin']['for_bid']
+                _, pending, success_ran = Batch.redis do |r|
+                  r.multi do
+                    r.srem("BID-#{origin_bid}-pending_callbacks", opts['origin']['event'])
+                    r.scard("BID-#{origin_bid}-pending_callbacks")
+                    r.hget("BID-#{origin_bid}", "success")
+                  end
+                end
+                Batch.cleanup_redis(origin_bid) if pending == 0 && success_ran == 'true'
+              end
+              if (Batch.redis {|r| r.scard("BID-#{bid}-pending_callbacks") }) == 0
+                Batch.cleanup_redis(bid)
+              end
             end
           end
 
@@ -113,13 +119,7 @@ module CanvasSync
               end
             end
 
-            # If the batch was successful run :success callback, which will call the parent's :complete callback (if necessary)
-            # Also, only trigger the success callback if the :complete callback_batch was successful
-            if pending.to_i.zero? && children == success
-              # Batch.enqueue_callbacks(:success, bid)
-
-            # otherwise check for a parent and call its :complete if needed
-            elsif parent_bid
+            if parent_bid && !(pending.to_i.zero? && children == success)
               # if batch was not successfull check and see if its parent is complete
               # if the parent is complete we trigger the complete callback
               # We don't want to run this if the batch was successfull because the success

data/lib/canvas_sync/job_batches/context_hash.rb

@@ -28,6 +28,10 @@ module CanvasSync
         @hash_map[local_bid]
       end
 
+      def own
+        resolve_hash(@bid_stack[-1]) || {}
+      end
+
       def set_local(new_hash)
         @dirty = true
         local.clear.merge!(new_hash)
@@ -106,7 +110,8 @@ module CanvasSync
           @bid_stack[index]
         else
           pbid = Batch.redis do |r|
-            r.hget("BID-#{bid}", "parent_bid") || r.hget("BID-#{bid}", "callback_for")
+            callback_params = JSON.parse(r.hget("BID-#{bid}", "callback_params") || "{}")
+            callback_params['for_bid'] || r.hget("BID-#{bid}", "parent_bid")
           end
           @bid_stack.unshift(pbid)
           pbid

data/lib/canvas_sync/job_batches/pool.rb

@@ -24,6 +24,7 @@ module CanvasSync
       end
 
       def self.from_pid(pid)
+        raise "PID must be given" unless pid.present?
         new(pid)
       end
 
@@ -38,7 +39,7 @@ module CanvasSync
       def add_jobs(job_descs)
         job_descs.each do |job_desc|
           wrapper = Batch.new
-          wrapper.description = "Pool Job Wrapper"
+          wrapper.description = "Pool Job Wrapper (PID: #{pid})"
           checkin_event = (on_failed_job == :wait) ? :success : :complete
           wrapper.on(checkin_event, "#{self.class.to_s}.job_checked_in", pool_id: pid)
           wrapper.jobs {}
@@ -54,24 +55,77 @@ module CanvasSync
         refill_allotment
       end
 
+      def keep_open!
+        if block_given?
+          begin
+            keep_open!
+            yield
+          ensure
+            let_close!
+          end
+        else
+          redis do |r|
+            r.hset(redis_key, 'keep_open', true)
+          end
+        end
+      end
+
+      def let_close!
+        _, active_count = redis do |r|
+          r.multi do
+            r.hset(redis_key, 'keep_open', false)
+            r.hincrby(redis_key, "active_count", 0)
+          end
+        end
+
+        if active_count == 0 && pending_count == 0
+          cleanup_redis if clean_when_empty
+        end
+      end
+
       def cleanup_redis
         Batch.logger.debug {"Cleaning redis of pool #{pid}"}
         redis do |r|
-          r.del(
+          r.zrem("pools", pid)
+          r.unlink(
             "#{redis_key}",
             "#{redis_key}-jobs",
           )
         end
       end
 
+      def active_count
+        redis do |r|
+          r.hincrby(redis_key, "active_count", 0)
+        end
+      end
+
+      def pending_count
+        jobs_key = "#{redis_key}-jobs"
+        order = self.order || 'fifo'
+        redis do |r|
+          case order.to_sym
+          when :fifo, :lifo
+            r.llen(jobs_key)
+          when :random
+            r.scard(jobs_key)
+          when :priority
+            r.zcard(jobs_key)
+          end
+        end
+      end
+
       def job_checked_in(status, options)
         active_count = redis do |r|
+          return unless r.exists?(redis_key)
           r.hincrby(redis_key, "active_count", -1)
         end
-        added_count = refill_allotment
 
+        added_count = refill_allotment
         if active_count == 0 && added_count == 0
-          cleanup_redis if clean_when_empty
+          if clean_when_empty && redis {|r| r.hget(redis_key, 'keep_open') } != 'true'
+            cleanup_redis
+          end
         end
       end
 
@@ -159,29 +213,25 @@ module CanvasSync
         ActiveJob::Arguments.deserialize(JSON.parse(job_json))[0]
       end
 
-      def pending_count
-        order = self.order
-        redis do |r|
-          case order.to_sym
-          when :fifo, :lifo
-            r.llen(jobs_key)
-          when :random
-            r.scard(jobs_key)
-          when :priority
-            r.zcard(jobs_key)
-          end
-        end
-      end
-
       def self.redis(&blk)
         Batch.redis &blk
       end
       delegate :redis, to: :class
 
+      protected
+
+      def flush_pending_attrs
+        super
+        redis do |r|
+          r.zadd("pools", created_at, pid)
+        end
+      end
+
       private
 
-      def initialize_new(concurrency: nil, order: :fifo, clean_when_empty: true, on_failed_job: :wait)
+      def initialize_new(concurrency: nil, order: :fifo, clean_when_empty: true, on_failed_job: :wait, description: nil)
         self.created_at = Time.now.utc.to_f
+        self.description = description
         self.order = order
         self.concurrency = concurrency
         self.clean_when_empty = clean_when_empty

data/lib/canvas_sync/job_batches/sidekiq.rb

@@ -57,16 +57,17 @@ module CanvasSync
       class ServerMiddleware
         def call(_worker, msg, _queue)
           if (bid = msg['bid'])
+            prev_batch = Thread.current[:batch]
             begin
               Thread.current[:batch] = Batch.new(bid)
               yield
-              Thread.current[:batch] = nil
+              Thread.current[:batch].save_context_changes
               Batch.process_successful_job(bid, msg['jid'])
             rescue
               Batch.process_failed_job(bid, msg['jid'])
               raise
             ensure
-              Thread.current[:batch] = nil
+              Thread.current[:batch] = prev_batch
             end
           else
             yield
@@ -117,3 +118,5 @@ module CanvasSync
     end
   end
 end
+
+require_relative 'sidekiq/web'