zitadel/internal/query/target.go
Elio Bischof 042c438813
feat(v3alpha): read actions (#8357)
# Which Problems Are Solved

The current v3alpha actions APIs don't exactly adhere to the [new
resources API
design](https://zitadel.com/docs/apis/v3#standard-resources).

# How the Problems Are Solved

- **Improved ID access**: The aggregate ID is added to the resource
details object, so accessing resource IDs and constructing proto
messages for resources is easier
- **Explicit Instances**: Optionally, the instance can be explicitly
given in each request
- **Pagination**: A default search limit and a max search limit are
added to the defaults.yaml. They apply to the new v3 APIs (currently
only actions). The search query defaults are changed to ascending by
creation date, because this makes the pagination results the most
deterministic. The creation date is also added to the object details.
The bug with updated creation dates is fixed for executions and targets.
- **Removed Sequences**: Removed Sequence from object details and
ProcessedSequence from search details

# Additional Changes

Object details IDs are checked in unit test only if an empty ID is
expected. Centralizing the details check also makes this internal object
more flexible for future evolutions.

# Additional Context

- Closes #8169 
- Depends on https://github.com/zitadel/zitadel/pull/8225

---------

Co-authored-by: Silvan <silvan.reusser@gmail.com>
Co-authored-by: Stefan Benz <46600784+stebenz@users.noreply.github.com>
2024-08-12 22:32:01 +02:00

206 lines
5.3 KiB
Go

package query
import (
"context"
"database/sql"
"errors"
"time"
sq "github.com/Masterminds/squirrel"
"github.com/zitadel/zitadel/internal/api/authz"
"github.com/zitadel/zitadel/internal/domain"
"github.com/zitadel/zitadel/internal/query/projection"
"github.com/zitadel/zitadel/internal/zerrors"
)
var (
targetTable = table{
name: projection.TargetTable,
instanceIDCol: projection.TargetInstanceIDCol,
}
TargetColumnID = Column{
name: projection.TargetIDCol,
table: targetTable,
}
TargetColumnCreationDate = Column{
name: projection.TargetCreationDateCol,
table: targetTable,
}
TargetColumnChangeDate = Column{
name: projection.TargetChangeDateCol,
table: targetTable,
}
TargetColumnResourceOwner = Column{
name: projection.TargetResourceOwnerCol,
table: targetTable,
}
TargetColumnInstanceID = Column{
name: projection.TargetInstanceIDCol,
table: targetTable,
}
TargetColumnName = Column{
name: projection.TargetNameCol,
table: targetTable,
}
TargetColumnTargetType = Column{
name: projection.TargetTargetType,
table: targetTable,
}
TargetColumnURL = Column{
name: projection.TargetEndpointCol,
table: targetTable,
}
TargetColumnTimeout = Column{
name: projection.TargetTimeoutCol,
table: targetTable,
}
TargetColumnInterruptOnError = Column{
name: projection.TargetInterruptOnErrorCol,
table: targetTable,
}
)
type Targets struct {
SearchResponse
Targets []*Target
}
func (t *Targets) SetState(s *State) {
t.State = s
}
type Target struct {
domain.ObjectDetails
Name string
TargetType domain.TargetType
Endpoint string
Timeout time.Duration
InterruptOnError bool
}
type TargetSearchQueries struct {
SearchRequest
Queries []SearchQuery
}
func (q *TargetSearchQueries) toQuery(query sq.SelectBuilder) sq.SelectBuilder {
query = q.SearchRequest.toQuery(query)
for _, q := range q.Queries {
query = q.toQuery(query)
}
return query
}
func (q *Queries) SearchTargets(ctx context.Context, queries *TargetSearchQueries) (targets *Targets, err error) {
eq := sq.Eq{
TargetColumnInstanceID.identifier(): authz.GetInstance(ctx).InstanceID(),
}
query, scan := prepareTargetsQuery(ctx, q.client)
return genericRowsQueryWithState[*Targets](ctx, q.client, targetTable, combineToWhereStmt(query, queries.toQuery, eq), scan)
}
func (q *Queries) GetTargetByID(ctx context.Context, id string) (target *Target, err error) {
eq := sq.Eq{
TargetColumnID.identifier(): id,
TargetColumnInstanceID.identifier(): authz.GetInstance(ctx).InstanceID(),
}
query, scan := prepareTargetQuery(ctx, q.client)
return genericRowQuery[*Target](ctx, q.client, query.Where(eq), scan)
}
func NewTargetNameSearchQuery(method TextComparison, value string) (SearchQuery, error) {
return NewTextQuery(TargetColumnName, value, method)
}
func NewTargetInIDsSearchQuery(values []string) (SearchQuery, error) {
return NewInTextQuery(TargetColumnID, values)
}
func prepareTargetsQuery(context.Context, prepareDatabase) (sq.SelectBuilder, func(rows *sql.Rows) (*Targets, error)) {
return sq.Select(
TargetColumnID.identifier(),
TargetColumnCreationDate.identifier(),
TargetColumnChangeDate.identifier(),
TargetColumnResourceOwner.identifier(),
TargetColumnName.identifier(),
TargetColumnTargetType.identifier(),
TargetColumnTimeout.identifier(),
TargetColumnURL.identifier(),
TargetColumnInterruptOnError.identifier(),
countColumn.identifier(),
).From(targetTable.identifier()).
PlaceholderFormat(sq.Dollar),
func(rows *sql.Rows) (*Targets, error) {
targets := make([]*Target, 0)
var count uint64
for rows.Next() {
target := new(Target)
err := rows.Scan(
&target.ID,
&target.CreationDate,
&target.EventDate,
&target.ResourceOwner,
&target.Name,
&target.TargetType,
&target.Timeout,
&target.Endpoint,
&target.InterruptOnError,
&count,
)
if err != nil {
return nil, err
}
targets = append(targets, target)
}
if err := rows.Close(); err != nil {
return nil, zerrors.ThrowInternal(err, "QUERY-fzwi6cgxos", "Errors.Query.CloseRows")
}
return &Targets{
Targets: targets,
SearchResponse: SearchResponse{
Count: count,
},
}, nil
}
}
func prepareTargetQuery(context.Context, prepareDatabase) (sq.SelectBuilder, func(row *sql.Row) (*Target, error)) {
return sq.Select(
TargetColumnID.identifier(),
TargetColumnCreationDate.identifier(),
TargetColumnChangeDate.identifier(),
TargetColumnResourceOwner.identifier(),
TargetColumnName.identifier(),
TargetColumnTargetType.identifier(),
TargetColumnTimeout.identifier(),
TargetColumnURL.identifier(),
TargetColumnInterruptOnError.identifier(),
).From(targetTable.identifier()).
PlaceholderFormat(sq.Dollar),
func(row *sql.Row) (*Target, error) {
target := new(Target)
err := row.Scan(
&target.ID,
&target.CreationDate,
&target.EventDate,
&target.ResourceOwner,
&target.Name,
&target.TargetType,
&target.Timeout,
&target.Endpoint,
&target.InterruptOnError,
)
if err != nil {
if errors.Is(err, sql.ErrNoRows) {
return nil, zerrors.ThrowNotFound(err, "QUERY-hj5oaniyrz", "Errors.Target.NotFound")
}
return nil, zerrors.ThrowInternal(err, "QUERY-5qhc19sc49", "Errors.Internal")
}
return target, nil
}
}