ductwork 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 94c5c2250e4a96fee3aaeac379ec1ee58ac85e6aa5c2f0ccffc67c9e66d4499d
-  data.tar.gz: ac6aac4135803b6d0712db4b4491202b64280a506a3101baba6563f549e5ee9d
+  metadata.gz: 01b3ce0336857fcaf0dcaf6beb6b02f002186bd5a94df0c05761cfcd49e8a7e9
+  data.tar.gz: cbef9120711ddf5a42819f68dd44871965681317695c6244e732e8e0228b4218
 SHA512:
-  metadata.gz: d7305c2c9a26693cfa92dce562016420aafe4d745cb3efb4450b5192a8c036d7db5d96023b71979bd15c817059c2f8f2933f974a441066ec891cb2132d802c99
-  data.tar.gz: 54dfdadfcafe3e1e4a214f5d11599e87bc3b114387702b426aad5c146ec7ca2042c42e0fa001cd0d598e11b515a342f8f01d5ac3b96a4f6b982d6579f93b50a7
+  metadata.gz: 315615bb86d68fdcb29bf8dd96d987c79be645a551a85e45825f1a623de9099a8a8ec6e9ef64465eaab259406aa82151a5f76959d10cde2f43bfd7381d5b34bd
+  data.tar.gz: 11b3af06290fa9c3261ef1cdc5ee98e45e2e103988c3b2b11fe07dc9d873c441b82ddfe3a091f1e5da6b487d0af1343e1d3b021049e01705f1c7f2bb94788050

data/.claude/skills/audit-common/accepted-tradeoffs.md

@@ -96,11 +96,6 @@ its place through divergent behavior rather than labeling. Cause metadata
 lives on `Branch#halt_reason` instead. Pipeline and Run states stay
 `in_progress`, `completed`, `halted`.
 
-## 7. `Ductwork.validate!` is not run at boot
-
-It runs in host-application specs, deliberately, for developer experience. Do
-not recommend moving it to boot-time or engine initialization.
-
 ---
 
 # Known Open — report only with new information

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Ductwork Changelog
 
+## [1.4.0]
+
+- feat: validate steps and pipelines/workflows during boot of main process
+
 ## [1.3.0]
 
 - feat: add more `MigrationHelper` methods for swapping and updating the availability claim index

data/lib/ductwork/cli.rb

@@ -5,6 +5,7 @@ require "optparse"
 module Ductwork
   class CLI
     DEFAULT_COMMAND = "start"
+    BACKTRACE_FRAME_LIMIT = 5
 
     def self.start!(args)
       new(args).start!
@@ -31,8 +32,9 @@ module Ductwork
 
     def start!
       parse!
-      auto_configure
-      execute_command
+      configure
+      validate!
+      execute
     end
 
     private
@@ -44,9 +46,9 @@ module Ductwork
       top_level_parser.order(raw_args)
       @command = raw_args.shift || DEFAULT_COMMAND
 
-      if command == "start"
+      if start_command?
         start_command_parser.parse!(raw_args)
-      elsif command == "health"
+      elsif health_check_command?
         health_command_parser.parse!(raw_args)
       else
         warn "Unknown command: #{command}"
@@ -55,7 +57,15 @@ module Ductwork
       end
     end
 
-    def auto_configure
+    def start_command?
+      command == "start"
+    end
+
+    def health_check_command?
+      command == "health"
+    end
+
+    def configure
       configuration_options[:role] = ENV.fetch("DUCTWORK_ROLE", nil)
       Ductwork.configuration = Configuration.new(**configuration_options)
       Ductwork.logger = if Ductwork.configuration.logger_source == "rails"
@@ -82,10 +92,39 @@ module Ductwork
       BANNER
     end
 
-    def execute_command
-      if command == "start"
+    def validate!
+      if start_command?
+        Ductwork.validate!
+      end
+    rescue StandardError => e
+      report_invalid_definitions(e)
+      exit 1
+    end
+
+    def report_invalid_definitions(error)
+      warn "ductwork failed to validate your step and pipeline definitions"
+      warn ""
+      warn "  #{error.class}: #{error.message}"
+
+      definition_frames(error).each do |frame|
+        warn "    #{frame}"
+      end
+    end
+
+    def definition_frames(error)
+      frames = error.backtrace.to_a
+
+      return frames if Ductwork.logger.debug?
+
+      application_frames = frames.grep(/\A#{Regexp.escape(Rails.root.to_s)}/)
+
+      (application_frames.presence || frames).first(BACKTRACE_FRAME_LIMIT)
+    end
+
+    def execute
+      if start_command?
         launch_processes
-      elsif command == "health"
+      elsif health_check_command?
         check_health
       end
     end

data/lib/ductwork/version.rb

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

data/lib/ductwork.rb

@@ -10,6 +10,14 @@ require "securerandom"
 require "zeitwerk"
 
 module Ductwork
+  DEFINITION_DIRECTORIES = %w[
+    app/steps
+    app/pipelines
+    app/workflows
+  ].freeze
+
+  class LoadPathError < StandardError; end
+
   class << self
     attr_accessor :app_executor, :loader, :logger
     attr_writer :configuration, :defined_pipelines, :hooks
@@ -67,25 +75,18 @@ module Ductwork
     end
 
     def validate!
-      step_directory = Rails.root.join("app/steps")
-      pipeline_directory = Rails.root.join("app/pipelines")
-      workflow_directory = Rails.root.join("app/workflows")
-      loader = if defined?(Rails.autoloaders)
-                 Rails.autoloaders.main
-               else
-                 Ductwork.loader
-               end
-
-      if step_directory.exist?
-        loader.eager_load_dir(step_directory)
-      end
-
-      if pipeline_directory.exist?
-        loader.eager_load_dir(pipeline_directory)
-      end
-
-      if workflow_directory.exist?
-        loader.eager_load_dir(workflow_directory)
+      loader = Rails.autoloaders.main
+
+      DEFINITION_DIRECTORIES.each do |relative|
+        directory = Rails.root.join(relative)
+
+        if directory.exist?
+          begin
+            loader.eager_load_dir(directory)
+          rescue Zeitwerk::Error => e
+            raise LoadPathError, "#{directory} exists but is not autoloadable: #{e.message}"
+          end
+        end
       end
 
       true

metadata

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