rails-pg-extras 4.4.0 → 4.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a0259a817155746ae3dda5a13fd1e6c8e0421dad029dd2c6100222379dad76f
-  data.tar.gz: 5ffdc7d923d458bab991439a65adf91ff3e752e8e90280c6e3faae57d36762a7
+  metadata.gz: acfc146396c33697f24aa0e96d251c77fd94e2a5d10a8154dcff9df02a981ac8
+  data.tar.gz: 5290474635b58a4e35afd3c075726b24e75a6194acd691e5b90b5b3289f2b5f1
 SHA512:
-  metadata.gz: a6a55fcb7e8cc126859f1f45f4ba38f9562f1bded1e4aa6287e3728926cc3eb598552d4cdcc311104e811b513f20a71f52d29964dd6f0137df68a2699e9ef7ab
-  data.tar.gz: 305dc8c57cace4845795b051afca373103765181a1121203d9963261a0be18b50d6335355a60988be745d16d19ecd9f30ac506f4cff15c5265c38cdca039316a
+  metadata.gz: 3db2562f135d7b904239f5481d5050f1404062b679fa9dc1399379bea58f66c981d7adadee8d5af34ff4e5c0ffc10f6cd1de2c3fab03923083c45fa11d24785b
+  data.tar.gz: 91b734c2c9bc9e6678d50def9cc4603e5444f35b16ec90514e14644954fa1d8d8e4b014c287dc2beb2cb9edfc3cadd29f517ad3f4fd42a37872304b91c5c553b

data/.circleci/config.yml

@@ -2,39 +2,47 @@ version: 2
 jobs:
   test:
     docker:
-      - image: circleci/ruby:2.6.5
+      - image: cimg/ruby:2.7.6
         environment:
           DATABASE_URL: postgresql://postgres:secret@localhost:5432/rails-pg-extras-test
-      - image: circleci/postgres:11.5
+      - image: cimg/postgres:11.15
         command: postgres -c shared_preload_libraries=pg_stat_statements
         name: postgres11
         environment:
           POSTGRES_USER: postgres
           POSTGRES_DB: rails-pg-extras-test
           POSTGRES_PASSWORD: secret
-      - image: circleci/postgres:12.7
+      - image: cimg/postgres:12.10
         command: postgres -c shared_preload_libraries=pg_stat_statements
         name: postgres12
         environment:
           POSTGRES_USER: postgres
           POSTGRES_DB: rails-pg-extras-test
           POSTGRES_PASSWORD: secret
-      - image: circleci/postgres:13.3
+      - image: cimg/postgres:13.6
         command: postgres -c shared_preload_libraries=pg_stat_statements
         name: postgres13
         environment:
           POSTGRES_USER: postgres
           POSTGRES_DB: rails-pg-extras-test
           POSTGRES_PASSWORD: secret
+      - image: cimg/postgres:14.2
+        command: postgres -c shared_preload_libraries=pg_stat_statements
+        name: postgres14
+        environment:
+          POSTGRES_USER: postgres
+          POSTGRES_DB: rails-pg-extras-test
+          POSTGRES_PASSWORD: secret
     parallelism: 1
     steps:
       - checkout
       - run: gem update --system
       - run: gem install bundler
-      - run: bundle config set --local path 'vendor/bundle'
-      - run: bundle install
       - run: sudo apt-get update --allow-releaseinfo-change
       - run: sudo apt install postgresql-client
+      - run: sudo apt install libpq-dev
+      - run: bundle config set --local path 'vendor/bundle'
+      - run: bundle install
       - run: dockerize -wait tcp://postgres11:5432 -timeout 1m
       - run:
           name: Run specs for PG 11
@@ -51,6 +59,11 @@ jobs:
           environment:
             DATABASE_URL: postgresql://postgres:secret@postgres13:5432/rails-pg-extras-test
           command: bundle exec rspec spec/
+      - run:
+          name: Run specs for PG 14
+          environment:
+            DATABASE_URL: postgresql://postgres:secret@postgres14:5432/rails-pg-extras-test
+          command: bundle exec rspec spec/
 workflows:
   version: 2
   test:

data/README.md

@@ -20,7 +20,7 @@ Alternative versions:
 
 - [Elixir](https://github.com/pawurb/ecto_psql_extras)
 
-- [Python](https://github.com/pawurb/ecto_psql_extras)
+- [Python Flask](https://github.com/nickjj/flask-pg-extras)
 
 - [Haskell](https://github.com/pawurb/haskell-pg-extras)
 
@@ -119,7 +119,7 @@ You can enable UI using a Rails engine by adding the following code in `config/r
   mount RailsPgExtras::Web::Engine, at: 'pg_extras'
 ```
 
-You can enable HTTP basic auth by specifying `RAILS_PG_EXTRAS_USER` and `RAILS_PG_EXTRAS_PASSWORD` variables.
+You can enable HTTP basic auth by specifying `RAILS_PG_EXTRAS_USER` and `RAILS_PG_EXTRAS_PASSWORD` variables. Authentication is mandatory unless you specify `RAILS_PG_EXTRAS_PUBLIC_DASHBOARD=true`.
 
 You can configure available web actions in `config/initializers/rails_pg_extras.rb`:
 
@@ -128,7 +128,7 @@ RailsPgExtras.configure do |config|
   # Rails-pg-extras does not enable all the web actions by default. You can check all available actions via `RailsPgExtras::Web::ACTIONS`.
   # For example, you may want to enable the dangerous `kill_all` action.
 
-  config.enabled_web_actions = %i[kill_all pg_stat_statements_reset enable_extensions]
+  config.enabled_web_actions = %i[kill_all pg_stat_statements_reset add_extensions]
 end
 ```
 
@@ -286,14 +286,14 @@ RailsPgExtras.locks
 
 $ rake pg_extras:locks
 
- procpid | relname | transactionid | granted |     query_snippet     | mode             |       age
----------+---------+---------------+---------+-----------------------+-------------------------------------
-   31776 |         |               | t       | <IDLE> in transaction | ExclusiveLock    |  00:19:29.837898
-   31776 |         |          1294 | t       | <IDLE> in transaction | RowExclusiveLock |  00:19:29.837898
-   31912 |         |               | t       | select * from hello;  | ExclusiveLock    |  00:19:17.94259
-    3443 |         |               | t       |                      +| ExclusiveLock    |  00:00:00
-         |         |               |         |    select            +|                  |
-         |         |               |         |      pg_stat_activi   |                  |
+ procpid | relname | transactionid | granted |     query_snippet     | mode             |       age        |   application |
+---------+---------+---------------+---------+-----------------------+------------------------------------------------------
+   31776 |         |               | t       | <IDLE> in transaction | ExclusiveLock    |  00:19:29.837898 |  bin/rails
+   31776 |         |          1294 | t       | <IDLE> in transaction | RowExclusiveLock |  00:19:29.837898 |  bin/rails
+   31912 |         |               | t       | select * from hello;  | ExclusiveLock    |  00:19:17.94259  |  bin/rails
+    3443 |         |               | t       |                      +| ExclusiveLock    |  00:00:00        |  bin/sidekiq
+         |         |               |         |    select            +|                  |                  |
+         |         |               |         |      pg_stat_activi   |                  |                  |
 (4 rows)
 ```
 

data/Rakefile

@@ -5,6 +5,6 @@ RSpec::Core::RakeTask.new(:spec)
 
 desc 'Test all PG versions'
 task :test_all do
-  system("PG_VERSION=11 bundle exec rspec spec/ && PG_VERSION=12 bundle exec rspec spec/ && PG_VERSION=13 bundle exec rspec spec/")
+  system("PG_VERSION=11 bundle exec rspec spec/ && PG_VERSION=12 bundle exec rspec spec/ && PG_VERSION=13 bundle exec rspec spec/ && PG_VERSION=14 bundle exec rspec spec/")
 end
 

data/app/controllers/rails_pg_extras/web/application_controller.rb

@@ -3,6 +3,7 @@ require "rails_pg_extras/version"
 
 module RailsPgExtras::Web
   class ApplicationController < ActionController::Base
+    before_action :validate_credentials!
     layout "rails_pg_extras/web/application"
 
     REQUIRED_EXTENSIONS = {
@@ -14,7 +15,13 @@ module RailsPgExtras::Web
     ACTIONS = %i[kill_all pg_stat_statements_reset add_extensions]
 
     if ENV['RAILS_PG_EXTRAS_USER'].present? && ENV['RAILS_PG_EXTRAS_PASSWORD'].present?
-      http_basic_authenticate_with name: ENV['RAILS_PG_EXTRAS_USER'], password: ENV['RAILS_PG_EXTRAS_PASSWORD']
+      http_basic_authenticate_with name: ENV.fetch('RAILS_PG_EXTRAS_USER'), password: ENV.fetch('RAILS_PG_EXTRAS_PASSWORD')
+    end
+
+    def validate_credentials!
+      if (ENV['RAILS_PG_EXTRAS_USER'].blank? || ENV['RAILS_PG_EXTRAS_PASSWORD'].blank?) && ENV["RAILS_PG_EXTRAS_PUBLIC_DASHBOARD"] != "true"
+        raise "Missing credentials for rails-pg-extras dashboard! If you want to enable public dashboard please set RAILS_PG_EXTRAS_PUBLIC_DASHBOARD=true"
+      end
     end
   end
 end

data/app/controllers/rails_pg_extras/web/queries_controller.rb

@@ -21,7 +21,7 @@ module RailsPgExtras::Web
     private
 
     def load_queries
-      @all_queries = (RailsPgExtras::QUERIES - ACTIONS).inject({}) do |memo, query_name|
+      @all_queries = (RailsPgExtras::QUERIES - RailsPgExtras::Web::ACTIONS).inject({}) do |memo, query_name|
         unless query_name.in? %i[mandelbrot]
           memo[query_name] = { disabled: query_disabled?(query_name) }
         end

data/app/views/rails_pg_extras/web/queries/_unavailable_extensions_warning.html.erb

@@ -5,7 +5,7 @@
   <% end %>
  </div>
 
-<% if RailsPgExtras::Web.action_enabled?(:enable_extensions) %>
+<% if RailsPgExtras::Web.action_enabled?(:add_extensions) %>
   <%= link_to "Enable extensions", add_extensions_action_path,
     method: "post",
     data: {

data/app/views/rails_pg_extras/web/queries/index.html.erb

@@ -15,7 +15,7 @@
   %>
 <% end %>
 
-<% if RailsPgExtras::Web.action_enabled?(:pg_stat_statements_reset) %>
+<% if RailsPgExtras::Web.action_enabled?(:pg_stat_statements_reset) && unavailable_extensions.exclude?(:pg_stat_statements) %>
   <%= link_to "pg_stat_statements_reset", pg_stat_statements_reset_action_path,
     method: "post",
     data: {

data/app/views/rails_pg_extras/web/shared/_queries_selector.html.erb

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

data/docker-compose.yml.sample

@@ -2,7 +2,7 @@ version: '3'
 
 services:
   postgres11:
-    image: postgres:11.5-alpine
+    image: postgres:11.16-alpine
     command: postgres -c shared_preload_libraries=pg_stat_statements
     environment:
       POSTGRES_USER: postgres
@@ -11,7 +11,7 @@ services:
     ports:
       - '5432:5432'
   postgres12:
-    image: postgres:12.7-alpine
+    image: postgres:12.11-alpine
     command: postgres -c shared_preload_libraries=pg_stat_statements
     environment:
       POSTGRES_USER: postgres
@@ -20,7 +20,7 @@ services:
     ports:
       - '5433:5432'
   postgres13:
-    image: postgres:13.3-alpine
+    image: postgres:13.7-alpine
     command: postgres -c shared_preload_libraries=pg_stat_statements
     environment:
       POSTGRES_USER: postgres
@@ -28,3 +28,12 @@ services:
       POSTGRES_PASSWORD: secret
     ports:
       - '5434:5432'
+  postgres14:
+    image: postgres:14.3-alpine
+    command: postgres -c shared_preload_libraries=pg_stat_statements
+    environment:
+      POSTGRES_USER: postgres
+      POSTGRES_DB: rails-pg-extras-test
+      POSTGRES_PASSWORD: secret
+    ports:
+      - '5435:5432'

data/lib/rails_pg_extras/tasks/all.rake

@@ -3,35 +3,25 @@
 require 'rails-pg-extras'
 
 namespace :pg_extras do
-  task :establish_connection do
-    if ENV['DATABASE_URL'].present?
-      ActiveRecord::Base.establish_connection(ENV['DATABASE_URL'])
-    else
-      db_config_file = File.read('config/database.yml')
-      db_config = YAML::load(ERB.new(db_config_file).result, aliases: true)
-      ActiveRecord::Base.establish_connection(db_config[Rails.env])
-    end
-  end
-
   RailsPgExtras::QUERIES.each do |query_name|
     desc RubyPgExtras.description_for(query_name: query_name)
-    task query_name.to_sym => :establish_connection do
+    task query_name.to_sym => :environment do
       RailsPgExtras.public_send(query_name)
     end
   end
 
   desc "Generate a PostgreSQL healthcheck report"
-  task diagnose: :establish_connection do
+  task diagnose: :environment do
     RailsPgExtras.diagnose
   end
 
   desc "Display tables metadata metrics"
-  task table_info: :establish_connection do
+  task table_info: :environment do
     RailsPgExtras.table_info
   end
 
   desc "Display indexes metadata metrics"
-  task index_info: :establish_connection do
+  task index_info: :environment do
     RailsPgExtras.index_info
   end
 end

data/lib/rails_pg_extras/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RailsPgExtras
-  VERSION = "4.4.0"
+  VERSION = "4.8.1"
 end

data/lib/rails_pg_extras/web/engine.rb

@@ -3,5 +3,7 @@ require 'rails'
 module RailsPgExtras::Web
   class Engine < ::Rails::Engine
     isolate_namespace RailsPgExtras::Web
+
+    config.middleware.use ActionDispatch::Flash
   end
 end

data/lib/rails_pg_extras/web.rb

@@ -2,7 +2,7 @@ require "rails_pg_extras/web/engine"
 
 module RailsPgExtras
   module Web
-    ACTIONS = %i[kill_all pg_stat_statements_reset enable_extensions].freeze
+    ACTIONS = %i[kill_all pg_stat_statements_reset add_extensions].freeze
 
     def self.action_enabled?(action_name)
       RailsPgExtras.configuration.enabled_web_actions.include?(action_name.to_sym)

data/spec/spec_helper.rb

@@ -13,6 +13,8 @@ elsif pg_version == "12"
   "5433"
 elsif pg_version == "13"
   "5434"
+elsif pg_version == "14"
+  "5435"
 else
   "5432"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-pg-extras
 version: !ruby/object:Gem::Version
-  version: 4.4.0
+  version: 4.8.1
 platform: ruby
 authors:
 - pawurb
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-03-12 00:00:00.000000000 Z
+date: 2022-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-pg-extras
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.4.0
+        version: 4.8.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.4.0
+        version: 4.8.1
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement