airbrake-ruby 2.4.1 → 2.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 485663114790c11fb2bce21e7d5fc9c89a2f5557
-  data.tar.gz: 4e6de160720983de3ba60294b2674329c1ffa9db
+  metadata.gz: d37ba4b5467c1b4c23efde342796d56a40ae2603
+  data.tar.gz: 5a500173b55d2aeb86cbc891048d928e0abd4391
 SHA512:
-  metadata.gz: 80d9aecb4ce06871347b40ee525b8b286199845096c3533e7a6109d55be1422d473f27f48ec33fa402d6760e95778c835485b1695836e67a893419921cbf170a
-  data.tar.gz: ef0440643d93d0bedc16d4bf3d8710467a7f5287dd5331b07f9b5f2f6c0ab42bc042b887d78d344a47df7c7f59a60b5f0699792832262a7776527b6c85331667
+  metadata.gz: 17da4cdf501d76c606aa55db2c18fec5bef4af58eeae465fab3dea614d1301db602df0559b894e57cfecf80f68dc616106437fe55fa5ac03e20f4d5a86860ea7
+  data.tar.gz: 45989b8b85dd89dd62ba1a7d81db9630990fef94dd4a36f829353a2553e45f92457613e5f5aae6eb14ce6c6071a0c0b7e8f3f87ea6db110e21bf2bd6317b5631

data/lib/airbrake-ruby/filters/keys_filter.rb

@@ -23,6 +23,11 @@ module Airbrake
       #   by blacklist/whitelist filters
       FILTERABLE_KEYS = %i[environment session params].freeze
 
+      ##
+      # @return [Array<Symbol>] parts of a Notice's *context* payload that can
+      #   be modified by blacklist/whitelist filters
+      FILTERABLE_CONTEXT_KEYS = %i[user headers].freeze
+
       ##
       # @return [Integer]
       attr_reader :weight
@@ -53,14 +58,7 @@ module Airbrake
         end
 
         FILTERABLE_KEYS.each { |key| filter_hash(notice[key]) }
-
-        if notice[:context][:user]
-          if should_filter?(:user)
-            notice[:context][:user] = FILTERED
-          else
-            filter_hash(notice[:context][:user])
-          end
-        end
+        FILTERABLE_CONTEXT_KEYS.each { |key| filter_context_key(notice, key) }
 
         return unless notice[:context][:url]
         filter_url(notice)
@@ -130,6 +128,13 @@ module Airbrake
           "Known patterns: #{@patterns}"
         )
       end
+
+      def filter_context_key(notice, key)
+        return unless notice[:context][key]
+        return filter_hash(notice[:context][key]) unless should_filter?(key)
+
+        notice[:context][key] = FILTERED
+      end
     end
   end
 end

data/lib/airbrake-ruby/version.rb

@@ -4,5 +4,5 @@
 module Airbrake
   ##
   # @return [String] the library version
-  AIRBRAKE_RUBY_VERSION = '2.4.1'.freeze
+  AIRBRAKE_RUBY_VERSION = '2.4.2'.freeze
 end

data/spec/filters/keys_blacklist_spec.rb

@@ -193,5 +193,35 @@ RSpec.describe Airbrake::Filters::KeysBlacklist do
         expect(notice[:context][:user]).to eq('[Filtered]')
       end
     end
+
+    context "and when it is a hash" do
+      let(:patterns) { ['name'] }
+
+      it "filters out individual user fields" do
+        notice[:context][:user] = { id: 1337, name: 'Bingo Bango' }
+        subject.call(notice)
+        expect(notice[:context][:user][:name]).to eq('[Filtered]')
+      end
+    end
+  end
+
+  context "when the headers key is present" do
+    let(:patterns) { ['headers'] }
+
+    it "filters out the headers" do
+      notice[:context][:headers] = { 'HTTP_COOKIE' => 'banana' }
+      subject.call(notice)
+      expect(notice[:context][:headers]).to eq('[Filtered]')
+    end
+
+    context "and when it is a hash" do
+      let(:patterns) { ['HTTP_COOKIE'] }
+
+      it "filters out individual header fields" do
+        notice[:context][:headers] = { 'HTTP_COOKIE' => 'banana' }
+        subject.call(notice)
+        expect(notice[:context][:headers]['HTTP_COOKIE']).to eq('[Filtered]')
+      end
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: airbrake-ruby
 version: !ruby/object:Gem::Version
-  version: 2.4.1
+  version: 2.4.2
 platform: ruby
 authors:
 - Airbrake Technologies, Inc.