Merge pull request reidmorrison#118 from hoangtuanictvn/sensitive_arguments

Check log_arguments? to hide log for sensitive arguments in ActiveJob

Author: reidmorrison

.travis.yml

@@ -22,17 +22,26 @@ matrix:
     - name: "Rails 6.0 on Ruby 2.6.6"
       rvm: 2.6.6
       gemfile: gemfiles/rails_6.0.gemfile
+    - name: "Rails 6.1 on Ruby 2.6.6"
+      rvm: 2.6.6
+      gemfile: gemfiles/rails_6.1.gemfile
 
     - name: "Rails 6.0 on Ruby 2.7.1"
       rvm: 2.7.1
       gemfile: gemfiles/rails_6.0.gemfile
+    - name: "Rails 6.1 on Ruby 2.7.1"
+      rvm: 2.7.1
+      gemfile: gemfiles/rails_6.1.gemfile
 
     - name: "Rails 5.2 on JRuby 9.2.11.1"
       rvm: jruby-9.2.11.1
       gemfile: gemfiles/rails_5.2.gemfile
     - name: "Rails 6.0 on JRuby 9.2.11.1"
       rvm: jruby-9.2.11.1
       gemfile: gemfiles/rails_6.0.gemfile
+    - name: "Rails 6.1 on JRuby 9.2.11.1"
+      rvm: jruby-9.2.11.1
+      gemfile: gemfiles/rails_6.1.gemfile
 
   allow_failures:
     - rvm: jruby-9.2.11.1

Appraisals

@@ -15,3 +15,9 @@ appraise "rails_6.0" do
   gem "activerecord-jdbcsqlite3-adapter", "~> 60.0", platform: :jruby
   gem "sqlite3", "~> 1.4.0", platform: :ruby
 end
+
+appraise "rails_6.1" do
+  gem "rails", "~> 6.1.0"
+  gem "activerecord-jdbcsqlite3-adapter", "~> 61.0", platform: :jruby
+  gem "sqlite3", "~> 1.4.0", platform: :ruby
+end

gemfiles/rails_6.1.gemfile

@@ -0,0 +1,21 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal"
+gem "puma"
+gem "active_model_serializers"
+gem "amazing_print"
+gem "minitest"
+gem "rake"
+gem "sprockets", "< 4.0"
+gem "rails", "~> 6.1.0"
+gem "activerecord-jdbcsqlite3-adapter", "~> 61.0", platform: :jruby
+gem "sqlite3", "~> 1.4.0", platform: :ruby
+gem "jdbc-sqlite3", platform: :jruby
+
+group :development do
+  gem "rubocop"
+end
+
+gemspec path: "../"

lib/rails_semantic_logger/active_job/log_subscriber.rb

@@ -78,7 +78,11 @@ def adapter_name
         end
 
         def formatted_args
-          JSON.pretty_generate(job.arguments.map { |arg| format(arg) })
+          if defined?(job.class.log_arguments?) && !job.class.log_arguments?
+            ""
+          else
+            JSON.pretty_generate(job.arguments.map { |arg| format(arg) })
+          end
         end
 
         def format(arg)

test/active_job_test.rb

@@ -10,6 +10,22 @@ def perform(record)
       end
     end
 
+    class SensitiveJob < ActiveJob::Base
+      queue_as :my_jobs
+
+      if Rails.version.to_f >= 6.1
+        self.log_arguments = false
+      else
+        def self.log_arguments?
+          false
+        end
+      end
+
+      def perform(record)
+        "Received: #{record}"
+      end
+    end
+
     class TestModel
       include GlobalID::Identification
 
@@ -76,28 +92,48 @@ def id
                                                   Time.zone.now,
                                                   "transaction_id",
                                                   adapter: ActiveJob::QueueAdapters::InlineAdapter.new,
-                                                  job:     MyJob.new(TestModel.new, 1, "string", foo: "bar")
+                                                  job: job
         end
 
         describe "#payload" do
           specify do
             assert_equal(formatter.payload[:event_name], "perform.active_job")
             assert_equal(formatter.payload[:adapter], "Inline")
             assert_equal(formatter.payload[:queue], "my_jobs")
-            assert_equal(formatter.payload[:job_class], "ActiveJobTest::MyJob")
             assert_kind_of(String, formatter.payload[:job_id])
             assert_kind_of(Float, formatter.payload[:duration])
-            arguments = <<~ARGS.chomp
-              [
-                "gid://dummy/ActiveJobTest::TestModel/15",
-                1,
-                "string",
-                {
-                  "foo": "bar"
-                }
-              ]
-            ARGS
-            assert_equal(formatter.payload[:arguments], arguments)
+          end
+
+          describe "Show arguments in log" do
+            let(:job) do
+              MyJob.new(TestModel.new, 1, "string", foo: "bar")
+            end
+
+            specify do
+              assert_equal(formatter.payload[:job_class], "ActiveJobTest::MyJob")
+              arguments = <<~ARGS.chomp
+                [
+                  "gid://dummy/ActiveJobTest::TestModel/15",
+                  1,
+                  "string",
+                  {
+                    "foo": "bar"
+                  }
+                ]
+              ARGS
+              assert_equal(formatter.payload[:arguments], arguments)
+            end
+          end
+
+          describe "Hide arguments from log" do
+            let(:job) do
+              SensitiveJob.new(TestModel.new, 1, "string", foo: "bar")
+            end
+
+            specify do
+              assert_equal(formatter.payload[:job_class], "ActiveJobTest::SensitiveJob")
+              assert_equal(formatter.payload[:arguments], "")
+            end
           end
         end