pg_peek 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: edfdc4a86128d1eec3f1c69e731780b9ef71afdd071d76cde2756eee57d55ff8
-  data.tar.gz: 666c7f0204c05e295f6c6950e32362720e273d579ec3eec6c557fd2769ab14c0
+  metadata.gz: eb99f16f0d2715eb1e038f98b4c7a43077678408b4f7f216f1238a823540f448
+  data.tar.gz: 2bda074f80788e6ab201e49948ce76539cb2e62ce2d0f06276ec22262ed32fda
 SHA512:
-  metadata.gz: 4ecde1526a25bd02fe30c47dbbe62ff2058ce2d8f6b1ff741ffd50b2eea26236e102646f98b67dabf4d9f6d566717a838c04c15be895d5d3b335a59bde342945
-  data.tar.gz: 44fa0fbf8d8ccd408c9e967b78ec29503fc94f605beb961cdc8480137773e7b6145af740990c039ac4f09be1c7664d03c204290190c0f9cd94a1e674b9517d15
+  metadata.gz: cbd81cbdb7abff990c656557f38e5d889e96c4b80a632a9c55d48b49b0363dd3443ee3ca13adc8ced93edcd5fde0b9c5fdeb4d202f8f64a755aeebacbcffe37d
+  data.tar.gz: 0f60578fbe2b529b6fc076d087a2908a0806e23f77597e70d57a8abc8166e8aa89509805f493af20a7495aba75c683a395ec4af1e1e6b032891491d20ae7b1c5

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

@@ -280,6 +280,12 @@ button, .button {
 button:hover { border-color: var(--fg); }
 button.danger { color: var(--danger); border-color: var(--danger); }
 button.danger:hover { background: var(--danger); color: var(--bg); }
+button:disabled, button:disabled:hover {
+  background: var(--panel);
+  color: var(--dim);
+  border-color: var(--line);
+  cursor: not-allowed;
+}
 
 form.inline { display: inline; margin: 0; }
 
@@ -297,6 +303,13 @@ form.inline { display: inline; margin: 0; }
   margin: 0.75rem 0;
 }
 
+.alert {
+  border: 1px solid var(--danger);
+  color: var(--danger);
+  padding: 0.4rem 0.75rem;
+  margin: 0.75rem 0;
+}
+
 mark { background: var(--accent); color: var(--bg); }
 
 .grid {

data/app/controllers/pg_peek/pg_stat_statements_controller.rb

@@ -3,9 +3,15 @@
 class PgPeek::PgStatStatementsController < PgPeek::ApplicationController
   def reset
     @database = PgPeek::Database.find(params[:database_id]) or raise ActiveRecord::RecordNotFound, "Database not found"
-    PgPeek::PgStatStatements.new(database: @database).reset!
+    pg_stat_statements = PgPeek::PgStatStatements.new(database: @database)
 
-    redirect_to database_path(@database, anchor: "pg_stat_statements"),
-                notice: "pg_stat_statements has been reset."
+    if pg_stat_statements.resettable?
+      pg_stat_statements.reset!
+      flash[:notice] = "pg_stat_statements has been reset."
+    else
+      flash[:alert] = "This role may not reset pg_stat_statements; the statistics were left as they are."
+    end
+
+    redirect_to database_path(@database, anchor: "pg_stat_statements")
   end
 end

data/app/models/pg_peek/pg_stat_statements.rb

@@ -24,16 +24,34 @@ class PgPeek::PgStatStatements
   # The extension can be created in the database while the module itself was
   # never loaded at server start. Querying the view then raises
   # PG::ObjectNotInPrerequisiteState, so every read has to check this first.
+  #
+  # Roles without pg_read_all_settings (dokku's postgres plugin, most managed
+  # hosts) cannot read shared_preload_libraries, so then the only way to tell
+  # is to ask the module itself.
   def preloaded?
-    shared_preload_libraries.split(",").map(&:strip).include?(LIBRARY_NAME)
+    if shared_preload_libraries
+      shared_preload_libraries.split(",").map(&:strip).include?(LIBRARY_NAME)
+    else
+      installed? && module_loaded?
+    end
   end
 
   def usable?
     installed? && preloaded?
   end
 
+  # nil when this role may not examine the setting, as opposed to "" when
+  # nothing is preloaded.
   def shared_preload_libraries
-    @shared_preload_libraries ||= connection.select_value(PgPeek::QueryLoader.mark("SHOW shared_preload_libraries")).to_s
+    return @shared_preload_libraries if defined?(@shared_preload_libraries)
+
+    @shared_preload_libraries = without_aborting_transaction do
+      connection.select_value(PgPeek::QueryLoader.mark("SHOW shared_preload_libraries")).to_s
+    end
+  rescue ActiveRecord::StatementInvalid => e
+    raise unless e.cause.is_a?(PG::InsufficientPrivilege)
+
+    @shared_preload_libraries = nil
   end
 
   def outdated?
@@ -42,12 +60,23 @@ class PgPeek::PgStatStatements
     @installed_version != @default_version
   end
 
+  # The extension revokes EXECUTE on the reset from PUBLIC, so only superusers
+  # and roles granted it may run one.
+  def resettable?
+    return @resettable if defined?(@resettable)
+
+    @resettable = usable? && connection.select_value(PgPeek::QueryLoader.mark(<<~SQL)) == true
+      SELECT bool_and(has_function_privilege(oid, 'EXECUTE'))
+      FROM pg_proc WHERE proname = 'pg_stat_statements_reset'
+    SQL
+  end
+
   # Server-wide on purpose. pg_stat_statements_info keeps a single stats_reset
   # for the whole server and only moves it when every entry is removed, so a
   # reset scoped to this database would leave "stats since" pointing at the
   # old time.
   def reset!
-    return unless usable?
+    return unless resettable?
 
     connection.execute PgPeek::QueryLoader.mark(<<-SQL)
       SELECT pg_stat_statements_reset();
@@ -119,6 +148,27 @@ class PgPeek::PgStatStatements
 
   private
 
+  # pg_stat_statements_info() raises PG::ObjectNotInPrerequisiteState unless
+  # the module was loaded at server start, and is readable by any role.
+  def module_loaded?
+    return @module_loaded if defined?(@module_loaded)
+
+    @module_loaded = without_aborting_transaction do
+      connection.select_value(PgPeek::QueryLoader.mark("SELECT 1 FROM pg_stat_statements_info"))
+      true
+    end
+  rescue ActiveRecord::StatementInvalid => e
+    raise unless e.cause.is_a?(PG::ObjectNotInPrerequisiteState)
+
+    @module_loaded = false
+  end
+
+  # A failed statement inside an open transaction (a host app's, or a
+  # transactional test) would poison it; a savepoint confines the failure.
+  def without_aborting_transaction(&)
+    connection.transaction(requires_new: true, &)
+  end
+
   def verify_installation
     result = connection.execute PgPeek::QueryLoader.mark(<<-SQL)
       SELECT default_version, installed_version FROM pg_available_extensions WHERE name = 'pg_stat_statements';

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

@@ -15,6 +15,7 @@
   <body>
     <main>
       <% if flash[:notice] %><p class="notice"><%= flash[:notice] %></p><% end %>
+      <% if flash[:alert] %><p class="alert"><%= flash[:alert] %></p><% end %>
       <nav>
         <ul>
           <li><%= link_to "pg_peek", databases_path, class: "wordmark" %></li>

data/app/views/pg_peek/databases/show.html.erb

@@ -142,8 +142,16 @@ end</code></pre>
                   reset_database_pg_stat_statements_path(@database),
                   method: :delete,
                   class: "danger",
+                  disabled: !@pg_stat_statements.resettable?,
                   form_class: "inline",
                   form: { data: { confirm: "Reset pg_stat_statements? This clears statement statistics for every database on this server." } } %>
+    <% unless @pg_stat_statements.resettable? %>
+      <p class="dim">
+        <%= @connection_summary["username"] %> may not reset the statistics: the extension
+        allows it only to superusers and roles granted it. To allow it:
+      </p>
+      <pre><code>GRANT EXECUTE ON FUNCTION pg_stat_statements_reset TO <%= @connection_summary["username"] %>;</code></pre>
+    <% end %>
     <% if @pg_stat_statements.outdated? %>
       <p class="dim">
         Version <%= @pg_stat_statements.default_version %> is available:

data/app/views/pg_peek/pg_stat_statements/_preload_instructions.html.erb

@@ -11,7 +11,11 @@
   <footer>
     <small>
       A server restart is required — this setting cannot be reloaded.
-      Currently loaded: <code><%= pg_stat_statements.shared_preload_libraries.presence || "(none)" %></code>
+      <% if pg_stat_statements.shared_preload_libraries %>
+        Currently loaded: <code><%= pg_stat_statements.shared_preload_libraries.presence || "(none)" %></code>
+      <% else %>
+        This role may not read <code>shared_preload_libraries</code>; the module itself reported it is not loaded.
+      <% end %>
     </small>
   </footer>
 </article>

data/lib/pg_peek/version.rb

@@ -1,3 +1,3 @@
 module PgPeek
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pg_peek
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Tomasz Mazur
@@ -171,6 +171,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/trix/pg_peek
   source_code_uri: https://github.com/trix/pg_peek
+  changelog_uri: https://github.com/trix/pg_peek/releases
   rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths: