Skip to content

Trim SyncWorkflowState request branch token and log request size when error #8794

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
xwduan merged 4 commits into from
Dec 12, 2025
Merged

Trim SyncWorkflowState request branch token and log request size when error #8794

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6e07d16
Trim request branch token and log request size when error
xwduan Dec 10, 2025
12a90f0
Merge branch 'main' into will/add_log_for_sync_workflow_state
xwduan Dec 11, 2025
477a5f1
Merge branch 'main' into will/add_log_for_sync_workflow_state
xwduan Dec 11, 2025
345edd6
fix unit test
xwduan Dec 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 18 additions & 3 deletions service/history/replication/executable_task.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -622,18 +622,33 @@ func (e *ExecutableTaskImpl) SyncState(
}

targetClusterInfo := e.ClusterMetadata.GetAllClusterInfo()[e.ClusterMetadata.GetCurrentClusterName()]
resp, err := remoteAdminClient.SyncWorkflowState(ctx, &adminservice.SyncWorkflowStateRequest{

// Remove branch tokens from version histories to reduce request size
versionHistories := syncStateErr.VersionHistories
if versionHistories != nil {
versionHistories = versionhistory.CopyVersionHistories(versionHistories)
for _, history := range versionHistories.Histories {
history.BranchToken = nil
}
}

req := &adminservice.SyncWorkflowStateRequest{
NamespaceId: syncStateErr.NamespaceId,
Execution: &commonpb.WorkflowExecution{
WorkflowId: syncStateErr.WorkflowId,
RunId: syncStateErr.RunId,
},
ArchetypeId: syncStateErr.ArchetypeId,
VersionedTransition: syncStateErr.VersionedTransition,
VersionHistories: syncStateErr.VersionHistories,
VersionHistories: versionHistories,
TargetClusterId: int32(targetClusterInfo.InitialFailoverVersion),
})
}
resp, err := remoteAdminClient.SyncWorkflowState(ctx, req)
if err != nil {
var resourceExhaustedError *serviceerror.ResourceExhausted
if errors.As(err, &resourceExhaustedError) {
return false, serviceerror.NewInvalidArgumentf("sync workflow state failed due to resource exhausted: %v, request payload size: %v", err, req.Size())
}
logger := log.With(e.Logger,
tag.WorkflowNamespaceID(syncStateErr.NamespaceId),
tag.WorkflowID(syncStateErr.WorkflowId),
Expand Down
39 changes: 33 additions & 6 deletions service/history/replication/executable_task_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -580,8 +580,17 @@ func (s *executableTaskSuite) TestResend_TransitionHistoryDisabled() {
},
ArchetypeId: syncStateErr.ArchetypeId,
VersionedTransition: syncStateErr.VersionedTransition,
VersionHistories: syncStateErr.VersionHistories,
TargetClusterId: int32(s.clusterMetadata.GetAllClusterInfo()[s.clusterMetadata.GetCurrentClusterName()].InitialFailoverVersion),
VersionHistories: &historyspb.VersionHistories{
Histories: []*historyspb.VersionHistory{
{
// BranchToken is removed in the actual implementation
Items: []*historyspb.VersionHistoryItem{
{EventId: 102, Version: 1234},
},
},
},
},
TargetClusterId: int32(s.clusterMetadata.GetAllClusterInfo()[s.clusterMetadata.GetCurrentClusterName()].InitialFailoverVersion),
},
).Return(nil, consts.ErrTransitionHistoryDisabled).Times(1)

Expand Down Expand Up @@ -636,8 +645,17 @@ func (s *executableTaskSuite) TestSyncState_SourceMutableStateHasUnFlushedBuffer
},
ArchetypeId: chasm.WorkflowArchetypeID,
VersionedTransition: syncStateErr.VersionedTransition,
VersionHistories: syncStateErr.VersionHistories,
TargetClusterId: int32(s.clusterMetadata.GetAllClusterInfo()[s.clusterMetadata.GetCurrentClusterName()].InitialFailoverVersion),
VersionHistories: &historyspb.VersionHistories{
Histories: []*historyspb.VersionHistory{
{
// BranchToken is removed in the actual implementation
Items: []*historyspb.VersionHistoryItem{
{EventId: 102, Version: 1234},
},
},
},
},
TargetClusterId: int32(s.clusterMetadata.GetAllClusterInfo()[s.clusterMetadata.GetCurrentClusterName()].InitialFailoverVersion),
},
).Return(nil, serviceerror.NewWorkflowNotReady("workflow not ready")).Times(1)

Expand Down Expand Up @@ -1134,8 +1152,17 @@ func (s *executableTaskSuite) TestSyncState() {
},
ArchetypeId: chasm.WorkflowArchetypeID,
VersionedTransition: syncStateErr.VersionedTransition,
VersionHistories: syncStateErr.VersionHistories,
TargetClusterId: int32(s.clusterMetadata.GetAllClusterInfo()[s.clusterMetadata.GetCurrentClusterName()].InitialFailoverVersion),
VersionHistories: &historyspb.VersionHistories{
Histories: []*historyspb.VersionHistory{
{
// BranchToken is removed in the actual implementation
Items: []*historyspb.VersionHistoryItem{
{EventId: 102, Version: 1234},
},
},
},
},
TargetClusterId: int32(s.clusterMetadata.GetAllClusterInfo()[s.clusterMetadata.GetCurrentClusterName()].InitialFailoverVersion),
},
).Return(&adminservice.SyncWorkflowStateResponse{
VersionedTransitionArtifact: versionedTransitionArtifact,
Expand Down
Loading