mirror of
https://github.com/zitadel/zitadel.git
synced 2025-11-02 03:38:46 +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>
(cherry picked from commit a9ebc06c77)
380 lines
9.1 KiB
Go
380 lines
9.1 KiB
Go
package query
|
|
|
|
import (
|
|
"database/sql"
|
|
"database/sql/driver"
|
|
"errors"
|
|
"fmt"
|
|
"regexp"
|
|
"testing"
|
|
"time"
|
|
|
|
"github.com/zitadel/zitadel/internal/crypto"
|
|
"github.com/zitadel/zitadel/internal/domain"
|
|
target_domain "github.com/zitadel/zitadel/internal/execution/target"
|
|
"github.com/zitadel/zitadel/internal/zerrors"
|
|
)
|
|
|
|
var (
|
|
prepareTargetsStmt = `SELECT projections.targets2.id,` +
|
|
` projections.targets2.creation_date,` +
|
|
` projections.targets2.change_date,` +
|
|
` projections.targets2.resource_owner,` +
|
|
` projections.targets2.name,` +
|
|
` projections.targets2.target_type,` +
|
|
` projections.targets2.timeout,` +
|
|
` projections.targets2.endpoint,` +
|
|
` projections.targets2.interrupt_on_error,` +
|
|
` projections.targets2.signing_key,` +
|
|
` COUNT(*) OVER ()` +
|
|
` FROM projections.targets2`
|
|
prepareTargetsCols = []string{
|
|
"id",
|
|
"creation_date",
|
|
"change_date",
|
|
"resource_owner",
|
|
"name",
|
|
"target_type",
|
|
"timeout",
|
|
"endpoint",
|
|
"interrupt_on_error",
|
|
"signing_key",
|
|
"count",
|
|
}
|
|
|
|
prepareTargetStmt = `SELECT projections.targets2.id,` +
|
|
` projections.targets2.creation_date,` +
|
|
` projections.targets2.change_date,` +
|
|
` projections.targets2.resource_owner,` +
|
|
` projections.targets2.name,` +
|
|
` projections.targets2.target_type,` +
|
|
` projections.targets2.timeout,` +
|
|
` projections.targets2.endpoint,` +
|
|
` projections.targets2.interrupt_on_error,` +
|
|
` projections.targets2.signing_key` +
|
|
` FROM projections.targets2`
|
|
prepareTargetCols = []string{
|
|
"id",
|
|
"creation_date",
|
|
"change_date",
|
|
"resource_owner",
|
|
"name",
|
|
"target_type",
|
|
"timeout",
|
|
"endpoint",
|
|
"interrupt_on_error",
|
|
"signing_key",
|
|
}
|
|
)
|
|
|
|
func Test_TargetPrepares(t *testing.T) {
|
|
type want struct {
|
|
sqlExpectations sqlExpectation
|
|
err checkErr
|
|
}
|
|
tests := []struct {
|
|
name string
|
|
prepare interface{}
|
|
want want
|
|
object interface{}
|
|
}{
|
|
{
|
|
name: "prepareTargetsQuery no result",
|
|
prepare: prepareTargetsQuery,
|
|
want: want{
|
|
sqlExpectations: mockQueries(
|
|
regexp.QuoteMeta(prepareTargetsStmt),
|
|
nil,
|
|
nil,
|
|
),
|
|
},
|
|
object: &Targets{Targets: []*Target{}},
|
|
},
|
|
{
|
|
name: "prepareTargetsQuery one result",
|
|
prepare: prepareTargetsQuery,
|
|
want: want{
|
|
sqlExpectations: mockQueries(
|
|
regexp.QuoteMeta(prepareTargetsStmt),
|
|
prepareTargetsCols,
|
|
[][]driver.Value{
|
|
{
|
|
"id",
|
|
testNow,
|
|
testNow,
|
|
"ro",
|
|
"target-name",
|
|
target_domain.TargetTypeWebhook,
|
|
1 * time.Second,
|
|
"https://example.com",
|
|
true,
|
|
&crypto.CryptoValue{
|
|
CryptoType: crypto.TypeEncryption,
|
|
Algorithm: "alg",
|
|
KeyID: "encKey",
|
|
Crypted: []byte("crypted"),
|
|
},
|
|
},
|
|
},
|
|
),
|
|
},
|
|
object: &Targets{
|
|
SearchResponse: SearchResponse{
|
|
Count: 1,
|
|
},
|
|
Targets: []*Target{
|
|
{
|
|
ObjectDetails: domain.ObjectDetails{
|
|
ID: "id",
|
|
EventDate: testNow,
|
|
CreationDate: testNow,
|
|
ResourceOwner: "ro",
|
|
},
|
|
Name: "target-name",
|
|
TargetType: target_domain.TargetTypeWebhook,
|
|
Timeout: 1 * time.Second,
|
|
Endpoint: "https://example.com",
|
|
InterruptOnError: true,
|
|
signingKey: &crypto.CryptoValue{
|
|
CryptoType: crypto.TypeEncryption,
|
|
Algorithm: "alg",
|
|
KeyID: "encKey",
|
|
Crypted: []byte("crypted"),
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
{
|
|
name: "prepareTargetsQuery multiple result",
|
|
prepare: prepareTargetsQuery,
|
|
want: want{
|
|
sqlExpectations: mockQueries(
|
|
regexp.QuoteMeta(prepareTargetsStmt),
|
|
prepareTargetsCols,
|
|
[][]driver.Value{
|
|
{
|
|
"id-1",
|
|
testNow,
|
|
testNow,
|
|
"ro",
|
|
"target-name1",
|
|
target_domain.TargetTypeWebhook,
|
|
1 * time.Second,
|
|
"https://example.com",
|
|
true,
|
|
&crypto.CryptoValue{
|
|
CryptoType: crypto.TypeEncryption,
|
|
Algorithm: "alg",
|
|
KeyID: "encKey",
|
|
Crypted: []byte("crypted"),
|
|
},
|
|
},
|
|
{
|
|
"id-2",
|
|
testNow,
|
|
testNow,
|
|
"ro",
|
|
"target-name2",
|
|
target_domain.TargetTypeWebhook,
|
|
1 * time.Second,
|
|
"https://example.com",
|
|
false,
|
|
&crypto.CryptoValue{
|
|
CryptoType: crypto.TypeEncryption,
|
|
Algorithm: "alg",
|
|
KeyID: "encKey",
|
|
Crypted: []byte("crypted"),
|
|
},
|
|
},
|
|
{
|
|
"id-3",
|
|
testNow,
|
|
testNow,
|
|
"ro",
|
|
"target-name3",
|
|
target_domain.TargetTypeAsync,
|
|
1 * time.Second,
|
|
"https://example.com",
|
|
false,
|
|
&crypto.CryptoValue{
|
|
CryptoType: crypto.TypeEncryption,
|
|
Algorithm: "alg",
|
|
KeyID: "encKey",
|
|
Crypted: []byte("crypted"),
|
|
},
|
|
},
|
|
},
|
|
),
|
|
},
|
|
object: &Targets{
|
|
SearchResponse: SearchResponse{
|
|
Count: 3,
|
|
},
|
|
Targets: []*Target{
|
|
{
|
|
ObjectDetails: domain.ObjectDetails{
|
|
ID: "id-1",
|
|
EventDate: testNow,
|
|
CreationDate: testNow,
|
|
ResourceOwner: "ro",
|
|
},
|
|
Name: "target-name1",
|
|
TargetType: target_domain.TargetTypeWebhook,
|
|
Timeout: 1 * time.Second,
|
|
Endpoint: "https://example.com",
|
|
InterruptOnError: true,
|
|
signingKey: &crypto.CryptoValue{
|
|
CryptoType: crypto.TypeEncryption,
|
|
Algorithm: "alg",
|
|
KeyID: "encKey",
|
|
Crypted: []byte("crypted"),
|
|
},
|
|
},
|
|
{
|
|
ObjectDetails: domain.ObjectDetails{
|
|
ID: "id-2",
|
|
EventDate: testNow,
|
|
CreationDate: testNow,
|
|
ResourceOwner: "ro",
|
|
},
|
|
Name: "target-name2",
|
|
TargetType: target_domain.TargetTypeWebhook,
|
|
Timeout: 1 * time.Second,
|
|
Endpoint: "https://example.com",
|
|
InterruptOnError: false,
|
|
signingKey: &crypto.CryptoValue{
|
|
CryptoType: crypto.TypeEncryption,
|
|
Algorithm: "alg",
|
|
KeyID: "encKey",
|
|
Crypted: []byte("crypted"),
|
|
},
|
|
},
|
|
{
|
|
ObjectDetails: domain.ObjectDetails{
|
|
ID: "id-3",
|
|
EventDate: testNow,
|
|
CreationDate: testNow,
|
|
ResourceOwner: "ro",
|
|
},
|
|
Name: "target-name3",
|
|
TargetType: target_domain.TargetTypeAsync,
|
|
Timeout: 1 * time.Second,
|
|
Endpoint: "https://example.com",
|
|
InterruptOnError: false,
|
|
signingKey: &crypto.CryptoValue{
|
|
CryptoType: crypto.TypeEncryption,
|
|
Algorithm: "alg",
|
|
KeyID: "encKey",
|
|
Crypted: []byte("crypted"),
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
{
|
|
name: "prepareTargetsQuery sql err",
|
|
prepare: prepareTargetsQuery,
|
|
want: want{
|
|
sqlExpectations: mockQueryErr(
|
|
regexp.QuoteMeta(prepareTargetsStmt),
|
|
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: (*Target)(nil),
|
|
},
|
|
{
|
|
name: "prepareTargetQuery no result",
|
|
prepare: prepareTargetQuery,
|
|
want: want{
|
|
sqlExpectations: mockQueriesScanErr(
|
|
regexp.QuoteMeta(prepareTargetStmt),
|
|
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: (*Target)(nil),
|
|
},
|
|
{
|
|
name: "prepareTargetQuery found",
|
|
prepare: prepareTargetQuery,
|
|
want: want{
|
|
sqlExpectations: mockQuery(
|
|
regexp.QuoteMeta(prepareTargetStmt),
|
|
prepareTargetCols,
|
|
[]driver.Value{
|
|
"id",
|
|
testNow,
|
|
testNow,
|
|
"ro",
|
|
"target-name",
|
|
target_domain.TargetTypeWebhook,
|
|
1 * time.Second,
|
|
"https://example.com",
|
|
true,
|
|
&crypto.CryptoValue{
|
|
CryptoType: crypto.TypeEncryption,
|
|
Algorithm: "alg",
|
|
KeyID: "encKey",
|
|
Crypted: []byte("crypted"),
|
|
},
|
|
},
|
|
),
|
|
},
|
|
object: &Target{
|
|
ObjectDetails: domain.ObjectDetails{
|
|
ID: "id",
|
|
EventDate: testNow,
|
|
CreationDate: testNow,
|
|
ResourceOwner: "ro",
|
|
},
|
|
Name: "target-name",
|
|
TargetType: target_domain.TargetTypeWebhook,
|
|
Timeout: 1 * time.Second,
|
|
Endpoint: "https://example.com",
|
|
InterruptOnError: true,
|
|
signingKey: &crypto.CryptoValue{
|
|
CryptoType: crypto.TypeEncryption,
|
|
Algorithm: "alg",
|
|
KeyID: "encKey",
|
|
Crypted: []byte("crypted"),
|
|
},
|
|
},
|
|
},
|
|
{
|
|
name: "prepareTargetQuery sql err",
|
|
prepare: prepareTargetQuery,
|
|
want: want{
|
|
sqlExpectations: mockQueryErr(
|
|
regexp.QuoteMeta(prepareTargetStmt),
|
|
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: (*Target)(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)
|
|
})
|
|
}
|
|
}
|