trainspotter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f16e8da81b6991459274f9b8833de22ec79efb5fa2766ebf81e63b6e1546d578
+  data.tar.gz: 3af436892b6ee8a664710e22b28d9e2a58790462f9861cff8a2ae0cc0dea69be
+SHA512:
+  metadata.gz: 0a6a38c16936cd01883a74ed208e163faec3829f19fbf5f01d7c0b003efc8e5bfca4e015236ce0aec7253cb912822f26c28d77b32fb1e92b69b49bdbba09e74d
+  data.tar.gz: c754879f16a6706abfabfd59dc7b9ad89f06713047f375a9912cb32d3abfaab91a7673b29cd2e110d53e854d2d8f869f3f66bb28adb3dcac83052661feac7aac

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright Micah Geisel
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,103 @@
+# Trainspotter
+
+A zero-config, web-based Rails log viewer with request grouping and session tracking. See your Rails logs in a beautiful, organized interface right in your browser.
+
+## Features
+
+- **Zero configuration** - Just mount the engine and go
+- **Request grouping** - See HTTP requests with their associated SQL queries and view renders
+- **Session tracking** - Group requests by user session with automatic login/logout detection
+- **Real-time updates** - New requests appear automatically via polling
+- **Background processing** - Log ingestion runs in a background job
+- **SQLite storage** - Separate database for fast queries without impacting your app
+- **Dark/light mode** - Respects your system preference
+- **Performance at a glance** - See request duration, query count, and render count
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "trainspotter"
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+## Usage
+
+Mount the engine in your `config/routes.rb`:
+
+```ruby
+Rails.application.routes.draw do
+  mount Trainspotter::Engine => "/admin/logs"
+
+  # Your other routes...
+end
+```
+
+That's it! Visit `/trainspotter` in your browser to see your logs.
+
+### Restricting Access
+
+In production, you'll likely want to restrict access. Here are some options:
+
+**With Devise:**
+
+```ruby
+authenticate :user, ->(u) { u.admin? } do
+  mount Trainspotter::Engine => "/trainspotter"
+end
+```
+
+**With HTTP Basic Auth:**
+
+```ruby
+mount Trainspotter::Engine => "/trainspotter", constraints: ->(req) {
+  Rack::Auth::Basic::Request.new(req.env).provided? &&
+  Rack::Auth::Basic::Request.new(req.env).credentials == ["admin", ENV["TRAINSPOTTER_PASSWORD"]]
+}
+```
+
+**Development only:**
+
+```ruby
+if Rails.env.development?
+  mount Trainspotter::Engine => "/trainspotter"
+end
+```
+
+## How It Works
+
+Trainspotter reads your Rails log files and parses the standard Rails log format. A background job (`IngestJob`) processes new log entries and stores them in a separate SQLite database.
+
+**Requests View:**
+- HTTP method and path
+- Controller and action
+- Response status (color-coded)
+- Total duration
+- Number of SQL queries and view renders
+- Click to expand and see SQL queries and renders
+
+**Sessions View:**
+- Groups requests by user session (based on IP + time window)
+- Automatic login/logout detection
+- See all requests made during a session
+
+Trainspotter supports tagged logging (`config.log_tags = [:request_id]`) for accurate request grouping in multi-threaded environments.
+
+## Requirements
+
+- Rails 8.0+
+- Ruby 3.3+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/botandrose/trainspotter.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/setup"
+
+require "bundler/gem_tasks"
+
+require "rspec/core/rake_task"
+require "cucumber/rake/task"
+
+RSpec::Core::RakeTask.new(:spec)
+Cucumber::Rake::Task.new(:cucumber)
+
+task default: %i[spec cucumber]

data/app/controllers/trainspotter/application_controller.rb

@@ -0,0 +1,11 @@
+module Trainspotter
+  class ApplicationController < ActionController::Base
+    before_action :ensure_trainspotter_connected
+
+    private
+
+    def ensure_trainspotter_connected
+      Record.ensure_connected
+    end
+  end
+end

data/app/controllers/trainspotter/requests_controller.rb

@@ -0,0 +1,46 @@
+module Trainspotter
+  class RequestsController < ApplicationController
+    def index
+      @current_log_file = params[:log_file] || Trainspotter.default_log_file
+      @current_ip = params[:ip].presence
+      @available_log_files = Trainspotter.available_log_files
+
+      all_requests = filter_requests(RequestRecord.recent(log_file: @current_log_file))
+      @available_ips = RequestRecord.unique_ips(log_file: @current_log_file)
+      @requests = filter_by_ip(all_requests).first(50)
+    end
+
+    def poll
+      log_file = params[:log_file] || Trainspotter.default_log_file
+      ip_filter = params[:ip].presence
+      since_id = params[:since_id].presence
+
+      new_requests = filter_by_ip(
+        filter_requests(RequestRecord.poll_for_changes(log_file: log_file, since_id: since_id)),
+        ip_filter
+      )
+
+      render json: {
+        requests: new_requests.map { |r| render_request_html(r) },
+        since_id: new_requests.last&.id
+      }
+    end
+
+    private
+
+    def render_request_html(request)
+      render_to_string(partial: "trainspotter/requests/request", locals: { request: request })
+    end
+
+    def filter_requests(requests)
+      requests.reject do |request|
+        Trainspotter.filter_request?(request.path) || Trainspotter.internal_request?(request)
+      end
+    end
+
+    def filter_by_ip(requests, ip = @current_ip)
+      return requests if ip.blank?
+      requests.select { |request| request.ip == ip }
+    end
+  end
+end

data/app/controllers/trainspotter/sessions_controller.rb

@@ -0,0 +1,30 @@
+module Trainspotter
+  class SessionsController < ApplicationController
+    def index
+      @current_log_file = params[:log_file] || Trainspotter.default_log_file
+      @available_log_files = Trainspotter.available_log_files
+      @show_anonymous = params[:show_anonymous] == "1"
+
+      @sessions = SessionRecord.recent(
+        log_file: @current_log_file,
+        include_anonymous: @show_anonymous,
+        limit: 50
+      )
+    end
+
+    def requests
+      requests = RequestRecord.for_session(params[:id], limit: 200)
+      @requests = filter_requests(requests)
+
+      render json: {
+        requests: @requests.map { |r| render_to_string(partial: "trainspotter/requests/request", locals: { request: r }) }
+      }
+    end
+
+    private
+
+    def filter_requests(requests)
+      requests.reject { |r| Trainspotter.filter_request?(r.path) || Trainspotter.internal_request?(r) }
+    end
+  end
+end

data/app/engine_assets/javascripts/application.js

@@ -0,0 +1,7 @@
+import { Application } from "@hotwired/stimulus"
+import RequestsController from "trainspotter/controllers/requests_controller"
+import SessionsController from "trainspotter/controllers/sessions_controller"
+
+const application = Application.start()
+application.register("requests", RequestsController)
+application.register("sessions", SessionsController)

data/app/engine_assets/javascripts/controllers/requests_controller.js

@@ -0,0 +1,67 @@
+import { Controller } from "@hotwired/stimulus"
+
+export default class extends Controller {
+  static targets = ["list", "status", "logFile", "ipFilter", "autoScroll"]
+  static values = {
+    pollUrl: String,
+    rootUrl: String,
+    sinceId: String,
+    logFile: String,
+    ip: String
+  }
+
+  connect() {
+    this.scrollToBottom()
+    this.poll()
+  }
+
+  poll() {
+    const params = new URLSearchParams()
+    params.set("log_file", this.logFileValue)
+    if (this.sinceIdValue) params.set("since_id", this.sinceIdValue)
+    if (this.ipValue) params.set("ip", this.ipValue)
+
+    fetch(`${this.pollUrlValue}?${params}`)
+      .then(response => response.json())
+      .then(data => {
+        if (data.requests?.length > 0) {
+          data.requests.forEach(html => {
+            this.listTarget.insertAdjacentHTML("beforeend", html)
+          })
+          this.scrollToBottom()
+          this.element.querySelector(".empty-state")?.remove()
+        }
+        if (data.since_id) this.sinceIdValue = data.since_id
+        this.statusTarget.classList.remove("disconnected")
+        this.statusTarget.classList.add("connected")
+      })
+      .catch(() => {
+        this.statusTarget.classList.remove("connected")
+        this.statusTarget.classList.add("disconnected")
+      })
+      .finally(() => setTimeout(() => this.poll(), 1000))
+  }
+
+  scrollToBottom() {
+    if (this.autoScrollTarget.checked) {
+      this.listTarget.scrollTop = this.listTarget.scrollHeight
+    }
+  }
+
+  changeLogFile() {
+    this.logFileValue = this.logFileTarget.value
+    window.location.href = this.buildUrl()
+  }
+
+  changeIp() {
+    this.ipValue = this.ipFilterTarget.value
+    window.location.href = this.buildUrl()
+  }
+
+  buildUrl() {
+    const params = new URLSearchParams()
+    params.set("log_file", this.logFileValue)
+    if (this.ipValue) params.set("ip", this.ipValue)
+    return `${this.rootUrlValue}?${params}`
+  }
+}

data/app/engine_assets/javascripts/controllers/sessions_controller.js

@@ -0,0 +1,43 @@
+import { Controller } from "@hotwired/stimulus"
+
+export default class extends Controller {
+  static targets = ["logFile", "showAnonymous"]
+  static values = { sessionsUrl: String }
+
+  changeLogFile() {
+    window.location.href = this.buildUrl()
+  }
+
+  changeShowAnonymous() {
+    window.location.href = this.buildUrl()
+  }
+
+  buildUrl() {
+    const params = new URLSearchParams()
+    if (this.hasLogFileTarget) params.set("log_file", this.logFileTarget.value)
+    if (this.hasShowAnonymousTarget && this.showAnonymousTarget.checked) {
+      params.set("show_anonymous", "1")
+    }
+    return `${this.sessionsUrlValue}?${params}`
+  }
+
+  loadSession(event) {
+    const details = event.currentTarget
+    if (!details.open || details.dataset.loaded) return
+
+    details.dataset.loaded = "true"
+    const sessionId = details.dataset.sessionId
+    const content = details.querySelector(".session-requests")
+
+    fetch(`${this.sessionsUrlValue}/${sessionId}/requests`)
+      .then(response => response.json())
+      .then(data => {
+        content.innerHTML = data.requests?.length > 0
+          ? data.requests.join("")
+          : '<p class="empty-hint">No requests in this session.</p>'
+      })
+      .catch(() => {
+        content.innerHTML = '<p class="error-hint">Failed to load requests.</p>'
+      })
+  }
+}