Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Propagatable exception after committed DB transaction #35

Merged
merged 3 commits into from
Dec 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 15 additions & 6 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,26 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).

## 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](https://github.com/Envek/after_commit_everywhere/pull/35) by [@kevink1103](). Also see discussion at [#34](https://github.com/Envek/after_commit_everywhere/issues/34).

## 1.4.0 (2024-02-07)

### Added

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

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

See [Pull request #30](https://github.com/Envek/after_commit_everywhere/pull/30) by [@quentindemetz][] and [@A1090][].
See [Pull request #30](https://github.com/Envek/after_commit_everywhere/pull/30) by [@quentindemetz][] and [@A1090][].

## 1.3.1 (2023-06-21)

Expand Down Expand Up @@ -147,3 +155,4 @@ See [#11](https://github.com/Envek/after_commit_everywhere/issues/11) for discus
[@jpcamara]: https://github.com/jpcamara "JP Camara"
[@quentindemetz]: https://github.com/quentindemetz "Quentin de Metz"
[@A1090]: https://github.com/A1090 "Tabac Andreina"
[@kevink1103]: https://github.com/kevink1103 "Kevin (bum)"
2 changes: 1 addition & 1 deletion Gemfile.lock
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
PATH
remote: .
specs:
after_commit_everywhere (1.4.0)
after_commit_everywhere (1.5.0)
activerecord (>= 4.2)
activesupport

Expand Down
2 changes: 1 addition & 1 deletion lib/after_commit_everywhere/version.rb
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# frozen_string_literal: true

module AfterCommitEverywhere
VERSION = "1.4.0"
VERSION = "1.5.0"
end
6 changes: 4 additions & 2 deletions lib/after_commit_everywhere/wrap.rb
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,10 @@ def trigger_transactional_callbacks?
true
end

def committed!(*)
@handlers[:after_commit]&.call
def committed!(should_run_callbacks: true)
if should_run_callbacks
@handlers[:after_commit]&.call
end
end

def rolledback!(*)
Expand Down
21 changes: 15 additions & 6 deletions spec/after_commit_everywhere_spec.rb
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,10 @@
end

context "within transaction" do
context 'when prepend is true' do
let(:handler_1) { spy("handler_1") }
let(:handler_2) { spy("handler_2") }
let(:handler_1) { spy("handler_1") }
let(:handler_2) { spy("handler_2") }

context 'when prepend is true' do
it 'executes prepended callback first' do
ActiveRecord::Base.transaction do
example_class.new.after_commit { handler_1.call }
Expand All @@ -54,9 +54,6 @@
end

context 'when prepend is not specified' do
let(:handler_1) { spy("handler_1") }
let(:handler_2) { spy("handler_2") }

it 'executes callbacks in the order they were defined' do
ActiveRecord::Base.transaction do
example_class.new.after_commit { handler_1.call }
Expand Down Expand Up @@ -99,6 +96,18 @@
expect(handler).to have_received(:call)
end
end

it 'propagates an error raised in one of multiple callbacks' do
expect do
ActiveRecord::Base.transaction do
example_class.new.after_commit { raise 'this should prevent other callbacks being executed' }
example_class.new.after_commit { handler_1.call }
example_class.new.after_commit { handler_2.call }
end
end.to raise_error('this should prevent other callbacks being executed')
expect(handler_1).not_to have_received(:call)
expect(handler_2).not_to have_received(:call)
end
end

context "without transaction" do
Expand Down
Loading