mirror of
https://github.com/andwati/zitadel.git
synced 2026-10-18 13:52:51 +00:00
Improves compatibility of eventstore and related database components with the new relational table package. ## Which problems are solved 1. **Incompatible Database Interfaces**: The existing eventstore was tightly coupled to the database package, which is incompatible with the new, more abstract relational table package in v3. This prevented the new command-side logic from pushing events to the legacy eventstore. 2. **Missing Health Checks**: The database interfaces in the new package lacked a Ping method, making it impossible to perform health checks on database connections. 3. **Event Publishing Logic**: The command handling logic in domain needed a way to collect and push events to the legacy eventstore after a command was successfully executed. ## How the problems are solved 1. **`LegacyEventstore` Interface**: * A new `LegacyEventstore` interface is introduced in the new `database/eventstore` . This interface exposes a `PushWithNewClient` method that accepts the new `database.QueryExecutor` interface, decoupling the v3 domain from the legacy implementation. * The `internal/eventstore.Eventstore` now implements this interface. A wrapper, PushWithClient, is added to convert the old database client types (`*sql.DB`, `*sql.Tx`) into the new `QueryExecutor` types before calling `PushWithNewClient`. 2. **Database Interface Updates**: * The `database.Pool` and `database.Client` interfaces in `storage/eventstore` have been updated to include a Ping method, allowing for consistent health checks across different database dialects. * The `postgres` and `sql` dialect implementations have been updated to support this new method. 3. **Command and Invoker Refactoring**: * The `Commander` interface in domain now includes an `Events() []legacy_es.Command` method. This allows commands to declare which events they will generate. * The `eventCollector` in the invoker logic has been redesigned. It now ensures a database transaction is started before executing a command. After successful execution, it calls the `Events()` method on the command to collect the generated events and appends them to a list. * The `eventStoreInvoker` then pushes all collected events to the legacy eventstore using the new `LegacyEventstore` interface, ensuring that events are only pushed if the entire command (and any sub-commands) executes successfully within the transaction. 4. **Testing**: * New unit tests have been added for the invoker to verify that events are correctly collected from single commands, batched commands, and nested commands. These changes create a clean bridge between the new v3 command-side logic and the existing v1 eventstore, allowing for incremental adoption of the new architecture while maintaining full functionality. ## Additional Information closes https://github.com/zitadel/zitadel/issues/10442
101 lines
3.7 KiB
Go
101 lines
3.7 KiB
Go
package eventstore
|
|
|
|
import (
|
|
"context"
|
|
_ "embed"
|
|
"errors"
|
|
"fmt"
|
|
"strings"
|
|
|
|
"github.com/jackc/pgx/v5/pgconn"
|
|
"github.com/zitadel/logging"
|
|
|
|
"github.com/zitadel/zitadel/backend/v3/storage/database"
|
|
"github.com/zitadel/zitadel/internal/eventstore"
|
|
"github.com/zitadel/zitadel/internal/telemetry/tracing"
|
|
"github.com/zitadel/zitadel/internal/zerrors"
|
|
)
|
|
|
|
var (
|
|
//go:embed unique_constraints_delete.sql
|
|
deleteConstraintStmt string
|
|
//go:embed unique_constraints_delete_placeholders.sql
|
|
deleteConstraintPlaceholdersStmt string
|
|
//go:embed unique_constraints_add.sql
|
|
addConstraintStmt string
|
|
)
|
|
|
|
func handleUniqueConstraints(ctx context.Context, tx database.Transaction, commands []eventstore.Command) (err error) {
|
|
ctx, span := tracing.NewSpan(ctx)
|
|
defer func() { span.EndWithError(err) }()
|
|
|
|
deletePlaceholders := make([]string, 0)
|
|
deleteArgs := make([]any, 0)
|
|
|
|
addPlaceholders := make([]string, 0)
|
|
addArgs := make([]any, 0)
|
|
addConstraints := map[string]*eventstore.UniqueConstraint{}
|
|
deleteConstraints := map[string]*eventstore.UniqueConstraint{}
|
|
|
|
for _, command := range commands {
|
|
for _, constraint := range command.UniqueConstraints() {
|
|
instanceID := command.Aggregate().InstanceID
|
|
if constraint.IsGlobal {
|
|
instanceID = ""
|
|
}
|
|
switch constraint.Action {
|
|
case eventstore.UniqueConstraintAdd:
|
|
constraint.UniqueField = strings.ToLower(constraint.UniqueField)
|
|
addPlaceholders = append(addPlaceholders, fmt.Sprintf("($%d, $%d, $%d)", len(addArgs)+1, len(addArgs)+2, len(addArgs)+3))
|
|
addArgs = append(addArgs, instanceID, constraint.UniqueType, constraint.UniqueField)
|
|
addConstraints[fmt.Sprintf(uniqueConstraintPlaceholderFmt, instanceID, constraint.UniqueType, constraint.UniqueField)] = constraint
|
|
case eventstore.UniqueConstraintRemove:
|
|
deletePlaceholders = append(deletePlaceholders, fmt.Sprintf(deleteConstraintPlaceholdersStmt, len(deleteArgs)+1, len(deleteArgs)+2, len(deleteArgs)+3))
|
|
deleteArgs = append(deleteArgs, instanceID, constraint.UniqueType, constraint.UniqueField)
|
|
deleteConstraints[fmt.Sprintf(uniqueConstraintPlaceholderFmt, instanceID, constraint.UniqueType, constraint.UniqueField)] = constraint
|
|
case eventstore.UniqueConstraintInstanceRemove:
|
|
deletePlaceholders = append(deletePlaceholders, fmt.Sprintf("(instance_id = $%d)", len(deleteArgs)+1))
|
|
deleteArgs = append(deleteArgs, instanceID)
|
|
deleteConstraints[fmt.Sprintf(uniqueConstraintPlaceholderFmt, instanceID, constraint.UniqueType, constraint.UniqueField)] = constraint
|
|
}
|
|
}
|
|
}
|
|
|
|
if len(deletePlaceholders) > 0 {
|
|
_, err := tx.Exec(ctx, fmt.Sprintf(deleteConstraintStmt, strings.Join(deletePlaceholders, " OR ")), deleteArgs...)
|
|
if err != nil {
|
|
logging.WithError(err).Warn("delete unique constraint failed")
|
|
errMessage := "Errors.Internal"
|
|
if constraint := constraintFromErr(err, deleteConstraints); constraint != nil {
|
|
errMessage = constraint.ErrorMessage
|
|
}
|
|
return zerrors.ThrowInternal(err, "V3-C8l3V", errMessage)
|
|
}
|
|
}
|
|
if len(addPlaceholders) > 0 {
|
|
_, err := tx.Exec(ctx, fmt.Sprintf(addConstraintStmt, strings.Join(addPlaceholders, ", ")), addArgs...)
|
|
if err != nil {
|
|
logging.WithError(err).Warn("add unique constraint failed")
|
|
errMessage := "Errors.Internal"
|
|
if constraint := constraintFromErr(err, addConstraints); constraint != nil {
|
|
errMessage = constraint.ErrorMessage
|
|
}
|
|
return zerrors.ThrowAlreadyExists(err, "V3-DKcYh", errMessage)
|
|
}
|
|
}
|
|
return nil
|
|
}
|
|
|
|
func constraintFromErr(err error, constraints map[string]*eventstore.UniqueConstraint) *eventstore.UniqueConstraint {
|
|
pgErr := new(pgconn.PgError)
|
|
if !errors.As(err, &pgErr) {
|
|
return nil
|
|
}
|
|
for key, constraint := range constraints {
|
|
if strings.Contains(pgErr.Detail, key) {
|
|
return constraint
|
|
}
|
|
}
|
|
return nil
|
|
}
|