Files
tasks/service/history/ndc/conflict_resolver_test.go
Vladyslav SimonenkoandGitHub 56841e02af Track external payloads stats for workflow execution (#8775)
## What changed?
Keep the total number and the size of the external payloads per the
workflow execution

## Why?
We are working on building the support for external payloads in SDK,
which are stored outside of Temporal. We'd like to be able to show the
total size and the number of external payloads in the given workflow
execution.

## How did you test it?
- [ ] built
- [X] run locally and tested manually
- [ ] covered by existing tests
- [X] added new unit test(s)
- [x] added new functional test(s)

## Potential risks
N/A
2026-01-05 10:36:35 -08:00

410 lines
14 KiB
Go

package ndc
import (
"context"
"math/rand"
"testing"
"github.com/google/uuid"
"github.com/stretchr/testify/require"
"github.com/stretchr/testify/suite"
historyspb "go.temporal.io/server/api/history/v1"
persistencespb "go.temporal.io/server/api/persistence/v1"
"go.temporal.io/server/common/definition"
"go.temporal.io/server/common/log"
"go.temporal.io/server/common/persistence/versionhistory"
"go.temporal.io/server/common/util"
historyi "go.temporal.io/server/service/history/interfaces"
"go.temporal.io/server/service/history/shard"
"go.temporal.io/server/service/history/tests"
"go.uber.org/mock/gomock"
)
type (
conflictResolverSuite struct {
suite.Suite
*require.Assertions
controller *gomock.Controller
mockShard *shard.ContextTest
mockContext *historyi.MockWorkflowContext
mockMutableState *historyi.MockMutableState
mockStateBuilder *MockStateRebuilder
logger log.Logger
namespaceID string
namespace string
workflowID string
runID string
nDCConflictResolver *ConflictResolverImpl
}
)
func TestNDCConflictResolverSuite(t *testing.T) {
s := new(conflictResolverSuite)
suite.Run(t, s)
}
func (s *conflictResolverSuite) SetupTest() {
s.Assertions = require.New(s.T())
s.controller = gomock.NewController(s.T())
s.mockContext = historyi.NewMockWorkflowContext(s.controller)
s.mockMutableState = historyi.NewMockMutableState(s.controller)
s.mockStateBuilder = NewMockStateRebuilder(s.controller)
s.mockShard = shard.NewTestContext(
s.controller,
&persistencespb.ShardInfo{
ShardId: 10,
RangeId: 1,
},
tests.NewDynamicConfig(),
)
s.logger = s.mockShard.GetLogger()
s.namespaceID = uuid.NewString()
s.namespace = "some random namespace name"
s.workflowID = "some random workflow ID"
s.runID = uuid.NewString()
s.nDCConflictResolver = NewConflictResolver(
s.mockShard, s.mockContext, s.mockMutableState, s.logger,
)
s.nDCConflictResolver.stateRebuilder = s.mockStateBuilder
}
func (s *conflictResolverSuite) TearDownTest() {
s.controller.Finish()
s.mockShard.StopForTest()
}
func (s *conflictResolverSuite) TestRebuild() {
ctx := context.Background()
updateCondition := int64(59)
dbVersion := int64(1444)
requestID := uuid.NewString()
version := int64(12)
historySize := int64(12345)
externalPayloadSize := int64(6789)
externalPayloadCount := int64(42)
branchToken0 := []byte("some random branch token")
lastEventID0 := int64(5)
versionHistory0 := versionhistory.NewVersionHistory(
branchToken0,
[]*historyspb.VersionHistoryItem{versionhistory.NewVersionHistoryItem(lastEventID0, version)},
)
branchToken1 := []byte("other random branch token")
lastEventID1 := int64(2)
versionHistory1 := versionhistory.NewVersionHistory(
branchToken1,
[]*historyspb.VersionHistoryItem{versionhistory.NewVersionHistoryItem(lastEventID1, version)},
)
versionHistories := versionhistory.NewVersionHistories(versionHistory0)
_, _, err := versionhistory.AddAndSwitchVersionHistory(versionHistories, versionHistory1)
s.NoError(err)
s.mockMutableState.EXPECT().GetUpdateCondition().Return(updateCondition, dbVersion).AnyTimes()
s.mockMutableState.EXPECT().GetExecutionInfo().Return(&persistencespb.WorkflowExecutionInfo{
NamespaceId: s.namespaceID,
WorkflowId: s.workflowID,
VersionHistories: versionHistories,
}).AnyTimes()
s.mockMutableState.EXPECT().GetExecutionState().Return(&persistencespb.WorkflowExecutionState{
RunId: s.runID,
}).AnyTimes()
s.mockMutableState.EXPECT().GetHistorySize().Return(historySize).AnyTimes()
s.mockMutableState.EXPECT().GetExternalPayloadSize().Return(externalPayloadSize).AnyTimes()
s.mockMutableState.EXPECT().GetExternalPayloadCount().Return(externalPayloadCount).AnyTimes()
workflowKey := definition.NewWorkflowKey(
s.namespaceID,
s.workflowID,
s.runID,
)
mockRebuildMutableState := historyi.NewMockMutableState(s.controller)
mockRebuildMutableState.EXPECT().GetExecutionInfo().Return(
&persistencespb.WorkflowExecutionInfo{
VersionHistories: versionhistory.NewVersionHistories(
versionhistory.NewVersionHistory(
branchToken1,
[]*historyspb.VersionHistoryItem{versionhistory.NewVersionHistoryItem(lastEventID1, version)},
),
),
},
).AnyTimes()
mockRebuildMutableState.EXPECT().AddHistorySize(historySize)
mockRebuildMutableState.EXPECT().AddExternalPayloadSize(externalPayloadSize)
mockRebuildMutableState.EXPECT().AddExternalPayloadCount(externalPayloadCount)
mockRebuildMutableState.EXPECT().SetUpdateCondition(updateCondition, dbVersion)
s.mockStateBuilder.EXPECT().Rebuild(
ctx,
gomock.Any(),
workflowKey,
branchToken1,
lastEventID1,
util.Ptr(version),
workflowKey,
branchToken1,
requestID,
).Return(mockRebuildMutableState, RebuildStats{
HistorySize: rand.Int63(),
ExternalPayloadSize: rand.Int63(),
ExternalPayloadCount: rand.Int63(),
}, nil)
s.mockContext.EXPECT().Clear()
rebuiltMutableState, err := s.nDCConflictResolver.rebuild(ctx, 1, requestID)
s.NoError(err)
s.NotNil(rebuiltMutableState)
s.Equal(int32(1), versionHistories.GetCurrentVersionHistoryIndex())
}
func (s *conflictResolverSuite) TestGetOrRebuildCurrentMutableState_NoRebuild_NotCurrent() {
branchToken0 := []byte("some random branch token")
lastEventID0 := int64(2)
version0 := int64(12)
versionHistoryItem0 := versionhistory.NewVersionHistoryItem(lastEventID0, version0)
versionHistory0 := versionhistory.NewVersionHistory(
branchToken0,
[]*historyspb.VersionHistoryItem{versionHistoryItem0},
)
branchToken1 := []byte("another random branch token")
lastEventID1 := lastEventID0 + 1
version1 := version0 + 1
versionHistoryItem1 := versionhistory.NewVersionHistoryItem(lastEventID1, version1)
versionHistory1 := versionhistory.NewVersionHistory(
branchToken1,
[]*historyspb.VersionHistoryItem{versionHistoryItem0, versionHistoryItem1},
)
versionHistories := versionhistory.NewVersionHistories(versionHistory0)
_, _, err := versionhistory.AddAndSwitchVersionHistory(versionHistories, versionHistory1)
s.Nil(err)
s.mockMutableState.EXPECT().GetExecutionInfo().Return(&persistencespb.WorkflowExecutionInfo{VersionHistories: versionHistories}).AnyTimes()
rebuiltMutableState, isRebuilt, err := s.nDCConflictResolver.GetOrRebuildCurrentMutableState(context.Background(), 0, version0)
s.NoError(err)
s.False(isRebuilt)
s.Equal(s.mockMutableState, rebuiltMutableState)
}
func (s *conflictResolverSuite) TestGetOrRebuildCurrentMutableState_NoRebuild_SameIndex() {
branchToken := []byte("some random branch token")
lastEventID := int64(2)
version := int64(12)
versionHistoryItem := versionhistory.NewVersionHistoryItem(lastEventID, version)
versionHistory := versionhistory.NewVersionHistory(
branchToken,
[]*historyspb.VersionHistoryItem{versionHistoryItem},
)
versionHistories := versionhistory.NewVersionHistories(versionHistory)
s.mockMutableState.EXPECT().GetExecutionInfo().Return(&persistencespb.WorkflowExecutionInfo{VersionHistories: versionHistories}).AnyTimes()
rebuiltMutableState, isRebuilt, err := s.nDCConflictResolver.GetOrRebuildCurrentMutableState(context.Background(), 0, version)
s.NoError(err)
s.False(isRebuilt)
s.Equal(s.mockMutableState, rebuiltMutableState)
}
func (s *conflictResolverSuite) TestGetOrRebuildCurrentMutableState_Rebuild() {
ctx := context.Background()
updateCondition := int64(59)
dbVersion := int64(1444)
version := int64(12)
incomingVersion := version + 1
historySize := int64(12345)
// current branch
branchToken0 := []byte("some random branch token")
lastEventID0 := int64(2)
versionHistoryItem0 := versionhistory.NewVersionHistoryItem(lastEventID0, version)
versionHistory0 := versionhistory.NewVersionHistory(
branchToken0,
[]*historyspb.VersionHistoryItem{versionHistoryItem0},
)
// stale branch, used for Rebuild
branchToken1 := []byte("other random branch token")
lastEventID1 := lastEventID0 - 1
versionHistoryItem1 := versionhistory.NewVersionHistoryItem(lastEventID1, version)
versionHistory1 := versionhistory.NewVersionHistory(
branchToken1,
[]*historyspb.VersionHistoryItem{versionHistoryItem1},
)
versionHistories := versionhistory.NewVersionHistories(versionHistory0)
_, _, err := versionhistory.AddAndSwitchVersionHistory(versionHistories, versionHistory1)
s.Nil(err)
s.mockMutableState.EXPECT().GetUpdateCondition().Return(updateCondition, dbVersion).AnyTimes()
s.mockMutableState.EXPECT().GetExecutionInfo().Return(&persistencespb.WorkflowExecutionInfo{
NamespaceId: s.namespaceID,
WorkflowId: s.workflowID,
VersionHistories: versionHistories,
}).AnyTimes()
s.mockMutableState.EXPECT().GetExecutionState().Return(&persistencespb.WorkflowExecutionState{
RunId: s.runID,
}).AnyTimes()
s.mockMutableState.EXPECT().GetHistorySize().Return(historySize).AnyTimes()
externalPayloadSize := int64(6789)
externalPayloadCount := int64(42)
s.mockMutableState.EXPECT().GetExternalPayloadSize().Return(externalPayloadSize).AnyTimes()
s.mockMutableState.EXPECT().GetExternalPayloadCount().Return(externalPayloadCount).AnyTimes()
workflowKey := definition.NewWorkflowKey(
s.namespaceID,
s.workflowID,
s.runID,
)
mockRebuildMutableState := historyi.NewMockMutableState(s.controller)
mockRebuildMutableState.EXPECT().GetExecutionInfo().Return(
&persistencespb.WorkflowExecutionInfo{
VersionHistories: versionhistory.NewVersionHistories(
versionhistory.NewVersionHistory(
branchToken1,
[]*historyspb.VersionHistoryItem{versionhistory.NewVersionHistoryItem(lastEventID1, version)},
),
),
},
).AnyTimes()
mockRebuildMutableState.EXPECT().AddHistorySize(historySize)
mockRebuildMutableState.EXPECT().AddExternalPayloadSize(externalPayloadSize)
mockRebuildMutableState.EXPECT().AddExternalPayloadCount(externalPayloadCount)
mockRebuildMutableState.EXPECT().SetUpdateCondition(updateCondition, dbVersion)
s.mockStateBuilder.EXPECT().Rebuild(
ctx,
gomock.Any(),
workflowKey,
branchToken1,
lastEventID1,
util.Ptr(version),
workflowKey,
branchToken1,
gomock.Any(),
).Return(mockRebuildMutableState, RebuildStats{
HistorySize: rand.Int63(),
ExternalPayloadSize: rand.Int63(),
ExternalPayloadCount: rand.Int63(),
}, nil)
s.mockContext.EXPECT().Clear()
rebuiltMutableState, isRebuilt, err := s.nDCConflictResolver.GetOrRebuildCurrentMutableState(ctx, 1, incomingVersion)
s.NoError(err)
s.NotNil(rebuiltMutableState)
s.True(isRebuilt)
}
func (s *conflictResolverSuite) TestGetOrRebuildMutableState_NoRebuild_SameIndex() {
branchToken := []byte("some random branch token")
lastEventID := int64(2)
version := int64(12)
versionHistoryItem := versionhistory.NewVersionHistoryItem(lastEventID, version)
versionHistory := versionhistory.NewVersionHistory(
branchToken,
[]*historyspb.VersionHistoryItem{versionHistoryItem},
)
versionHistories := versionhistory.NewVersionHistories(versionHistory)
s.mockMutableState.EXPECT().GetExecutionInfo().Return(&persistencespb.WorkflowExecutionInfo{VersionHistories: versionHistories}).AnyTimes()
rebuiltMutableState, isRebuilt, err := s.nDCConflictResolver.GetOrRebuildMutableState(context.Background(), 0)
s.NoError(err)
s.False(isRebuilt)
s.Equal(s.mockMutableState, rebuiltMutableState)
}
func (s *conflictResolverSuite) TestGetOrRebuildMutableState_Rebuild() {
ctx := context.Background()
updateCondition := int64(59)
dbVersion := int64(1444)
version := int64(12)
historySize := int64(12345)
externalPayloadSize := int64(6789)
externalPayloadCount := int64(42)
// current branch
branchToken0 := []byte("some random branch token")
lastEventID0 := int64(2)
versionHistoryItem0 := versionhistory.NewVersionHistoryItem(lastEventID0, version)
versionHistory0 := versionhistory.NewVersionHistory(
branchToken0,
[]*historyspb.VersionHistoryItem{versionHistoryItem0},
)
// stale branch, used for Rebuild
branchToken1 := []byte("other random branch token")
lastEventID1 := lastEventID0 - 1
versionHistoryItem1 := versionhistory.NewVersionHistoryItem(lastEventID1, version)
versionHistory1 := versionhistory.NewVersionHistory(
branchToken1,
[]*historyspb.VersionHistoryItem{versionHistoryItem1},
)
versionHistories := versionhistory.NewVersionHistories(versionHistory0)
_, _, err := versionhistory.AddAndSwitchVersionHistory(versionHistories, versionHistory1)
s.Nil(err)
s.mockMutableState.EXPECT().GetUpdateCondition().Return(updateCondition, dbVersion).AnyTimes()
s.mockMutableState.EXPECT().GetExecutionInfo().Return(&persistencespb.WorkflowExecutionInfo{
NamespaceId: s.namespaceID,
WorkflowId: s.workflowID,
VersionHistories: versionHistories,
}).AnyTimes()
s.mockMutableState.EXPECT().GetExecutionState().Return(&persistencespb.WorkflowExecutionState{
RunId: s.runID,
}).AnyTimes()
s.mockMutableState.EXPECT().GetHistorySize().Return(historySize).AnyTimes()
s.mockMutableState.EXPECT().GetExternalPayloadSize().Return(externalPayloadSize).AnyTimes()
s.mockMutableState.EXPECT().GetExternalPayloadCount().Return(externalPayloadCount).AnyTimes()
workflowKey := definition.NewWorkflowKey(
s.namespaceID,
s.workflowID,
s.runID,
)
mockRebuildMutableState := historyi.NewMockMutableState(s.controller)
mockRebuildMutableState.EXPECT().GetExecutionInfo().Return(
&persistencespb.WorkflowExecutionInfo{
VersionHistories: versionhistory.NewVersionHistories(
versionhistory.NewVersionHistory(
branchToken1,
[]*historyspb.VersionHistoryItem{versionhistory.NewVersionHistoryItem(lastEventID1, version)},
),
),
},
).AnyTimes()
mockRebuildMutableState.EXPECT().AddHistorySize(historySize)
mockRebuildMutableState.EXPECT().AddExternalPayloadSize(externalPayloadSize)
mockRebuildMutableState.EXPECT().AddExternalPayloadCount(externalPayloadCount)
mockRebuildMutableState.EXPECT().SetUpdateCondition(updateCondition, dbVersion)
s.mockStateBuilder.EXPECT().Rebuild(
ctx,
gomock.Any(),
workflowKey,
branchToken1,
lastEventID1,
util.Ptr(version),
workflowKey,
branchToken1,
gomock.Any(),
).Return(mockRebuildMutableState, RebuildStats{
HistorySize: rand.Int63(),
ExternalPayloadSize: rand.Int63(),
ExternalPayloadCount: rand.Int63(),
}, nil)
s.mockContext.EXPECT().Clear()
rebuiltMutableState, isRebuilt, err := s.nDCConflictResolver.GetOrRebuildMutableState(ctx, 1)
s.NoError(err)
s.NotNil(rebuiltMutableState)
s.True(isRebuilt)
}