rails-pg-extras 4.7.0 → 4.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 80408a2c9f3f8e75d77405d2c702221ed8344e85a3fb1484d2563009ce8923c1
-  data.tar.gz: 9888e136dfe03dd8566f2d1a3a15703003d2d9faeddd5fac3c756728108bcb86
+  metadata.gz: acfc146396c33697f24aa0e96d251c77fd94e2a5d10a8154dcff9df02a981ac8
+  data.tar.gz: 5290474635b58a4e35afd3c075726b24e75a6194acd691e5b90b5b3289f2b5f1
 SHA512:
-  metadata.gz: 253d40f9bf6f6c0b717b581baba483e6068351651e6706177b4ffefaa41fc892dea9a0072af7632e01d071db85eb9d1376ba072ea61782d3aedf5ece90140e4d
-  data.tar.gz: '019b8421a159330e4a0ecb88104dd5ba004516dc83efd88cb4496ed4da896941a789725d5737109c16ab64bb10e87da23f223690cb7215507632c880acef1c1d'
+  metadata.gz: 3db2562f135d7b904239f5481d5050f1404062b679fa9dc1399379bea58f66c981d7adadee8d5af34ff4e5c0ffc10f6cd1de2c3fab03923083c45fa11d24785b
+  data.tar.gz: 91b734c2c9bc9e6678d50def9cc4603e5444f35b16ec90514e14644954fa1d8d8e4b014c287dc2beb2cb9edfc3cadd29f517ad3f4fd42a37872304b91c5c553b

data/README.md

@@ -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`:
 
@@ -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/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/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.7.0"
+  VERSION = "4.8.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-pg-extras
 version: !ruby/object:Gem::Version
-  version: 4.7.0
+  version: 4.8.1
 platform: ruby
 authors:
 - pawurb
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-06-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.7.0
+        version: 4.8.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.7.0
+        version: 4.8.1
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement