mirror of
https://github.com/zitadel/zitadel.git
synced 2025-12-24 03:36:46 +00:00
This pull request fixes an issue where the repository would fail to scan organization or instance structs if the `domains` column was `NULL`. ## Which problems are solved If the `domains` column of `orgs` or `instances` was `NULL`, the repository failed scanning into the structs. This happened because the scanning mechanism did not correctly handle `NULL` JSONB columns. ## How the problems are solved A new generic type `JSONArray[T]` is introduced, which implements the `sql.Scanner` interface. This type can correctly scan JSON arrays from the database, including handling `NULL` values gracefully. The repositories for instances and organizations have been updated to use this new type for the domains field. The SQL queries have also been improved to use `FILTER` with `jsonb_agg` for better readability and performance when aggregating domains. ## Additional changes * An unnecessary cleanup step in the organization domain tests for already removed domains has been removed. * The `pgxscan` library has been replaced with `sqlscan` for scanning `database/sql`.Rows. * Minor cleanups in integration tests.
301 lines
9.5 KiB
Go
301 lines
9.5 KiB
Go
package repository
|
|
|
|
import (
|
|
"context"
|
|
"time"
|
|
|
|
"golang.org/x/text/language"
|
|
|
|
"github.com/zitadel/zitadel/backend/v3/domain"
|
|
"github.com/zitadel/zitadel/backend/v3/storage/database"
|
|
)
|
|
|
|
var _ domain.InstanceRepository = (*instance)(nil)
|
|
|
|
type instance struct {
|
|
repository
|
|
shouldLoadDomains bool
|
|
domainRepo *instanceDomain
|
|
}
|
|
|
|
func InstanceRepository(client database.QueryExecutor) domain.InstanceRepository {
|
|
return &instance{
|
|
repository: repository{
|
|
client: client,
|
|
},
|
|
}
|
|
}
|
|
|
|
// -------------------------------------------------------------
|
|
// repository
|
|
// -------------------------------------------------------------
|
|
|
|
const (
|
|
queryInstanceStmt = `SELECT instances.id, instances.name, instances.default_org_id, instances.iam_project_id, instances.console_client_id, instances.console_app_id, instances.default_language, instances.created_at, instances.updated_at` +
|
|
` , jsonb_agg(json_build_object('domain', instance_domains.domain, 'isPrimary', instance_domains.is_primary, 'isGenerated', instance_domains.is_generated, 'createdAt', instance_domains.created_at, 'updatedAt', instance_domains.updated_at)) FILTER (WHERE instance_domains.instance_id IS NOT NULL) AS domains` +
|
|
` FROM zitadel.instances`
|
|
)
|
|
|
|
// Get implements [domain.InstanceRepository].
|
|
func (i *instance) Get(ctx context.Context, opts ...database.QueryOption) (*domain.Instance, error) {
|
|
opts = append(opts,
|
|
i.joinDomains(),
|
|
database.WithGroupBy(i.IDColumn()),
|
|
)
|
|
|
|
options := new(database.QueryOpts)
|
|
for _, opt := range opts {
|
|
opt(options)
|
|
}
|
|
|
|
var builder database.StatementBuilder
|
|
builder.WriteString(queryInstanceStmt)
|
|
options.Write(&builder)
|
|
|
|
return scanInstance(ctx, i.client, &builder)
|
|
}
|
|
|
|
// List implements [domain.InstanceRepository].
|
|
func (i *instance) List(ctx context.Context, opts ...database.QueryOption) ([]*domain.Instance, error) {
|
|
opts = append(opts,
|
|
i.joinDomains(),
|
|
database.WithGroupBy(i.IDColumn()),
|
|
)
|
|
|
|
options := new(database.QueryOpts)
|
|
for _, opt := range opts {
|
|
opt(options)
|
|
}
|
|
|
|
var builder database.StatementBuilder
|
|
builder.WriteString(queryInstanceStmt)
|
|
options.Write(&builder)
|
|
|
|
return scanInstances(ctx, i.client, &builder)
|
|
}
|
|
|
|
func (i *instance) joinDomains() database.QueryOption {
|
|
columns := make([]database.Condition, 0, 2)
|
|
columns = append(columns, database.NewColumnCondition(i.IDColumn(), i.Domains(false).InstanceIDColumn()))
|
|
|
|
// If domains should not be joined, we make sure to return null for the domain columns
|
|
// the query optimizer of the dialect should optimize this away if no domains are requested
|
|
if !i.shouldLoadDomains {
|
|
columns = append(columns, database.IsNull(i.Domains(false).InstanceIDColumn()))
|
|
}
|
|
|
|
return database.WithLeftJoin(
|
|
"zitadel.instance_domains",
|
|
database.And(columns...),
|
|
)
|
|
}
|
|
|
|
// Create implements [domain.InstanceRepository].
|
|
func (i *instance) Create(ctx context.Context, instance *domain.Instance) error {
|
|
var (
|
|
builder database.StatementBuilder
|
|
createdAt, updatedAt any = database.DefaultInstruction, database.DefaultInstruction
|
|
)
|
|
if !instance.CreatedAt.IsZero() {
|
|
createdAt = instance.CreatedAt
|
|
}
|
|
if !instance.UpdatedAt.IsZero() {
|
|
updatedAt = instance.UpdatedAt
|
|
}
|
|
|
|
builder.WriteString(`INSERT INTO zitadel.instances (id, name, default_org_id, iam_project_id, console_client_id, console_app_id, default_language, created_at, updated_at) VALUES (`)
|
|
builder.WriteArgs(instance.ID, instance.Name, instance.DefaultOrgID, instance.IAMProjectID, instance.ConsoleClientID, instance.ConsoleAppID, instance.DefaultLanguage, createdAt, updatedAt)
|
|
builder.WriteString(`) RETURNING created_at, updated_at`)
|
|
|
|
return i.client.QueryRow(ctx, builder.String(), builder.Args()...).Scan(&instance.CreatedAt, &instance.UpdatedAt)
|
|
}
|
|
|
|
// Update implements [domain.InstanceRepository].
|
|
func (i instance) Update(ctx context.Context, id string, changes ...database.Change) (int64, error) {
|
|
if len(changes) == 0 {
|
|
return 0, database.ErrNoChanges
|
|
}
|
|
var builder database.StatementBuilder
|
|
|
|
builder.WriteString(`UPDATE zitadel.instances SET `)
|
|
|
|
database.Changes(changes).Write(&builder)
|
|
|
|
idCondition := i.IDCondition(id)
|
|
writeCondition(&builder, idCondition)
|
|
|
|
stmt := builder.String()
|
|
|
|
return i.client.Exec(ctx, stmt, builder.Args()...)
|
|
}
|
|
|
|
// Delete implements [domain.InstanceRepository].
|
|
func (i instance) Delete(ctx context.Context, id string) (int64, error) {
|
|
var builder database.StatementBuilder
|
|
|
|
builder.WriteString(`DELETE FROM zitadel.instances`)
|
|
|
|
idCondition := i.IDCondition(id)
|
|
writeCondition(&builder, idCondition)
|
|
|
|
return i.client.Exec(ctx, builder.String(), builder.Args()...)
|
|
}
|
|
|
|
// -------------------------------------------------------------
|
|
// changes
|
|
// -------------------------------------------------------------
|
|
|
|
// SetName implements [domain.instanceChanges].
|
|
func (i instance) SetName(name string) database.Change {
|
|
return database.NewChange(i.NameColumn(), name)
|
|
}
|
|
|
|
// SetUpdatedAt implements [domain.instanceChanges].
|
|
func (i instance) SetUpdatedAt(time time.Time) database.Change {
|
|
return database.NewChange(i.UpdatedAtColumn(), time)
|
|
}
|
|
|
|
func (i instance) SetIAMProject(id string) database.Change {
|
|
return database.NewChange(i.IAMProjectIDColumn(), id)
|
|
}
|
|
func (i instance) SetDefaultOrg(id string) database.Change {
|
|
return database.NewChange(i.DefaultOrgIDColumn(), id)
|
|
}
|
|
func (i instance) SetDefaultLanguage(lang language.Tag) database.Change {
|
|
return database.NewChange(i.DefaultLanguageColumn(), lang.String())
|
|
}
|
|
func (i instance) SetConsoleClientID(id string) database.Change {
|
|
return database.NewChange(i.ConsoleClientIDColumn(), id)
|
|
}
|
|
func (i instance) SetConsoleAppID(id string) database.Change {
|
|
return database.NewChange(i.ConsoleAppIDColumn(), id)
|
|
}
|
|
|
|
// -------------------------------------------------------------
|
|
// conditions
|
|
// -------------------------------------------------------------
|
|
|
|
// IDCondition implements [domain.instanceConditions].
|
|
func (i instance) IDCondition(id string) database.Condition {
|
|
return database.NewTextCondition(i.IDColumn(), database.TextOperationEqual, id)
|
|
}
|
|
|
|
// NameCondition implements [domain.instanceConditions].
|
|
func (i instance) NameCondition(op database.TextOperation, name string) database.Condition {
|
|
return database.NewTextCondition(i.NameColumn(), op, name)
|
|
}
|
|
|
|
// -------------------------------------------------------------
|
|
// columns
|
|
// -------------------------------------------------------------
|
|
|
|
// IDColumn implements [domain.instanceColumns].
|
|
func (instance) IDColumn() database.Column {
|
|
return database.NewColumn("instances", "id")
|
|
}
|
|
|
|
// NameColumn implements [domain.instanceColumns].
|
|
func (instance) NameColumn() database.Column {
|
|
return database.NewColumn("instances", "name")
|
|
}
|
|
|
|
// CreatedAtColumn implements [domain.instanceColumns].
|
|
func (instance) CreatedAtColumn() database.Column {
|
|
return database.NewColumn("instances", "created_at")
|
|
}
|
|
|
|
// DefaultOrgIdColumn implements [domain.instanceColumns].
|
|
func (instance) DefaultOrgIDColumn() database.Column {
|
|
return database.NewColumn("instances", "default_org_id")
|
|
}
|
|
|
|
// IAMProjectIDColumn implements [domain.instanceColumns].
|
|
func (instance) IAMProjectIDColumn() database.Column {
|
|
return database.NewColumn("instances", "iam_project_id")
|
|
}
|
|
|
|
// ConsoleClientIDColumn implements [domain.instanceColumns].
|
|
func (instance) ConsoleClientIDColumn() database.Column {
|
|
return database.NewColumn("instances", "console_client_id")
|
|
}
|
|
|
|
// ConsoleAppIDColumn implements [domain.instanceColumns].
|
|
func (instance) ConsoleAppIDColumn() database.Column {
|
|
return database.NewColumn("instances", "console_app_id")
|
|
}
|
|
|
|
// DefaultLanguageColumn implements [domain.instanceColumns].
|
|
func (instance) DefaultLanguageColumn() database.Column {
|
|
return database.NewColumn("instances", "default_language")
|
|
}
|
|
|
|
// UpdatedAtColumn implements [domain.instanceColumns].
|
|
func (instance) UpdatedAtColumn() database.Column {
|
|
return database.NewColumn("instances", "updated_at")
|
|
}
|
|
|
|
// -------------------------------------------------------------
|
|
// scanners
|
|
// -------------------------------------------------------------
|
|
|
|
type rawInstance struct {
|
|
*domain.Instance
|
|
Domains JSONArray[domain.InstanceDomain] `json:"domains,omitempty" db:"domains"`
|
|
}
|
|
|
|
func scanInstance(ctx context.Context, querier database.Querier, builder *database.StatementBuilder) (*domain.Instance, error) {
|
|
rows, err := querier.Query(ctx, builder.String(), builder.Args()...)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
var instance rawInstance
|
|
if err := rows.(database.CollectableRows).CollectExactlyOneRow(&instance); err != nil {
|
|
return nil, err
|
|
}
|
|
instance.Instance.Domains = instance.Domains
|
|
|
|
return instance.Instance, nil
|
|
}
|
|
|
|
func scanInstances(ctx context.Context, querier database.Querier, builder *database.StatementBuilder) ([]*domain.Instance, error) {
|
|
rows, err := querier.Query(ctx, builder.String(), builder.Args()...)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
var instances []*rawInstance
|
|
if err := rows.(database.CollectableRows).Collect(&instances); err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
result := make([]*domain.Instance, len(instances))
|
|
for i, inst := range instances {
|
|
result[i] = inst.Instance
|
|
result[i].Domains = inst.Domains
|
|
}
|
|
|
|
return result, nil
|
|
}
|
|
|
|
// -------------------------------------------------------------
|
|
// sub repositories
|
|
// -------------------------------------------------------------
|
|
|
|
// Domains implements [domain.InstanceRepository].
|
|
func (i *instance) Domains(shouldLoad bool) domain.InstanceDomainRepository {
|
|
if !i.shouldLoadDomains {
|
|
i.shouldLoadDomains = shouldLoad
|
|
}
|
|
|
|
if i.domainRepo != nil {
|
|
return i.domainRepo
|
|
}
|
|
|
|
i.domainRepo = &instanceDomain{
|
|
repository: i.repository,
|
|
instance: i,
|
|
}
|
|
return i.domainRepo
|
|
}
|