rails_event_viewer 0.1.0

data/app/controllers/rails_event_viewer/application_controller.rb

@@ -0,0 +1,84 @@
+module RailsEventViewer
+  class ApplicationController < ActionController::Base
+    include Pagy::Method
+
+    layout "rails_event_viewer/application"
+
+    before_action :authenticate!
+    around_action :use_viewer_time_zone
+
+    helper_method :current_timezone, :current_adapter, :analytics_supported?, :persistence_supported?
+
+    private
+
+    def authenticate!
+      if RailsEventViewer.http_basic_auth_enabled
+        expected_user = RailsEventViewer.http_basic_auth_user.to_s
+        expected_password = RailsEventViewer.http_basic_auth_password.to_s
+
+        if expected_user.empty? || expected_password.empty?
+          render plain: "RailsEventViewer: http_basic_auth_user and http_basic_auth_password must be set", status: :forbidden
+          return
+        end
+
+        authenticate_or_request_with_http_basic do |user, password|
+          ActiveSupport::SecurityUtils.secure_compare(user.to_s, expected_user) &
+            ActiveSupport::SecurityUtils.secure_compare(password.to_s, expected_password)
+        end
+        return
+      end
+
+      auth = RailsEventViewer.authentication
+      if auth.nil?
+        return true if Rails.env.local?
+
+        render plain: "RailsEventViewer: configure authentication or http_basic_auth", status: :forbidden
+        return
+      end
+
+      render plain: "Unauthorized", status: :unauthorized unless auth.call(self) || performed?
+    end
+
+    def use_viewer_time_zone(&block)
+      zone = ActiveSupport::TimeZone[cookies[:timezone].to_s] || ActiveSupport::TimeZone["UTC"]
+      Time.use_zone(zone, &block)
+    end
+
+    def safe_parse_date(date_string, default: nil)
+      return default if date_string.blank?
+
+      Date.parse(date_string)
+    rescue Date::Error, TypeError
+      default
+    end
+
+    def current_timezone
+      Time.zone.name
+    end
+
+    def current_adapter
+      RailsEventViewer.adapter
+    end
+
+    def analytics_supported?
+      current_adapter.supports_analytics?
+    end
+
+    def persistence_supported?
+      current_adapter.supports_persistence?
+    end
+
+    def per_page
+      (params[:per_page] || RailsEventViewer.per_page).to_i.clamp(1, 100)
+    end
+
+    # Helper to create paginated results from EventsRelation
+    # Uses a countable wrapper to make EventsRelation work with Pagy
+    def pagy_events(relation)
+      countable = RailsEventViewer::PagyCountable.new(relation)
+      pagy, records = pagy(:offset, countable, limit: per_page)
+
+      [pagy, records.to_a]
+    end
+  end
+end

data/app/controllers/rails_event_viewer/dashboard_controller.rb

@@ -0,0 +1,18 @@
+module RailsEventViewer
+  class DashboardController < ApplicationController
+    def index
+      @total_events = RailsEventViewer.events.count
+      @events_today = current_adapter.count_since(Time.current.beginning_of_day)
+      @event_names = current_adapter.distinct_event_names
+      @recent_events = RailsEventViewer.events.limit(10).to_a
+
+      if analytics_supported?
+        @events_by_type = current_adapter.counts_by_name(limit: 10)
+        @events_over_time = current_adapter.events_over_time(since: 24.hours.ago, interval: :hour)
+      else
+        @events_by_type = {}
+        @events_over_time = {}
+      end
+    end
+  end
+end

data/app/controllers/rails_event_viewer/event_types_controller.rb

@@ -0,0 +1,16 @@
+module RailsEventViewer
+  class EventTypesController < ApplicationController
+    def index
+      @event_types = current_adapter.event_type_statistics
+    end
+
+    def show
+      @event_type_name = params[:name]
+      total_events = RailsEventViewer.events.with_name(@event_type_name)
+
+      @pagy, @events = pagy_events(total_events)
+      @total_count = @pagy.count
+      @events_today = total_events.since(Time.current.beginning_of_day).count
+    end
+  end
+end

data/app/controllers/rails_event_viewer/events_controller.rb

@@ -0,0 +1,72 @@
+module RailsEventViewer
+  class EventsController < ApplicationController
+    def index
+      relation = apply_filters(RailsEventViewer.events)
+      @pagy, @events = pagy_events(relation)
+      @event_names = current_adapter.distinct_event_names
+    end
+
+    def show
+      @event = current_adapter.find_event(params[:id])
+
+      if @event.nil?
+        redirect_to events_path, alert: "Event not found"
+        return
+      end
+
+      @related_events = find_related_events(@event)
+    end
+
+    def search
+      @query = params[:q]
+      relation = RailsEventViewer.events.search(@query)
+      @pagy, @events = pagy_events(relation)
+      @event_names = current_adapter.distinct_event_names
+
+      render :index
+    end
+
+    private
+
+    def apply_filters(relation)
+      relation = relation.with_name(params[:name]) if params[:name].present?
+
+      @start_date = safe_parse_date(params[:start_date])
+      @end_date = safe_parse_date(params[:end_date])
+      relation = relation.since(@start_date.beginning_of_day) if @start_date
+      relation = relation.until(@end_date.end_of_day) if @end_date
+
+      if params[:tag_key].present?
+        relation = relation.with_tag(params[:tag_key], params[:tag_value].presence)
+      end
+
+      if params[:context_key].present?
+        relation = relation.with_context(params[:context_key], params[:context_value].presence)
+      end
+
+      if params[:q].present?
+        relation = relation.search(params[:q])
+      end
+
+      relation
+    end
+
+    def find_related_events(event)
+      context = event.respond_to?(:context) ? event.context : event[:context]
+      return [] unless context.present?
+
+      # Find events with matching request_id in context
+      request_id = context["request_id"] || context[:request_id]
+      return [] unless request_id
+
+      event_id = event.respond_to?(:id) ? event.id : event[:id]
+
+      RailsEventViewer.events
+        .with_context("request_id", request_id)
+        .limit(11)
+        .to_a
+        .reject { |e| (e.respond_to?(:id) ? e.id : e[:id]) == event_id }
+        .first(10)
+    end
+  end
+end

data/app/controllers/rails_event_viewer/groups_controller.rb

@@ -0,0 +1,52 @@
+module RailsEventViewer
+  class GroupsController < ApplicationController
+    def index
+      @group_keys = RailsEventViewer.group_keys
+      @selected_key = params[:key].presence_in(@group_keys.map(&:to_s)) || @group_keys.first&.to_s
+      @source = source_param
+
+      if @selected_key.present?
+        @groups = current_adapter.group_instances(
+          @selected_key,
+          source: @source,
+          limit: 100
+        )
+      else
+        @groups = []
+      end
+    end
+
+    def show
+      @key = params[:key]
+      @value = params[:id]
+      @source = source_param
+
+      events = if @source == :tags
+        RailsEventViewer.events.with_tag(@key, @value)
+      else
+        RailsEventViewer.events.with_context(@key, @value)
+      end
+
+      @pagy, @events = pagy_events(events)
+      @total_count = @pagy.count
+      @event_names = @events.map { |e| event_name(e) }.uniq
+
+      @first_event_at, @last_event_at = current_adapter.event_time_span(events)
+      @duration = @last_event_at - @first_event_at if @first_event_at && @last_event_at
+    end
+
+    private
+
+    def source_param
+      params[:source].presence_in(%w[context tags])&.to_sym || :context
+    end
+
+    def event_name(event)
+      event.respond_to?(:name) ? event.name : event[:name]
+    end
+
+    def event_occurred_at(event)
+      event.respond_to?(:occurred_at) ? event.occurred_at : event[:occurred_at]
+    end
+  end
+end

data/app/helpers/rails_event_viewer/application_helper.rb

@@ -0,0 +1,163 @@
+module RailsEventViewer
+  module ApplicationHelper
+    def nav_link_class(controller)
+      base_classes = "rounded-md px-3 py-2 text-sm font-medium"
+
+      if controller_name == controller
+        "#{base_classes} bg-indigo-700 text-white"
+      else
+        "#{base_classes} text-indigo-200 hover:bg-indigo-500 hover:text-white"
+      end
+    end
+
+    # Format event time - works with both Entry model and Hash
+    def format_event_time(event)
+      time = event_occurred_at(event)
+      return "N/A" unless time
+
+      time.strftime("%Y-%m-%d %H:%M:%S.%3N")
+    end
+
+    def time_ago_with_title(time)
+      return "N/A" unless time
+
+      content_tag(:span, time_ago_in_words(time) + " ago", title: time.strftime("%Y-%m-%d %H:%M:%S %Z"))
+    end
+
+    def truncate_json(json, length: 100)
+      text = json.is_a?(Hash) ? json.to_json : json.to_s
+      truncate(text, length: length)
+    end
+
+    def json_tree(data, depth: 0, max_depth: nil)
+      return content_tag(:span, "null", class: "text-gray-400") if data.nil?
+      return content_tag(:span, data.to_json, class: json_value_class(data)) unless data.is_a?(Hash) || data.is_a?(Array)
+      return content_tag(:span, collapsed_summary(data), class: "text-gray-400") if max_depth && depth >= max_depth
+
+      if data.is_a?(Hash)
+        render_hash_tree(data, depth, max_depth)
+      else
+        render_array_tree(data, depth, max_depth)
+      end
+    end
+
+    def timezone_options
+      ActiveSupport::TimeZone.all.map { |tz| [tz.to_s, tz.name] }
+    end
+
+    # Helper to get attribute from either Entry model or Hash
+    def event_attribute(event, attr)
+      if event.respond_to?(attr)
+        event.public_send(attr)
+      elsif event.is_a?(Hash)
+        event[attr] || event[attr.to_s]
+      end
+    end
+
+    def event_id(event)
+      event_attribute(event, :id)
+    end
+
+    def event_name(event)
+      event_attribute(event, :name)
+    end
+
+    def event_payload(event)
+      event_attribute(event, :payload) || {}
+    end
+
+    def event_tags(event)
+      event_attribute(event, :tags) || {}
+    end
+
+    def event_context(event)
+      event_attribute(event, :context) || {}
+    end
+
+    def event_occurred_at(event)
+      event_attribute(event, :occurred_at)
+    end
+
+    def event_source_file(event)
+      event_attribute(event, :source_file)
+    end
+
+    def event_source_line(event)
+      event_attribute(event, :source_line)
+    end
+
+    def event_source_label(event)
+      event_attribute(event, :source_label)
+    end
+
+    def event_short_filepath(event)
+      filepath = event_source_file(event)
+      return nil unless filepath
+
+      filepath.gsub(%r{.*/app/}, "app/")
+    end
+
+    def format_duration(seconds)
+      return "-" unless seconds
+
+      duration = ActiveSupport::Duration.build(seconds)
+      parts = duration.parts
+
+      return "0 seconds" if parts.empty? || parts == { seconds: 0 }
+
+      parts.map { |unit, value|
+        unit_name = value == 1 ? unit.to_s.singularize : unit.to_s
+        "#{value} #{unit_name}"
+      }.to_sentence
+    end
+
+    private
+
+    def json_value_class(value)
+      case value
+      when String
+        "text-green-600"
+      when Numeric
+        "text-blue-600"
+      when TrueClass, FalseClass
+        "text-purple-600"
+      else
+        "text-gray-900"
+      end
+    end
+
+    def collapsed_summary(data)
+      if data.is_a?(Hash)
+        data.empty? ? "{}" : "{#{data.size} #{"key".pluralize(data.size)}}"
+      else
+        data.empty? ? "[]" : "[#{data.size} #{"item".pluralize(data.size)}]"
+      end
+    end
+
+    def render_hash_tree(hash, depth, max_depth)
+      return content_tag(:span, "{}", class: "text-gray-400") if hash.empty?
+
+      content_tag(:div, class: "pl-4") do
+        hash.map do |key, value|
+          content_tag(:div, class: "py-0.5") do
+            content_tag(:span, "#{key}:", class: "text-gray-600 font-medium mr-2") +
+              json_tree(value, depth: depth + 1, max_depth: max_depth)
+          end
+        end.join.html_safe
+      end
+    end
+
+    def render_array_tree(array, depth, max_depth)
+      return content_tag(:span, "[]", class: "text-gray-400") if array.empty?
+
+      content_tag(:div, class: "pl-4") do
+        array.each_with_index.map do |value, index|
+          content_tag(:div, class: "py-0.5") do
+            content_tag(:span, "[#{index}]:", class: "text-gray-400 mr-2") +
+              json_tree(value, depth: depth + 1, max_depth: max_depth)
+          end
+        end.join.html_safe
+      end
+    end
+  end
+end

data/app/models/rails_event_viewer/application_record.rb

@@ -0,0 +1,5 @@
+module RailsEventViewer
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/rails_event_viewer/entry.rb

@@ -0,0 +1,34 @@
+module RailsEventViewer
+  class Entry < ApplicationRecord
+    self.table_name = "rails_event_viewer_entries"
+
+    validates :name, presence: true
+    validates :occurred_at, presence: true
+
+    def source_location
+      {
+        filepath: source_file,
+        lineno: source_line,
+        label: source_label
+      }.compact
+    end
+
+    def short_filepath
+      return nil unless source_file
+
+      source_file.gsub(%r{.*/app/}, "app/")
+    end
+
+    def tagged?
+      tags.present? && tags.any?
+    end
+
+    def has_context?
+      context.present? && context.any?
+    end
+
+    def tag(key)
+      tags&.dig(key.to_s)
+    end
+  end
+end

data/app/views/layouts/rails_event_viewer/application.html.erb

@@ -0,0 +1,45 @@
+<!DOCTYPE html>
+<html lang="en" class="h-full bg-gray-100">
+<head>
+  <title><%= content_for(:title) || "Rails Event Viewer" %></title>
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <!-- Tailwind CSS CDN (replace with bundled CSS in production) -->
+  <script src="https://cdn.tailwindcss.com"></script>
+
+  <!-- Chart.js for Chartkick (with date adapter for time-series charts) -->
+  <script src="https://cdn.jsdelivr.net/npm/chart.js@4.4.1/dist/chart.umd.min.js"></script>
+  <script src="https://cdn.jsdelivr.net/npm/chartjs-adapter-date-fns@3.0.0/dist/chartjs-adapter-date-fns.bundle.min.js"></script>
+  <script src="https://cdn.jsdelivr.net/npm/chartkick@5.0.1/dist/chartkick.min.js"></script>
+
+  <%= stylesheet_link_tag "rails_event_viewer/application", media: "all", "data-turbo-track": "reload" %>
+  <%= javascript_importmap_tags if respond_to?(:javascript_importmap_tags) %>
+
+  <%= yield :head %>
+</head>
+<body class="h-full">
+  <div class="min-h-full">
+    <%= render "rails_event_viewer/shared/navigation" %>
+
+    <main class="py-6">
+      <div class="mx-auto max-w-7xl px-4 sm:px-6 lg:px-8">
+        <% if notice.present? %>
+          <div class="mb-4 rounded-md bg-green-50 p-4">
+            <p class="text-sm font-medium text-green-800"><%= notice %></p>
+          </div>
+        <% end %>
+
+        <% if alert.present? %>
+          <div class="mb-4 rounded-md bg-red-50 p-4">
+            <p class="text-sm font-medium text-red-800"><%= alert %></p>
+          </div>
+        <% end %>
+
+        <%= yield %>
+      </div>
+    </main>
+  </div>
+</body>
+</html>

data/app/views/rails_event_viewer/analytics/overview.html.erb

@@ -0,0 +1,134 @@
+<% content_for(:title, "Analytics - Rails Event Viewer") %>
+
+<div class="space-y-6">
+  <div class="flex justify-between items-center">
+    <h1 class="text-2xl font-bold text-gray-900">Analytics</h1>
+
+    <!-- Date range picker -->
+    <%= form_with url: rails_event_viewer.analytics_overview_path, method: :get, class: "flex items-center space-x-3" do |f| %>
+      <%= f.date_field :start_date,
+          value: @date_range.begin.to_date,
+          class: "rounded-md border border-gray-300 shadow-sm focus:border-indigo-500 focus:ring-indigo-500 py-2 px-3" %>
+      <span class="text-gray-500">to</span>
+      <%= f.date_field :end_date,
+          value: @date_range.end.to_date,
+          class: "rounded-md border border-gray-300 shadow-sm focus:border-indigo-500 focus:ring-indigo-500 py-2 px-3" %>
+      <%= f.submit "Apply",
+          class: "bg-indigo-600 text-white px-5 py-2.5 rounded-md font-medium hover:bg-indigo-700 cursor-pointer" %>
+    <% end %>
+  </div>
+
+  <!-- Overview stats -->
+  <div class="grid grid-cols-1 gap-5 sm:grid-cols-2 lg:grid-cols-4">
+    <%= render "rails_event_viewer/shared/stat_card",
+        title: "Total Events",
+        value: number_with_delimiter(@total_events),
+        icon: "database" %>
+    <%= render "rails_event_viewer/shared/stat_card",
+        title: "Unique Types",
+        value: @unique_event_types,
+        icon: "tag" %>
+    <%= render "rails_event_viewer/shared/stat_card",
+        title: "Avg/Hour",
+        value: @avg_events_per_hour,
+        icon: "clock" %>
+    <%= render "rails_event_viewer/shared/stat_card",
+        title: "Peak Period",
+        value: @peak_period ? @peak_period.first.to_s : "N/A",
+        icon: "calendar" %>
+  </div>
+
+  <!-- Charts -->
+  <div class="grid grid-cols-1 gap-6 lg:grid-cols-2">
+    <div class="bg-white rounded-lg shadow p-6 overflow-hidden">
+      <h3 class="text-lg font-medium text-gray-900 mb-4">Events Over Time</h3>
+      <div class="h-72 overflow-hidden">
+        <% if @events_over_time.any? %>
+          <%= line_chart @events_over_time,
+              id: "analytics-timeline",
+              height: "100%",
+              colors: ["#4F46E5"],
+              library: {
+                plugins: { legend: { display: false } },
+                scales: { y: { beginAtZero: true } }
+              } %>
+        <% else %>
+          <div class="flex items-center justify-center h-full text-gray-400">
+            No data for the selected period
+          </div>
+        <% end %>
+      </div>
+    </div>
+
+    <div class="bg-white rounded-lg shadow p-6 overflow-hidden">
+      <h3 class="text-lg font-medium text-gray-900 mb-4">Events by Type</h3>
+      <div class="h-72 overflow-hidden">
+        <% if @events_by_type.any? %>
+          <%= bar_chart @events_by_type,
+              id: "analytics-by-type",
+              height: "100%",
+              colors: ["#4F46E5"],
+              library: {
+                indexAxis: 'y',
+                plugins: { legend: { display: false } }
+              } %>
+        <% else %>
+          <div class="flex items-center justify-center h-full text-gray-400">
+            No data for the selected period
+          </div>
+        <% end %>
+      </div>
+    </div>
+  </div>
+
+  <!-- Event type breakdown table -->
+  <div class="bg-white rounded-lg shadow">
+    <div class="px-6 py-4 border-b border-gray-200">
+      <h3 class="text-lg font-medium text-gray-900">Event Type Breakdown</h3>
+    </div>
+
+    <% if @events_by_type.any? %>
+      <div class="overflow-x-auto">
+        <table class="min-w-full divide-y divide-gray-200">
+          <thead class="bg-gray-50">
+            <tr>
+              <th class="px-6 py-3 text-left text-xs font-medium text-gray-500 uppercase tracking-wider">Event Type</th>
+              <th class="px-6 py-3 text-left text-xs font-medium text-gray-500 uppercase tracking-wider">Count</th>
+              <th class="px-6 py-3 text-left text-xs font-medium text-gray-500 uppercase tracking-wider">Percentage</th>
+              <th class="px-6 py-3 text-left text-xs font-medium text-gray-500 uppercase tracking-wider">Distribution</th>
+            </tr>
+          </thead>
+          <tbody class="divide-y divide-gray-200">
+            <% @events_by_type.each do |name, count| %>
+              <% percentage = @total_events > 0 ? (count.to_f / @total_events * 100) : 0 %>
+              <tr class="hover:bg-gray-50">
+                <td class="px-6 py-4 whitespace-nowrap">
+                  <%= link_to rails_event_viewer.events_path(name: name), class: "text-indigo-600 hover:text-indigo-900" do %>
+                    <span class="inline-flex items-center px-2.5 py-0.5 rounded-full text-xs font-medium bg-indigo-100 text-indigo-800">
+                      <%= name %>
+                    </span>
+                  <% end %>
+                </td>
+                <td class="px-6 py-4 whitespace-nowrap text-sm text-gray-900">
+                  <%= number_with_delimiter(count) %>
+                </td>
+                <td class="px-6 py-4 whitespace-nowrap text-sm text-gray-500">
+                  <%= number_to_percentage(percentage, precision: 1) %>
+                </td>
+                <td class="px-6 py-4 whitespace-nowrap">
+                  <div class="w-full bg-gray-200 rounded-full h-2">
+                    <div class="bg-indigo-600 h-2 rounded-full" style="width: <%= [percentage, 100].min %>%"></div>
+                  </div>
+                </td>
+              </tr>
+            <% end %>
+          </tbody>
+        </table>
+      </div>
+    <% else %>
+      <div class="px-6 py-12 text-center text-gray-500">
+        No events for the selected period.
+      </div>
+    <% end %>
+  </div>
+</div>