Files
zitadel/backend/v3/domain/org_update.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

133 lines
3.5 KiB
Go

package domain
import (
"context"
"strings"
"github.com/zitadel/zitadel/backend/v3/storage/database"
"github.com/zitadel/zitadel/internal/api/authz"
http_utils "github.com/zitadel/zitadel/internal/api/http"
"github.com/zitadel/zitadel/internal/domain"
"github.com/zitadel/zitadel/internal/eventstore"
"github.com/zitadel/zitadel/internal/repository/org"
"github.com/zitadel/zitadel/internal/zerrors"
)
type UpdateOrgCommand struct {
ID string `json:"id"`
Name string `json:"name"`
OldDomainName *string `json:"old_name"`
IsOldDomainVerified *bool `json:"is_old_domain_primary"`
}
// RequiresTransaction implements [Transactional].
func (cmd *UpdateOrgCommand) RequiresTransaction() {}
// Events implements Commander.
func (cmd *UpdateOrgCommand) Events(ctx context.Context, opts *InvokeOpts) ([]eventstore.Command, error) {
toReturn := []eventstore.Command{}
if cmd.OldDomainName != nil && *cmd.OldDomainName != cmd.Name {
toReturn = append(toReturn, org.NewOrgChangedEvent(ctx, &org.NewAggregate(cmd.ID).Aggregate, *cmd.OldDomainName, cmd.Name))
}
return toReturn, nil
}
var (
_ Commander = (*UpdateOrgCommand)(nil)
_ Transactional = (*UpdateOrgCommand)(nil)
)
func NewUpdateOrgCommand(id, name string) *UpdateOrgCommand {
return &UpdateOrgCommand{
ID: id,
Name: name,
}
}
func (cmd *UpdateOrgCommand) Execute(ctx context.Context, opts *InvokeOpts) (err error) {
organizationRepo := opts.organizationRepo.LoadDomains()
org, err := organizationRepo.Get(ctx, opts.DB(), database.WithCondition(
organizationRepo.PrimaryKeyCondition(authz.GetInstance(ctx).InstanceID(), cmd.ID),
))
if err != nil {
return err
}
err = cmd.setDomainInfos(ctx, org)
if err != nil {
return err
}
updateCount, err := organizationRepo.Update(
ctx,
opts.DB(),
organizationRepo.PrimaryKeyCondition(org.InstanceID, org.ID),
database.NewChange(organizationRepo.NameColumn(), cmd.Name),
)
if err != nil {
return err
}
if updateCount == 0 {
err = zerrors.ThrowNotFound(nil, "DOM-7PfSUn", "Errors.Org.NotFound")
return err
}
if updateCount > 1 {
err = zerrors.ThrowInternal(NewMultipleObjectsUpdatedError(1, updateCount), "DOM-QzITrx", "unexpected number of rows updated")
return err
}
return err
}
func (cmd *UpdateOrgCommand) String() string {
return "UpdateOrgCommand"
}
func (cmd *UpdateOrgCommand) Validate(ctx context.Context, opts *InvokeOpts) error {
if cmd.ID = strings.TrimSpace(cmd.ID); cmd.ID == "" {
return zerrors.ThrowInvalidArgument(nil, "DOM-lEMhVC", "invalid organization ID")
}
if cmd.Name = strings.TrimSpace(cmd.Name); cmd.Name == "" {
return zerrors.ThrowInvalidArgument(nil, "DOM-wfUntW", "invalid organization name")
}
organizationRepo := opts.organizationRepo
org, err := organizationRepo.Get(ctx, opts.DB(),
database.WithCondition(
opts.organizationRepo.PrimaryKeyCondition(authz.GetInstance(ctx).InstanceID(), cmd.ID),
))
if err != nil {
return err
}
if org.Name == cmd.Name {
return zerrors.ThrowPreconditionFailed(nil, "DOM-nDzwIu", "Errors.Org.NotChanged")
}
return nil
}
func (cmd *UpdateOrgCommand) setDomainInfos(ctx context.Context, org *Organization) error {
iamDomain := http_utils.DomainContext(ctx).RequestedDomain()
oldDomainName, err := domain.NewIAMDomainName(org.Name, iamDomain)
if err != nil {
return err
}
for _, d := range org.Domains {
if d.Domain == oldDomainName && !d.IsPrimary {
cmd.IsOldDomainVerified = &d.IsVerified
cmd.OldDomainName = &d.Domain
return nil
}
}
return nil
}