pg_reports 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f0a634540a400676a49a8db9574fe8abbccd9faeae920e5d22323b1d54c791bd
-  data.tar.gz: ec2665323a7adbc2eae7dbcdd2a0b49ca5d7e4a96ca3f9603b1fd4304c23c98b
+  metadata.gz: 76f8945d09a2245c88f64ac0a07634055f7fb3133b87f15d7c7ca89915ace112
+  data.tar.gz: 28d4080e6ed159f24b3df313237b312218acdfc0c1681157db81af1aa4f09aab
 SHA512:
-  metadata.gz: ff18cbb7ffe10932d42b8a277fb33ef812a7d8d4211874575ea51869d9478c868143b7e912d639c493eb4ee81252b6a0c296aaaeefd132aa381bb6e5b99aef99
-  data.tar.gz: ef94bcbc4e686d1c82f6e6664735dbdbdbdbd441285be485c43fa593c69ba47886d16dd25998776ab7ef772382ec7e97d472fa34011b8683ee0c7d88881ec69b
+  metadata.gz: 3591a546c84af405ffa25664aa3016e85297608ba12130d6bb0aa8f0fc2f39b5c91c8470b672b1d67a24c834638384adf658062b08a582814d1271b8c1a5d9d1
+  data.tar.gz: 3e90622e7676573d94b2ef2c7d5e2b7070bb9a9d5fef021440aab741bfc5faa15d9b3b6a5fbcba8883c98484f1096f0d93ec048a3db3d0b728deed4d1880cb72

data/CHANGELOG.md

@@ -5,6 +5,29 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.2.0] - 2026-01-28
+
+### Added
+
+- Sortable table columns - click on column header to sort ascending/descending
+- Top scrollbar for wide tables (synchronized with bottom scroll)
+- Report descriptions in dashboard cards on the main page
+- IDE integration for source code links:
+  - VS Code (WSL) - for Windows Subsystem for Linux
+  - VS Code - direct path for native Linux
+  - RubyMine
+  - IntelliJ IDEA
+  - Cursor
+- IDE settings modal to choose default IDE (skip menu and open directly)
+- Save records for comparison - save query results to compare before/after optimizations
+- EXPLAIN ANALYZE for queries - run EXPLAIN ANALYZE directly from the dashboard
+- Migration generator for unused/broken indexes - generate and create migration files
+
+### Changed
+
+- Reduced spacing between report description and results table
+- Dropdown menus now use fixed positioning to prevent clipping by table rows
+
 ## [0.1.0] - 2026-01-17
 
 ### Added

data/README.md

@@ -15,9 +15,13 @@ A comprehensive PostgreSQL monitoring and analysis library for Rails application
 - 📋 **Table Statistics** - Monitor table sizes, bloat, vacuum needs, and cache hit ratios
 - 🔌 **Connection Monitoring** - Track active connections, locks, and blocking queries
 - 🖥️ **System Overview** - Database sizes, PostgreSQL settings, installed extensions
-- 🌐 **Web Dashboard** - Beautiful dark-themed UI with expandable rows
+- 🌐 **Web Dashboard** - Beautiful dark-themed UI with sortable tables and expandable rows
 - 📨 **Telegram Integration** - Send reports directly to Telegram
 - 📥 **Export** - Download reports in TXT, CSV, or JSON format
+- 🔗 **IDE Integration** - Open source locations in VS Code, RubyMine, IntelliJ, or Cursor
+- 📌 **Comparison Mode** - Save records to compare before/after optimization
+- 📊 **EXPLAIN ANALYZE** - Run query plans directly from the dashboard
+- 🗑️ **Migration Generator** - Generate Rails migrations to drop unused indexes
 
 ## Installation
 
@@ -255,13 +259,60 @@ report.select { |row| row["calls"] > 100 }
 
 The dashboard provides:
 
-- 📊 Overview of all report categories
+- 📊 Overview of all report categories with descriptions
 - ⚡ One-click report execution
 - 🔍 Expandable rows for full query text
 - 📋 Copy query to clipboard
-- 📥 Download in multiple formats
+- 📥 Download in multiple formats (TXT, CSV, JSON)
 - 📨 Send to Telegram
 - 🔧 pg_stat_statements management
+- 🔄 Sortable columns - click headers to sort ascending/descending
+- 📌 Save records for comparison - track before/after optimization results
+- 📊 EXPLAIN ANALYZE - run query plans directly from the dashboard
+- 🗑️ Migration generator - create Rails migrations to drop unused indexes
+- 🔗 IDE integration - click source locations to open in your IDE
+
+### IDE Integration
+
+Click on source locations in reports to open the file directly in your IDE. Supported IDEs:
+
+- **VS Code (WSL)** - for Windows Subsystem for Linux
+- **VS Code** - direct path for native Linux/macOS
+- **RubyMine**
+- **IntelliJ IDEA**
+- **Cursor**
+
+Use the ⚙️ button to set your default IDE and skip the selection menu.
+
+### Save Records for Comparison
+
+When optimizing queries, you can save records to compare before/after results:
+
+1. Expand a row and click "📌 Save for Comparison"
+2. Saved records appear above the results table
+3. Click saved records to expand and see all details
+4. Clear all or remove individual saved records
+
+Records are stored in browser localStorage per report type.
+
+### EXPLAIN ANALYZE
+
+For query reports, you can run EXPLAIN ANALYZE directly:
+
+1. Expand a row with a query
+2. Click "📊 EXPLAIN ANALYZE"
+3. View the execution plan with timing statistics
+
+> Note: Queries with parameter placeholders ($1, $2) from pg_stat_statements cannot be analyzed directly. Copy the query and replace parameters with actual values.
+
+### Migration Generator
+
+For unused or invalid indexes, generate Rails migrations:
+
+1. Go to Indexes → Unused Indexes
+2. Expand a row and click "🗑️ Generate Migration"
+3. Copy the code or create the file directly
+4. The file opens automatically in your configured IDE
 
 ### Authentication
 

data/app/controllers/pg_reports/dashboard_controller.rb

@@ -33,6 +33,11 @@ module PgReports
         return
       end
 
+      # Get documentation for the report
+      @documentation = Dashboard::ReportsRegistry.documentation(@report_key)
+      @thresholds = Dashboard::ReportsRegistry.thresholds(@report_key)
+      @problem_fields = Dashboard::ReportsRegistry.problem_fields(@report_key)
+
       @report = execute_report(@category, @report_key)
     rescue => e
       @error = e.message
@@ -44,6 +49,8 @@ module PgReports
       report_key = params[:report].to_sym
 
       report = execute_report(category, report_key)
+      thresholds = Dashboard::ReportsRegistry.thresholds(report_key)
+      problem_fields = Dashboard::ReportsRegistry.problem_fields(report_key)
 
       render json: {
         success: true,
@@ -51,7 +58,9 @@ module PgReports
         columns: report.columns,
         data: report.data.first(100),
         total: report.size,
-        generated_at: report.generated_at.strftime("%Y-%m-%d %H:%M:%S")
+        generated_at: report.generated_at.strftime("%Y-%m-%d %H:%M:%S"),
+        thresholds: thresholds,
+        problem_fields: problem_fields
       }
     rescue => e
       render json: {success: false, error: e.message}, status: :unprocessable_entity
@@ -103,6 +112,86 @@ module PgReports
       render json: {success: false, error: e.message}, status: :unprocessable_entity
     end
 
+    def explain_analyze
+      query = params[:query]
+
+      if query.blank?
+        render json: {success: false, error: "Query is required"}, status: :unprocessable_entity
+        return
+      end
+
+      # Security: Only allow SELECT queries for EXPLAIN ANALYZE
+      normalized = query.strip.gsub(/\s+/, " ").downcase
+      unless normalized.start_with?("select")
+        render json: {success: false, error: "Only SELECT queries are allowed for EXPLAIN ANALYZE"}, status: :unprocessable_entity
+        return
+      end
+
+      # Check for parameterized queries (from pg_stat_statements normalization)
+      if query.match?(/\$\d+/)
+        render json: {
+          success: false,
+          error: "This query contains parameter placeholders ($1, $2, etc.) from pg_stat_statements normalization. " \
+                 "EXPLAIN ANALYZE cannot be run on parameterized queries without actual values. " \
+                 "Copy the query and replace parameters with real values to analyze it manually."
+        }, status: :unprocessable_entity
+        return
+      end
+
+      result = ActiveRecord::Base.connection.execute("EXPLAIN (ANALYZE, BUFFERS, FORMAT TEXT) #{query}")
+      explain_output = result.map { |r| r["QUERY PLAN"] }.join("\n")
+
+      # Extract stats from the output
+      stats = {}
+      if (match = explain_output.match(/Planning Time: ([\d.]+) ms/))
+        stats[:planning_time] = match[1].to_f
+      end
+      if (match = explain_output.match(/Execution Time: ([\d.]+) ms/))
+        stats[:execution_time] = match[1].to_f
+      end
+      if (match = explain_output.match(/cost=[\d.]+\.\.([\d.]+)/))
+        stats[:total_cost] = match[1].to_f
+      end
+      if (match = explain_output.match(/rows=(\d+)/))
+        stats[:rows] = match[1].to_i
+      end
+
+      render json: {success: true, explain: explain_output, stats: stats}
+    rescue => e
+      render json: {success: false, error: e.message}, status: :unprocessable_entity
+    end
+
+    def create_migration
+      file_name = params[:file_name]
+      code = params[:code]
+
+      if file_name.blank? || code.blank?
+        render json: {success: false, error: "File name and code are required"}, status: :unprocessable_entity
+        return
+      end
+
+      # Sanitize file name
+      safe_file_name = file_name.gsub(/[^a-z0-9_.]/, "")
+      unless safe_file_name.match?(/\A\d{14}_\w+\.rb\z/)
+        render json: {success: false, error: "Invalid migration file name format"}, status: :unprocessable_entity
+        return
+      end
+
+      # Find migrations directory
+      migrations_path = Rails.root.join("db", "migrate")
+      unless migrations_path.exist?
+        render json: {success: false, error: "Migrations directory not found"}, status: :unprocessable_entity
+        return
+      end
+
+      file_path = migrations_path.join(safe_file_name)
+      File.write(file_path, code)
+
+      render json: {success: true, file_path: file_path.to_s, message: "Migration created successfully"}
+    rescue => e
+      render json: {success: false, error: e.message}, status: :unprocessable_entity
+    end
+
     private
 
     def authenticate_dashboard!

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

@@ -3,8 +3,9 @@
 <head>
   <meta charset="UTF-8">
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
-  <meta name="pg-reports-root" content="<%= pg_reports.root_path.chomp('/') %>">
+  <meta name="pg-reports-root" content="<%= request.script_name.presence || PgReports::Engine.routes.url_helpers.root_path %>">
   <title>PgReports Dashboard</title>
+  <link rel="icon" type="image/svg+xml" href="data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 32 32'%3E%3Crect width='32' height='32' rx='6' fill='%234f46e5'/%3E%3Crect x='5' y='18' width='5' height='9' rx='1' fill='%23fff'/%3E%3Crect x='13.5' y='12' width='5' height='15' rx='1' fill='%23fff'/%3E%3Crect x='22' y='6' width='5' height='21' rx='1' fill='%23fff'/%3E%3C/svg%3E">
   <link rel="preconnect" href="https://fonts.googleapis.com">
   <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
   <link href="https://fonts.googleapis.com/css2?family=JetBrains+Mono:wght@400;500;600&family=Plus+Jakarta+Sans:wght@400;500;600;700&display=swap" rel="stylesheet">

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

@@ -105,12 +105,18 @@ pg_stat_statements.track = all</pre>
         <% category[:reports].each do |report_key, report| %>
           <% if category_key == :queries && !@pg_stat_status[:ready] %>
             <div class="report-link disabled">
-              <span><%= report[:name] %></span>
+              <div class="report-link-info">
+                <span class="report-link-name"><%= report[:name] %></span>
+                <span class="report-link-desc"><%= report[:description] %></span>
+              </div>
               <span class="lock">🔒</span>
             </div>
           <% else %>
             <%= link_to report_path(category: category_key, report: report_key), class: "report-link" do %>
-              <span><%= report[:name] %></span>
+              <div class="report-link-info">
+                <span class="report-link-name"><%= report[:name] %></span>
+                <span class="report-link-desc"><%= report[:description] %></span>
+              </div>
               <span class="arrow">→</span>
             <% end %>
           <% end %>
@@ -216,6 +222,31 @@ pg_stat_statements.track = all</pre>
     opacity: 0.5;
   }
 
+  .report-link-info {
+    display: flex;
+    flex-direction: column;
+    gap: 0.125rem;
+    flex: 1;
+    min-width: 0;
+  }
+
+  .report-link-name {
+    font-weight: 500;
+    color: inherit;
+  }
+
+  .report-link-desc {
+    font-size: 0.75rem;
+    color: var(--text-muted);
+    white-space: nowrap;
+    overflow: hidden;
+    text-overflow: ellipsis;
+  }
+
+  .report-link:hover .report-link-desc {
+    color: var(--text-secondary);
+  }
+
   /* Modal */
   .modal {
     position: fixed;