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]>
88 lines
2.6 KiB
Go
88 lines
2.6 KiB
Go
package domain
|
|
|
|
import (
|
|
"context"
|
|
"errors"
|
|
"strings"
|
|
|
|
"github.com/zitadel/zitadel/backend/v3/storage/database"
|
|
"github.com/zitadel/zitadel/internal/api/authz"
|
|
"github.com/zitadel/zitadel/internal/eventstore"
|
|
"github.com/zitadel/zitadel/internal/repository/org"
|
|
"github.com/zitadel/zitadel/internal/zerrors"
|
|
)
|
|
|
|
var (
|
|
_ Commander = (*DeactivateOrgCommand)(nil)
|
|
_ Transactional = (*DeactivateOrgCommand)(nil)
|
|
)
|
|
|
|
type DeactivateOrgCommand struct {
|
|
ID string `json:"id"`
|
|
}
|
|
|
|
func NewDeactivateOrgCommand(organizationID string) *DeactivateOrgCommand {
|
|
return &DeactivateOrgCommand{ID: organizationID}
|
|
}
|
|
|
|
// Events implements [Commander].
|
|
func (cmd *DeactivateOrgCommand) Events(ctx context.Context, opts *InvokeOpts) ([]eventstore.Command, error) {
|
|
return []eventstore.Command{org.NewOrgDeactivatedEvent(ctx, &org.NewAggregate(cmd.ID).Aggregate)}, nil
|
|
}
|
|
|
|
// RequiresTransaction implements [Transactional].
|
|
func (cmd *DeactivateOrgCommand) RequiresTransaction() {}
|
|
|
|
// Execute implements [Commander].
|
|
func (cmd *DeactivateOrgCommand) Execute(ctx context.Context, opts *InvokeOpts) (err error) {
|
|
organizationRepo := opts.organizationRepo
|
|
|
|
updateCount, err := organizationRepo.Update(ctx, opts.DB(),
|
|
organizationRepo.PrimaryKeyCondition(authz.GetInstance(ctx).InstanceID(), cmd.ID),
|
|
database.NewChange(organizationRepo.StateColumn(), OrgStateInactive),
|
|
)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
if updateCount == 0 {
|
|
return zerrors.ThrowNotFound(nil, "DOM-vWPy7D", "Errors.Org.NotFound")
|
|
}
|
|
if updateCount > 1 {
|
|
return zerrors.ThrowInternal(NewMultipleObjectsUpdatedError(1, updateCount), "DOM-dXl1kJ", "unexpected number of rows updated")
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
// String implements [Commander].
|
|
func (DeactivateOrgCommand) String() string {
|
|
return "DeactivateOrgCommand"
|
|
}
|
|
|
|
// Validate implements [Commander].
|
|
func (cmd *DeactivateOrgCommand) Validate(ctx context.Context, opts *InvokeOpts) (err error) {
|
|
if cmd.ID = strings.TrimSpace(cmd.ID); cmd.ID == "" {
|
|
return zerrors.ThrowInvalidArgument(nil, "DOM-Qc3T1r", "invalid organization ID")
|
|
}
|
|
|
|
organizationRepo := opts.organizationRepo
|
|
|
|
org, err := organizationRepo.Get(ctx, opts.DB(), database.WithCondition(
|
|
organizationRepo.PrimaryKeyCondition(authz.GetInstance(ctx).InstanceID(), cmd.ID),
|
|
))
|
|
if err != nil {
|
|
var notFoundError *database.NoRowFoundError
|
|
if errors.As(err, ¬FoundError) {
|
|
err = zerrors.ThrowNotFound(err, "DOM-QEjfpz", "Errors.Org.NotFound")
|
|
}
|
|
return err
|
|
}
|
|
|
|
if org.State == OrgStateInactive {
|
|
err = zerrors.ThrowPreconditionFailed(nil, "DOM-Z2dzsT", "Errors.Org.AlreadyDeactivated")
|
|
return err
|
|
}
|
|
return nil
|
|
}
|