twiglet 3.9.2 → 3.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b87b30fcde8a6363eb43ef4451718f3e15066a686b6ecd5340cb504cc3f0ebd
-  data.tar.gz: 6efcea94e5b2623e3c01e974f34ad80f0c7238fb655f306415ad75a7105b0164
+  metadata.gz: 99e8d740d7d9a800eef5d22fe68252f41bd6d75042d2a8f69596b9361a6daf4d
+  data.tar.gz: fe9ac8d41fed72423a4ee2e9b209f0c10f742546fbd36704a1c391dba6004e64
 SHA512:
-  metadata.gz: 962d159d17c025956e0294d07ae9f452f10298c17fdaa3d56eb56e7547eee03ef324d260d58151553ada630eb2a5326650d22b6649ceb00ca8412dda7b27cb92
-  data.tar.gz: e5a2394439c12bedc56de394e5275ae383c4c40debba8cdcd9a81aefe962afc9d81089df599ed6201103646136969356d7101bb570be8736987cfb3c150edb65
+  metadata.gz: d14b3282ec480b9d628902261ac467f89bf5f635723d420a1b05607b7c6c4f549f6aaa70d0eba8513c23100e1f8142ed2099b07295c0ce288b85108478861daa
+  data.tar.gz: 9d8119f8ce88a5fed9a0cc1e159180d623a194ee2eacfa0ac898a3d289b6318343c3583764223d132bc0cc1550b7c37bac2bcd2f6b39e530747f9f1d1a201f6f

data/lib/hash_extensions.rb

@@ -2,7 +2,7 @@
 
 module HashExtensions
   def to_nested
-    self unless contains_dotted_key?
+    return self unless contains_dotted_key?
 
     keys.reduce({}) do |nested, key|
       nested.deep_merge(build_nested_object(key, self[key]))

data/lib/twiglet/formatter.rb

@@ -11,12 +11,13 @@ module Twiglet
       validator:,
       default_properties: {},
       context_provider: nil,
+      context_providers: [],
       now: -> { Time.now.utc }
     )
       @service_name = service_name
       @now = now
       @default_properties = default_properties
-      @context_provider = context_provider
+      @context_providers = context_provider ? [context_provider] : context_providers
       @validator = validator
 
       super()
@@ -45,7 +46,9 @@ module Twiglet
         }
       }
 
-      context = @context_provider&.call || {}
+      context = @context_providers.reduce({}) do |c, context_provider|
+        c.deep_merge(context_provider.call)
+      end
 
       JSON.generate(
         base_message

data/lib/twiglet/logger.rb

@@ -33,7 +33,7 @@ module Twiglet
       formatter = Twiglet::Formatter.new(
         service_name,
         default_properties: args.fetch(:default_properties, {}),
-        context_provider: args[:context_provider],
+        context_providers: Array(args[:context_provider] || args[:context_providers]),
         now: now,
         validator: @validator
       )
@@ -82,9 +82,12 @@ module Twiglet
     end
 
     def context_provider(&blk)
+      new_context_providers = Array(@args[:context_providers])
+      new_context_providers << blk
+
       self.class.new(
         @service_name,
-        **@args.merge(context_provider: blk)
+        **@args.merge(context_providers: new_context_providers)
       )
     end
 

data/lib/twiglet/message.rb

@@ -8,7 +8,7 @@ module Twiglet
       when Hash
         replace(msg.transform_keys!(&:to_sym))
       else
-        super(msg)
+        super
       end
     end
   end

data/lib/twiglet/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Twiglet
-  VERSION = '3.9.2'
+  VERSION = '3.11.0'
 end

data/test/formatter_test.rb

@@ -58,4 +58,32 @@ describe Twiglet::Formatter do
     }
     assert_equal JSON.parse(msg), expected_log
   end
+
+  it 'merges the outputs of all context providers into the messages log' do
+    provider_1 = -> { { 'request' => { 'id' => '1234567890' } } }
+    provider_2 = -> { { 'request' => { 'type' => 'test' } } }
+    formatter = Twiglet::Formatter.new(
+      'petshop', now: @now, validator: Twiglet::Validator.new({}.to_json),
+                 context_providers: [provider_1, provider_2]
+    )
+    msg = formatter.call('warn', nil, nil, 'shop is running low on dog food')
+    expected_log = {
+      "ecs" => {
+        "version" => '1.5.0'
+      },
+      "@timestamp" => '2020-05-11T15:01:01.000Z',
+      "service" => {
+        "name" => 'petshop'
+      },
+      "log" => {
+        "level" => 'warn'
+      },
+      "message" => 'shop is running low on dog food',
+      "request" => {
+        'id' => '1234567890',
+        'type' => 'test'
+      }
+    }
+    assert_equal expected_log, JSON.parse(msg)
+  end
 end

data/test/logger_test.rb

@@ -3,6 +3,7 @@
 require 'minitest/autorun'
 require 'minitest/mock'
 require_relative '../lib/twiglet/logger'
+require 'active_support'
 
 LEVELS = [
   { method: :debug, level: 'debug' },
@@ -188,9 +189,13 @@ describe Twiglet::Logger do
     end
 
     it "should be able to add contextual information to events with the context_provider" do
-      purchase_logger = @logger.context_provider do
-        { 'context' => { 'id' => 'my-context-id' } }
-      end
+      provider = -> { { 'context' => { 'id' => 'my-context-id' } } }
+      purchase_logger = Twiglet::Logger.new(
+        'petshop',
+        now: @now,
+        output: @buffer,
+        context_provider: provider
+      )
 
       # do stuff
       purchase_logger.info(
@@ -206,6 +211,31 @@ describe Twiglet::Logger do
       assert_equal 'my-context-id', log[:context][:id]
     end
 
+    it "should be able to add contextual information to events with multiple context providers" do
+      provider_1 = -> { { 'context' => { 'id' => 'my-context-id' } } }
+      provider_2 = -> { { 'context' => { 'type' => 'test' } } }
+      purchase_logger = Twiglet::Logger.new(
+        'petshop',
+        now: @now,
+        output: @buffer,
+        context_providers: [provider_1, provider_2]
+      )
+
+      # do stuff
+      purchase_logger.info(
+        {
+          message: 'customer bought a dog',
+          pet: { name: 'Barker', species: 'dog', breed: 'Bitsa' }
+        }
+      )
+
+      log = read_json @buffer
+
+      assert_equal 'customer bought a dog', log[:message]
+      assert_equal 'my-context-id', log[:context][:id]
+      assert_equal 'test', log[:context][:type]
+    end
+
     it "chaining .with and .context_provider is possible" do
       # Let's add some context to this customer journey
       purchase_logger = @logger.with(
@@ -266,6 +296,27 @@ describe Twiglet::Logger do
       assert_equal 'my-context-id', log[:context][:id]
     end
 
+    it "previously supplied context providers should be preserved" do
+      # Let's add some context to this customer journey
+      purchase_logger = @logger
+                        .context_provider { { 'first-context' => { 'first-id' => 'my-first-context-id' } } }
+                        .context_provider { { 'second-context' => { 'second-id' => 'my-second-context-id' } } }
+      # do stuff
+      purchase_logger.info(
+        {
+          message: 'customer bought a dog',
+          pet: { name: 'Barker', species: 'dog', breed: 'Bitsa' }
+        }
+      )
+
+      log = read_json @buffer
+
+      assert_equal 'customer bought a dog', log[:message]
+      assert_equal 'Barker', log[:pet][:name]
+      assert_equal 'my-first-context-id', log[:'first-context'][:'first-id']
+      assert_equal 'my-second-context-id', log[:'second-context'][:'second-id']
+    end
+
     it "should log 'message' string property" do
       message = {}
       message['message'] = 'Guinea pigs arrived'
@@ -393,8 +444,7 @@ describe Twiglet::Logger do
       assert_equal 'Some error', actual_log[:message]
     end
 
-    it 'should log error type properly even when active_support/json is required' do
-      require 'active_support/json'
+    it 'should log error type properly even when active_support is required' do
       e = StandardError.new('Unknown error')
       @logger.error('Artificially raised exception with string message', e)
 

data/twiglet.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |gem|
 
   gem.license               = 'Copyright SimplyBusiness'
 
-  gem.add_runtime_dependency     'json-schema'
+  gem.add_dependency 'json-schema'
   gem.add_development_dependency 'minitest'
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'simplecov', '0.17.1'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twiglet
 version: !ruby/object:Gem::Version
-  version: 3.9.2
+  version: 3.11.0
 platform: ruby
 authors:
 - Simply Business
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-09-27 00:00:00.000000000 Z
+date: 2024-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json-schema