CHANGELOG.md

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

1.5.0 (2024-12-09)

Added

• Ability to propagate exception for multiple after_commit callbacks within transaction. Should handle exception inside callback to avoid stopping other callbacks.

  Pull request #35 by @kevink1103. Also see discussion at #34.

1.4.0 (2024-02-07)

Added

• Ability to prepend callbacks to the head of callback queue using prepend: true option.

  AfterCommitEverywhere.after_commit { puts "I'm second!" }
  AfterCommitEverywhere.after_commit(prepend: true) { puts "I'm first!" }

  See Pull request #30 by @quentindemetz and @A1090.

1.3.1 (2023-06-21)

Fixed

• Don't include development-related files into packaged gem to avoid confusing users or software tools. @Envek.

  See discussion at #26.

  Files packaged after this change:

  CHANGELOG.md
  LICENSE.txt
  README.md
  after_commit_everywhere.gemspec
  lib/after_commit_everywhere.rb
  lib/after_commit_everywhere/version.rb
  lib/after_commit_everywhere/wrap.rb
  

1.3.0 (2022-10-28)

Added

• in_transaction helper method to execute code within existing transaction or start a new one if there is no tx open.

  It is similar to ActiveRecord::Base.transaction, but it doesn't swallow ActiveRecord::Rollback exception in case when there is no transaction open.

  See discussion at #23 for details.

  Pull request #23 by @jpcamara.

• Ability to call in_transaction helper with the same arguments as ActiveRecord::Base.transaction. @Envek.

1.2.2 (2022-06-20)

Fixed

• Connection leak from the connection pool when after_commit called outside Rails executor without connection checked out and some connections were already checked out from another threads.

  See discussion at issue #20 for details.

  Pull request #22 by @Envek.

1.2.1 (2022-06-10)

Fixed

• Connection leak from the connection pool when after_commit called outside Rails executor without connection checked out

  Usually all invocations of after_commit (whether it happens during serving HTTP request in Rails controller or performing job in Sidekiq worker process) are made inside Rails executor which checks in any connections back to the connection pool that were checked out inside its block.

  However, in cases when a) after_commit was called outside of Rails executor (3-rd party gems or non-Rails apps using ActiveRecord) and b) database connection hasn't been checked out yet, then connection will be checked out by after_commit implicitly by call to ActiveRecord::Base.connection and not checked in back afterwards causing it to leak from the connection pool.

  But in that case we can be sure that there is no transaction in progress ('cause one need to checkout connection and issue BEGIN to it), so we don't need to check it out at all and can fast-forward to without_tx action.

  See discussion at issue #20 for details.

  Pull request #21 by @Envek.

1.2.0 (2022-03-26)

Added

• Allow to change callbacks' behavior when they are called outside transaction:

  AfterCommitEverywhere.after_commit(without_tx: :raise) do
    # Will be executed only if was called within transaction
    # Error will be raised otherwise
  end

  Available values for without_tx keyword argument:

  • :execute to execute callback immediately
  • :warn_and_execute to print warning and execute immediately
  • :raise to raise an exception instead of executing

  Pull request #18 by @lolripgg.

1.1.0 (2021-08-05)

Added

• Allow to call transactional callbacks directly on AfterCommitEverywhere module:

  AfterCommitEverywhere.after_commit { puts "If you see me then transaction has been successfully commited!" }

• Allow to call in_transaction? helper method from instance methods in classes that includes AfterCommitEverywhere module.

1.0.0 (2021-02-17)

Declare gem as stable. No changes since 0.1.5.

See #11 for discussion.

0.1.5 (2020-03-22)

Fixed

• [PR #8] Callback registration when callback methods are aliased. (@stokarenko)

0.1.4 (2019-09-10)

• [PR #6] ActiveRecord 6.0 compatibility. (@joevandyk)

0.1.3 (2019-02-18)

• Make in_transaction? helper method public. (@Envek)

0.1.2 (2018-05-01)

• [PR #1] Enable ActiveRecord 4.2 support. (@arjun810, @Envek)

0.1.1 (2018-03-29)

• Do not issue warning on after_commit invocation outside of transaction as it is expected behaviour. (@Envek)

0.1.0 (2018-03-18)

• Initial version with after_commit, before_commit. and after_rollback callbacks. (@Envek)