full_request_logger 0.3 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3277ad6d1379e4c24c95d9cea1d1f8aba4e2459296e554b325dbd190dbe5405a
-  data.tar.gz: cd66762f0e1c159111a7f842ec5c093680d6cac023d6094699b391586801da3b
+  metadata.gz: c29787f9346418ef668cf13d447e5213744323c20a268af972ef5fd95420270c
+  data.tar.gz: 68477467205afbb579f81d122780eeca0240e8b2fa530673ad58ce2a7b9dd7f5
 SHA512:
-  metadata.gz: c4999de51e83269df0d1224423670a7a2e22b82cd3751cc1af77fc3a787179663270d14d3be9675a6423848bf84e184c9d55c140c2fab4c93c4c7b621f365f9b
-  data.tar.gz: 072af0e253a048a8419a8c2b2c443927541a6871bb557b6b9a18b7c16da8fb02e06f9c24f29df569386459af5f3115e0eb534120c257de5b6cbde94197e778bf
+  metadata.gz: 503622938851c3ef75cdb957b7dfa4c54208f577b5d8e46f6dbb01cdbad30b29e17952c47287845f295d33b72ac096380955226fa8d0f8bd74ab7b330c849f57
+  data.tar.gz: e03156b8169140f7d72294c604848590bda8a5bacca7be04730f7b88c6697323b89ba26e75c34fd69dd8b97f6ce048661d0c474c85d4b2cb51220718aea3ca6d

data/Gemfile.lock

@@ -2,117 +2,117 @@ PATH
   remote: .
   specs:
     full_request_logger (0.3)
-      rails (>= 6.0.0)
+      rails (>= 5.0.0)
       redis (>= 4.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (6.0.0)
-      actionpack (= 6.0.0)
+    actioncable (6.0.2.2)
+      actionpack (= 6.0.2.2)
       nio4r (~> 2.0)
       websocket-driver (>= 0.6.1)
-    actionmailbox (6.0.0)
-      actionpack (= 6.0.0)
-      activejob (= 6.0.0)
-      activerecord (= 6.0.0)
-      activestorage (= 6.0.0)
-      activesupport (= 6.0.0)
+    actionmailbox (6.0.2.2)
+      actionpack (= 6.0.2.2)
+      activejob (= 6.0.2.2)
+      activerecord (= 6.0.2.2)
+      activestorage (= 6.0.2.2)
+      activesupport (= 6.0.2.2)
       mail (>= 2.7.1)
-    actionmailer (6.0.0)
-      actionpack (= 6.0.0)
-      actionview (= 6.0.0)
-      activejob (= 6.0.0)
+    actionmailer (6.0.2.2)
+      actionpack (= 6.0.2.2)
+      actionview (= 6.0.2.2)
+      activejob (= 6.0.2.2)
       mail (~> 2.5, >= 2.5.4)
       rails-dom-testing (~> 2.0)
-    actionpack (6.0.0)
-      actionview (= 6.0.0)
-      activesupport (= 6.0.0)
-      rack (~> 2.0)
+    actionpack (6.0.2.2)
+      actionview (= 6.0.2.2)
+      activesupport (= 6.0.2.2)
+      rack (~> 2.0, >= 2.0.8)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actiontext (6.0.0)
-      actionpack (= 6.0.0)
-      activerecord (= 6.0.0)
-      activestorage (= 6.0.0)
-      activesupport (= 6.0.0)
+    actiontext (6.0.2.2)
+      actionpack (= 6.0.2.2)
+      activerecord (= 6.0.2.2)
+      activestorage (= 6.0.2.2)
+      activesupport (= 6.0.2.2)
       nokogiri (>= 1.8.5)
-    actionview (6.0.0)
-      activesupport (= 6.0.0)
+    actionview (6.0.2.2)
+      activesupport (= 6.0.2.2)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activejob (6.0.0)
-      activesupport (= 6.0.0)
+    activejob (6.0.2.2)
+      activesupport (= 6.0.2.2)
       globalid (>= 0.3.6)
-    activemodel (6.0.0)
-      activesupport (= 6.0.0)
-    activerecord (6.0.0)
-      activemodel (= 6.0.0)
-      activesupport (= 6.0.0)
-    activestorage (6.0.0)
-      actionpack (= 6.0.0)
-      activejob (= 6.0.0)
-      activerecord (= 6.0.0)
+    activemodel (6.0.2.2)
+      activesupport (= 6.0.2.2)
+    activerecord (6.0.2.2)
+      activemodel (= 6.0.2.2)
+      activesupport (= 6.0.2.2)
+    activestorage (6.0.2.2)
+      actionpack (= 6.0.2.2)
+      activejob (= 6.0.2.2)
+      activerecord (= 6.0.2.2)
       marcel (~> 0.3.1)
-    activesupport (6.0.0)
+    activesupport (6.0.2.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-      zeitwerk (~> 2.1, >= 2.1.8)
-    builder (3.2.3)
+      zeitwerk (~> 2.2)
+    builder (3.2.4)
     byebug (11.0.1)
-    concurrent-ruby (1.1.5)
-    crass (1.0.5)
+    concurrent-ruby (1.1.6)
+    crass (1.0.6)
     erubi (1.9.0)
     globalid (0.4.2)
       activesupport (>= 4.2.0)
-    i18n (1.7.0)
+    i18n (1.8.2)
       concurrent-ruby (~> 1.0)
-    loofah (2.3.0)
+    loofah (2.4.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     mail (2.7.1)
       mini_mime (>= 0.1.1)
     marcel (0.3.3)
       mimemagic (~> 0.3.2)
-    method_source (0.9.2)
-    mimemagic (0.3.3)
+    method_source (1.0.0)
+    mimemagic (0.3.4)
     mini_mime (1.0.2)
     mini_portile2 (2.4.0)
-    minitest (5.12.2)
+    minitest (5.14.0)
     nio4r (2.5.2)
-    nokogiri (1.10.4)
+    nokogiri (1.10.9)
       mini_portile2 (~> 2.4.0)
-    rack (2.0.7)
+    rack (2.2.2)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
-    rails (6.0.0)
-      actioncable (= 6.0.0)
-      actionmailbox (= 6.0.0)
-      actionmailer (= 6.0.0)
-      actionpack (= 6.0.0)
-      actiontext (= 6.0.0)
-      actionview (= 6.0.0)
-      activejob (= 6.0.0)
-      activemodel (= 6.0.0)
-      activerecord (= 6.0.0)
-      activestorage (= 6.0.0)
-      activesupport (= 6.0.0)
+    rails (6.0.2.2)
+      actioncable (= 6.0.2.2)
+      actionmailbox (= 6.0.2.2)
+      actionmailer (= 6.0.2.2)
+      actionpack (= 6.0.2.2)
+      actiontext (= 6.0.2.2)
+      actionview (= 6.0.2.2)
+      activejob (= 6.0.2.2)
+      activemodel (= 6.0.2.2)
+      activerecord (= 6.0.2.2)
+      activestorage (= 6.0.2.2)
+      activesupport (= 6.0.2.2)
       bundler (>= 1.3.0)
-      railties (= 6.0.0)
+      railties (= 6.0.2.2)
       sprockets-rails (>= 2.0.0)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
     rails-html-sanitizer (1.3.0)
       loofah (~> 2.3)
-    railties (6.0.0)
-      actionpack (= 6.0.0)
-      activesupport (= 6.0.0)
+    railties (6.0.2.2)
+      actionpack (= 6.0.2.2)
+      activesupport (= 6.0.2.2)
       method_source
       rake (>= 0.8.7)
       thor (>= 0.20.3, < 2.0)
@@ -125,14 +125,14 @@ GEM
       actionpack (>= 4.0)
       activesupport (>= 4.0)
       sprockets (>= 3.0.0)
-    thor (0.20.3)
+    thor (1.0.1)
     thread_safe (0.3.6)
-    tzinfo (1.2.5)
+    tzinfo (1.2.6)
       thread_safe (~> 0.1)
     websocket-driver (0.7.1)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.4)
-    zeitwerk (2.2.0)
+    zeitwerk (2.3.0)
 
 PLATFORMS
   ruby

data/README.md

@@ -1,6 +1,6 @@
 # Full Request Logger
 
-Easy access to full request logs via a web UI. The recorder attaches to the existing Rails.logger instance, 
+Easy access to full request logs via a web UI. The recorder attaches to the existing Rails.logger instance,
 and captures a copy of each log line into a per-thread buffer. When the request is over, the middleware makes
 the recorder store all the log lines that were recorded for that request as a compressed batch to an auto-expiring Redis key.
 
@@ -17,14 +17,14 @@ gem 'full_request_logger'
 
 ## Configuration
 
-Add to development.rb and/or production.rb. Default time-to-live (TTL) for reach recorded request is 10 minutes,
+Add to development.rb and/or production.rb. Default time-to-live (TTL) for each recorded request is 10 minutes,
 and the default Redis storage is assumed to live on localhost, but both can be overwritten. Only configuration needed
 is the enabled setting.
 
 ```ruby
 config.full_request_logger.enabled = true
 config.full_request_logger.ttl     = 1.hour
-config.full_request_logger.redis   = { host: "127.0.0.1", port: 36379, timeout: 1 }
+config.full_request_logger.redis   = { host: "127.0.0.1", port: 6379, timeout: 1 }
 ```
 
 You can restrict which requests will be stored by setting an eligibility function that gets to evaluate the request:
@@ -46,7 +46,7 @@ full_request_logger:
 
 ## Usage
 
-Access request logs via `/rails/conductor/full_request_logger/request_logs/:id` where id is the X-Request-Id.
+Access request logs via `/rails/conductor/full_request_logger/request_logs`.
 
 ## License
 

data/app/controllers/rails/conductor/full_request_logger/request_logs_controller.rb

@@ -1,6 +1,7 @@
 module Rails
   class Conductor::FullRequestLogger::RequestLogsController < ActionController::Base
     before_action :authenticate
+    skip_before_action :verify_authenticity_token, only: :create
 
     layout "rails/conductor"
 
@@ -18,7 +19,7 @@ module Rails
           format.text { send_data @logs, disposition: :attachment, filename: "#{params[:id]}.log" }
         end
       else
-        head :not_found
+        redirect_to rails_conductor_request_logs_url, alert: "Request not found!"
       end
     end
 

data/app/views/rails/conductor/full_request_logger/request_logs/index.html.erb

@@ -1,7 +1,9 @@
 <h1>Lookup a request log</h1>
 
+<% if alert = flash[:alert] %><p style="color: red"><%= alert %></p><% end %>
+
 <%= form_with url: rails_conductor_request_logs_path do |form| %>
   <p>Copy the X-Request-Id header and paste it in:</p>
-  <%= form.text_field :id, size: 40, placeholder: "0540689b-1ec6-4b92-ae8e-1c55bf7c3b79" %>
+  <%= form.text_field :id, size: 40, placeholder: "0540689b-1ec6-4b92-ae8e-1c55bf7c3b79", autofocus: true %>
   <%= form.submit "Retrieve" %>
 <% end %>

data/full_request_logger.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name     = 'full_request_logger'
-  s.version  = '0.3'
+  s.version  = '0.3.1'
   s.authors  = 'David Heinemeier Hansson'
   s.email    = 'david@basecamp.com'
   s.summary  = 'Make full request logs accessible via web UI'
@@ -9,7 +9,7 @@ Gem::Specification.new do |s|
 
   s.required_ruby_version = '>= 2.6.0'
 
-  s.add_dependency 'rails', '>= 6.0.0'
+  s.add_dependency 'rails', '>= 5.0.0'
   s.add_dependency 'redis', '>= 4.0'
 
   s.add_development_dependency 'bundler', '~> 1.17'

data/lib/full_request_logger/engine.rb

@@ -1,5 +1,6 @@
 require "rails/engine"
 require "full_request_logger/middleware"
+require "full_request_logger/job"
 
 module FullRequestLogger
   class Engine < Rails::Engine
@@ -12,6 +13,12 @@ module FullRequestLogger
       config.app_middleware.insert_after ::ActionDispatch::RequestId, FullRequestLogger::Middleware
     end
 
+    initializer "full_request_logger.job" do
+      ActiveSupport.on_load(:active_job) do
+        include FullRequestLogger::Job
+      end
+    end
+
     initializer "full_request_logger.configs" do
       config.after_initialize do |app|
         FullRequestLogger.enabled     = app.config.full_request_logger.enabled || false

data/lib/full_request_logger/job.rb

@@ -0,0 +1,9 @@
+module FullRequestLogger::Job
+  extend ActiveSupport::Concern
+
+  included do
+    alias_method :request_id, :job_id
+
+    after_perform { |job| FullRequestLogger::Processor.new(job).process }
+  end
+end

data/lib/full_request_logger/middleware.rb

@@ -5,7 +5,7 @@ module FullRequestLogger
     end
 
     def call(env)
-      @app.call(env).tap { Processor.new(env).process }
+      @app.call(env).tap { Processor.new(ActionDispatch::Request.new(env)).process }
     end
   end
 end

data/lib/full_request_logger/processor.rb

@@ -1,9 +1,8 @@
 require "full_request_logger/recorder"
-require "action_dispatch/http/request"
 
 class FullRequestLogger::Processor
-  def initialize(env)
-    @env = env
+  def initialize(request)
+    @request = request
   end
 
   def process
@@ -15,6 +14,9 @@ class FullRequestLogger::Processor
   end
 
   private
+    attr_reader :request
+    delegate :request_id, to: :request
+
     def enabled?
       FullRequestLogger.enabled
     end
@@ -32,9 +34,4 @@ class FullRequestLogger::Processor
     def recorder
       @recorder ||= FullRequestLogger::Recorder.instance
     end
-
-    delegate :request_id, to: :request
-    def request
-      @request ||= ActionDispatch::Request.new(@env)
-    end
 end

data/test/processor_test.rb

@@ -11,7 +11,7 @@ class ProcessorTest < ActiveSupport::TestCase
   FRL    = FullRequestLogger::Recorder.instance.tap { |frl| frl.attach_to(LOGGER) }
 
   setup do
-    @processor = FullRequestLogger::Processor.new({ "action_dispatch.request_id" => "123" })
+    @processor = FullRequestLogger::Processor.new(ActionDispatch::Request.new({ "action_dispatch.request_id" => "123" }))
   end
 
   teardown { FRL.clear_all }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: full_request_logger
 version: !ruby/object:Gem::Version
-  version: '0.3'
+  version: 0.3.1
 platform: ruby
 authors:
 - David Heinemeier Hansson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-19 00:00:00.000000000 Z
+date: 2020-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.0.0
+        version: 5.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.0.0
+        version: 5.0.0
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
@@ -71,6 +71,7 @@ files:
 - full_request_logger.gemspec
 - lib/full_request_logger.rb
 - lib/full_request_logger/engine.rb
+- lib/full_request_logger/job.rb
 - lib/full_request_logger/middleware.rb
 - lib/full_request_logger/processor.rb
 - lib/full_request_logger/recorder.rb