rf_logger 0.3.2 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b595e7d05f3277b9c9835fa966c9c3a4a1e6fec9
-  data.tar.gz: aecb196b1dbd862dffab3ec5dc341ab68ec1e31b
+  metadata.gz: c98893ac9f0eafd8301166b30dcf4457b36d5b1f
+  data.tar.gz: d502d55018ded1e967701994c50f76d51dda5e46
 SHA512:
-  metadata.gz: 6b16adcfce60a563371920d59b2bfc05b701c5c74a0572bdaace67bf747914b95ae6128142f8f51eb4e3530c6d3768af99223d65877c7e563ad0fed2e7bd6d22
-  data.tar.gz: 96c307c32bb8880a67b3a159713d6734f990bd63a3ac2e1ea6c76235177ecac1a2b8add190331cb8e90eb0d70710c5bf615de914edab98bd05f0f130e662bc39
+  metadata.gz: 5874f7a53ef1009b1ccb3fae87e9e6344857c35f16ada5e43c19f08a0d2a5f5e6a98593d9bd52f02dae5e3616f62f508d09679d4fd3aae6260e407793c77d562
+  data.tar.gz: a34a4b5e487697bdbb8898fb8aab7924b62060b3694c673f12b698b3172e56680c06ba9d7a89b308ab8013080d25883e92a0739175ca403627aff70b439665e9

data/lib/rf_logger/active_record/logger.rb

@@ -20,11 +20,10 @@ module RfLogger
             :level       => RfLogger::LEVELS.index(level.to_sym),
             :action      => entry[:action],
             :actor       => entry[:actor],
-            :metadata    => entry[:metadata] || {},
+            :metadata    => merge_request_to_metadata(entry[:metadata] || {}),
             :target_type => entry[:target_type],
             :target_id   => entry[:target_id],
           }
-          attributes[:metadata].merge!(request_tags: rf_logger_request_tags) unless rf_logger_request_tags.nil?
           create(attributes)
         end
       end

data/lib/rf_logger/rails/key_value_tagged_logging.rb

@@ -53,6 +53,6 @@ require "rails/engine/railties"
 
 class KeyValueKeyLogging < ::Rails::Railtie
   initializer "rf_logging.add_log_tag_request_id" do |app|
-    app.config.log_tags = { request_id: :uuid }
+    app.config.log_tags = { request_id: :uuid, remote_ip: :remote_ip }
   end
 end

data/lib/rf_logger/rails/rails_compatibility.rb

@@ -21,7 +21,7 @@ module RfLogger
     attr_reader :rails_version
 
     def rails_not_support_message
-      return unless ENV["RF_LOGGER_LOAD_DEBUG"] = "true"
+      return unless ENV["RF_LOGGER_LOAD_DEBUG"] == "true"
       puts "RfLogger: These patches change Rails private methods and are only known to work for Rails #{MIN} through #{MAX}. Current version #{rails_version}"
     end
 

data/lib/rf_logger/request/request_tags.rb

@@ -5,5 +5,16 @@ module RfLogger
     def rf_logger_request_tags
       Thread.current.get_inheritable_attribute(:rf_logger_request_tags)
     end
+
+    def rf_logger_request_tags?
+      rf_logger_request_tags.present? && rf_logger_request_tags.reject { |_, v| v.nil? }.count > 0
+    end
+
+    def merge_request_to_metadata(metadata)
+      if metadata.is_a?(Hash) && rf_logger_request_tags?
+        metadata.merge!(request_tags: rf_logger_request_tags)
+      end
+      metadata
+    end
   end
 end

data/lib/rf_logger/sequel/logger.rb

@@ -26,8 +26,7 @@ module RfLogger
         def add(level, entry)
           entry[:level]    = RfLogger::LEVELS.index(level.to_sym)
           entry[:actor]    = entry[:actor] || ''
-          entry[:metadata] = entry[:metadata] || {}
-          entry[:metadata].merge!(request_tags: rf_logger_request_tags) unless rf_logger_request_tags.nil?
+          entry[:metadata] = merge_request_to_metadata(entry[:metadata] || {})
           entry[:created_at] = Time.now
           create(entry)
         end
@@ -39,6 +38,7 @@ module RfLogger
       end
 
       def metadata=(metadata_hash)
+        metadata_hash = self.class.merge_request_to_metadata(metadata_hash)
         metadata_as_json = metadata_hash.nil? ? nil : metadata_hash.to_json
         self[:metadata]  = metadata_as_json
       end

data/lib/rf_logger/version.rb

@@ -1,3 +1,3 @@
 module RfLogger
-  VERSION = "0.3.2"
+  VERSION = "0.3.3"
 end

data/spec/lib/rf_logger/active_record/logger_spec.rb

@@ -44,6 +44,20 @@ describe RfLogger::ActiveRecord::Logger do
           )
         end
       end
+
+      context "when metadata is not a hash" do
+        it "creates new Log object with level = #{level}" do
+          described_class.send(level.to_sym, action: 'log me', metadata: "not a hash")
+          expect(described_class).to have_received(:create).with(
+            :level => RfLogger::LEVELS.index(level.to_sym),
+            :action => 'log me',
+            :actor => nil,
+            :metadata => "not a hash",
+            :target_type => nil,
+            :target_id => nil,
+          )
+        end
+      end
     end
   end
 end

data/spec/lib/rf_logger/sequel/logger_spec.rb

@@ -82,6 +82,20 @@ describe RfLogger::Sequel::Logger do
       end
     end
 
+    context "when rf_logger_request_tags has keys but nil values" do
+      it "return a metadata with no request_tags key" do
+        allow(described_class).to receive(:rf_logger_request_tags).and_return({ key_with_no_value: nil })
+
+        expect(described_class).to receive(:create).with(
+          ({ :level      => 1,
+             :actor      => "",
+             :metadata   => { },
+             :created_at => "NOW" })
+        )
+        described_class.add(:info, {})
+      end
+    end
+
     it 'sets actor to blank string if not provided' do
       expect(described_class).to receive(:create).with(
         :actor => '',
@@ -104,12 +118,30 @@ describe RfLogger::Sequel::Logger do
 
       described_class.add(:info, { :action => 'palpitate' })
     end
+
+    it 'return passed in value when metadata is not a hash' do
+      expect(described_class).to receive(:create).with(
+        :actor => '',
+        :action => 'palpitate',
+        :metadata => "not a hash",
+        :created_at => 'NOW',
+        :level => RfLogger::LEVELS.index(:info)
+      )
+
+      described_class.add(:info, { :action => 'palpitate', :metadata => "not a hash" })
+    end
   end
 
   describe "#metadata" do
     it 'returns a hash for metadata even though it is stored as JSON' do
-      subject.metadata = {'foo' => 'bar'}
-      expect(subject.metadata).to eq({'foo' => 'bar'})
+      subject.metadata = { 'foo' => 'bar' }
+      expect(subject.metadata).to eq({ 'foo' => 'bar', "request_tags" => { "request_id" => "909090" } })
+    end
+
+    it 'return a hash without request_tags when values are nil' do
+      allow(described_class).to receive(:rf_logger_request_tags).and_return({ key_with_no_value: nil })
+      subject.metadata = { 'foo' => 'bar' }
+      expect(subject.metadata).to eq({ 'foo' => 'bar' })
     end
 
     it 'returns nil if column is null' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rf_logger
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3
 platform: ruby
 authors:
 - Dustin Zeisler