Extend #enqueue in ActvieJobSubscriber to handle errors and aborts

Author: claracodes

lib/rails_semantic_logger/active_job/log_subscriber.rb

@@ -4,8 +4,23 @@ module RailsSemanticLogger
   module ActiveJob
     class LogSubscriber < ::ActiveSupport::LogSubscriber
       def enqueue(event)
-        log_with_formatter event: event do |fmt|
-          {message: "Enqueued #{fmt.job_info}"}
+        ex = event.payload[:exception_object]
+
+        if ex
+          log_with_formatter level: :error, event: event do |fmt|
+            {
+              message: "Failed enqueuing #{fmt.job_info} (#{ex.class} (#{ex.message})",
+              exception: ex
+            }
+          end
+        elsif event.payload[:aborted]
+          log_with_formatter level: :info, event: event do |fmt|
+            { message: "Failed enqueuing #{fmt.job_info}, a before_enqueue callback halted the enqueuing execution." }
+          end
+        else
+          log_with_formatter event: event do |fmt|
+            { message: "Enqueued #{fmt.job_info}" }
+          end
         end
       end
 

test/active_job_test.rb

@@ -1,4 +1,5 @@
 require_relative "test_helper"
+require 'pry'
 
 class ActiveJobTest < Minitest::Test
   if defined?(ActiveJob)
@@ -142,7 +143,7 @@ def id
             messages[0],
             level:            :error,
             name:             "Rails",
-            message_includes: "Error enqueuing ActiveJobTest::MyJob",
+            message_includes: "Failed enqueuing ActiveJobTest::MyJob",
             payload_includes: {
               job_class:  "ActiveJobTest::MyJob",
               queue:      "my_jobs",
@@ -176,15 +177,16 @@ def id
 
           assert_semantic_logger_event(
             messages[0],
-            level:            :error,
+            level:            :info,
             name:             "Rails",
-            message_includes: "Failed enqueuing ActiveJobTest::MyJob, a before_enqueue callback halted the enqueuing execution.",
+            message_includes: "Failed enqueuing ActiveJobTest::MyJob",
             payload_includes: {
               job_class:  "ActiveJobTest::MyJob",
               queue:      "my_jobs",
               event_name: "enqueue.active_job"
             }
           )
+          assert_match /Failed enqueuing .*, a before_enqueue callback halted the enqueuing execution/, messages[0].message
           assert_includes messages[0].payload, :job_id
         end
       end