acidic_job 1.0.0.beta.10 → 1.0.0.pre1

data/lib/acidic_job/extensions/active_job.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+
+module AcidicJob
+  module Extensions
+    module ActiveJob
+      extend ActiveSupport::Concern
+
+      concerning :Serialization do
+        class_methods do
+          def serialize_with_arguments(*args, **kwargs)
+            job_or_instantiate(*args, **kwargs).serialize
+          end
+        end
+
+        def serialize_job(*_args, **_kwargs)
+          serialize
+        end
+      end
+
+      class_methods do
+        def perform_acidicly(*args, **kwargs)
+          raise UnsupportedExtension unless defined?(::ActiveJob) && self < ::ActiveJob::Base
+
+          serialized_job = serialize_with_arguments(*args, **kwargs)
+
+          AcidicJob::Run.create!(
+            staged: true,
+            job_class: name,
+            serialized_job: serialized_job,
+            idempotency_key: IdempotencyKey.value_for(serialized_job)
+          )
+        end
+        alias_method :perform_transactionally, :perform_acidicly
+      end
+    end
+  end
+end

data/lib/acidic_job/extensions/noticed.rb

@@ -11,10 +11,10 @@ module AcidicJob
         end
       end
 
-      # THIS IS A HACK THAT COPIES AND PASTES KEY PARTS OF THE `Noticed::Base` CODE
-      # IN ORDER TO ALLOW US TO TRANSACTIONALLY DELIVER NOTIFICATIONS
-      # THIS IS THUS LIABLE TO BREAK WHENEVER THAT GEM IS UPDATED
       def deliver_acidicly(recipients)
+        # THIS IS A HACK THAT COPIES AND PASTES KEY PARTS OF THE `Noticed::Base` CODE
+        # IN ORDER TO ALLOW US TO TRANSACTIONALLY DELIVER NOTIFICATIONS
+        # THIS IS THUS LIABLE TO BREAK WHENEVER THAT GEM IS UPDATED
         delivery_methods = self.class.delivery_methods.dup
 
         Array.wrap(recipients).uniq.each do |recipient|
@@ -35,12 +35,18 @@ module AcidicJob
               recipient: recipient,
               record: record
             }
-            job = job_class.new(args)
+            serialized_job = job_class.send(:job_or_instantiate, args).serialize
 
-            AcidicJob::Run.stage!(job)
+            AcidicJob::Run.create!(
+              staged: true,
+              job_class: job_class.name,
+              serialized_job: serialized_job,
+              idempotency_key: IdempotencyKey.value_for(serialized_job)
+            )
           end
         end
       end
+      alias deliver_transactionally deliver_acidicly
     end
   end
 end

data/lib/acidic_job/extensions/sidekiq.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+require "active_support/callbacks"
+require "active_support/core_ext/module/concerning"
+
+module AcidicJob
+  module Extensions
+    module Sidekiq
+      extend ActiveSupport::Concern
+
+      concerning :Serialization do
+        class_methods do
+          # called only from `AcidicJob::Run#enqueue_staged_job`
+          def deserialize(serialized_job_hash)
+            klass = serialized_job_hash["class"].constantize
+            worker = klass.new
+            worker.jid = serialized_job_hash["jid"]
+            worker.instance_variable_set(:@args, serialized_job_hash["args"])
+
+            worker
+          end
+
+          # called only from `AcidicJob::PerformAcidicly#perform_acidicly`
+          # and `AcidicJob::DeliverAcidicly#deliver_acidicly`
+          def serialize_with_arguments(args = [], _kwargs = nil)
+            # THIS IS A HACK THAT ESSENTIALLY COPIES THE CODE FROM THE SIDEKIQ CODEBASE TO MIMIC THE BEHAVIOR
+            args = Array[args]
+            normalized_args = ::Sidekiq.load_json(::Sidekiq.dump_json(args))
+            item = { "class" => self, "args" => normalized_args }
+            dummy_sidekiq_client = ::Sidekiq::Client.new
+            normed = dummy_sidekiq_client.send :normalize_item, item
+            dummy_sidekiq_client.send :process_single, item["class"], normed
+          end
+        end
+
+        def serialize_job(args = [], _kwargs = nil)
+          # `@args` is only set via `deserialize`; it is not a standard Sidekiq thing
+          arguments = args || @args
+          normalized_args = ::Sidekiq.load_json(::Sidekiq.dump_json(arguments))
+          item = { "class" => self.class, "args" => normalized_args, "jid" => jid }
+          sidekiq_options = sidekiq_options_hash || {}
+
+          sidekiq_options.merge(item)
+        end
+
+        # called only from `AcidicJob::Run#enqueue_staged_job`
+        def enqueue
+          ::Sidekiq::Client.push(
+            "class" => self.class,
+            "args" => @args,
+            "jid" => @jid
+          )
+        end
+      end
+
+      concerning :PerformAcidicly do
+        class_methods do
+          def perform_acidicly(*args, **kwargs)
+            serialized_job = serialize_with_arguments(*args, **kwargs)
+
+            AcidicJob::Run.create!(
+              staged: true,
+              job_class: name,
+              serialized_job: serialized_job,
+              idempotency_key: IdempotencyKey.value_for(serialized_job)
+            )
+          end
+          alias_method :perform_transactionally, :perform_acidicly
+        end
+      end
+
+      # to balance `perform_async` class method
+      concerning :PerformSync do
+        class_methods do
+          def perform_sync(*args, **kwargs)
+            new.perform(*args, **kwargs)
+          end
+        end
+      end
+
+      # Following approach used by ActiveJob
+      # https://github.com/rails/rails/blob/93c9534c9871d4adad4bc33b5edc355672b59c61/activejob/lib/active_job/callbacks.rb
+      concerning :Callbacks do
+        class_methods do
+          def around_perform(*filters, &blk)
+            set_callback(:perform, :around, *filters, &blk)
+          end
+
+          def before_perform(*filters, &blk)
+            set_callback(:perform, :before, *filters, &blk)
+          end
+
+          def after_perform(*filters, &blk)
+            set_callback(:perform, :after, *filters, &blk)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/acidic_job/finished_point.rb

@@ -1,14 +1,16 @@
 # frozen_string_literal: true
 
-require_relative "run"
-
 # Represents an action to set a new API response (which will be stored onto an
 # idempotency key). One  possible option for a return from an #atomic_phase
 # block.
 module AcidicJob
   class FinishedPoint
     def call(run:)
-      run.finish!
+      # Skip AR callbacks as there are none on the model
+      run.update_columns(
+        locked_at: nil,
+        recovery_point: Run::FINISHED_RECOVERY_POINT
+      )
     end
   end
 end

data/lib/acidic_job/idempotency_key.rb

@@ -2,26 +2,23 @@
 
 module AcidicJob
   class IdempotencyKey
-    def initialize(job)
-      @job = job
-    end
+    def self.value_for(hash_or_job, *args, **kwargs)
+      return hash_or_job.job_id if hash_or_job.respond_to?(:job_id) && !hash_or_job.job_id.nil?
+      return hash_or_job.jid if hash_or_job.respond_to?(:jid) && !hash_or_job.jid.nil?
 
-    def value(acidic_by: :job_id)
-      case acidic_by
-      when Proc
-        proc_result = @job.instance_exec(&acidic_by)
-        Digest::SHA1.hexdigest [@job.class.name, proc_result].flatten.join
-      when :job_arguments
-        Digest::SHA1.hexdigest [@job.class.name, @job.arguments].flatten.join
-      else
-        if @job.job_id.start_with? Run::STAGED_JOB_ID_PREFIX
-          # "STG__#{idempotency_key}__#{encoded_global_id}"
-          _prefix, idempotency_key, _encoded_global_id = @job.job_id.split("__")
-          idempotency_key
-        else
-          @job.job_id
-        end
+      if hash_or_job.is_a?(Hash) && hash_or_job.key?("job_id") && !hash_or_job["job_id"].nil?
+        return hash_or_job["job_id"]
       end
+      return hash_or_job["jid"] if hash_or_job.is_a?(Hash) && hash_or_job.key?("jid") && !hash_or_job["jid"].nil?
+
+      worker_class = case hash_or_job
+                     when Hash
+                       hash_or_job["worker"] || hash_or_job["job_class"]
+                     else
+                       hash_or_job.class.name
+                     end
+
+      Digest::SHA1.hexdigest [worker_class, args, kwargs].flatten.join
     end
   end
 end

data/lib/acidic_job/perform_wrapper.rb

@@ -2,21 +2,48 @@
 
 module AcidicJob
   # NOTE: it is essential that this be a bare module and not an ActiveSupport::Concern
-  # WHY?
   module PerformWrapper
-    def perform(*args)
-      @arguments = args
+    def perform(*args, **kwargs)
+      super_method = method(:perform).super_method
 
       # we don't want to run the `perform` callbacks twice, since ActiveJob already handles that for us
-      if defined?(ActiveJob) && self.class < ActiveJob::Base
-        super(*args)
-      elsif defined?(Sidekiq) && self.class.include?(Sidekiq::Worker)
-        run_callbacks :perform do
-          super(*args)
-        end
+      if aj_job?
+        __acidic_job_perform_for_aj(super_method, *args, **kwargs)
+      elsif sk_job?
+        __acidic_job_perform_for_sk(super_method, *args, **kwargs)
       else
         raise UnknownJobAdapter
       end
     end
+
+    def sk_job?
+      defined?(Sidekiq) && self.class.include?(Sidekiq::Worker)
+    end
+
+    def aj_job?
+      defined?(ActiveJob) && self.class < ActiveJob::Base
+    end
+
+    private
+
+    # don't run `perform` callbacks, as ActiveJob already does this
+    def __acidic_job_perform_for_aj(super_method, *args, **kwargs)
+      __acidic_job_perform_base(super_method, *args, **kwargs)
+    end
+
+    # ensure to run `perform` callbacks
+    def __acidic_job_perform_for_sk(super_method, *args, **kwargs)
+      run_callbacks :perform do
+        __acidic_job_perform_base(super_method, *args, **kwargs)
+      end
+    end
+
+    # capture arguments passed to `perform` to be used by AcidicJob later
+    def __acidic_job_perform_base(super_method, *args, **kwargs)
+      @__acidic_job_args = args
+      @__acidic_job_kwargs = kwargs
+
+      super_method.call(*args, **kwargs)
+    end
   end
 end

data/lib/acidic_job/recovery_point.rb

@@ -4,14 +4,15 @@
 # return from an #atomic_phase block.
 module AcidicJob
   class RecoveryPoint
-    attr_reader :name
+    attr_accessor :name
 
     def initialize(name)
       @name = name
     end
 
     def call(run:)
-      run.recover_to!(@name)
+      # Skip AR callbacks as there are none on the model
+      run.update_column(:recovery_point, @name)
     end
   end
 end

data/lib/acidic_job/run.rb

@@ -2,302 +2,76 @@
 
 require "active_record"
 require "global_id"
-require "base64"
 require "active_support/core_ext/object/with_options"
-require "active_support/core_ext/module/concerning"
-require "active_support/concern"
 
 module AcidicJob
   class Run < ActiveRecord::Base
     include GlobalID::Identification
 
     FINISHED_RECOVERY_POINT = "FINISHED"
-    STAGED_JOB_ID_PREFIX = "STG"
-    STAGED_JOB_ID_DELIMITER = "__"
-    IDEMPOTENCY_KEY_LOCK_TIMEOUT_SECONDS = 2
 
     self.table_name = "acidic_job_runs"
 
-    validates :idempotency_key, presence: true
-    validate :not_awaited_but_unstaged
+    after_create_commit :enqueue_staged_job, if: :staged?
 
-    def self.clear_finished
-      # over-write any pre-existing relation queries on `recovery_point` and/or `error_object`
-      to_purge = finished
+    serialize :error_object
+    serialize :serialized_job
+    serialize :workflow
+    store :attr_accessors
 
-      count = to_purge.count
+    validates :staged, inclusion: { in: [true, false] } # uses database default
+    validates :serialized_job, presence: true
+    validates :idempotency_key, presence: true, uniqueness: true
+    validates :job_class, presence: true
 
-      return 0 if count.zero?
+    scope :staged, -> { where(staged: true) }
+    scope :unstaged, -> { where(staged: false) }
+    scope :finished, -> { where(recovery_point: FINISHED_RECOVERY_POINT) }
+    scope :running, -> { where.not(recovery_point: FINISHED_RECOVERY_POINT) }
 
-      AcidicJob.logger.info("Deleting #{count} finished AcidicJob runs")
-      to_purge.delete_all
+    with_options unless: :staged? do
+      validates :last_run_at, presence: true
+      validates :recovery_point, presence: true
+      validates :workflow, presence: true
     end
 
-    def succeeded?
-      finished? && !errored?
+    def finished?
+      recovery_point == FINISHED_RECOVERY_POINT
     end
 
-    concerning :Awaitable do
-      included do
-        belongs_to :awaited_by, class_name: "AcidicJob::Run", optional: true
-        has_many :batched_runs, class_name: "AcidicJob::Run", foreign_key: "awaited_by_id"
-
-        scope :awaited, -> { where.not(awaited_by: nil) }
-        scope :unawaited, -> { where(awaited_by: nil) }
-
-        after_update_commit :proceed_with_parent, if: :finished?
-
-        serialize :returning_to, AcidicJob::Serializer
-      end
-
-      class_methods do
-        def await!(job, by:, return_to:)
-          create!(
-            staged: true,
-            awaited_by: by,
-            job_class: job.class.name,
-            serialized_job: job.serialize,
-            idempotency_key: job.idempotency_key
-          )
-          by.update(returning_to: return_to)
-        end
-      end
-
-      def awaited?
-        awaited_by.present?
-      end
-
-      private
-
-      def proceed_with_parent
-        return unless finished?
-        return unless awaited_by.present?
-        return if awaited_by.batched_runs.outstanding.any?
-
-        AcidicJob.logger.log_run_event("Proceeding with parent job...", job, self)
-        awaited_by.unlock!
-        awaited_by.proceed
-        AcidicJob.logger.log_run_event("Proceeded with parent job.", job, self)
-      end
-
-      protected
-
-      def proceed
-        # this needs to be explicitly set so that `was_workflow_job?` appropriately returns `true`
-        # TODO: replace this with some way to check the type of the job directly
-        # either via class method or explicit module inclusion
-        job.instance_variable_set(:@acidic_job_run, self)
-
-        workflow = Workflow.new(self, job, returning_to)
-        # TODO: WRITE REGRESSION TESTS FOR PARALLEL JOB FAILING AND RETRYING THE ORIGINAL STEP
-        workflow.progress_to_next_step
-
-        # when a batch of jobs for a step succeeds, we begin processing the `AcidicJob::Run` record again
-        return if finished?
-
-        AcidicJob.logger.log_run_event("Re-enqueuing parent job...", job, self)
-        enqueue_job
-        AcidicJob.logger.log_run_event("Re-enqueued parent job.", job, self)
-      end
-    end
-
-    concerning :Stageable do
-      included do
-        after_create_commit :enqueue_job, if: :staged?
-
-        validates :staged, inclusion: { in: [true, false] } # uses database default
-
-        scope :staged, -> { where(staged: true) }
-        scope :unstaged, -> { where(staged: false) }
-      end
-
-      class_methods do
-        def stage!(job)
-          create!(
-            staged: true,
-            job_class: job.class.name,
-            serialized_job: job.serialize,
-            idempotency_key: job.try(:idempotency_key) || job.job_id
-          )
-        end
-      end
-
-      private
-
-      def job_id
-        return idempotency_key unless staged?
-
-        # encode the identifier for this record in the job ID
-        global_id = to_global_id.to_s.remove("gid://")
-        # base64 encoding for minimal security
-        encoded_global_id = Base64.urlsafe_encode64(global_id, padding: false)
-
-        [
-          STAGED_JOB_ID_PREFIX,
-          idempotency_key,
-          encoded_global_id
-        ].join(STAGED_JOB_ID_DELIMITER)
-      end
-    end
-
-    concerning :Workflowable do
-      included do
-        serialize :workflow, AcidicJob::Serializer
-        serialize :error_object, AcidicJob::Serializer
-        store :attr_accessors, coder: AcidicJob::Serializer
-
-        with_options unless: :staged? do
-          validates :last_run_at, presence: true
-          validates :recovery_point, presence: true
-          validates :workflow, presence: true
-        end
-      end
-
-      def workflow?
-        self[:workflow].present?
-      end
-
-      def attr_accessors
-        self[:attr_accessors] || {}
-      end
-
-      def current_step_name
-        recovery_point
-      end
-
-      def current_step_hash
-        workflow[current_step_name]
-      end
-
-      def next_step_name
-        current_step_hash.fetch("then")
-      end
-
-      def current_step_awaits
-        current_step_hash["awaits"]
-      end
-
-      def next_step_finishes?
-        next_step_name.to_s == FINISHED_RECOVERY_POINT
-      end
-
-      def current_step_finished?
-        current_step_name.to_s == FINISHED_RECOVERY_POINT
-      end
-    end
-
-    concerning :Jobbable do
-      included do
-        serialize :serialized_job, JSON
-
-        validates :serialized_job, presence: true
-        validates :job_class, presence: true
-      end
-
-      def job
-        return @job if defined? @job
-
-        serialized_job_for_run = serialized_job.merge("job_id" => job_id)
-        job_class_for_run = job_class.constantize
-
-        @job = job_class_for_run.deserialize(serialized_job_for_run)
-      end
-
-      def enqueue_job
-        job.enqueue
-
-        # NOTE: record will be deleted after the job has successfully been performed
-        true
-      end
-    end
-
-    concerning :Finishable do
-      included do
-        scope :finished, -> { where(recovery_point: FINISHED_RECOVERY_POINT) }
-        scope :outstanding, lambda {
-                              where.not(recovery_point: FINISHED_RECOVERY_POINT).or(where(recovery_point: [nil, ""]))
-                            }
-      end
-
-      def finish!
-        finish and unlock and save!
-      end
-
-      def finish
-        self.recovery_point = FINISHED_RECOVERY_POINT
-        self
-      end
-
-      def finished?
-        recovery_point.to_s == FINISHED_RECOVERY_POINT
-      end
+    def succeeded?
+      finished? && !failed?
     end
 
-    concerning :Unlockable do
-      included do
-        scope :unlocked, -> { where(locked_at: nil) }
-        scope :locked, -> { where.not(locked_at: nil) }
-      end
-
-      def unlock!
-        unlock and save!
-      end
-
-      def unlock
-        self.locked_at = nil
-        self
-      end
-
-      def locked?
-        locked_at.present?
-      end
-
-      def lock_active?
-        return false if locked_at.nil?
-
-        locked_at > Time.current - IDEMPOTENCY_KEY_LOCK_TIMEOUT_SECONDS
-      end
+    def failed?
+      error_object.present?
     end
 
-    concerning :ErrorStoreable do
-      included do
-        scope :unerrored, -> { where(error_object: nil) }
-        scope :errored, -> { where.not(error_object: nil) }
-      end
+    private
 
-      def store_error!(error)
-        reload and unlock and store_error(error) and save!
-      end
+    def enqueue_staged_job
+      return unless staged?
 
-      def store_error(error)
-        self.error_object = error
-        self
-      end
+      # encode the identifier for this record in the job ID
+      # base64 encoding for minimal security
+      global_id = to_global_id.to_s.remove("gid://")
+      encoded_global_id = Base64.encode64(global_id).strip
+      staged_job_id = "STG_#{idempotency_key}__#{encoded_global_id}"
 
-      def errored?
-        error_object.present?
-      end
-    end
+      serialized_staged_job = if serialized_job.key?("jid")
+                                serialized_job.merge("jid" => staged_job_id)
+                              elsif serialized_job.key?("job_id")
+                                serialized_job.merge("job_id" => staged_job_id)
+                              else
+                                raise UnknownSerializedJobIdentifier
+                              end
 
-    concerning :Recoverable do
-      def recover_to!(point)
-        recover_to(point) and save!
-      end
-
-      def recover_to(point)
-        self.recovery_point = point
-        self
-      end
-
-      def known_recovery_point?
-        workflow.key?(recovery_point)
-      end
-    end
+      job = job_class.constantize.deserialize(serialized_staged_job)
 
-    def not_awaited_but_unstaged
-      return true unless awaited? && !staged?
+      job.enqueue
 
-      errors.add(:base, "cannot be awaited by another job but not staged")
+      # NOTE: record will be deleted after the job has successfully been performed
+      true
     end
   end
 end

data/lib/acidic_job/staging.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+
+module AcidicJob
+  module Staging
+    extend ActiveSupport::Concern
+
+    def delete_staged_job_record
+      return unless was_staged_job?
+
+      staged_job_run.delete
+      true
+    rescue ActiveRecord::RecordNotFound
+      true
+    end
+
+    def was_staged_job?
+      identifier.start_with? "STG_"
+    end
+
+    def staged_job_run
+      # "STG_#{idempotency_key}__#{encoded_global_id}"
+      encoded_global_id = identifier.split("__").last
+      staged_job_gid = "gid://#{Base64.decode64(encoded_global_id)}"
+
+      GlobalID::Locator.locate(staged_job_gid)
+    end
+  end
+end