mirror of
https://github.com/zitadel/zitadel.git
synced 2024-12-15 04:18:01 +00:00
042c438813
# 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>
270 lines
6.9 KiB
Go
270 lines
6.9 KiB
Go
package query
|
|
|
|
import (
|
|
"database/sql"
|
|
"database/sql/driver"
|
|
"errors"
|
|
"fmt"
|
|
"regexp"
|
|
"testing"
|
|
|
|
"github.com/zitadel/zitadel/internal/domain"
|
|
exec "github.com/zitadel/zitadel/internal/repository/execution"
|
|
"github.com/zitadel/zitadel/internal/zerrors"
|
|
)
|
|
|
|
var (
|
|
prepareExecutionsStmt = `SELECT projections.executions1.instance_id,` +
|
|
` projections.executions1.id,` +
|
|
` projections.executions1.creation_date,` +
|
|
` projections.executions1.change_date,` +
|
|
` execution_targets.targets,` +
|
|
` COUNT(*) OVER ()` +
|
|
` FROM projections.executions1` +
|
|
` JOIN (` +
|
|
`SELECT instance_id, execution_id, JSONB_AGG( JSON_OBJECT( 'position' : position, 'include' : include, 'target' : target_id ) ) as targets` +
|
|
` FROM projections.executions1_targets` +
|
|
` GROUP BY instance_id, execution_id` +
|
|
`)` +
|
|
` AS execution_targets` +
|
|
` ON execution_targets.instance_id = projections.executions1.instance_id` +
|
|
` AND execution_targets.execution_id = projections.executions1.id`
|
|
prepareExecutionsCols = []string{
|
|
"instance_id",
|
|
"id",
|
|
"creation_date",
|
|
"change_date",
|
|
"targets",
|
|
"count",
|
|
}
|
|
|
|
prepareExecutionStmt = `SELECT projections.executions1.instance_id,` +
|
|
` projections.executions1.id,` +
|
|
` projections.executions1.creation_date,` +
|
|
` projections.executions1.change_date,` +
|
|
` execution_targets.targets` +
|
|
` FROM projections.executions1` +
|
|
` JOIN (` +
|
|
`SELECT instance_id, execution_id, JSONB_AGG( JSON_OBJECT( 'position' : position, 'include' : include, 'target' : target_id ) ) as targets` +
|
|
` FROM projections.executions1_targets` +
|
|
` GROUP BY instance_id, execution_id` +
|
|
`)` +
|
|
` AS execution_targets` +
|
|
` ON execution_targets.instance_id = projections.executions1.instance_id` +
|
|
` AND execution_targets.execution_id = projections.executions1.id`
|
|
prepareExecutionCols = []string{
|
|
"instance_id",
|
|
"id",
|
|
"creation_date",
|
|
"change_date",
|
|
"targets",
|
|
}
|
|
)
|
|
|
|
func Test_ExecutionPrepares(t *testing.T) {
|
|
type want struct {
|
|
sqlExpectations sqlExpectation
|
|
err checkErr
|
|
}
|
|
tests := []struct {
|
|
name string
|
|
prepare interface{}
|
|
want want
|
|
object interface{}
|
|
}{
|
|
{
|
|
name: "prepareExecutionsQuery no result",
|
|
prepare: prepareExecutionsQuery,
|
|
want: want{
|
|
sqlExpectations: mockQueries(
|
|
regexp.QuoteMeta(prepareExecutionsStmt),
|
|
nil,
|
|
nil,
|
|
),
|
|
},
|
|
object: &Executions{Executions: []*Execution{}},
|
|
},
|
|
{
|
|
name: "prepareExecutionsQuery one result",
|
|
prepare: prepareExecutionsQuery,
|
|
want: want{
|
|
sqlExpectations: mockQueries(
|
|
regexp.QuoteMeta(prepareExecutionsStmt),
|
|
prepareExecutionsCols,
|
|
[][]driver.Value{
|
|
{
|
|
"ro",
|
|
"id",
|
|
testNow,
|
|
testNow,
|
|
[]byte(`[{"position" : 1, "target" : "target"}, {"position" : 2, "include" : "include"}]`),
|
|
},
|
|
},
|
|
),
|
|
},
|
|
object: &Executions{
|
|
SearchResponse: SearchResponse{
|
|
Count: 1,
|
|
},
|
|
Executions: []*Execution{
|
|
{
|
|
ObjectDetails: domain.ObjectDetails{
|
|
EventDate: testNow,
|
|
CreationDate: testNow,
|
|
ResourceOwner: "ro",
|
|
ID: "id",
|
|
},
|
|
Targets: []*exec.Target{
|
|
{Type: domain.ExecutionTargetTypeTarget, Target: "target"},
|
|
{Type: domain.ExecutionTargetTypeInclude, Target: "include"},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
{
|
|
name: "prepareExecutionsQuery multiple result",
|
|
prepare: prepareExecutionsQuery,
|
|
want: want{
|
|
sqlExpectations: mockQueries(
|
|
regexp.QuoteMeta(prepareExecutionsStmt),
|
|
prepareExecutionsCols,
|
|
[][]driver.Value{
|
|
{
|
|
"ro",
|
|
"id-1",
|
|
testNow,
|
|
testNow,
|
|
[]byte(`[{"position" : 1, "target" : "target"}, {"position" : 2, "include" : "include"}]`),
|
|
},
|
|
{
|
|
"ro",
|
|
"id-2",
|
|
testNow,
|
|
testNow,
|
|
[]byte(`[{"position" : 2, "target" : "target"}, {"position" : 1, "include" : "include"}]`),
|
|
},
|
|
},
|
|
),
|
|
},
|
|
object: &Executions{
|
|
SearchResponse: SearchResponse{
|
|
Count: 2,
|
|
},
|
|
Executions: []*Execution{
|
|
{
|
|
ObjectDetails: domain.ObjectDetails{
|
|
ID: "id-1",
|
|
EventDate: testNow,
|
|
CreationDate: testNow,
|
|
ResourceOwner: "ro",
|
|
},
|
|
Targets: []*exec.Target{
|
|
{Type: domain.ExecutionTargetTypeTarget, Target: "target"},
|
|
{Type: domain.ExecutionTargetTypeInclude, Target: "include"},
|
|
},
|
|
},
|
|
{
|
|
ObjectDetails: domain.ObjectDetails{
|
|
ID: "id-2",
|
|
EventDate: testNow,
|
|
CreationDate: testNow,
|
|
ResourceOwner: "ro",
|
|
},
|
|
Targets: []*exec.Target{
|
|
{Type: domain.ExecutionTargetTypeInclude, Target: "include"},
|
|
{Type: domain.ExecutionTargetTypeTarget, Target: "target"},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
{
|
|
name: "prepareExecutionsQuery sql err",
|
|
prepare: prepareExecutionsQuery,
|
|
want: want{
|
|
sqlExpectations: mockQueryErr(
|
|
regexp.QuoteMeta(prepareExecutionsStmt),
|
|
sql.ErrConnDone,
|
|
),
|
|
err: func(err error) (error, bool) {
|
|
if !errors.Is(err, sql.ErrConnDone) {
|
|
return fmt.Errorf("err should be sql.ErrConnDone got: %w", err), false
|
|
}
|
|
return nil, true
|
|
},
|
|
},
|
|
object: (*Execution)(nil),
|
|
},
|
|
{
|
|
name: "prepareExecutionQuery no result",
|
|
prepare: prepareExecutionQuery,
|
|
want: want{
|
|
sqlExpectations: mockQueriesScanErr(
|
|
regexp.QuoteMeta(prepareExecutionStmt),
|
|
nil,
|
|
nil,
|
|
),
|
|
err: func(err error) (error, bool) {
|
|
if !zerrors.IsNotFound(err) {
|
|
return fmt.Errorf("err should be zitadel.NotFoundError got: %w", err), false
|
|
}
|
|
return nil, true
|
|
},
|
|
},
|
|
object: (*Execution)(nil),
|
|
},
|
|
{
|
|
name: "prepareExecutionQuery found",
|
|
prepare: prepareExecutionQuery,
|
|
want: want{
|
|
sqlExpectations: mockQuery(
|
|
regexp.QuoteMeta(prepareExecutionStmt),
|
|
prepareExecutionCols,
|
|
[]driver.Value{
|
|
"ro",
|
|
"id",
|
|
testNow,
|
|
testNow,
|
|
[]byte(`[{"position" : 1, "target" : "target"}, {"position" : 2, "include" : "include"}]`),
|
|
},
|
|
),
|
|
},
|
|
object: &Execution{
|
|
ObjectDetails: domain.ObjectDetails{
|
|
ID: "id",
|
|
EventDate: testNow,
|
|
CreationDate: testNow,
|
|
ResourceOwner: "ro",
|
|
},
|
|
Targets: []*exec.Target{
|
|
{Type: domain.ExecutionTargetTypeTarget, Target: "target"},
|
|
{Type: domain.ExecutionTargetTypeInclude, Target: "include"},
|
|
},
|
|
},
|
|
},
|
|
{
|
|
name: "prepareExecutionQuery sql err",
|
|
prepare: prepareExecutionQuery,
|
|
want: want{
|
|
sqlExpectations: mockQueryErr(
|
|
regexp.QuoteMeta(prepareExecutionStmt),
|
|
sql.ErrConnDone,
|
|
),
|
|
err: func(err error) (error, bool) {
|
|
if !errors.Is(err, sql.ErrConnDone) {
|
|
return fmt.Errorf("err should be sql.ErrConnDone got: %w", err), false
|
|
}
|
|
return nil, true
|
|
},
|
|
},
|
|
object: (*Execution)(nil),
|
|
},
|
|
}
|
|
for _, tt := range tests {
|
|
t.Run(tt.name, func(t *testing.T) {
|
|
assertPrepare(t, tt.prepare, tt.object, tt.want.sqlExpectations, tt.want.err, defaultPrepareArgs...)
|
|
})
|
|
}
|
|
}
|