Introduce transaction hooks in @tsed/mikro-orm

[derevnjuk]

Information

The current version of @tsed/mikro-orm lacks a comprehensive set of transaction hooks that allow developers to customize transaction behavior. To address this limitation, I propose the addition of two new interfaces, BeforeTransactionCommit and AfterTransactionCommit, which provide the ability to define hooks executed right before and after committing data to the database.

Example

import { AfterTransactionCommit, BeforeTransactionCommit } from "@tsed/mikro-orm";
import { EntityManager } from "@mikro-orm/core";
import { Injectable } from "@tsed/di";

@Injectable()
export class Hooks implements AfterTransactionCommit, BeforeTransactionCommit {
  $afterTransactionCommit(em: EntityManager): Promise<unknown> | unknown {
    // Custom code executed after committing data
  }

  $beforeTransactionCommit(em: EntityManager): Promise<unknown> | unknown {
    // Custom code executed before committing data
  }
}

Use Case

The proposed transaction hooks would empower developers to implement advanced patterns such as the Inbox pattern or domain event dispatch. With BeforeTransactionCommit, developers can modify data within the same transaction context, allowing them to perform additional operations before the transaction is committed. Conversely, AfterTransactionCommit enables executing code after the data is committed, making it suitable for handling eventual consistency and compensatory actions in case of failures.

Acceptance criteria

• The $beforeTransactionCommit event should be fired within the same transaction context before the data is committed to the database.
• The $afterTransactionCommit method should be fired after the data is successfully committed to the database.

[derevnjuk]

Once #2293 is merged, this request will be addressed as well.

[github-actions]

🎉 Are you happy?

If you appreciated the support, know that it is free and is carried out on personal time ;)

A support, even a little bit makes a difference for me and continues to bring you answers!

[Romakita]

🎉 This issue has been resolved in version 7.34.0 🎉

The release is available on:

• v7.34.0
• GitHub release

Your semantic-release bot 📦🚀