mirror of
https://github.com/rails/rails.git
synced 2022-11-09 12:12:34 -05:00
64c53d7ce4
At present, ActiveRecord::Delegation compiles delegation methods on a global basis. The compiled methods apply to all subsequent Relation instances. This creates several problems: 1) After Post.all.recent has been called, User.all.respond_to?(:recent) will be true, even if User.all.recent will actually raise an error due to no User.recent method existing. (See #8080.) 2) Depending on the AR class, the delegation should do different things. For example, if a Post.zip method exists, then Post.all.zip should call it. But this will then result in User.zip being called by a subsequent User.all.zip, even if User.zip does not exist, when in fact User.all.zip should call User.all.to_a.zip. (There are various variants of this problem.) We are creating these compiled delegations in order to avoid method missing and to avoid repeating logic on each invocation. One way of handling these issues is to add additional checks in various places to ensure we're doing the "right thing". However, this makes the compiled methods signficantly slower. In which case, there's almost no point in avoiding method_missing at all. (See #8127 for a proposed solution which takes this approach.) This is an alternative approach which involves creating a subclass of ActiveRecord::Relation for each AR class represented. So, with this patch, Post.all.class != User.all.class. This means that the delegations are compiled for and only apply to a single AR class. A compiled method for Post.all will not be invoked from User.all. This solves the above issues without incurring significant performance penalties. It's designed to be relatively seamless, however the downside is a bit of complexity and potentially confusion for a user who thinks that Post.all and User.all should be instances of the same class. Benchmark --------- require 'active_record' require 'benchmark/ips' class Post < ActiveRecord::Base establish_connection adapter: 'sqlite3', database: ':memory:' connection.create_table :posts def self.omg :omg end end relation = Post.all Benchmark.ips do |r| r.report('delegation') { relation.omg } r.report('constructing') { Post.all } end Before ------ Calculating ------------------------------------- delegation 4392 i/100ms constructing 4780 i/100ms ------------------------------------------------- delegation 144235.9 (±27.7%) i/s - 663192 in 5.038075s constructing 182015.5 (±21.2%) i/s - 850840 in 5.005364s After ----- Calculating ------------------------------------- delegation 6677 i/100ms constructing 6260 i/100ms ------------------------------------------------- delegation 166828.2 (±34.2%) i/s - 754501 in 5.001430s constructing 116575.5 (±18.6%) i/s - 563400 in 5.036690s Comments -------- Bear in mind that the standard deviations in the above are huge, so we can't compare the numbers too directly. However, we can conclude that Relation construction has become a little slower (as we'd expect), but not by a huge huge amount, and we can still construct a large number of Relations quite quickly.
269 lines
8 KiB
Ruby
269 lines
8 KiB
Ruby
require "cases/helper"
|
|
require 'models/post'
|
|
require 'models/comment'
|
|
|
|
module ActiveRecord
|
|
class RelationTest < ActiveRecord::TestCase
|
|
fixtures :posts, :comments
|
|
|
|
class FakeKlass < Struct.new(:table_name, :name)
|
|
end
|
|
|
|
def test_construction
|
|
relation = nil
|
|
assert_nothing_raised do
|
|
relation = Relation.new FakeKlass, :b
|
|
end
|
|
assert_equal FakeKlass, relation.klass
|
|
assert_equal :b, relation.table
|
|
assert !relation.loaded, 'relation is not loaded'
|
|
end
|
|
|
|
def test_responds_to_model_and_returns_klass
|
|
relation = Relation.new FakeKlass, :b
|
|
assert_equal FakeKlass, relation.model
|
|
end
|
|
|
|
def test_initialize_single_values
|
|
relation = Relation.new FakeKlass, :b
|
|
(Relation::SINGLE_VALUE_METHODS - [:create_with]).each do |method|
|
|
assert_nil relation.send("#{method}_value"), method.to_s
|
|
end
|
|
assert_equal({}, relation.create_with_value)
|
|
end
|
|
|
|
def test_multi_value_initialize
|
|
relation = Relation.new FakeKlass, :b
|
|
Relation::MULTI_VALUE_METHODS.each do |method|
|
|
assert_equal [], relation.send("#{method}_values"), method.to_s
|
|
end
|
|
end
|
|
|
|
def test_extensions
|
|
relation = Relation.new FakeKlass, :b
|
|
assert_equal [], relation.extensions
|
|
end
|
|
|
|
def test_empty_where_values_hash
|
|
relation = Relation.new FakeKlass, :b
|
|
assert_equal({}, relation.where_values_hash)
|
|
|
|
relation.where! :hello
|
|
assert_equal({}, relation.where_values_hash)
|
|
end
|
|
|
|
def test_has_values
|
|
relation = Relation.new Post, Post.arel_table
|
|
relation.where! relation.table[:id].eq(10)
|
|
assert_equal({:id => 10}, relation.where_values_hash)
|
|
end
|
|
|
|
def test_values_wrong_table
|
|
relation = Relation.new Post, Post.arel_table
|
|
relation.where! Comment.arel_table[:id].eq(10)
|
|
assert_equal({}, relation.where_values_hash)
|
|
end
|
|
|
|
def test_tree_is_not_traversed
|
|
relation = Relation.new Post, Post.arel_table
|
|
left = relation.table[:id].eq(10)
|
|
right = relation.table[:id].eq(10)
|
|
combine = left.and right
|
|
relation.where! combine
|
|
assert_equal({}, relation.where_values_hash)
|
|
end
|
|
|
|
def test_table_name_delegates_to_klass
|
|
relation = Relation.new FakeKlass.new('foo'), :b
|
|
assert_equal 'foo', relation.table_name
|
|
end
|
|
|
|
def test_scope_for_create
|
|
relation = Relation.new FakeKlass, :b
|
|
assert_equal({}, relation.scope_for_create)
|
|
end
|
|
|
|
def test_create_with_value
|
|
relation = Relation.new Post, Post.arel_table
|
|
hash = { :hello => 'world' }
|
|
relation.create_with_value = hash
|
|
assert_equal hash, relation.scope_for_create
|
|
end
|
|
|
|
def test_create_with_value_with_wheres
|
|
relation = Relation.new Post, Post.arel_table
|
|
relation.where! relation.table[:id].eq(10)
|
|
relation.create_with_value = {:hello => 'world'}
|
|
assert_equal({:hello => 'world', :id => 10}, relation.scope_for_create)
|
|
end
|
|
|
|
# FIXME: is this really wanted or expected behavior?
|
|
def test_scope_for_create_is_cached
|
|
relation = Relation.new Post, Post.arel_table
|
|
assert_equal({}, relation.scope_for_create)
|
|
|
|
relation.where! relation.table[:id].eq(10)
|
|
assert_equal({}, relation.scope_for_create)
|
|
|
|
relation.create_with_value = {:hello => 'world'}
|
|
assert_equal({}, relation.scope_for_create)
|
|
end
|
|
|
|
def test_empty_eager_loading?
|
|
relation = Relation.new FakeKlass, :b
|
|
assert !relation.eager_loading?
|
|
end
|
|
|
|
def test_eager_load_values
|
|
relation = Relation.new FakeKlass, :b
|
|
relation.eager_load! :b
|
|
assert relation.eager_loading?
|
|
end
|
|
|
|
def test_references_values
|
|
relation = Relation.new FakeKlass, :b
|
|
assert_equal [], relation.references_values
|
|
relation = relation.references(:foo).references(:omg, :lol)
|
|
assert_equal ['foo', 'omg', 'lol'], relation.references_values
|
|
end
|
|
|
|
def test_references_values_dont_duplicate
|
|
relation = Relation.new FakeKlass, :b
|
|
relation = relation.references(:foo).references(:foo)
|
|
assert_equal ['foo'], relation.references_values
|
|
end
|
|
|
|
test 'merging a hash into a relation' do
|
|
relation = Relation.new FakeKlass, :b
|
|
relation = relation.merge where: :lol, readonly: true
|
|
|
|
assert_equal [:lol], relation.where_values
|
|
assert_equal true, relation.readonly_value
|
|
end
|
|
|
|
test 'merging an empty hash into a relation' do
|
|
assert_equal [], Relation.new(FakeKlass, :b).merge({}).where_values
|
|
end
|
|
|
|
test 'merging a hash with unknown keys raises' do
|
|
assert_raises(ArgumentError) { Relation::HashMerger.new(nil, omg: 'lol') }
|
|
end
|
|
|
|
test '#values returns a dup of the values' do
|
|
relation = Relation.new(FakeKlass, :b).where! :foo
|
|
values = relation.values
|
|
|
|
values[:where] = nil
|
|
assert_not_nil relation.where_values
|
|
end
|
|
|
|
test 'relations can be created with a values hash' do
|
|
relation = Relation.new(FakeKlass, :b, where: [:foo])
|
|
assert_equal [:foo], relation.where_values
|
|
end
|
|
|
|
test 'merging a single where value' do
|
|
relation = Relation.new(FakeKlass, :b)
|
|
relation.merge!(where: :foo)
|
|
assert_equal [:foo], relation.where_values
|
|
end
|
|
|
|
test 'merging a hash interpolates conditions' do
|
|
klass = stub_everything
|
|
klass.stubs(:sanitize_sql).with(['foo = ?', 'bar']).returns('foo = bar')
|
|
|
|
relation = Relation.new(klass, :b)
|
|
relation.merge!(where: ['foo = ?', 'bar'])
|
|
assert_equal ['foo = bar'], relation.where_values
|
|
end
|
|
end
|
|
|
|
class RelationMutationTest < ActiveSupport::TestCase
|
|
class FakeKlass < Struct.new(:table_name, :name)
|
|
end
|
|
|
|
def relation
|
|
@relation ||= Relation.new FakeKlass, :b
|
|
end
|
|
|
|
(Relation::MULTI_VALUE_METHODS - [:references, :extending]).each do |method|
|
|
test "##{method}!" do
|
|
assert relation.public_send("#{method}!", :foo).equal?(relation)
|
|
assert_equal [:foo], relation.public_send("#{method}_values")
|
|
end
|
|
end
|
|
|
|
test '#references!' do
|
|
assert relation.references!(:foo).equal?(relation)
|
|
assert relation.references_values.include?('foo')
|
|
end
|
|
|
|
test 'extending!' do
|
|
mod, mod2 = Module.new, Module.new
|
|
|
|
assert relation.extending!(mod).equal?(relation)
|
|
assert_equal [mod], relation.extending_values
|
|
assert relation.is_a?(mod)
|
|
|
|
relation.extending!(mod2)
|
|
assert_equal [mod, mod2], relation.extending_values
|
|
end
|
|
|
|
test 'extending! with empty args' do
|
|
relation.extending!
|
|
assert_equal [], relation.extending_values
|
|
end
|
|
|
|
(Relation::SINGLE_VALUE_METHODS - [:from, :lock, :reordering, :reverse_order, :create_with]).each do |method|
|
|
test "##{method}!" do
|
|
assert relation.public_send("#{method}!", :foo).equal?(relation)
|
|
assert_equal :foo, relation.public_send("#{method}_value")
|
|
end
|
|
end
|
|
|
|
test '#from!' do
|
|
assert relation.from!('foo').equal?(relation)
|
|
assert_equal ['foo', nil], relation.from_value
|
|
end
|
|
|
|
test '#lock!' do
|
|
assert relation.lock!('foo').equal?(relation)
|
|
assert_equal 'foo', relation.lock_value
|
|
end
|
|
|
|
test '#reorder!' do
|
|
relation = self.relation.order('foo')
|
|
|
|
assert relation.reorder!('bar').equal?(relation)
|
|
assert_equal ['bar'], relation.order_values
|
|
assert relation.reordering_value
|
|
end
|
|
|
|
test 'reverse_order!' do
|
|
assert relation.reverse_order!.equal?(relation)
|
|
assert relation.reverse_order_value
|
|
relation.reverse_order!
|
|
assert !relation.reverse_order_value
|
|
end
|
|
|
|
test 'create_with!' do
|
|
assert relation.create_with!(foo: 'bar').equal?(relation)
|
|
assert_equal({foo: 'bar'}, relation.create_with_value)
|
|
end
|
|
|
|
test 'merge!' do
|
|
assert relation.merge!(where: :foo).equal?(relation)
|
|
assert_equal [:foo], relation.where_values
|
|
end
|
|
|
|
test 'merge with a proc' do
|
|
assert_equal [:foo], relation.merge(-> { where(:foo) }).where_values
|
|
end
|
|
|
|
test 'none!' do
|
|
assert relation.none!.equal?(relation)
|
|
assert_equal [NullRelation], relation.extending_values
|
|
assert relation.is_a?(NullRelation)
|
|
end
|
|
end
|
|
end
|