superlogger 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '082cbc716a6f0432e73617a883fd03584bd8f3de5a1f3f32afd6a48882d05f76'
-  data.tar.gz: c85c50a9e182a78c3c281a427b5fd351c4c01b9181dbeffe81a6831bc51f7b39
+  metadata.gz: 31133b660d9663478b8feabfa3bfc2f38431485648ef434230ae56e778b9a65c
+  data.tar.gz: 7c2bf630ad96997d64a6ac7224a3635fe3dd6246b79ab289305498bdf68a5ac8
 SHA512:
-  metadata.gz: 7f5eb670792f8cb1abf4a4b3830b7b0e415b9f0849d9339bf8ddce091dc71dd7f2cc455813f7c6ca64fafba40ab8de59f32c6fd1a6c5cec74d24968caecc3624
-  data.tar.gz: bc3c65ddb32e7e5eec96de1028d86a12557fda30643797eb71e863db4dac24fcf82dd5434a8c72639a9eb78b1168e60fc4c2dc3fbbd71fffb6a0dcbf08cc3f13
+  metadata.gz: 29ca48eafa2e7e648cb852e6e2142aa4092f95b5e1b86a9cd0eb432ac180616b9af0c2746c6cfa161ec997038fe7e38b3b5552bb8bf01b0a55ae7003211bad0b
+  data.tar.gz: b554d0898a26c4b32936754cec07cc557faafa74c719e918c789d20b7f11110e98915ff62476d2de199d2bc0a0a445011c7531f02642b5acbaf4e1caa5382142

data/README.md

@@ -72,3 +72,34 @@ Rails.logger.info "Meatball"
 - `request_id` = 32 characters
 - `msg` = If values given is not a hash, it is treated as `{"msg":<value>"}`
 - All duration related fields are in milliseconds
+
+To log additional fields that are available on the `ActionDispatch::Request` object, set in `config/application.rb`:
+```ruby
+Superlogger.include_log_fields = lambda do |request|
+  # Return a hash of extra fields to log.
+  {
+    user_id: request.session[:current_user].id,
+    ip: request.ip
+  }
+end
+```
+
+## Testing ##
+
+To run the tests for Superlogger:
+
+```sh
+rake test
+```
+
+## Publishing a New Release ##
+
+1. Bump the version in `lib/superlogger/version.rb`.
+1. Run `bundle install` to update the version of Superlogger in `Gemfile.lock`.
+1. Open a pull request with the changes from the above steps.
+1. After the pull request is merged, publish a new release on GitHub with the same version tag.
+1. Clear all temporary files to prevent them from being bundled into the gem.
+   This is most easily achieved by building from a new clone of the repository.
+1. Run `gem build superlogger.gemspec` to build the gem.
+1. Run `gem push superlogger-x.x.x.gem` to publish the gem to RubyGems.
+   You will be prompted for credentials if this is your first time publishing the gem on your machine.

data/lib/superlogger/superlogger_middleware.rb

@@ -1,7 +1,10 @@
 module Superlogger
   class SuperloggerMiddleware
-    def initialize(app)
+    def initialize(app, options = {})
       @app = app
+      @options = {
+        include_log_fields: ->(_request) { {} }
+      }.merge(options)
     end
 
     def call(env)
@@ -15,7 +18,8 @@ module Superlogger
     end
 
     def process_request(request)
-      setup_logging(request)
+      setup_request_id_for_logging(request)
+      setup_session_id_for_logging(request)
 
       # Start of request
       Rails.logger.info method: request.method, path: request.fullpath
@@ -27,20 +31,24 @@ module Superlogger
 
       # End of request
       duration = ((t2 - t1) * 1000).to_f.round(2)
-      Rails.logger.info method: request.method, path: request.fullpath, response_time: duration, status: status
+
+      # After the request has been processed, the session ID can change from what it was before the request
+      # was processed. As such, we need to setup the session ID again.
+      setup_session_id_for_logging(request)
+
+      Rails.logger.info method: request.method, path: request.fullpath, response_time: duration, status: status, **@options[:include_log_fields].call(request)
 
       [status, _headers, _response]
     end
 
-    def setup_logging(request)
-      if request.env['rack.session']
-        # Store session id before any actual logging is done
-        if request.env['rack.session'].id
-          Superlogger.session_id = request.env['rack.session'].id.to_s
-        end
-      end
-
+    def setup_request_id_for_logging(request)
       Superlogger.request_id = request.uuid.try(:gsub, '-', '')
     end
+
+    def setup_session_id_for_logging(request)
+      return unless request.env['rack.session']&.id
+
+      Superlogger.session_id = request.env['rack.session'].id.to_s
+    end
   end
 end

data/lib/superlogger/version.rb

@@ -1,3 +1,3 @@
 module Superlogger
-  VERSION = '1.0.1'
+  VERSION = '1.1.0'
 end

data/lib/superlogger.rb

@@ -3,6 +3,7 @@ require 'superlogger/logger'
 
 module Superlogger
   @@enabled = false
+  @@include_log_fields = nil
 
   module_function
 
@@ -18,7 +19,9 @@ module Superlogger
     require 'superlogger/superlogger_middleware'
 
     # important to insert after session middleware so we can get the session id
-    app.middleware.use Superlogger::SuperloggerMiddleware
+    app.middleware.use Superlogger::SuperloggerMiddleware, {
+      include_log_fields: @@include_log_fields
+    }.compact
   end
 
   def detach_existing_log_subscribers
@@ -74,6 +77,14 @@ module Superlogger
   def enabled
     @@enabled
   end
+
+  def include_log_fields=(include_log_fields)
+    @@include_log_fields=include_log_fields
+  end
+
+  def include_log_fields
+    @@include_log_fields
+  end
 end
 
 require 'superlogger/railtie' if defined?(Rails)

data/test/dummy/app/controllers/home_controller.rb

@@ -2,4 +2,10 @@ class HomeController < ApplicationController
   def index
     Something.where(paper: '123', stone: '456').first
   end
+
+  def index_with_session
+    # Force load session by writing to it.
+    session[:current_time] = Time.now
+    redirect_to action: :index
+  end
 end

data/test/dummy/config/application.rb

@@ -23,5 +23,13 @@ module Dummy
     
     Superlogger.enabled = true
     config.logger = Superlogger::Logger.new(STDOUT)
+
+    Superlogger.include_log_fields = lambda do |request|
+      session = request.session
+      {
+        current_time: session[:current_time],
+        hello: 'world'
+      }
+    end
   end
 end

data/test/dummy/config/routes.rb

@@ -1,3 +1,4 @@
 Rails.application.routes.draw do
   get 'home/index'
+  get 'home/index_with_session'
 end

data/test/superlogger_test.rb

@@ -33,10 +33,30 @@ class SuperloggerTest < ActiveSupport::TestCase
     assert_not_nil Superlogger::VERSION
   end
 
-  test 'log format' do
+  test 'log format when session is not loaded' do
     request('home/index')
 
-    fields = output.first
+    fields = output[4]
+    assert fields.key?("level")
+    assert fields.key?("ts")
+    assert fields.key?("caller")
+    assert_equal fields.key?("session_id"), false
+    assert fields.key?("request_id")
+  end
+
+  test 'log format when session is loaded' do
+    request('home/index_with_session')
+
+    # Session is not loaded before the request is processed.
+    fields = output[0]
+    assert fields.key?("level")
+    assert fields.key?("ts")
+    assert fields.key?("caller")
+    assert_equal fields.key?("session_id"), false
+    assert fields.key?("request_id")
+
+    # Session is loaded after the request is processed.
+    fields = output[4]
     assert fields.key?("level")
     assert fields.key?("ts")
     assert fields.key?("caller")
@@ -44,14 +64,49 @@ class SuperloggerTest < ActiveSupport::TestCase
     assert fields.key?("request_id")
   end
 
+  # The additional fields to log are defined in `/test/dummy/config/application.rb`.
+  # Unfortunately, because `Superlogger::SuperloggerMiddleware` is initialised
+  # together with the Rails application, and because we cannot programmatically
+  # reinitialise the Rails application or run multiple instances of it, we are
+  # only able to test a single Superlogger configuration. Once the Rails
+  # application is initialised, the middleware stack cannot be changed.
+  #
+  # This effectively means that we are unable to change the Superlogger settings
+  # in the Rails application configuration on a per-test basis. For the sake of
+  # testing, we choose the Superlogger settings that let us test the presence of
+  # behaviours and set the additional fields to log.
+  test 'log format when logging additional fields' do
+    request('home/index_with_session')
+
+    # Additional fields are not logged before the request is processed.
+    fields = output[0]
+    assert fields.key?("level")
+    assert fields.key?("ts")
+    assert fields.key?("caller")
+    assert_equal fields.key?("session_id"), false
+    assert fields.key?("request_id")
+    assert_equal fields.key?("current_time"), false
+    assert_equal fields.key?("hello"), false
+
+    # Additional fields are logged after the request is processed.
+    fields = output[4]
+    assert fields.key?("level")
+    assert fields.key?("ts")
+    assert fields.key?("caller")
+    assert fields.key?("session_id")
+    assert fields.key?("request_id")
+    assert fields.key?("current_time")
+    assert fields.key?("hello")
+  end
+
   test 'timestamp' do
     request('home/index')
     assert_equal Time.at(output[0]["ts"]).to_date, Date.today
   end
 
   test 'with session_id' do
-    env = request('home/index')
-    assert_match env['rack.session'].id.to_s[0..11], output[0]["session_id"]
+    env = request('home/index_with_session')
+    assert_match env['rack.session'].id.to_s[0..11], output[4]["session_id"]
   end
 
   test 'without session_id' do
@@ -108,7 +163,7 @@ class SuperloggerTest < ActiveSupport::TestCase
   test 'action_controller_log_subscriber.process_action' do
     request('home/index')
 
-    fields = output[5]
+    fields = output[7]
     assert_operator fields["view_duration"], :>, 0
     assert_operator fields["db_duration"], :>, 0
   end
@@ -116,11 +171,11 @@ class SuperloggerTest < ActiveSupport::TestCase
   test 'action_view_log_subscriber.render_template.render_partial.render_collection' do
     request('home/index')
 
-    fields = output[3]
+    fields = output[4]
     assert_match 'partial.html.erb', fields["view"]
     assert fields.key?("duration")
 
-    fields = output[4]
+    fields = output[5]
     assert_match 'index.html.erb', fields["view"]
     assert fields.key?("duration")
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: superlogger
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Soh Yu Ming
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-04 00:00:00.000000000 Z
+date: 2024-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -117,7 +117,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
+rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
 summary: Machine-readable logging for Rails