rails-pg-extras-web 1.6.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c7f43ce0a38a6e61ba4c9424cd92614afd7f6609436d9da8aa0365365ad08a87
-  data.tar.gz: e0ffa21d94bc8c12069c081d746410b954d9dd56b2e88809b36fd456e94bca30
+  metadata.gz: 8ca457b8f7491e7b1eab0a053ec0fd563db431209718b40203a121dc31ecf453
+  data.tar.gz: aa628d82e9b6858f565ea0b6fbb57c4c945706e684ba9c9e85530bbaf728fa69
 SHA512:
-  metadata.gz: 55039e4b67cc04e64545ab07092bf135f9844ae84414d1a7688957fdcad0124918f538b4f3f020e133b7fedabfe86e4b3b5682654887794429c6d9c75ee99834
-  data.tar.gz: 368e5bcda5b27669152df55c5fec5940a7575bd1557628af8d206cd2f4221700eedf91818dfdad08dd7262bd37866eab47be7d018559eec368cb91df9158dbc4
+  metadata.gz: 70c68e56d0f99bb4511b23ac98d246e381e67634b751f02b6c6e57906ca8efd9a6c07861c75cb15a043fb8654d89c1a991ec9288b1cd07a087e9eefcbc45eecd
+  data.tar.gz: d9d877137d79912412c3d7885e8b49bdf1d4a3ad0024d37908f99dc4567de864ab963359ee9158288a2ece7b82e6444d78cd9eb7c1a9468a4467578522b3e12b

data/README.md

@@ -1,5 +1,7 @@
 # RailsPgExtrasWeb
-Web UI for rails-pg-extras-web
+Web UI for [rails-pg-extras](https://github.com/pawurb/rails-pg-extras)
+
+![WebUI](https://raw.githubusercontent.com/pawurb/rails-pg-extras/master/rails-pg-extras-web.png)
 
 ## Installation
 Add this line to your application's Gemfile:

data/app/controllers/rails_pg_extras_web/actions_controller.rb

@@ -0,0 +1,26 @@
+module RailsPgExtrasWeb
+  class ActionsController < ApplicationController
+    def kill_all
+      run(:kill_all)
+    end
+
+    def pg_stat_statements_reset
+      run(:pg_stat_statements_reset)
+    end
+
+    def add_extensions
+      run(:add_extensions)
+    end
+
+    private
+
+    def run(action)
+      begin
+        RailsPGExtras.run_query(query_name: action, in_format: :raw)
+        redirect_to root_path, notice: "Successfully ran #{action}"
+      rescue ActiveRecord::StatementInvalid => e
+        redirect_to root_path, alert: "Error: #{e.message}"
+      end
+    end
+  end
+end

data/app/controllers/rails_pg_extras_web/application_controller.rb

@@ -1,9 +1,18 @@
 require "rails-pg-extras"
+require "rails-pg-extras/version"
 
 module RailsPgExtrasWeb
   class ApplicationController < ActionController::Base
     layout "rails_pg_extras_web/application"
 
+    REQUIRED_EXTENSIONS = {
+      pg_stat_statements: %i[calls outliers pg_stat_statements_reset],
+      pg_buffercache: %i[buffercache_stats buffercache_usage],
+      sslinfo: %i[ssl_used]
+    }
+
+    ACTIONS = %i[kill_all pg_stat_statements_reset add_extensions]
+
     if Rails.env.production? && ENV['PG_EXTRAS_USER'].present? && ENV['PG_EXTRAS_PASSWORD'].present?
       http_basic_authenticate_with name: ENV['PG_EXTRAS_USER'], password: ENV['PG_EXTRAS_PASSWORD']
     end

data/app/controllers/rails_pg_extras_web/queries_controller.rb

@@ -1,51 +1,44 @@
 module RailsPgExtrasWeb
   class QueriesController < ApplicationController
-    REQUIRED_EXTENSIONS = {
-      pg_stat_statements: %i[calls outliers],
-      pg_buffercache: %i[buffercache_stats buffercache_usage]
-    }
-
     before_action :load_queries
     helper_method :unavailable_extensions
 
     def index
-      @query_name = params[:query_name]&.to_sym.presence_in(@all_queries.keys)
-      return unless @query_name
+      if params[:query_name].present?
+        @query_name = params[:query_name].to_sym.presence_in(@all_queries.keys)
+        return unless @query_name
+
+        begin
+          @result = RailsPGExtras.run_query(query_name: @query_name.to_sym, in_format: :raw)
+        rescue ActiveRecord::StatementInvalid => e
+          @error = e.message
+        end
 
-      @result = RailsPGExtras.run_query(query_name: @query_name.to_sym, in_format: :raw)
-    rescue ActiveRecord::StatementInvalid => e
-      @error = e.message
+        render :show
+      end
     end
 
     private
 
     def load_queries
-      @all_queries = {}
+      @all_queries = (RailsPGExtras::QUERIES - ACTIONS).inject({}) do |memo, query_name|
+        unless query_name.in? %i[mandelbrot]
+          memo[query_name] = { disabled: query_disabled?(query_name) }
+        end
 
-      ::RailsPGExtras::QUERIES.each do |query_name|
-        @all_queries[query_name] = {
-          disabled: query_disabled?(query_name),
-          command:  query_name == :kill_all
-        }
+        memo
       end
     end
 
     def query_disabled?(query_name)
-      case query_name
-      when :calls, :outliers
-        unavailable_extensions.key?(:pg_stat_statements)
-      when :buffercache_stats, :buffercache_usage
-        unavailable_extensions.key?(:pg_buffercache)
-      else
-        false
-      end
+      unavailable_extensions.values.flatten.include?(query_name)
     end
 
     def unavailable_extensions
       return @unavailable_extensions if defined?(@unavailable_extensions)
 
-      extensions = ActiveRecord::Base.connection.extensions
-      @unavailable_extensions = REQUIRED_EXTENSIONS.select { |extension, _| !extensions.include?(extension.to_s) }
+      enabled_extensions = ActiveRecord::Base.connection.extensions
+      @unavailable_extensions = REQUIRED_EXTENSIONS.delete_if { |ext| ext.to_s.in?(enabled_extensions)  }
     end
   end
 end

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

@@ -1,19 +1,26 @@
 <!DOCTYPE html>
 <html>
-<head>
-  <title>PG::Extras</title>
-</head>
-<body onload="document.forms.queries.query_name.focus()">
-  <%= form_with url: queries_path, id: "queries", method: :get do |f| %>
-    <%= f.select :query_name, options_for_select(@all_queries.except(:kill_all, :mandelbrot), params[:query_name]),
-      prompt: "--- select query ---"
-    %>
+  <head>
+    <title><%= content_for :title %> |  v<%= RailsPGExtras::VERSION %></title>
+    <%= javascript_include_tag "https://unpkg.com/@rails/ujs" %>
+    <link href="https://unpkg.com/tailwindcss@^2/dist/tailwind.min.css" rel="stylesheet">
+    <%= csrf_meta_tags %>
+  </head>
+  <body class="p-5 text-xs">
+    <% if flash[:notice] %>
+      <div class="bg-green-100 border-l-4 border-green-500 text-green-700 p-4 mb-4" role="alert">
+        <p class="font-bold">Notice</p>
+        <p><%= flash[:notice] %></p>
+      </div>
+    <% end %>
 
-    <button type="submit">Run</button>
-  <% end %>
+    <% if flash[:alert] %>
+      <div class="bg-red-100 border-l-4 border-red-500 text-red-700 p-4 mb-4" role="alert">
+        <p class="font-bold">Alert</p>
+        <p><%= flash[:alert] %></p>
+      </div>
+    <% end %>
 
-  <div style='margin-top: 20px'>
     <%= yield %>
-  </div>
-</body>
+  </body>
 </html>

data/app/views/rails_pg_extras_web/queries/_diagnose.html.erb

@@ -0,0 +1,9 @@
+  <h1 class="font-bold text-xl my-5">Diagnose</h1>
+  <table class="w-full font-mono border-collapse border my-5">
+    <% RailsPGExtras.diagnose(in_format: :hash).each do |diagnosis| %>
+      <tr class="<%= diagnosis[:ok] ? 'bg-green-300' : 'bg-red-300' %>">
+        <td class='p-1 border font-bold'><%= diagnosis[:check_name] %></td>
+        <td class='p-1 border'><%= diagnosis[:message] %></td>
+      </tr>
+    <% end %>
+  </table>

data/app/views/rails_pg_extras_web/queries/_result.html.erb

@@ -0,0 +1,21 @@
+<h1 class="font-bold text-xl my-5"><%= title %></h1>
+
+<table class="w-full font-mono border-collapse border my-5">
+  <thead>
+    <tr class="bg-gray-300">
+      <% headers.each do |header| %>
+      <th class="p-2 border text-left"><%= header %></th>
+      <% end %>
+    </tr>
+  </thead>
+  <tbody>
+  <% rows.each.with_index do |row, i| %>
+    <tr class="hover:bg-gray-400 hover:text-white <%= i.even? ? "bg-gray-100" : "bg-gray-200" %>">
+    <% row.each do |column| %>
+      <td class="p-1 border"><%= column %></td>
+    <% end %>
+    </tr>
+  <% end %>
+  </tbody>
+</table>
+<span class="italic">run_at: <%= Time.now.utc %></span>

data/app/views/rails_pg_extras_web/queries/_unavailable_extensions_warning.html.erb

@@ -0,0 +1,13 @@
+<div class="text-red-500 p-3 font-mono my-5">
+  <% unavailable_extensions.each do |extension, queries| %>
+    WARNING: Queries <%= queries.map { |q| "<b><u>#{q}</u></b>" }.join(", ").html_safe %> require extension: <b><%= extension %></b>
+    <br>
+  <% end %>
+ </div>
+
+<%= link_to "Enable extensions", add_extensions_action_path,
+  method: "post",
+  data: {
+    confirm: "This command will enable following extensions: #{unavailable_extensions.keys.join(', ')}. Do you want to proceeed?"
+  }, class: 'border p-3 bg-green-500 text-white hover:bg-green-600 font-bold rounded' %>
+

data/app/views/rails_pg_extras_web/queries/index.html.erb

@@ -1,72 +1,21 @@
-<% if unavailable_extensions.any? && !@result %>
-  <% unavailable_extensions.each do |extension, queries| %>
-    <span style='color: orange'>
-      WARNING: Queries <%= queries.map { |q| "<b><u>#{q}</u></b>" }.join(", ").html_safe %> require extension: <b><%= extension %></b>
-    </span>
-
-    <h4>Rails</h4>
-    <pre style='background-color: #e2e2e2; padding: 10px'>ActiveRecord::Base.connection.enable_extension "<%= extension %>"</pre>
-    <h4>SQL</h4>
-    <pre style='background-color: #e2e2e2; padding: 10px'>CREATE EXTENSION <%= extension %></pre>
-  <% end %>
-<% end %>
-
-<% if @error %>
-  <span style='color: red'><%= @error %></span>
-<% else %>
-  <% if @result && @result.any? %>
-    <table>
-      <caption><%= RubyPGExtras.description_for(query_name: @query_name) %></caption>
-      <thead>
-        <tr>
-          <% @result[0].keys.each do |header| %>
-            <th><%= header %></th>
-          <% end %>
-        </tr>
-      </thead>
-      <tbody>
-        <% @result.values.each do |row| %>
-          <tr>
-            <% row.each do |column| %>
-              <td><%= column %></td>
-            <% end %>
-          </tr>
-        <% end %>
-      </tbody>
-    </table>
-
-    <pre>run_at: <%= Time.now.utc %></pre>
-  <% else %>
-   <pre>No results</pre>
-  <% end %>
-<% end %>
-
-<style media="screen">
-  table {
-    font-family: monospace;
-    border-collapse: collapse;
-    width: 100%;
-  }
-
-  table th {
-    background-color: #c9c9;
-  }
-
-  table th, table td {
-    text-align: left;
-    border: 1px solid #c9c9;
-    padding: 3px;
-  }
-
-  table td {
-    overflow: hidden;
-    text-overflow: ellipsis;
-    white-space: nowrap;
-  }
-
-  table caption {
-    padding: 5px;
-    font-size: 15px;
-    font-weight: bold;
-  }
-</style>
+<%= content_for :title, "pg_extras" %>
+<%= render "rails_pg_extras_web/shared/queries_selector" %>
+<%= render "unavailable_extensions_warning" if unavailable_extensions.any? %>
+<%= render "diagnose" if unavailable_extensions.none? %>
+
+<h1 class="font-bold text-xl my-5">Actions</h1>
+
+<%= link_to "kill_all",  kill_all_action_path,
+  method: "post",
+  data: {
+    confirm: "This commands kills all the currently active connections to the database. Do you want to proceed?"
+  }, 
+  class: 'border p-3 bg-red-500 text-white hover:bg-red-600 font-bold rounded'
+%>
+
+<%= link_to "pg_stat_statements_reset", pg_stat_statements_reset_action_path,
+  method: "post",
+  data: {
+    confirm: "This command discards all statistics gathered so far by pg_stat_statements. Do you want to proceed?"
+  }, class: 'border p-3 bg-blue-500 text-white hover:bg-blue-600 font-bold rounded'
+%>

data/app/views/rails_pg_extras_web/queries/show.html.erb

@@ -0,0 +1,24 @@
+<%= content_for :title, params[:query_name].presence || "pg_extras" %>
+<%= render "rails_pg_extras_web/shared/queries_selector" %>
+
+<% if @error %>
+  <div class="text-red-500 p-3 font-mono my-5"><%= @error %></div>
+<% else %>
+  <% if @result&.any? %>
+    <%= render "result",
+      title: RubyPGExtras.description_for(query_name: @query_name),
+      headers: @result[0].keys,
+      rows: @result.values
+    %>
+  <% else %>
+   <div class="font-mono p-3 bg-gray-100 mt-3">No results</div>
+  <% end %>
+<% end %>
+
+<style>
+@media print {
+  form {
+    display: none
+  }
+}
+</style>

data/app/views/rails_pg_extras_web/shared/_queries_selector.html.erb

@@ -0,0 +1,11 @@
+<%= form_with url: queries_path, id: "queries", method: :get do |f| %>
+  <%= f.select :query_name, options_for_select(@all_queries, params[:query_name]),
+    {prompt: "--- select query ---"},
+    {class: "border p-2 font-bold", autofocus: true}
+  %>
+<% end %>
+<script>
+  document.getElementById('queries').addEventListener('change', (e) => {
+    e.target.form.submit()
+  })
+</script>

data/config/routes.rb

@@ -1,5 +1,9 @@
 RailsPgExtrasWeb::Engine.routes.draw do
-  resources :queries, only: :index
+  resources :queries, only: [:index]
+
+  post "/actions/kill_all" => "actions#kill_all", as: :kill_all_action
+  post "/actions/pg_stat_statements_reset" => "actions#pg_stat_statements_reset", as: :pg_stat_statements_reset_action
+  post "/actions/add_extensions" => "actions#add_extensions", as: :add_extensions_action
 
   root to: "queries#index"
 end

data/lib/rails_pg_extras_web/version.rb

@@ -1,3 +1,3 @@
 module RailsPgExtrasWeb
-  VERSION = '1.6.0'
+  VERSION = '3.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-pg-extras-web
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Tomasz Mazur
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-19 00:00:00.000000000 Z
+date: 2021-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg
@@ -30,15 +30,15 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.0
+        version: '3.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.0
-description: 
+        version: '3.1'
+description:
 email:
 - tomasz.mazur@hey.com
 executables: []
@@ -48,10 +48,16 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
+- app/controllers/rails_pg_extras_web/actions_controller.rb
 - app/controllers/rails_pg_extras_web/application_controller.rb
 - app/controllers/rails_pg_extras_web/queries_controller.rb
 - app/views/layouts/rails_pg_extras_web/application.html.erb
+- app/views/rails_pg_extras_web/queries/_diagnose.html.erb
+- app/views/rails_pg_extras_web/queries/_result.html.erb
+- app/views/rails_pg_extras_web/queries/_unavailable_extensions_warning.html.erb
 - app/views/rails_pg_extras_web/queries/index.html.erb
+- app/views/rails_pg_extras_web/queries/show.html.erb
+- app/views/rails_pg_extras_web/shared/_queries_selector.html.erb
 - config/routes.rb
 - lib/rails-pg-extras-web.rb
 - lib/rails_pg_extras_web/engine.rb
@@ -60,7 +66,7 @@ homepage: https://github.com/defkode/rails-pg-extras-web
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -76,7 +82,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.6
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Web UI for rails-pg-extras
 test_files: []