1
0
Fork 0
mirror of https://github.com/rails/rails.git synced 2022-11-09 12:12:34 -05:00

Add option for default_scope to run on all queries

This change allows for applications to optionally run a `default_scope`
on `update` and `delete` queries. Default scopes already ran on select
and insert queries.

Applications can now run a set default scope on all queries for a model
by setting a `all_queries` option:

```ruby
class Article < ApplicationRecord
  default_scope -> { where(blog_id: 1) }, all_queries: true
end
```

Using the default scope in this way is useful for applications that need
to query by more than the primary key by default. An example of this
would be in an application using a sharding strategy like Vitess like.
For Rails sharding, we route connections first and then query the
database. However, Vitess and other solutions use a parameter in the
query to figure out how to route the queries. By extending
`default_scope` to apply to all queries we can allow applications to
optionally apply additional constraints to all queries. Note that this
only works with `where` queries as it does not make sense to select a
record by primary key with an order. With this change we're allowing
apps to select with a primary key and an additional key.

To make this change dynamic for routing queries in a tenant sharding
strategy applications can use the `Current` API or parameters in a
request to route queries:

```ruby
class Article < ApplicationRecord
  default_scope -> { where(blog_id: Current.blog.id) }, all_queries: true
end
```

In order to achieve this I created a new object when default scopes are
created. This allows us to store both the scope itself and whether we
should run this on all queries. I chose not to implement an `on:` option
that takes an array of actions because there is no simple or clear way
to turn off the default scope for create/select. It also doesn't really
make sense to only have a default scope for delete queries. The decision
to use `all_queries` here allows for the implementation to be more
flexible than it was without creating a mess in an application.
This commit is contained in:
eileencodes 2020-11-19 17:20:45 -05:00
parent 6f9d4a000b
commit 816f6194b6
No known key found for this signature in database
GPG key ID: BA5C575120BBE8DF
8 changed files with 160 additions and 11 deletions

View file

@ -1,3 +1,17 @@
* Add option to run `default_scope` on all queries.
Previously, a `default_scope` would only run on select or insert queries. In some cases, like non-Rails tenant sharding solutions, it may be desirable to run `default_scope` on all queries in order to ensure queries are including a foreign key for the shard (ie `blog_id`).
Now applications can add an option to run on all queries including select, insert, delete, and update by adding an `all_queries` option to the default scope definition.
```ruby
class Article < ApplicationRecord
default_scope -> { where(blog_id: Current.blog.id) }, all_queries: true
end
```
*Eileen M. Uchitelle*
* Add `where.associated` to check for the presence of an association. * Add `where.associated` to check for the presence of an association.
```ruby ```ruby

View file

@ -378,6 +378,10 @@ module ActiveRecord
def _update_record(values, constraints) # :nodoc: def _update_record(values, constraints) # :nodoc:
constraints = _substitute_values(constraints).map { |attr, bind| attr.eq(bind) } constraints = _substitute_values(constraints).map { |attr, bind| attr.eq(bind) }
if default_scopes.any? && !default_scoped(all_queries: true).where_clause.empty?
constraints << default_scoped(all_queries: true).where_clause.ast
end
um = arel_table.where( um = arel_table.where(
constraints.reduce(&:and) constraints.reduce(&:and)
).compile_update(_substitute_values(values), primary_key) ).compile_update(_substitute_values(values), primary_key)
@ -388,6 +392,10 @@ module ActiveRecord
def _delete_record(constraints) # :nodoc: def _delete_record(constraints) # :nodoc:
constraints = _substitute_values(constraints).map { |attr, bind| attr.eq(bind) } constraints = _substitute_values(constraints).map { |attr, bind| attr.eq(bind) }
if default_scopes.any? && !default_scoped(all_queries: true).where_clause.empty?
constraints << default_scoped(all_queries: true).where_clause.ast
end
dm = Arel::DeleteManager.new dm = Arel::DeleteManager.new
dm.from(arel_table) dm.from(arel_table)
dm.wheres = constraints dm.wheres = constraints

View file

@ -2,6 +2,15 @@
module ActiveRecord module ActiveRecord
module Scoping module Scoping
class DefaultScope # :nodoc:
attr_reader :scope, :all_queries
def initialize(scope, all_queries = nil)
@scope = scope
@all_queries = all_queries
end
end
module Default module Default
extend ActiveSupport::Concern extend ActiveSupport::Concern
@ -54,11 +63,26 @@ module ActiveRecord
# Article.all # => SELECT * FROM articles WHERE published = true # Article.all # => SELECT * FROM articles WHERE published = true
# #
# The #default_scope is also applied while creating/building a record. # The #default_scope is also applied while creating/building a record.
# It is not applied while updating a record. # It is not applied while updating or deleting a record.
# #
# Article.new.published # => true # Article.new.published # => true
# Article.create.published # => true # Article.create.published # => true
# #
# To apply a #default_scope when updating or deleting a record, add
# `all_queries: true`:
#
# class Article < ActiveRecord::Base
# default_scope { where(blog_id: 1) }, all_queries: true
# end
#
# Applying a default scope to all queries will ensure that records
# are always queried by the additional conditions. Note that only
# where clauses apply, as it does not make sense to add order to
# queries that return a single object by primary key.
#
# Article.find(1).destroy
# => DELETE ... FROM `articles` where ID = 1 AND blog_id = 1;
#
# (You can also pass any object which responds to +call+ to the # (You can also pass any object which responds to +call+ to the
# +default_scope+ macro, and it will be called when building the # +default_scope+ macro, and it will be called when building the
# default scope.) # default scope.)
@ -85,7 +109,7 @@ module ActiveRecord
# # Should return a scope, you can call 'super' here etc. # # Should return a scope, you can call 'super' here etc.
# end # end
# end # end
def default_scope(scope = nil, &block) # :doc: def default_scope(scope = nil, all_queries: nil, &block) # :doc:
scope = block if block_given? scope = block if block_given?
if scope.is_a?(Relation) || !scope.respond_to?(:call) if scope.is_a?(Relation) || !scope.respond_to?(:call)
@ -96,10 +120,12 @@ module ActiveRecord
"self.default_scope.)" "self.default_scope.)"
end end
self.default_scopes += [scope] default_scope = DefaultScope.new(scope, all_queries)
self.default_scopes += [default_scope]
end end
def build_default_scope(relation = relation()) def build_default_scope(relation = relation(), all_queries: nil)
return if abstract_class? return if abstract_class?
if default_scope_override.nil? if default_scope_override.nil?
@ -115,13 +141,25 @@ module ActiveRecord
end end
elsif default_scopes.any? elsif default_scopes.any?
evaluate_default_scope do evaluate_default_scope do
default_scopes.inject(relation) do |default_scope, scope| default_scopes.inject(relation) do |default_scope, scope_obj|
scope = scope.respond_to?(:to_proc) ? scope : scope.method(:call) if execute_scope?(all_queries, scope_obj)
scope = scope_obj.scope.respond_to?(:to_proc) ? scope_obj.scope : scope_obj.scope.method(:call)
default_scope.instance_exec(&scope) || default_scope default_scope.instance_exec(&scope) || default_scope
end end
end end
end end
end end
end
# If all_queries is nil, only execute on select and insert queries.
#
# If all_queries is true, check if the default_scope object has
# all_queries set, then execute on all queries; select, insert, update
# and delete.
def execute_scope?(all_queries, default_scope_obj)
all_queries.nil? || all_queries && default_scope_obj.all_queries
end
def ignore_default_scope? def ignore_default_scope?
ScopeRegistry.value_for(:ignore_default_scope, base_class) ScopeRegistry.value_for(:ignore_default_scope, base_class)

View file

@ -42,8 +42,8 @@ module ActiveRecord
end end
# Returns a scope for the model with default scopes. # Returns a scope for the model with default scopes.
def default_scoped(scope = relation) def default_scoped(scope = relation, all_queries: nil)
build_default_scope(scope) || scope build_default_scope(scope, all_queries: all_queries) || scope
end end
def default_extensions # :nodoc: def default_extensions # :nodoc:

View file

@ -378,7 +378,7 @@ class NestedThroughAssociationsTest < ActiveRecord::TestCase
prev_default_scope = Club.default_scopes prev_default_scope = Club.default_scopes
[:includes, :preload, :joins, :eager_load].each do |q| [:includes, :preload, :joins, :eager_load].each do |q|
Club.default_scopes = [proc { Club.public_send(q, :category) }] Club.default_scopes = [ActiveRecord::Scoping::DefaultScope.new(proc { Club.public_send(q, :category) })]
assert_equal categories(:general), members(:groucho).reload.club_category assert_equal categories(:general), members(:groucho).reload.club_category
end end
ensure ensure

View file

@ -145,7 +145,7 @@ module ActiveRecord
def test_dup_with_default_scope def test_dup_with_default_scope
prev_default_scopes = Topic.default_scopes prev_default_scopes = Topic.default_scopes
Topic.default_scopes = [proc { Topic.where(approved: true) }] Topic.default_scopes = [ActiveRecord::Scoping::DefaultScope.new(proc { Topic.where(approved: true) })]
topic = Topic.new(approved: false) topic = Topic.new(approved: false)
assert_not topic.dup.approved?, "should not be overridden by default scopes" assert_not topic.dup.approved?, "should not be overridden by default scopes"
ensure ensure

View file

@ -7,6 +7,7 @@ require "models/developer"
require "models/project" require "models/project"
require "models/computer" require "models/computer"
require "models/cat" require "models/cat"
require "models/mentor"
require "concurrent/atomic/cyclic_barrier" require "concurrent/atomic/cyclic_barrier"
class DefaultScopingTest < ActiveRecord::TestCase class DefaultScopingTest < ActiveRecord::TestCase
@ -79,6 +80,84 @@ class DefaultScopingTest < ActiveRecord::TestCase
assert_equal 50000, wheres["salary"] assert_equal 50000, wheres["salary"]
end end
def test_default_scope_runs_on_create
Mentor.create!
create_sql = capture_sql { DeveloperwithDefaultMentorScopeNot.create!(name: "Eileen") }.first
assert_match(/mentor_id/, create_sql)
end
def test_default_scope_with_all_queries_runs_on_create
Mentor.create!
create_sql = capture_sql { DeveloperWithDefaultMentorScopeAllQueries.create!(name: "Eileen") }.first
assert_match(/mentor_id/, create_sql)
end
def test_default_scope_runs_on_select
Mentor.create!
DeveloperwithDefaultMentorScopeNot.create!(name: "Eileen")
select_sql = capture_sql { DeveloperwithDefaultMentorScopeNot.find_by(name: "Eileen") }.first
assert_match(/mentor_id/, select_sql)
end
def test_default_scope_with_all_queries_runs_on_select
Mentor.create!
DeveloperWithDefaultMentorScopeAllQueries.create!(name: "Eileen")
select_sql = capture_sql { DeveloperWithDefaultMentorScopeAllQueries.find_by(name: "Eileen") }.first
assert_match(/mentor_id/, select_sql)
end
def test_default_scope_doesnt_run_on_update
Mentor.create!
dev = DeveloperwithDefaultMentorScopeNot.create!(name: "Eileen")
update_sql = capture_sql { dev.update!(name: "Not Eileen") }.first
assert_no_match(/mentor_id/, update_sql)
end
def test_default_scope_with_all_queries_runs_on_update
Mentor.create!
dev = DeveloperWithDefaultMentorScopeAllQueries.create!(name: "Eileen")
update_sql = capture_sql { dev.update!(name: "Not Eileen") }.first
assert_match(/mentor_id/, update_sql)
end
def test_default_scope_doesnt_run_on_update_columns
Mentor.create!
dev = DeveloperwithDefaultMentorScopeNot.create!(name: "Eileen")
update_sql = capture_sql { dev.update_columns(name: "Not Eileen") }.first
assert_no_match(/mentor_id/, update_sql)
end
def test_default_scope_with_all_queries_runs_on_update_columns
Mentor.create!
dev = DeveloperWithDefaultMentorScopeAllQueries.create!(name: "Eileen")
update_sql = capture_sql { dev.update_columns(name: "Not Eileen") }.first
assert_match(/mentor_id/, update_sql)
end
def test_default_scope_doesnt_run_on_destroy
Mentor.create!
dev = DeveloperwithDefaultMentorScopeNot.create!(name: "Eileen")
destroy_sql = capture_sql { dev.destroy }.first
assert_no_match(/mentor_id/, destroy_sql)
end
def test_default_scope_with_all_queries_runs_on_destroy
Mentor.create!
dev = DeveloperWithDefaultMentorScopeAllQueries.create!(name: "Eileen")
destroy_sql = capture_sql { dev.destroy }.first
assert_match(/mentor_id/, destroy_sql)
end
def test_scope_overwrites_default def test_scope_overwrites_default
expected = Developer.all.merge!(order: "salary DESC, name DESC").to_a.collect(&:name) expected = Developer.all.merge!(order: "salary DESC, name DESC").to_a.collect(&:name)
received = DeveloperOrderedBySalary.by_name.to_a.collect(&:name) received = DeveloperOrderedBySalary.by_name.to_a.collect(&:name)

View file

@ -140,6 +140,16 @@ class DeveloperWithSelect < ActiveRecord::Base
default_scope { select("name") } default_scope { select("name") }
end end
class DeveloperwithDefaultMentorScopeNot < ActiveRecord::Base
self.table_name = "developers"
default_scope -> { where(mentor_id: 1) }
end
class DeveloperWithDefaultMentorScopeAllQueries < ActiveRecord::Base
self.table_name = "developers"
default_scope -> { where(mentor_id: 1) }, all_queries: true
end
class DeveloperWithIncludes < ActiveRecord::Base class DeveloperWithIncludes < ActiveRecord::Base
self.table_name = "developers" self.table_name = "developers"
has_many :audit_logs, foreign_key: :developer_id has_many :audit_logs, foreign_key: :developer_id