Merge pull request #12 from hhoopes/hlh/rails-7.1-splatting

Update TaggedHashFormatter to handle nil edge cases gracefully

Author: bwillis

CHANGELOG.md

@@ -4,7 +4,7 @@
 
 Bug Fixes:
 
-* None
+* Formatter is now more defensive about incoming nil and array-of-nil values, after changes with Rails 7.x Rack::Logger identified the gap
 
 Enhancements:
 

lib/fluent_logger_rails/tagged_hash_formatter.rb

@@ -43,10 +43,13 @@ def format_severity(severity)
     end
 
     def tagged(*tags)
-      add_tags(*tags)
-      yield self
+      tags = tags.flatten.compact if tags.is_a?(Array)
+
+      add_tags(*tags) if tags
+
+      yield(self)
     ensure
-      remove_tags(*tags)
+      remove_tags(*tags) if tags
     end
 
     def add_tags(*tags)

spec/integration/fluent_logger_rails/tagged_hash_formatter_spec.rb

@@ -33,6 +33,46 @@
     end
   end
 
+  describe '#tagged' do
+    let(:tags) { nil }
+
+    context 'nil tag' do
+      it 'does not attempt to process the tags' do
+        expect(formatter).not_to(receive(:remove_tags).with(anything))
+
+        formatter.tagged(tags) { expect(formatter.current_tags).to(eq({ tags: [] })) }
+      end
+    end
+
+    context 'with a nested array of nil tags' do
+      let(:tags) { [nil] }
+
+      it 'does not attempt to process the tags' do
+        expect(formatter).not_to(receive(:remove_tags).with(anything))
+
+        formatter.tagged([tags]) { expect(formatter.current_tags).to(eq({ tags: [] })) }
+      end
+    end
+
+    context 'with a string tag' do
+      let(:tags) { 'tag' }
+
+      it 'adds the tag' do
+        formatter.tagged(tags) { expect(formatter.current_tags).to(eq({ tags: [tags] })) }
+      end
+    end
+
+    context 'with a hash' do
+      let(:tags) { { port: 80, host: '127.0.0.1' } }
+
+      it 'adds the tags' do
+        formatter.tagged(**tags) do
+          expect(formatter.current_tags).to(eq(tags))
+        end
+      end
+    end
+  end
+
   describe '#add_tags' do
     context 'for a hash' do
       before { formatter.add_tags(host: '127.0.0.1', port: '80')}