[BUG] Events created in nested transactions can fail to deliver

[ryanshellberg]

Bug Report

Describe the Bug:
Originally called out as a concern in the V2 PR. When an event is created inside of a transaction, the corresponding EventJob fires before the event itself is created. This leads to a DeserializationError which is then discarded, so the failure was quite tricky to track down.

To Reproduce:
A little tricky to reproduce here because it is a race condition, but our code looks like this:

Person.transaction do 
  ... other changes ...
  ReportComplete.with(report: report).deliver(report.user)
end

Expected Behavior:
EventJob's are created after the event is committed to the database.

Actual Behavior:
EventJob's are fired off before the event is committed to the database.

Environment:

• Noticed gem version: 2.3.1
• Ruby version: 3.3.1
• Rails version: 7.1.3.3
• Operating System: OSX 14.5

Possible Fix:
Seems like using an after_commit callback to fire the job should work.

Related Issues:
#313 (comment)

Checklist:

• I have searched for similar issues and couldn't find any
• I have checked the documentation for relevant information
• I have included all the required information

[excid3]

I wouldn't consider this a bug in Noticed. You should deliver the notification after your transaction is completed.

By wrapping Noticed in another transaction, it negates the transaction Noticed uses internally.

Rails 7.2 is going to help with this by enqueuing after transaction: https://edgeguides.rubyonrails.org/7_2_release_notes.html#prevent-jobs-from-being-scheduled-within-transactions

[ryanshellberg]

Good point, thanks for the info on the upcoming Rails change!