mirror of
https://github.com/andwati/zitadel.git
synced 2026-10-19 14:12:52 +00:00
f230cf0fb5
# Which Problems Are Solved Relational table's primary keys are part of the SQL table definition. However, by abstraction through the repository interfaces callers (service layer) have no clear understanding of the primary key definion. This might lead to confusion during implementation: - The repository makes a sanity check on required conditions before query execution and returns an error if the condition was not met. - When a Get method is executed, an error is returned if not exactly one row is found. Get replaces the legacy GetXxxByID methods we have on projections. However, a list of flexible conditions can be passed. - Operations like UPDATE and DELETE should often only affect a single row, identified by the primary key. If the primary key conditions are missing an error is returned. Because there is no "type safety" enforced here, the errors are returned during runtime. When all possible combinations of API arguments are not properly tested such errors are actually bugs in the experience of the end-user. (The API should do it's own input validation, but a programmer's error is easily made). # How the Problems Are Solved Add `PrimaryKeyColumns` and `PrimaryKeyCondition` to existing repository intefaces. # Additional Changes - Where reducers already used repositories, the PrimaryKeyConditions are used where possible. # Additional Context - Part of https://github.com/zitadel/zitadel/wiki/Decision-Log#expose-primary-key-definition-in-repository-interfaces --------- Co-authored-by: Marco A. <[email protected]>
84 lines
3.3 KiB
Go
84 lines
3.3 KiB
Go
package domain
|
|
|
|
import (
|
|
"context"
|
|
"time"
|
|
|
|
"github.com/zitadel/zitadel/backend/v3/storage/database"
|
|
)
|
|
|
|
type InstanceDomain struct {
|
|
InstanceID string `json:"instanceId,omitempty" db:"instance_id"`
|
|
Domain string `json:"domain,omitempty" db:"domain"`
|
|
// IsPrimary indicates if the domain is the primary domain of the instance.
|
|
// It is only set for custom domains.
|
|
IsPrimary *bool `json:"isPrimary,omitempty" db:"is_primary"`
|
|
// IsGenerated indicates if the domain is a generated domain.
|
|
// It is only set for custom domains.
|
|
IsGenerated *bool `json:"isGenerated,omitempty" db:"is_generated"`
|
|
Type DomainType `json:"type,omitempty" db:"type"`
|
|
|
|
CreatedAt time.Time `json:"createdAt,omitzero" db:"created_at"`
|
|
UpdatedAt time.Time `json:"updatedAt,omitzero" db:"updated_at"`
|
|
}
|
|
|
|
type AddInstanceDomain struct {
|
|
InstanceID string `json:"instanceId,omitempty" db:"instance_id"`
|
|
Domain string `json:"domain,omitempty" db:"domain"`
|
|
IsPrimary *bool `json:"isPrimary,omitempty" db:"is_primary"`
|
|
IsGenerated *bool `json:"isGenerated,omitempty" db:"is_generated"`
|
|
Type DomainType `json:"type,omitempty" db:"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 last updated.
|
|
// It is set by the repository and should not be set by the caller.
|
|
UpdatedAt time.Time `json:"updatedAt,omitzero" db:"updated_at"`
|
|
}
|
|
|
|
type instanceDomainColumns interface {
|
|
domainColumns
|
|
// IsGeneratedColumn returns the column for the is generated field.
|
|
IsGeneratedColumn() database.Column
|
|
// TypeColumn returns the column for the type field.
|
|
TypeColumn() database.Column
|
|
}
|
|
|
|
type instanceDomainConditions interface {
|
|
domainConditions
|
|
// PrimaryKeyCondition returns a filter on the primary key fields.
|
|
PrimaryKeyCondition(domain string) database.Condition
|
|
// TypeCondition returns a filter for the type field.
|
|
TypeCondition(typ DomainType) database.Condition
|
|
}
|
|
|
|
type instanceDomainChanges interface {
|
|
domainChanges
|
|
// SetType sets the type column.
|
|
SetType(typ DomainType) database.Change
|
|
}
|
|
|
|
type InstanceDomainRepository interface {
|
|
Repository
|
|
|
|
instanceDomainColumns
|
|
instanceDomainConditions
|
|
instanceDomainChanges
|
|
|
|
// 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, client database.QueryExecutor, opts ...database.QueryOption) (*InstanceDomain, 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, client database.QueryExecutor, opts ...database.QueryOption) ([]*InstanceDomain, error)
|
|
|
|
// Add adds a new domain to the instance.
|
|
Add(ctx context.Context, client database.QueryExecutor, domain *AddInstanceDomain) error
|
|
// Update updates an existing domain in the instance.
|
|
Update(ctx context.Context, client database.QueryExecutor, condition database.Condition, changes ...database.Change) (int64, error)
|
|
// Remove removes a domain from the instance.
|
|
Remove(ctx context.Context, client database.QueryExecutor, condition database.Condition) (int64, error)
|
|
}
|