jit_preloader 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eca89dc638bbbebd84f69ba52f731374496e4e34
-  data.tar.gz: 2126a1bb08e1a80439eb14f2d298d5f571dfce89
+  metadata.gz: 1d42276971ec067b0aafaf2252e62e7a8f974525
+  data.tar.gz: 5c2cc5de28be5ebedc033d704971937dcd9904d9
 SHA512:
-  metadata.gz: 27df8fe13432a9026259fba55e00c7de531a619431e6cf803273c652dc9bd31d35062202a3081b6653d980b2c3a8fd160d0e6a60ad64b82930f04b027b718906
-  data.tar.gz: 8f1a8c01680f7a8c25532b7ecb4d80965dbea03c35149e9e25d2b7b08ab328fce139124ddbb151eedc677ff0fd57815a175de7841bafdc779fb7ad3d9e6a4e19
+  metadata.gz: 71cfe85e0ca02afa0632b7efcf4991ca3778fa0870bb4773c1f789ff18bb21e9d50d08b5d2bffb9590c660480bc2e57061fce6e97d5553d586b9bdfd2108a5e6
+  data.tar.gz: 23828f4c2da51cbfb4e8e5f4026472875d29119005045d4d720908380811b0662aa0ca013e38af3a52accc8d08233ac358a2d92437184426645209a558479125

data/Gemfile.lock

@@ -1,31 +1,32 @@
 PATH
   remote: .
   specs:
-    jit_preloader (0.0.8)
+    jit_preloader (0.2.0)
       activerecord (> 4.2, < 6)
       activesupport
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (5.1.1)
-      activesupport (= 5.1.1)
-    activerecord (5.1.1)
-      activemodel (= 5.1.1)
-      activesupport (= 5.1.1)
-      arel (~> 8.0)
-    activesupport (5.1.1)
+    activemodel (5.2.2)
+      activesupport (= 5.2.2)
+    activerecord (5.2.2)
+      activemodel (= 5.2.2)
+      activesupport (= 5.2.2)
+      arel (>= 9.0)
+    activesupport (5.2.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (~> 0.7)
+      i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-    arel (8.0.0)
+    arel (9.0.0)
     byebug (9.0.6)
-    concurrent-ruby (1.0.5)
+    concurrent-ruby (1.1.4)
     database_cleaner (1.5.3)
     diff-lcs (1.2.5)
-    i18n (0.8.1)
-    minitest (5.10.2)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    minitest (5.11.3)
     rake (10.5.0)
     rspec (3.5.0)
       rspec-core (~> 3.5.0)
@@ -42,14 +43,14 @@ GEM
     rspec-support (3.5.0)
     sqlite3 (1.3.12)
     thread_safe (0.3.6)
-    tzinfo (1.2.3)
+    tzinfo (1.2.5)
       thread_safe (~> 0.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.7)
+  bundler
   byebug
   database_cleaner
   jit_preloader!
@@ -58,4 +59,4 @@ DEPENDENCIES
   sqlite3
 
 BUNDLED WITH
-   1.13.6
+   2.0.1

data/README.md

@@ -157,7 +157,7 @@ end
 # ...
 
 #new
-class Contact < ActiveRecord::Bas
+class Contact < ActiveRecord::Base
   has_many :addresses
   has_many_aggregate :addresses, :max_street_length, :maximum, "LENGTH(street)", default: nil
   has_many_aggregate :addresses, :count_all, :count, "*"
@@ -165,7 +165,7 @@ end
 
 Contact.jit_preload.each do |contact|
   contact.addresses_max_street_length
-  contact.adddresses_count_all
+  contact.addresses_count_all
 end
 # SELECT * FROM contacts
 # SELECT contact_id, MAX(LENGTH(street)) FROM addresses WHERE contact_id IN (1, 2, 3, ...) GROUP BY contact_id

data/jit_preloader.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "activerecord", "> 4.2", "< 6"
   spec.add_dependency "activesupport"
 
-  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "database_cleaner"

data/lib/jit_preloader.rb

@@ -8,8 +8,12 @@ require 'jit_preloader/active_record/base'
 require 'jit_preloader/active_record/relation'
 require 'jit_preloader/active_record/associations/collection_association'
 require 'jit_preloader/active_record/associations/singular_association'
-require 'jit_preloader/active_record/associations/preloader/collection_association'
-require 'jit_preloader/active_record/associations/preloader/singular_association'
+if Gem::Version.new(ActiveRecord::VERSION::STRING) < Gem::Version.new("5.2.2")
+  require 'jit_preloader/active_record/associations/preloader/collection_association'
+  require 'jit_preloader/active_record/associations/preloader/singular_association'
+else
+  require 'jit_preloader/active_record/associations/preloader/association'
+end
 require 'jit_preloader/preloader'
 
 module JitPreloader

data/lib/jit_preloader/active_record/associations/preloader/association.rb

@@ -0,0 +1,71 @@
+module JitPreloader
+  module PreloaderAssociation
+
+    # A monkey patch to ActiveRecord. The old method looked like the snippet
+    # below. Our changes here are that we remove records that are already
+    # part of the target, then attach all of the records to a new jit preloader.
+    #
+    # def run(preloader)
+    #   records = load_records do |record|
+    #     owner = owners_by_key[convert_key(record[association_key_name])]
+    #     association = owner.association(reflection.name)
+    #     association.set_inverse_instance(record)
+    #   end
+
+    #   owners.each do |owner|
+    #     associate_records_to_owner(owner, records[convert_key(owner[owner_key_name])] || [])
+    #   end
+    # end
+
+    def run(preloader)
+      all_records = []
+      records = load_records do |record|
+        owner = owners_by_key[convert_key(record[association_key_name])]
+        association = owner.association(reflection.name)
+        association.set_inverse_instance(record)
+      end
+
+      owners.each do |owner|
+        owned_records = records[convert_key(owner[owner_key_name])] || []
+        all_records.concat(Array(owned_records)) if owner.jit_preloader || JitPreloader.globally_enabled?
+        associate_records_to_owner(owner, owned_records)
+      end
+
+      JitPreloader::Preloader.attach(all_records) if all_records.any?
+    end
+
+    # Original method:
+    # def associate_records_to_owner(owner, records)
+    #   association = owner.association(reflection.name)
+    #   association.loaded!
+    #   if reflection.collection?
+    #     association.target.concat(records)
+    #   else
+    #     association.target = records.first unless records.empty?
+    #   end
+    # end
+    def associate_records_to_owner(owner, records)
+      association = owner.association(reflection.name)
+      association.loaded!
+
+      if reflection.collection?
+        # It is possible that some of the records are loaded already.
+        # We don't want to duplicate them, but we also want to preserve
+        # the original copy so that we don't blow away in-memory changes.
+        new_records = association.target.any? ? records - association.target : records
+        association.target.concat(new_records)
+      else
+        association.target ||= records.first unless records.empty?
+      end
+    end
+
+
+    def build_scope
+      super.tap do |scope|
+        scope.jit_preload! if owners.any?(&:jit_preloader) || JitPreloader.globally_enabled?
+      end
+    end
+  end
+end
+
+ActiveRecord::Associations::Preloader::Association.prepend(JitPreloader::PreloaderAssociation)

data/lib/jit_preloader/active_record/associations/preloader/association.rb~

@@ -0,0 +1,34 @@
+class ActiveRecord::Associations::Preloader::Association
+  private
+  # A monkey patch to ActiveRecord. The old method looked like the snippet
+  # below. Our changes here are that we remove records that are already
+  # part of the target, then attach all of the records to a new jit preloader.
+  #
+  # def preload(preloader)
+  #   associated_records_by_owner(preloader).each do |owner, records|
+  #     association = owner.association(reflection.name)
+  #     association.loaded!
+  #     association.target.concat(records)
+  #     records.each { |record| association.set_inverse_instance(record) }
+  #   end
+  # end
+
+  def preload(preloader)
+    return unless (reflection.scope.nil? || reflection.scope.arity == 0) && klass.ancestors.include?(ActiveRecord::Base)
+    all_records = []
+    associated_records_by_owner(preloader).each do |owner, records|
+      association = owner.association(reflection.name)
+      association.loaded!
+      # It is possible that some of the records are loaded already.
+      # We don't want to duplicate them, but we also want to preserve
+      # the original copy so that we don't blow away in-memory changes.
+      new_records = association.target.any? ? records - association.target : records
+
+      association.target.concat(new_records)
+      new_records.each { |record| association.set_inverse_instance(record) }
+
+      all_records.concat(records) if owner.jit_preloader || JitPreloader.globally_enabled?
+    end
+    JitPreloader::Preloader.attach(all_records) if all_records.any?
+  end
+end

data/lib/jit_preloader/active_record/base.rb

@@ -43,6 +43,10 @@ module JitPreloadExtension
 
           conditions[reflection.foreign_key] = primary_ids
 
+          if reflection.type.present?
+            conditions[reflection.type] = self.class.name
+          end
+
           preloaded_data = Hash[association_scope
                                  .where(conditions)
                                  .group(reflection.foreign_key)

data/lib/jit_preloader/version.rb

@@ -1,3 +1,3 @@
 module JitPreloader
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/spec/lib/jit_preloader/preloader_spec.rb

@@ -32,6 +32,15 @@ RSpec.describe JitPreloader::Preloader do
     )
   end
 
+  let!(:contact_owner) do
+    contact3.contact_owner_id = contact1.id
+    contact3.contact_owner_type = "Address"
+    contact3.save!
+    ContactOwner.create(
+      contacts: [contact1, contact2],
+    )
+  end
+
   let(:canada) { Country.create(name: "Canada") }
   let(:usa) { Country.create(name: "U.S.A") }
 
@@ -40,6 +49,42 @@ RSpec.describe JitPreloader::Preloader do
     ->(event, data){ source_map[data[:source]] << data[:association] }
   end
 
+  context "when preloading an aggregate as polymorphic" do
+    let(:contact_owner_counts) { [2] }
+
+    context "without jit preload" do
+      it "generates N+1 query notifications for each one" do
+        ActiveSupport::Notifications.subscribed(callback, "n_plus_one_query") do
+          ContactOwner.all.each_with_index do |c, i|
+            expect(c.contacts_count).to eql contact_owner_counts[i]
+          end
+        end
+
+        contact_owner_queries = [contact_owner].product([["contacts.count"]])
+        expect(source_map).to eql(Hash[contact_owner_queries])
+      end
+    end
+
+    context "with jit_preload" do
+
+      it "does NOT generate N+1 query notifications" do
+        ActiveSupport::Notifications.subscribed(callback, "n_plus_one_query") do
+          ContactOwner.jit_preload.each_with_index do |c, i|
+            expect(c.contacts_count).to eql contact_owner_counts[i]
+          end
+        end
+
+        expect(source_map).to eql({})
+      end
+
+      it "can handle queries" do
+        ContactOwner.jit_preload.each_with_index do |c, i|
+          expect(c.contacts_count).to eql contact_owner_counts[i]
+        end
+      end
+    end
+  end
+
   context "when preloading an aggregate" do
     let(:addresses_counts) { [3, 0, 2] }
     let(:phone_number_counts) { [2, 0, 1] }

data/spec/support/database.rb

@@ -1,7 +1,8 @@
 class Database
   def self.tables
     [
-      "CREATE TABLE contacts (id INTEGER NOT NULL PRIMARY KEY, name VARCHAR(255))",
+      "CREATE TABLE contacts (id INTEGER NOT NULL PRIMARY KEY, name VARCHAR(255), contact_owner_id INTEGER, contact_owner_type VARCHAR(255))",
+      "CREATE TABLE contact_owners (id INTEGER NOT NULL PRIMARY KEY, name VARCHAR(255))",
       "CREATE TABLE addresses (id INTEGER NOT NULL PRIMARY KEY, contact_id INTEGER NOT NULL, country_id INTEGER NOT NULL, street VARCHAR(255))",
       "CREATE TABLE email_addresses (id INTEGER NOT NULL PRIMARY KEY, contact_id INTEGER NOT NULL, address VARCHAR(255))",
       "CREATE TABLE phone_numbers (id INTEGER NOT NULL PRIMARY KEY, contact_id INTEGER NOT NULL, phone VARCHAR(10))",

data/spec/support/models.rb

@@ -1,8 +1,11 @@
 class Contact < ActiveRecord::Base
+  belongs_to :contact_owner, polymorphic: true
+
   has_many :addresses
   has_many :phone_numbers
   has_one :email_address
 
+
   has_many_aggregate :addresses, :max_street_length, :maximum, "LENGTH(street)"
   has_many_aggregate :phone_numbers, :count, :count, "id"
   has_many_aggregate :addresses, :count, :count, "*"
@@ -24,3 +27,8 @@ end
 class Country < ActiveRecord::Base
   has_many :addresses
 end
+
+class ContactOwner < ActiveRecord::Base
+  has_many :contacts, as: :contact_owner
+  has_many_aggregate :contacts, :count, :count, "*"
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jit_preloader
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Kyle d'Oliveira
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-19 00:00:00.000000000 Z
+date: 2019-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -48,16 +48,16 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -147,6 +147,8 @@ files:
 - jit_preloader.gemspec
 - lib/jit_preloader.rb
 - lib/jit_preloader/active_record/associations/collection_association.rb
+- lib/jit_preloader/active_record/associations/preloader/association.rb
+- lib/jit_preloader/active_record/associations/preloader/association.rb~
 - lib/jit_preloader/active_record/associations/preloader/collection_association.rb
 - lib/jit_preloader/active_record/associations/preloader/singular_association.rb
 - lib/jit_preloader/active_record/associations/singular_association.rb
@@ -178,7 +180,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Tool to understand N+1 queries and to remove them