mirror of
https://github.com/andwati/zitadel.git
synced 2026-10-18 05:52:51 +00:00
c4221a9c0f
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]>
65 lines
2.3 KiB
Go
65 lines
2.3 KiB
Go
package domain_test
|
|
|
|
import (
|
|
"testing"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/require"
|
|
"go.uber.org/mock/gomock"
|
|
|
|
"github.com/zitadel/zitadel/backend/v3/domain"
|
|
domainmock "github.com/zitadel/zitadel/backend/v3/domain/mock"
|
|
)
|
|
|
|
func TestBatchExecutors(t *testing.T) {
|
|
t.Parallel()
|
|
t.Run("when commands are batched should run in expected order and return no error", func(t *testing.T) {
|
|
t.Parallel()
|
|
// Given
|
|
mockCtrl := gomock.NewController(t)
|
|
mockCmd1 := domainmock.NewMockCommander(mockCtrl)
|
|
mockCmd2 := domainmock.NewMockCommander(mockCtrl)
|
|
mockCmd3 := domainmock.NewMockCommander(mockCtrl)
|
|
|
|
mockCmd1.EXPECT().String().Return("cmd1").AnyTimes()
|
|
mockCmd2.EXPECT().String().Return("cmd2").AnyTimes()
|
|
mockCmd3.EXPECT().String().Return("cmd3").AnyTimes()
|
|
|
|
gomock.InOrder(
|
|
mockCmd1.EXPECT().Validate(gomock.Any(), gomock.Any()).Times(1),
|
|
mockCmd1.EXPECT().Execute(gomock.Any(), gomock.Any()).Times(1),
|
|
mockCmd1.EXPECT().Events(gomock.Any(), gomock.Any()).Times(1),
|
|
mockCmd2.EXPECT().Validate(gomock.Any(), gomock.Any()).Times(1),
|
|
mockCmd2.EXPECT().Execute(gomock.Any(), gomock.Any()).Times(1),
|
|
mockCmd2.EXPECT().Events(gomock.Any(), gomock.Any()).Times(1),
|
|
mockCmd3.EXPECT().Validate(gomock.Any(), gomock.Any()).Times(1),
|
|
mockCmd3.EXPECT().Execute(gomock.Any(), gomock.Any()).Times(1),
|
|
mockCmd3.EXPECT().Events(gomock.Any(), gomock.Any()).Times(1),
|
|
)
|
|
|
|
batcher := domain.BatchExecutors(mockCmd1, mockCmd2, mockCmd3)
|
|
err := domain.Invoke(t.Context(), batcher)
|
|
require.NoError(t, err)
|
|
require.True(t, mockCtrl.Satisfied())
|
|
})
|
|
|
|
t.Run("when batched commands fail should return error from invoker", func(t *testing.T) {
|
|
t.Parallel()
|
|
mockCtrl := gomock.NewController(t)
|
|
mockCmd1 := domainmock.NewMockCommander(mockCtrl)
|
|
mockCmd2 := domainmock.NewMockCommander(mockCtrl)
|
|
|
|
mockCmd1.EXPECT().String().Return("cmd1").AnyTimes()
|
|
mockCmd2.EXPECT().String().Return("cmd2").AnyTimes()
|
|
|
|
gomock.InOrder(
|
|
mockCmd1.EXPECT().Validate(gomock.Any(), gomock.Any()).Times(1),
|
|
mockCmd1.EXPECT().Execute(gomock.Any(), gomock.Any()).Return(assert.AnError).Times(1),
|
|
)
|
|
|
|
batcher := domain.BatchExecutors(mockCmd1, mockCmd2)
|
|
err := domain.Invoke(t.Context(), batcher)
|
|
require.ErrorIs(t, err, assert.AnError)
|
|
})
|
|
}
|