mirror of
https://github.com/zitadel/zitadel.git
synced 2025-12-07 07:16:54 +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)
303 lines
7.1 KiB
Go
303 lines
7.1 KiB
Go
package middleware
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
"reflect"
|
|
"testing"
|
|
"time"
|
|
|
|
"golang.org/x/text/language"
|
|
"google.golang.org/grpc"
|
|
|
|
"github.com/zitadel/zitadel/internal/api/authz"
|
|
http_util "github.com/zitadel/zitadel/internal/api/http"
|
|
"github.com/zitadel/zitadel/internal/execution/target"
|
|
"github.com/zitadel/zitadel/internal/feature"
|
|
object_v3 "github.com/zitadel/zitadel/pkg/grpc/object/v3alpha"
|
|
)
|
|
|
|
func Test_setInstance(t *testing.T) {
|
|
type args struct {
|
|
ctx context.Context
|
|
req interface{}
|
|
info *grpc.UnaryServerInfo
|
|
handler grpc.UnaryHandler
|
|
verifier authz.InstanceVerifier
|
|
}
|
|
type res struct {
|
|
want interface{}
|
|
err bool
|
|
}
|
|
tests := []struct {
|
|
name string
|
|
args args
|
|
res res
|
|
}{
|
|
{
|
|
"hostname not found, error",
|
|
args{
|
|
ctx: context.Background(),
|
|
},
|
|
res{
|
|
want: nil,
|
|
err: true,
|
|
},
|
|
},
|
|
{
|
|
"invalid host, error",
|
|
args{
|
|
ctx: http_util.WithDomainContext(context.Background(), &http_util.DomainCtx{InstanceHost: "host2"}),
|
|
req: &mockRequest{},
|
|
verifier: &mockInstanceVerifier{instanceHost: "host"},
|
|
},
|
|
res{
|
|
want: nil,
|
|
err: true,
|
|
},
|
|
},
|
|
{
|
|
"valid host",
|
|
args{
|
|
ctx: http_util.WithDomainContext(context.Background(), &http_util.DomainCtx{InstanceHost: "host"}),
|
|
req: &mockRequest{},
|
|
verifier: &mockInstanceVerifier{instanceHost: "host"},
|
|
handler: func(ctx context.Context, req interface{}) (interface{}, error) {
|
|
return req, nil
|
|
},
|
|
},
|
|
res{
|
|
want: &mockRequest{},
|
|
err: false,
|
|
},
|
|
},
|
|
{
|
|
"explicit instance unset, hostname not found, error",
|
|
args{
|
|
ctx: http_util.WithDomainContext(context.Background(), &http_util.DomainCtx{InstanceHost: "host2"}),
|
|
req: &mockRequestWithExplicitInstance{},
|
|
verifier: &mockInstanceVerifier{instanceHost: "host"},
|
|
},
|
|
res{
|
|
want: nil,
|
|
err: true,
|
|
},
|
|
},
|
|
{
|
|
"explicit instance unset, invalid host, error",
|
|
args{
|
|
ctx: http_util.WithDomainContext(context.Background(), &http_util.DomainCtx{InstanceHost: "host2"}),
|
|
req: &mockRequestWithExplicitInstance{},
|
|
verifier: &mockInstanceVerifier{instanceHost: "host"},
|
|
},
|
|
res{
|
|
want: nil,
|
|
err: true,
|
|
},
|
|
},
|
|
{
|
|
"explicit instance unset, valid host",
|
|
args{
|
|
ctx: http_util.WithDomainContext(context.Background(), &http_util.DomainCtx{InstanceHost: "host"}),
|
|
req: &mockRequestWithExplicitInstance{},
|
|
verifier: &mockInstanceVerifier{instanceHost: "host"},
|
|
handler: func(ctx context.Context, req interface{}) (interface{}, error) {
|
|
return req, nil
|
|
},
|
|
},
|
|
res{
|
|
want: &mockRequestWithExplicitInstance{},
|
|
err: false,
|
|
},
|
|
},
|
|
{
|
|
name: "explicit instance set, id not found, error",
|
|
args: args{
|
|
ctx: context.Background(),
|
|
req: &mockRequestWithExplicitInstance{
|
|
instance: object_v3.Instance{
|
|
Property: &object_v3.Instance_Id{
|
|
Id: "not existing instance id",
|
|
},
|
|
},
|
|
},
|
|
verifier: &mockInstanceVerifier{id: "existing instance id"},
|
|
},
|
|
res: res{
|
|
want: nil,
|
|
err: true,
|
|
},
|
|
},
|
|
{
|
|
name: "explicit instance set, id found, ok",
|
|
args: args{
|
|
ctx: context.Background(),
|
|
req: &mockRequestWithExplicitInstance{
|
|
instance: object_v3.Instance{
|
|
Property: &object_v3.Instance_Id{
|
|
Id: "existing instance id",
|
|
},
|
|
},
|
|
},
|
|
verifier: &mockInstanceVerifier{id: "existing instance id"},
|
|
handler: func(ctx context.Context, req interface{}) (interface{}, error) {
|
|
return req, nil
|
|
},
|
|
},
|
|
res: res{
|
|
want: &mockRequestWithExplicitInstance{
|
|
instance: object_v3.Instance{
|
|
Property: &object_v3.Instance_Id{
|
|
Id: "existing instance id",
|
|
},
|
|
},
|
|
},
|
|
err: false,
|
|
},
|
|
},
|
|
{
|
|
name: "explicit instance set, domain not found, error",
|
|
args: args{
|
|
ctx: context.Background(),
|
|
req: &mockRequestWithExplicitInstance{
|
|
instance: object_v3.Instance{
|
|
Property: &object_v3.Instance_Domain{
|
|
Domain: "not existing instance domain",
|
|
},
|
|
},
|
|
},
|
|
verifier: &mockInstanceVerifier{instanceHost: "existing instance domain"},
|
|
},
|
|
res: res{
|
|
want: nil,
|
|
err: true,
|
|
},
|
|
},
|
|
{
|
|
name: "explicit instance set, domain found, ok",
|
|
args: args{
|
|
ctx: context.Background(),
|
|
req: &mockRequestWithExplicitInstance{
|
|
instance: object_v3.Instance{
|
|
Property: &object_v3.Instance_Domain{
|
|
Domain: "existing instance domain",
|
|
},
|
|
},
|
|
},
|
|
verifier: &mockInstanceVerifier{instanceHost: "existing instance domain"},
|
|
handler: func(ctx context.Context, req interface{}) (interface{}, error) {
|
|
return req, nil
|
|
},
|
|
},
|
|
res: res{
|
|
want: &mockRequestWithExplicitInstance{
|
|
instance: object_v3.Instance{
|
|
Property: &object_v3.Instance_Domain{
|
|
Domain: "existing instance domain",
|
|
},
|
|
},
|
|
},
|
|
err: false,
|
|
},
|
|
},
|
|
}
|
|
for _, tt := range tests {
|
|
t.Run(tt.name, func(t *testing.T) {
|
|
got, err := setInstance(tt.args.ctx, tt.args.req, tt.args.info, tt.args.handler, tt.args.verifier, "", nil)
|
|
if (err != nil) != tt.res.err {
|
|
t.Errorf("setInstance() error = %v, wantErr %v", err, tt.res.err)
|
|
return
|
|
}
|
|
if !reflect.DeepEqual(got, tt.res.want) {
|
|
t.Errorf("setInstance() got = %v, want %v", got, tt.res.want)
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
type mockRequest struct{}
|
|
|
|
type mockRequestWithExplicitInstance struct {
|
|
instance object_v3.Instance
|
|
}
|
|
|
|
func (m *mockRequestWithExplicitInstance) GetInstance() *object_v3.Instance {
|
|
return &m.instance
|
|
}
|
|
|
|
type mockInstanceVerifier struct {
|
|
id string
|
|
instanceHost string
|
|
publicHost string
|
|
}
|
|
|
|
func (m *mockInstanceVerifier) InstanceByHost(_ context.Context, instanceHost, publicHost string) (authz.Instance, error) {
|
|
if instanceHost != m.instanceHost {
|
|
return nil, fmt.Errorf("invalid host")
|
|
}
|
|
if publicHost == "" {
|
|
return &mockInstance{}, nil
|
|
}
|
|
if publicHost != instanceHost && publicHost != m.publicHost {
|
|
return nil, fmt.Errorf("invalid host")
|
|
}
|
|
return &mockInstance{}, nil
|
|
}
|
|
|
|
func (m *mockInstanceVerifier) InstanceByID(_ context.Context, id string) (authz.Instance, error) {
|
|
if id != m.id {
|
|
return nil, fmt.Errorf("not found")
|
|
}
|
|
return &mockInstance{}, nil
|
|
}
|
|
|
|
type mockInstance struct{}
|
|
|
|
func (m *mockInstance) Block() *bool {
|
|
panic("shouldn't be called here")
|
|
}
|
|
|
|
func (m *mockInstance) AuditLogRetention() *time.Duration {
|
|
panic("shouldn't be called here")
|
|
}
|
|
|
|
func (m *mockInstance) InstanceID() string {
|
|
return "instanceID"
|
|
}
|
|
|
|
func (m *mockInstance) ProjectID() string {
|
|
return "projectID"
|
|
}
|
|
|
|
func (m *mockInstance) ConsoleClientID() string {
|
|
return "consoleClientID"
|
|
}
|
|
|
|
func (m *mockInstance) ConsoleApplicationID() string {
|
|
return "consoleApplicationID"
|
|
}
|
|
|
|
func (m *mockInstance) DefaultLanguage() language.Tag {
|
|
return language.English
|
|
}
|
|
|
|
func (m *mockInstance) DefaultOrganisationID() string {
|
|
return "orgID"
|
|
}
|
|
|
|
func (m *mockInstance) SecurityPolicyAllowedOrigins() []string {
|
|
return nil
|
|
}
|
|
|
|
func (m *mockInstance) EnableImpersonation() bool {
|
|
return false
|
|
}
|
|
|
|
func (m *mockInstance) Features() feature.Features {
|
|
return feature.Features{}
|
|
}
|
|
|
|
func (m *mockInstance) ExecutionRouter() target.Router {
|
|
return target.NewRouter(nil)
|
|
}
|