predictive_load 0.4.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e90bbf6f94ab919853192241e22b311e67202681
-  data.tar.gz: e7606fd33878084afdcd62ca317d428b62cd5b24
+SHA256:
+  metadata.gz: 4b0c3352a1804088cd709d17e619ff406cc243a92ef5b180815416e704b89775
+  data.tar.gz: b12b98881fccee776a2cf2175a8c2d4c06eb6325d1d5a47c08a732f5b6c2eb51
 SHA512:
-  metadata.gz: 9c5344e844ebe9295b7865681dc1d7c91c2331fc180187d1f2a1a4da7da5784010dc2ccb1d565c3f939b6c6683199ee5a1e1591dcd696196ceed2b4829964fcd
-  data.tar.gz: 09d21270213b7c416d7fd8a18ff238ad61d41d1616d2fb1274b22670223d9a7c68da2bb0995375ff45b75e102f9449f50ccc4dd4ae7ebd00e377d177ce966049
+  metadata.gz: a67ac4027e5b1f8c5d70b4799f7cbd230c18c0b18a2100085c1876a97ece7b283b621a22981ac5f1e0d16e6c0f6383746d436080f57a2b1810a216230c20a74e
+  data.tar.gz: baa04313709dd51cbe4269a9cf536559d88ea24d55409a0ba80dd9f1f1db9fa4b1f4ee03df9df57841bb5abe81250255bbb9b257d55fcd6e9f653b5dbc2479d2

data/README.md

@@ -1,4 +1,5 @@
-[![Build Status](https://travis-ci.org/eac/predictive_load.png)](https://travis-ci.org/eac/predictive_load)
+[![Build Status](https://github.com/zendesk/predictive_load/actions/workflows/actions.yml/badge.svg?branch=master)](https://github.com/zendesk/predictive_load/actions/workflows/actions.yml)
+
 
 predictive_load
 ===============
@@ -40,40 +41,6 @@ Some things cannot be preloaded, use `predictive_load: false`
 has_many :foos, predictive_load: false
 ```
 
-### N+1 detection logging
-
-There is also a log-only version:
-```ruby
-require 'predictive_load'
-require 'predictive_load/active_record_collection_observation'
-ActiveRecord::Base.send(:include, PredictiveLoad::ActiveRecordCollectionObservation)
-
-require 'predictive_load/watcher'
-
-ActiveRecord::Relation.collection_observer = PredictiveLoad::Watcher
-
-Comment.all.each do |comment|
-  comment.account
-end
-
-```
-
-Produces:
-
-```
-detected n1 call on Comment#account
-expect to prevent 10 queries
-would preload with: SELECT `accounts`.* FROM `accounts`  WHERE `accounts`.`id` IN (...)
-+----+-------------+----------+-------+---------------+---------+---------+-------+------+-------+
-| id | select_type | table    | type  | possible_keys | key     | key_len | ref   | rows | Extra |
-+----+-------------+----------+-------+---------------+---------+---------+-------+------+-------+
-|  1 | SIMPLE      | accounts | const | PRIMARY       | PRIMARY | 4       | const |    10 |      |
-+----+-------------+----------+-------+---------------+---------+---------+-------+------+-------+
-1 row in set (0.00 sec)
-would have prevented all 10 queries
-
-```
-
 #### 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,31 +1,40 @@
 module PredictiveLoad::ActiveRecordCollectionObservation
 
   def self.included(base)
-    ActiveRecord::Relation.send(:include, RelationObservation)
-    ActiveRecord::Base.send(:include, CollectionMember)
-    ActiveRecord::Base.send(:extend, UnscopedTracker)
-    ActiveRecord::Associations::Association.send(:include, AssociationNotification)
-    ActiveRecord::Associations::CollectionAssociation.send(:include, CollectionAssociationNotification)
+    ActiveRecord::Relation.class_attribute :collection_observer
+    if ActiveRecord::VERSION::MAJOR >= 5
+      ActiveRecord::Relation.prepend Rails5RelationObservation
+    else
+      ActiveRecord::Relation.prepend Rails4RelationObservation
+    end
+    ActiveRecord::Base.include CollectionMember
+    ActiveRecord::Base.extend UnscopedTracker
+    ActiveRecord::Associations::Association.prepend AssociationNotification
+    ActiveRecord::Associations::CollectionAssociation.prepend CollectionAssociationNotification
   end
 
-  module RelationObservation
-
-    def self.included(base)
-      base.class_attribute :collection_observer
-      base.send(:alias_method, :to_a_without_collection_observer, :to_a)
-      base.send(:alias_method, :to_a, :to_a_with_collection_observer)
+  module Rails5RelationObservation
+    # this essentially intercepts the enumerable methods that would result in n+1s since most of
+    # those are delegated to :records in Rails 5+ in the ActiveRecord::Relation::Delegation module
+    def records
+      record_array = super
+      if record_array.size > 1 && collection_observer
+        collection_observer.observe(record_array.dup)
+      end
+      record_array
     end
+  end
 
-    def to_a_with_collection_observer
-      records = to_a_without_collection_observer
-
-      if records.size > 1 && collection_observer
-        collection_observer.observe(records.dup)
+  module Rails4RelationObservation
+    # this essentially intercepts the enumerable methods that would result in n+1s since most of
+    # those are delegated to :to_a in Rails 5+ in the ActiveRecord::Relation::Delegation module
+    def to_a
+      record_array = super
+      if record_array.size > 1 && collection_observer
+        collection_observer.observe(record_array.dup)
       end
-
-      records
+      record_array
     end
-
   end
 
   module CollectionMember
@@ -57,16 +66,10 @@ module PredictiveLoad::ActiveRecordCollectionObservation
   end
 
   module AssociationNotification
-
-    def self.included(base)
-      base.send(:alias_method, :load_target_without_notification, :load_target)
-      base.send(:alias_method, :load_target, :load_target_with_notification)
-    end
-
-    def load_target_with_notification
+    def load_target
       notify_collection_observer if find_target?
 
-      load_target_without_notification
+      super
     end
 
     protected
@@ -76,22 +79,14 @@ module PredictiveLoad::ActiveRecordCollectionObservation
         @owner.collection_observer.loading_association(@owner, self)
       end
     end
-
   end
 
   module CollectionAssociationNotification
-
-    def self.included(base)
-      base.send(:alias_method, :load_target_without_notification, :load_target)
-      base.send(:alias_method, :load_target, :load_target_with_notification)
-    end
-
-    def load_target_with_notification
+    def load_target
       notify_collection_observer if find_target?
 
-      load_target_without_notification
+      super
     end
-
   end
 
 end

data/lib/predictive_load/loader.rb

@@ -57,10 +57,21 @@ module PredictiveLoad
     end
 
     def preload(association_name)
+      # https://github.com/rails/rails/blob/v4.2.10/activerecord/lib/active_record/associations/preloader.rb#L187 (similar to other Rails versions)
+      # If the first record association is loaded, Preloader aborts.
+      #
+      # In a code like `comments.each { |c| c.user }, if the first comment user_id is nil,
+      # when calling the method (`user`) ActiveRecord doesn't load the association, but marks it as loaded.
+      # So when the second comment calls `user` (and user_id is not nil), @records.first will be the first
+      # comment above (with thr association already loaded), which will be checked by Preloader and used to skip
+      # any preloading.
+      #
+      # Fix is pretty simple, ignore any record with association already loaded.
+      rs = records_with_association(association_name).reject { |r| r.association(association_name).loaded? }
       if ActiveRecord::VERSION::STRING <= "4.1.0"
-        ActiveRecord::Associations::Preloader.new(records_with_association(association_name), [ association_name ]).run
+        ActiveRecord::Associations::Preloader.new(rs, [ association_name ]).run
       else
-        ActiveRecord::Associations::Preloader.new.preload(records_with_association(association_name), [ association_name ])
+        ActiveRecord::Associations::Preloader.new.preload(rs, [ association_name ])
       end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: predictive_load
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Eric Chapweske
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-02-12 00:00:00.000000000 Z
+date: 2021-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -16,132 +16,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: 4.2.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '5.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: 4.2.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.1'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: minitest-rg
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: sqlite3
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: bump
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: wwtd
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: query_diet
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.3'
 description: Predictive loader
 email:
 - eac@zendesk.com
@@ -155,12 +43,11 @@ files:
 - lib/predictive_load/active_record_collection_observation.rb
 - lib/predictive_load/loader.rb
 - lib/predictive_load/preload_log.rb
-- lib/predictive_load/watcher.rb
-homepage: ''
+homepage: https://github.com/zendesk/predictive_load
 licenses:
 - Apache License Version 2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -168,16 +55,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5.1
-signing_key: 
+rubyforge_project:
+rubygems_version: 2.7.6.2
+signing_key:
 specification_version: 4
 summary: ''
 test_files: []

data/lib/predictive_load/watcher.rb

@@ -1,84 +0,0 @@
-raise "Not supported on rails 4.1+" if ActiveRecord::VERSION::STRING >= "4.1.0"
-
-require 'predictive_load/loader'
-require 'predictive_load/preload_log'
-
-module PredictiveLoad
-  # Provides N+1 detection / log mode.
-  #
-  # Usage:
-  # ActiveRecord::Relation.collection_observer = PredictiveLoad::Watcher
-  #
-  # Example output:
-  # predictive_load: detected n1 call on Comment#account
-  # predictive_load: expect to prevent 1 queries
-  # predictive_load: would preload with: SELECT `accounts`.* FROM `accounts`  WHERE `accounts`.`id` IN (...)
-  # predictive_load: +----+-------------+----------+-------+---------------+---------+---------+-------+------+-------+
-  # predictive_load: | id | select_type | table    | type  | possible_keys | key     | key_len | ref   | rows | Extra |
-  # predictive_load: +----+-------------+----------+-------+---------------+---------+---------+-------+------+-------+
-  # predictive_load: |  1 | SIMPLE      | accounts | const | PRIMARY       | PRIMARY | 4       | const |    1 |       |
-  # predictive_load: +----+-------------+----------+-------+---------------+---------+---------+-------+------+-------+
-  # predictive_load: 1 row in set (0.00 sec)
-  # predictive_load: would have prevented all 1 queries
-  class Watcher < Loader
-
-    attr_reader :loaded_associations
-
-    def initialize(records)
-      super
-      @loaded_associations = {}
-    end
-
-    def loading_association(record, association)
-      association_name = association.reflection.name
-      return if !all_records_will_likely_load_association?(association_name)
-      return if !supports_preload?(association)
-
-      if loaded_associations.key?(association_name)
-        log_query_plan(association_name)
-      end
-
-      increment_query_count(association_name)
-    end
-
-    protected
-
-    def log_query_plan(association_name)
-      log("detected n+1 call on #{records.first.class.name}##{association_name}")
-
-      # Detailed logging for first query
-      if query_count(association_name) == 1
-        log("expect to prevent #{expected_query_count} queries")
-        log_preload(association_name)
-      end
-
-      # All records loaded association
-      if query_count(association_name) == expected_query_count
-        log("would have prevented all #{expected_query_count} queries")
-      end
-
-    end
-
-    def query_count(association_name)
-      loaded_associations[association_name] || 0
-    end
-
-    def increment_query_count(association_name)
-      loaded_associations[association_name] ||= 0
-      loaded_associations[association_name] += 1
-    end
-
-    def expected_query_count
-      records.size - 1
-    end
-
-    def log_preload(association_name)
-      PreloadLog.new(records_with_association(association_name), [ association_name ]).run
-    end
-
-    def log(message)
-      ActiveRecord::Base.logger.info("predictive_load: #{message}")
-    end
-
-  end
-end