cmdx 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 198e34bfa10cf9b640e3a768e335e3901063e2cde3817be7c63fb710b322acc6
-  data.tar.gz: 59f99b87b1c2cc5fff64e2092f3f5ef5230a43d11de6f27c6609802627509164
+  metadata.gz: da7809a9d556cc2cb4cc5734fe52790f4e964ccc437728e1c78cef2a6e2121ec
+  data.tar.gz: 9577047cd8a98bc19fe81c02366aebf70c295e738e3083c478ab670c8af55048
 SHA512:
-  metadata.gz: e60556e4f9af0a9af56d748a1084d95e5fecbe5316268d1d2f1414e5d4c323be81a7c56066bf19edf121eab3fb48080d6b5b3470086ee96241008eb28df9a152
-  data.tar.gz: cc37a5a0029f708f624e449b0526060e203b649d282f33f69551c641ae06f34a3d53886b346b8e48b68f6dbaff23654171d34e58e7d854429c58f0c3d90c62af
+  metadata.gz: 3101e89eafcaf552fa64db81fdc0547628e23636564097ae91fb5dc726cbe25bcfbb6c44a04619cbbfcfe41f29f9a42a658bcd045a1a035f85b0c098d20a6038
+  data.tar.gz: 97450b9d1018dfc80d73fac8b0072356c4a1e05f39fc377cbf517468a412c77041bb1376ae0b3a72fb34575709fa169115ebf69ae7285a75fe41d453b21ee247

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 ## [Unreleased]
 
+## [0.3.0] - 2025-03-14
+### Added
+- Add `progname` to logger instances
+- Add `LoggerSerializer` to standardize log output
+### Changed
+- Revert default log formatter to `Line`
+- Removed `pid` from result serializer
+- Fix serialization of frozen run
+- Fix `call!` not marking state of failure as interrupted
+
 ## [0.2.0] - 2025-03-12
 ### Added
 - Add `PrettyJson` log formatter

data/docs/logging.md

@@ -11,27 +11,27 @@ Built-in log formatters are:
 
 #### Success:
 ```txt
-I, [2022-07-17T18:43:15.000000 #3784] INFO -- CMDx: index=0 run_id=018c2b95-b764-7615-a924-cc5b910ed1e5 type=Task class=SimulationTask id=018c2b95-b764-7615-a924-cc5b910ed1e5 state=complete status=success outcome=success metadata={} runtime=0 tags=[] pid=3784
+I, [2022-07-17T18:43:15.000000 #3784] INFO -- SimulationTask: index=0 run_id=018c2b95-b764-7615-a924-cc5b910ed1e5 type=Task task=SimulationTask id=018c2b95-b764-7615-a924-cc5b910ed1e5 tags=[] state=complete status=success outcome=success metadata={} runtime=0 origin=CMDx
 ```
 
 #### Skipped:
 ```txt
-W, [2022-07-17T18:43:15.000000 #3784] WARN -- CMDx: index=0 run_id=018c2b95-b764-7615-a924-cc5b910ed1e5 type=Task class=SimulationTask id=018c2b95-b764-7615-a924-cc5b910ed1e5 state=interrupted status=skipped outcome=skipped metadata={} runtime=0 tags=[] pid=3784
+W, [2022-07-17T18:43:15.000000 #3784] WARN -- SimulationTask: index=0 run_id=018c2b95-b764-7615-a924-cc5b910ed1e5 type=Task task=SimulationTask id=018c2b95-b764-7615-a924-cc5b910ed1e5 tags=[] state=interrupted status=skipped outcome=skipped metadata={} runtime=0 origin=CMDx
 ```
 
 #### Failed:
 ```txt
-E, [2022-07-17T18:43:15.000000 #3784] ERROR -- CMDx: index=0 run_id=018c2b95-b764-7615-a924-cc5b910ed1e5 type=Task class=SimulationTask id=018c2b95-b764-7615-a924-cc5b910ed1e5 state=interrupted status=failed outcome=failed metadata={} runtime=0 tags=[] pid=3784
+E, [2022-07-17T18:43:15.000000 #3784] ERROR -- SimulationTask: index=0 run_id=018c2b95-b764-7615-a924-cc5b910ed1e5 type=Task task=SimulationTask id=018c2b95-b764-7615-a924-cc5b910ed1e5 tags=[] state=interrupted status=failed outcome=failed metadata={} runtime=0 origin=CMDx
 ```
 
 #### Level 1 subtask failure:
 ```txt
-E, [2022-07-17T18:43:15.000000 #3784] ERROR -- CMDx: index=0 run_id=018c2b95-b764-7615-a924-cc5b910ed1e5 type=Task class=SimulationTask id=018c2b95-b764-7615-a924-cc5b910ed1e5 state=interrupted status=failed outcome=interrupted metadata={} runtime=0 tags=[] pid=3784 caused_failure={:index=>1, :run_id=>"018c2b95-b764-7615-a924-cc5b910ed1e5", :type=>"Task", :class=>"SimulationTask", :id=>"018c2b95-b764-7615-a924-cc5b910ed1e5", :state=>"interrupted", :status=>"failed", :outcome=>"failed", :metadata=>{}, :runtime=>0, :tags=>[], :pid=>3784} threw_failure={:index=>1, :run_id=>"018c2b95-b764-7615-a924-cc5b910ed1e5", :type=>"Task", :class=>"SimulationTask", :id=>"018c2b95-b764-7615-a924-cc5b910ed1e5", :state=>"interrupted", :status=>"failed", :outcome=>"failed", :metadata=>{}, :runtime=>0, :tags=>[], :pid=>3784}
+E, [2022-07-17T18:43:15.000000 #3784] ERROR -- SimulationTask: index=0 run_id=018c2b95-b764-7615-a924-cc5b910ed1e5 type=Task task=SimulationTask id=018c2b95-b764-7615-a924-cc5b910ed1e5 tags=[] state=interrupted status=failed outcome=interrupted metadata={} runtime=0 caused_failure={index: 1, run_id: "018c2b95-b764-7615-a924-cc5b910ed1e5", type: "Task", task: "SimulationTask", id: "018c2b95-b764-7615-a924-cc5b910ed1e5", tags: [], state: "interrupted", status: "failed", outcome: "failed", metadata: {}, runtime: 0} threw_failure={index: 1, run_id: "018c2b95-b764-7615-a924-cc5b910ed1e5", type: "Task", task: "SimulationTask", id: "018c2b95-b764-7615-a924-cc5b910ed1e5", tags: [], state: "interrupted", status: "failed", outcome: "failed", metadata: {}, runtime: 0} origin=CMDx
 ```
 
 #### Level 2+ subtask failure:
 ```txt
-E, [2022-07-17T18:43:15.000000 #3784] ERROR -- CMDx: index=0 run_id=018c2b95-b764-7615-a924-cc5b910ed1e5 type=Task class=SimulationTask id=018c2b95-b764-7615-a924-cc5b910ed1e5 state=interrupted status=failed outcome=interrupted metadata={} runtime=0 tags=[] pid=3784 caused_failure={:index=>2, :run_id=>"018c2b95-b764-7615-a924-cc5b910ed1e5", :type=>"Task", :class=>"SimulationTask", :id=>"018c2b95-b764-7615-a924-cc5b910ed1e5", :state=>"interrupted", :status=>"failed", :outcome=>"failed", :metadata=>{}, :runtime=>0, :tags=>[], :pid=>3784} threw_failure={:index=>1, :run_id=>"018c2b95-b764-7615-a924-cc5b910ed1e5", :type=>"Task", :class=>"SimulationTask", :id=>"018c2b95-b764-7615-a924-cc5b910ed1e5", :state=>"interrupted", :status=>"failed", :outcome=>"interrupted", :metadata=>{}, :runtime=>0, :tags=>[], :pid=>3784}
+E, [2022-07-17T18:43:15.000000 #3784] ERROR -- SimulationTask: index=0 run_id=018c2b95-b764-7615-a924-cc5b910ed1e5 type=Task task=SimulationTask id=018c2b95-b764-7615-a924-cc5b910ed1e5 tags=[] state=interrupted status=failed outcome=interrupted metadata={} runtime=0 caused_failure={index: 2, run_id: "018c2b95-b764-7615-a924-cc5b910ed1e5", type: "Task", task: "SimulationTask", id: "018c2b95-b764-7615-a924-cc5b910ed1e5", tags: [], state: "interrupted", status: "failed", outcome: "failed", metadata: {}, runtime: 0} threw_failure={index: 1, run_id: "018c2b95-b764-7615-a924-cc5b910ed1e5", type: "Task", task: "SimulationTask", id: "018c2b95-b764-7615-a924-cc5b910ed1e5", tags: [], state: "interrupted", status: "failed", outcome: "interrupted", metadata: {}, runtime: 0} origin=CMDx
 ```
 
 ## Logger
@@ -92,7 +92,7 @@ Define a custom log formatter to match your expected output, for example one tha
 
 ```ruby
 class CustomCmdxLogFormat
-  def call(severity, time, progname, message)
+  def call(severity, time, task, message)
     # Return string, hash, array, etc to output...
   end
 end

data/lib/cmdx/configuration.rb

@@ -14,7 +14,7 @@ module CMDx
 
   def reset_configuration!
     @configuration = LazyStruct.new(
-      logger: ::Logger.new($stdout, formatter: CMDx::LogFormatters::PrettyLine.new),
+      logger: ::Logger.new($stdout, formatter: CMDx::LogFormatters::Json.new),
       task_halt: CMDx::Result::FAILED,
       task_timeout: nil,
       batch_halt: CMDx::Result::FAILED,

data/lib/cmdx/log_formatters/json.rb

@@ -4,9 +4,14 @@ module CMDx
   module LogFormatters
     class Json
 
-      def call(_severity, _time, _progname, message)
-        message = message.to_h if message.is_a?(Result)
-        JSON.dump(message) << "\n"
+      def call(severity, time, task, message)
+        m = LoggerSerializer.call(severity, time, task, message).merge!(
+          severity:,
+          pid: Process.pid,
+          timestamp: Utils::LogTimestamp.call(time.utc)
+        )
+
+        JSON.dump(m) << "\n"
       end
 
     end

data/lib/cmdx/log_formatters/key_value.rb

@@ -4,14 +4,15 @@ module CMDx
   module LogFormatters
     class KeyValue
 
-      def call(_severity, _time, _progname, message)
-        if message.is_a?(Result)
-          message = message.to_h.map do |k, v|
-            "#{k}=#{v}"
-          end.join(" ")
-        end
+      def call(severity, time, task, message)
+        m = LoggerSerializer.call(severity, time, task, message).merge!(
+          severity:,
+          pid: Process.pid,
+          timestamp: Utils::LogTimestamp.call(time.utc)
+        )
 
-        message << "\n"
+        m = m.map { |k, v| "#{k}=#{v}" }.join(" ") if m.is_a?(Hash)
+        m << "\n"
       end
 
     end

data/lib/cmdx/log_formatters/line.rb

@@ -4,11 +4,12 @@ module CMDx
   module LogFormatters
     class Line
 
-      def call(severity, time, progname, message)
-        timestamp = Utils::LogTimestamp.call(time.utc)
-        message   = KeyValue.new.call(severity, time, progname, message).chomp
+      def call(severity, time, task, message)
+        t = Utils::LogTimestamp.call(time.utc)
+        m = LoggerSerializer.call(severity, time, task, message)
+        m = m.map { |k, v| "#{k}=#{v}" }.join(" ") if m.is_a?(Hash)
 
-        "#{severity[0]}, [#{timestamp} ##{Process.pid}] #{severity} -- #{progname || 'CMDx'}: #{message}\n"
+        "#{severity[0]}, [#{t} ##{Process.pid}] #{severity} -- #{task.class.name}: #{m}\n"
       end
 
     end

data/lib/cmdx/log_formatters/logstash.rb

@@ -4,15 +4,15 @@ module CMDx
   module LogFormatters
     class Logstash
 
-      def call(_severity, time, _progname, message)
-        message = message.to_h if message.is_a?(Result)
+      def call(severity, time, task, message)
+        m = LoggerSerializer.call(severity, time, task, message).merge!(
+          severity:,
+          pid: Process.pid,
+          "@version" => "1",
+          "@timestamp" => Utils::LogTimestamp.call(time.utc)
+        )
 
-        if message.is_a?(Hash)
-          message["@version"]   ||= "1"
-          message["@timestamp"] ||= Utils::LogTimestamp.call(time.utc)
-        end
-
-        JSON.dump(message) << "\n"
+        JSON.dump(m) << "\n"
       end
 
     end

data/lib/cmdx/log_formatters/pretty_json.rb

@@ -4,9 +4,14 @@ module CMDx
   module LogFormatters
     class PrettyJson
 
-      def call(_severity, _time, _progname, message)
-        message = message.to_h if message.is_a?(Result)
-        JSON.pretty_generate(message) << "\n"
+      def call(severity, time, task, message)
+        m = LoggerSerializer.call(severity, time, task, message).merge!(
+          severity:,
+          pid: Process.pid,
+          timestamp: Utils::LogTimestamp.call(time.utc)
+        )
+
+        JSON.pretty_generate(m) << "\n"
       end
 
     end

data/lib/cmdx/log_formatters/pretty_key_value.rb

@@ -4,19 +4,15 @@ module CMDx
   module LogFormatters
     class PrettyKeyValue
 
-      COLORED_KEYS = %i[
-        state status outcome
-      ].freeze
+      def call(severity, time, task, message)
+        m = LoggerSerializer.call(severity, time, task, message, ansi_colorize: true).merge!(
+          severity:,
+          pid: Process.pid,
+          timestamp: Utils::LogTimestamp.call(time.utc)
+        )
 
-      def call(_severity, _time, _progname, message)
-        if message.is_a?(Result)
-          message = message.to_h.map do |k, v|
-            v = ResultAnsi.call(v) if COLORED_KEYS.include?(k)
-            "#{k}=#{v}"
-          end.join(" ")
-        end
-
-        message << "\n"
+        m = m.map { |k, v| "#{k}=#{v}" }.join(" ") if m.is_a?(Hash)
+        m << "\n"
       end
 
     end

data/lib/cmdx/log_formatters/pretty_line.rb

@@ -4,13 +4,14 @@ module CMDx
   module LogFormatters
     class PrettyLine
 
-      def call(severity, time, progname, message)
-        indicator = LoggerAnsi.call(severity[0])
-        severity  = LoggerAnsi.call(severity)
-        timestamp = Utils::LogTimestamp.call(time.utc)
-        message   = PrettyKeyValue.new.call(severity, time, progname, message).chomp
+      def call(severity, time, task, message)
+        i = LoggerAnsi.call(severity[0])
+        s = LoggerAnsi.call(severity)
+        t = Utils::LogTimestamp.call(time.utc)
+        m = LoggerSerializer.call(severity, time, task, message, ansi_colorize: true)
+        m = m.map { |k, v| "#{k}=#{v}" }.join(" ") if m.is_a?(Hash)
 
-        "#{indicator}, [#{timestamp} ##{Process.pid}] #{severity} -- #{progname || 'CMDx'}: #{message}\n"
+        "#{i}, [#{t} ##{Process.pid}] #{s} -- #{task.class.name}: #{m}\n"
       end
 
     end

data/lib/cmdx/log_formatters/raw.rb

@@ -4,7 +4,7 @@ module CMDx
   module LogFormatters
     class Raw
 
-      def call(_severity, _time, _progname, message)
+      def call(_severity, _time, _task, message)
         message.inspect << "\n"
       end
 

data/lib/cmdx/logger.rb

@@ -9,6 +9,7 @@ module CMDx
       logger           = task.task_setting(:logger)
       logger.formatter = task.task_setting(:log_formatter) if task.task_setting?(:log_formatter)
       logger.level     = task.task_setting(:log_level) if task.task_setting?(:log_level)
+      logger.progname  = task
       logger
     end
 

data/lib/cmdx/logger_serializer.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module CMDx
+  module LoggerSerializer
+
+    COLORED_KEYS = %i[
+      state status outcome
+    ].freeze
+
+    module_function
+
+    def call(_severity, _time, task, message, **options)
+      m = message.respond_to?(:to_h) ? message.to_h : {}
+
+      if options.delete(:ansi_colorize) && message.is_a?(Result)
+        COLORED_KEYS.each { |k| m[k] = ResultAnsi.call(m[k]) if m.key?(k) }
+      elsif !message.is_a?(Result)
+        m.merge!(
+          TaskSerializer.call(task),
+          message: message
+        )
+      end
+
+      m[:origin] ||= "CMDx"
+      m
+    end
+
+  end
+end

data/lib/cmdx/result.rb

@@ -28,6 +28,10 @@ module CMDx
       define_method(:"#{s}?") { state == s }
     end
 
+    def executed!
+      success? ? complete! : interrupt!
+    end
+
     def executed?
       complete? || interrupted?
     end

data/lib/cmdx/result_inspector.rb

@@ -4,7 +4,7 @@ module CMDx
   module ResultInspector
 
     ORDERED_KEYS = %i[
-      class type index id state status outcome metadata
+      task type index id state status outcome metadata
       tags pid runtime caused_failure threw_failure
     ].freeze
 
@@ -17,10 +17,10 @@ module CMDx
         value = result[key]
 
         case key
-        when :class
+        when :task
           "#{value}:"
         when :caused_failure, :threw_failure
-          "#{key}=<[#{value[:index]}] #{value[:class]}: #{value[:id]}>"
+          "#{key}=<[#{value[:index]}] #{value[:task]}: #{value[:id]}>"
         else
           "#{key}=#{value}"
         end

data/lib/cmdx/result_serializer.rb

@@ -13,20 +13,15 @@ module CMDx
     module_function
 
     def call(result)
-      {
-        index: result.index,
-        run_id: result.run.id,
-        type: result.task.is_a?(Batch) ? "Batch" : "Task",
-        class: result.task.class.name,
-        id: result.task.id,
-        state: result.state,
-        status: result.status,
-        outcome: result.outcome,
-        metadata: result.metadata,
-        runtime: result.runtime,
-        tags: result.task.task_setting(:tags),
-        pid: Process.pid
-      }.tap do |hash|
+      TaskSerializer.call(result.task).tap do |hash|
+        hash.merge!(
+          state: result.state,
+          status: result.status,
+          outcome: result.outcome,
+          metadata: result.metadata,
+          runtime: result.runtime
+        )
+
         if result.failed?
           STRIP_FAILURE.call(hash, result, :caused_failure)
           STRIP_FAILURE.call(hash, result, :threw_failure)

data/lib/cmdx/run.rb

@@ -13,6 +13,11 @@ module CMDx
       @results = Array(attributes[:results])
     end
 
+    def freeze
+      first_result
+      super
+    end
+
     def to_h
       RunSerializer.call(self)
     end

data/lib/cmdx/task.rb

@@ -103,7 +103,6 @@ module CMDx
     end
 
     def after_call
-      result.send(result.success? ? :complete! : :interrupt!)
       TaskHook.call(self, :"on_#{result.status}")
       TaskHook.call(self, :"on_#{result.state}")
 
@@ -126,6 +125,7 @@ module CMDx
       rescue StandardError => e
         fail!(reason: "[#{e.class}] #{e.message}", original_exception: e)
       ensure
+        result.executed!
         after_call
       end
 
@@ -139,10 +139,12 @@ module CMDx
       rescue UndefinedCallError => e
         raise(e)
       rescue Fault => e
+        result.executed!
         raise(e) if Array(task_setting(:task_halt)).include?(e.result.status)
 
         after_call # HACK: treat as NO-OP
       else
+        result.executed!
         after_call # ELSE: treat as success
       end
 

data/lib/cmdx/task_serializer.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module CMDx
+  module TaskSerializer
+
+    module_function
+
+    def call(task)
+      {
+        index: task.result.index,
+        run_id: task.run.id,
+        type: task.is_a?(Batch) ? "Batch" : "Task",
+        task: task.class.name,
+        id: task.id,
+        tags: task.task_setting(:tags)
+      }
+    end
+
+  end
+end

data/lib/cmdx/version.rb

@@ -2,6 +2,6 @@
 
 module CMDx
 
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 
 end

data/lib/cmdx.rb

@@ -48,6 +48,7 @@ require_relative "cmdx/error"
 require_relative "cmdx/errors"
 require_relative "cmdx/fault"
 require_relative "cmdx/faults"
+require_relative "cmdx/logger_serializer"
 require_relative "cmdx/logger_ansi"
 require_relative "cmdx/logger"
 require_relative "cmdx/lazy_struct"
@@ -71,6 +72,7 @@ require_relative "cmdx/result_ansi"
 require_relative "cmdx/result_logger"
 require_relative "cmdx/task"
 require_relative "cmdx/task_hook"
+require_relative "cmdx/task_serializer"
 require_relative "cmdx/batch"
 require_relative "cmdx/immutator"
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: cmdx
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Juan Gomez
 bindir: exe
 cert_chain: []
-date: 2025-03-13 00:00:00.000000000 Z
+date: 2025-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bigdecimal
@@ -225,6 +225,7 @@ files:
 - lib/cmdx/log_formatters/raw.rb
 - lib/cmdx/logger.rb
 - lib/cmdx/logger_ansi.rb
+- lib/cmdx/logger_serializer.rb
 - lib/cmdx/parameter.rb
 - lib/cmdx/parameter_inspector.rb
 - lib/cmdx/parameter_serializer.rb
@@ -244,6 +245,7 @@ files:
 - lib/cmdx/run_serializer.rb
 - lib/cmdx/task.rb
 - lib/cmdx/task_hook.rb
+- lib/cmdx/task_serializer.rb
 - lib/cmdx/utils/log_timestamp.rb
 - lib/cmdx/utils/monotonic_runtime.rb
 - lib/cmdx/utils/name_affix.rb