mirror of
https://github.com/andwati/zitadel.git
synced 2026-10-19 06:02: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]>
123 lines
4.6 KiB
Go
123 lines
4.6 KiB
Go
package domain
|
|
|
|
import (
|
|
"context"
|
|
"time"
|
|
|
|
"golang.org/x/text/language"
|
|
|
|
"github.com/zitadel/zitadel/backend/v3/storage/cache"
|
|
"github.com/zitadel/zitadel/backend/v3/storage/database"
|
|
)
|
|
|
|
type Instance struct {
|
|
ID string `json:"id,omitempty" db:"id"`
|
|
Name string `json:"name,omitempty" db:"name"`
|
|
DefaultOrgID string `json:"defaultOrgId,omitempty" db:"default_org_id"`
|
|
IAMProjectID string `json:"iamProjectId,omitempty" db:"iam_project_id"`
|
|
ConsoleClientID string `json:"consoleClientId,omitempty" db:"console_client_id"`
|
|
ConsoleAppID string `json:"consoleAppId,omitempty" db:"console_app_id"`
|
|
DefaultLanguage string `json:"defaultLanguage,omitempty" db:"default_language"`
|
|
CreatedAt time.Time `json:"createdAt" db:"created_at"`
|
|
UpdatedAt time.Time `json:"updatedAt" db:"updated_at"`
|
|
|
|
Domains []*InstanceDomain `json:"domains,omitempty" db:"-"`
|
|
}
|
|
|
|
type instanceCacheIndex uint8
|
|
|
|
const (
|
|
instanceCacheIndexUndefined instanceCacheIndex = iota
|
|
instanceCacheIndexID
|
|
)
|
|
|
|
// Keys implements the [cache.Entry].
|
|
func (i *Instance) Keys(index instanceCacheIndex) (key []string) {
|
|
if index == instanceCacheIndexID {
|
|
return []string{i.ID}
|
|
}
|
|
return nil
|
|
}
|
|
|
|
var _ cache.Entry[instanceCacheIndex, string] = (*Instance)(nil)
|
|
|
|
// instanceColumns define all the columns of the instance table.
|
|
type instanceColumns interface {
|
|
// IDColumn returns the column for the id field.
|
|
IDColumn() database.Column
|
|
// NameColumn returns the column for the name field.
|
|
NameColumn() database.Column
|
|
// DefaultOrgIDColumn returns the column for the default org id field
|
|
DefaultOrgIDColumn() database.Column
|
|
// IAMProjectIDColumn returns the column for the default IAM org id field
|
|
IAMProjectIDColumn() database.Column
|
|
// ConsoleClientIDColumn returns the column for the default IAM org id field
|
|
ConsoleClientIDColumn() database.Column
|
|
// ConsoleAppIDColumn returns the column for the console client id field
|
|
ConsoleAppIDColumn() database.Column
|
|
// DefaultLanguageColumn returns the column for the default language field
|
|
DefaultLanguageColumn() database.Column
|
|
// CreatedAtColumn returns the column for the created at field.
|
|
CreatedAtColumn() database.Column
|
|
// UpdatedAtColumn returns the column for the updated at field.
|
|
UpdatedAtColumn() database.Column
|
|
}
|
|
|
|
// instanceConditions define all the conditions for the instance table.
|
|
type instanceConditions interface {
|
|
// PrimaryKeyCondition returns a filter on the primary key fields.
|
|
PrimaryKeyCondition(instanceID string) database.Condition
|
|
// IDCondition returns an equal filter on the id field.
|
|
IDCondition(instanceID string) database.Condition
|
|
// NameCondition returns a filter on the name field.
|
|
NameCondition(op database.TextOperation, name string) database.Condition
|
|
// ExistsDomain returns a filter on the instance domains.
|
|
ExistsDomain(cond database.Condition) database.Condition
|
|
}
|
|
|
|
// instanceChanges define all the changes for the instance table.
|
|
type instanceChanges interface {
|
|
// SetName sets the name column.
|
|
SetName(name string) database.Change
|
|
// SetUpdatedAt sets the updated at column.
|
|
SetUpdatedAt(time time.Time) database.Change
|
|
// SetIAMProject sets the iam project column.
|
|
SetIAMProject(id string) database.Change
|
|
// SetDefaultOrg sets the default org column.
|
|
SetDefaultOrg(id string) database.Change
|
|
// SetDefaultLanguage sets the default language column.
|
|
SetDefaultLanguage(language language.Tag) database.Change
|
|
// SetConsoleClientID sets the console client id column.
|
|
SetConsoleClientID(id string) database.Change
|
|
// SetConsoleAppID sets the console app id column.
|
|
SetConsoleAppID(id string) database.Change
|
|
}
|
|
|
|
// InstanceRepository is the interface for the instance repository.
|
|
type InstanceRepository interface {
|
|
Repository
|
|
|
|
instanceColumns
|
|
instanceConditions
|
|
instanceChanges
|
|
|
|
// TODO
|
|
// Member returns the member repository which is a sub repository of the instance repository.
|
|
// Member() MemberRepository
|
|
|
|
Get(ctx context.Context, client database.QueryExecutor, opts ...database.QueryOption) (*Instance, error)
|
|
List(ctx context.Context, client database.QueryExecutor, opts ...database.QueryOption) ([]*Instance, error)
|
|
|
|
Create(ctx context.Context, client database.QueryExecutor, instance *Instance) error
|
|
Update(ctx context.Context, client database.QueryExecutor, id string, changes ...database.Change) (int64, error)
|
|
Delete(ctx context.Context, client database.QueryExecutor, id string) (int64, error)
|
|
|
|
// LoadDomains loads the domains of the given instance.
|
|
// If it is called the [Instance].Domains field will be set on future calls to Get or List.
|
|
LoadDomains() InstanceRepository
|
|
}
|
|
|
|
type CreateInstance struct {
|
|
Name string `json:"name"`
|
|
}
|