twiglet 2.3.6 → 2.3.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b6b403959c8c42d8942d17af72a53419a68b8a90c0a805fbdec6703aa4e86d95
-  data.tar.gz: 7c99b71016b8f41ab0d82cfedcb376dd5704c77e1bdb7a00a99f48a89d1b2666
+  metadata.gz: aa67e232d4c30f51fa72893c00e3c348f82e70b5cfe4b65c3ed695ef96a10bd9
+  data.tar.gz: d67da5f68a44f3d4f382f2be0d507325a1698081664b2977f44139faa117581b
 SHA512:
-  metadata.gz: e22959d3b8796813b6f4b789ae00cf8629b83b14b31a4f525babc3718d7462c93e961391f3322c39a15bd26d08a38194cd1dd6d025d5c4871ada864be4e52c5b
-  data.tar.gz: bcf49062251a7b68b20ef559c124e04928593fc5a004ad21cbfd3262a716f382bcc3b462ca338bfd628796e5c40d14bf4c543d430f4e9d7c542a6201a7639f2b
+  metadata.gz: 2100bc269dcd76fe9edefa2723f172e376ebb6340fb0f1b489cd8fc6b9629967385eb2bc081934ba42ac7d552fd63ce3232c58021df6fd74e2c331a0d4c04cbb
+  data.tar.gz: fc7f824c61cf1156551018a1adfe7ebae5313844725e837393d19082ff7d89487a54e8f5adcc8900c9bf3f67d398344b353b010d87c4c04f638d3be9bf7af07f

data/.github/workflows/ruby.yml

@@ -4,6 +4,9 @@ on:
   push:
     branches:
 
+env:
+  CI: true
+
 jobs:
   build:
     runs-on: ubuntu-latest
@@ -23,11 +26,22 @@ jobs:
         ruby-version: ${{ matrix.ruby-version }}
     - name: Install dependencies
       run: bundle install
+    - name: install cc-test-reporter
+      env:
+        CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
+      run: |
+        curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-0.6.3-linux-amd64 > ./cc-test-reporter
+        chmod +x ./cc-test-reporter
+        ./cc-test-reporter before-build
     - name: Rubocop Check
       run: bundle exec rubocop
     - name: Run all tests
       run: bundle exec rake test
       shell: bash
+    - name: upload test coverage to CodeClimate
+      env:
+        CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
+      run: ./cc-test-reporter after-build
     - name: Run example_app
       run: bundle exec ruby example_app.rb
       shell: bash

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

@@ -0,0 +1,16 @@
+name: Check version
+
+on:
+  pull_request:
+    branches:
+      - master
+    types: [opened, synchronize]
+jobs:
+  build:
+    runs-on: ubuntu-18.04
+
+    steps:
+      - uses: simplybusiness/version-forget-me-not@v1
+        env:
+          ACCESS_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          VERSION_FILE_PATH: "lib/twiglet/version.rb"

data/.gitignore

@@ -1,3 +1,4 @@
+*~
 *.gem
 Gemfile.lock
 *.rbc

data/Dockerfile

@@ -0,0 +1,7 @@
+FROM ruby:2.6.5
+
+WORKDIR /var/app
+COPY Gemfile .
+RUN bundle install
+
+CMD ["bash"]

data/Gemfile

@@ -5,4 +5,5 @@ gem 'simplycop', git: 'https://github.com/simplybusiness/simplycop.git'
 group :development, :test do
   gem 'minitest'
   gem 'rake'
+  gem 'simplecov', '0.17.1'
 end

data/Makefile

@@ -0,0 +1,9 @@
+.PHONY: all build test
+
+all: build test
+
+build:
+	docker build -t simplybusiness/ruby-dev:2.6.5 .
+
+test:
+	docker run -it -v `pwd`:/var/app simplybusiness/ruby-dev:2.6.5 bundle exec rake test

data/README.md

@@ -42,9 +42,10 @@ This will write to STDOUT a JSON string:
 
 Obviously the timestamp will be different.
 
-Alternatively, if you just want to log some error message in text format
+Alternatively, if you just want to log some error string:
+
 ```ruby
-logger.error( "Emergency! There's an Emergency going on")
+logger.error("Emergency! There's an Emergency going on")
 ```
 
 This will write to STDOUT a JSON string:
@@ -53,11 +54,22 @@ This will write to STDOUT a JSON string:
 {"service":{"name":"service name"},"@timestamp":"2020-05-14T10:54:59.164+01:00","log":{"level":"error"}, "message":"Emergency! There's an Emergency going on"}
 ```
 
-Errors can be logged as well, and this will log the error message and backtrace in the relevant ECS compliant fields:
+A message is always required unless a block is provided. The message can be an object or a string.
+
+An optional error can also be provided, in which case the error message and backtrace will be logged in the relevant ECS compliant fields:
 
 ```ruby
 db_err = StandardError.new('Connection timed-out')
 logger.error({ message: 'DB connection failed.' }, db_err)
+
+# this is also valid
+logger.error('DB connection failed.', db_err)
+```
+
+These will both result in the same JSON string written to STDOUT:
+
+```json
+{"ecs":{"version":"1.5.0"},"@timestamp":"2020-08-21T15:44:37.890Z","service":{"name":"service name"},"log":{"level":"error"},"message":"DB connection failed.","error":{"message":"Connection timed-out"}}
 ```
 
 Add log event specific information simply as attributes in a hash:
@@ -81,18 +93,18 @@ This writes:
 {"service":{"name":"service name"},"@timestamp":"2020-05-14T10:56:49.527+01:00","log":{"level":"info"},"event":{"action":"HTTP request"},"message":"GET /pets success","trace":{"id":"1c8a5fb2-fecd-44d8-92a4-449eb2ce4dcb"},"http":{"request":{"method":"get"},"response":{"status_code":200}},"url":{"path":"/pets"}}
 ```
 
-Similar to error you can use text logging here as:
+Similar to error you can use string logging here as:
 
 ```
 logger.info('GET /pets success')
 ```
+
 This writes:
 
 ```json
 {"service":{"name":"service name"},"@timestamp":"2020-05-14T10:56:49.527+01:00","log":{"level":"info"}}
 ```
 
-
 It may be that when making a series of logs that write information about a single event, you may want to avoid duplication by creating an event specific logger that includes the context:
 
 ```ruby
@@ -117,7 +129,7 @@ which will print:
 {"service":{"name":"service name"},"@timestamp":"2020-05-14T10:58:30.780+01:00","log":{"level":"error"},"event":{"action":"HTTP request"},"trace":{"id":"126bb6fa-28a2-470f-b013-eefbf9182b2d"},"message":"Error 500 in /pets/buy","http":{"request":{"method":"post","url.path":"/pet/buy"},"response":{"status_code":500}}}
 ```
 
-## Use of dotted keys
+## Use of dotted keys (DEPRECATED)
 
 Writing nested json objects could be confusing. This library has a built-in feature to convert dotted keys into nested objects, so if you log like this:
 

data/Rakefile

@@ -2,6 +2,6 @@ require 'rake/testtask'
 
 Rake::TestTask.new do |t|
   t.libs << "test"
-  t.test_files = FileList['test/*_test.rb']
+  t.test_files = FileList['test/test_coverage.rb', 'test/*_test.rb', 'examples/rack/request_logger_test.rb']
   t.verbose = true
 end

data/examples/rack/example_rack_app.rb

@@ -0,0 +1,17 @@
+require 'twiglet/logger'
+require 'request_logger'
+
+# basic rack application
+class Application
+  def call(_env)
+    status  = 200
+    headers = { "Content-Type" => "text/json" }
+    body    = ["Example rack app"]
+
+    [status, headers, body]
+  end
+end
+
+use RequestLogger, Twiglet::Logger.new('example_app')
+
+run Application.new

data/examples/rack/request_logger.rb

@@ -0,0 +1,49 @@
+# Middleware for logging request logs
+class RequestLogger
+  def initialize(app, logger)
+    @app = app
+    @logger = logger
+  end
+
+  def call(env)
+    status, headers, body = @app.call(env)
+    log(env, status)
+    [status, headers, body]
+  rescue StandardError => e
+    log_error(env, 500, e)
+    [500, {}, body]
+  end
+
+  private
+
+  def log(env, status)
+    fields = get_fields(env, status)
+    @logger.info(fields)
+  end
+
+  def log_error(env, status, error)
+    fields = get_fields(env, status)
+    @logger.error(fields, error)
+  end
+
+  def get_fields(env, status)
+    message = "#{env['REQUEST_METHOD']}: #{env['PATH_INFO']}"
+
+    {
+      http: {
+        request: {
+          method: env['REQUEST_METHOD'],
+          server: env['SERVER_NAME'],
+          https_enabled: env['HTTPS'],
+          path: env['PATH_INFO'],
+          query: env['QUERY_STRING']  # Don't log PII query params
+        },
+        response: {
+          status: status,
+          body: { bytes: env['CONTENT_LENGTH'] }
+        }
+      },
+      message: message
+    }
+  end
+end

data/examples/rack/request_logger_test.rb

@@ -0,0 +1,66 @@
+require 'minitest/autorun'
+require_relative './request_logger'
+require 'rack'
+
+describe RequestLogger do
+  let(:output) { StringIO.new }
+
+  before { output.rewind }
+
+  it 'log should not be empty' do
+    request.get("/some/path")
+    log = output.string
+    refute_empty log
+  end
+
+  it 'logs the request data' do
+    request.get("/some/path?some_var=1")
+    log = JSON.parse(output.string)
+    http_body = {
+      "request" => {
+        "https_enabled" => "off",
+        "method" => "GET",
+        "path" => "/some/path",
+        "query" => "some_var=1",
+        "server" => "example.org"
+      },
+      "response" => {
+        "status" => 200,
+        "body" => { "bytes" => "0" }
+      }
+    }
+    assert_equal http_body, log["http"]
+    assert_equal "GET: /some/path", log["message"]
+  end
+
+  it 'does not log PII' do
+    request.post("/user/info", input_data: {credit_card_no: '1234'})
+    log = output.string
+    assert_includes log, "POST: /user/info"
+    refute_includes log, 'credit_card_no'
+    refute_includes log, '1234'
+  end
+
+  it 'logs an error message when a request is bad' do
+    bad_request.get("/some/path")
+    log = JSON.parse(output.string)
+    assert_equal 'error', log['log']['level']
+    assert_equal 'some exception', log['error']['message']
+  end
+end
+
+def request
+  app = ->(env) { [200, env, "app"] }
+  base_request(app)
+end
+
+def bad_request
+  app = Rack::Lint.new ->(_env) { raise StandardError, 'some exception' }
+  base_request(app)
+end
+
+def base_request(app)
+  logger = Twiglet::Logger.new('example', output: output)
+  req_logger = RequestLogger.new(app, logger)
+  Rack::MockRequest.new(req_logger)
+end

data/lib/twiglet/formatter.rb

@@ -1,5 +1,6 @@
 require 'logger'
 require_relative '../hash_extensions'
+require_relative 'message'
 
 module Twiglet
   class Formatter < ::Logger::Formatter
@@ -17,38 +18,12 @@ module Twiglet
 
     def call(severity, _time, _progname, msg)
       level = severity.downcase
-      log(level: level, message: msg)
+      log(level: level, message: Message.new(msg))
     end
 
     private
 
     def log(level:, message:)
-      case message
-      when String
-        log_text(level, message: message)
-      when Hash
-        log_object(level, message: message)
-      else
-        raise('Message must be String or Hash')
-      end
-    end
-
-    def log_text(level, message:)
-      raise('The \'message\' property of log object must not be empty') if message.strip.empty?
-
-      message = { message: message }
-      log_message(level, message: message)
-    end
-
-    def log_object(level, message:)
-      message = message.transform_keys(&:to_sym)
-      message.key?(:message) || raise('Log object must have a \'message\' property')
-      message[:message].strip.empty? && raise('The \'message\' property of log object must not be empty')
-
-      log_message(level, message: message)
-    end
-
-    def log_message(level, message:)
       base_message = {
         ecs: {
           version: '1.5.0'

data/lib/twiglet/logger.rb

@@ -5,6 +5,7 @@ require 'time'
 require 'json'
 require_relative 'formatter'
 require_relative '../hash_extensions'
+require_relative 'message'
 
 module Twiglet
   class Logger < ::Logger
@@ -29,7 +30,7 @@ module Twiglet
       super(output, formatter: formatter, level: level)
     end
 
-    def error(message = {}, error = nil, &block)
+    def error(message = nil, error = nil, &block)
       if error
         error_fields = {
           'error': {
@@ -37,7 +38,7 @@ module Twiglet
           }
         }
         add_stack_trace(error_fields, error)
-        message.is_a?(Hash) ? message.merge!(error_fields) : error_fields.merge!(message: message)
+        message = Message.new(message).merge(error_fields)
       end
 
       super(message, &block)

data/lib/twiglet/message.rb

@@ -0,0 +1,24 @@
+module Twiglet
+  class Message < Hash
+    def initialize(msg)
+      case msg
+      when String
+        self[:message] = msg
+      when Hash
+        replace(msg.transform_keys!(&:to_sym))
+      end
+
+      validate!
+    end
+
+    private
+
+    def validate!
+      raise 'Message must be initialized with a String or a non-empty Hash' if empty?
+
+      raise 'Log object must have a \'message\' property' unless self[:message]
+
+      raise 'The \'message\' property of the log object must not be empty' if self[:message].strip.empty?
+    end
+  end
+end

data/lib/twiglet/version.rb

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

data/test/logger_test.rb

@@ -230,6 +230,16 @@ describe Twiglet::Logger do
       refute actual_log[:error].key?(:stack_trace)
     end
 
+    it 'should log an error with string message' do
+      e = StandardError.new('Unknown error')
+      @logger.error('Artificially raised exception with string message', e)
+
+      actual_log = read_json(@buffer)
+
+      assert_equal 'Artificially raised exception with string message', actual_log[:message]
+      assert_equal 'Unknown error', actual_log[:error][:message]
+    end
+
     LEVELS.each do |attrs|
       it "should correctly log level when calling #{attrs[:method]}" do
         @logger.public_send(attrs[:method], {message: 'a log message'})

data/test/message_test.rb

@@ -0,0 +1,31 @@
+require 'minitest/autorun'
+require_relative '../lib/twiglet/message'
+
+describe Twiglet::Message do
+  it 'raises if message is empty' do
+    assert_raises RuntimeError do
+      Twiglet::Message.new('   ')
+    end
+  end
+
+  it 'raises if message is not provided' do
+    assert_raises RuntimeError do
+      Twiglet::Message.new(foo: 'bar')
+    end
+  end
+
+  it 'raises on unrecognized inputs' do
+    assert_raises RuntimeError do
+      Twiglet::Message.new(OpenStruct.new(message: 'hello'))
+    end
+  end
+
+  it 'returns a message hash from a string' do
+    assert_equal Twiglet::Message.new('hello, world'), { message: 'hello, world' }
+  end
+
+  it 'returns a message hash with symbolized keys' do
+    input_message = { 'key' => 'value', 'message' => 'hello, world' }
+    assert_equal Twiglet::Message.new(input_message), { key: 'value', message: 'hello, world' }
+  end
+end

data/test/test_coverage.rb

@@ -0,0 +1,13 @@
+require 'simplecov'
+
+SimpleCov.start do
+  add_filter "/test/"
+  add_filter "examples/rack/request_logger_test.rb"
+
+  if ENV['CI']
+    formatter SimpleCov::Formatter::SimpleFormatter
+  else
+    formatter SimpleCov::Formatter::MultiFormatter.new([SimpleCov::Formatter::SimpleFormatter,
+                                                        SimpleCov::Formatter::HTMLFormatter])
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twiglet
 version: !ruby/object:Gem::Version
-  version: 2.3.6
+  version: 2.3.11
 platform: ruby
 authors:
 - Simply Business
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-10 00:00:00.000000000 Z
+date: 2020-08-27 00:00:00.000000000 Z
 dependencies: []
 description: Like a log, only smaller.
 email:
@@ -20,23 +20,32 @@ files:
 - ".github/CODEOWNERS"
 - ".github/workflows/gem-publish.yml"
 - ".github/workflows/ruby.yml"
+- ".github/workflows/version-forget-me-not.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - ".ruby-version"
 - CODE_OF_CONDUCT.md
+- Dockerfile
 - Gemfile
 - LICENSE
+- Makefile
 - RATIONALE.md
 - README.md
 - Rakefile
 - example_app.rb
+- examples/rack/example_rack_app.rb
+- examples/rack/request_logger.rb
+- examples/rack/request_logger_test.rb
 - lib/hash_extensions.rb
 - lib/twiglet/formatter.rb
 - lib/twiglet/logger.rb
+- lib/twiglet/message.rb
 - lib/twiglet/version.rb
 - test/formatter_test.rb
 - test/hash_extensions_test.rb
 - test/logger_test.rb
+- test/message_test.rb
+- test/test_coverage.rb
 - twiglet.gemspec
 homepage: https://github.com/simplybusiness/twiglet-ruby
 licenses: