mirror of
https://github.com/zitadel/zitadel.git
synced 2025-12-23 17:46:44 +00:00
# Which Problems Are Solved The event execution system currently uses a projection handler that subscribes to and processes all events for all instances. This creates a high static cost because the system over-fetches event data, handling many events that are not needed by most instances. This inefficiency is also reflected in high "rows returned" metrics in the database. # How the Problems Are Solved Eliminate the use of a project handler. Instead, events for which "execution targets" are defined, are directly pushed to the queue by the eventstore. A Router is populated in the Instance object in the authz middleware. - By joining the execution targets to the instance, no additional queries are needed anymore. - As part of the instance object, execution targets are now cached as well. - Events are queued within the same transaction, giving transactional guarantees on delivery. - Uses the "insert many fast` variant of River. Multiple jobs are queued in a single round-trip to the database. - Fix compatibility with PostgreSQL 15 # Additional Changes - The signing key was stored as plain-text in the river job payload in the DB. This violated our [Secrets Storage](https://zitadel.com/docs/concepts/architecture/secrets#secrets-storage) principle. This change removed the field and only uses the encrypted version of the signing key. - Fixed the target ordering from descending to ascending. - Some minor linter warnings on the use of `io.WriteString()`. # Additional Context - Introduced in https://github.com/zitadel/zitadel/pull/9249 - Closes https://github.com/zitadel/zitadel/issues/10553 - Closes https://github.com/zitadel/zitadel/issues/9832 - Closes https://github.com/zitadel/zitadel/issues/10372 - Closes https://github.com/zitadel/zitadel/issues/10492 --------- Co-authored-by: Stefan Benz <46600784+stebenz@users.noreply.github.com>
329 lines
8.7 KiB
Go
329 lines
8.7 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 et.instance_id, et.execution_id, JSONB_AGG( JSON_BUILD_OBJECT( 'position', et.position, 'include', et.include, 'target', et.target_id ) ) as targets` +
|
|
` FROM projections.executions1_targets AS et` +
|
|
` INNER JOIN projections.targets2 AS t ON et.instance_id = t.instance_id AND et.target_id IS NOT NULL AND et.target_id = t.id` +
|
|
` GROUP BY et.instance_id, et.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 et.instance_id, et.execution_id, JSONB_AGG( JSON_BUILD_OBJECT( 'position', et.position, 'include', et.include, 'target', et.target_id ) ) as targets` +
|
|
` FROM projections.executions1_targets AS et` +
|
|
` INNER JOIN projections.targets2 AS t ON et.instance_id = t.instance_id AND et.target_id IS NOT NULL AND et.target_id = t.id` +
|
|
` GROUP BY et.instance_id, et.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 multiple result, removed target, position missing",
|
|
prepare: prepareExecutionsQuery,
|
|
want: want{
|
|
sqlExpectations: mockQueries(
|
|
regexp.QuoteMeta(prepareExecutionsStmt),
|
|
prepareExecutionsCols,
|
|
[][]driver.Value{
|
|
{
|
|
"ro",
|
|
"id-1",
|
|
testNow,
|
|
testNow,
|
|
[]byte(`[{"position" : 1, "target" : "target"}, {"position" : 3, "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)
|
|
})
|
|
}
|
|
}
|