canvas_sync 0.17.3.beta2 → 0.17.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 416545a03622711eba78ef420fd07aff9eb1e56ee9536b9e12369406885079c5
-  data.tar.gz: e9cabdc870f0903bcffc60f711c0ed34a5b471d1bbdf1d8a2a4d83ce9ac745a4
+  metadata.gz: 99d4cd616a9692a100cfea8f3a3342e031f898311e211052f46eb16ee80c4bf1
+  data.tar.gz: 0d1b48e269c183b3c4df489439766474d2e31773d2743d55006a29e06d6e78ff
 SHA512:
-  metadata.gz: 020ba0e260823c40a21273c3bda767c9774207fa36bf7e639d0927db19d544a27b1fefcebfdd64e2b4445ba5ca526098229d95e4c3ee7f5f6e336ef42da8a1f6
-  data.tar.gz: 1840797de37257526d002507fe1849c84cd5cc71ed5bbb176a93061dce8d4c25e85528ec7312a3215e9520bcf4f708ac8cf5834539fdac4a7810919700844d33
+  metadata.gz: 17d7319ed2f35611f19428b85a823f218962fab5f843db9c8372e372bfa67c2267ecf4328134052857d2c157474bac36c34aa8b5b4ab7ba8598f28369b37efdf
+  data.tar.gz: 74d1cc1807dd95b75acda579bd9b7e0c42dd7fbfd0a3a4d7d3b6b5c08e277cc5a7661b15a63940170290d83049636433833b388a71788d7b73166deaf4bfe541

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
@@ -171,12 +171,19 @@ 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
         unless defined?(@closed)
           redis do |r|
-            @closed = r.hget(@bidkey, 'closed') == 'true'
+            @closed = r.hget(@bidkey, 'success') == 'true'
           end
         end
         raise "Cannot add jobs to Batch #{} bid - it has already entered the callback-stage" if @closed
@@ -184,15 +191,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 +208,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 +230,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)
 
@@ -246,6 +258,8 @@ module CanvasSync
 
         def process_successful_job(bid, jid)
           _, failed, pending, children, complete, success, parent_bid = redis do |r|
+            return unless r.exists?("BID-#{bid}")
+
             r.multi do
               r.srem("BID-#{bid}-failed", jid)
 
@@ -256,13 +270,12 @@ module CanvasSync
               r.scard("BID-#{bid}-batches-success")
               r.hget("BID-#{bid}", "parent_bid")
 
-              r.srem("BID-#{bid}-jids", jid)
+              r.hincrby("BID-#{bid}", "successful-jobs", 1)
+              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
@@ -271,29 +284,13 @@ module CanvasSync
           end
         end
 
-        def possibly_enqueue_callbacks(bid, types: [:complete, :success])
-          pending_jobs, failed_jobs, total_batches, completed_batches, successful_batches = redis do |r|
-            r.multi do
-
-            end
-          end
-
-          if (types.include?(:complete)) && (pending_jobs.to_i == failed_jobs.to_i && total_batches.to_i == completed_batches.to_i)
-            enqueue_callbacks(:complete, bid)
-          end
-          if (types.include?(:success)) && (pending_jobs.to_i.zero? && total_batches.to_i == successful_batches.to_i)
-            enqueue_callbacks(:success, bid)
-          end
-        end
-
         def enqueue_callbacks(event, bid)
           batch_key = "BID-#{bid}"
           callback_key = "#{batch_key}-callbacks-#{event}"
-          already_processed, _, _, callbacks, queue, parent_bid, callback_params = redis do |r|
+          already_processed, _, callbacks, queue, parent_bid, callback_params = redis do |r|
             return unless r.exists?(batch_key)
             r.multi do
               r.hget(batch_key, event)
-              r.hset(batch_key, "closed", true)
               r.hset(batch_key, event, true)
               r.smembers(callback_key)
               r.hget(batch_key, "callback_queue")
@@ -317,6 +314,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 = {
@@ -345,7 +347,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",
@@ -356,10 +359,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
@@ -368,8 +382,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,19 +60,28 @@ 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
 
           def success(bid, status, parent_bid)
             return unless parent_bid
 
-            _, _, success, _, _, complete, pending, children, failure = Batch.redis do |r|
+            _, _, success, _, _, complete, pending, children, success, failure = Batch.redis do |r|
               r.multi do
                 r.sadd("BID-#{parent_bid}-batches-success", bid)
                 r.expire("BID-#{parent_bid}-batches-success", Batch::BID_EXPIRE_TTL)
@@ -87,6 +93,7 @@ module CanvasSync
 
                 r.hincrby("BID-#{parent_bid}", "pending", 0)
                 r.hincrby("BID-#{parent_bid}", "children", 0)
+                r.scard("BID-#{parent_bid}-batches-success")
                 r.scard("BID-#{parent_bid}-failed")
               end
             end
@@ -97,6 +104,10 @@ module CanvasSync
               Batch.logger.debug {"Finalize parent complete bid: #{parent_bid}"}
               Batch.enqueue_callbacks(:complete, parent_bid)
             end
+            if pending.to_i.zero? && children == success
+              Batch.logger.debug {"Finalize parent success bid: #{parent_bid}"}
+              Batch.enqueue_callbacks(:success, parent_bid)
+            end
           end
 
           def complete(bid, status, parent_bid)
@@ -108,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

@@ -10,7 +10,7 @@ module CanvasSync
       redis_attr :created_at
       redis_attr :concurrency, :int
       redis_attr :order
-      redis_attr :on_failed_job
+      redis_attr :on_failed_job, :symbol
       redis_attr :clean_when_empty, :bool
 
       def initialize(pooolid = nil, **kwargs)
@@ -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 {}
@@ -57,19 +58,42 @@ module CanvasSync
       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
         end
@@ -159,29 +183,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/redis_model.rb

@@ -27,6 +27,8 @@ module CanvasSync
                   value = value.to_f
                 elsif :#{type} == :json
                   value = JSON.parse(value)
+                elsif :#{type} == :symbol
+                  value = value&.to_sym
                 end
                 @#{key} = value
               end

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'

data/lib/canvas_sync/job_batches/sidekiq/web.rb

@@ -0,0 +1,114 @@
+
+begin
+  require "sidekiq/web"
+rescue LoadError
+  # client-only usage
+end
+
+require_relative "web/helpers"
+
+module CanvasSync::JobBatches::Sidekiq
+  module Web
+    def self.registered(app) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+      app.helpers do
+        include Web::Helpers
+      end
+
+      app.get "/batches" do
+        @count = (params['count'] || 25).to_i
+        @current_page, @total_size, @batches = page('batches', params['page'], @count)
+        @batches = @batches.map {|b, score| CanvasSync::JobBatches::Batch.new(b) }
+
+        erb(get_template(:batches))
+      end
+
+      app.get "/batches/:bid" do
+        @bid = params[:bid]
+        @batch = CanvasSync::JobBatches::Batch.new(@bid)
+
+        @count = (params['count'] || 25).to_i
+        @current_batches_page, @total_batches_size, @sub_batches = page("BID-#{@batch.bid}-bids", params['batch_page'], @count)
+        @sub_batches = @sub_batches.map {|b, score| CanvasSync::JobBatches::Batch.new(b) }
+
+        @current_jobs_page, @total_jobs_size, @jobs = page("BID-#{@batch.bid}-jids", params['job_page'], @count)
+        @jobs = @jobs.map {|jid, score| jid }
+
+        erb(get_template(:batch))
+      end
+
+      app.post "/batches/all" do
+        if params['delete']
+          drain_zset('batches') do |batches|
+            batches.each do |bid|
+              CanvasSync::JobBatches::Batch.cleanup_redis(bid)
+            end
+          end
+        end
+
+        redirect "#{root_path}batches"
+      end
+
+      app.post "/batches/:bid" do
+        @bid = params[:bid]
+        @batch = CanvasSync::JobBatches::Batch.new(@bid)
+
+        if params['delete']
+          CanvasSync::JobBatches::Batch.delete_prematurely!(@bid)
+        end
+
+        redirect_with_query("#{root_path}batches")
+      end
+
+      # =============== POOLS =============== #
+
+      app.get "/pools" do
+        @count = (params['count'] || 25).to_i
+        @current_page, @total_size, @pools = page('pools', params['page'], @count)
+        @pools = @pools.map {|b, score| CanvasSync::JobBatches::Pool.new(b) }
+
+        erb(get_template(:pools))
+      end
+
+      app.get "/pools/:pid" do
+        @pid = params[:pid]
+        @pool = CanvasSync::JobBatches::Pool.new(@pid)
+
+        @count = (params['count'] || 25).to_i
+        @current_jobs_page, @total_jobs_size, @jobs = page("POOLID-#{@pool.pid}-jobs", params['job_page'], @count)
+        @jobs = @jobs.map {|desc, score=nil| JSON.parse(desc)[0] }
+
+        erb(get_template(:pool))
+      end
+
+      app.post "/pools/all" do
+        if params['delete']
+          drain_zset('pools') do |pools|
+            pools.each do |pid|
+              CanvasSync::JobBatches::Pool.from_pid(pid).cleanup_redis
+            end
+          end
+        end
+
+        redirect "#{root_path}pools"
+      end
+
+      app.post "/pools/:pid" do
+        @pid = params[:pid]
+        @pool = CanvasSync::JobBatches::Pool.from_pid(@pid)
+
+        if params['delete']
+          @pool.cleanup_redis
+        end
+
+        redirect_with_query("#{root_path}pools")
+      end
+    end
+  end
+end
+
+if defined?(::Sidekiq::Web)
+  ::Sidekiq::Web.register CanvasSync::JobBatches::Sidekiq::Web
+  ::Sidekiq::Web.tabs["Batches"] = "batches"
+  ::Sidekiq::Web.tabs["Pools"] = "pools"
+  ::Sidekiq::Web.settings.locales << File.join(File.dirname(__FILE__), "locales")
+end