acidic_job 1.0.0.pre22 → 1.0.0.pre25

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 892c6a2598d63440a7e749484e790b3f47380954b615bd7b2c4fc4c8de541759
-  data.tar.gz: bf7383000fa8e0fb1c545e5ccb014c7123884eb14da77178dd088bb9b12e73e1
+  metadata.gz: 305652928d6e3948110121767a94388b2f569a0ccc4693944cde5df2938c9a4b
+  data.tar.gz: 1c612e9380eaa0f73dd194441f69a988015e304c55c047793ad292f8c46e6c19
 SHA512:
-  metadata.gz: 87610f9f920ddb6e34c727a6b4c9e8d98d9ec556bff1dea221e3f588694b4e5f77b482985ba906cc62c5a3593e398e906e8dd6aa815e9c6d3031e410b71abfeb
-  data.tar.gz: 7ca46ec550598f545d3baaafccf09cf082b6eaad01a1d6bb4b8f5a7298d9023b0b33c824183e3c5b30b3a1fbb2a9200286761b4e671adf39569a62b6ac392740
+  metadata.gz: f720cc6bebf8bdc4197295a3501b750e4b8b7741d7f04d6096aba426d45b37027d650664b038f1e45a32dc0763af9cd88ccec41c6d32dbdde56d0937a5af4df2
+  data.tar.gz: a7639fe45ebbea79331a8355a5f8a20fc95182341d575ca8a8040a0733cfe242f5e694ec98d1b442eea5235ccabf4280bd91f20f28ff1814b0bd32ffa95a8bff

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    acidic_job (1.0.0.pre22)
+    acidic_job (1.0.0.pre25)
       activerecord
       activesupport
       database_cleaner

data/lib/acidic_job/awaiting.rb

@@ -8,39 +8,59 @@ module AcidicJob
 
     private
 
+    def was_awaited_job?
+      (acidic_job_run.present? && acidic_job_run.awaited_by.present?) ||
+        (staged_job_run.present? && staged_job_run.awaited_by.present?)
+    end
+
+    def reenqueue_awaited_by_job
+      run = staged_job_run&.awaited_by || acidic_job_run&.awaited_by
+
+      return unless run
+      return if run.batched_runs.outstanding.any?
+
+      current_step = run.workflow[run.recovery_point.to_s]
+      step_result = run.returning_to
+
+      job = run.job_class.constantize.deserialize(run.serialized_job)
+      # this needs to be explicitly set so that `was_workflow_job?` appropriately returns `true`
+      # which is what the `after_finish :reenqueue_awaited_by_job` check needs
+      job.instance_variable_set(:@acidic_job_run, run)
+
+      step = Step.new(current_step, run, job, step_result)
+      # TODO: WRITE REGRESSION TESTS FOR PARALLEL JOB FAILING AND RETRYING THE ORIGINAL STEP
+      step.progress
+
+      return if run.finished?
+
+      # when a batch of jobs for a step succeeds, we begin processing the `AcidicJob::Run` record again
+      # process_run(run)
+      run.update_column(:locked_at, nil)
+      job.enqueue
+    end
+
     def enqueue_step_parallel_jobs(jobs_or_jobs_getter, run, step_result)
-      # `batch` is available from Sidekiq::Pro
-      raise SidekiqBatchRequired unless defined?(Sidekiq::Batch)
-
-      jobs = case jobs_or_jobs_getter
-             when Array
-               jobs_or_jobs_getter
-             when Symbol, String
-               method(jobs_or_jobs_getter).call
-             end
-
-      step_batch = Sidekiq::Batch.new
-      # step_batch.description = "AcidicJob::Workflow Step: #{step}"
-      step_batch.on(
-        :success,
-        "#{self.class.name}#step_done",
-        # NOTE: options are marshalled through JSON so use only basic types.
-        {
-          "run_id" => run.id,
-          "step_result_yaml" => step_result.to_yaml.strip,
-          "parent_worker" => self.class.name,
-          "job_names" => jobs.map { |job| job_name(job) }
-        }
-      )
-
-      # NOTE: The jobs method is atomic.
-      # All jobs created in the block are actually pushed atomically at the end of the block.
-      # If an error is raised, none of the jobs will go to Redis.
-      step_batch.jobs do
-        jobs.each do |job|
-          worker, args, kwargs = job_args_and_kwargs(job)
-
-          worker.perform_async(*args, **kwargs)
+      awaited_jobs = case jobs_or_jobs_getter
+                     when Array
+                       jobs_or_jobs_getter
+                     when Symbol, String
+                       method(jobs_or_jobs_getter).call
+                     end
+
+      AcidicJob::Run.transaction do
+        awaited_jobs.each do |awaited_job|
+          worker_class, args, kwargs = job_args_and_kwargs(awaited_job)
+
+          job = worker_class.new(*args, **kwargs)
+
+          AcidicJob::Run.create!(
+            staged: true,
+            awaited_by: run,
+            job_class: worker_class,
+            serialized_job: job.serialize_job(*args, **kwargs),
+            idempotency_key: job.idempotency_key
+          )
+          run.update(returning_to: step_result)
         end
       end
     end
@@ -58,17 +78,6 @@ module AcidicJob
       process_run(run)
     end
 
-    def job_name(job)
-      case job
-      when Class, Symbol
-        job.to_s
-      when String
-        job
-      else
-        job.class.name
-      end
-    end
-
     def job_args_and_kwargs(job)
       case job
       when Class

data/lib/acidic_job/extensions/sidekiq.rb

@@ -13,7 +13,11 @@ module AcidicJob
         class_methods do
           # called only from `AcidicJob::Run#enqueue_staged_job`
           def deserialize(serialized_job_hash)
-            klass = serialized_job_hash["class"].constantize
+            klass = if serialized_job_hash["class"].is_a?(Class)
+                      serialized_job_hash["class"]
+                    else
+                      serialized_job_hash["class"].constantize
+                    end
             worker = klass.new
             worker.jid = serialized_job_hash["jid"]
             worker.instance_variable_set(:@args, serialized_job_hash["args"])
@@ -54,7 +58,7 @@ module AcidicJob
           ::Sidekiq::Client.push(
             "class" => self.class,
             "args" => @args,
-            "jid" => @jid
+            "jid" => @acidic_job_run&.staged_job_id || @jid
           )
         end
       end

data/lib/acidic_job/idempotency_key.rb

@@ -20,7 +20,15 @@ module AcidicJob
                 end
               end
 
-      value || value_from_job_args(hash_or_job, *args, **kwargs)
+      result = value || value_from_job_args(hash_or_job, *args, **kwargs)
+
+      if result.start_with?("STG__")
+        # "STG__#{idempotency_key}__#{encoded_global_id}"
+        _prefix, idempotency_key, _encoded_global_id = result.split("__")
+        idempotency_key
+      else
+        result
+      end
     end
 
     private

data/lib/acidic_job/run.rb

@@ -12,11 +12,15 @@ module AcidicJob
 
     self.table_name = "acidic_job_runs"
 
+    belongs_to :awaited_by, class_name: "AcidicJob::Run", optional: true
+    has_many :batched_runs, class_name: "AcidicJob::Run", foreign_key: "awaited_by_id"
+
     after_create_commit :enqueue_staged_job, if: :staged?
 
     serialize :error_object
     serialize :serialized_job
     serialize :workflow
+    serialize :returning_to
     store :attr_accessors
 
     validates :staged, inclusion: { in: [true, false] } # uses database default
@@ -27,7 +31,9 @@ module AcidicJob
     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) }
+    scope :outstanding, lambda {
+      where.not(recovery_point: FINISHED_RECOVERY_POINT).or(where(recovery_point: [nil, ""]))
+    }
 
     with_options unless: :staged? do
       validates :last_run_at, presence: true
@@ -60,16 +66,19 @@ module AcidicJob
       error_object.present?
     end
 
-    private
-
-    def enqueue_staged_job
-      return unless staged?
-
+    def staged_job_id
       # 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}"
+
+      "STG__#{idempotency_key}__#{encoded_global_id}"
+    end
+
+    private
+
+    def enqueue_staged_job
+      return unless staged?
 
       serialized_staged_job = if serialized_job.key?("jid")
                                 serialized_job.merge("jid" => staged_job_id)

data/lib/acidic_job/staging.rb

@@ -7,17 +7,10 @@ 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
+    private
 
     def was_staged_job?
-      identifier.start_with? "STG_"
+      identifier.start_with? "STG__"
     end
 
     def staged_job_run
@@ -26,6 +19,8 @@ module AcidicJob
       staged_job_gid = "gid://#{Base64.decode64(encoded_global_id)}"
 
       GlobalID::Locator.locate(staged_job_gid)
+    rescue ActiveRecord::RecordNotFound
+      nil
     end
 
     def identifier
@@ -33,7 +28,9 @@ module AcidicJob
       return job_id if defined?(job_id) && !job_id.nil?
 
       # might be defined already in `with_acidity` method
-      @__acidic_job_idempotency_key ||= IdempotencyKey.value_for(self, @__acidic_job_args, @__acidic_job_kwargs)
+      acidic_identifier = self.class.acidic_identifier
+      @__acidic_job_idempotency_key ||= IdempotencyKey.new(acidic_identifier)
+                                                      .value_for(self, *@__acidic_job_args, **@__acidic_job_kwargs)
 
       @__acidic_job_idempotency_key
     end

data/lib/acidic_job/step.rb

@@ -42,7 +42,13 @@ module AcidicJob
     # The progression phase advances the job run state machine onto the next step
     def progress
       @run.with_lock do
-        @step_result.call(run: @run)
+        if @step_result.is_a?(FinishedPoint)
+          @job.run_callbacks :finish do
+            @step_result.call(run: @run)
+          end
+        else
+          @step_result.call(run: @run)
+        end
       end
     end
 

data/lib/acidic_job/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AcidicJob
-  VERSION = "1.0.0.pre22"
+  VERSION = "1.0.0.pre25"
 end

data/lib/acidic_job.rb

@@ -48,8 +48,12 @@ module AcidicJob
     end
 
     # TODO: write test for a staged job that uses awaits
-    klass.set_callback :perform, :after, :delete_staged_job_record, if: :was_staged_job?
+    klass.set_callback :perform, :after, :reenqueue_awaited_by_job,
+                       if: -> { was_awaited_job? && !was_workflow_job? }
+    klass.set_callback :perform, :after, :finish_staged_job, if: -> { was_staged_job? && !was_workflow_job? }
     klass.define_callbacks :finish
+    klass.set_callback :finish, :after, :reenqueue_awaited_by_job,
+                       if: -> { was_workflow_job? && was_awaited_job? }
 
     klass.instance_variable_set(:@acidic_identifier, :job_id)
     klass.define_singleton_method(:acidic_by_job_id) { @acidic_identifier = :job_id }
@@ -133,9 +137,17 @@ module AcidicJob
 
   private
 
+  def finish_staged_job
+    FinishedPoint.new.call(run: staged_job_run)
+  end
+
+  def was_workflow_job?
+    defined?(@acidic_job_run) && @acidic_job_run.present?
+  end
+
   def process_run(run)
     # if the run record is already marked as finished, immediately return its result
-    return finish_run(run) if run.finished?
+    return run.succeeded? if run.finished?
 
     # otherwise, we will enter a loop to process each step of the workflow
     loop do
@@ -174,13 +186,7 @@ module AcidicJob
     end
 
     # the loop will break once the job is finished, so simply report the status
-    finish_run(run)
-  end
-
-  def finish_run(run)
-    run_callbacks :finish do
-      run.succeeded?
-    end
+    run.succeeded?
   end
 
   def step(method_name, awaits: [], for_each: nil)
@@ -223,9 +229,7 @@ module AcidicJob
       if run.present?
         # Programs enqueuing multiple jobs with different parameters but the
         # same idempotency key is a bug.
-        # NOTE: WOULD THE ENQUEUED_AT OR CREATED_AT FIELD BE NECESSARILY DIFFERENT?
-        if run.serialized_job.except("jid", "job_id",
-                                     "enqueued_at") != serialized_job.except("jid", "job_id", "enqueued_at")
+        if run.serialized_job.slice("args", "arguments") != serialized_job.slice("args", "arguments")
           raise MismatchedIdempotencyKeyAndJobArguments
         end
 
@@ -234,7 +238,14 @@ module AcidicJob
         raise LockedIdempotencyKey if run.locked_at && run.locked_at > Time.current - IDEMPOTENCY_KEY_LOCK_TIMEOUT
 
         # Lock the run and update latest run unless the job is already finished.
-        run.update!(last_run_at: Time.current, locked_at: Time.current, workflow: workflow) unless run.finished?
+        unless run.finished?
+          run.update!(
+            last_run_at: Time.current,
+            locked_at: Time.current,
+            workflow: workflow,
+            recovery_point: run.recovery_point || workflow.first.first
+          )
+        end
       else
         run = Run.create!(
           staged: false,

data/lib/generators/acidic_job/templates/create_acidic_job_runs_migration.rb.erb

@@ -1,19 +1,19 @@
 class <%= migration_class_name %> < ActiveRecord::Migration<%= migration_version %>
   def change
     create_table :acidic_job_runs do |t|
-      t.boolean 	:staged, 					null: false, 	default: -> { false }
-      t.string 		:idempotency_key, null: false
-      t.text 			:serialized_job, 	null: false
-      t.string 		:job_class, 			null: false
-      t.datetime 	:last_run_at, 		null: true, 	default: -> { "CURRENT_TIMESTAMP" }
-      t.datetime 	:locked_at, 			null: true
-      t.string 		:recovery_point, 	null: true
-      t.text 			:error_object, 		null: true
-      t.text 			:attr_accessors, 	null: true
-      t.text 			:workflow, 				null: true
+      t.boolean     :staged, 					null: false,  default: -> { false }
+      t.string      :idempotency_key, null: false,  index: { unique: true }
+      t.text        :serialized_job, 	null: false
+      t.string      :job_class, 			null: false
+      t.datetime    :last_run_at, 		null: true,   default: -> { "CURRENT_TIMESTAMP" }
+      t.datetime    :locked_at, 			null: true
+      t.string      :recovery_point, 	null: true
+      t.text        :error_object, 		null: true
+      t.text        :attr_accessors, 	null: true
+      t.text        :workflow, 				null: true
+      t.references  :awaited_by,      null: true,   index: true
+      t.text        :returning_to,    null: true
       t.timestamps
-    
-      t.index :idempotency_key, unique: true
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: acidic_job
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre22
+  version: 1.0.0.pre25
 platform: ruby
 authors:
 - fractaledmind
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-05-17 00:00:00.000000000 Z
+date: 2022-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord