Files
zitadel/backend/v3/domain/invoker_transaction.go
T
c4221a9c0f refactor: invoker implementations and clean up code (#10962)
This pull request refactors the command execution and transaction
handling logic within the `domain` package. The primary goal is to
simplify the invoker chain, clarify transaction management, and improve
the overall structure for better maintainability and readability.

### Key Changes:

- **Simplified Invoker Chain**: The previous chain of invokers has been
refactored. A new `transactionInvoker` is introduced to explicitly
manage database transactions for commands that require them. This
responsibility is no longer spread across different parts of the
invocation flow.
- **`Transactional` Interface**: A new `Transactional` interface has
been introduced. Commands that need to run within a database transaction
now implement this interface. This provides a clear and explicit
contract for transactional operations.
- **Consolidated Transaction Logic**: The logic for starting,
committing, and rolling back transactions is now centralized within the
`transactionInvoker` and the `eventStoreInvoker`. The `EnsureTx` method
on `InvokeOpts` has been removed, and transaction handling is now
managed automatically by the invocation framework.
- **Improved Event Handling**: The `eventStoreInvoker` and its
`eventCollector` have been rewritten to be more robust and to correctly
handle nested and batched commands, ensuring that all events are
collected and published within the same transaction.
- **Code Cleanup**: A significant amount of now-unused code, including
the old `invoker_test.go`, has been removed. Various comments and
variable declarations have also been cleaned up.
- **Updated Command Implementations**: All commands in the `domain`
package (e.g., `ActivateOrgCommand`, `DeactivateOrgCommand`,
`DeleteOrgCommand`, `UpdateOrgCommand`) have been updated to use the new
`Transactional` interface where appropriate, removing manual transaction
management.
- **Enhanced Testing**: Tests have been added and updated to cover the
new transaction and event handling logic, ensuring the refactoring is
sound.
- **Use `PrimaryKeyCondition`**: Use the
`repository.PrimaryKeyCondition(...)` method instead of using
`database.And(...)` where possible.

These changes lead to a cleaner, more decoupled architecture for command
handling in ZITADEL.

---------

Co-authored-by: Marco A. <[email protected]>
2025-10-27 14:04:06 +00:00

41 lines
1.1 KiB
Go

package domain
import (
"context"
)
// transactionInvoker ensures that [InvokeOpts].DB() returns a [database.Transaction].
// if a new transaction is started, it will be committed or rolled back after the [Executor] execution.
type transactionInvoker struct {
invoker
}
// NewTransactionInvoker creates a new [transactionInvoker].
func NewTransactionInvoker(next Invoker) *transactionInvoker {
return &transactionInvoker{
invoker: invoker{next: next},
}
}
// Transactional is implemented by [Commander]s and [Querier]s wishing to access the DB inside a transaction.
//
//go:generate mockgen -destination=mock/transactional.mock.go -package=domainmock . Transactional
type Transactional interface {
RequiresTransaction()
}
// Invoke implements [Invoker].
func (i *transactionInvoker) Invoke(ctx context.Context, executor Executor, opts *InvokeOpts) (err error) {
if _, ok := executor.(Transactional); !ok {
return i.execute(ctx, executor, opts)
}
close, err := i.ensureTx(ctx, opts)
if err != nil {
return err
}
defer func() { err = close(err) }()
return i.execute(ctx, executor, opts)
}