dbwatcher 0.1.5 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ee5502341a37e588b1dcf38edd5f33fa9e0b3746f43efea7e419ec241e873150
-  data.tar.gz: 874907249da682606c7f02df3e423ba3f0b6ef8c553ff6165561ab5cb7ad0981
+  metadata.gz: ea9aad773959e5c5e862792305df463112927844dd7d1473130b84c0d23583e8
+  data.tar.gz: 89bbc03d80d56b2a478657a9b3e24b9b6ce83439fd2342a19be4d2be4147d2e4
 SHA512:
-  metadata.gz: 8b8d78baaa87bad96ac04968238b945d162c8acc0451c678803d7defdfa46ab66fbb9d7e96ab8bc11a4f09166713f995e641bea32090c2346ab335939faa7770
-  data.tar.gz: 13dd481403397e95a74c04857718f878ebd35dc223ffa164dfaf871f6da4a9c0d02559555b25f5b575e5bab2cf265ce953902e400026647d3441c9bdd38a3e92
+  metadata.gz: 5b12cccc60ec47f58f6fb779106d38d0d915df0b49c06e10a35456abcd2c7e18874a1e5db9a0428a380a5169e62c425f4f18a092c85250858b52a237c687b9f2
+  data.tar.gz: a95e7b8a3674d232a99668d3f1c9051b79ffa97237412bd14563e0229761d8b51aaccb27e3ae7518e52a3375afc5c016b766b5453588a6ffc24f040ffced4254

data/README.md

@@ -1,8 +1,8 @@
-# DBWatcher 🔍
+# DB Watcher 🔍
 
 Track and visualize database changes in your Rails application for easier debugging and development.
 
-DBWatcher is a powerful Rails gem that captures, stores, and visualizes all database operations in your application. Perfect for debugging complex data flows, understanding application behavior, and optimizing database performance.
+DB Watcher is a powerful Rails gem that captures, stores, and visualizes all database operations in your application. Perfect for debugging complex data flows, understanding application behavior, and optimizing database performance.
 
 ## ✨ Features
 

data/app/controllers/dbwatcher/base_controller.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module Dbwatcher
+  # Base controller for all Dbwatcher controllers
+  # Provides common functionality and configuration for the entire engine
+  class BaseController < ActionController::Base
+    protect_from_forgery with: :exception
+    layout "dbwatcher/application"
+
+    before_action :set_current_time
+    before_action :log_request_info
+
+    # Common error handling
+    rescue_from StandardError, with: :handle_error
+
+    protected
+
+    # Set current time for consistent timestamp usage across views
+    def set_current_time
+      @current_time = Time.current
+    end
+
+    # Log request information for debugging
+    def log_request_info
+      return unless Rails.logger
+
+      Rails.logger.info "DBWatcher Request: #{request.method} #{request.path} - Controller: #{self.class.name}"
+    end
+
+    # Common error handling for all controllers
+    def handle_error(exception)
+      Rails.logger.error "DBWatcher Error in #{self.class.name}##{action_name}: #{exception.message}"
+      Rails.logger.error exception.backtrace.join("\n") if Rails.env.development?
+
+      respond_to do |format|
+        format.html do
+          flash[:error] = "An error occurred while processing your request."
+          redirect_to root_path
+        end
+        format.json do
+          render json: { error: "Internal server error" }, status: :internal_server_error
+        end
+      end
+    end
+
+    # Helper method for safely extracting data from hashes with symbol/string keys
+    def safe_extract(data, key)
+      return nil unless data.is_a?(Hash)
+
+      data[key] || data[key.to_s]
+    end
+
+    # Helper method for formatting timestamps consistently
+    def format_timestamp(timestamp_str)
+      return "N/A" unless timestamp_str
+
+      Time.parse(timestamp_str).strftime("%H:%M:%S")
+    rescue ArgumentError
+      "N/A"
+    end
+
+    # Make helper methods available to views
+    helper_method :format_timestamp, :safe_extract
+
+    # Helper method for rendering JSON responses with consistent structure
+    def render_json_response(data, status: :ok)
+      render json: {
+        status: status,
+        data: data,
+        timestamp: @current_time.iso8601
+      }, status: status
+    end
+
+    # Helper method for handling not found resources
+    def handle_not_found(resource_name, redirect_path)
+      Rails.logger.warn "#{self.class.name}##{action_name}: #{resource_name} not found for ID: #{params[:id]}"
+
+      respond_to do |format|
+        format.html do
+          redirect_to redirect_path, alert: "#{resource_name} not found"
+        end
+        format.json do
+          render json: { error: "#{resource_name} not found" }, status: :not_found
+        end
+      end
+    end
+
+    # Helper method for clearing storage with consistent messaging
+    def clear_storage_with_message(storage_method, resource_name, redirect_path)
+      cleared_count = storage_method.call
+      redirect_to redirect_path,
+                  notice: "#{resource_name} cleared (#{cleared_count} files removed)"
+    end
+  end
+end

data/app/controllers/dbwatcher/dashboard_controller.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Dbwatcher
+  class DashboardController < BaseController
+    def index
+      dashboard_data = Dbwatcher::Services::DashboardDataAggregator.call
+      @recent_sessions = dashboard_data[:recent_sessions]
+      @active_tables = dashboard_data[:active_tables]
+      @query_stats = dashboard_data[:query_stats]
+    end
+  end
+end

data/app/controllers/dbwatcher/queries_controller.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Dbwatcher
+  class QueriesController < BaseController
+    def index
+      @date = params[:date] || Date.current.strftime("%Y-%m-%d")
+      queries = Storage.queries.for_date(@date).all
+      @queries = Dbwatcher::Services::QueryFilterProcessor.call(queries, params)
+
+      respond_to do |format|
+        format.html
+        format.json { render json: @queries }
+      end
+    end
+
+    def clear
+      clear_storage_with_message(
+        -> { Storage.query_storage.clear_all },
+        "SQL query logs",
+        queries_path
+      )
+    end
+  end
+end

data/app/controllers/dbwatcher/sessions_controller.rb

@@ -1,16 +1,20 @@
 # frozen_string_literal: true
 
 module Dbwatcher
-  class SessionsController < ActionController::Base
-    protect_from_forgery with: :exception
-    layout "dbwatcher/application"
-
+  class SessionsController < BaseController
     def index
-      @sessions = Storage.all_sessions
+      @sessions = Storage.sessions.all
     end
 
     def show
-      @session = Storage.load_session(params[:id])
+      Rails.logger.info "SessionsController#show: Loading session with ID: #{params[:id]}"
+      @session = Storage.sessions.find(params[:id])
+      Rails.logger.info "SessionsController#show: Loaded session: #{@session.inspect}"
+
+      return handle_not_found("Session", sessions_path) unless @session
+
+      @tables_summary = Storage.sessions.build_tables_summary(@session)
+      Rails.logger.info "SessionsController#show: Tables summary: #{@tables_summary.inspect}"
 
       respond_to do |format|
         format.html
@@ -18,21 +22,12 @@ module Dbwatcher
       end
     end
 
-    def destroy_all
-      Dbwatcher.reset!
-      redirect_to root_path, notice: "All sessions cleared"
-    end
-
-    private
-
-    # Helper method to safely get the sessions path
-    def sessions_index_path
-      if respond_to?(:sessions_path)
+    def clear
+      clear_storage_with_message(
+        -> { Storage.session_storage.clear_all },
+        "All sessions",
         sessions_path
-      else
-        "/dbwatcher"
-      end
+      )
     end
-    helper_method :sessions_index_path
   end
 end

data/app/controllers/dbwatcher/tables_controller.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Dbwatcher
+  class TablesController < BaseController
+    def index
+      @tables = Dbwatcher::Services::TableStatisticsCollector.call
+    end
+
+    def show
+      @table_name = params[:id]
+      @changes = Storage.tables.changes_for(@table_name).all
+      @sessions = @changes.map { |c| c[:session_id] }.uniq
+
+      respond_to do |format|
+        format.html
+        format.json { render json: @changes }
+      end
+    end
+
+    def changes
+      @table_name = params[:id]
+      @changes = Storage.tables.changes_for(@table_name).all
+      @sessions = extract_session_ids(@changes)
+      @records = group_changes_by_record(@changes)
+    end
+
+    private
+
+    # These remain as they are simple data extraction helpers
+    def extract_session_ids(changes)
+      changes.map { |c| c[:session_id] }.uniq
+    end
+
+    def group_changes_by_record(changes)
+      changes.group_by { |c| c[:record_id] }
+    end
+  end
+end

data/app/helpers/dbwatcher/application_helper.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+module Dbwatcher
+  module ApplicationHelper
+    include FormattingHelper
+    include SessionHelper
+
+    # Common view helpers for templates
+
+    # Create icon HTML for stats cards
+    def stats_icon(type)
+      icon_html = icon_definitions[type.to_sym]
+      icon_html&.html_safe
+    end
+
+    private
+
+    # Icon definitions for stats cards
+    def icon_definitions
+      {
+        sessions: sessions_icon_svg,
+        tables: tables_icon_svg,
+        queries: queries_icon_svg,
+        performance: performance_icon_svg
+      }
+    end
+
+    def sessions_icon_svg
+      <<~SVG
+        <svg class="w-4 h-4 text-blue-medium" fill="currentColor" viewBox="0 0 20 20">
+          <path d="M10 12a2 2 0 100-4 2 2 0 000 4z"/>
+          <path fill-rule="evenodd" d="M.458 10C1.732 5.943 5.522 3 10 3s8.268 2.943 9.542 7c-1.274 4.057-5.064 7-9.542 7S1.732 14.057.458 10zM14 10a4 4 0 11-8 0 4 4 0 018 0z" clip-rule="evenodd"/>
+        </svg>
+      SVG
+    end
+
+    def tables_icon_svg
+      <<~SVG
+        <svg class="w-4 h-4 text-gold-dark" fill="currentColor" viewBox="0 0 20 20">
+          <path fill-rule="evenodd" d="M3 3a1 1 0 000 2v8a2 2 0 002 2h2.586l-1.293 1.293a1 1 0 101.414 1.414L10 15.414l2.293 2.293a1 1 0 001.414-1.414L12.414 15H15a2 2 0 002-2V5a1 1 0 100-2H3zm11 4a1 1 0 10-2 0v4a1 1 0 102 0V7zm-3 1a1 1 0 10-2 0v3a1 1 0 102 0V8zM8 9a1 1 0 00-2 0v2a1 1 0 102 0V9z" clip-rule="evenodd"/>
+        </svg>
+      SVG
+    end
+
+    def queries_icon_svg
+      <<~SVG
+        <svg class="w-4 h-4 text-blue-light" fill="currentColor" viewBox="0 0 20 20">
+          <path fill-rule="evenodd" d="M2 5a2 2 0 012-2h12a2 2 0 012 2v10a2 2 0 01-2 2H4a2 2 0 01-2-2V5zm3.293 1.293a1 1 0 011.414 0l3 3a1 1 0 010 1.414l-3 3a1 1 0 01-1.414-1.414L7.586 10 5.293 7.707a1 1 0 010-1.414zM11 12a1 1 0 100 2h3a1 1 0 100-2h-3z" clip-rule="evenodd"/>
+        </svg>
+      SVG
+    end
+
+    def performance_icon_svg
+      <<~SVG
+        <svg class="w-4 h-4 text-gold-light" fill="currentColor" viewBox="0 0 20 20">
+          <path fill-rule="evenodd"
+                d="M10 18a8 8 0 100-16 8 8 0 000 16zm1-12a1 1 0 10-2 0v4a1 1 0 00.293.707l2.828 2.829a1 1 0 101.415-1.415L11 9.586V6z"
+                clip-rule="evenodd"/>
+        </svg>
+      SVG
+    end
+
+    public
+
+    # Generate operation badges for tables
+    def operation_badges
+      content_tag(:div, class: "flex gap-1 justify-center") do
+        [
+          content_tag(:span, "I", class: "badge badge-insert", title: "Inserts"),
+          content_tag(:span, "U", class: "badge badge-update", title: "Updates"),
+          content_tag(:span, "D", class: "badge badge-delete", title: "Deletes")
+        ].join.html_safe
+      end
+    end
+
+    # Create action buttons with consistent styling
+    def action_button(text, path, color: "blue")
+      link_to text, path, class: "px-3 py-1 text-xs bg-#{color}-600 text-white rounded hover:bg-#{color}-700"
+    end
+
+    # Safe value extraction with fallback
+    def safe_value(data, key, fallback = "N/A")
+      return fallback unless data.is_a?(Hash)
+
+      data[key] || data[key.to_s] || fallback
+    end
+
+    # Format count with proper fallback
+    def format_count(value)
+      value.to_i.to_s
+    end
+
+    # Create empty state message
+    def empty_state(message, icon: nil)
+      content_tag(:div, class: "text-center py-8 text-gray-500") do
+        content = []
+        content << icon if icon
+        content << content_tag(:p, message, class: "text-xs")
+        content.join.html_safe
+      end
+    end
+  end
+end

data/app/helpers/dbwatcher/formatting_helper.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+module Dbwatcher
+  module FormattingHelper
+    # Truncate cell values for display in compact view
+    def truncate_cell_value(value, max_length = 50)
+      return "" if value.nil?
+
+      formatted_value = format_cell_value_simple(value)
+
+      if formatted_value.length > max_length
+        "#{formatted_value[0...max_length]}..."
+      else
+        formatted_value
+      end
+    end
+
+    # Format cell values for display
+    def format_cell_value(value)
+      return "" if value.nil?
+
+      case value
+      when String
+        format_string_value(value)
+      when Hash, Array
+        JSON.pretty_generate(value)
+      when Time, DateTime
+        format_datetime_value(value)
+      when Date
+        value.strftime("%Y-%m-%d")
+      else
+        value.to_s
+      end
+    end
+
+    # Simple formatting for truncated display
+    def format_cell_value_simple(value)
+      return "" if value.nil?
+
+      case value
+      when String
+        format_string_value_simple(value)
+      when Hash
+        format_hash_simple(value)
+      when Array
+        format_array_simple(value)
+      when Time, DateTime
+        format_datetime_value(value)
+      when Date
+        value.strftime("%Y-%m-%d")
+      else
+        value.to_s
+      end
+    end
+
+    private
+
+    # Format string values with JSON detection
+    def format_string_value(value)
+      return value unless json?(value)
+
+      begin
+        JSON.pretty_generate(JSON.parse(value))
+      rescue JSON::ParserError
+        value
+      end
+    end
+
+    def format_string_value_simple(value)
+      return value unless json?(value)
+
+      begin
+        parsed = JSON.parse(value)
+        format_parsed_json_simple(parsed)
+      rescue JSON::ParserError
+        value
+      end
+    end
+
+    def format_parsed_json_simple(parsed)
+      if parsed.is_a?(Array)
+        format_array_simple(parsed)
+      elsif parsed.is_a?(Hash)
+        format_hash_simple(parsed)
+      else
+        parsed.to_s
+      end
+    end
+
+    def format_array_simple(array)
+      "[#{array.length} items]"
+    end
+
+    def format_hash_simple(hash)
+      "{#{hash.keys.length} keys}"
+    end
+
+    def format_datetime_value(value)
+      value.strftime("%Y-%m-%d %H:%M:%S")
+    end
+
+    def json?(string)
+      return false unless string.is_a?(String)
+
+      string.strip.start_with?("{", "[")
+    end
+  end
+end

data/app/helpers/dbwatcher/session_helper.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Dbwatcher
+  module SessionHelper
+    # Get session change count with fallback
+    def session_change_count(session)
+      safe_value(session, :change_count, 0).to_i
+    end
+
+    # Determine if session is active
+    def session_active?(session)
+      safe_value(session, :ended_at).blank?
+    end
+
+    # Format session name for display
+    def display_session_name(name)
+      name.to_s.gsub(/^HTTP \w+ /, "")
+    end
+
+    # Generate session ID display (truncated)
+    def display_session_id(id)
+      return "N/A" unless id
+
+      "#{id[0..7]}..."
+    end
+  end
+end

data/app/views/dbwatcher/dashboard/index.html.erb

@@ -0,0 +1,177 @@
+<%# Dashboard Overview Page %>
+<div class="h-full flex flex-col">
+  <!-- Compact Header -->
+  <div class="h-10 bg-navy-dark text-white flex items-center px-4">
+    <h1 class="text-sm font-medium">Dashboard</h1>
+    <span class="ml-auto text-xs text-blue-light">
+      <%= Time.current.strftime("%Y-%m-%d %H:%M:%S") %>
+    </span>
+  </div>
+  
+  <!-- Tab Bar -->
+  <div class="tab-bar">
+    <div class="tab-item active">Overview</div>
+    <div class="tab-item">Statistics</div>
+    <div class="tab-item">Recent Activity</div>
+  </div>
+  
+  <!-- Content Area -->
+  <div class="flex-1 overflow-auto p-4">
+    <!-- Compact Stats Grid -->
+    <div class="grid grid-cols-4 gap-3 mb-4">
+      <!-- Sessions Card -->
+      <%= render 'dbwatcher/shared/stats_card',
+          label: 'Active Sessions',
+          value: @recent_sessions&.count || 0,
+          description: 'Last 24 hours',
+          icon_html: stats_icon(:sessions) %>
+      
+      <!-- Tables Card -->
+      <%= render 'dbwatcher/shared/stats_card',
+          label: 'Modified Tables',
+          value: @active_tables&.count || 0,
+          description: 'With changes',
+          icon_html: stats_icon(:tables) %>
+      
+      <!-- Queries Card -->
+      <%= render 'dbwatcher/shared/stats_card',
+          label: 'SQL Queries',
+          value: @query_stats&.dig(:total) || 0,
+          description: 'Today',
+          icon_html: stats_icon(:queries) %>
+      
+      <!-- Performance Card -->
+      <% slow_queries = @query_stats&.dig(:slow_queries) || 0 %>
+      <%= render 'dbwatcher/shared/stats_card',
+          label: 'Slow Queries',
+          value: slow_queries,
+          value_class: (slow_queries > 0 ? 'text-red-600' : 'text-navy-dark'),
+          description: '> 100ms',
+          icon_html: stats_icon(:performance) %>
+    </div>
+    
+    <!-- Two Column Layout -->
+    <div class="grid grid-cols-2 gap-4">
+      <!-- Recent Sessions -->
+      <div class="border border-gray-300 rounded">
+        <div class="bg-gray-100 px-3 py-2 border-b border-gray-300">
+          <h3 class="text-xs font-medium text-gray-700">Recent Sessions</h3>
+        </div>
+        <div class="max-h-64 overflow-auto">
+          <% if @recent_sessions&.any? %>
+            <table class="compact-table w-full">
+              <thead>
+                <tr>
+                  <th class="text-left">Session</th>
+                  <th class="text-center">Changes</th>
+                  <th class="text-right">Time</th>
+                </tr>
+              </thead>
+              <tbody>
+                <% @recent_sessions.each do |session| %>
+                  <tr class="hover:bg-blue-50">
+                    <td class="truncate max-w-xs" title="<%= session[:name] || session['name'] %>">
+                      <% session_id = session[:id] || session['id'] %>
+                      <% session_name = (session[:name] || session['name']).to_s.gsub(/^HTTP \w+ /, '') %>
+                      <%= link_to session_name, session_path(session_id), class: "text-navy-dark hover:text-blue-medium" %>
+                    </td>
+                    <td class="text-center">
+                      <span class="badge bg-gray-600 text-white">
+                        <%= session[:change_count] || session['change_count'] || 0 %>
+                      </span>
+                    </td>
+                    <td class="text-right text-gray-500">
+                      <% started_at = session[:started_at] || session['started_at'] %>
+                      <%= Time.parse(started_at).strftime("%H:%M:%S") rescue 'N/A' %>
+                    </td>
+                  </tr>
+                <% end %>
+              </tbody>
+            </table>
+          <% else %>
+            <div class="p-4 text-center text-gray-500 text-xs">No recent sessions</div>
+          <% end %>
+        </div>
+      </div>
+      
+      <!-- Active Tables -->
+      <div class="border border-gray-300 rounded">
+        <div class="bg-gray-100 px-3 py-2 border-b border-gray-300">
+          <h3 class="text-xs font-medium text-gray-700">Most Active Tables</h3>
+        </div>
+        <div class="max-h-64 overflow-auto">
+          <% if @active_tables&.any? %>
+            <table class="compact-table w-full">
+              <thead>
+                <tr>
+                  <th class="text-left">Table</th>
+                  <th class="text-center">Operations</th>
+                  <th class="text-right">Changes</th>
+                </tr>
+              </thead>
+              <tbody>
+                <% @active_tables.first(10).each do |table_name, count| %>
+                  <tr class="hover:bg-blue-50">
+                    <td class="font-medium text-navy-dark">
+                      <%= link_to table_name, table_path(table_name), class: "text-navy-dark hover:text-blue-medium" %>
+                    </td>
+                    <td class="text-center">
+                      <div class="flex gap-1 justify-center">
+                        <span class="badge badge-insert" title="Inserts">I</span>
+                        <span class="badge badge-update" title="Updates">U</span>
+                        <span class="badge badge-delete" title="Deletes">D</span>
+                      </div>
+                    </td>
+                    <td class="text-right">
+                      <span class="text-sm font-medium"><%= count %></span>
+                    </td>
+                  </tr>
+                <% end %>
+              </tbody>
+            </table>
+          <% else %>
+            <div class="p-4 text-center text-gray-500 text-xs">No active tables</div>
+          <% end %>
+        </div>
+      </div>
+    </div>
+
+    <!-- Query Activity Section -->
+    <div class="mt-4 border border-gray-300 rounded">
+      <div class="bg-gray-100 px-3 py-2 border-b border-gray-300">
+        <h3 class="text-xs font-medium text-gray-700">Query Activity</h3>
+      </div>
+      <div class="p-4">
+        <% if @query_stats&.dig(:by_operation)&.any? %>
+          <div class="grid grid-cols-4 gap-4 text-center">
+            <% @query_stats[:by_operation].each do |operation, count| %>
+              <div class="border border-gray-200 rounded p-2">
+                <div class="text-lg font-bold text-navy-dark"><%= count %></div>
+                <div class="text-xs text-gray-500 uppercase"><%= operation %></div>
+              </div>
+            <% end %>
+          </div>
+        <% else %>
+          <div class="text-center text-gray-500 text-xs">No query activity</div>
+        <% end %>
+      </div>
+    </div>
+
+    <!-- Quick Actions -->
+    <div class="mt-4 border border-gray-300 rounded">
+      <div class="bg-gray-100 px-3 py-2 border-b border-gray-300">
+        <h3 class="text-xs font-medium text-gray-700">Quick Actions</h3>
+      </div>
+      <div class="p-3">
+        <div class="flex gap-2">
+          <%= link_to "View All Sessions", sessions_path, 
+              class: "px-3 py-1 text-xs bg-blue-600 text-white rounded hover:bg-blue-700" %>
+          <%= link_to "Browse Tables", tables_path, 
+              class: "px-3 py-1 text-xs bg-green-600 text-white rounded hover:bg-green-700" %>
+          <%= link_to "SQL Logs", queries_path, 
+              class: "px-3 py-1 text-xs bg-purple-600 text-white rounded hover:bg-purple-700" %>
+        </div>
+      </div>
+    </div>
+  </div>
+</div>