pghero 3.1.0 → 3.7.0

data/app/assets/stylesheets/pghero/application.css

@@ -187,7 +187,7 @@ hr {
 }
 
 #slider-container {
-  padding: 6px 140px 20px 140px;
+  padding: 6px 8px 14px 8px;
 }
 
 .queries-table th a, .space-table th a {
@@ -195,7 +195,7 @@ hr {
 }
 
 #slider {
-  margin-bottom: 20px;
+  margin: 0px 14px 18px 14px;
 }
 
 #range-start {
@@ -483,6 +483,12 @@ body {
   line-height: 300px;
   text-align: center;
   color: #999;
+  margin-bottom: 20px;
+}
+
+.pie-chart {
+  height: 260px;
+  line-height: 260px;
 }
 
 .unused-index {
@@ -497,8 +503,18 @@ body {
   font-weight: bold;
 }
 
+.origins-table {
+  table-layout: auto;
+}
+
 .origin {
   word-break: break-word;
+  width: 90%;
+}
+
+.origin-pct {
+  text-align: right;
+  width: 10%;
 }
 
 .duplicate-indexes td {
@@ -512,3 +528,93 @@ body {
 .no-outline:focus {
   outline: none;
 }
+
+.width-10 {
+  width: 10%;
+}
+
+.width-15 {
+  width: 15%;
+}
+
+.width-20 {
+  width: 20%;
+}
+
+.width-25 {
+  width: 25%;
+}
+
+.width-33 {
+  width: 33.33%;
+}
+
+.right-5 {
+  margin-right: 5px;
+}
+
+.query-row {
+  border-top: none;
+  padding: 0;
+}
+
+.query-pre {
+  margin-top: 1em;
+}
+
+.query-code {
+  max-height: 230px;
+  overflow: hidden;
+}
+
+.break-all {
+  word-break: break-all;
+}
+
+.migration {
+  display: none;
+}
+
+.migration pre {
+  overflow: scroll;
+  white-space: pre;
+  word-break: normal;
+}
+
+.space-index {
+  font-style: italic;
+}
+
+a.relation-link {
+  color: inherit;
+}
+
+.push-left {
+  float: left;
+}
+
+.clear-both {
+  clear: both;
+}
+
+.create-index {
+  color: #eee;
+  background-color: #333;
+}
+
+.hide {
+  display: none;
+}
+
+.show-details {
+  float: right;
+  color: #f0ad4e;
+  margin-top: 0px;
+  padding: 10px;
+  cursor: pointer;
+}
+
+.details pre {
+  color: #f0ad4e;
+  background-color: #333;
+}

data/app/assets/stylesheets/pghero/nouislider.css

@@ -1,4 +1,3 @@
-/*! nouislider - 14.6.1 - 8/17/2020 */
 /* Functional styling;
  * These styles are required for noUiSlider to function.
  * You don't need to change these rules to apply your design.
@@ -39,20 +38,14 @@
   z-index: 1;
   top: 0;
   right: 0;
+  height: 100%;
+  width: 100%;
   -ms-transform-origin: 0 0;
   -webkit-transform-origin: 0 0;
   -webkit-transform-style: preserve-3d;
   transform-origin: 0 0;
   transform-style: flat;
 }
-.noUi-connect {
-  height: 100%;
-  width: 100%;
-}
-.noUi-origin {
-  height: 10%;
-  width: 10%;
-}
 /* Offset direction
  */
 .noUi-txt-dir-rtl.noUi-horizontal .noUi-origin {
@@ -63,6 +56,7 @@
  * connect elements.
  */
 .noUi-vertical .noUi-origin {
+  top: -100%;
   width: 0;
 }
 .noUi-horizontal .noUi-origin {
@@ -103,7 +97,7 @@
   width: 28px;
   height: 34px;
   right: -6px;
-  top: -17px;
+  bottom: -17px;
 }
 .noUi-txt-dir-rtl.noUi-horizontal .noUi-handle {
   left: -17px;

data/app/controllers/pg_hero/home_controller.rb

@@ -46,11 +46,18 @@ module PgHero
 
       @transaction_id_danger = @database.transaction_id_danger(threshold: 1500000000)
 
-      @readable_sequences, @unreadable_sequences = @database.sequences.partition { |s| s[:readable] }
+      sequences, @sequences_timeout = rescue_timeout([]) { @database.sequences }
+      @readable_sequences, @unreadable_sequences = sequences.partition { |s| s[:readable] }
 
       @sequence_danger = @database.sequence_danger(threshold: (params[:sequence_threshold] || 0.9).to_f, sequences: @readable_sequences)
 
-      @indexes = @database.indexes
+      @indexes, @indexes_timeout =
+        if @sequences_timeout
+          # skip indexes for faster loading
+          [[], true]
+        else
+          rescue_timeout([]) { @database.indexes }
+        end
       @invalid_indexes = @database.invalid_indexes(indexes: @indexes)
       @invalid_constraints = @database.invalid_constraints
       @duplicate_indexes = @database.duplicate_indexes(indexes: @indexes)
@@ -80,7 +87,7 @@ module PgHero
       @days = (params[:days] || 7).to_i
       @database_size = @database.database_size
       @only_tables = params[:tables].present?
-      @relation_sizes = @only_tables ? @database.table_sizes : @database.relation_sizes
+      @relation_sizes, @sizes_timeout = rescue_timeout([]) { @only_tables ? @database.table_sizes : @database.relation_sizes }
       @space_stats_enabled = @database.space_stats_enabled? && !@only_tables
       if @space_stats_enabled
         space_growth = @database.space_growth(days: @days, relation_sizes: @relation_sizes)
@@ -157,8 +164,11 @@ module PgHero
           )
         end
 
-      @indexes = @database.indexes
-      set_suggested_indexes
+      if !@historical_query_stats_enabled || request.xhr?
+        set_suggested_indexes
+      else
+        @debug = params[:debug].present?
+      end
 
       # fix back button issue with caching
       response.headers["Cache-Control"] = "must-revalidate, no-store, no-cache, private"
@@ -178,7 +188,7 @@ module PgHero
         @explainable_query = stats[:explainable_query]
 
         if @show_details
-          query_hash_stats = @database.query_hash_stats(@query_hash, user: @user)
+          query_hash_stats = @database.query_hash_stats(@query_hash, user: @user, current: true)
 
           @chart_data = [{name: "Value", data: query_hash_stats.map { |r| [r[:captured_at].change(sec: 0), (r[:total_minutes] * 60 * 1000).round] }, library: chart_library_options}]
           @chart2_data = [{name: "Value", data: query_hash_stats.map { |r| [r[:captured_at].change(sec: 0), r[:average_time].round(1)] }, library: chart_library_options}]
@@ -193,7 +203,8 @@ module PgHero
 
         if @tables.any?
           @row_counts = @database.table_stats(table: @tables).to_h { |i| [i[:table], i[:estimated_rows]] }
-          @indexes_by_table = @database.indexes.group_by { |i| i[:table] }
+          indexes, @indexes_timeout = rescue_timeout([]) { @database.indexes }
+          @indexes_by_table = indexes.group_by { |i| i[:table] }
         end
       else
         render_text "Unknown query", status: :not_found
@@ -239,9 +250,16 @@ module PgHero
       stats =
         case @database.system_stats_provider
         when :azure
-          [
-            {name: "IO Consumption", data: @database.azure_stats("io_consumption_percent", **system_params), library: chart_library_options}
-          ]
+          if @database.send(:azure_flexible_server?)
+            [
+              {name: "Read IOPS", data: @database.read_iops_stats(**system_params).map { |k, v| [k, v ? v.round : v] }, library: chart_library_options},
+              {name: "Write IOPS", data: @database.write_iops_stats(**system_params).map { |k, v| [k, v ? v.round : v] }, library: chart_library_options}
+            ]
+          else
+            [
+              {name: "IO Consumption", data: @database.azure_stats("io_consumption_percent", **system_params), library: chart_library_options}
+            ]
+          end
         when :gcp
           [
             {name: "Read Ops", data: @database.read_iops_stats(**system_params).map { |k, v| [k, v ? v.round : v] }, library: chart_library_options},
@@ -258,7 +276,7 @@ module PgHero
 
     def free_space_stats
       render json: [
-        {name: "Free Space", data: @database.free_space_stats(duration: 14.days, period: 1.hour), library: chart_library_options},
+        {name: "Free Space", data: @database.free_space_stats(duration: 14.days, period: 1.hour), library: chart_library_options}
       ]
     end
 
@@ -276,12 +294,14 @@ module PgHero
       # need to prevent CSRF and DoS
       if request.post? && @query.present?
         begin
+          generic_plan = @database.server_version_num >= 160000 && @query.include?("$1")
+
           explain_options =
             case params[:commit]
             when "Analyze"
               {analyze: true}
             when "Visualize"
-              if @explain_analyze_enabled
+              if @explain_analyze_enabled && !generic_plan
                 {analyze: true, costs: true, verbose: true, buffers: true, format: "json"}
               else
                 {costs: true, verbose: true, format: "json"}
@@ -290,6 +310,8 @@ module PgHero
               {}
             end
 
+          explain_options[:generic_plan] = true if generic_plan
+
           if explain_options[:analyze] && !@explain_analyze_enabled
             render_text "Explain analyze not enabled", status: :bad_request
             return
@@ -303,8 +325,10 @@ module PgHero
           @error =
             if message == "Unsafe statement"
               "Unsafe statement"
-            elsif message.start_with?("PG::ProtocolViolation: ERROR:  bind message supplies 0 parameters")
+            elsif message.start_with?("PG::UndefinedParameter")
               "Can't explain queries with bind parameters"
+            elsif message.include?("EXPLAIN options ANALYZE and GENERIC_PLAN cannot be used together")
+              "Can't analyze queries with bind parameters"
             elsif message.start_with?("PG::SyntaxError")
               "Syntax error with query"
             elsif message.start_with?("PG::QueryCanceled")
@@ -395,6 +419,7 @@ module PgHero
       redirect_backward alert: "The database user does not have permission to enable query stats"
     end
 
+    # TODO disable if historical query stats enabled?
     def reset_query_stats
       success =
         if @database.server_version_num >= 120000
@@ -440,14 +465,18 @@ module PgHero
     end
 
     def set_suggested_indexes(min_average_time = 0, min_calls = 0)
+      if @database.suggested_indexes_enabled? && !@indexes
+        @indexes, @indexes_timeout = rescue_timeout([]) { @database.indexes }
+      end
+
       @suggested_indexes_by_query =
-        if @database.suggested_indexes_enabled?
-          @database.suggested_indexes_by_query(query_stats: @query_stats.select { |qs| qs[:average_time] >= min_average_time && qs[:calls] >= min_calls })
+        if !@indexes_timeout && @database.suggested_indexes_enabled?
+          @database.suggested_indexes_by_query(query_stats: @query_stats.select { |qs| qs[:average_time] >= min_average_time && qs[:calls] >= min_calls }, indexes: @indexes)
         else
           {}
         end
 
-      @suggested_indexes = @database.suggested_indexes(suggested_indexes_by_query: @suggested_indexes_by_query, indexes: @indexes)
+      @suggested_indexes = @database.suggested_indexes(suggested_indexes_by_query: @suggested_indexes_by_query)
       @query_stats_by_query = @query_stats.index_by { |q| q[:query] }
       @debug = params[:debug].present?
     end
@@ -495,5 +524,13 @@ module PgHero
         redirect_to root_path, alert: "Query stats not enabled"
       end
     end
+
+    # rescue QueryCanceled for case when
+    # statement timeout is less than lock timeout
+    def rescue_timeout(default)
+      [yield, false]
+    rescue ActiveRecord::LockWaitTimeout, ActiveRecord::QueryCanceled
+      [default, true]
+    end
   end
 end

data/app/helpers/pg_hero/home_helper.rb

@@ -5,15 +5,15 @@ module PgHero
       if schema && schema != "public"
         ident = "#{schema}.#{table}"
       end
-      if ident =~ /\A[a-z0-9_]+\z/
+      if /\A[a-z0-9_]+\z/.match?(ident)
         ident
       else
         @database.quote_ident(ident)
       end
     end
 
-    def pghero_js_var(name, value)
-      "var #{name} = #{json_escape(value.to_json(root: false))};".html_safe
+    def pghero_js_value(value)
+      json_escape(value.to_json(root: false)).html_safe
     end
 
     def pghero_remove_index(query)

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

@@ -5,12 +5,12 @@
 
     <meta charset="utf-8" />
     <%= favicon_link_tag "pghero/favicon.png" %>
-    <% if defined?(Propshaft::Railtie) %>
+    <% if defined?(Propshaft::Railtie) && Rails.application.assets.is_a?(Propshaft::Assembly) %>
       <%= stylesheet_link_tag "pghero/nouislider", "pghero/arduino-light", "pghero/application" %>
-      <%= javascript_include_tag "pghero/jquery", "pghero/nouislider", "pghero/Chart.bundle", "pghero/chartkick", "pghero/highlight.pack", "pghero/application" %>
+      <%= javascript_include_tag "pghero/jquery", "pghero/nouislider", "pghero/Chart.bundle", "pghero/chartkick", "pghero/highlight.min", "pghero/application", nonce: true %>
     <% else %>
       <%= stylesheet_link_tag "pghero/application" %>
-      <%= javascript_include_tag "pghero/application" %>
+      <%= javascript_include_tag "pghero/application", nonce: true %>
     <% end %>
   </head>
   <body>

data/app/views/pg_hero/home/_connections_table.html.erb

@@ -2,7 +2,7 @@
   <thead>
     <tr>
       <th>Top Sources</th>
-      <th style="width: 20%;">Connections</th>
+      <th class="width-20">Connections</th>
     </tr>
   </thead>
   <tbody>

data/app/views/pg_hero/home/_live_queries_table.html.erb

@@ -1,10 +1,10 @@
 <table class="table queries">
   <thead>
     <tr>
-      <th style="width: 25%;">Pid</th>
-      <th style="width: 25%;">Duration</th>
-      <th style="width: 25%;">State</th>
-      <th style="width: 25%;"></th>
+      <th class="width-25">Pid</th>
+      <th class="width-25">Duration</th>
+      <th class="width-25">State</th>
+      <th class="width-25"></th>
     </tr>
   </thead>
   <tbody>
@@ -39,15 +39,15 @@
         </td>
       </tr>
       <tr>
-        <td colspan="6" style="border-top: none; padding: 0;">
+        <td colspan="4" class="query-row">
           <%= query[:source] %> <span class="text-muted"><%= query[:user] %></span>
-          <pre style="margin-top: 1em;"><code><%= query[:query] %></code></pre>
+          <pre class="query-pre"><code><%= query[:query] %></code></pre>
         </td>
       </tr>
     <% end %>
   </tbody>
 </table>
 
-<script>
+<%= javascript_tag nonce: true do %>
   highlightQueries();
-</script>
+<% end %>

data/app/views/pg_hero/home/_queries_table.html.erb

@@ -2,9 +2,9 @@
   <% unless local_assigns[:xhr] %>
     <thead>
       <tr>
-        <th style="width: 33.33%;"><%= local_assigns[:sort_headers] ? link_to("Total Time", {sort: nil}, data: {sort: nil}) : "Total Time" %></th>
-        <th style="width: 33.33%;"><%= local_assigns[:sort_headers] ? link_to("Average Time", {sort: "average_time"}, data: {sort: "average_time"}) : "Average Time" %></th>
-        <th style="width: 33.33%;"><%= local_assigns[:sort_headers] ? link_to("Calls", {sort: "calls"}, data: {sort: "calls"}) : "Calls" %></th>
+        <th class="width-33"><%= local_assigns[:sort_headers] ? link_to("Total Time", {sort: nil}, data: {sort: nil}) : "Total Time" %></th>
+        <th class="width-33"><%= local_assigns[:sort_headers] ? link_to("Average Time", {sort: "average_time"}, data: {sort: "average_time"}) : "Average Time" %></th>
+        <th class="width-33"><%= local_assigns[:sort_headers] ? link_to("Calls", {sort: "calls"}, data: {sort: "calls"}) : "Calls" %></th>
       </tr>
     </thead>
   <% end %>
@@ -57,8 +57,8 @@
         </td>
       </tr>
       <tr>
-        <td colspan="3" style="border-top: none; padding: 0;">
-          <pre><code style="max-height: 230px; overflow: hidden;" onclick="this.style.maxHeight = 'none';"><%= query[:query] %></code></pre>
+        <td colspan="3" class="query-row">
+          <pre><code class="query-code"><%= query[:query] %></code></pre>
           <% if query[:query] == "<insufficient privilege>" %>
             <p class="text-muted">For security reasons, only superusers can see queries executed by other users.</p>
           <% end %>

data/app/views/pg_hero/home/_query_stats_slider.html.erb

@@ -4,13 +4,13 @@
   <div id="range-start"></div>
 </div>
 
-<script>
-  <%= pghero_js_var("sort", @sort) %>
-  <%= pghero_js_var("minAverageTime", @min_average_time) %>
-  <%= pghero_js_var("minCalls", @min_calls) %>
-  <%= pghero_js_var("debug", @debug) %>
-  <%= pghero_js_var("startAt", params[:start_at] ? @start_at.to_i * 1000 : nil) %>
-  <%= pghero_js_var("endAt", @end_at.to_i * 1000) %>
+<%= javascript_tag nonce: true do %>
+  var sort = <%= pghero_js_value(@sort) %>;
+  var minAverageTime = <%= pghero_js_value(@min_average_time) %>;
+  var minCalls = <%= pghero_js_value(@min_calls) %>;
+  var debug = <%= pghero_js_value(@debug) %>;
+  var startAt = <%= pghero_js_value(params[:start_at] ? @start_at.to_i * 1000 : nil) %>;
+  var endAt = <%= pghero_js_value(@end_at.to_i * 1000) %>;
 
   initSlider();
-</script>
+<% end %>

data/app/views/pg_hero/home/_suggested_index.html.erb

@@ -1,13 +1,14 @@
 <% if index && !details[:covering_index] %>
   <% unless @debug %>
-    <div style="float: right; color: #f0ad4e; margin-top: 0px; padding: 10px; cursor: pointer;" onclick="document.getElementById('details-<%= index.object_id %>').style.display = 'block'; this.style.display = 'none';">Details</div>
+    <div class="show-details">Details</div>
   <% end %>
-  <code><pre style="color: #eee; background-color: #333;">CREATE INDEX CONCURRENTLY ON <%= index[:table] %><% if index[:using] %> USING <%= index[:using] %><% end %> (<%= index[:columns].join(", ") %>)</pre></code>
+  <code><pre class="create-index">CREATE INDEX CONCURRENTLY ON <%= index[:table] %><% if index[:using] %> USING <%= index[:using] %><% end %> (<%= index[:columns].join(", ") %>)</pre></code>
 <% end %>
-<div id="details-<%= index.object_id %>" style="<%= "display: none;" unless @debug %>">
-  <code><pre style="color: #f0ad4e; background-color: #333;"><% if details[:explanation] %><%= details[:explanation] %>
+<div class="details<%= " hide" unless @debug %>">
+  <code><pre><% if details[:explanation] %><%= details[:explanation] %>
 <% end %><% if details[:row_estimates] %>Rows: <%= details[:rows] %>
-Row progression: <%= details[:row_progression].to_a.join(", ") %>
+<% if details[:row_progression] %>Row progression: <%= details[:row_progression].to_a.join(", ") %>
+<% end %>
 
 Row estimates
 <%= details[:row_estimates].to_a.map { |k, v| "- #{k}: #{v}" }.join("\n") %><% end %><% if details[:table_indexes] %>

data/app/views/pg_hero/home/connections.html.erb

@@ -6,25 +6,25 @@
   <% if @total_connections > 0 %>
     <h3>By Database</h3>
 
-    <div id="chart-1" class="chart" style="height: 260px; line-height: 260px; margin-bottom: 20px;">Loading...</div>
-    <script>
-      new Chartkick.PieChart("chart-1", <%= json_escape(@connections_by_database.to_json).html_safe %>);
-    </script>
+    <div id="chart-1" class="chart pie-chart">Loading...</div>
+    <%= javascript_tag nonce: true do %>
+      new Chartkick.PieChart("chart-1", <%= pghero_js_value(@connections_by_database) %>);
+    <% end %>
 
     <h3>By User</h3>
 
-    <div id="chart-2" class="chart" style="height: 260px; line-height: 260px; margin-bottom: 20px;">Loading...</div>
-    <script>
-      new Chartkick.PieChart("chart-2", <%= json_escape(@connections_by_user.to_json).html_safe %>);
-    </script>
+    <div id="chart-2" class="chart pie-chart">Loading...</div>
+    <%= javascript_tag nonce: true do %>
+      new Chartkick.PieChart("chart-2", <%= pghero_js_value(@connections_by_user) %>);
+    <% end %>
 
     <% if @connections_by_ssl_status %>
       <h3>By Security</h3>
 
-      <div id="chart-3" class="chart" style="height: 260px; line-height: 260px; margin-bottom: 20px;">Loading...</div>
-      <script>
-        new Chartkick.PieChart("chart-3", <%= json_escape(@connections_by_ssl_status.to_json).html_safe %>);
-      </script>
+      <div id="chart-3" class="chart pie-chart">Loading...</div>
+      <%= javascript_tag nonce: true do %>
+        new Chartkick.PieChart("chart-3", <%= pghero_js_value(@connections_by_ssl_status) %>);
+      <% end %>
     <% end %>
 
     <%= render partial: "connections_table", locals: {connection_sources: @connection_sources} %>

data/app/views/pg_hero/home/explain.html.erb

@@ -4,9 +4,9 @@
   <%= form_tag explain_path do %>
     <div class="field"><%= text_area_tag :query, @query, placeholder: "Enter a SQL query" %></div>
     <p>
-      <%= submit_tag "Explain", class: "btn btn-info", style: "margin-right: 10px;" %>
+      <%= submit_tag "Explain", class: "btn btn-info right-5" %>
       <% if @explain_analyze_enabled %>
-        <%= submit_tag "Analyze", class: "btn btn-danger", style: "margin-right: 10px;" %>
+        <%= submit_tag "Analyze", class: "btn btn-danger right-5" %>
       <% end %>
       <%= submit_tag "Visualize", class: "btn btn-danger" %>
     </p>