activerecord 7.2.0.beta1 → 7.2.0.beta2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8f1dab654da16e8ee509ad6666ae0ed76c264fc0ee14e9c9def0134b729bb3a
-  data.tar.gz: 13e0b150714cb4389adcfc67ff3f4ff1a93b4df35da4b9711432259401218672
+  metadata.gz: 79dcd5171d733c47a82a63fd34a602529290fc29e1e1011906763b5a46bec471
+  data.tar.gz: b910e80c8172f01a7aabe42b3b6fb12e11f704c7951972684d1694d136b05520
 SHA512:
-  metadata.gz: ff57b5e598733b4b307cd757710fa043fa7669673f317263bfd0e0074bf4df6373ddb14c1ade8584d8cf5a7489a4d6c08d604cdca461439fafea2f0ee8b59823
-  data.tar.gz: 4801e69d0dc1006cfa3d6081c14380c7e5c00341136df95aafd812093bba843d4e7ed0bdc423d8c43056c9b2b3d4a434431be08dc724d23a762514e102008a2b
+  metadata.gz: 5126184906916972f44998d4180a0975a34504341702aa941b065a1eec31014e4066ce5e76a34d7270d4e58e4ab5e068806cdbb2d5bb3177552406b7ce781c84
+  data.tar.gz: 876047d057f0103a6e255880ffe12d4625bbbc91e81df3cd1eee22e08d853740c1063a1df7883efe805f56c17abd115e9e5b0c57241d5ab1387eb5fb65214df6

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+## Rails 7.2.0.beta2 (June 04, 2024) ##
+
+*   The payload of `sql.active_record` Active Support notifications now has the current transaction in the `:transaction` key.
+
+    *Xavier Noria*
+
+*   The payload of `transaction.active_record` Active Support notifications now has the transaction the event is related to in the `:transaction` key.
+
+    *Xavier Noria*
+
+*   Define `ActiveRecord::Transaction#uuid`, which returns a UUID for the database transaction. This may be helpful when tracing database activity. These UUIDs are generated only on demand.
+
+    *Xavier Noria*
+
 ## Rails 7.2.0.beta1 (May 29, 2024) ##
 
 *   Fix inference of association model on nested models with the same demodularized name.

data/lib/active_record/connection_adapters/abstract/connection_pool.rb

@@ -74,7 +74,7 @@ module ActiveRecord
     # Connections can be obtained and used from a connection pool in several
     # ways:
     #
-    # 1. Simply use {ActiveRecord::Base.lease_connection}[rdoc-ref:ConnectionHandling.connection].
+    # 1. Simply use {ActiveRecord::Base.lease_connection}[rdoc-ref:ConnectionHandling#lease_connection].
     #    When you're done with the connection(s) and wish it to be returned to the pool, you call
     #    {ActiveRecord::Base.connection_handler.clear_active_connections!}[rdoc-ref:ConnectionAdapters::ConnectionHandler#clear_active_connections!].
     #    This is the default behavior for Active Record when used in conjunction with
@@ -305,7 +305,7 @@ module ActiveRecord
       def connection
         ActiveRecord.deprecator.warn(<<~MSG)
           ActiveRecord::ConnectionAdapters::ConnectionPool#connection is deprecated
-          and will be removed in Rails 7.3. Use #lease_connection instead.
+          and will be removed in Rails 8.0. Use #lease_connection instead.
         MSG
         lease_connection
       end

data/lib/active_record/connection_adapters/abstract/query_cache.rb

@@ -277,6 +277,7 @@ module ActiveRecord
             type_casted_binds: -> { type_casted_binds(binds) },
             name: name,
             connection: self,
+            transaction: current_transaction.presence,
             cached: true
           }
         end

data/lib/active_record/connection_adapters/abstract/transaction.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "active_support/core_ext/digest"
+
 module ActiveRecord
   module ConnectionAdapters
     # = Active Record Connection Adapters Transaction State
@@ -107,6 +109,7 @@ module ActiveRecord
       def initialize; end
       def state; end
       def closed?; true; end
+      alias_method :blank?, :closed?
       def open?; false; end
       def joinable?; false; end
       def add_record(record, _ = true); end
@@ -119,6 +122,7 @@ module ActiveRecord
       def before_commit; yield; end
       def after_commit; yield; end
       def after_rollback; end # noop
+      def uuid; Digest::UUID.nil_uuid; end
     end
 
     class Transaction < ActiveRecord::Transaction # :nodoc:
@@ -138,7 +142,7 @@ module ActiveRecord
         @run_commit_callbacks = run_commit_callbacks
         @lazy_enrollment_records = nil
         @dirty = false
-        @instrumenter = TransactionInstrumenter.new(connection: connection)
+        @instrumenter = TransactionInstrumenter.new(connection: connection, transaction: self)
       end
 
       def dirty!
@@ -269,8 +273,6 @@ module ActiveRecord
 
       def full_rollback?; true; end
       def joinable?; @joinable; end
-      def closed?; false; end
-      def open?; !closed?; end
 
       private
         def unique_records

data/lib/active_record/connection_adapters/abstract_adapter.rb

@@ -1118,6 +1118,7 @@ module ActiveRecord
             statement_name:    statement_name,
             async:             async,
             connection:        self,
+            transaction:       current_transaction.presence,
             row_count:         0,
             &block
           )

data/lib/active_record/enum.rb

@@ -226,7 +226,7 @@ module ActiveRecord
 
       ActiveRecord.deprecator.warn(<<~MSG)
         Defining enums with keyword arguments is deprecated and will be removed
-        in Rails 7.3. Positional arguments should be used instead:
+        in Rails 8.0. Positional arguments should be used instead:
 
         #{definitions.map { |name, values| "enum :#{name}, #{values}" }.join("\n")}
       MSG

data/lib/active_record/gem_version.rb

@@ -10,7 +10,7 @@ module ActiveRecord
     MAJOR = 7
     MINOR = 2
     TINY  = 0
-    PRE   = "beta1"
+    PRE   = "beta2"
 
     STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".")
   end

data/lib/active_record/railtie.rb

@@ -187,7 +187,7 @@ To keep using the current cache store, you can turn off cache versioning entirel
       if config.active_record.warn_on_records_fetched_greater_than
         ActiveRecord.deprecator.warn <<~MSG.squish
           `config.active_record.warn_on_records_fetched_greater_than` is deprecated and will be
-          removed in Rails 7.3.
+          removed in Rails 8.0.
           Please subscribe to `sql.active_record` notifications and access the row count field to
           detect large result set sizes.
         MSG

data/lib/active_record/relation/query_methods.rb

@@ -746,7 +746,7 @@ module ActiveRecord
     VALID_UNSCOPING_VALUES = Set.new([:where, :select, :group, :order, :lock,
                                      :limit, :offset, :joins, :left_outer_joins, :annotate,
                                      :includes, :eager_load, :preload, :from, :readonly,
-                                     :having, :optimizer_hints])
+                                     :having, :optimizer_hints, :with])
 
     # Removes an unwanted relation that is already defined on a chain of relations.
     # This is useful when passing around chains of relations and would like to

data/lib/active_record/tasks/database_tasks.rb

@@ -446,7 +446,7 @@ module ActiveRecord
             db_config_or_name.default_schema_cache_path(ActiveRecord::Tasks::DatabaseTasks.db_dir)
         else
           ActiveRecord.deprecator.warn(<<~MSG.squish)
-            Passing a database name to `cache_dump_filename` is deprecated and will be removed in Rails 7.3. Pass a
+            Passing a database name to `cache_dump_filename` is deprecated and will be removed in Rails 8.0. Pass a
             `ActiveRecord::DatabaseConfigurations::DatabaseConfig` object instead.
           MSG
 
@@ -531,7 +531,7 @@ module ActiveRecord
         def schema_cache_env
           if ENV["SCHEMA_CACHE"]
             ActiveRecord.deprecator.warn(<<~MSG.squish)
-              Setting `ENV["SCHEMA_CACHE"]` is deprecated and will be removed in Rails 7.3.
+              Setting `ENV["SCHEMA_CACHE"]` is deprecated and will be removed in Rails 8.0.
               Configure the `:schema_cache_path` in the database configuration instead.
             MSG
 

data/lib/active_record/transaction.rb

@@ -1,6 +1,48 @@
 # frozen_string_literal: true
 
+require "active_support/core_ext/digest"
+
 module ActiveRecord
+  # This abstract class specifies the interface to interact with the current transaction state.
+  #
+  # Any other methods not specified here are considered to be private interfaces.
+  #
+  # == Callbacks
+  #
+  # After updating the database state, you may sometimes need to perform some extra work, or reflect these
+  # changes in a remote system like clearing or updating a cache:
+  #
+  #   def publish_article(article)
+  #     article.update!(published: true)
+  #     NotificationService.article_published(article)
+  #   end
+  #
+  # The above code works but has one important flaw, which is that it no longer works properly if called inside
+  # a transaction, as it will interact with the remote system before the changes are persisted:
+  #
+  #   Article.transaction do
+  #     article = create_article(article)
+  #     publish_article(article)
+  #   end
+  #
+  # The callbacks offered by ActiveRecord::Transaction allow to rewriting this method in a way that is compatible
+  # with transactions:
+  #
+  #   def publish_article(article)
+  #     article.update!(published: true)
+  #     Article.current_transaction.after_commit do
+  #       NotificationService.article_published(article)
+  #     end
+  #   end
+  #
+  # In the above example, if +publish_article+ is called inside a transaction, the callback will be invoked
+  # after the transaction is successfully committed, and if called outside a transaction, the callback will be invoked
+  # immediately.
+  #
+  # == Caveats
+  #
+  # When using after_commit callbacks, it is important to note that if the callback raises an error, the transaction
+  # won't be rolled back. Relying solely on these to synchronize state between multiple systems may lead to consistency issues.
   class Transaction
     class Callback # :nodoc:
       def initialize(event, callback)
@@ -23,6 +65,7 @@ module ActiveRecord
 
     def initialize # :nodoc:
       @callbacks = nil
+      @uuid = nil
     end
 
     # Registers a block to be called before the current transaction is fully committed.
@@ -32,6 +75,8 @@ module ActiveRecord
     # If the current transaction has a parent transaction, the callback is transferred to
     # the parent when the current transaction commits, or dropped when the current transaction
     # is rolled back. This operation is repeated until the outermost transaction is reached.
+    #
+    # If the callback raises an error, the transaction is rolled back.
     def before_commit(&block)
       (@callbacks ||= []) << Callback.new(:before_commit, block)
     end
@@ -43,6 +88,8 @@ module ActiveRecord
     # If the current transaction has a parent transaction, the callback is transferred to
     # the parent when the current transaction commits, or dropped when the current transaction
     # is rolled back. This operation is repeated until the outermost transaction is reached.
+    #
+    # If the callback raises an error, the transaction remains committed.
     def after_commit(&block)
       (@callbacks ||= []) << Callback.new(:after_commit, block)
     end
@@ -60,8 +107,24 @@ module ActiveRecord
       (@callbacks ||= []) << Callback.new(:after_rollback, block)
     end
 
+    # Returns true if a transaction was started.
+    def open?
+      true
+    end
+
+    # Returns true if no transaction is currently active.
+    def closed?
+      false
+    end
+    alias_method :blank?, :closed?
+
+    # Returns a UUID for this transaction.
+    def uuid
+      @uuid ||= Digest::UUID.uuid_v4
+    end
+
     protected
-      def append_callbacks(callbacks)
+      def append_callbacks(callbacks) # :nodoc:
         (@callbacks ||= []).concat(callbacks)
       end
   end

data/lib/active_record/transactions.rb

@@ -188,6 +188,27 @@ module ActiveRecord
     # #after_commit is a good spot to put in a hook to clearing a cache since clearing it from
     # within a transaction could trigger the cache to be regenerated before the database is updated.
     #
+    # ==== NOTE: Callbacks are deduplicated per callback by filter.
+    #
+    # Trying to define multiple callbacks with the same filter will result in a single callback being run.
+    #
+    # For example:
+    #
+    #   after_commit :do_something
+    #   after_commit :do_something # only the last one will be called
+    #
+    # This applies to all variations of <tt>after_*_commit</tt> callbacks as well.
+    #
+    #   after_commit :do_something
+    #   after_create_commit :do_something
+    #   after_save_commit :do_something
+    #
+    # It is recommended to use the +on:+ option to specify when the callback should be run.
+    #
+    #   after_commit :do_something, on: [:create, :update]
+    #
+    # This is equivalent to using +after_create_commit+ and +after_update_commit+, but will not be deduplicated.
+    #
     # === Caveats
     #
     # If you're on MySQL, then do not use Data Definition Language (DDL) operations in nested
@@ -214,7 +235,13 @@ module ActiveRecord
         end
       end
 
-      # Returns the current transaction. See ActiveRecord::Transactions API docs.
+      # Returns a representation of the current transaction state,
+      # which can be a top level transaction, a savepoint, or the absence of a transaction.
+      #
+      # An object is always returned, whether or not a transaction is currently active.
+      # To check if a transaction was opened, use <tt>current_transaction.open?</tt>.
+      #
+      # See the ActiveRecord::Transaction documentation for detailed behavior.
       def current_transaction
         connection_pool.active_connection&.current_transaction || ConnectionAdapters::TransactionManager::NULL_TRANSACTION
       end

data/lib/active_record.rb

@@ -347,14 +347,14 @@ module ActiveRecord
   def self.commit_transaction_on_non_local_return
     ActiveRecord.deprecator.warn <<-WARNING.squish
       `Rails.application.config.active_record.commit_transaction_on_non_local_return`
-      is deprecated and will be removed in Rails 7.3.
+      is deprecated and will be removed in Rails 8.0.
     WARNING
   end
 
   def self.commit_transaction_on_non_local_return=(value)
     ActiveRecord.deprecator.warn <<-WARNING.squish
       `Rails.application.config.active_record.commit_transaction_on_non_local_return`
-      is deprecated and will be removed in Rails 7.3.
+      is deprecated and will be removed in Rails 8.0.
     WARNING
   end
 
@@ -447,14 +447,14 @@ module ActiveRecord
   def self.allow_deprecated_singular_associations_name
     ActiveRecord.deprecator.warn <<-WARNING.squish
       `Rails.application.config.active_record.allow_deprecated_singular_associations_name`
-      is deprecated and will be removed in Rails 7.3.
+      is deprecated and will be removed in Rails 8.0.
     WARNING
   end
 
   def self.allow_deprecated_singular_associations_name=(value)
     ActiveRecord.deprecator.warn <<-WARNING.squish
       `Rails.application.config.active_record.allow_deprecated_singular_associations_name`
-      is deprecated and will be removed in Rails 7.3.
+      is deprecated and will be removed in Rails 8.0.
     WARNING
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord
 version: !ruby/object:Gem::Version
-  version: 7.2.0.beta1
+  version: 7.2.0.beta2
 platform: ruby
 authors:
 - David Heinemeier Hansson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-29 00:00:00.000000000 Z
+date: 2024-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 7.2.0.beta1
+        version: 7.2.0.beta2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 7.2.0.beta1
+        version: 7.2.0.beta2
 - !ruby/object:Gem::Dependency
   name: activemodel
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 7.2.0.beta1
+        version: 7.2.0.beta2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 7.2.0.beta1
+        version: 7.2.0.beta2
 - !ruby/object:Gem::Dependency
   name: timeout
   requirement: !ruby/object:Gem::Requirement
@@ -475,10 +475,10 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/rails/rails/issues
-  changelog_uri: https://github.com/rails/rails/blob/v7.2.0.beta1/activerecord/CHANGELOG.md
-  documentation_uri: https://api.rubyonrails.org/v7.2.0.beta1/
+  changelog_uri: https://github.com/rails/rails/blob/v7.2.0.beta2/activerecord/CHANGELOG.md
+  documentation_uri: https://api.rubyonrails.org/v7.2.0.beta2/
   mailing_list_uri: https://discuss.rubyonrails.org/c/rubyonrails-talk
-  source_code_uri: https://github.com/rails/rails/tree/v7.2.0.beta1/activerecord
+  source_code_uri: https://github.com/rails/rails/tree/v7.2.0.beta2/activerecord
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options:
@@ -493,11 +493,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.5.10
+rubygems_version: 3.3.27
 signing_key:
 specification_version: 4
 summary: Object-relational mapper framework (part of Rails).