mirror of
https://github.com/andwati/zitadel.git
synced 2026-11-21 12:28:46 +00:00
refactor: invoker implementations and clean up code (#10962)
This pull request refactors the command execution and transaction handling logic within the `domain` package. The primary goal is to simplify the invoker chain, clarify transaction management, and improve the overall structure for better maintainability and readability. ### Key Changes: - **Simplified Invoker Chain**: The previous chain of invokers has been refactored. A new `transactionInvoker` is introduced to explicitly manage database transactions for commands that require them. This responsibility is no longer spread across different parts of the invocation flow. - **`Transactional` Interface**: A new `Transactional` interface has been introduced. Commands that need to run within a database transaction now implement this interface. This provides a clear and explicit contract for transactional operations. - **Consolidated Transaction Logic**: The logic for starting, committing, and rolling back transactions is now centralized within the `transactionInvoker` and the `eventStoreInvoker`. The `EnsureTx` method on `InvokeOpts` has been removed, and transaction handling is now managed automatically by the invocation framework. - **Improved Event Handling**: The `eventStoreInvoker` and its `eventCollector` have been rewritten to be more robust and to correctly handle nested and batched commands, ensuring that all events are collected and published within the same transaction. - **Code Cleanup**: A significant amount of now-unused code, including the old `invoker_test.go`, has been removed. Various comments and variable declarations have also been cleaned up. - **Updated Command Implementations**: All commands in the `domain` package (e.g., `ActivateOrgCommand`, `DeactivateOrgCommand`, `DeleteOrgCommand`, `UpdateOrgCommand`) have been updated to use the new `Transactional` interface where appropriate, removing manual transaction management. - **Enhanced Testing**: Tests have been added and updated to cover the new transaction and event handling logic, ensuring the refactoring is sound. - **Use `PrimaryKeyCondition`**: Use the `repository.PrimaryKeyCondition(...)` method instead of using `database.And(...)` where possible. These changes lead to a cleaner, more decoupled architecture for command handling in ZITADEL. --------- Co-authored-by: Marco A. <[email protected]>
This commit is contained in:
@@ -250,7 +250,7 @@ func NewTextIgnoreCaseCondition[T Text](col Column, op TextOperation, value T) C
|
||||
}
|
||||
}
|
||||
|
||||
// NewDateCondition creates a condition that compares a numeric column with a value.
|
||||
// NewNumberCondition creates a condition that compares a numeric column with a value.
|
||||
func NewNumberCondition[V Number](col Column, op NumberOperation, value V) Condition {
|
||||
return valueCondition{
|
||||
col: col,
|
||||
@@ -260,7 +260,7 @@ func NewNumberCondition[V Number](col Column, op NumberOperation, value V) Condi
|
||||
}
|
||||
}
|
||||
|
||||
// NewDateCondition creates a condition that compares a boolean column with a value.
|
||||
// NewBooleanCondition creates a condition that compares a boolean column with a value.
|
||||
func NewBooleanCondition[V Boolean](col Column, value V) Condition {
|
||||
return valueCondition{
|
||||
col: col,
|
||||
@@ -319,7 +319,7 @@ func (e *existsCondition) Matches(x any) bool {
|
||||
|
||||
// String implements [Condition].
|
||||
func (e *existsCondition) String() string {
|
||||
return "unimplemented"
|
||||
return "existsCondition"
|
||||
}
|
||||
|
||||
// Exists creates a condition that checks for the existence of rows in a subquery.
|
||||
|
||||
@@ -39,10 +39,7 @@ func TestServer_TestOrgDomainReduces(t *testing.T) {
|
||||
assert.EventuallyWithT(t, func(t *assert.CollectT) {
|
||||
_, err := orgRepo.Get(CTX, pool,
|
||||
database.WithCondition(
|
||||
database.And(
|
||||
orgRepo.InstanceIDCondition(Instance.Instance.Id),
|
||||
orgRepo.IDCondition(org.GetId()),
|
||||
),
|
||||
orgRepo.PrimaryKeyCondition(Instance.Instance.Id, org.GetId()),
|
||||
),
|
||||
)
|
||||
assert.NoError(t, err)
|
||||
|
||||
@@ -1,55 +0,0 @@
|
||||
//go:build integration
|
||||
|
||||
package events_test
|
||||
|
||||
import (
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/brianvoe/gofakeit/v6"
|
||||
"github.com/stretchr/testify/assert"
|
||||
"github.com/stretchr/testify/require"
|
||||
|
||||
"github.com/zitadel/zitadel/backend/v3/storage/database"
|
||||
"github.com/zitadel/zitadel/backend/v3/storage/database/repository"
|
||||
"github.com/zitadel/zitadel/internal/integration"
|
||||
org "github.com/zitadel/zitadel/pkg/grpc/org/v2beta"
|
||||
v2beta "github.com/zitadel/zitadel/pkg/grpc/org/v2beta"
|
||||
)
|
||||
|
||||
func createOrg(t *testing.T) *org.CreateOrganizationResponse {
|
||||
t.Helper()
|
||||
org, err := OrgClient.CreateOrganization(CTX, &org.CreateOrganizationRequest{
|
||||
Name: gofakeit.Name(),
|
||||
})
|
||||
require.NoError(t, err)
|
||||
|
||||
orgRepo := repository.OrganizationRepository()
|
||||
retryDuration, tick := integration.WaitForAndTickWithMaxDuration(t.Context(), time.Minute)
|
||||
assert.EventuallyWithT(t, func(tc *assert.CollectT) {
|
||||
_, err := orgRepo.Get(t.Context(), pool,
|
||||
database.WithCondition(database.And(
|
||||
orgRepo.InstanceIDCondition(Instance.Instance.Id),
|
||||
orgRepo.IDCondition(org.GetId())),
|
||||
),
|
||||
)
|
||||
assert.NoError(tc, err)
|
||||
}, retryDuration, tick)
|
||||
|
||||
return org
|
||||
}
|
||||
|
||||
func createTestScopedOrg(t *testing.T) *org.CreateOrganizationResponse {
|
||||
org := createOrg(t)
|
||||
|
||||
t.Cleanup(func() {
|
||||
_, err := OrgClient.DeleteOrganization(CTX, &v2beta.DeleteOrganizationRequest{
|
||||
Id: org.GetId(),
|
||||
})
|
||||
if err != nil {
|
||||
t.Logf("Failed to delete organization on cleanup: %v", err)
|
||||
}
|
||||
})
|
||||
|
||||
return org
|
||||
}
|
||||
@@ -14,6 +14,8 @@ import (
|
||||
"github.com/zitadel/zitadel/backend/v3/storage/database"
|
||||
"github.com/zitadel/zitadel/backend/v3/storage/database/repository"
|
||||
"github.com/zitadel/zitadel/internal/integration"
|
||||
org "github.com/zitadel/zitadel/pkg/grpc/org/v2beta"
|
||||
v2beta "github.com/zitadel/zitadel/pkg/grpc/org/v2beta"
|
||||
v2beta_org "github.com/zitadel/zitadel/pkg/grpc/org/v2beta"
|
||||
)
|
||||
|
||||
@@ -43,12 +45,7 @@ func TestServer_TestOrganizationReduces(t *testing.T) {
|
||||
retryDuration, tick := integration.WaitForAndTickWithMaxDuration(CTX, time.Minute)
|
||||
assert.EventuallyWithT(t, func(tt *assert.CollectT) {
|
||||
organization, err := orgRepo.Get(CTX, pool,
|
||||
database.WithCondition(
|
||||
database.And(
|
||||
orgRepo.IDCondition(org.GetId()),
|
||||
orgRepo.InstanceIDCondition(instanceID),
|
||||
),
|
||||
),
|
||||
database.WithCondition(orgRepo.PrimaryKeyCondition(instanceID, org.GetId())),
|
||||
)
|
||||
require.NoError(tt, err)
|
||||
|
||||
@@ -93,12 +90,7 @@ func TestServer_TestOrganizationReduces(t *testing.T) {
|
||||
retryDuration, tick := integration.WaitForAndTickWithMaxDuration(CTX, time.Minute)
|
||||
assert.EventuallyWithT(t, func(t *assert.CollectT) {
|
||||
organization, err := orgRepo.Get(CTX, pool,
|
||||
database.WithCondition(
|
||||
database.And(
|
||||
orgRepo.IDCondition(organization.Id),
|
||||
orgRepo.InstanceIDCondition(instanceID),
|
||||
),
|
||||
),
|
||||
database.WithCondition(orgRepo.PrimaryKeyCondition(instanceID, organization.GetId())),
|
||||
)
|
||||
require.NoError(t, err)
|
||||
|
||||
@@ -138,12 +130,7 @@ func TestServer_TestOrganizationReduces(t *testing.T) {
|
||||
retryDuration, tick := integration.WaitForAndTickWithMaxDuration(CTX, time.Minute)
|
||||
assert.EventuallyWithT(t, func(t *assert.CollectT) {
|
||||
organization, err := orgRepo.Get(CTX, pool,
|
||||
database.WithCondition(
|
||||
database.And(
|
||||
orgRepo.IDCondition(organization.Id),
|
||||
orgRepo.InstanceIDCondition(instanceID),
|
||||
),
|
||||
),
|
||||
database.WithCondition(orgRepo.PrimaryKeyCondition(instanceID, organization.GetId())),
|
||||
)
|
||||
require.NoError(t, err)
|
||||
|
||||
@@ -182,12 +169,7 @@ func TestServer_TestOrganizationReduces(t *testing.T) {
|
||||
retryDuration, tick := integration.WaitForAndTickWithMaxDuration(CTX, time.Minute)
|
||||
assert.EventuallyWithT(t, func(t *assert.CollectT) {
|
||||
organization, err := orgRepo.Get(CTX, pool,
|
||||
database.WithCondition(
|
||||
database.And(
|
||||
orgRepo.IDCondition(organization.Id),
|
||||
orgRepo.InstanceIDCondition(instanceID),
|
||||
),
|
||||
),
|
||||
database.WithCondition(orgRepo.PrimaryKeyCondition(instanceID, organization.GetId())),
|
||||
)
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, domain.OrgStateInactive, organization.State)
|
||||
@@ -204,12 +186,7 @@ func TestServer_TestOrganizationReduces(t *testing.T) {
|
||||
retryDuration, tick = integration.WaitForAndTickWithMaxDuration(CTX, time.Minute)
|
||||
assert.EventuallyWithT(t, func(t *assert.CollectT) {
|
||||
organization, err := orgRepo.Get(CTX, pool,
|
||||
database.WithCondition(
|
||||
database.And(
|
||||
orgRepo.IDCondition(organization.Id),
|
||||
orgRepo.InstanceIDCondition(instanceID),
|
||||
),
|
||||
),
|
||||
database.WithCondition(orgRepo.PrimaryKeyCondition(instanceID, organization.GetId())),
|
||||
)
|
||||
require.NoError(t, err)
|
||||
|
||||
@@ -234,12 +211,7 @@ func TestServer_TestOrganizationReduces(t *testing.T) {
|
||||
retryDuration, tick := integration.WaitForAndTickWithMaxDuration(CTX, time.Minute)
|
||||
assert.EventuallyWithT(t, func(t *assert.CollectT) {
|
||||
_, err := orgRepo.Get(CTX, pool,
|
||||
database.WithCondition(
|
||||
database.And(
|
||||
orgRepo.IDCondition(organization.Id),
|
||||
orgRepo.InstanceIDCondition(instanceID),
|
||||
),
|
||||
),
|
||||
database.WithCondition(orgRepo.PrimaryKeyCondition(instanceID, organization.GetId())),
|
||||
)
|
||||
require.NoError(t, err)
|
||||
}, retryDuration, tick)
|
||||
@@ -253,12 +225,7 @@ func TestServer_TestOrganizationReduces(t *testing.T) {
|
||||
retryDuration, tick = integration.WaitForAndTickWithMaxDuration(CTX, time.Minute)
|
||||
assert.EventuallyWithT(t, func(t *assert.CollectT) {
|
||||
organization, err := orgRepo.Get(CTX, pool,
|
||||
database.WithCondition(
|
||||
database.And(
|
||||
orgRepo.IDCondition(organization.Id),
|
||||
orgRepo.InstanceIDCondition(instanceID),
|
||||
),
|
||||
),
|
||||
database.WithCondition(orgRepo.PrimaryKeyCondition(instanceID, organization.GetId())),
|
||||
)
|
||||
require.ErrorIs(t, err, new(database.NoRowFoundError))
|
||||
|
||||
@@ -267,3 +234,37 @@ func TestServer_TestOrganizationReduces(t *testing.T) {
|
||||
}, retryDuration, tick)
|
||||
})
|
||||
}
|
||||
|
||||
func createOrg(t *testing.T) *org.CreateOrganizationResponse {
|
||||
t.Helper()
|
||||
org, err := OrgClient.CreateOrganization(CTX, &org.CreateOrganizationRequest{
|
||||
Name: gofakeit.Name(),
|
||||
})
|
||||
require.NoError(t, err)
|
||||
|
||||
orgRepo := repository.OrganizationRepository()
|
||||
retryDuration, tick := integration.WaitForAndTickWithMaxDuration(t.Context(), time.Minute)
|
||||
assert.EventuallyWithT(t, func(tc *assert.CollectT) {
|
||||
_, err := orgRepo.Get(t.Context(), pool,
|
||||
database.WithCondition(orgRepo.PrimaryKeyCondition(Instance.Instance.Id, org.GetId())),
|
||||
)
|
||||
assert.NoError(tc, err)
|
||||
}, retryDuration, tick)
|
||||
|
||||
return org
|
||||
}
|
||||
|
||||
func createTestScopedOrg(t *testing.T) *org.CreateOrganizationResponse {
|
||||
org := createOrg(t)
|
||||
|
||||
t.Cleanup(func() {
|
||||
_, err := OrgClient.DeleteOrganization(CTX, &v2beta.DeleteOrganizationRequest{
|
||||
Id: org.GetId(),
|
||||
})
|
||||
if err != nil {
|
||||
t.Logf("Failed to delete organization on cleanup: %v", err)
|
||||
}
|
||||
})
|
||||
|
||||
return org
|
||||
}
|
||||
|
||||
@@ -3,6 +3,7 @@ package database
|
||||
import (
|
||||
"fmt"
|
||||
"reflect"
|
||||
"slices"
|
||||
|
||||
"go.uber.org/mock/gomock"
|
||||
)
|
||||
@@ -148,17 +149,15 @@ func (q *QueryOpts) Matches(x any) bool {
|
||||
inputOpts.Write(inputBuilder)
|
||||
q.Write(expectedBuilder)
|
||||
|
||||
if len(inputBuilder.Args()) != len(expectedBuilder.Args()) {
|
||||
return false
|
||||
deepEq := func(input, expected any) int {
|
||||
if reflect.DeepEqual(input, expected) {
|
||||
return 0
|
||||
}
|
||||
return -1
|
||||
}
|
||||
|
||||
for i := range inputBuilder.Args() {
|
||||
argIn, argExp := inputBuilder.Args()[i], expectedBuilder.Args()[i]
|
||||
|
||||
isEqual := reflect.DeepEqual(argIn, argExp)
|
||||
if !isEqual {
|
||||
return false
|
||||
}
|
||||
if slices.CompareFunc(inputBuilder.Args(), expectedBuilder.Args(), deepEq) != 0 {
|
||||
return false
|
||||
}
|
||||
return inputBuilder.String() == expectedBuilder.String()
|
||||
}
|
||||
|
||||
@@ -247,12 +247,7 @@ func TestCreateOrganization(t *testing.T) {
|
||||
|
||||
// check organization values
|
||||
organization, err = organizationRepo.Get(t.Context(), savepoint,
|
||||
database.WithCondition(
|
||||
database.And(
|
||||
organizationRepo.IDCondition(organization.ID),
|
||||
organizationRepo.InstanceIDCondition(organization.InstanceID),
|
||||
),
|
||||
),
|
||||
database.WithCondition(organizationRepo.PrimaryKeyCondition(organization.InstanceID, organization.ID)),
|
||||
)
|
||||
require.NoError(t, err)
|
||||
|
||||
@@ -342,12 +337,7 @@ func TestUpdateOrganization(t *testing.T) {
|
||||
require.NoError(t, err)
|
||||
|
||||
// delete instance
|
||||
_, err = organizationRepo.Delete(t.Context(), tx,
|
||||
database.And(
|
||||
organizationRepo.InstanceIDCondition(org.InstanceID),
|
||||
organizationRepo.IDCondition(org.ID),
|
||||
),
|
||||
)
|
||||
_, err = organizationRepo.Delete(t.Context(), tx, organizationRepo.PrimaryKeyCondition(org.InstanceID, org.ID))
|
||||
require.NoError(t, err)
|
||||
|
||||
return &org
|
||||
@@ -399,10 +389,7 @@ func TestUpdateOrganization(t *testing.T) {
|
||||
|
||||
// update org
|
||||
rowsAffected, err := organizationRepo.Update(t.Context(), tx,
|
||||
database.And(
|
||||
organizationRepo.InstanceIDCondition(createdOrg.InstanceID),
|
||||
organizationRepo.IDCondition(createdOrg.ID),
|
||||
),
|
||||
organizationRepo.PrimaryKeyCondition(createdOrg.InstanceID, createdOrg.ID),
|
||||
tt.update...,
|
||||
)
|
||||
afterUpdate := time.Now()
|
||||
@@ -417,10 +404,7 @@ func TestUpdateOrganization(t *testing.T) {
|
||||
// check organization values
|
||||
organization, err := organizationRepo.Get(t.Context(), tx,
|
||||
database.WithCondition(
|
||||
database.And(
|
||||
organizationRepo.IDCondition(createdOrg.ID),
|
||||
organizationRepo.InstanceIDCondition(createdOrg.InstanceID),
|
||||
),
|
||||
organizationRepo.PrimaryKeyCondition(createdOrg.InstanceID, createdOrg.ID),
|
||||
),
|
||||
)
|
||||
require.NoError(t, err)
|
||||
|
||||
@@ -4,10 +4,17 @@ import "context"
|
||||
|
||||
// Transaction is an SQL transaction.
|
||||
type Transaction interface {
|
||||
// Commit marks a transaction as successful and commits it to the database.
|
||||
Commit(ctx context.Context) error
|
||||
// Rollback undoes all changes made in the transaction.
|
||||
Rollback(ctx context.Context) error
|
||||
// End commits the transaction if err is nil, otherwise rollbacks.
|
||||
//
|
||||
// If err is nil the returned error is from Commit.
|
||||
// If err is not nil, and rollback is successful, the original err is returned.
|
||||
// If err is not nil, and rollback fails, the two errors are joined using [errors.Join].
|
||||
End(ctx context.Context, err error) error
|
||||
|
||||
// Begin starts a sub transaction.
|
||||
Begin(ctx context.Context) (Transaction, error)
|
||||
|
||||
QueryExecutor
|
||||
|
||||
Reference in New Issue
Block a user