predictive_load 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 93ddc441f98b6e7f9ec3b9a4277b5bf91cad8d360564e2c46dfae3a4963e647b
-  data.tar.gz: 05c1fc9459671d0cad41b68c9f6e5e5003e006ba582a5fedf3b63aca379a85fa
+  metadata.gz: 738aa194d5fa872a614133eafb9bf2eefe2bc4c6958eaf02784cdee1e3b56ade
+  data.tar.gz: ff4d1953f00722fee627b1b73c41d1af2ee3b5168993886dfa9bd65529d616d5
 SHA512:
-  metadata.gz: a6b4e23f4c7cbb1d4751e7aef27fabaa1e5ccb337276788489b08c031b0f3a9b9b3ac318328215579d78b2477ac95148af1dfa350a0635cb98959bb28c76b296
-  data.tar.gz: 8d836cbd60a8798408752818ec84b08165d27f9196645129683a1c15abd43288976575ad0e57c737c93e9169b9995a065c3d1bfea2a962da4b39f62d25f53a07
+  metadata.gz: 7d5c7f2b7bd5ce257238cc0a767f44dbb0889b5fbd5311dd7f56ce0cc237c6d424e9a78f0758fac73ca2e8ec55226f01db3f843455a7d2324b7d02f1aead937f
+  data.tar.gz: 3fd1edf5e995179c55e9bfba6a1801daad33f036f2f95ac2f56b928c143f65957d9be7221434592f5896ce7087f50f0eb1103b3f2022ffe710a16133a49a7ebd

data/README.md

@@ -41,6 +41,28 @@ Some things cannot be preloaded, use `predictive_load: false`
 has_many :foos, predictive_load: false
 ```
 
+### Instrumentation
+
+The library can be instrumented by providing a callback, to be invoked every time automatic preloading happens. The callback must be a callable that receives two arguments:
+* The record (instance) on which the queries that triggered automatic preloading are being performed, in the form of some association call.
+* The association object, which can be inspected to check the type and name of the association.
+
+For example, the callback could be used to emit some metrics:
+
+```ruby
+require "active_support/core_ext/string"
+
+PredictiveLoad.callback = -> (record, association) do
+  METRICS_CLIENT.increment_counter(
+    "active_record.automatic_preloads",
+    tags: [
+      "model:#{record.class.name.underscore}",
+      "association:#{association.reflection.name}"
+    ]
+  )
+end
+```
+
 #### Known limitations:
 
 * Calling association#size will trigger an N+1 on SELECT COUNT(*). Work around by calling #length, loading all records.

data/lib/predictive_load/active_record_collection_observation.rb

@@ -1,5 +1,4 @@
 module PredictiveLoad::ActiveRecordCollectionObservation
-
   def self.included(base)
     ActiveRecord::Relation.class_attribute :collection_observer
     if ActiveRecord::VERSION::MAJOR >= 5
@@ -38,9 +37,7 @@ module PredictiveLoad::ActiveRecordCollectionObservation
   end
 
   module CollectionMember
-
     attr_accessor :collection_observer
-
   end
 
   # disable eager loading since includes + unscoped is broken on rails 4
@@ -73,9 +70,7 @@ module PredictiveLoad::ActiveRecordCollectionObservation
     protected
 
     def notify_collection_observer
-      if @owner.collection_observer
-        @owner.collection_observer.loading_association(@owner, self)
-      end
+      @owner.collection_observer&.loading_association(@owner, self)
     end
   end
 
@@ -86,5 +81,4 @@ module PredictiveLoad::ActiveRecordCollectionObservation
       super
     end
   end
-
 end

data/lib/predictive_load/loader.rb

@@ -23,6 +23,7 @@ module PredictiveLoad
       association_name = association.reflection.name
 
       if all_records_will_likely_load_association?(association_name) && supports_preload?(association)
+        PredictiveLoad.callback&.call(record, association)
         preload(association_name)
       end
     end
@@ -32,7 +33,7 @@ module PredictiveLoad
     attr_reader :records
 
     def all_records_will_likely_load_association?(association_name)
-      if defined?(Mocha) && association_name.to_s.index('_stub_')
+      if defined?(Mocha) && association_name.to_s.index("_stub_")
         false
       else
         true
@@ -43,11 +44,11 @@ module PredictiveLoad
       return false if ActiveRecord::Base.predictive_load_disabled.include?(association.klass)
       return false if association.reflection.options[:predictive_load] == false
       return false if association.reflection.options[:conditions].respond_to?(:to_proc) # rails 3 conditions proc (we do not know if it uses instance methods)
-      if scope = association.reflection.scope
+      if (scope = association.reflection.scope)
         if scope.is_a?(Proc)
           # rails 4+ conditions block, if it uses a passed in object, we assume it is not preloadable
           return false if scope.arity.to_i > 0
-        elsif where = scope.options[:where]
+        elsif (where = scope.options[:where])
           # ActiveRecord::Associations::Builder::DeprecatedOptionsProc from rails 4.0 and deprecated finders
           # when conditions was a proc the where will be a proc too -> check arity
           return false if where.is_a?(Proc) && where.arity > 0
@@ -74,7 +75,7 @@ module PredictiveLoad
     else
       def preload(association_name)
         rs = records_with_association(association_name).reject { |r| r.association(association_name).loaded? }
-        ActiveRecord::Associations::Preloader.new.preload(rs, [ association_name ])
+        ActiveRecord::Associations::Preloader.new.preload(rs, [association_name])
       end
     end
 

data/lib/predictive_load/preload_log.rb

@@ -1,8 +1,7 @@
-require 'active_record/associations/preloader'
+require "active_record/associations/preloader"
 
 module PredictiveLoad
   class PreloadLog < ActiveRecord::Associations::Preloader
-
     attr_accessor :logger
 
     def preload(association)
@@ -17,7 +16,7 @@ module PredictiveLoad
 
           preload_sql = preloader.scope.where(collection_arel(preloader)).to_sql
 
-          log("would preload with: #{preload_sql.to_s}")
+          log("would preload with: #{preload_sql}")
           klass.connection.explain(preload_sql).each_line do |line|
             log(line)
           end
@@ -34,7 +33,5 @@ module PredictiveLoad
     def log(message)
       ActiveRecord::Base.logger.info("predictive_load: #{message}")
     end
-
   end
-
 end

data/lib/predictive_load.rb

@@ -4,6 +4,27 @@ module PredictiveLoad
       super + [:predictive_load]
     end
   end
+
+  class << self
+    attr_reader :callback
+
+    # Configure a callback to be invoked when the library preloads some association.
+    #
+    # It must be a callable with an arity of two.
+    # The callback receives two arguments:
+    # - The record (instance) on which the queries that triggered automatic preloading
+    #   are being performed, in the form of some association call.
+    # - The association object, which can be inspected to check the type and name of
+    #   the association.
+    #
+    def callback=(c)
+      if c.nil? || (c.respond_to?(:call) && c.respond_to?(:arity) && c.arity == 2)
+        @callback = c
+      else
+        raise ArgumentError, "wrong callback type, it must be a callable that supports 2 arguments"
+      end
+    end
+  end
 end
 
 if ActiveRecord::VERSION::MAJOR >= 5

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: predictive_load
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Eric Chapweske
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-05-05 00:00:00.000000000 Z
+date: 2023-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord