mirror of
https://github.com/andwati/zitadel.git
synced 2026-10-22 23:42:16 +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]>
92 lines
4.1 KiB
Go
92 lines
4.1 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
|
|
|
|
// PrimaryKeyCondition returns a filter on the primary key fields.
|
|
PrimaryKeyCondition(instanceID, orgID, domain string) database.Condition
|
|
// 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
|
|
}
|
|
|
|
//go:generate mockgen -typed -package domainmock -destination ./mock/org_domain.mock.go . OrganizationDomainRepository
|
|
|
|
type OrganizationDomainRepository interface {
|
|
Repository
|
|
|
|
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, client database.QueryExecutor, 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, client database.QueryExecutor, opts ...database.QueryOption) ([]*OrganizationDomain, error)
|
|
|
|
// Add adds a new domain to the organization.
|
|
Add(ctx context.Context, client database.QueryExecutor, domain *AddOrganizationDomain) error
|
|
// Update updates an existing domain in the organization.
|
|
Update(ctx context.Context, client database.QueryExecutor, condition database.Condition, changes ...database.Change) (int64, error)
|
|
// Remove removes a domain from the organization.
|
|
Remove(ctx context.Context, client database.QueryExecutor, condition database.Condition) (int64, error)
|
|
}
|