twiglet 3.4.8 → 3.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aa66002d342a4010bd45cfac5f9d379feedf444bb0b7da9183abd32c48eefb73
-  data.tar.gz: 8c09fc2eae272156fb47e8bece9ec1ddc8aa20e30ea582554a45b7471fca6e43
+  metadata.gz: 00772aa96a6be0df63c418fc7cc077cf599e9909af51e00be9992bf78d298660
+  data.tar.gz: 479f94b2de093c797e863b66f02287e37d1b1c5aa58931553bdff269844ed792
 SHA512:
-  metadata.gz: ac5edd60f8444dce77ec6f5e0ee2c2d0cd7bc317944788ce4f8731564eadb89650f4fc25834bc6aedcdacd91f0f10ca9108b9bb0cfef70b2769a79ca6a344096
-  data.tar.gz: 59dc3907ede5435f2f1daa09f862c3d3ca7cd144cddf6e75f04b35698eb8a8262484c5d0705dd7c4ec6a99b4d8972a4d765c1bbf30956638043073f15e54e9ca
+  metadata.gz: 17317a0d26e6b66b573e5eeeafc7d4957c6bdb87e70f320279098cb405464e68fe29a56cbe4421663d809cf39b6e7f72d5d5b5c0261fecd59766bf420e928250
+  data.tar.gz: 222e608e335c4a6406e08376356f1cd7e42c89ea09f7d4eba6432fc33aa26d614421f60ef123d45b2eed73ab334741b50fbf096ee17631f38dbf8930cb4c4397

data/.github/workflows/ruby.yml

@@ -18,7 +18,7 @@ jobs:
 
     strategy:
       matrix:
-        ruby-version: [2.6, 2.7, 3.0]
+        ruby-version: [2.7, 3.0, 3.1]
 
     steps:
     - uses: actions/checkout@v3

data/.ruby-version

@@ -1 +1 @@
-2.6.5
+2.7.6

data/README.md

@@ -1,6 +1,6 @@
 # Twiglet: Ruby version
 Like a log, only smaller.
 
-This library provides a minimal JSON logging interface suitable for use in (micro)services.  See the [RATIONALE](RATIONALE.md) for design rationale and an explantion of the Elastic Common Schema that we are using for log attribute naming.
+This library provides a minimal JSON logging interface suitable for use in (micro)services.  See the [RATIONALE](docs/RATIONALE.md) for design rationale and an explantion of the Elastic Common Schema that we are using for log attribute naming.
 
 See [Full docs](docs/index.md)

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.8'
+  VERSION = '3.5.1'
 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.8
+  version: 3.5.1
 platform: ruby
 authors:
 - Simply Business
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-03-17 00:00:00.000000000 Z
+date: 2022-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json-schema
@@ -145,7 +145,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Twiglet