twiglet 3.4.9 → 3.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 65664ab480ca568c939561798c9a3b317ce30d9a5fb17562b3a37af581a907e2
-  data.tar.gz: 0cf41522b5763297f0835944bfbfa7b0de30402d25cdae59abdcc8c71b0f18cd
+  metadata.gz: eaf4b42f0fd1e53803522582677f68f3a71835de59264853a8dac15bd385db7a
+  data.tar.gz: 56905f74d551eadb29c6ffbd6a1aa7e8ccba23e614c2ab36172b44c96e815c40
 SHA512:
-  metadata.gz: 33df11aa4c11ac1c7ff8cc34eb3cbd767a1cd3899316b22719ce590e66677d5fa8ae6bdaf2988bea053e559c440e43e975e480c55170acf1ba34635c6ea764dc
-  data.tar.gz: e4e1fde4a257a2f4defa20b6486ca0741de9328c18c917c940c63c623fc9e732cb6f24531feb58880ee18b52aac7a7d8795674462549861fd82e722bf090f352
+  metadata.gz: 36a81212d48fbd1d88b5fac2a6920cc1c6b03b5d4af03fc69ae3ec21d0d9109fd1c5e1afb7c07099e85f712a28bc319f05ed74fa5bc4a1ff3383e9de9a571a42
+  data.tar.gz: e727b067f3dce94ece0074108a704177ae101b3d78e13df801b147379f71041f19e3b5d519f60328783f27b9474ab3d8e9c96692da6c4144e94d8f9173c4b03e

data/lib/twiglet/formatter.rb

@@ -7,11 +7,14 @@ module Twiglet
     Hash.include HashExtensions
 
     def initialize(service_name,
-                   validator:, default_properties: {},
+                   validator:,
+                   default_properties: {},
+                   context_provider: nil,
                    now: -> { Time.now.utc })
       @service_name = service_name
       @now = now
       @default_properties = default_properties
+      @context_provider = context_provider
       @validator = validator
 
       super()
@@ -40,8 +43,11 @@ module Twiglet
         }
       }
 
+      context = @context_provider&.call || {}
+
       base_message
         .deep_merge(@default_properties.to_nested)
+        .deep_merge(context.to_nested)
         .deep_merge(message.to_nested)
         .to_json
         .concat("\n")

data/lib/twiglet/logger.rb

@@ -16,7 +16,6 @@ module Twiglet
       **args
     )
       @service_name = service_name
-      default_properties = args.delete(:default_properties) || {}
       @args = args
 
       now = args.fetch(:now, -> { Time.now.utc })
@@ -31,7 +30,8 @@ module Twiglet
 
       formatter = Twiglet::Formatter.new(
         service_name,
-        default_properties: default_properties,
+        default_properties: args.fetch(:default_properties, {}),
+        context_provider: args[:context_provider],
         now: now,
         validator: @validator
       )
@@ -58,12 +58,19 @@ module Twiglet
     end
 
     def with(default_properties)
-      Logger.new(
+      self.class.new(
         @service_name,
         **@args.merge(default_properties: default_properties)
       )
     end
 
+    def context_provider(&blk)
+      self.class.new(
+        @service_name,
+        **@args.merge(context_provider: blk)
+      )
+    end
+
     alias_method :warning, :warn
     alias_method :critical, :fatal
 

data/lib/twiglet/version.rb

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

data/test/formatter_test.rb

@@ -32,4 +32,30 @@ describe Twiglet::Formatter do
     }
     assert_equal JSON.parse(msg), expected_log
   end
+
+  it 'merges the outputs of the context provider into messages logs' do
+    provider = -> { { 'request' => { 'id' => '1234567890' } } }
+    formatter = Twiglet::Formatter.new(
+      'petshop', now: @now, validator: Twiglet::Validator.new({}.to_json),
+                 context_provider: provider
+    )
+    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'
+      }
+    }
+    assert_equal JSON.parse(msg), expected_log
+  end
 end

data/test/logger_test.rb

@@ -146,6 +146,115 @@ describe Twiglet::Logger do
       assert_equal 'Barker', log[:pet][:name]
     end
 
+    it "isn't possible to chain .with methods to gradually add messages" do
+      # Let's add some context to this customer journey
+      purchase_logger = @logger.with(
+        {
+          trace: { id: '1c8a5fb2-fecd-44d8-92a4-449eb2ce4dcb' }
+        }
+      ).with(
+        {
+          customer: { full_name: 'Freda Bloggs' },
+          event: { action: 'pet purchase' }
+        }
+      )
+
+      # do stuff
+      purchase_logger.info(
+        {
+          message: 'customer bought a dog',
+          pet: { name: 'Barker', species: 'dog', breed: 'Bitsa' }
+        }
+      )
+
+      log = read_json @buffer
+
+      assert_nil log[:trace]
+      assert_equal 'Freda Bloggs', log[:customer][:full_name]
+      assert_equal 'pet purchase', log[:event][:action]
+      assert_equal 'customer bought a dog', log[:message]
+      assert_equal 'Barker', log[:pet][:name]
+    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
+
+      # 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]
+    end
+
+    it "chaining .with and .context_provider is possible" do
+      # Let's add some context to this customer journey
+      purchase_logger = @logger.with(
+        {
+          trace: { id: '1c8a5fb2-fecd-44d8-92a4-449eb2ce4dcb' },
+          customer: { full_name: 'Freda Bloggs' },
+          event: { action: 'pet purchase' }
+        }
+      ).context_provider do
+        { 'context' => { 'id' => 'my-context-id' } }
+      end
+
+      # do stuff
+      purchase_logger.info(
+        {
+          message: 'customer bought a dog',
+          pet: { name: 'Barker', species: 'dog', breed: 'Bitsa' }
+        }
+      )
+
+      log = read_json @buffer
+
+      assert_equal '1c8a5fb2-fecd-44d8-92a4-449eb2ce4dcb', log[:trace][:id]
+      assert_equal 'Freda Bloggs', log[:customer][:full_name]
+      assert_equal 'pet purchase', log[:event][:action]
+      assert_equal 'customer bought a dog', log[:message]
+      assert_equal 'Barker', log[:pet][:name]
+      assert_equal 'my-context-id', log[:context][:id]
+    end
+
+    it "chaining .context_provider and .with is possible" do
+      # Let's add some context to this customer journey
+      purchase_logger = @logger
+                        .context_provider do
+        { 'context' => { 'id' => 'my-context-id' } }
+      end.with(
+        {
+          trace: { id: '1c8a5fb2-fecd-44d8-92a4-449eb2ce4dcb' },
+          customer: { full_name: 'Freda Bloggs' },
+          event: { action: 'pet purchase' }
+        }
+      )
+      # do stuff
+      purchase_logger.info(
+        {
+          message: 'customer bought a dog',
+          pet: { name: 'Barker', species: 'dog', breed: 'Bitsa' }
+        }
+      )
+
+      log = read_json @buffer
+
+      assert_equal '1c8a5fb2-fecd-44d8-92a4-449eb2ce4dcb', log[:trace][:id]
+      assert_equal 'Freda Bloggs', log[:customer][:full_name]
+      assert_equal 'pet purchase', log[:event][:action]
+      assert_equal 'customer bought a dog', log[:message]
+      assert_equal 'Barker', log[:pet][:name]
+      assert_equal 'my-context-id', log[:context][:id]
+    end
+
     it "should log 'message' string property" do
       message = {}
       message['message'] = 'Guinea pigs arrived'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twiglet
 version: !ruby/object:Gem::Version
-  version: 3.4.9
+  version: 3.5.0
 platform: ruby
 authors:
 - Simply Business
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-04-05 00:00:00.000000000 Z
+date: 2022-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json-schema