Merge pull request rails#42916 from Alexander-Blair/respect-log-arguments-setting-in-application-jobs

Avoid logging delayed job arguments if log_arguments set to false

Author: rafaelfranca

activejob/lib/active_job/queue_adapters/delayed_job_adapter.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "delayed_job"
+require "active_support/core_ext/string/inflections"
 
 module ActiveJob
   module QueueAdapters
@@ -35,12 +36,21 @@ def initialize(job_data)
         end
 
         def display_name
-          "#{job_data['job_class']} [#{job_data['job_id']}] from DelayedJob(#{job_data['queue_name']}) with arguments: #{job_data['arguments']}"
+          base_name = "#{job_data["job_class"]} [#{job_data["job_id"]}] from DelayedJob(#{job_data["queue_name"]})"
+
+          return base_name unless log_arguments?
+
+          "#{base_name} with arguments: #{job_data["arguments"]}"
         end
 
         def perform
           Base.execute(job_data)
         end
+
+        private
+          def log_arguments?
+            job_data["job_class"].constantize.log_arguments?
+          end
       end
     end
   end

activejob/test/cases/delayed_job_adapter_test.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require "active_job/queue_adapters/delayed_job_adapter"
+
+class DelayedJobAdapterTest < ActiveSupport::TestCase
+  test "does not log arguments when log_arguments is set to false on a job" do
+    job_id = SecureRandom.uuid
+
+    job_wrapper = ActiveJob::QueueAdapters::DelayedJobAdapter::JobWrapper.new(
+      "job_class" => DisableLogJob.to_s,
+      "queue_name" => "default",
+      "job_id" => job_id,
+      "arguments" => { "some" => { "job" => "arguments" } }
+    )
+
+    assert_equal "DisableLogJob [#{job_id}] from DelayedJob(default)", job_wrapper.display_name
+  end
+
+  test "logs arguments when log_arguments is set to true on a job" do
+    job_id = SecureRandom.uuid
+    arguments = { "some" => { "job" => "arguments" } }
+
+    job_wrapper = ActiveJob::QueueAdapters::DelayedJobAdapter::JobWrapper.new(
+      "job_class" => HelloJob.to_s,
+      "queue_name" => "default",
+      "job_id" => job_id,
+      "arguments" => arguments
+    )
+
+    assert_equal "HelloJob [#{job_id}] from DelayedJob(default) with arguments: #{arguments}",
+                 job_wrapper.display_name
+  end
+end