mirror of
https://github.com/zitadel/zitadel.git
synced 2025-12-06 19:36:41 +00:00
perf(actionsv2): execution target router (#10564)
# 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)
This commit is contained in:
Tim Möhlmann
committed by
Livio Spring
Livio Spring
parent
d0d8e904c4
commit
2727fa719d
@@ -1,15 +1,23 @@
|
||||
package eventstore
|
||||
|
||||
import (
|
||||
"context"
|
||||
"database/sql"
|
||||
_ "embed"
|
||||
"testing"
|
||||
|
||||
"github.com/riverqueue/river"
|
||||
"github.com/stretchr/testify/assert"
|
||||
"github.com/stretchr/testify/require"
|
||||
"go.uber.org/mock/gomock"
|
||||
|
||||
"github.com/zitadel/zitadel/internal/api/authz"
|
||||
"github.com/zitadel/zitadel/internal/database"
|
||||
"github.com/zitadel/zitadel/internal/database/postgres"
|
||||
"github.com/zitadel/zitadel/internal/eventstore"
|
||||
"github.com/zitadel/zitadel/internal/eventstore/mock"
|
||||
"github.com/zitadel/zitadel/internal/execution/target"
|
||||
exec_repo "github.com/zitadel/zitadel/internal/repository/execution"
|
||||
)
|
||||
|
||||
func Test_mapCommands(t *testing.T) {
|
||||
@@ -251,3 +259,159 @@ func Test_mapCommands(t *testing.T) {
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestEventstore_queueExecutions(t *testing.T) {
|
||||
events := []eventstore.Event{
|
||||
mockEventType(mockAggregate("TEST"), 1, nil, "ex.foo.bar"),
|
||||
mockEventType(mockAggregate("TEST"), 2, nil, "ex.bar.foo"),
|
||||
mockEventType(mockAggregate("TEST"), 3, nil, "ex.removed"),
|
||||
}
|
||||
type args struct {
|
||||
ctx context.Context
|
||||
tx database.Tx
|
||||
events []eventstore.Event
|
||||
}
|
||||
tests := []struct {
|
||||
name string
|
||||
queue func(t *testing.T) eventstore.ExecutionQueue
|
||||
args args
|
||||
wantErr bool
|
||||
}{
|
||||
{
|
||||
name: "incorrect Tx type, noop",
|
||||
queue: func(t *testing.T) eventstore.ExecutionQueue {
|
||||
mQueue := mock.NewMockExecutionQueue(gomock.NewController(t))
|
||||
return mQueue
|
||||
},
|
||||
args: args{
|
||||
ctx: context.Background(),
|
||||
tx: nil,
|
||||
events: events,
|
||||
},
|
||||
wantErr: false,
|
||||
},
|
||||
{
|
||||
name: "no events",
|
||||
queue: func(t *testing.T) eventstore.ExecutionQueue {
|
||||
mQueue := mock.NewMockExecutionQueue(gomock.NewController(t))
|
||||
return mQueue
|
||||
},
|
||||
args: args{
|
||||
ctx: context.Background(),
|
||||
tx: &sql.Tx{},
|
||||
events: []eventstore.Event{},
|
||||
},
|
||||
wantErr: false,
|
||||
},
|
||||
{
|
||||
name: "no router in Ctx",
|
||||
queue: func(t *testing.T) eventstore.ExecutionQueue {
|
||||
mQueue := mock.NewMockExecutionQueue(gomock.NewController(t))
|
||||
return mQueue
|
||||
},
|
||||
args: args{
|
||||
ctx: context.Background(),
|
||||
tx: &sql.Tx{},
|
||||
events: events,
|
||||
},
|
||||
wantErr: false,
|
||||
},
|
||||
{
|
||||
name: "not found in router",
|
||||
queue: func(t *testing.T) eventstore.ExecutionQueue {
|
||||
mQueue := mock.NewMockExecutionQueue(gomock.NewController(t))
|
||||
return mQueue
|
||||
},
|
||||
args: args{
|
||||
ctx: authz.WithExecutionRouter(
|
||||
context.Background(),
|
||||
target.NewRouter([]target.Target{
|
||||
{
|
||||
ExecutionID: "function/fooBar",
|
||||
},
|
||||
}),
|
||||
),
|
||||
tx: &sql.Tx{},
|
||||
events: events,
|
||||
},
|
||||
wantErr: false,
|
||||
},
|
||||
{
|
||||
name: "event prefix",
|
||||
queue: func(t *testing.T) eventstore.ExecutionQueue {
|
||||
mQueue := mock.NewMockExecutionQueue(gomock.NewController(t))
|
||||
mQueue.EXPECT().InsertManyFastTx(
|
||||
gomock.Any(),
|
||||
gomock.Any(),
|
||||
[]river.JobArgs{
|
||||
mustNewRequest(t, events[0], []target.Target{{ExecutionID: "event"}}),
|
||||
mustNewRequest(t, events[1], []target.Target{{ExecutionID: "event"}}),
|
||||
mustNewRequest(t, events[2], []target.Target{{ExecutionID: "event"}}),
|
||||
},
|
||||
gomock.Any(),
|
||||
)
|
||||
return mQueue
|
||||
},
|
||||
args: args{
|
||||
ctx: authz.WithExecutionRouter(
|
||||
context.Background(),
|
||||
target.NewRouter([]target.Target{
|
||||
{ExecutionID: "function/fooBar"},
|
||||
{ExecutionID: "event"},
|
||||
}),
|
||||
),
|
||||
tx: &sql.Tx{},
|
||||
events: events,
|
||||
},
|
||||
wantErr: false,
|
||||
},
|
||||
{
|
||||
name: "event wildcard and exact match",
|
||||
queue: func(t *testing.T) eventstore.ExecutionQueue {
|
||||
mQueue := mock.NewMockExecutionQueue(gomock.NewController(t))
|
||||
mQueue.EXPECT().InsertManyFastTx(
|
||||
gomock.Any(),
|
||||
gomock.Any(),
|
||||
[]river.JobArgs{
|
||||
mustNewRequest(t, events[0], []target.Target{{ExecutionID: "event/ex.foo.*"}}),
|
||||
mustNewRequest(t, events[2], []target.Target{{ExecutionID: "event/ex.removed"}}),
|
||||
},
|
||||
gomock.Any(),
|
||||
)
|
||||
return mQueue
|
||||
},
|
||||
args: args{
|
||||
ctx: authz.WithExecutionRouter(
|
||||
context.Background(),
|
||||
target.NewRouter([]target.Target{
|
||||
{ExecutionID: "function/fooBar"},
|
||||
{ExecutionID: "event/ex.foo.*"},
|
||||
{ExecutionID: "event/ex.removed"},
|
||||
}),
|
||||
),
|
||||
tx: &sql.Tx{},
|
||||
events: events,
|
||||
},
|
||||
wantErr: false,
|
||||
},
|
||||
}
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
es := &Eventstore{
|
||||
queue: tt.queue(t),
|
||||
}
|
||||
err := es.queueExecutions(tt.args.ctx, tt.args.tx, tt.args.events)
|
||||
if tt.wantErr {
|
||||
assert.Error(t, err)
|
||||
return
|
||||
}
|
||||
assert.NoError(t, err)
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func mustNewRequest(t *testing.T, e eventstore.Event, targets []target.Target) *exec_repo.Request {
|
||||
req, err := exec_repo.NewRequest(e, targets)
|
||||
require.NoError(t, err, "exec_repo.NewRequest")
|
||||
return req
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user