active_record_query_counter 2.0.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eb19f1f7e8a7678f3cdf3079b05e9aa26353b33b809c240943e0899f584dac6a
-  data.tar.gz: 7bcbce0b2d06c4f871074898651071f1400cd87c7ee8ee514837ee80caac6774
+  metadata.gz: 00cf8b2bba420e0b37944a53f4be128aeac846d6e387b15b03c3393f3a0030c2
+  data.tar.gz: 10c05613e25513f1afab756f9cdd1133a19f7b54e34ca811b7f3ba5ad982ff0e
 SHA512:
-  metadata.gz: 80c468ec96c069bb4043a0e210d4fb4b1d82714d2aa0b69bd07ac9fd23bb04255ffcf4b175fcfa66b7aa0afd8434c211645e70f4fd8d05ad9c10faa4ee95c679
-  data.tar.gz: fb972d526b98c97f98230a29eb9412726746a58c3d4a05406ab9ccc046d6eb0ec5007fa8d52d26a40c9a966ad2af4c50c045c1d9257cd15ce90dd21c5dedbcfa
+  metadata.gz: 4294aac8c3b0b55197ba1d069cc0a57f269ad772c23480b928fcf3f0a01b7c4f806f4969bf32f2d229b8dea65bc976d18cc864f923ec468dbbb43fc2fbe20bdd
+  data.tar.gz: ffddf3b2d87b74a2ad184d0ec55c4b371cda418c262aa2d0889cf40916579f5bff575ef0e631a39764edd58f7d321b71fa1b993dda6c3ff0c9f1ef060ca02769

data/CHANGELOG.md

@@ -4,6 +4,23 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## 2.2.0
+
+### Added
+
+- Added `ActiveRecordQueryCounter.disable` method to allow disabling query counting behavior within a block.
+- Rails 7.1 compatibility.
+
+## 2.1.0
+
+### Added
+
+- Added count of queries that hit the query cache instead of being sent to the database.
+
+### Removed
+
+- Dropped support for ActiveRecord 5.0.
+
 ## 2.0.0
 
 ### Added

data/README.md

@@ -60,6 +60,18 @@ Sidekiq.configure_server do |config|
 end
 ```
 
+If you want to disable query counting within a block of code, you can use the `disable` method.
+
+```ruby
+ActiveRecordQueryCounter.count_queries do
+  do_something
+  ActiveRecordQueryCounter.disable do
+    # Queries will not be counted in this block.
+    do_something_else
+  end
+end
+```
+
 ### Notifications
 
 You can also subscribe to ActiveSupport notifications to get notified when query thresholds are exceeded.

data/VERSION

@@ -1 +1 @@
-2.0.0
+2.2.0

data/active_record_query_counter.gemspec

@@ -28,7 +28,7 @@ Gem::Specification.new do |spec|
 
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "activerecord", ">= 5.0"
+  spec.add_dependency "activerecord", ">= 5.1"
 
   spec.add_development_dependency "bundler"
 

data/lib/active_record_query_counter/connection_adapter_extension.rb

@@ -3,14 +3,38 @@
 module ActiveRecordQueryCounter
   # Module to prepend to the connection adapter to inject the counting behavior.
   module ConnectionAdapterExtension
-    def exec_query(sql, name = nil, binds = [], *args, **kwargs)
-      start_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)
-      result = super
-      if result.is_a?(ActiveRecord::Result)
-        end_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)
-        ActiveRecordQueryCounter.add_query(sql, name, binds, result.length, start_time, end_time)
+    class << self
+      def inject(connection_class)
+        # Rails 7.1+ uses internal_exec_query instead of exec_query.
+        mod = (connection_class.instance_methods.include?(:internal_exec_query) ? InternalExecQuery : ExecQuery)
+        unless connection_class.include?(mod)
+          connection_class.prepend(mod)
+        end
+      end
+    end
+
+    module ExecQuery
+      def exec_query(sql, name = nil, binds = [], *args, **kwargs)
+        start_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+        result = super
+        if result.is_a?(ActiveRecord::Result)
+          end_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+          ActiveRecordQueryCounter.add_query(sql, name, binds, result.length, start_time, end_time)
+        end
+        result
+      end
+    end
+
+    module InternalExecQuery
+      def internal_exec_query(sql, name = nil, binds = [], *args, **kwargs)
+        start_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+        result = super
+        if result.is_a?(ActiveRecord::Result)
+          end_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+          ActiveRecordQueryCounter.add_query(sql, name, binds, result.length, start_time, end_time)
+        end
+        result
       end
-      result
     end
   end
 end

data/lib/active_record_query_counter/counter.rb

@@ -3,17 +3,30 @@
 module ActiveRecordQueryCounter
   # Data structure for storing query information encountered within a block.
   class Counter
-    attr_accessor :query_count, :row_count, :query_time
+    attr_accessor :query_count, :row_count, :query_time, :cached_query_count
     attr_reader :thresholds
 
     def initialize
       @query_count = 0
       @row_count = 0
       @query_time = 0.0
+      @cached_query_count = 0
       @transactions_hash = {}
       @thresholds = ActiveRecordQueryCounter.default_thresholds.dup
     end
 
+    # Return the percentage of queries that used the query cache instead of going to the database.
+    #
+    # @return [Float]
+    def cache_hit_rate
+      total_queries = query_count + cached_query_count
+      if total_queries > 0
+        (cached_query_count.to_f / total_queries)
+      else
+        0.0
+      end
+    end
+
     # Return an array of transaction information for any transactions that have been tracked
     # by the counter.
     #

data/lib/active_record_query_counter/thresholds.rb

@@ -6,6 +6,10 @@ module ActiveRecordQueryCounter
   class Thresholds
     attr_reader :query_time, :row_count, :transaction_time, :transaction_count
 
+    def initialize
+      clear
+    end
+
     def query_time=(value)
       @query_time = value&.to_f
     end

data/lib/active_record_query_counter/transaction_manager_extension.rb

@@ -3,6 +3,14 @@
 module ActiveRecordQueryCounter
   # Extension to ActiveRecord::ConnectionAdapters::TransactionManager to count transactions.
   module TransactionManagerExtension
+    class << self
+      def inject(transaction_manager_class)
+        unless transaction_manager_class.include?(self)
+          transaction_manager_class.prepend(self)
+        end
+      end
+    end
+
     def begin_transaction(*args, **kwargs)
       if open_transactions == 0
         @active_record_query_counter_transaction_start_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)

data/lib/active_record_query_counter.rb

@@ -19,7 +19,7 @@ require_relative "active_record_query_counter/version"
 #    puts ActiveRecordQueryCounter.row_count
 #  end
 module ActiveRecordQueryCounter
-  IGNORED_STATEMENTS = %w[CACHE SCHEMA EXPLAIN].freeze
+  IGNORED_STATEMENTS = %w[SCHEMA EXPLAIN].freeze
   private_constant :IGNORED_STATEMENTS
 
   class << self
@@ -48,6 +48,20 @@ module ActiveRecordQueryCounter
       end
     end
 
+    # Disable query counting in a block. Any queries or transactions inside the block will not
+    # be counted.
+    #
+    # @return [Object] the return value of the block
+    def disable(&block)
+      counter = current_counter
+      begin
+        self.current_counter = nil
+        yield
+      ensure
+        self.current_counter = counter
+      end
+    end
+
     # Increment the query counters.
     #
     # @param row_count [Integer] the number of rows returned by the query
@@ -107,6 +121,16 @@ module ActiveRecordQueryCounter
       counter.query_count if counter.is_a?(Counter)
     end
 
+    # Return the number of queries that hit the query cache and were not sent to the database
+    # that have been counted within the current block.  Returns nil if not inside a block where
+    # queries are being counted.
+    #
+    # @return [Integer, nil]
+    def cached_query_count
+      counter = current_counter
+      counter.cached_query_count if counter.is_a?(Counter)
+    end
+
     # Return the number of rows that have been counted within the current block.
     # Returns nil if not inside a block where queries are being counted.
     #
@@ -182,6 +206,8 @@ module ActiveRecordQueryCounter
           query_count: counter.query_count,
           row_count: counter.row_count,
           query_time: counter.query_time,
+          cached_query_count: counter.cached_query_count,
+          cache_hit_rate: counter.cache_hit_rate,
           transaction_count: counter.transaction_count,
           transaction_time: counter.transaction_time
         }
@@ -207,11 +233,14 @@ module ActiveRecordQueryCounter
     # @param connection_class [Class] the connection adapter class to extend
     # @return [void]
     def enable!(connection_class)
-      unless connection_class.include?(ConnectionAdapterExtension)
-        connection_class.prepend(ConnectionAdapterExtension)
-      end
-      unless ActiveRecord::ConnectionAdapters::TransactionManager.include?(TransactionManagerExtension)
-        ActiveRecord::ConnectionAdapters::TransactionManager.prepend(TransactionManagerExtension)
+      ConnectionAdapterExtension.inject(connection_class)
+      TransactionManagerExtension.inject(ActiveRecord::ConnectionAdapters::TransactionManager)
+
+      @cache_subscription ||= ActiveSupport::Notifications.subscribe("sql.active_record") do |_name, _start_time, _end_time, _id, payload|
+        if payload[:cached]
+          counter = current_counter
+          counter.cached_query_count += 1 if counter
+        end
       end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_record_query_counter
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Brian Durand
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-09 00:00:00.000000000 Z
+date: 2023-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -78,7 +78,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.4.20
 signing_key:
 specification_version: 4
 summary: Count total number of ActiveRecord queries and row counts inside a block