rails-pg-extras 5.5.0 → 5.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7a02d3f90a286c80e215584b471293e8f2aaaaf33a56c56ca42e938d763b08dd
-  data.tar.gz: 6326377418830e39a9105347a61e65837e64c1c80e390faa661a98468d6ad565
+  metadata.gz: 12c092356cb3e67c70abd5e49d61227fda3872353846b2fc18f23e83e5b33526
+  data.tar.gz: 795c689588341078ed71d1ab6e522ba3b2d26e968d5f1a060983f70c0a163732
 SHA512:
-  metadata.gz: 4f89bd2d2b48f6cc82d9b0663e8d8a02f317d6aa4cc1052f0b123a126abf4bb5286068f1844b82a78c49b5b3fc835331fe16c7488ebc7ecd3b00bbdfeefcfe62
-  data.tar.gz: 33fdf43584ee3b879c2497ff28fe90f6494bbdadb77732692805cd99c25ec569d8ce94ff0839a4a255d92c36a5015df2b2f623cc04a8bd1d86dacd4306a45a09
+  metadata.gz: 821ad0700c0b8d6fc352e15f7c45591354ac49d061c16d67e55b1778ae1ea4b979bfd62f76dc0b0bebd6cf8716803fb7e799434deba397d28496ac634a4c34af
+  data.tar.gz: 5104d36a6a7e7a709f9e8be494178624b2e727d89e6958729dd00497245f11d2f8ae9a329c2ae848a00d41bf85e97b0eadb8cf17597678249e0150aa5837c120

data/.github/workflows/ci.yml

@@ -12,7 +12,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby-version: ['3.3', '3.2', '3.1', '3.0', '2.7', '2.6']
+        ruby-version: ['3.3', '3.2', '3.1', '3.0', '2.7']
     steps:
       - uses: actions/checkout@v4
       - name: Run PostgreSQL 12

data/README.md

@@ -135,7 +135,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.application.credentials.pg_extras.user` (or `RAILS_PG_EXTRAS_USER`) and `Rails.application.credentials.pg_extras.user` (or `RAILS_PG_EXTRAS_PASSWORD`) values. Authentication is mandatory unless you specify `RAILS_PG_EXTRAS_PUBLIC_DASHBOARD=true` or set `RailsPgExtras.configuration.public_dashboard = true`.
+You can enable HTTP basic auth by specifying `Rails.application.credentials.pg_extras.user` (or `RAILS_PG_EXTRAS_USER`) and `Rails.application.credentials.pg_extras.password` (or `RAILS_PG_EXTRAS_PASSWORD`) values. Authentication is mandatory unless you specify `RAILS_PG_EXTRAS_PUBLIC_DASHBOARD=true` or set `RailsPgExtras.configuration.public_dashboard = true`.
 
 You can configure available web actions in `config/initializers/rails_pg_extras.rb`:
 
@@ -210,6 +210,47 @@ you can add this info to the output:
 
 ![Marginalia logs](https://github.com/pawurb/rails-pg-extras/raw/main/marginalia-logs.png)
 
+### `missing_fk_indexes`
+
+This method lists columns likely to be foreign keys (i.e. column name ending in `_id` and related table exists) but don't have an index. It's recommended to always index foreign key columns because they are used for searching relation objects. 
+
+You can add indexes on the columns returned by this query and later check if they are receiving scans using the [unused_indexes method](#unused_indexes). Please remember that each index decreases write performance and autovacuuming overhead, so be careful when adding multiple indexes to often updated tables.
+
+```ruby
+RailsPgExtras.missing_fk_indexes(args: { table_name: "users" })
+
++---------------------------------+
+| Missing foreign key indexes     |
++-------------------+-------------+
+| table             | column_name |
++-------------------+-------------+
+| feedbacks         | team_id     |
+| votes             | user_id     |
++-------------------+-------------+
+
+```
+
+`table_name` argument is optional, if omitted, the method will display missing fk indexes for all the tables.
+
+## `missing_fk_constraints`
+
+Similarly to the previous method, this one shows columns likely to be foreign keys that don't have a corresponding foreign key constraint. Foreign key constraints improve data integrity in the database by preventing relations with nonexisting objects. You can read more about the benefits of using foreign keys [in this blog post](https://pawelurbanek.com/rails-postgresql-data-integrity).
+
+```ruby
+RailsPgExtras.missing_fk_constraints(args: { table_name: "users" })
+
++---------------------------------+
+| Missing foreign key constraints |
++-------------------+-------------+
+| table             | column_name |
++-------------------+-------------+
+| feedbacks         | team_id     |
+| votes             | user_id     |
++-------------------+-------------+
+
+```
+
+`table_name` argument is optional, if omitted, method will display missing fk constraints for all the tables.
 
 ### `table_info`
 

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

@@ -3,6 +3,14 @@ require "rails_pg_extras/version"
 
 module RailsPgExtras::Web
   class ApplicationController < ActionController::Base
+    def self.get_user
+      Rails.application.try(:credentials).try(:pg_extras).try(:user) || ENV["RAILS_PG_EXTRAS_USER"]
+    end
+
+    def self.get_password
+      Rails.application.try(:credentials).try(:pg_extras).try(:password) || ENV["RAILS_PG_EXTRAS_PASSWORD"]
+    end
+
     before_action :validate_credentials!
     layout "rails_pg_extras/web/application"
 
@@ -14,27 +22,14 @@ module RailsPgExtras::Web
 
     ACTIONS = %i[kill_all pg_stat_statements_reset add_extensions]
 
-    user = get_user
-    password = get_password
-
-    if user.present? && password.present?
-      http_basic_authenticate_with name: user, password: password
+    if get_user.present? && get_password.present?
+      http_basic_authenticate_with name: get_user, password: get_password
     end
 
     def validate_credentials!
-      if (get_user.blank? || get_password.blank?) && RailsPgExtras.configuration.public_dashboard != true
+      if (self.class.get_user.blank? || self.class.get_password.blank?) && RailsPgExtras.configuration.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
-
-    private
-
-    def get_user
-      Rails.application.try(:credentials).try(:pg_extras).try(:user) || ENV["RAILS_PG_EXTRAS_USER"]
-    end
-
-    def get_password
-      Rails.application.try(:credentials).try(:pg_extras).try(:password) || ENV["RAILS_PG_EXTRAS_PASSWORD"]
-    end
   end
 end

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

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

data/lib/rails-pg-extras.rb

@@ -6,6 +6,8 @@ require "rails_pg_extras/diagnose_data"
 require "rails_pg_extras/diagnose_print"
 require "rails_pg_extras/index_info"
 require "rails_pg_extras/index_info_print"
+require "rails_pg_extras/missing_fk_indexes"
+require "rails_pg_extras/missing_fk_constraints"
 require "rails_pg_extras/table_info"
 require "rails_pg_extras/table_info_print"
 
@@ -26,32 +28,12 @@ module RailsPgExtras
   end
 
   def self.run_query(query_name:, in_format:, args: {})
-    if %i(calls outliers).include?(query_name)
-      pg_stat_statements_version_sql = "SELECT installed_version
-                                        FROM pg_available_extensions
-                                        WHERE name = 'pg_stat_statements'"
-      if (version = RailsPgExtras.connection.execute(pg_stat_statements_version_sql)
-        .to_a[0].fetch("installed_version", nil))
-        if Gem::Version.new(version) < Gem::Version.new(NEW_PG_STAT_STATEMENTS)
-          query_name = "#{query_name}_legacy".to_sym
-        elsif Gem::Version.new(version) >= Gem::Version.new(PG_STAT_STATEMENTS_17)
-          query_name = "#{query_name}_17".to_sym
-        end
-      end
-    end
-
-    sql = if (custom_args = DEFAULT_ARGS[query_name].merge(args)) != {}
-        RubyPgExtras.sql_for(query_name: query_name) % custom_args
-      else
-        RubyPgExtras.sql_for(query_name: query_name)
-      end
-
-    result = connection.execute(sql)
-
-    RubyPgExtras.display_result(
-      result,
-      title: RubyPgExtras.description_for(query_name: query_name),
+    RubyPgExtras.run_query_base(
+      query_name: query_name,
+      conn: connection,
+      exec_method: :execute,
       in_format: in_format,
+      args: args,
     )
   end
 
@@ -150,6 +132,16 @@ module RailsPgExtras
     end
   end
 
+  def self.missing_fk_indexes(args: {}, in_format: :display_table)
+    result = RailsPgExtras::MissingFkIndexes.call(args[:table_name])
+    RubyPgExtras.display_result(result, title: "Missing foreign key indexes", in_format: in_format)
+  end
+
+  def self.missing_fk_constraints(args: {}, in_format: :display_table)
+    result = RailsPgExtras::MissingFkConstraints.call(args[:table_name])
+    RubyPgExtras.display_result(result, title: "Missing foreign key constraints", in_format: in_format)
+  end
+
   def self.connection
     if (db_url = ENV["RAILS_PG_EXTRAS_DATABASE_URL"])
       connector = ActiveRecord::Base.establish_connection(db_url)

data/lib/rails_pg_extras/configuration.rb

@@ -4,7 +4,7 @@ require "rails_pg_extras/web"
 
 module RailsPgExtras
   class Configuration
-    DEFAULT_CONFIG = { enabled_web_actions: Web::ACTIONS - [:kill_all], public_dashboard: ENV["RAILS_PG_EXTRAS_PUBLIC_DASHBOARD"] == "true" }
+    DEFAULT_CONFIG = { enabled_web_actions: Web::ACTIONS - [:kill_all, :kill_pid], public_dashboard: ENV["RAILS_PG_EXTRAS_PUBLIC_DASHBOARD"] == "true" }
 
     attr_reader :enabled_web_actions
     attr_accessor :public_dashboard

data/lib/rails_pg_extras/missing_fk_constraints.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module RailsPgExtras
+  class MissingFkConstraints < RubyPgExtras::MissingFkConstraints
+    private
+
+    def query_module
+      RailsPgExtras
+    end
+  end
+end

data/lib/rails_pg_extras/missing_fk_indexes.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module RailsPgExtras
+  class MissingFkIndexes < RubyPgExtras::MissingFkIndexes
+    private
+
+    def query_module
+      RailsPgExtras
+    end
+  end
+end

data/lib/rails_pg_extras/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RailsPgExtras
-  VERSION = "5.5.0"
+  VERSION = "5.6.1"
 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 add_extensions].freeze
+    ACTIONS = %i[kill_all pg_stat_statements_reset add_extensions kill_pid].freeze
 
     def self.action_enabled?(action_name)
       RailsPgExtras.configuration.enabled_web_actions.include?(action_name.to_sym)

data/spec/smoke_spec.rb

@@ -4,7 +4,13 @@ require "spec_helper"
 require "rails-pg-extras"
 
 describe RailsPgExtras do
-  RailsPgExtras::QUERIES.each do |query_name|
+  SKIP_QUERIES = %i[
+    kill_all
+    table_schema
+    table_foreign_keys
+  ]
+
+  RailsPgExtras::QUERIES.reject { |q| SKIP_QUERIES.include?(q) }.each do |query_name|
     it "#{query_name} query can be executed" do
       expect do
         RailsPgExtras.run_query(
@@ -31,7 +37,7 @@ describe RailsPgExtras do
 
   it "collecting queries data works" do
     output = RailsPgExtras.measure_queries { RailsPgExtras.diagnose(in_format: :hash) }
-    expect(output.fetch(:count)).to eq 10
+    expect(output.fetch(:count) > 0).to eq(true)
   end
 
   it "supports custom RAILS_PG_EXTRAS_DATABASE_URL" do
@@ -44,4 +50,20 @@ describe RailsPgExtras do
 
     ENV["RAILS_PG_EXTRAS_DATABASE_URL"] = nil
   end
+
+  describe "missing_fk_indexes" do
+    it "works" do
+      expect {
+        RailsPgExtras.missing_fk_indexes
+      }.not_to raise_error
+    end
+  end
+
+  describe "missing_fk_constraints" do
+    it "works" do
+      expect {
+        RailsPgExtras.missing_fk_constraints
+      }.not_to raise_error
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -7,21 +7,16 @@ require_relative "../lib/rails-pg-extras"
 
 pg_version = ENV["PG_VERSION"]
 
-port = if pg_version == "12"
-    "5432"
-  elsif pg_version == "13"
-    "5433"
-  elsif pg_version == "14"
-    "5434"
-  elsif pg_version == "15"
-    "5435"
-  elsif pg_version == "16"
-    "5436"
-  elsif pg_version == "17"
-    "5437"
-  else
-    "5432"
-  end
+PG_PORTS = {
+  "12" => "5432",
+  "13" => "5433",
+  "14" => "5434",
+  "15" => "5435",
+  "16" => "5436",
+  "17" => "5437",
+}
+
+port = PG_PORTS.fetch(pg_version, "5432")
 
 ENV["DATABASE_URL"] ||= "postgresql://postgres:secret@localhost:#{port}/rails-pg-extras-test"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-pg-extras
 version: !ruby/object:Gem::Version
-  version: 5.5.0
+  version: 5.6.1
 platform: ruby
 authors:
 - pawurb
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-04 00:00:00.000000000 Z
+date: 2025-02-02 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: 5.5.0
+        version: 5.6.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.5.0
+        version: 5.6.1
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -116,6 +116,8 @@ files:
 - lib/rails_pg_extras/diagnose_print.rb
 - lib/rails_pg_extras/index_info.rb
 - lib/rails_pg_extras/index_info_print.rb
+- lib/rails_pg_extras/missing_fk_constraints.rb
+- lib/rails_pg_extras/missing_fk_indexes.rb
 - lib/rails_pg_extras/railtie.rb
 - lib/rails_pg_extras/table_info.rb
 - lib/rails_pg_extras/table_info_print.rb