axn 0.1.0.pre.alpha.2.5.2 → 0.1.0.pre.alpha.2.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6902996eda6bf8911d2f90f73217d56a0905ddf0772ebfee3a9c2bbf8072279e
-  data.tar.gz: 3615981ef31731e017b2b9399b485290041b1a79cc0ccc231c189399ddb4e5f4
+  metadata.gz: d62aa4b98c8f159761234817e6b2ded26e0fcafa46d07685049d827281e92235
+  data.tar.gz: d3ffb46353e17db427393049767a6a03fbf3d5b30e94e4011a47397644364c32
 SHA512:
-  metadata.gz: 1f9ae2c8d65defac13be5abded734bdcf1057e8d880878d8cf4c57c58ef537d257a7a96208fe83616ce8ddc89344c60042b9eadbe8575b52d14fa9fa9981489e
-  data.tar.gz: bcbf95ea1e179a44076cb5b451f0ab1f94001bccb30bd78fd3fbbd025472fb08bed4cda805cf934ab6f3328f4aced08a96ff4983142aeed67c7121ecddd11e2b
+  metadata.gz: 54a4ea06f021850cc1d4e1e9bf18a6ec20f495871f23efab20380cd2a8135c52df46099f03281944c4dbe4419c836a72309cfd719e769ae3fd7e48a2ad7683db
+  data.tar.gz: 474eea3af1b53ad4ae85096a2e39d4b141b01c8c4f239f710cd13de933046d92b7efc67333902c78ed29c882bda5ada0a44e9e2efeab05721681f5ded1633b41

data/.rubocop.yml

@@ -30,6 +30,9 @@ Style/TrailingCommaInHashLiteral:
 Style/ClassAndModuleChildren:
   Enabled: false
 
+Style/HashSyntax:
+  EnforcedShorthandSyntax: always
+
 Style/DoubleNegation:
   Enabled: false
 

data/CHANGELOG.md

@@ -3,6 +3,10 @@
 ## Unreleased
 * N/A
 
+## 0.1.0-alpha.2.5.3
+* More aggressive logging of swallowed exceptions when not in production mode
+* Make automatic pre/post logging more digestible
+
 ## 0.1.0-alpha.2.5.2
 * [BREAKING] Removing `EnqueueAllInBackground` + `EnqueueAllWorker` - better + simply solved at application level
 * [TEST] Expose spec helpers to consumers (add `require "axn/testing/spec_helpers"` to your `spec_helper.rb`)

data/docs/reference/configuration.md

@@ -36,6 +36,22 @@ For example, if you're using Honeybadger this could look something like:
   end
 ```
 
+**Note:** The `action:` and `context:` keyword arguments are *optional*—your proc can accept any combination of `e`, `action:`, and `context:`. Only the keyword arguments you explicitly declare will be passed to your handler. All of the following are valid:
+
+```ruby
+  # Only exception object
+  c.on_exception = proc { |e| ... }
+
+  # Exception and action
+  c.on_exception = proc { |e, action:| ... }
+
+  # Exception and context
+  c.on_exception = proc { |e, context:| ... }
+
+  # Exception, action, and context
+  c.on_exception = proc { |e, action:, context:| ... }
+```
+
 A couple notes:
 
   * `context` will contain the arguments passed to the `action`, _but_ any marked as sensitive (e.g. `expects :foo, sensitive: true`) will be filtered out in the logs.

data/docs/usage/writing.md

@@ -155,4 +155,4 @@ after hook
 A number of custom callback are available for you as well, if you want to take specific actions when a given Axn succeeds or fails. See the [Class Interface docs](/reference/class#callbacks) for details.
 
 ## Strategies
-A number of [Strategies](/strategies), which are <abbr title="Don't Repeat Yourself">DRY</abbr>ed bits of commonly-used configuration, are available for your use as well.
+A number of [Strategies](/strategies/index), which are <abbr title="Don't Repeat Yourself">DRY</abbr>ed bits of commonly-used configuration, are available for your use as well.

data/lib/action/core/configuration.rb

@@ -2,7 +2,6 @@
 
 module Action
   class Configuration
-    include Action::Logging
     attr_accessor :top_level_around_hook
     attr_writer :logger, :env, :on_exception, :additional_includes, :default_log_level, :default_autolog_level
 
@@ -12,11 +11,21 @@ module Action
     def additional_includes = @additional_includes ||= []
 
     def on_exception(e, action:, context: {})
-      if @on_exception
-        # TODO: only pass action: or context: if requested (and update documentation)
-        @on_exception.call(e, action:, context:)
+      msg = "Handled exception (#{e.class.name}): #{e.message}"
+      msg = ("#" * 10) + " #{msg} " + ("#" * 10) unless Action.config.env.production?
+      action.log(msg)
+
+      return unless @on_exception
+
+      # Only pass the kwargs that the given block expects
+      kwargs = @on_exception.parameters.select { |type, _name| %i[key keyreq].include?(type) }.map(&:last)
+      kwarg_hash = {}
+      kwarg_hash[:action] = action if kwargs.include?(:action)
+      kwarg_hash[:context] = context if kwargs.include?(:context)
+      if kwarg_hash.any?
+        @on_exception.call(e, **kwarg_hash)
       else
-        log("[#{action.class.name.presence || "Anonymous Action"}] Exception raised: #{e.class.name} - #{e.message}")
+        @on_exception.call(e)
       end
     end
 

data/lib/action/core/context_facade.rb

@@ -75,8 +75,7 @@ module Action
         action.instance_exec(&msg)
       end
     rescue StandardError => e
-      action.warn("Ignoring #{e.class.name} while determining message callable: #{e.message}")
-      nil
+      Axn::Util.piping_error("determining message callable", action:, exception: e)
     end
   end
 

data/lib/action/core/event_handlers.rb

@@ -27,8 +27,7 @@ module Action
         action.instance_exec(exception, &@handler)
         true
       rescue StandardError => e
-        action.warn("Ignoring #{e.class.name} when evaluating handler: #{e.message}")
-        nil
+        Axn::Util.piping_error("executing handler", action:, exception: e)
       end
     end
 
@@ -54,8 +53,7 @@ module Action
           false
         end
       rescue StandardError => e
-        action.warn("Ignoring #{e.class.name} while determining matcher: #{e.message}")
-        false
+        Axn::Util.piping_error("determining if handler applies to exception", action:, exception: e)
       end
 
       private attr_reader :matcher

data/lib/action/core/{swallow_exceptions.rb → handle_exceptions.rb}

@@ -3,7 +3,7 @@
 require_relative "event_handlers"
 
 module Action
-  module SwallowExceptions
+  module HandleExceptions
     def self.included(base)
       base.class_eval do
         class_attribute :_success_msg, :_error_msg
@@ -56,7 +56,7 @@ module Action
         rescue StandardError => e
           # No action needed -- downstream #on_exception implementation should ideally log any internal failures, but
           # we don't want exception *handling* failures to cascade and overwrite the original exception.
-          warn("Ignoring #{e.class.name} in on_exception hook: #{e.message}")
+          Axn::Util.piping_error("executing on_exception hooks", action: self, exception: e)
         end
 
         class << base

data/lib/action/core/logging.rb

@@ -16,20 +16,20 @@ module Action
     module ClassMethods
       def default_log_level = Action.config.default_log_level
 
-      def log(message, level: default_log_level)
+      def log(message, level: default_log_level, before: nil, after: nil)
         msg = [_log_prefix, message].compact_blank.join(" ")
+        msg = [before, msg, after].compact_blank.join if before || after
 
         Action.config.logger.send(level, msg)
       end
 
       LEVELS.each do |level|
-        define_method(level) do |message|
-          log(message, level:)
+        define_method(level) do |message, before: nil, after: nil|
+          log(message, level:, before:, after:)
         end
       end
 
-      # TODO: this is ugly, we should be able to override in the config class...
-      def _log_prefix = name == "Action::Configuration" ? nil : "[#{name || "Anonymous Class"}]"
+      def _log_prefix = "[#{name.presence || "Anonymous Class"}]"
     end
   end
 end

data/lib/action/core/top_level_around_hook.rb

@@ -24,8 +24,9 @@ module Action
           self.class.default_autolog_level,
           [
             "About to execute",
-            context_for_logging(:inbound).presence&.inspect,
+            _log_context(:inbound),
           ].compact.join(" with: "),
+          before: Action.config.env.production? ? nil : "\n------\n",
         )
       end
 
@@ -36,21 +37,38 @@ module Action
           self.class.default_autolog_level,
           [
             "Execution completed (with outcome: #{outcome}) in #{elapsed_mils} milliseconds",
-            _log_after_data_peak,
+            _log_context(:outbound),
           ].compact.join(". Set: "),
+          after: Action.config.env.production? ? nil : "\n------\n",
         )
       end
 
-      def _log_after_data_peak
-        return unless (data = context_for_logging(:outbound)).present?
+      def _log_context(direction)
+        data = context_for_logging(direction)
+        return unless data.present?
 
-        max_length = 100
-        suffix = "...<truncated>...}"
+        max_length = 150
+        suffix = "…<truncated>…"
 
-        data.inspect.tap do |str|
+        _log_object(data).tap do |str|
           return str[0, max_length - suffix.length] + suffix if str.length > max_length
         end
       end
+
+      def _log_object(data)
+        case data
+        when Hash
+          # NOTE: slightly more manual in order to avoid quotes around ActiveRecord objects' <Class#id> formatting
+          "{#{data.map { |k, v| "#{k}: #{_log_object(v)}" }.join(", ")}}"
+        when Array
+          data.map { |v| _log_object(v) }
+        else
+          return data.to_unsafe_h if defined?(ActionController::Parameters) && data.is_a?(ActionController::Parameters)
+          return "<#{data.class.name}##{data.to_param.presence || "unpersisted"}>" if defined?(ActiveRecord::Base) && data.is_a?(ActiveRecord::Base)
+
+          data.inspect
+        end
+      end
     end
 
     module InstanceMethods

data/lib/action/core/validation/validators/model_validator.rb

@@ -26,8 +26,7 @@ module Action
         msg = id.blank? ? "not found (given a blank ID)" : "not found for class #{klass.name} and ID #{id}"
         record.errors.add(attribute, msg)
       rescue StandardError => e
-        warn("Model validation on field '#{attribute}' raised #{e.class.name}: #{e.message}")
-
+        Axn::Util.piping_error("applying model validation on field '#{attribute}'", exception: e)
         record.errors.add(attribute, "error raised while trying to find a valid #{klass.name}")
       end
     end

data/lib/action/core/validation/validators/validate_validator.rb

@@ -9,7 +9,7 @@ module Action
         msg = begin
           options[:with].call(value)
         rescue StandardError => e
-          Action.config.logger.warn("Custom validation on field '#{attribute}' raised #{e.class.name}: #{e.message}")
+          Axn::Util.piping_error("applying custom validation on field '#{attribute}'", exception: e)
 
           "failed validation: #{e.message}"
         end

data/lib/axn/util.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Axn
+  module Util
+    def self.piping_error(desc, exception:, action: nil)
+      # Extract just filename/line number from backtrace
+      src = exception.backtrace.first.split.first.split("/").last.split(":")[0, 2].join(":")
+
+      message = if Action.config.env.production?
+                  "Ignoring exception raised while #{desc}: #{exception.class.name} - #{exception.message} (from #{src})"
+                else
+                  msg = "!! IGNORING EXCEPTION RAISED WHILE #{desc.upcase} !!\n\n" \
+                        "\t* Exception: #{exception.class.name}\n" \
+                        "\t* Message: #{exception.message}\n" \
+                        "\t* From: #{src}"
+                  "#{"⌵" * 30}\n\n#{msg}\n\n#{"^" * 30}"
+                end
+
+      (action || Action.config.logger).send(:warn, message)
+
+      nil
+    end
+  end
+end

data/lib/axn/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Axn
-  VERSION = "0.1.0-alpha.2.5.2"
+  VERSION = "0.1.0-alpha.2.5.3"
 end

data/lib/axn.rb

@@ -2,6 +2,7 @@
 
 module Axn; end
 require_relative "axn/version"
+require_relative "axn/util"
 
 require "interactor"
 require "active_support"
@@ -16,7 +17,7 @@ require_relative "action/core/configuration"
 require_relative "action/core/top_level_around_hook"
 require_relative "action/core/contract"
 require_relative "action/core/contract_for_subfields"
-require_relative "action/core/swallow_exceptions"
+require_relative "action/core/handle_exceptions"
 require_relative "action/core/hoist_errors"
 require_relative "action/core/use_strategy"
 
@@ -44,7 +45,7 @@ module Action
       # can include those hook executions in any traces set from this hook.
       include TopLevelAroundHook
 
-      include SwallowExceptions
+      include HandleExceptions
       include Contract
       include ContractForSubfields
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: axn
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre.alpha.2.5.2
+  version: 0.1.0.pre.alpha.2.5.3
 platform: ruby
 authors:
 - Kali Donovan
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-07-07 00:00:00.000000000 Z
+date: 2025-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -96,9 +96,9 @@ files:
 - lib/action/core/contract_for_subfields.rb
 - lib/action/core/event_handlers.rb
 - lib/action/core/exceptions.rb
+- lib/action/core/handle_exceptions.rb
 - lib/action/core/hoist_errors.rb
 - lib/action/core/logging.rb
-- lib/action/core/swallow_exceptions.rb
 - lib/action/core/top_level_around_hook.rb
 - lib/action/core/use_strategy.rb
 - lib/action/core/validation/fields.rb
@@ -113,6 +113,7 @@ files:
 - lib/axn.rb
 - lib/axn/factory.rb
 - lib/axn/testing/spec_helpers.rb
+- lib/axn/util.rb
 - lib/axn/version.rb
 - package.json
 - yarn.lock