ductwork 0.7.0 → 0.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ec9b8299086fb8f1f51c449000ba0c4b4fb7db17f4712525d8216db7c8f082ea
-  data.tar.gz: 997008b013d1a752e28237a7b6f0dab563a3e8beda7e6a2799f54013f89be661
+  metadata.gz: a3a59fb73965f325d3e23243f59e7e973419f3683d2de741cf5bbf115bccad8d
+  data.tar.gz: d66a5c291d197b7a8e679d23e9c68b6575d2e35100b06f7c412c97e5bc515ec3
 SHA512:
-  metadata.gz: c0687a091dd17926ea4cff0443d9b4cb593a448a26ca6e8f86a2ea629ff4c776e087bab52972d868a22dc5316bba4631123458e7a8202fceb3661c28f5d133cb
-  data.tar.gz: f5770989f81963fcedc318a11c038e81e4d4a5a211c22b428dccc6b60713da883d31dac2fe4994b3a122dab8fa75738ec766f48a50c31ea6a72c36530de5f8e0
+  metadata.gz: de5ca4b1c9dff4478992234183ae84d810cec930eede8d97dc7511959efad9521acb201ec5f39a2d96d430383ee3f240d3a3395bc55fc19ce272603000eb92a2
+  data.tar.gz: b86ea8a91f912ae55e509f2c059fc8db8d4ccff0055fe96db77593a98ce188255b2bbcb395709a0b672ded6b8df1a1537001fc56cfb3de7244a5dda9a4e48192

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Ductwork Changelog
 
+## [0.7.2]
+
+- chore: small DRY refactor in pipeline advancement
+
+## [0.7.1]
+
+- chore: isolate on halt execution in `Ductwork::Job#execution_failed!`
+- chore: add pipeline definition metadata to `DefinitionBuilder` initializer
+
 ## [0.7.0]
 
 - feat: set `Pipeline` and `Step` models status to "in-progress" when claiming latest job

data/lib/ductwork/dsl/definition_builder.rb

@@ -9,6 +9,7 @@ module Ductwork
 
       def initialize
         @definition = {
+          metadata: {},
           nodes: [],
           edges: {},
         }
@@ -102,9 +103,7 @@ module Ductwork
       def on_halt(klass)
         validate_classes!(klass)
 
-        definition[:metadata] ||= {}
-        definition[:metadata][:on_halt] = {}
-        definition[:metadata][:on_halt][:klass] = klass.name
+        definition[:metadata][:on_halt] = { klass: klass.name }
 
         self
       end

data/lib/ductwork/models/job.rb

@@ -195,11 +195,17 @@ module Ductwork
       # NOTE: perform lifecycle hook execution outside of the transaction as
       # to not unnecessarily hold it open
       if halted
-        klass = JSON.parse(pipeline.definition).dig("metadata", "on_halt", "klass")
+        execute_on_halt(pipeline, error)
+      end
+    end
 
-        if klass.present?
-          Object.const_get(klass).new(error).execute
-        end
+    def execute_on_halt(pipeline, error)
+      klass = JSON
+              .parse(pipeline.definition)
+              .dig("metadata", "on_halt", "klass")
+
+      if klass.present?
+        Object.const_get(klass).new(error).execute
       end
     end
   end

data/lib/ductwork/models/pipeline.rb

@@ -113,9 +113,14 @@ module Ductwork
 
     private
 
-    def create_step_and_enqueue_job(klass:, step_type:, input_arg:)
+    def create_step_and_enqueue_job(edge:, input_arg:, klass: nil)
       status = :in_progress
       started_at = Time.current
+      # NOTE: "chain" is used by ActiveRecord so we have to call
+      # this enum value "default" :sad:
+      step_type = edge[:type] == "chain" ? "default" : edge[:type]
+      klass ||= edge.fetch(:to).sole
+
       next_step = steps.create!(klass:, status:, step_type:, started_at:)
       Ductwork::Job.enqueue(next_step, input_arg)
     end
@@ -157,11 +162,8 @@ module Ductwork
       else
         edges.each do |step_klass, step_edges|
           edge = step_edges[-1]
-          # NOTE: "chain" is used by ActiveRecord so we have to call
-          # this enum value "default" :sad:
-          step_type = edge[:type] == "chain" ? "default" : edge[:type]
 
-          if step_type == "collapse"
+          if edge[:type] == "collapse"
             conditionally_collapse_next_steps(step_klass, edge, advancing_ids)
           else
             advance_non_merging_steps(step_klass, edge, advancing_ids)
@@ -172,15 +174,13 @@ module Ductwork
     end
 
     def advance_non_merging_steps(step_klass, edge, advancing_ids)
-      # NOTE: "chain" is used by ActiveRecord so we have to call
-      # this enum value "default" :sad:
-      step_type = edge[:type] == "chain" ? "default" : edge[:type]
+      step_type = edge[:type]
 
       steps.where(id: advancing_ids, klass: step_klass).find_each do |step|
-        if step_type.in?(%w[default divide])
-          advance_to_next_steps(step_type, step.id, edge)
+        if step_type.in?(%w[chain divide])
+          advance_to_next_steps(step.id, edge)
         elsif step_type == "expand"
-          expand_to_next_steps(step_type, step.id, edge)
+          expand_to_next_steps(step.id, edge)
         else
           Ductwork.logger.error(
             msg: "Invalid step type",
@@ -192,7 +192,7 @@ module Ductwork
       end
     end
 
-    def advance_to_next_steps(step_type, step_id, edge)
+    def advance_to_next_steps(step_id, edge)
       too_many = edge[:to].tally.any? do |to_klass, count|
         depth = Ductwork
                 .configuration
@@ -204,15 +204,9 @@ module Ductwork
       if too_many
         halted!
       else
-        edge[:to].each do |to_klass|
-          next_step = steps.create!(
-            klass: to_klass,
-            status: :in_progress,
-            step_type: step_type,
-            started_at: Time.current
-          )
-          return_value = Ductwork::Job.find_by(step_id:).return_value
-          Ductwork::Job.enqueue(next_step, return_value)
+        edge[:to].each do |klass|
+          input_arg = Ductwork::Job.find_by(step_id:).return_value
+          create_step_and_enqueue_job(edge:, input_arg:, klass:)
         end
       end
     end
@@ -230,8 +224,7 @@ module Ductwork
     end
 
     def combine_next_steps(edges, advancing_ids)
-      klass = edges.values.sample.dig(-1, :to).sole
-      step_type = "combine"
+      edge = edges.values.sample[-1]
       groups = steps
                .where(id: advancing_ids)
                .group(:klass)
@@ -243,11 +236,11 @@ module Ductwork
         input_arg = Ductwork::Job
                     .where(step_id: group.map(&:id))
                     .map(&:return_value)
-        create_step_and_enqueue_job(klass:, step_type:, input_arg:)
+        create_step_and_enqueue_job(edge:, input_arg:)
       end
     end
 
-    def expand_to_next_steps(step_type, step_id, edge)
+    def expand_to_next_steps(step_id, edge)
       next_klass = edge[:to].sole
       return_value = Ductwork::Job
                      .find_by(step_id:)
@@ -258,18 +251,14 @@ module Ductwork
         halted!
       else
         Array(return_value).each do |input_arg|
-          create_step_and_enqueue_job(
-            klass: next_klass,
-            step_type: step_type,
-            input_arg: input_arg
-          )
+          create_step_and_enqueue_job(edge:, input_arg:)
         end
       end
     end
 
     def conditionally_collapse_next_steps(step_klass, edge, advancing_ids)
       if steps.where(status: %w[pending in_progress], klass: step_klass).none?
-        collapse_next_steps(edge[:to].sole, advancing_ids)
+        collapse_next_steps(edge, advancing_ids)
       else
         Ductwork.logger.debug(
           msg: "Not all expanded steps have completed; not collapsing",
@@ -279,15 +268,14 @@ module Ductwork
       end
     end
 
-    def collapse_next_steps(klass, advancing_ids)
-      step_type = "collapse"
+    def collapse_next_steps(edge, advancing_ids)
       input_arg = []
 
       Ductwork::Job.where(step_id: advancing_ids).find_each do |job|
         input_arg << job.return_value
       end
 
-      create_step_and_enqueue_job(klass:, step_type:, input_arg:)
+      create_step_and_enqueue_job(edge:, input_arg:)
     end
 
     def log_pipeline_advanced(edges)

data/lib/ductwork/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Ductwork
-  VERSION = "0.7.0"
+  VERSION = "0.7.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ductwork
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.2
 platform: ruby
 authors:
 - Tyler Ewing