2017-07-09 13:41:28 -04:00
|
|
|
# frozen_string_literal: true
|
|
|
|
|
2016-08-06 12:26:20 -04:00
|
|
|
require "cases/helper"
|
|
|
|
require "models/topic"
|
|
|
|
require "models/author"
|
|
|
|
require "models/post"
|
2011-02-10 12:56:50 -05:00
|
|
|
|
2017-04-04 22:35:47 -04:00
|
|
|
if ActiveRecord::Base.connection.prepared_statements
|
2017-03-22 11:21:05 -04:00
|
|
|
module ActiveRecord
|
|
|
|
class BindParameterTest < ActiveRecord::TestCase
|
2017-04-27 02:44:25 -04:00
|
|
|
fixtures :topics, :authors, :author_addresses, :posts
|
2017-03-22 11:21:05 -04:00
|
|
|
|
|
|
|
class LogListener
|
|
|
|
attr_accessor :calls
|
|
|
|
|
|
|
|
def initialize
|
|
|
|
@calls = []
|
|
|
|
end
|
|
|
|
|
|
|
|
def call(*args)
|
|
|
|
calls << args
|
|
|
|
end
|
2011-02-10 12:56:50 -05:00
|
|
|
end
|
|
|
|
|
2017-03-22 11:21:05 -04:00
|
|
|
def setup
|
|
|
|
super
|
|
|
|
@connection = ActiveRecord::Base.connection
|
|
|
|
@subscriber = LogListener.new
|
|
|
|
@pk = Topic.columns_hash[Topic.primary_key]
|
|
|
|
@subscription = ActiveSupport::Notifications.subscribe("sql.active_record", @subscriber)
|
2011-02-10 12:56:50 -05:00
|
|
|
end
|
|
|
|
|
2017-03-22 11:21:05 -04:00
|
|
|
def teardown
|
|
|
|
ActiveSupport::Notifications.unsubscribe(@subscription)
|
|
|
|
end
|
2011-02-10 12:56:50 -05:00
|
|
|
|
2019-02-25 09:40:20 -05:00
|
|
|
def test_statement_cache
|
|
|
|
@connection.clear_cache!
|
|
|
|
|
|
|
|
topics = Topic.where(id: 1)
|
|
|
|
assert_equal [1], topics.map(&:id)
|
|
|
|
assert_includes statement_cache, to_sql_key(topics.arel)
|
|
|
|
end
|
|
|
|
|
|
|
|
def test_statement_cache_with_query_cache
|
|
|
|
@connection.enable_query_cache!
|
|
|
|
@connection.clear_cache!
|
|
|
|
|
|
|
|
topics = Topic.where(id: 1)
|
|
|
|
assert_equal [1], topics.map(&:id)
|
|
|
|
assert_includes statement_cache, to_sql_key(topics.arel)
|
|
|
|
ensure
|
|
|
|
@connection.disable_query_cache!
|
|
|
|
end
|
|
|
|
|
|
|
|
def test_statement_cache_with_find
|
|
|
|
@connection.clear_cache!
|
|
|
|
|
|
|
|
topics = Topic.where(id: 1).limit(1)
|
|
|
|
assert_equal 1, Topic.find(1).id
|
|
|
|
assert_includes statement_cache, to_sql_key(topics.arel)
|
|
|
|
end
|
|
|
|
|
|
|
|
def test_statement_cache_with_in_clause
|
|
|
|
@connection.clear_cache!
|
|
|
|
|
|
|
|
topics = Topic.where(id: [1, 3])
|
|
|
|
assert_equal [1, 3], topics.map(&:id)
|
|
|
|
assert_not_includes statement_cache, to_sql_key(topics.arel)
|
|
|
|
end
|
|
|
|
|
|
|
|
def test_statement_cache_with_sql_string_literal
|
|
|
|
@connection.clear_cache!
|
|
|
|
|
|
|
|
topics = Topic.where("topics.id = ?", 1)
|
|
|
|
assert_equal [1], topics.map(&:id)
|
|
|
|
assert_not_includes statement_cache, to_sql_key(topics.arel)
|
|
|
|
end
|
|
|
|
|
2018-09-13 17:57:20 -04:00
|
|
|
def test_too_many_binds
|
|
|
|
bind_params_length = @connection.send(:bind_params_length)
|
2018-11-03 01:45:25 -04:00
|
|
|
|
2018-10-23 21:31:41 -04:00
|
|
|
topics = Topic.where(id: (1 .. bind_params_length).to_a << 2**63)
|
2018-09-13 17:57:20 -04:00
|
|
|
assert_equal Topic.count, topics.count
|
2018-11-03 01:45:25 -04:00
|
|
|
|
|
|
|
topics = Topic.where.not(id: (1 .. bind_params_length).to_a << 2**63)
|
|
|
|
assert_equal 0, topics.count
|
2018-09-13 17:57:20 -04:00
|
|
|
end
|
|
|
|
|
2019-02-14 23:07:01 -05:00
|
|
|
def test_too_many_binds_with_query_cache
|
2019-02-25 09:40:20 -05:00
|
|
|
@connection.enable_query_cache!
|
|
|
|
|
2019-02-14 23:07:01 -05:00
|
|
|
bind_params_length = @connection.send(:bind_params_length)
|
|
|
|
topics = Topic.where(id: (1 .. bind_params_length + 1).to_a)
|
|
|
|
assert_equal Topic.count, topics.count
|
|
|
|
|
|
|
|
topics = Topic.where.not(id: (1 .. bind_params_length + 1).to_a)
|
|
|
|
assert_equal 0, topics.count
|
2019-02-16 00:07:50 -05:00
|
|
|
ensure
|
2019-02-25 09:40:20 -05:00
|
|
|
@connection.disable_query_cache!
|
2019-02-14 23:07:01 -05:00
|
|
|
end
|
|
|
|
|
2015-01-05 18:25:19 -05:00
|
|
|
def test_bind_from_join_in_subquery
|
2016-08-06 12:26:20 -04:00
|
|
|
subquery = Author.joins(:thinking_posts).where(name: "David")
|
|
|
|
scope = Author.from(subquery, "authors").where(id: 1)
|
2015-01-05 18:25:19 -05:00
|
|
|
assert_equal 1, scope.count
|
|
|
|
end
|
|
|
|
|
2013-11-08 10:57:51 -05:00
|
|
|
def test_binds_are_logged
|
Refactor Active Record to let Arel manage bind params
A common source of bugs and code bloat within Active Record has been the
need for us to maintain the list of bind values separately from the AST
they're associated with. This makes any sort of AST manipulation
incredibly difficult, as any time we want to potentially insert or
remove an AST node, we need to traverse the entire tree to find where
the associated bind parameters are.
With this change, the bind parameters now live on the AST directly.
Active Record does not need to know or care about them until the final
AST traversal for SQL construction. Rather than returning just the SQL,
the Arel collector will now return both the SQL and the bind parameters.
At this point the connection adapter will have all the values that it
had before.
A bit of this code is janky and something I'd like to refactor later. In
particular, I don't like how we're handling associations in the
predicate builder, the special casing of `StatementCache::Substitute` in
`QueryAttribute`, or generally how we're handling bind value replacement
in the statement cache when prepared statements are disabled.
This also mostly reverts #26378, as it moved all the code into a
location that I wanted to delete.
/cc @metaskills @yahonda, this change will affect the adapters
Fixes #29766.
Fixes #29804.
Fixes #26541.
Close #28539.
Close #24769.
Close #26468.
Close #26202.
There are probably other issues/PRs that can be closed because of this
commit, but that's all I could find on the first few pages.
2017-07-24 08:19:35 -04:00
|
|
|
sub = Arel::Nodes::BindParam.new(1)
|
2017-07-21 13:55:24 -04:00
|
|
|
binds = [Relation::QueryAttribute.new("id", 1, Type::Value.new)]
|
|
|
|
sql = "select * from topics where id = #{sub.to_sql}"
|
2011-02-10 12:56:50 -05:00
|
|
|
|
2016-08-06 12:26:20 -04:00
|
|
|
@connection.exec_query(sql, "SQL", binds)
|
2011-02-10 12:56:50 -05:00
|
|
|
|
2014-03-29 09:52:56 -04:00
|
|
|
message = @subscriber.calls.find { |args| args[4][:sql] == sql }
|
2013-11-08 10:57:51 -05:00
|
|
|
assert_equal binds, message[4][:binds]
|
|
|
|
end
|
2011-02-10 16:34:33 -05:00
|
|
|
|
2013-11-08 10:57:51 -05:00
|
|
|
def test_find_one_uses_binds
|
|
|
|
Topic.find(1)
|
2015-01-27 15:42:02 -05:00
|
|
|
message = @subscriber.calls.find { |args| args[4][:binds].any? { |attr| attr.value == 1 } }
|
2016-08-06 12:26:20 -04:00
|
|
|
assert message, "expected a message with binds"
|
2013-11-08 10:57:51 -05:00
|
|
|
end
|
2011-02-10 16:34:33 -05:00
|
|
|
|
2017-03-22 11:21:05 -04:00
|
|
|
def test_logs_binds_after_type_cast
|
2017-07-21 13:55:24 -04:00
|
|
|
binds = [Relation::QueryAttribute.new("id", "10", Type::Integer.new)]
|
2017-03-22 11:21:05 -04:00
|
|
|
assert_logs_binds(binds)
|
2013-11-08 10:57:51 -05:00
|
|
|
end
|
2016-07-18 21:20:58 -04:00
|
|
|
|
2017-03-22 11:21:05 -04:00
|
|
|
def test_logs_legacy_binds_after_type_cast
|
|
|
|
binds = [[@pk, "10"]]
|
|
|
|
assert_logs_binds(binds)
|
2016-07-18 21:20:58 -04:00
|
|
|
end
|
2017-03-22 11:21:05 -04:00
|
|
|
|
|
|
|
private
|
2019-02-25 09:40:20 -05:00
|
|
|
def to_sql_key(arel)
|
|
|
|
sql = @connection.to_sql(arel)
|
|
|
|
@connection.respond_to?(:sql_key, true) ? @connection.send(:sql_key, sql) : sql
|
|
|
|
end
|
|
|
|
|
|
|
|
def statement_cache
|
|
|
|
@connection.instance_variable_get(:@statements).send(:cache)
|
|
|
|
end
|
|
|
|
|
2017-03-22 11:21:05 -04:00
|
|
|
def assert_logs_binds(binds)
|
|
|
|
payload = {
|
|
|
|
name: "SQL",
|
|
|
|
sql: "select * from topics where id = ?",
|
|
|
|
binds: binds,
|
|
|
|
type_casted_binds: @connection.type_casted_binds(binds)
|
|
|
|
}
|
|
|
|
|
|
|
|
event = ActiveSupport::Notifications::Event.new(
|
|
|
|
"foo",
|
|
|
|
Time.now,
|
|
|
|
Time.now,
|
|
|
|
123,
|
|
|
|
payload)
|
|
|
|
|
|
|
|
logger = Class.new(ActiveRecord::LogSubscriber) {
|
|
|
|
attr_reader :debugs
|
|
|
|
|
|
|
|
def initialize
|
|
|
|
super
|
|
|
|
@debugs = []
|
|
|
|
end
|
|
|
|
|
|
|
|
def debug(str)
|
|
|
|
@debugs << str
|
|
|
|
end
|
|
|
|
}.new
|
|
|
|
|
|
|
|
logger.sql(event)
|
|
|
|
assert_match([[@pk.name, 10]].inspect, logger.debugs.first)
|
|
|
|
end
|
2012-05-13 03:27:52 -04:00
|
|
|
end
|
2011-02-10 12:56:50 -05:00
|
|
|
end
|
|
|
|
end
|