pghero 1.3.2 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8fe1e7db4a7b8d0181a485cf8239903d2d8bb8c3
-  data.tar.gz: c2cda0f71c0e04d0fe345d86d114bbf49862b9c0
+  metadata.gz: 0c54bcd3e6419f74fe1bc9ad92ab5424ccde607d
+  data.tar.gz: a3a347148aad3b70bca436c805472a2dee80096f
 SHA512:
-  metadata.gz: b0989fe3df1db33256d9cbc4affe14ea52ec44542827821deadc809eac6fe163d8aa48a6ec8573c9ea350644c235c9e7e57c2e085921e4db85ec6aae6290c8e7
-  data.tar.gz: cd101a030b03c7b5adf8f73e88b850ab071f2c358564810a857995d877b3267014dafe226dd84b85b1f0e3a1b36bc6352b24912256e81e5c6ebe2b78a805273d
+  metadata.gz: a942b06fd72ba880d7c73b0bc3e35807d4a6f7c9ebe5b3df8ef2a8e131f8ab92871d1ca94b2c0eb35ca95cfe9d6d02efcc123741fecd66db9730dc70eafad3f0
+  data.tar.gz: d9727509fea173d2c698b2eddafd04834ef006f9c9463be61b0b9582bc555f0d894b34ee075dd8adc537489c575fc89257411f4083b3a690bc8ab47562a4e7f7

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 1.4.0 [unreleased]
+
+- Updated for Rails 5
+- Fixed error when `pg_stat_statements` not enabled in `shared_libaries`
+
 ## 1.3.2
 
 - Improved performance of query stats

data/Gemfile

@@ -2,3 +2,5 @@ source "https://rubygems.org"
 
 # Specify your gem's dependencies in pghero.gemspec
 gemspec
+
+gem "activerecord", "~> 5.0.0"

data/app/controllers/pg_hero/home_controller.rb

@@ -33,7 +33,10 @@ module PgHero
       @invalid_indexes = PgHero.invalid_indexes
       @duplicate_indexes = PgHero.duplicate_indexes if params[:duplicate_indexes]
       @good_cache_rate = @table_hit_rate >= PgHero.cache_hit_rate_threshold.to_f / 100 && @index_hit_rate >= PgHero.cache_hit_rate_threshold.to_f / 100
-      @query_stats_available = PgHero.query_stats_available?
+      unless @query_stats_enabled
+        @query_stats_available = PgHero.query_stats_available?
+        @query_stats_extension_enabled = PgHero.query_stats_extension_enabled? if @query_stats_available
+      end
       @total_connections = PgHero.total_connections
       @good_total_connections = @total_connections < PgHero.total_connections_threshold
       if @replica

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

@@ -17,7 +17,8 @@
         <td><%= query["started_at"] ? "#{number_with_delimiter(((now - Time.parse(query["started_at"])) * 1000).round)} ms" : nil %></td>
         <td><%= query["source"] %> <span class="text-muted"><%= query["user"] %></span></td>
         <td class="text-right">
-          <%= button_to "Explain", explain_path(query: query["query"]), form: {target: "_blank"}, class: "btn btn-info" %>
+          <% button_path, button_options = Rails.version >= "4.1" ? [explain_path, {params: {query: query["query"]}}] : [explain_path(query: query["query"]), {}] %>
+          <%= button_to "Explain", button_path, button_options.merge(form: {target: "_blank"}, class: "btn btn-info") %>
           <%= button_to "Kill", kill_path(pid: query["pid"]), class: "btn btn-danger" %>
         </td>
       </tr>

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

@@ -13,6 +13,6 @@ Row estimates
 <%= details[:row_estimates].to_a.map { |k, v| "- #{k}: #{v}" }.join("\n") %><% end %><% if details[:table_indexes] %>
 
 Existing indexes
-<% details[:table_indexes].sort_by { |i| [i["primary"] == "t" ? 0 : 1, i["columns"]] }.each do |i3| %>- <%= i3["columns"].join(", ") %><% if i3["using"] != "btree" %> <%= i3["using"].to_s.upcase %><% end %><% if i3["primary"] == "t" %> PRIMARY<% elsif i3["unique"] != "f" %> UNIQUE<% end %>
+<% details[:table_indexes].sort_by { |i| [PgHero.truthy?(i["primary"]) ? 0 : 1, i["columns"]] }.each do |i3| %>- <%= i3["columns"].join(", ") %><% if i3["using"] != "btree" %> <%= i3["using"].to_s.upcase %><% end %><% if PgHero.truthy?(i3["primary"]) %> PRIMARY<% elsif PgHero.truthy?(i3["unique"]) %> UNIQUE<% end %>
 <% end %><% end %></pre></code>
 </div>

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

@@ -317,7 +317,7 @@ add_index <%= index[:table].to_sym.inspect %>, [<%= index[:columns].map(&:to_sym
   <div class="content">
     <h1>Query Stats</h1>
 
-    <% if @query_stats_available %>
+    <% if @query_stats_available && !@query_stats_extension_enabled %>
       <p>
         Query stats are available but not enabled.
         <%= button_to "Enable", enable_query_stats_path, class: "btn btn-info" %>

data/lib/pghero/methods/basic.rb

@@ -45,12 +45,21 @@ module PgHero
         ssl_used = nil
         connection_model.transaction do
           execute("CREATE EXTENSION IF NOT EXISTS sslinfo")
-          ssl_used = select_all("SELECT ssl_is_used()").first["ssl_is_used"] == "t"
+          ssl_used = truthy?(select_all("SELECT ssl_is_used()").first["ssl_is_used"])
           raise ActiveRecord::Rollback
         end
         ssl_used
       end
 
+      # Handles Rails 4 ('t') and Rails 5 (true) values.
+      def truthy?(value)
+        value == true || value == 't'
+      end
+
+      def falsey?(value)
+        value == false || value == 'f'
+      end
+
       private
 
       def friendly_value(setting, unit)

data/lib/pghero/methods/indexes.rb

@@ -140,8 +140,8 @@ module PgHero
         indexes = []
 
         indexes_by_table = self.indexes.group_by { |i| i["table"] }
-        indexes_by_table.values.flatten.select { |i| i["primary"] == "f" && i["unique"] == "f" && !i["indexprs"] && !i["indpred"] && i["valid"] == "t" }.each do |index|
-          covering_index = indexes_by_table[index["table"]].find { |i| index_covers?(i["columns"], index["columns"]) && i["using"] == index["using"] && i["name"] != index["name"] && i["valid"] == "t" }
+        indexes_by_table.values.flatten.select { |i| falsey?(i["primary"]) && falsey?(i["unique"]) && !i["indexprs"] && !i["indpred"] && truthy?(i["valid"]) }.each do |index|
+          covering_index = indexes_by_table[index["table"]].find { |i| index_covers?(i["columns"], index["columns"]) && i["using"] == index["using"] && i["name"] != index["name"] && truthy?(i["valid"]) }
           if covering_index
             indexes << {"unneeded_index" => index, "covering_index" => covering_index}
           end

data/lib/pghero/methods/kill.rb

@@ -2,7 +2,7 @@ module PgHero
   module Methods
     module Kill
       def kill(pid)
-        execute("SELECT pg_terminate_backend(#{pid.to_i})").first["pg_terminate_backend"] == "t"
+        truthy? execute("SELECT pg_terminate_backend(#{pid.to_i})").first["pg_terminate_backend"]
       end
 
       def kill_long_running_queries

data/lib/pghero/methods/query_stats.rb

@@ -31,11 +31,16 @@ module PgHero
       end
 
       def query_stats_enabled?
-        select_all("SELECT COUNT(*) AS count FROM pg_extension WHERE extname = 'pg_stat_statements'").first["count"].to_i > 0 && query_stats_readable?
+        query_stats_extension_enabled? && query_stats_readable?
+      end
+
+      def query_stats_extension_enabled?
+        select_all("SELECT COUNT(*) AS count FROM pg_extension WHERE extname = 'pg_stat_statements'").first["count"].to_i > 0
       end
 
       def query_stats_readable?
-        select_all("SELECT has_table_privilege(current_user, 'pg_stat_statements', 'SELECT')").first["has_table_privilege"] == "t"
+        select_all("SELECT * FROM pg_stat_statements LIMIT 1")
+        true
       rescue ActiveRecord::StatementInvalid
         false
       end
@@ -116,7 +121,7 @@ module PgHero
       # http://stackoverflow.com/questions/20582500/how-to-check-if-a-table-exists-in-a-given-schema
       def historical_query_stats_enabled?
         # TODO use schema from config
-        stats_connection.select_all(squish <<-SQL
+        truthy? stats_connection.select_all(squish <<-SQL
           SELECT EXISTS (
             SELECT
               1
@@ -130,7 +135,7 @@ module PgHero
               AND c.relkind = 'r'
           )
         SQL
-        ).to_a.first["exists"] == "t"
+        ).to_a.first["exists"]
       end
 
       def stats_connection

data/lib/pghero/version.rb

@@ -1,3 +1,3 @@
 module PgHero
-  VERSION = "1.3.2"
+  VERSION = "1.4.0"
 end

data/test/gemfiles/activerecord42.gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in pghero.gemspec
+gemspec path: "../.."
+
+gem "activerecord", "~> 4.2.0"

data/test/suggested_indexes_test.rb

@@ -2,14 +2,19 @@ require_relative "test_helper"
 
 class SuggestedIndexesTest < Minitest::Test
   def setup
+    # no pg_stat_statements
+    skip if ENV["TRAVIS_CI"]
+
     PgHero.reset_query_stats
   end
 
   def test_basic
-    # no pg_stat_statements
-    skip if ENV["TRAVIS_CI"]
-
     User.where(email: "person1@example.org").first
     assert_equal [{table: "users", columns: ["email"]}], PgHero.suggested_indexes.map { |q| q.except(:queries, :details) }
   end
+
+  def test_existing_index
+    User.where("updated_at > ?", Time.now).to_a
+    assert_equal [], PgHero.suggested_indexes.map { |q| q.except(:queries, :details) }
+  end
 end

data/test/test_helper.rb

@@ -31,7 +31,9 @@ unless ENV["SKIP_SEED"]
     t.string :zip_code
     t.boolean :active
     t.timestamp :created_at
+    t.timestamp :updated_at
   end
+  ActiveRecord::Migration.add_index :users, :updated_at
 
   User.transaction do
     users =
@@ -43,7 +45,8 @@ unless ENV["SKIP_SEED"]
           login_attempts: rand(30),
           zip_code: i % 40 == 0 ? nil : "12345",
           active: true,
-          created_at: Time.now - rand(50).days
+          created_at: Time.now - rand(50).days,
+          updated_at: Time.now - rand(50).days
         )
       end
     User.import users, validate: false

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pghero
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: 1.4.0
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-04 00:00:00.000000000 Z
+date: 2016-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -175,6 +175,7 @@ files:
 - test/best_index_test.rb
 - test/explain_test.rb
 - test/gemfiles/activerecord41.gemfile
+- test/gemfiles/activerecord42.gemfile
 - test/suggested_indexes_test.rb
 - test/test_helper.rb
 homepage: https://github.com/ankane/pghero
@@ -211,6 +212,7 @@ test_files:
 - test/best_index_test.rb
 - test/explain_test.rb
 - test/gemfiles/activerecord41.gemfile
+- test/gemfiles/activerecord42.gemfile
 - test/suggested_indexes_test.rb
 - test/test_helper.rb
 has_rdoc: