Skip to content

Commit

Permalink
Deprecate using insert_all/upsert_all with unpersisted records in ass…
Browse files Browse the repository at this point in the history
…ociations.
  • Loading branch information
Schwad authored and rafaelfranca committed Jan 6, 2025
1 parent 272fb90 commit 7a66f63
Show file tree
Hide file tree
Showing 3 changed files with 47 additions and 2 deletions.
8 changes: 8 additions & 0 deletions activerecord/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
* Deprecate using `insert_all`/`upsert_all` with unpersisted records in associations.

Using these methods on associations containing unpersisted records will now
show a deprecation warning, as the unpersisted records will be lost after
the operation. This will become an error in Rails 8.2.

*Nick Schwaderer*

* Introduce versions formatter for the schema dumper.

It is now possible to override how schema dumper formats versions information inside the
Expand Down
13 changes: 12 additions & 1 deletion activerecord/lib/active_record/associations/collection_proxy.rb
Original file line number Diff line number Diff line change
Expand Up @@ -1128,7 +1128,18 @@ def pretty_print(pp) # :nodoc:
%w(insert insert_all insert! insert_all! upsert upsert_all).each do |method|
class_eval <<~RUBY, __FILE__, __LINE__ + 1
def #{method}(...)
scope.#{method}(...).tap { reset }
if loaded? && @association&.target&.any? { |r| r.new_record? }
ActiveRecord.deprecator.warn(<<~MSG)
Using #{method} on association with unpersisted records
(\#{to_a.reject(&:persisted?).map(&:class).uniq.join(', ')})
is deprecated. The unpersisted records will be lost after this operation.
Please either persist your records first or store them separately before
calling #{method}. This will become an error in Rails 8.1.
MSG
scope.#{method}(...)
else
scope.#{method}(...).tap { reset }
end
end
RUBY
end
Expand Down
28 changes: 27 additions & 1 deletion activerecord/test/cases/insert_all_test.rb
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ class ReadonlyNameBook < Book
end

class InsertAllTest < ActiveRecord::TestCase
fixtures :books
fixtures :books, :authors

def setup
Arel::Table.engine = nil # should not rely on the global Arel::Table.engine
Expand Down Expand Up @@ -863,6 +863,32 @@ def test_insert_all_when_table_name_contains_database
end
end

def test_insert_all_with_unpersisted_records_deprecation
author = Author.create!(name: "Rafael")
author.books.build(title: "Unpersisted Book")
author.books.load

assert_deprecated(ActiveRecord.deprecator) do
author.books.insert_all([{ title: "New Book" }])
end

assert_equal 1, author.books.size
assert_equal ["Unpersisted Book"], author.books.pluck(:title)
end

def test_insert_all_resets_without_unpersisted_records
author = Author.create!(name: "Rafael")
author.books.load

assert_not_deprecated(ActiveRecord.deprecator) do
author.books.insert_all([{ title: "New Book" }])
end

assert_not_predicate author.books, :loaded?
assert_equal 1, author.books.size
assert_equal ["New Book"], author.books.pluck(:title)
end

private
def capture_log_output
output = StringIO.new
Expand Down

0 comments on commit 7a66f63

Please sign in to comment.