mirror of
https://github.com/andwati/zitadel.git
synced 2026-10-18 05:52:51 +00:00
This PR initiates the rework of Zitadel's backend to state-persisted objects. This change is a step towards a more scalable and maintainable architecture. ## Changes * **New `/backend/v3` package**: A new package structure has been introduced to house the reworked backend logic. This includes: * `domain`: Contains the core business logic, commands, and repository interfaces. * `storage`: Implements the repository interfaces for database interactions with new transactional tables. * `telemetry`: Provides logging and tracing capabilities. * **Transactional Tables**: New database tables have been defined for `instances`, `instance_domains`, `organizations`, and `org_domains`. * **Projections**: New projections have been created to populate the new relational tables from the existing event store, ensuring data consistency during the migration. * **Repositories**: New repositories provide an abstraction layer for accessing and manipulating the data in the new tables. * **Setup**: A new setup step for `TransactionalTables` has been added to manage the database migrations for the new tables. This PR lays the foundation for future work to fully transition to state-persisted objects for these components, which will improve performance and simplify data access patterns. This PR initiates the rework of ZITADEL's backend to state-persisted objects. This is a foundational step towards a new architecture that will improve performance and maintainability. The following objects are migrated from event-sourced aggregates to state-persisted objects: * Instances * incl. Domains * Orgs * incl. Domains The structure of the new backend implementation follows the software architecture defined in this [wiki page](https://github.com/zitadel/zitadel/wiki/Software-Architecturel). This PR includes: * The initial implementation of the new transactional repositories for the objects listed above. * Projections to populate the new relational tables from the existing event store. * Adjustments to the build and test process to accommodate the new backend structure. This is a work in progress and further changes will be made to complete the migration. --------- Co-authored-by: Copilot <[email protected]> Co-authored-by: Iraq Jaber <[email protected]> Co-authored-by: Iraq <[email protected]> Co-authored-by: Tim Möhlmann <[email protected]>
159 lines
4.7 KiB
Go
159 lines
4.7 KiB
Go
package domain
|
|
|
|
// import (
|
|
// "context"
|
|
// "fmt"
|
|
|
|
// "github.com/zitadel/zitadel/backend/v3/storage/eventstore"
|
|
// )
|
|
|
|
// // Invoke provides a way to execute commands within the domain package.
|
|
// // It uses a chain of responsibility pattern to handle the command execution.
|
|
// // The default chain includes logging, tracing, and event publishing.
|
|
// // If you want to invoke multiple commands in a single transaction, you can use the [commandBatch].
|
|
// func Invoke(ctx context.Context, cmd Commander) error {
|
|
// invoker := newEventStoreInvoker(newLoggingInvoker(newTraceInvoker(nil)))
|
|
// opts := &CommandOpts{
|
|
// Invoker: invoker.collector,
|
|
// DB: pool,
|
|
// }
|
|
// return invoker.Invoke(ctx, cmd, opts)
|
|
// }
|
|
|
|
// // eventStoreInvoker checks if the command implements the [eventer] interface.
|
|
// // If it does, it collects the events and publishes them to the event store.
|
|
// type eventStoreInvoker struct {
|
|
// collector *eventCollector
|
|
// }
|
|
|
|
// func newEventStoreInvoker(next Invoker) *eventStoreInvoker {
|
|
// return &eventStoreInvoker{collector: &eventCollector{next: next}}
|
|
// }
|
|
|
|
// func (i *eventStoreInvoker) Invoke(ctx context.Context, command Commander, opts *CommandOpts) (err error) {
|
|
// err = i.collector.Invoke(ctx, command, opts)
|
|
// if err != nil {
|
|
// return err
|
|
// }
|
|
// if len(i.collector.events) > 0 {
|
|
// err = eventstore.Publish(ctx, i.collector.events, opts.DB)
|
|
// if err != nil {
|
|
// return err
|
|
// }
|
|
// }
|
|
// return nil
|
|
// }
|
|
|
|
// // eventCollector collects events from all commands. The [eventStoreInvoker] pushes the collected events after all commands are executed.
|
|
// type eventCollector struct {
|
|
// next Invoker
|
|
// events []*eventstore.Event
|
|
// }
|
|
|
|
// type eventer interface {
|
|
// Events() []*eventstore.Event
|
|
// }
|
|
|
|
// func (i *eventCollector) Invoke(ctx context.Context, command Commander, opts *CommandOpts) (err error) {
|
|
// if e, ok := command.(eventer); ok && len(e.Events()) > 0 {
|
|
// // we need to ensure all commands are executed in the same transaction
|
|
// close, err := opts.EnsureTx(ctx)
|
|
// if err != nil {
|
|
// return err
|
|
// }
|
|
// defer func() { err = close(ctx, err) }()
|
|
|
|
// i.events = append(i.events, e.Events()...)
|
|
// }
|
|
// if i.next != nil {
|
|
// return i.next.Invoke(ctx, command, opts)
|
|
// }
|
|
// return command.Execute(ctx, opts)
|
|
// }
|
|
|
|
// // traceInvoker decorates each command with tracing.
|
|
// type traceInvoker struct {
|
|
// next Invoker
|
|
// }
|
|
|
|
// func newTraceInvoker(next Invoker) *traceInvoker {
|
|
// return &traceInvoker{next: next}
|
|
// }
|
|
|
|
// func (i *traceInvoker) Invoke(ctx context.Context, command Commander, opts *CommandOpts) (err error) {
|
|
// ctx, span := tracer.Start(ctx, fmt.Sprintf("%T", command))
|
|
// defer func() {
|
|
// if err != nil {
|
|
// span.RecordError(err)
|
|
// }
|
|
// span.End()
|
|
// }()
|
|
|
|
// if i.next != nil {
|
|
// return i.next.Invoke(ctx, command, opts)
|
|
// }
|
|
// return command.Execute(ctx, opts)
|
|
// }
|
|
|
|
// // loggingInvoker decorates each command with logging.
|
|
// // It is an example implementation and logs the command name at the beginning and success or failure after the command got executed.
|
|
// type loggingInvoker struct {
|
|
// next Invoker
|
|
// }
|
|
|
|
// func newLoggingInvoker(next Invoker) *loggingInvoker {
|
|
// return &loggingInvoker{next: next}
|
|
// }
|
|
|
|
// func (i *loggingInvoker) Invoke(ctx context.Context, command Commander, opts *CommandOpts) (err error) {
|
|
// logger.InfoContext(ctx, "Invoking command", "command", command.String())
|
|
|
|
// if i.next != nil {
|
|
// err = i.next.Invoke(ctx, command, opts)
|
|
// } else {
|
|
// err = command.Execute(ctx, opts)
|
|
// }
|
|
|
|
// if err != nil {
|
|
// logger.ErrorContext(ctx, "Command invocation failed", "command", command.String(), "error", err)
|
|
// return err
|
|
// }
|
|
// logger.InfoContext(ctx, "Command invocation succeeded", "command", command.String())
|
|
// return nil
|
|
// }
|
|
|
|
// type noopInvoker struct {
|
|
// next Invoker
|
|
// }
|
|
|
|
// func (i *noopInvoker) Invoke(ctx context.Context, command Commander, opts *CommandOpts) error {
|
|
// if i.next != nil {
|
|
// return i.next.Invoke(ctx, command, opts)
|
|
// }
|
|
// return command.Execute(ctx, opts)
|
|
// }
|
|
|
|
// // cacheInvoker could be used in the future to do the caching.
|
|
// // My goal would be to have two interfaces:
|
|
// // - cacheSetter: which caches an object
|
|
// // - cacheGetter: which gets an object from the cache, this should also skip the command execution
|
|
// type cacheInvoker struct {
|
|
// next Invoker
|
|
// }
|
|
|
|
// type cacher interface {
|
|
// Cache(opts *CommandOpts)
|
|
// }
|
|
|
|
// func (i *cacheInvoker) Invoke(ctx context.Context, command Commander, opts *CommandOpts) (err error) {
|
|
// if c, ok := command.(cacher); ok {
|
|
// c.Cache(opts)
|
|
// }
|
|
// if i.next != nil {
|
|
// err = i.next.Invoke(ctx, command, opts)
|
|
// } else {
|
|
// err = command.Execute(ctx, opts)
|
|
// }
|
|
// return err
|
|
// }
|