pghero 3.3.3 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '002087a8cb8c6db43d1f084fd773aa4c8320c6fe77be3d4f42b6ca55ff91d39d'
-  data.tar.gz: fd4cb80b991e10232d7628604049e25685ae3723c53c7dd3231288b369015976
+  metadata.gz: be29c474a85a6d881dba5ab5a3b8ae273d62553fac0eeeef6c7a08f2087a4da1
+  data.tar.gz: a8637f122ec9946fb217bf6d7ab63b9aff2160de28c05bf054a25ce7d874c53c
 SHA512:
-  metadata.gz: 42a29de1135ce51d59423e0aedafff5261ffea8e93740a40aa80d472a48d01a799349ea9c48f78c027f86d493e342901698707894156b149236ca7e8f101a0a1
-  data.tar.gz: 68e636a77b47b825803c04ef90005827a66ae6abc0dab5f60bde8877f0c0d4aa580daa60c7959042bb0f9f0bb374eda3e885e0903069247a00c7a9a8779945a2
+  metadata.gz: ca6814ef570346653fa61963853839faeaa7c5a1c54224641cf709c303cc4b438e081b6b800eeb38c2167cba373c9734d1645ca7dcd7429b3c925b4420d83f31
+  data.tar.gz: c43a0efe62ab9be1b894335719294ed6328201c01645293ef4ca7c93ad9b0081486720d3229139f485ae7dc87ebc236b1a5391294c8f1c7c46114d58d847bb3d

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## 3.4.0 (2023-11-28)
+
+- Added support for explaining normalized queries with Postgres 16
+- Added Docker image for `linux/arm64`
+
+## 3.3.4 (2023-09-05)
+
+- Fixed support for aliases in config file
+
 ## 3.3.3 (2023-04-18)
 
 - Fixed error with system stats for Azure Database

data/README.md

@@ -8,7 +8,7 @@ A performance dashboard for Postgres
 
 :tangerine: Battle-tested at [Instacart](https://www.instacart.com/opensource)
 
-[![Build Status](https://github.com/ankane/pghero/workflows/build/badge.svg?branch=master)](https://github.com/ankane/pghero/actions) [![Docker Pulls](https://img.shields.io/docker/pulls/ankane/pghero)](https://hub.docker.com/r/ankane/pghero)
+[![Build Status](https://github.com/ankane/pghero/workflows/build/badge.svg?branch=master)](https://github.com/ankane/pghero/actions)
 
 ## Documentation
 

data/app/controllers/pg_hero/home_controller.rb

@@ -292,12 +292,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"}
@@ -306,6 +308,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
@@ -319,8 +323,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")

data/lib/pghero/methods/explain.rb

@@ -12,7 +12,7 @@ module PgHero
           if (sql.sub(/;\z/, "").include?(";") || sql.upcase.include?("COMMIT")) && !explain_safe?
             raise ActiveRecord::StatementInvalid, "Unsafe statement"
           end
-          explanation = select_all("EXPLAIN #{sql}").map { |v| v[:"QUERY PLAN"] }.join("\n")
+          explanation = execute("EXPLAIN #{sql}").map { |v| v["QUERY PLAN"] }.join("\n")
         end
 
         explanation
@@ -20,11 +20,12 @@ module PgHero
 
       # TODO rename to explain in 4.0
       # note: this method is not affected by the explain option
-      def explain_v2(sql, analyze: nil, verbose: nil, costs: nil, settings: nil, buffers: nil, wal: nil, timing: nil, summary: nil, format: "text")
+      def explain_v2(sql, analyze: nil, verbose: nil, costs: nil, settings: nil, generic_plan: nil, buffers: nil, wal: nil, timing: nil, summary: nil, format: "text")
         options = []
         add_explain_option(options, "ANALYZE", analyze)
         add_explain_option(options, "VERBOSE", verbose)
         add_explain_option(options, "SETTINGS", settings)
+        add_explain_option(options, "GENERIC_PLAN", generic_plan)
         add_explain_option(options, "COSTS", costs)
         add_explain_option(options, "BUFFERS", buffers)
         add_explain_option(options, "WAL", wal)

data/lib/pghero/methods/query_stats.rb

@@ -319,7 +319,7 @@ module PgHero
       end
 
       def explainable?(query)
-        query =~ /select/i && !query.include?("?)") && !query.include?("= ?") && !query.include?("$1") && query !~ /limit \?/i
+        query =~ /select/i && (server_version_num >= 160000 || (!query.include?("?)") && !query.include?("= ?") && !query.include?("$1") && query !~ /limit \?/i))
       end
 
       # removes comments

data/lib/pghero/version.rb

@@ -1,3 +1,3 @@
 module PgHero
-  VERSION = "3.3.3"
+  VERSION = "3.4.0"
 end

data/lib/pghero.rb

@@ -121,7 +121,7 @@ module PgHero
 
         config_file_exists = File.exist?(path)
 
-        config = YAML.safe_load(ERB.new(File.read(path)).result) if config_file_exists
+        config = YAML.safe_load(ERB.new(File.read(path)).result, aliases: true) if config_file_exists
         config ||= {}
 
         @file_config =
@@ -151,7 +151,7 @@ module PgHero
 
       if databases.empty?
         databases["primary"] = {
-          "url" => ENV["PGHERO_DATABASE_URL"] || connection_config(ActiveRecord::Base)
+          "url" => ENV["PGHERO_DATABASE_URL"] || default_connection_config
         }
       end
 
@@ -168,6 +168,11 @@ module PgHero
       }
     end
 
+    # private
+    def default_connection_config
+      connection_config(ActiveRecord::Base) if ActiveRecord::VERSION::STRING.to_f < 7.1
+    end
+
     # ensure we only have one copy of databases
     # so there's only one connection pool per database
     def databases

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pghero
 version: !ruby/object:Gem::Version
-  version: 3.3.3
+  version: 3.4.0
 platform: ruby
 authors:
 - Andrew Kane
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-18 00:00:00.000000000 Z
+date: 2023-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord