full_request_logger 0.2 → 0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 69103e9dda0de7ad14689c9479265fa4148620f406ba2cecc10e7350db55c183
-  data.tar.gz: ad9049fdc9cc3c55e462dee1205af4df4239522f1a2f9902c3d0457e4e2b4de3
+  metadata.gz: 3277ad6d1379e4c24c95d9cea1d1f8aba4e2459296e554b325dbd190dbe5405a
+  data.tar.gz: cd66762f0e1c159111a7f842ec5c093680d6cac023d6094699b391586801da3b
 SHA512:
-  metadata.gz: dec6f6c382133e02c94d8c875bab02cd925c046f91b6f0a85b742e707863fc4dbcee5256528d5d2332bd2c69ce251660b82227bb035ffecdcb843ac0ea2c47e9
-  data.tar.gz: a9f6274384f9a81f4178cca95b99b28dbd72a9a960309055f0524b7c6c4ac2cea4a3508f36eb535d64c61d2191f30fbfc250aab7aa4600e982a869eb3a47d502
+  metadata.gz: c4999de51e83269df0d1224423670a7a2e22b82cd3751cc1af77fc3a787179663270d14d3be9675a6423848bf84e184c9d55c140c2fab4c93c4c7b621f365f9b
+  data.tar.gz: 072af0e253a048a8419a8c2b2c443927541a6871bb557b6b9a18b7c16da8fb02e06f9c24f29df569386459af5f3115e0eb534120c257de5b6cbde94197e778bf

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    full_request_logger (0.1)
+    full_request_logger (0.3)
       rails (>= 6.0.0)
       redis (>= 4.0)
 

data/README.md

@@ -27,6 +27,14 @@ config.full_request_logger.ttl     = 1.hour
 config.full_request_logger.redis   = { host: "127.0.0.1", port: 36379, timeout: 1 }
 ```
 
+You can restrict which requests will be stored by setting an eligibility function that gets to evaluate the request:
+
+```ruby
+config.full_request_logger.eligibility = ->(request) { request.params[:full_request_log] == "1" }
+```
+
+This makes it easier to use the logger on a busy site that would otherwise result in a lot of needless redis writes.
+
 The request logs access can be protected behind http basic by adding the following credentials
 (using `./bin/rails credentials:edit --environment production`):
 

data/full_request_logger.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name     = 'full_request_logger'
-  s.version  = '0.2'
+  s.version  = '0.3'
   s.authors  = 'David Heinemeier Hansson'
   s.email    = 'david@basecamp.com'
   s.summary  = 'Make full request logs accessible via web UI'

data/lib/full_request_logger.rb

@@ -4,9 +4,11 @@ module FullRequestLogger
   extend ActiveSupport::Autoload
 
   autoload :Recorder
+  autoload :Processor
 
   mattr_accessor :ttl
   mattr_accessor :redis
   mattr_accessor :enabled
+  mattr_accessor :eligibility
   mattr_accessor :credentials
 end

data/lib/full_request_logger/engine.rb

@@ -17,6 +17,7 @@ module FullRequestLogger
         FullRequestLogger.enabled     = app.config.full_request_logger.enabled || false
         FullRequestLogger.ttl         = app.config.full_request_logger.ttl   || 10.minutes
         FullRequestLogger.redis       = app.config.full_request_logger.redis || {}
+        FullRequestLogger.eligibility = app.config.full_request_logger.eligibility || true
         FullRequestLogger.credentials = app.config.full_request_logger.credentials || app.credentials.full_request_logger
       end
     end

data/lib/full_request_logger/middleware.rb

@@ -5,11 +5,7 @@ module FullRequestLogger
     end
 
     def call(env)
-      @app.call(env).tap do
-        if FullRequestLogger.enabled
-          Recorder.instance.store ActionDispatch::Request.new(env).request_id
-        end
-      end
+      @app.call(env).tap { Processor.new(env).process }
     end
   end
-end
+end

data/lib/full_request_logger/processor.rb

@@ -0,0 +1,40 @@
+require "full_request_logger/recorder"
+require "action_dispatch/http/request"
+
+class FullRequestLogger::Processor
+  def initialize(env)
+    @env = env
+  end
+
+  def process
+    if enabled? && eligible_for_storage?
+      recorder.store request_id
+    else
+      recorder.clear
+    end
+  end
+
+  private
+    def enabled?
+      FullRequestLogger.enabled
+    end
+
+    def eligible_for_storage?
+      if eligibility.respond_to?(:call)
+        eligibility.call(request)
+      else
+        eligibility
+      end
+    end
+
+    delegate :eligibility, to: FullRequestLogger
+
+    def recorder
+      @recorder ||= FullRequestLogger::Recorder.instance
+    end
+
+    delegate :request_id, to: :request
+    def request
+      @request ||= ActionDispatch::Request.new(@env)
+    end
+end

data/lib/full_request_logger/recorder.rb

@@ -4,16 +4,10 @@ require "redis"
 require "zlib"
 
 class FullRequestLogger::Recorder
-  attr_reader :redis
-
   def self.instance
     @instance ||= new
   end
 
-  def initialize
-    @redis = Redis.new FullRequestLogger.redis
-  end
-
   # Extends an existing logger instance with a broadcast aspect that'll send a copy of all logging lines to this recorder.
   def attach_to(logger)
     logger.extend ActiveSupport::Logger.broadcast(ActiveSupport::Logger.new(self))
@@ -38,7 +32,7 @@ class FullRequestLogger::Recorder
         compress(log_to_be_stored)
     end
   ensure
-    messages.clear
+    clear
   end
 
   # Returns a single string with all the log messages that were captured for the given +request_id+ (or nil if nothing was
@@ -49,9 +43,14 @@ class FullRequestLogger::Recorder
     end
   end
 
-  # Clear out any messages pending in the buffer as well as all existing stored request logs.
-  def reset
+  # Clears the current buffer of log messages.
+  def clear
     messages.clear
+  end
+
+  # Clear out any messages pending in the buffer as well as all existing stored request logs.
+  def clear_all
+    clear
     clear_stored_requests
   end
 
@@ -61,6 +60,10 @@ class FullRequestLogger::Recorder
   end
 
   private
+    def redis
+      @redis ||= Redis.new FullRequestLogger.redis
+    end
+
     def messages
       Thread.current[:full_request_logger_messages] ||= []
     end

data/test/processor_test.rb

@@ -0,0 +1,64 @@
+require_relative "../test/dummy/config/environment"
+require "rails/test_help"
+
+require "full_request_logger"
+
+FullRequestLogger.enabled = true
+FullRequestLogger.eligibility = true
+
+class ProcessorTest < ActiveSupport::TestCase
+  LOGGER = Logger.new(StringIO.new)
+  FRL    = FullRequestLogger::Recorder.instance.tap { |frl| frl.attach_to(LOGGER) }
+
+  setup do
+    @processor = FullRequestLogger::Processor.new({ "action_dispatch.request_id" => "123" })
+  end
+
+  teardown { FRL.clear_all }
+
+  test "store when enabled with basic eligibility" do
+    LOGGER.info "hello!"
+    @processor.process
+    assert FRL.combined_log.blank?
+    assert_equal "hello!", FRL.retrieve("123")
+  end
+
+  test "clear without store when not enabled" do
+    begin
+      FullRequestLogger.enabled = false
+
+      LOGGER.info "hello!"
+      @processor.process
+      assert FRL.combined_log.blank?
+      assert_nil FRL.retrieve("123")
+    ensure
+      FullRequestLogger.enabled = true
+    end
+  end
+
+  test "successful eligibility will store request" do
+    begin
+      FullRequestLogger.eligibility = ->(request) { request.request_id == "123" }
+
+      LOGGER.info "hello!"
+      @processor.process
+      assert FRL.combined_log.blank?
+      assert_equal "hello!", FRL.retrieve("123")
+    ensure
+      FullRequestLogger.eligibility = true
+    end
+  end
+
+  test "failing eligibility will not store request" do
+    begin
+      FullRequestLogger.eligibility = ->(request) { request.request_id == "678" }
+
+      LOGGER.info "hello!"
+      @processor.process
+      assert FRL.combined_log.blank?
+      assert_nil FRL.retrieve("123")
+    ensure
+      FullRequestLogger.eligibility = true
+    end
+  end
+end

data/test/recorder_test.rb

@@ -9,7 +9,7 @@ class RecorderTest < ActiveSupport::TestCase
     @full_request_logger = FullRequestLogger::Recorder.new.tap { |frl| frl.attach_to(@logger) }
   end
 
-  teardown { @full_request_logger.reset }
+  teardown { @full_request_logger.clear_all }
 
   test "attached frl will store writes made to logger" do
     @logger.info "This is a line"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: full_request_logger
 version: !ruby/object:Gem::Version
-  version: '0.2'
+  version: '0.3'
 platform: ruby
 authors:
 - David Heinemeier Hansson
@@ -72,6 +72,7 @@ files:
 - lib/full_request_logger.rb
 - lib/full_request_logger/engine.rb
 - lib/full_request_logger/middleware.rb
+- lib/full_request_logger/processor.rb
 - lib/full_request_logger/recorder.rb
 - test/dummy/.babelrc
 - test/dummy/.gitignore
@@ -136,6 +137,7 @@ files:
 - test/dummy/public/apple-touch-icon-precomposed.png
 - test/dummy/public/apple-touch-icon.png
 - test/dummy/public/favicon.ico
+- test/processor_test.rb
 - test/recorder_test.rb
 homepage: https://github.com/basecamp/full_request_logger
 licenses:
@@ -224,4 +226,5 @@ test_files:
 - test/dummy/public/apple-touch-icon-precomposed.png
 - test/dummy/public/apple-touch-icon.png
 - test/dummy/public/favicon.ico
+- test/processor_test.rb
 - test/recorder_test.rb