rails-pg-extras 5.0.0 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f1b2e490792ca16221528d9b86cc3631420e09ceeeb7162c4cdad45e520a9a03
-  data.tar.gz: f6e40c1f217b8d621e76420601d8f051f0cb897a46ed6cb0d5f1be86c882ef2f
+  metadata.gz: 1f7109cdaf06d94ed2a1707fffcd477a471c84ece3e648e4279f602f27e89b67
+  data.tar.gz: 583b204cfad10e9c3602946d5e00d0c10eaf1a7407e7234fc1f22db154e22bab
 SHA512:
-  metadata.gz: e010da06f594274147283f6a9aba8cdf82efc9802564639ace819194897ce97108d96323049c7a718fd91a84a2e92a9270009278738414b592d7871ff3a6ff8d
-  data.tar.gz: fc6291563b877bcd6ad8af7bc25676c9ae5bf1843a1c551d6a57c36fa7a3571bb58c3124e931a4214a5859498ec9f6a8fb4fc9cee0a6bd23f265adcc4f657ef5
+  metadata.gz: a3f334dcdf081777134219ab9f3c6ca0a0e95ca36495d71447690526c71bf893960219bda40d12c82973a2779131ff6977e99a141829f3a4121378b65d8e1659
+  data.tar.gz: 8eb2229994c72de036a4cf5e865b2503efcb831dd12c1182e4b45d43956cc89ffecb44f2bb1b7fe7a5ab50b82f4a662ddf2f7bee3756cac054d75639c8c5a6e2

data/README.md

@@ -140,25 +140,50 @@ end
 
 ## Available methods
 
-### `queries_data`
+### `measure_queries`
 
-This method allows checking query types executed when running a provided Ruby snippet. It can help debug N+1 issues and review the impact of adding eager loading:
+This method displays query types executed when running a provided Ruby snippet, with their avg., min., max., and total duration. It also outputs info about the snippet execution duration and the portion spent running SQL queries (`total_duration`/`sql_duration`). It can help debug N+1 issues and review the impact of configuring eager loading:
 
 ```ruby
 
-User.queries_data { User.limit(10).map(&:team) }
+User.measure_queries { User.limit(10).map(&:team) }
 
 # {:count=>11,
 #  :queries=>
-#   {"SELECT \"users\".* FROM \"users\" LIMIT $1"=>1,
-#    "SELECT \"teams\".* FROM \"teams\" WHERE \"teams\".\"id\" = $1 LIMIT $2"=>10}}
-
-User.queries_data { User.limit(10).includes(:team).map(&:team) }
+#   {"SELECT \"users\".* FROM \"users\" LIMIT $1"=>
+#     {:count=>1,
+#      :total_duration=>0.003183000022545457,
+#      :min_duration=>0.003183000022545457,
+#      :max_duration=>0.003183000022545457,
+#      :avg_duration=>0.003183000022545457},
+#    "SELECT \"teams\".* FROM \"teams\" WHERE \"teams\".\"id\" = $1 LIMIT $2"=>
+#     {:count=>10,
+#      :total_duration=>0.011682000011205673,
+#      :min_duration=>0.0007209999894257635,
+#      :max_duration=>0.0024030000204220414,
+#      :avg_duration=>0.0011682000011205673}},
+#  :total_duration=>0.15247199998702854,
+#  :sql_duration=>0.01486500003375113}
+
+User.measure_queries { User.limit(10).includes(:team).map(&:team) }
 
 # {:count=>2,
 #  :queries=>
-#   {"SELECT \"users\".* FROM \"users\" LIMIT $1"=>1,
-#    "SELECT \"teams\".* FROM \"teams\" WHERE \"teams\".\"id\" IN ($1, $2, $3, $4, $5, $6, $7, $8)"=>1}}
+#   {"SELECT \"users\".* FROM \"users\" LIMIT $1"=>
+#     {:count=>1,
+#      :total_duration=>0.0036189999955240637,
+#      :min_duration=>0.0036189999955240637,
+#      :max_duration=>0.0036189999955240637,
+#      :avg_duration=>0.0036189999955240637},
+#    "SELECT \"teams\".* FROM \"teams\" WHERE \"teams\".\"id\" IN ($1, $2, $3, $4, $5, $6, $7, $8)"=>
+#     {:count=>1,
+#      :total_duration=>0.003714999998919666,
+#      :min_duration=>0.003714999998919666,
+#      :max_duration=>0.003714999998919666,
+#      :avg_duration=>0.003714999998919666}},
+#  :total_duration=>0.023814999993192032,
+#  :sql_duration=>0.0073339999944437295}
+
 ```
 
 ### `table_info`

data/lib/rails-pg-extras.rb

@@ -62,20 +62,58 @@ module RailsPgExtras
     end
   end
 
-  def self.queries_data(&block)
-    queries = Hash.new(0)
-    subscriber = ActiveSupport::Notifications.subscribe("sql.active_record") do |_name, _start, _finish, _id, payload|
+  def self.measure_duration(&block)
+    starting = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+    block.call
+    ending = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+    elapsed = ending - starting
+    elapsed
+  end
+
+  def self.measure_queries(&block)
+    queries = {}
+    sql_duration = 0
+
+    method_name = if ActiveSupport::Notifications.respond_to?(:monotonic_subscribe)
+      :monotonic_subscribe
+    else
+      :subscribe
+    end
+
+    subscriber = ActiveSupport::Notifications.public_send(method_name, "sql.active_record") do |_name, start, finish, _id, payload|
       unless payload[:name] =~ /SCHEMA/
-        queries[payload[:sql]] += 1
+        key = payload[:sql]
+        queries[key] ||= { count: 0, total_duration: 0, min_duration: nil, max_duration: nil }
+        queries[key][:count] += 1
+        duration = finish - start
+        queries[key][:total_duration] += duration
+        sql_duration += duration
+
+        if queries[key][:min_duration] == nil || queries[key][:min_duration] > duration
+          queries[key][:min_duration] = duration
+        end
+
+        if queries[key][:max_duration] == nil || queries[key][:max_duration] < duration
+          queries[key][:max_duration] = duration
+        end
       end
     end
 
-    block.call
+    total_duration = measure_duration do
+      block.call
+    end
+
+    queries = queries.reduce({}) do |agg, val|
+      val[1][:avg_duration] = val[1][:total_duration] / val[1][:count]
+      agg.merge(val[0] => val[1])
+    end
 
     ActiveSupport::Notifications.unsubscribe(subscriber)
     {
-      count: queries.values.sum,
-      queries: queries
+      count: queries.reduce(0) { |agg, val| agg + val[1].fetch(:count) },
+      queries: queries,
+      total_duration: total_duration,
+      sql_duration: sql_duration
     }
   end
 

data/lib/rails_pg_extras/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-pg-extras
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 5.1.0
 platform: ruby
 authors:
 - pawurb
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-02-25 00:00:00.000000000 Z
+date: 2023-02-26 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.0.0
+        version: 5.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.0.0
+        version: 5.1.0
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement