mirror of
https://github.com/andwati/zitadel.git
synced 2026-11-21 04:18: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:
@@ -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
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user