[Story/TP-57214]:Prevent reuse of Password reset token

lib/hedgelog.rb

@@ -25,12 +25,12 @@ class Hedgelog
   attr_reader :level
   attr_writer :app
 
-  def initialize(logdev = STDOUT, shift_age = nil, shift_size = nil)
+  def initialize(logdev = STDOUT, shift_age = nil, shift_size = nil, cleaner = nil)
     @level = LEVELS[:debug]
     @channel = nil
     @logdev = nil
     @app = nil
-    @scrubber = Hedgelog::Scrubber.new
+    @scrubber = Hedgelog::Scrubber.new(cleaner)
     @normalizer = Hedgelog::Normalizer.new
     @channel_context = Hedgelog::Context.new(@scrubber, @normalizer)
 

lib/hedgelog/scrubber.rb

@@ -3,9 +3,14 @@
 class Hedgelog
   class Scrubber
     def initialize(replacements = nil)
-      @replacements = replacements || [
-        ScrubReplacement.new('password', '**********')
-      ]
+      @replacements = [ScrubReplacement.new('password', '**********')]
+      replacements&.each do |x|
+        @replacements << if x.instance_of?(ScrubReplacement)
+                           x
+                         else
+                           ScrubReplacement.new(x, '**********')
+                         end
+      end
     end
 
     def scrub(data)

lib/hedgelog/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class Hedgelog
-  VERSION = '0.1.12'
+  VERSION = '0.2.1.alpha1'
 end

spec/hedgelog/context_spec.rb

@@ -85,19 +85,17 @@
     context 'with valid keys in the hash' do
       it 'updates the context with the merged data' do
         expect(instance[:foo]).to eq 'bar'
-        # rubocop:disable Performance/RedundantMerge
         instance.merge!(baz: 'qux')
-        # rubocop:enable Performance/RedundantMerge
+
         expect(instance.to_h).to include(foo: 'bar', baz: 'qux')
       end
     end
 
     context 'with existing, valid keys in the hash' do
       it 'updates the context with the merged data' do
         expect(instance[:foo]).to eq 'bar'
-        # rubocop:disable Performance/RedundantMerge
         instance.merge!(foo: 'qux')
-        # rubocop:enable Performance/RedundantMerge
+
         expect(instance.to_h).to include(foo: 'bar')
       end
     end

spec/hedgelog_spec.rb

@@ -60,7 +60,7 @@
 
   describe '#add' do
     subject do
-      logger = Hedgelog.new(log_dev)
+      logger = Hedgelog.new(log_dev, nil, nil, scrubber)
       logger.level = log_level
       logger.add(severity, message, progname, data, &block)
     end
@@ -69,6 +69,8 @@
     let(:data) { {} }
     let(:block) { nil }
     let(:severity) { 1 }
+    let(:scrubber) { nil }
+    let(:wash) { '**********' }
 
     context 'when the severity is lower than the log level' do
       let(:log_level) { Logger::FATAL }
@@ -84,11 +86,47 @@
     end
 
     context 'when logging with a message and data' do
-      let(:data) { {bar: 'baz'} }
-      it 'writes the message in the json hash' do
+      let(:data) { {bar: 'baz', secret: 'secret', password: 'do not see me'} }
+
+      it 'writes the message in the json hash should not be able to see password' do
         subject
         expect(JSON.parse(log_results)).to include('message' => 'Foo')
-        expect(JSON.parse(log_results)['context']).to include('bar' => 'baz')
+        expect(JSON.parse(log_results)['context']).to include('bar' => 'baz', 'secret' => 'secret', 'password' => wash)
+      end
+
+      context 'When the scrubber is a string array' do
+        let(:scrubber) { ['secret'] }
+
+        it 'writes the message and hash context while wiping secret info' do
+          subject
+          expect(JSON.parse(log_results)).to include('message' => 'Foo')
+          expect(JSON.parse(log_results)['context']).to include('bar' => 'baz', 'secret' => wash, 'password' => wash)
+        end
+      end
+      context 'When the scrubber is a ScrubReplacement array' do
+        let(:scrubber) { [Hedgelog::ScrubReplacement.new('secret', wash)] }
+
+        it 'writes message and hash context wipes secret and password' do
+          subject
+          expect(JSON.parse(log_results)).to include('message' => 'Foo')
+          expect(JSON.parse(log_results)['context']).to include('bar' => 'baz')
+          expect(JSON.parse(log_results)['context']).to include('secret' => wash)
+          expect(JSON.parse(log_results)['context']).to include('password' => wash)
+        end
+      end
+
+      context 'When the scrubber is a mixed array' do
+        let(:data) { {bar: 'baz', secret: 'secret', password: 'do not see me', mysterious: 'hidden'} }
+        let(:scrubber) { [Hedgelog::ScrubReplacement.new('secret', wash), 'mysterious'] }
+
+        it 'writes message and hash context wipes secret, password, and mysterious' do
+          subject
+          expect(JSON.parse(log_results)).to include('message' => 'Foo')
+          expect(JSON.parse(log_results)['context']).to include('bar' => 'baz')
+          expect(JSON.parse(log_results)['context']).to include('secret' => wash)
+          expect(JSON.parse(log_results)['context']).to include('password' => wash)
+          expect(JSON.parse(log_results)['context']).to include('mysterious' => wash)
+        end
       end
     end