predictive_load 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 580ba2c90f13384b9fba7ea3c386fbc8c25f79a35dbed9fa1ea3a59aadc2e854
-  data.tar.gz: 79a274f1f22adb3bec3a795c55dde8a01ed29056433e5316ad8d72dd605232f9
+  metadata.gz: 54bffe32fe50393ce8bb75bd01ae397084d3c2924ea4dafa9bccddb860baedf3
+  data.tar.gz: 1b37f4afd9874034fe0b7adc81317687d734cc51539665a5df005deefc0553c0
 SHA512:
-  metadata.gz: ec156ee9fea24e8b223f63d31b9f2d000ebb65fcf63005998682097e4ebba3c1c8c19e2df9aadc19819c77c9a90d5a8d01993353215ed61f14aeddcc54a2a20e
-  data.tar.gz: 4019f082b0a466304725cb37ad3e0753a19f2fd665bfe699a7221674c2f59be09cdb43db1b84331fe5386388081a529daba414d5d0e8d9b5918c702cba097d2b
+  metadata.gz: 8af3089f4ab81c3470d2811a335d40e36bede5ca38c59cf739135ebf4fdb18d7181338d9065a7fff06ff436a54c73e4ad618c61a890d8ee610c935855542e1da
+  data.tar.gz: de072a8eeaf0080dcf1bd2c1183b9b04f305c1206ed170737a6cbf97b62dee6945e876fb739b2495d715f9e1e373605383db35b13ed8ccb6b5a0f1bc71528e4c

data/README.md

@@ -40,40 +40,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.include AssociationNotification
+    ActiveRecord::Associations::CollectionAssociation.include 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: predictive_load
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors:
 - Eric Chapweske
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-16 00:00:00.000000000 Z
+date: 2020-02-05 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,7 +43,6 @@ 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: https://github.com/zendesk/predictive_load
 licenses:
 - Apache License Version 2.0
@@ -168,7 +55,7 @@ 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:
   - - ">="

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