twiglet 3.4.3 → 3.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 16ed3e64581c0d1c8908cf35d0dd77646a9e14be9f4fe39a6528a0c193f3bdfb
-  data.tar.gz: 83a5aeb0da1c3d2d44c464fee1ea602189dbae971b01473ffd91bc7358a30a8b
+  metadata.gz: eaf4b42f0fd1e53803522582677f68f3a71835de59264853a8dac15bd385db7a
+  data.tar.gz: 56905f74d551eadb29c6ffbd6a1aa7e8ccba23e614c2ab36172b44c96e815c40
 SHA512:
-  metadata.gz: f396edf27be32a886a2f08872632a1d5b19d236ce4eb20c84c1fc4fbe14889442c901e476d2b6def32329cf0149032c806d726d2a849da52f0e6a886ec6cf97d
-  data.tar.gz: 4425f5082fe34808c45d9b7eaca355721c025db44e626cea2c2f958ec0ce2cd254ed1bfcb2fcdb39b975f60572560e1da3ca6293cc45a656c3d387411f918d68
+  metadata.gz: 36a81212d48fbd1d88b5fac2a6920cc1c6b03b5d4af03fc69ae3ec21d0d9109fd1c5e1afb7c07099e85f712a28bc319f05ed74fa5bc4a1ff3383e9de9a571a42
+  data.tar.gz: e727b067f3dce94ece0074108a704177ae101b3d78e13df801b147379f71041f19e3b5d519f60328783f27b9474ab3d8e9c96692da6c4144e94d8f9173c4b03e

data/.github/workflows/codeql-analysis.yml

@@ -38,7 +38,7 @@ jobs:
 
     steps:
     - name: Checkout repository
-      uses: actions/checkout@v2
+      uses: actions/checkout@v3
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL

data/.github/workflows/dobby-actions.yml

@@ -3,6 +3,8 @@ name: "Dobby action"
 on:
   issue_comment:
     types: [created]
+permissions:
+  contents: read
 jobs:
   pr_commented:
     runs-on: ubuntu-20.04
@@ -11,7 +13,7 @@ jobs:
       BUNDLE_WITHOUT: "development:test"
     steps:
       - name: Chekcout action
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
         with:
           repository: 'simplybusiness/dobby'
           ref: 'v3.0.0'
@@ -20,7 +22,7 @@ jobs:
         with:
           bundler-cache: true
       - name: Bump version
-        uses: simplybusiness/dobby@v3.0.0
+        uses: simplybusiness/dobby@v3.0.1
         env:
           DOBBY_APP_ID: ${{ secrets.DOBBY_APP_ID }}
           DOBBY_PRIVATE_KEY: ${{ secrets.DOBBY_PRIVATE_KEY }}

data/.github/workflows/gem-publish.yml

@@ -12,7 +12,7 @@ jobs:
     name: Build and Publish
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
@@ -31,7 +31,7 @@ jobs:
         id: get-gem-version
         run: echo "::set-output name=GEM_VERSION::$(bundle exec ruby -e 'puts Twiglet::VERSION')"
       - name: Create Release
-        uses: actions/github-script@v5
+        uses: actions/github-script@v6
         env:
           GEM_VERSION: ${{ steps.get-gem-version.outputs.GEM_VERSION }}
         with:

data/.github/workflows/ruby.yml

@@ -6,6 +6,8 @@ on:
 
 env:
   CI: true
+permissions:
+  contents: read
 
 jobs:
   build:
@@ -19,7 +21,7 @@ jobs:
         ruby-version: [2.6, 2.7, 3.0]
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:

data/.github/workflows/version-forget-me-not.yml

@@ -5,6 +5,9 @@ on:
     branches:
       - master
     types: [opened, synchronize]
+permissions:
+  contents: read
+  statuses: write
 jobs:
   build:
     runs-on: ubuntu-18.04

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.3'
+  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.3
+  version: 3.5.0
 platform: ruby
 authors:
 - Simply Business
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-01 00:00:00.000000000 Z
+date: 2022-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json-schema