mirror of
https://github.com/zitadel/zitadel.git
synced 2025-12-06 07:32:24 +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)
168 lines
4.2 KiB
Go
168 lines
4.2 KiB
Go
package target
|
|
|
|
import (
|
|
"context"
|
|
"time"
|
|
|
|
"github.com/zitadel/zitadel/internal/crypto"
|
|
"github.com/zitadel/zitadel/internal/eventstore"
|
|
target_domain "github.com/zitadel/zitadel/internal/execution/target"
|
|
)
|
|
|
|
const (
|
|
eventTypePrefix eventstore.EventType = "target."
|
|
AddedEventType = eventTypePrefix + "added"
|
|
ChangedEventType = eventTypePrefix + "changed"
|
|
RemovedEventType = eventTypePrefix + "removed"
|
|
)
|
|
|
|
type AddedEvent struct {
|
|
eventstore.BaseEvent `json:"-"`
|
|
|
|
Name string `json:"name"`
|
|
TargetType target_domain.TargetType `json:"targetType"`
|
|
Endpoint string `json:"endpoint"`
|
|
Timeout time.Duration `json:"timeout"`
|
|
InterruptOnError bool `json:"interruptOnError"`
|
|
SigningKey *crypto.CryptoValue `json:"signingKey"`
|
|
}
|
|
|
|
func (e *AddedEvent) SetBaseEvent(b *eventstore.BaseEvent) {
|
|
e.BaseEvent = *b
|
|
}
|
|
|
|
func (e *AddedEvent) Payload() any {
|
|
return e
|
|
}
|
|
|
|
func (e *AddedEvent) UniqueConstraints() []*eventstore.UniqueConstraint {
|
|
return []*eventstore.UniqueConstraint{NewAddUniqueConstraint(e.Name)}
|
|
}
|
|
|
|
func NewAddedEvent(
|
|
ctx context.Context,
|
|
aggregate *eventstore.Aggregate,
|
|
name string,
|
|
targetType target_domain.TargetType,
|
|
endpoint string,
|
|
timeout time.Duration,
|
|
interruptOnError bool,
|
|
signingKey *crypto.CryptoValue,
|
|
) *AddedEvent {
|
|
return &AddedEvent{
|
|
*eventstore.NewBaseEventForPush(
|
|
ctx, aggregate, AddedEventType,
|
|
),
|
|
name, targetType, endpoint, timeout, interruptOnError, signingKey}
|
|
}
|
|
|
|
type ChangedEvent struct {
|
|
eventstore.BaseEvent `json:"-"`
|
|
|
|
Name *string `json:"name,omitempty"`
|
|
TargetType *target_domain.TargetType `json:"targetType,omitempty"`
|
|
Endpoint *string `json:"endpoint,omitempty"`
|
|
Timeout *time.Duration `json:"timeout,omitempty"`
|
|
InterruptOnError *bool `json:"interruptOnError,omitempty"`
|
|
SigningKey *crypto.CryptoValue `json:"signingKey,omitempty"`
|
|
|
|
oldName string
|
|
}
|
|
|
|
func (e *ChangedEvent) SetBaseEvent(b *eventstore.BaseEvent) {
|
|
e.BaseEvent = *b
|
|
}
|
|
|
|
func (e *ChangedEvent) Payload() interface{} {
|
|
return e
|
|
}
|
|
|
|
func (e *ChangedEvent) UniqueConstraints() []*eventstore.UniqueConstraint {
|
|
if e.oldName == "" {
|
|
return nil
|
|
}
|
|
return []*eventstore.UniqueConstraint{
|
|
NewRemoveUniqueConstraint(e.oldName),
|
|
NewAddUniqueConstraint(*e.Name),
|
|
}
|
|
}
|
|
|
|
func NewChangedEvent(
|
|
ctx context.Context,
|
|
aggregate *eventstore.Aggregate,
|
|
changes []Changes,
|
|
) *ChangedEvent {
|
|
changeEvent := &ChangedEvent{
|
|
BaseEvent: *eventstore.NewBaseEventForPush(
|
|
ctx,
|
|
aggregate,
|
|
ChangedEventType,
|
|
),
|
|
}
|
|
for _, change := range changes {
|
|
change(changeEvent)
|
|
}
|
|
return changeEvent
|
|
}
|
|
|
|
type Changes func(event *ChangedEvent)
|
|
|
|
func ChangeName(oldName, name string) func(event *ChangedEvent) {
|
|
return func(e *ChangedEvent) {
|
|
e.Name = &name
|
|
e.oldName = oldName
|
|
}
|
|
}
|
|
|
|
func ChangeTargetType(targetType target_domain.TargetType) func(event *ChangedEvent) {
|
|
return func(e *ChangedEvent) {
|
|
e.TargetType = &targetType
|
|
}
|
|
}
|
|
|
|
func ChangeEndpoint(endpoint string) func(event *ChangedEvent) {
|
|
return func(e *ChangedEvent) {
|
|
e.Endpoint = &endpoint
|
|
}
|
|
}
|
|
|
|
func ChangeTimeout(timeout time.Duration) func(event *ChangedEvent) {
|
|
return func(e *ChangedEvent) {
|
|
e.Timeout = &timeout
|
|
}
|
|
}
|
|
|
|
func ChangeInterruptOnError(interruptOnError bool) func(event *ChangedEvent) {
|
|
return func(e *ChangedEvent) {
|
|
e.InterruptOnError = &interruptOnError
|
|
}
|
|
}
|
|
|
|
func ChangeSigningKey(signingKey *crypto.CryptoValue) func(event *ChangedEvent) {
|
|
return func(e *ChangedEvent) {
|
|
e.SigningKey = signingKey
|
|
}
|
|
}
|
|
|
|
type RemovedEvent struct {
|
|
eventstore.BaseEvent `json:"-"`
|
|
|
|
name string
|
|
}
|
|
|
|
func (e *RemovedEvent) SetBaseEvent(b *eventstore.BaseEvent) {
|
|
e.BaseEvent = *b
|
|
}
|
|
|
|
func (e *RemovedEvent) Payload() any {
|
|
return e
|
|
}
|
|
|
|
func (e *RemovedEvent) UniqueConstraints() []*eventstore.UniqueConstraint {
|
|
return []*eventstore.UniqueConstraint{NewRemoveUniqueConstraint(e.name)}
|
|
}
|
|
|
|
func NewRemovedEvent(ctx context.Context, aggregate *eventstore.Aggregate, name string) *RemovedEvent {
|
|
return &RemovedEvent{*eventstore.NewBaseEventForPush(ctx, aggregate, RemovedEventType), name}
|
|
}
|