zitadel/internal/query/restrictions.go
Silvan 4df138286b
perf(query): reduce user query duration (#10037)
# Which Problems Are Solved

The resource usage to query user(s) on the database was high and
therefore could have performance impact.

# How the Problems Are Solved

Database queries involving the users and loginnames table were improved
and an index was added for user by email query.

# Additional Changes

- spellchecks
- updated apis on load tests

# additional info

needs cherry pick to v3
2025-06-06 08:48:29 +00:00

123 lines
3.7 KiB
Go

package query
import (
"context"
"database/sql"
"errors"
"time"
sq "github.com/Masterminds/squirrel"
"golang.org/x/text/language"
"github.com/zitadel/zitadel/internal/api/authz"
"github.com/zitadel/zitadel/internal/database"
"github.com/zitadel/zitadel/internal/domain"
"github.com/zitadel/zitadel/internal/query/projection"
"github.com/zitadel/zitadel/internal/telemetry/tracing"
zitade_errors "github.com/zitadel/zitadel/internal/zerrors"
)
var (
restrictionsTable = table{
name: projection.RestrictionsProjectionTable,
instanceIDCol: projection.RestrictionsColumnInstanceID,
}
RestrictionsColumnAggregateID = Column{
name: projection.RestrictionsColumnAggregateID,
table: restrictionsTable,
}
RestrictionsColumnCreationDate = Column{
name: projection.RestrictionsColumnCreationDate,
table: restrictionsTable,
}
RestrictionsColumnChangeDate = Column{
name: projection.RestrictionsColumnChangeDate,
table: restrictionsTable,
}
RestrictionsColumnResourceOwner = Column{
name: projection.RestrictionsColumnResourceOwner,
table: restrictionsTable,
}
RestrictionsColumnInstanceID = Column{
name: projection.RestrictionsColumnInstanceID,
table: restrictionsTable,
}
RestrictionsColumnSequence = Column{
name: projection.RestrictionsColumnSequence,
table: restrictionsTable,
}
RestrictionsColumnDisallowPublicOrgRegistration = Column{
name: projection.RestrictionsColumnDisallowPublicOrgRegistration,
table: restrictionsTable,
}
RestrictionsColumnAllowedLanguages = Column{
name: projection.RestrictionsColumnAllowedLanguages,
table: restrictionsTable,
}
)
type Restrictions struct {
AggregateID string
CreationDate time.Time
ChangeDate time.Time
ResourceOwner string
Sequence uint64
DisallowPublicOrgRegistration bool
AllowedLanguages []language.Tag
}
func (q *Queries) GetInstanceRestrictions(ctx context.Context) (restrictions Restrictions, err error) {
ctx, span := tracing.NewSpan(ctx)
defer func() { span.EndWithError(err) }()
stmt, scan := prepareRestrictionsQuery()
instanceID := authz.GetInstance(ctx).InstanceID()
query, args, err := stmt.Where(sq.Eq{
RestrictionsColumnInstanceID.identifier(): instanceID,
RestrictionsColumnResourceOwner.identifier(): instanceID,
}).ToSql()
if err != nil {
return restrictions, zitade_errors.ThrowInternal(err, "QUERY-XnLMQ", "Errors.Query.SQLStatement")
}
err = q.client.QueryRowContext(ctx, func(row *sql.Row) error {
restrictions, err = scan(row)
return err
}, query, args...)
if errors.Is(err, sql.ErrNoRows) {
// not found is not an error
err = nil
}
return restrictions, err
}
func prepareRestrictionsQuery() (sq.SelectBuilder, func(*sql.Row) (Restrictions, error)) {
return sq.Select(
RestrictionsColumnAggregateID.identifier(),
RestrictionsColumnCreationDate.identifier(),
RestrictionsColumnChangeDate.identifier(),
RestrictionsColumnResourceOwner.identifier(),
RestrictionsColumnSequence.identifier(),
RestrictionsColumnDisallowPublicOrgRegistration.identifier(),
RestrictionsColumnAllowedLanguages.identifier(),
).
From(restrictionsTable.identifier()).
PlaceholderFormat(sq.Dollar),
func(row *sql.Row) (restrictions Restrictions, err error) {
allowedLanguages := database.TextArray[string](make([]string, 0))
disallowPublicOrgRegistration := sql.NullBool{}
err = row.Scan(
&restrictions.AggregateID,
&restrictions.CreationDate,
&restrictions.ChangeDate,
&restrictions.ResourceOwner,
&restrictions.Sequence,
&disallowPublicOrgRegistration,
&allowedLanguages,
)
restrictions.DisallowPublicOrgRegistration = disallowPublicOrgRegistration.Bool
restrictions.AllowedLanguages = domain.StringsToLanguages(allowedLanguages)
return restrictions, err
}
}