mirror of
https://github.com/andwati/zitadel.git
synced 2026-11-16 10:45:12 +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]>
85 lines
3.6 KiB
Go
85 lines
3.6 KiB
Go
package domain
|
|
|
|
import (
|
|
"context"
|
|
"time"
|
|
|
|
"github.com/zitadel/zitadel/backend/v3/storage/database"
|
|
)
|
|
|
|
type OrganizationDomain struct {
|
|
InstanceID string `json:"instanceId,omitempty" db:"instance_id"`
|
|
OrgID string `json:"orgId,omitempty" db:"org_id"`
|
|
Domain string `json:"domain,omitempty" db:"domain"`
|
|
IsVerified bool `json:"isVerified,omitempty" db:"is_verified"`
|
|
IsPrimary bool `json:"isPrimary,omitempty" db:"is_primary"`
|
|
ValidationType *DomainValidationType `json:"validationType,omitempty" db:"validation_type"`
|
|
|
|
CreatedAt time.Time `json:"createdAt,omitzero" db:"created_at"`
|
|
UpdatedAt time.Time `json:"updatedAt,omitzero" db:"updated_at"`
|
|
}
|
|
|
|
type AddOrganizationDomain struct {
|
|
InstanceID string `json:"instanceId,omitempty" db:"instance_id"`
|
|
OrgID string `json:"orgId,omitempty" db:"org_id"`
|
|
Domain string `json:"domain,omitempty" db:"domain"`
|
|
IsVerified bool `json:"isVerified,omitempty" db:"is_verified"`
|
|
IsPrimary bool `json:"isPrimary,omitempty" db:"is_primary"`
|
|
ValidationType *DomainValidationType `json:"validationType,omitempty" db:"validation_type"`
|
|
|
|
// CreatedAt is the time when the domain was added.
|
|
// It is set by the repository and should not be set by the caller.
|
|
CreatedAt time.Time `json:"createdAt,omitzero" db:"created_at"`
|
|
// UpdatedAt is the time when the domain was added.
|
|
// It is set by the repository and should not be set by the caller.
|
|
UpdatedAt time.Time `json:"updatedAt,omitzero" db:"updated_at"`
|
|
}
|
|
|
|
type organizationDomainColumns interface {
|
|
domainColumns
|
|
// OrgIDColumn returns the column for the org id field.
|
|
OrgIDColumn() database.Column
|
|
// IsVerifiedColumn returns the column for the is verified field.
|
|
IsVerifiedColumn() database.Column
|
|
// ValidationTypeColumn returns the column for the verification type field.
|
|
ValidationTypeColumn() database.Column
|
|
}
|
|
|
|
type organizationDomainConditions interface {
|
|
domainConditions
|
|
// OrgIDCondition returns a filter on the org id field.
|
|
OrgIDCondition(orgID string) database.Condition
|
|
// IsVerifiedCondition returns a filter on the is verified field.
|
|
IsVerifiedCondition(isVerified bool) database.Condition
|
|
}
|
|
|
|
type organizationDomainChanges interface {
|
|
domainChanges
|
|
// SetVerified sets the is verified column to true.
|
|
SetVerified() database.Change
|
|
// SetValidationType sets the verification type column.
|
|
// If the domain is already verified, this is a no-op.
|
|
SetValidationType(verificationType DomainValidationType) database.Change
|
|
}
|
|
|
|
type OrganizationDomainRepository interface {
|
|
organizationDomainColumns
|
|
organizationDomainConditions
|
|
organizationDomainChanges
|
|
|
|
// Get returns a single domain based on the criteria.
|
|
// If no domain is found, it returns an error of type [database.ErrNotFound].
|
|
// If multiple domains are found, it returns an error of type [database.ErrMultipleRows].
|
|
Get(ctx context.Context, opts ...database.QueryOption) (*OrganizationDomain, error)
|
|
// List returns a list of domains based on the criteria.
|
|
// If no domains are found, it returns an empty slice.
|
|
List(ctx context.Context, opts ...database.QueryOption) ([]*OrganizationDomain, error)
|
|
|
|
// Add adds a new domain to the organization.
|
|
Add(ctx context.Context, domain *AddOrganizationDomain) error
|
|
// Update updates an existing domain in the organization.
|
|
Update(ctx context.Context, condition database.Condition, changes ...database.Change) (int64, error)
|
|
// Remove removes a domain from the organization.
|
|
Remove(ctx context.Context, condition database.Condition) (int64, error)
|
|
}
|