canvas_sync 0.17.35 → 0.17.37

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 43e293e4d64336d70983fbf6eedffb1279252c7d95dfe7a525aa1fa2da5f5463
-  data.tar.gz: b13c557e206b4ea989ff962ad385b0fef0862e67a07626eb8a661faae8c96fd2
+  metadata.gz: aa91c7ca59af567024be0ac8cb9d13ffff059fe7c04fb075101609b3fc78fe4f
+  data.tar.gz: 8f4e9744ed47825c119e4725c506bf8a55a0dca44d045f49c239e272eed3ea7d
 SHA512:
-  metadata.gz: 1866a0aafdc8eac4471c5e498055a64690f99982218d06a0ea14ac5ad8a496df1db6add14012d967a8de61efcdced32a1ec14aa7d5dc07c2a0299dc837cd6f0e
-  data.tar.gz: e16462ec03aa1a207871ab2dee9d0075a349aa09aaa7c8014833e9c4f3abe684a62e124fbdc5a76bd5340b913add521ec4304eae0f449b95c624358c4504c8f3
+  metadata.gz: 9a6213cb2348019af23683bfa1847e6f0025dd81269fe0950f6a0217acd15565d74096cbcc536bdd42eea8d214f1a5e8a67f8fd6f5188a09aa5442d8f7a26ac7
+  data.tar.gz: 8a502df328aff5498bf191bc6b3ef73ed91c32b1bcdf2b0f9aa1ec14ce8f0aaf9c908284c8e51da61b2ce51c97df43af0461c297dcb1b0b48252aab8b0240cad

data/lib/canvas_sync/engine.rb

@@ -5,6 +5,12 @@ module CanvasSync
   class Engine < ::Rails::Engine
     isolate_namespace CanvasSync
 
+    initializer "canvas_sync.serialze_symbols" do |app|
+      app.config.active_record.yaml_column_permitted_classes ||= []
+      app.config.active_record.yaml_column_permitted_classes |= [Symbol]
+    rescue
+    end
+
     initializer :append_migrations do |app|
       config.paths["db/migrate"].expanded.each do |expanded_path|
         app.config.paths["db/migrate"] << expanded_path

data/lib/canvas_sync/job_batches/active_job.rb

@@ -0,0 +1,108 @@
+
+module CanvasSync
+  module JobBatches
+    module ActiveJob
+      module BatchAwareJob
+        extend ActiveSupport::Concern
+
+        included do
+          around_perform do |job, block|
+            if (@bid) # This _must_ be @bid - not just bid
+              prev_batch = Thread.current[CURRENT_BATCH_THREAD_KEY]
+              begin
+                Thread.current[CURRENT_BATCH_THREAD_KEY] = Batch.new(@bid)
+                block.call
+                Thread.current[CURRENT_BATCH_THREAD_KEY].save_context_changes
+                Batch.process_successful_job(@bid, job_id)
+              rescue
+                Batch.process_failed_job(@bid, job_id)
+                raise
+              ensure
+                Thread.current[CURRENT_BATCH_THREAD_KEY] = prev_batch
+              end
+            else
+              block.call
+            end
+          end
+
+          around_enqueue do |job, block|
+            if (batch = Thread.current[CURRENT_BATCH_THREAD_KEY])
+              @bid = batch.bid
+              batch.increment_job_queue(job_id) if @bid
+            end
+            block.call
+          end
+        end
+
+        def bid
+          @bid || Thread.current[CURRENT_BATCH_THREAD_KEY]&.bid
+        end
+
+        def batch
+          Thread.current[CURRENT_BATCH_THREAD_KEY]
+        end
+
+        def batch_context
+          batch&.context || {}
+        end
+
+        def valid_within_batch?
+          batch.valid?
+        end
+
+        def serialize
+          super.tap do |data|
+            data['batch_id'] = @bid # This _must_ be @bid - not just bid
+            data
+          end
+        end
+
+        def deserialize(data)
+          super
+          @bid = data['batch_id']
+        end
+      end
+
+      class ActiveJobCallbackWorker < ::ActiveJob::Base
+        include Batch::Callback::CallbackWorkerCommon
+
+        def self.enqueue_all(args, queue)
+          args.each do |arg_set|
+            set(queue: queue).perform_later(*arg_set)
+          end
+        end
+      end
+
+      def self.handle_job_death(job, error = nil)
+        if job.is_a?(Array)
+          event = ActiveSupport::Notifications::Event.new(*job)
+          payload = event.payload
+          job = payload[:job].serialize
+          error = payload[:error]
+        end
+
+        if job["job_id"].present? && job["batch_id"].present?
+          CanvasSync::JobBatches::Batch.process_dead_job(job['batch_id'], job['job_id'])
+        end
+      end
+
+      def self.configure
+        ::ActiveJob::Base.include BatchAwareJob
+
+        begin
+          ActiveSupport::Notifications.subscribe "discard.active_job" do |*args|
+            handle_job_death(args)
+          end
+
+          ActiveSupport::Notifications.subscribe "retry_stopped.active_job" do |*args|
+            handle_job_death(args)
+          end
+        rescue => err
+          Rails.logger.warn(err)
+        end
+
+        Batch::Callback.worker_class ||= ActiveJobCallbackWorker
+      end
+    end
+  end
+end

data/lib/canvas_sync/job_batches/batch.rb

@@ -6,7 +6,6 @@ end
 
 require_relative './redis_model'
 require_relative './redis_script'
-require_relative './batch_aware_job'
 require_relative "./callback"
 require_relative "./context_hash"
 require_relative "./status"
@@ -465,7 +464,7 @@ module CanvasSync
             when 'set'
               r.smembers(key)
             when 'zset'
-              r.smembers(key, 0, -1)
+              r.zrange(key, 0, -1)
             end
           end
         end
@@ -481,8 +480,6 @@ module CanvasSync
         end
       end
     end
-
-    ActiveJob::Base.include BatchAwareJob
   end
 end
 
@@ -491,3 +488,9 @@ if defined?(::Sidekiq)
   require_relative './sidekiq'
   CanvasSync::JobBatches::Sidekiq.configure
 end
+
+# Automatically integrate with ActiveJob if it is present.
+if defined?(::ActiveJob)
+  require_relative './active_job'
+  CanvasSync::JobBatches::ActiveJob.configure
+end

data/lib/canvas_sync/job_batches/callback.rb

@@ -38,24 +38,12 @@ module CanvasSync
           end
         end
 
-        class ActiveJobCallbackWorker < ActiveJob::Base
-          include CallbackWorkerCommon
-
-          def self.enqueue_all(args, queue)
-            args.each do |arg_set|
-              set(queue: queue).perform_later(*arg_set)
-            end
-          end
-        end
-
-        worker_class = ActiveJobCallbackWorker
-
         class Finalize
           def dispatch(status, opts)
             bid = opts["bid"]
             event = opts["event"].to_sym
 
-            Batch.logger.debug {"Finalize #{event} batch id: #{opts["bid"]}, callback batch id: #{callback_bid} callback_batch #{is_callback_batch}"}
+            Batch.logger.debug {"Finalize #{event} batch id: #{opts["bid"]}"}
 
             batch_status = Status.new bid
             send(event, bid, batch_status, batch_status.parent_bid)

data/lib/canvas_sync/job_batches/jobs/base_job.rb

@@ -1,6 +1,6 @@
 module CanvasSync
   module JobBatches
-    class BaseJob < ActiveJob::Base
+    class BaseJob < ::ActiveJob::Base
 
     end
   end

data/lib/canvas_sync/job_batches/jobs/managed_batch_job.rb

@@ -26,7 +26,7 @@ module CanvasSync
 
               mapped_sub_jobs = sub_jobs.each_with_index.map do |j, i|
                 j['_mngbid_index_'] = i # This allows duplicate jobs when a Redis Set is used
-                j = ActiveJob::Arguments.serialize([j])
+                j = ::ActiveJob::Arguments.serialize([j])
                 JSON.unparse(j)
               end
               if ordered
@@ -104,7 +104,7 @@ module CanvasSync
         return unless next_job_json.present?
 
         next_job = JSON.parse(next_job_json)
-        next_job = ActiveJob::Arguments.deserialize(next_job)[0]
+        next_job = ::ActiveJob::Arguments.deserialize(next_job)[0]
 
         Batch.new(root_bid).jobs do
           Batch.new.tap do |batch|

data/lib/canvas_sync/job_batches/pool.rb

@@ -171,7 +171,7 @@ module CanvasSync
         jobs_key = "#{redis_key}-jobs"
         # This allows duplicate jobs when a Redis Set is used
         job_desc[:_pool_random_key_] = SecureRandom.urlsafe_base64(10)
-        job_json = JSON.unparse(ActiveJob::Arguments.serialize([job_desc]))
+        job_json = JSON.unparse(::ActiveJob::Arguments.serialize([job_desc]))
         order = self.order
 
         redis.multi do |r|
@@ -204,7 +204,7 @@ module CanvasSync
 
         return nil unless job_json.present?
 
-        ActiveJob::Arguments.deserialize(JSON.parse(job_json))[0]&.symbolize_keys
+        ::ActiveJob::Arguments.deserialize(JSON.parse(job_json))[0]&.symbolize_keys
       end
 
       def self.redis(&blk)

data/lib/canvas_sync/job_batches/sidekiq.rb

@@ -49,7 +49,7 @@ module CanvasSync
         end
 
         def should_handle_batch?(msg)
-          return false if msg['class'] == 'ActiveJob::QueueAdapters::SidekiqAdapter::JobWrapper' && (msg['wrapped'].to_s).constantize < BatchAwareJob
+          return false if JobBatches::Sidekiq.is_activejob_job?(msg)
           true
         end
       end
@@ -75,6 +75,22 @@ module CanvasSync
         end
       end
 
+      def self.is_activejob_job?(msg)
+        return false unless defined?(::ActiveJob)
+
+        msg['class'] == 'ActiveJob::QueueAdapters::SidekiqAdapter::JobWrapper' && (msg['wrapped'].to_s).constantize < JobBatches::ActiveJob::BatchAwareJob
+      end
+
+      def self.switch_tenant(job)
+        if defined?(::Apartment)
+          ::Apartment::Tenant.switch(job['apartment'] || 'public') do
+            yield
+          end
+        else
+          yield
+        end
+      end
+
       def self.configure
         if defined?(::Sidekiq::Batch) && ::Sidekiq::Batch != JobBatches::Batch
           print "WARNING: Detected Sidekiq Pro or sidekiq-batch. CanvasSync JobBatches may not be fully compatible!"
@@ -98,14 +114,12 @@ module CanvasSync
           end
 
           config.death_handlers << ->(job, ex) do
-            return unless job['bid'].present?
-
-            if defined?(::Apartment)
-              ::Apartment::Tenant.switch(job['apartment'] || 'public') do
+            switch_tenant(job) do
+              if is_activejob_job?(job)
+                JobBatches::ActiveJob.handle_job_death(job["args"][0], ex)
+              elsif job['bid'].present?
                 ::Sidekiq::Batch.process_dead_job(job['bid'], job['jid'])
               end
-            else
-              ::Sidekiq::Batch.process_dead_job(job['bid'], job['jid'])
             end
           end
         end

data/lib/canvas_sync/version.rb

@@ -1,3 +1,3 @@
 module CanvasSync
-  VERSION = "0.17.35".freeze
+  VERSION = "0.17.37".freeze
 end