full_request_logger 0.1 → 0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bbae2d623039dd9c1b3f1f956adcb5769a4eae0aaae14b2bcaa2f1272fd3d8ac
-  data.tar.gz: 8799755a93425af26cf02bb6fa38f53cc0087ff1cea0318845f26326dc0a5b0c
+  metadata.gz: 69103e9dda0de7ad14689c9479265fa4148620f406ba2cecc10e7350db55c183
+  data.tar.gz: ad9049fdc9cc3c55e462dee1205af4df4239522f1a2f9902c3d0457e4e2b4de3
 SHA512:
-  metadata.gz: 3d92ba086bb4f520f6b8e97143c7c82dbc69d7c8c1dd03fd27de96faa5d773c6cbc7a85d4f8e3db002422a8682ee6bf5d5202c4a078e2d3a7d79eb835882e5b5
-  data.tar.gz: 0e4bd4e58a52d3eac3d1c09ecda279c0aaa547cfeaf4802135bc82958ecd188bfe9728a8b82ea890b29d4b2c61eb90f0a4f05ec9e44647786c39846f98f5b1c1
+  metadata.gz: dec6f6c382133e02c94d8c875bab02cd925c046f91b6f0a85b742e707863fc4dbcee5256528d5d2332bd2c69ce251660b82227bb035ffecdcb843ac0ea2c47e9
+  data.tar.gz: a9f6274384f9a81f4178cca95b99b28dbd72a9a960309055f0524b7c6c4ac2cea4a3508f36eb535d64c61d2191f30fbfc250aab7aa4600e982a869eb3a47d502

data/Gemfile.lock

@@ -0,0 +1,147 @@
+PATH
+  remote: .
+  specs:
+    full_request_logger (0.1)
+      rails (>= 6.0.0)
+      redis (>= 4.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (6.0.0)
+      actionpack (= 6.0.0)
+      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)
+      mail (>= 2.7.1)
+    actionmailer (6.0.0)
+      actionpack (= 6.0.0)
+      actionview (= 6.0.0)
+      activejob (= 6.0.0)
+      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)
+      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)
+      nokogiri (>= 1.8.5)
+    actionview (6.0.0)
+      activesupport (= 6.0.0)
+      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)
+      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)
+      marcel (~> 0.3.1)
+    activesupport (6.0.0)
+      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)
+    byebug (11.0.1)
+    concurrent-ruby (1.1.5)
+    crass (1.0.5)
+    erubi (1.9.0)
+    globalid (0.4.2)
+      activesupport (>= 4.2.0)
+    i18n (1.7.0)
+      concurrent-ruby (~> 1.0)
+    loofah (2.3.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)
+    mini_mime (1.0.2)
+    mini_portile2 (2.4.0)
+    minitest (5.12.2)
+    nio4r (2.5.2)
+    nokogiri (1.10.4)
+      mini_portile2 (~> 2.4.0)
+    rack (2.0.7)
+    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)
+      bundler (>= 1.3.0)
+      railties (= 6.0.0)
+      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)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.20.3, < 2.0)
+    rake (13.0.0)
+    redis (4.1.3)
+    sprockets (4.0.0)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.1)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    thor (0.20.3)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    websocket-driver (0.7.1)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.4)
+    zeitwerk (2.2.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  byebug
+  full_request_logger!
+  rake
+
+BUNDLED WITH
+   1.17.2

data/README.md

@@ -2,7 +2,7 @@
 
 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 flush all the log lines that were recorded for that request as a compressed batch to an expiring Redis key.
+the recorder store all the log lines that were recorded for that request as a compressed batch to an auto-expiring Redis key.
 
 Thus you no longer have to grep through log files or wrestle with logging pipelines to instantly see all the
 log lines relevant to a request you just made. This is ideal for when you're testing a feature in the wild with

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

@@ -1,11 +1,16 @@
 module Rails
   class Conductor::FullRequestLogger::RequestLogsController < ActionController::Base
-    if credentials = FullRequestLogger.credentials
-      http_basic_authenticate_with credentials
-    end
+    before_action :authenticate
 
     layout "rails/conductor"
 
+    def index
+    end
+
+    def create
+      redirect_to rails_conductor_request_log_url(params[:id])
+    end
+
     def show
       if @logs = FullRequestLogger::Recorder.instance.retrieve(params[:id])
         respond_to do |format|
@@ -16,5 +21,12 @@ module Rails
         head :not_found
       end
     end
+
+    private
+      def authenticate
+        if credentials = FullRequestLogger.credentials
+          http_basic_authenticate_or_request_with credentials
+        end
+      end
   end
 end

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

@@ -0,0 +1,7 @@
+<h1>Lookup a request log</h1>
+
+<%= 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.submit "Retrieve" %>
+<% end %>

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

@@ -1,5 +1,8 @@
 <h1>Request: <%= params[:id] %></h1>
 
-<p><%= link_to "Download", rails_conductor_request_log_path(params[:id], format: :text) %></p>
+<p>
+  <%= link_to "Download this request log", rails_conductor_request_log_path(params[:id], format: :text) %> |
+  <%= link_to "Lookup another request", rails_conductor_request_logs_path %>
+</p>
 
-<pre><%= @logs %></pre>
+<pre style="background: black; color: white; padding: 10px"><%= @logs %></pre>

data/config/routes.rb

@@ -2,6 +2,6 @@
 
 Rails.application.routes.draw do
   scope "rails/conductor/full_request_logger/", module: "rails/conductor/full_request_logger" do
-    resources :request_logs, only: :show, as: :rails_conductor_request_logs
+    resources :request_logs, only: %i[ index create show ], as: :rails_conductor_request_logs
   end
 end

data/full_request_logger.gemspec

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

data/lib/full_request_logger/middleware.rb

@@ -7,7 +7,7 @@ module FullRequestLogger
     def call(env)
       @app.call(env).tap do
         if FullRequestLogger.enabled
-          Recorder.instance.flush ActionDispatch::Request.new(env).request_id
+          Recorder.instance.store ActionDispatch::Request.new(env).request_id
         end
       end
     end

data/lib/full_request_logger/recorder.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "redis"
 require "zlib"
 
 class FullRequestLogger::Recorder
@@ -13,37 +14,47 @@ class FullRequestLogger::Recorder
     @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)
-    )
+    logger.extend ActiveSupport::Logger.broadcast(ActiveSupport::Logger.new(self))
   end
 
+  # Writes a log message to a buffer that'll be stored when the request is over.
   def write(message)
     messages << remove_ansi_colors(message)
   end
 
-  def log
+  # Return a single string with all the log messages that have been buffered so far.
+  def combined_log
     messages.join.strip
   end
 
-  def flush(request_id)
-    if (log_to_be_flushed = log).present?
+  # Store all log messages as a single string to the full request logging storage accessible under the +request_id+.
+  def store(request_id)
+    if (log_to_be_stored = combined_log).present?
       redis.setex \
         request_key(request_id),
         FullRequestLogger.ttl,
-        compress(log_to_be_flushed)
+        compress(log_to_be_stored)
     end
   ensure
     messages.clear
   end
 
+  # Returns a single string with all the log messages that were captured for the given +request_id+ (or nil if nothing was
+  # recorded or it has since expired).
   def retrieve(request_id)
     if log = redis.get(request_key(request_id))
       uncompress(log).force_encoding("utf-8")
     end
   end
 
+  # Clear out any messages pending in the buffer as well as all existing stored request logs.
+  def reset
+    messages.clear
+    clear_stored_requests
+  end
+
   # no-op needed for Logger to treat this as a valid log device
   def close
     redis.disconnect!
@@ -62,6 +73,12 @@ class FullRequestLogger::Recorder
       "full_request_logger/requests/#{id}"
     end
 
+    def clear_stored_requests
+      if (request_keys = redis.keys(request_key("*"))).any?
+        redis.del request_keys
+      end
+    end
+
     def compress(text)
       Zlib::Deflate.deflate(text)
     end

data/test/dummy/.babelrc

@@ -0,0 +1,18 @@
+{
+  "presets": [
+    ["env", {
+      "modules": false,
+      "targets": {
+        "browsers": "> 1%",
+        "uglify": true
+      },
+      "useBuiltIns": true
+    }]
+  ],
+
+  "plugins": [
+    "syntax-dynamic-import",
+    "transform-object-rest-spread",
+    ["transform-class-properties", { "spec": true }]
+  ]
+}

data/test/dummy/.gitignore

@@ -0,0 +1,3 @@
+*.log
+*.sqlite3
+tmp/*

data/test/dummy/.postcssrc.yml

@@ -0,0 +1,3 @@
+plugins:
+  postcss-import: {}
+  postcss-cssnext: {}

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require_relative 'config/application'
+
+Rails.application.load_tasks

data/test/dummy/app/assets/config/manifest.js

@@ -0,0 +1,3 @@
+//= link_tree ../images
+//= link_directory ../javascripts .js
+//= link_directory ../stylesheets .css

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/test/dummy/app/assets/stylesheets/scaffold.css

@@ -0,0 +1,80 @@
+body {
+  background-color: #fff;
+  color: #333;
+  margin: 33px;
+}
+
+body, p, ol, ul, td {
+  font-family: verdana, arial, helvetica, sans-serif;
+  font-size: 13px;
+  line-height: 18px;
+}
+
+pre {
+  background-color: #eee;
+  padding: 10px;
+  font-size: 11px;
+}
+
+a {
+  color: #000;
+}
+
+a:visited {
+  color: #666;
+}
+
+a:hover {
+  color: #fff;
+  background-color: #000;
+}
+
+th {
+  padding-bottom: 5px;
+}
+
+td {
+  padding: 0 5px 7px;
+}
+
+div.field,
+div.actions {
+  margin-bottom: 10px;
+}
+
+#notice {
+  color: green;
+}
+
+.field_with_errors {
+  padding: 2px;
+  background-color: red;
+  display: table;
+}
+
+#error_explanation {
+  width: 450px;
+  border: 2px solid red;
+  padding: 7px 7px 0;
+  margin-bottom: 20px;
+  background-color: #f0f0f0;
+}
+
+#error_explanation h2 {
+  text-align: left;
+  font-weight: bold;
+  padding: 5px 5px 5px 15px;
+  font-size: 12px;
+  margin: -7px -7px 0;
+  background-color: #c00;
+  color: #fff;
+}
+
+#error_explanation ul li {
+  font-size: 12px;
+  list-style: square;
+}
+
+label {
+  display: block;
+}