mirror of
https://github.com/andwati/zitadel.git
synced 2026-10-18 05:52:51 +00:00
c4221a9c0f
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]>
96 lines
2.5 KiB
Go
96 lines
2.5 KiB
Go
package domain
|
|
|
|
import (
|
|
"context"
|
|
|
|
"github.com/zitadel/zitadel/backend/v3/storage/database"
|
|
"github.com/zitadel/zitadel/backend/v3/storage/eventstore"
|
|
)
|
|
|
|
type InvokeOpt func(*InvokeOpts)
|
|
|
|
func WithOrganizationRepo(repo OrganizationRepository) InvokeOpt {
|
|
return func(opts *InvokeOpts) {
|
|
opts.organizationRepo = repo
|
|
}
|
|
}
|
|
|
|
func WithOrganizationDomainRepo(repo OrganizationDomainRepository) InvokeOpt {
|
|
return func(opts *InvokeOpts) {
|
|
opts.organizationDomainRepo = repo
|
|
}
|
|
}
|
|
|
|
func WithProjectRepo(repo ProjectRepository) InvokeOpt {
|
|
return func(opts *InvokeOpts) {
|
|
opts.projectRepo = repo
|
|
}
|
|
}
|
|
|
|
// WithQueryExecutor sets the database client to be used by the command.
|
|
// If not set, the default pool will be used.
|
|
// This is mainly used for testing.
|
|
func WithQueryExecutor(executor database.QueryExecutor) InvokeOpt {
|
|
return func(opts *InvokeOpts) {
|
|
opts.db = executor
|
|
}
|
|
}
|
|
|
|
// WithLegacyEventstore sets the eventstore to be used by the command.
|
|
// If not set, the default one will be used.
|
|
// This is mainly used for testing.
|
|
func WithLegacyEventstore(es eventstore.LegacyEventstore) InvokeOpt {
|
|
return func(opts *InvokeOpts) {
|
|
opts.legacyEventstore = es
|
|
}
|
|
}
|
|
|
|
// InvokeOpts are passed to each command
|
|
type InvokeOpts struct {
|
|
// db is the database client.
|
|
// [Executor]s MUST NOT access this field directly, use [InvokeOpts.DB] to access it.
|
|
//
|
|
// [Invoker]s may manipulate this field for example changing it to a transaction.
|
|
// Its their responsibility to restore it after ending the transaction.
|
|
db database.QueryExecutor
|
|
legacyEventstore eventstore.LegacyEventstore
|
|
Invoker Invoker
|
|
Permissions PermissionChecker
|
|
organizationRepo OrganizationRepository
|
|
organizationDomainRepo OrganizationDomainRepository
|
|
projectRepo ProjectRepository
|
|
}
|
|
|
|
func (o *InvokeOpts) DB() database.QueryExecutor {
|
|
if o.db != nil {
|
|
return o.db
|
|
}
|
|
o.db = pool
|
|
return o.db
|
|
}
|
|
|
|
func (o *InvokeOpts) LegacyEventstore() eventstore.LegacyEventstore {
|
|
if o.legacyEventstore != nil {
|
|
return o.legacyEventstore
|
|
}
|
|
o.legacyEventstore = legacyEventstore
|
|
return o.legacyEventstore
|
|
}
|
|
|
|
func (o *InvokeOpts) Invoke(ctx context.Context, executor Executor) error {
|
|
if o.Invoker == nil {
|
|
return executor.Execute(ctx, o)
|
|
}
|
|
return o.Invoker.Invoke(ctx, executor, o)
|
|
}
|
|
|
|
func DefaultOpts(invoker Invoker) *InvokeOpts {
|
|
if invoker == nil {
|
|
invoker = &noopInvoker{}
|
|
}
|
|
return &InvokeOpts{
|
|
Invoker: invoker,
|
|
Permissions: &noopPermissionChecker{}, // prevent panics for now
|
|
}
|
|
}
|