Files
zeekay 40351cce6f rip: delete temporal fork — native ZAP-only tasksd
Goes from 135 MB binary with 1153 files importing go.temporal.io and 224
importing google.golang.org/grpc to a 10 MB native binary with ZERO of
either.

Deleted:
- tasks/, tasktests/, service/, chasm/, client/, api/, proto/, tools/
- cmd/tools/, components/, docker/
- schema/{cassandra,elasticsearch,mysql,postgresql,sqlite}/
- 40 tainted common/ subdirs + 7 top-level common files
- tests/testutils (no longer referenced after surviving deps drop common)

New cmd/tasksd (~100 lines) boots tasks.Embed (zap.Node) + http.Server.
New pkg/tasks/embed.go registers ZAP handlers for the SDK opcode surface
(0x0060-0x00A5). Workflow handlers return a 501 "not yet implemented"
envelope; native engine lands behind this contract.

Build:  go build ./cmd/tasksd → 10 MB
Vet:    go vet ./... → clean
Boot:   tasksd --zap-port 9999 --http :7243
Probes: /healthz, /v1/tasks/health → 200
UI:     /_/tasks/, / → 200 (embedded Vite bundle)
ZAP:    _tasks._tcp on :9999 (mDNS disabled; direct connect)

go.mod: tidy. No go.temporal.io. No google.golang.org/grpc.
2026-04-26 14:06:21 -07:00

869 lines
34 KiB
Go

package respondworkflowtaskcompleted
import (
"context"
"errors"
"maps"
"testing"
"time"
"github.com/stretchr/testify/require"
"github.com/stretchr/testify/suite"
commandpb "go.temporal.io/api/command/v1"
enumspb "go.temporal.io/api/enums/v1"
historypb "go.temporal.io/api/history/v1"
protocolpb "go.temporal.io/api/protocol/v1"
querypb "go.temporal.io/api/query/v1"
"go.temporal.io/api/serviceerror"
updatepb "go.temporal.io/api/update/v1"
"go.temporal.io/api/workflowservice/v1"
enumsspb "go.temporal.io/server/api/enums/v1"
"go.temporal.io/server/api/historyservice/v1"
persistencespb "go.temporal.io/server/api/persistence/v1"
tokenspb "go.temporal.io/server/api/token/v1"
"go.temporal.io/server/common"
"go.temporal.io/server/common/clock"
"go.temporal.io/server/common/cluster"
"go.temporal.io/server/common/contextutil"
"go.temporal.io/server/common/effect"
"go.temporal.io/server/common/locks"
"go.temporal.io/server/common/log"
"go.temporal.io/server/common/metrics"
"go.temporal.io/server/common/namespace"
"go.temporal.io/server/common/payloads"
"go.temporal.io/server/common/persistence"
"go.temporal.io/server/common/tasktoken"
"go.temporal.io/server/common/testing/historyrequire"
"go.temporal.io/server/common/testing/protorequire"
"go.temporal.io/server/common/testing/protoutils"
"go.temporal.io/server/common/testing/testvars"
"go.temporal.io/server/common/testing/updateutils"
"go.temporal.io/server/service/history/api"
"go.temporal.io/server/service/history/events"
"go.temporal.io/server/service/history/hsm"
historyi "go.temporal.io/server/service/history/interfaces"
"go.temporal.io/server/service/history/shard"
"go.temporal.io/server/service/history/tests"
"go.temporal.io/server/service/history/workflow"
wcache "go.temporal.io/server/service/history/workflow/cache"
"go.temporal.io/server/service/history/workflow/update"
"go.uber.org/mock/gomock"
)
type (
WorkflowTaskCompletedHandlerSuite struct {
suite.Suite
*require.Assertions
protorequire.ProtoAssertions
historyrequire.HistoryRequire
updateutils.UpdateUtils
controller *gomock.Controller
mockShard *shard.ContextTest
mockEventsCache *events.MockCache
mockExecutionMgr *persistence.MockExecutionManager
workflowCache wcache.Cache
mockNamespaceCache *namespace.MockRegistry
logger log.Logger
workflowTaskCompletedHandler *WorkflowTaskCompletedHandler
}
)
func TestWorkflowTaskCompletedHandlerSuite(t *testing.T) {
suite.Run(t, new(WorkflowTaskCompletedHandlerSuite))
}
func (s *WorkflowTaskCompletedHandlerSuite) SetupSubTest() {
s.Assertions = require.New(s.T())
s.ProtoAssertions = protorequire.New(s.T())
s.HistoryRequire = historyrequire.New(s.T())
s.UpdateUtils = updateutils.New(s.T())
s.controller = gomock.NewController(s.T())
config := tests.NewDynamicConfig()
s.mockShard = shard.NewTestContext(
s.controller,
&persistencespb.ShardInfo{
ShardId: 1,
RangeId: 1,
},
config,
)
reg := hsm.NewRegistry()
err := workflow.RegisterStateMachine(reg)
s.NoError(err)
s.mockShard.SetStateMachineRegistry(reg)
mockEngine := historyi.NewMockEngine(s.controller)
mockEngine.EXPECT().NotifyNewHistoryEvent(gomock.Any()).AnyTimes()
mockEngine.EXPECT().NotifyNewTasks(gomock.Any()).AnyTimes()
s.mockShard.SetEngineForTesting(mockEngine)
s.mockNamespaceCache = s.mockShard.Resource.NamespaceCache
s.mockExecutionMgr = s.mockShard.Resource.ExecutionMgr
s.mockShard.Resource.ShardMgr.EXPECT().UpdateShard(gomock.Any(), gomock.Any()).Return(nil).AnyTimes()
mockClusterMetadata := s.mockShard.Resource.ClusterMetadata
mockClusterMetadata.EXPECT().GetClusterID().Return(int64(1)).AnyTimes()
mockClusterMetadata.EXPECT().GetCurrentClusterName().Return(cluster.TestCurrentClusterName).AnyTimes()
mockClusterMetadata.EXPECT().ClusterNameForFailoverVersion(false, common.EmptyVersion).Return(cluster.TestCurrentClusterName).AnyTimes()
mockClusterMetadata.EXPECT().ClusterNameForFailoverVersion(true, tests.Version).Return(cluster.TestCurrentClusterName).AnyTimes()
mockClusterMetadata.EXPECT().GetAllClusterInfo().Return(nil).AnyTimes()
s.mockEventsCache = s.mockShard.MockEventsCache
s.mockEventsCache.EXPECT().PutEvent(gomock.Any(), gomock.Any()).AnyTimes()
s.logger = s.mockShard.GetLogger()
s.workflowCache = wcache.NewHostLevelCache(s.mockShard.GetConfig(), s.mockShard.GetLogger(), metrics.NoopMetricsHandler)
s.workflowTaskCompletedHandler = NewWorkflowTaskCompletedHandler(
s.mockShard,
tasktoken.NewSerializer(),
events.NewNotifier(clock.NewRealTimeSource(), metrics.NoopMetricsHandler, func(namespace.ID, string) int32 { return 1 }),
nil,
nil,
nil,
nil,
api.NewWorkflowConsistencyChecker(s.mockShard, s.workflowCache),
nil,
nil,
)
}
func (s *WorkflowTaskCompletedHandlerSuite) TearDownTest() {
s.controller.Finish()
}
func (s *WorkflowTaskCompletedHandlerSuite) TestUpdateWorkflow() {
createWrittenHistoryCh := func(expectedUpdateWorkflowExecutionCalls int) <-chan []*historypb.HistoryEvent {
writtenHistoryCh := make(chan []*historypb.HistoryEvent, expectedUpdateWorkflowExecutionCalls)
s.mockExecutionMgr.EXPECT().UpdateWorkflowExecution(gomock.Any(), gomock.Any()).DoAndReturn(func(_ context.Context, request *persistence.UpdateWorkflowExecutionRequest) (*persistence.UpdateWorkflowExecutionResponse, error) {
var wfEvents []*persistence.WorkflowEvents
if len(request.UpdateWorkflowEvents) > 0 {
wfEvents = request.UpdateWorkflowEvents
} else {
wfEvents = request.NewWorkflowEvents
}
var historyEvents []*historypb.HistoryEvent
for _, uwe := range wfEvents {
for _, event := range uwe.Events {
historyEvents = append(historyEvents, event)
}
}
writtenHistoryCh <- historyEvents
return tests.UpdateWorkflowExecutionResponse, nil
}).Times(expectedUpdateWorkflowExecutionCalls)
return writtenHistoryCh
}
s.Run("Accept Complete", func() {
tv := testvars.New(s.T())
tv = tv.WithRunID(tv.Any().RunID())
s.mockNamespaceCache.EXPECT().GetNamespaceByID(tv.NamespaceID()).Return(tv.Namespace(), nil).AnyTimes()
wfContext := s.createStartedWorkflow(tv)
writtenHistoryCh := createWrittenHistoryCh(1)
_, err := wfContext.LoadMutableState(context.Background(), s.workflowTaskCompletedHandler.shardContext)
s.NoError(err)
updRequestMsg, upd, serializedTaskToken := s.createSentUpdate(tv, wfContext)
s.NotNil(upd)
// Use context with metadata to verify it's set via transaction close
ctx := contextutil.WithMetadataContext(context.Background())
_, err = s.workflowTaskCompletedHandler.Invoke(ctx, &historyservice.RespondWorkflowTaskCompletedRequest{
NamespaceId: tv.NamespaceID().String(),
CompleteRequest: &workflowservice.RespondWorkflowTaskCompletedRequest{
TaskToken: serializedTaskToken,
Commands: s.UpdateAcceptCompleteCommands(tv),
Messages: s.UpdateAcceptCompleteMessages(tv, updRequestMsg),
Identity: tv.Any().String(),
},
})
s.NoError(err)
updStatus, err := upd.WaitLifecycleStage(context.Background(), enumspb.UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_UNSPECIFIED, time.Duration(0))
s.NoError(err)
s.Equal(enumspb.UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_COMPLETED.String(), updStatus.Stage.String())
s.ProtoEqual(payloads.EncodeString("success-result-of-"+tv.UpdateID()), updStatus.Outcome.GetSuccess())
s.EqualHistoryEvents(`
2 WorkflowTaskScheduled // Speculative WFT events are persisted on WFT completion.
3 WorkflowTaskStarted // Speculative WFT events are persisted on WFT completion.
4 WorkflowTaskCompleted
5 WorkflowExecutionUpdateAccepted
6 WorkflowExecutionUpdateCompleted`, <-writtenHistoryCh)
// VERIFY: Context metadata set via transaction close (normal case WITH commands)
contextWorkflowType, ok := contextutil.ContextMetadataGet(ctx, contextutil.MetadataKeyWorkflowType)
s.True(ok, "context workflow type MUST be set in normal case with commands")
s.Equal(tv.WorkflowType().GetName(), contextWorkflowType)
contextTaskQueue, ok := contextutil.ContextMetadataGet(ctx, contextutil.MetadataKeyWorkflowTaskQueue)
s.True(ok, "context task queue MUST be set in normal case with commands")
s.Equal(tv.TaskQueue().GetName(), contextTaskQueue)
})
s.Run("Reject", func() {
tv := testvars.New(s.T())
tv = tv.WithRunID(tv.Any().RunID())
s.mockNamespaceCache.EXPECT().GetNamespaceByID(tv.NamespaceID()).Return(tv.Namespace(), nil).AnyTimes()
wfContext := s.createStartedWorkflow(tv)
updRequestMsg, upd, serializedTaskToken := s.createSentUpdate(tv, wfContext)
s.NotNil(upd)
// Use context with metadata support to verify SetContextMetadata is called
ctx := contextutil.WithMetadataContext(context.Background())
_, err := s.workflowTaskCompletedHandler.Invoke(ctx, &historyservice.RespondWorkflowTaskCompletedRequest{
NamespaceId: tv.NamespaceID().String(),
CompleteRequest: &workflowservice.RespondWorkflowTaskCompletedRequest{
TaskToken: serializedTaskToken,
Messages: s.UpdateRejectMessages(tv, updRequestMsg),
Identity: tv.Any().String(),
},
})
s.NoError(err)
updStatus, err := upd.WaitLifecycleStage(context.Background(), enumspb.UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_UNSPECIFIED, time.Duration(0))
s.NoError(err)
s.Equal(enumspb.UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_COMPLETED.String(), updStatus.Stage.String())
s.Equal("rejection-of-"+tv.UpdateID(), updStatus.Outcome.GetFailure().GetMessage())
// VERIFY: Context metadata set for readonly operation (no commands, only messages)
contextWorkflowType, ok := contextutil.ContextMetadataGet(ctx, contextutil.MetadataKeyWorkflowType)
s.True(ok, "context workflow type MUST be set for readonly operation")
s.Equal(tv.WorkflowType().GetName(), contextWorkflowType)
contextTaskQueue, ok := contextutil.ContextMetadataGet(ctx, contextutil.MetadataKeyWorkflowTaskQueue)
s.True(ok, "context task queue MUST be set for readonly operation")
s.Equal(tv.TaskQueue().GetName(), contextTaskQueue)
})
s.Run("Heartbeat (empty completion)", func() {
tv := testvars.New(s.T())
tv = tv.WithRunID(tv.Any().RunID())
s.mockNamespaceCache.EXPECT().GetNamespaceByID(tv.NamespaceID()).Return(tv.Namespace(), nil).AnyTimes()
wfContext := s.createStartedWorkflow(tv)
_, _, serializedTaskToken := s.createSentUpdate(tv, wfContext)
// Use context with metadata support to verify SetContextMetadata is called
ctx := contextutil.WithMetadataContext(context.Background())
_, err := s.workflowTaskCompletedHandler.Invoke(ctx, &historyservice.RespondWorkflowTaskCompletedRequest{
NamespaceId: tv.NamespaceID().String(),
CompleteRequest: &workflowservice.RespondWorkflowTaskCompletedRequest{
TaskToken: serializedTaskToken,
// No Commands, no Messages - this is a workflow task heartbeat
Identity: tv.Any().String(),
},
})
s.NoError(err)
// VERIFY: Context metadata set for heartbeat (no commands, no messages)
contextWorkflowType, ok := contextutil.ContextMetadataGet(ctx, contextutil.MetadataKeyWorkflowType)
s.True(ok, "context workflow type MUST be set for heartbeat")
s.Equal(tv.WorkflowType().GetName(), contextWorkflowType)
contextTaskQueue, ok := contextutil.ContextMetadataGet(ctx, contextutil.MetadataKeyWorkflowTaskQueue)
s.True(ok, "context task queue MUST be set for heartbeat")
s.Equal(tv.TaskQueue().GetName(), contextTaskQueue)
})
s.Run("Write failed on normal task queue", func() {
tv := testvars.New(s.T())
tv = tv.WithRunID(tv.Any().RunID())
s.mockNamespaceCache.EXPECT().GetNamespaceByID(tv.NamespaceID()).Return(tv.Namespace(), nil).AnyTimes()
wfContext := s.createStartedWorkflow(tv)
writeErr := errors.New("write failed")
s.mockExecutionMgr.EXPECT().UpdateWorkflowExecution(gomock.Any(), gomock.Any()).Return(nil, writeErr)
updRequestMsg, upd, serializedTaskToken := s.createSentUpdate(tv, wfContext)
s.NotNil(upd)
ctx := contextutil.WithMetadataContext(context.Background())
_, err := s.workflowTaskCompletedHandler.Invoke(ctx, &historyservice.RespondWorkflowTaskCompletedRequest{
NamespaceId: tv.NamespaceID().String(),
CompleteRequest: &workflowservice.RespondWorkflowTaskCompletedRequest{
TaskToken: serializedTaskToken,
Commands: s.UpdateAcceptCompleteCommands(tv),
Messages: s.UpdateAcceptCompleteMessages(tv, updRequestMsg),
Identity: tv.Any().String(),
},
})
s.ErrorIs(err, writeErr)
s.Nil(wfContext.(*workflow.ContextImpl).MutableState, "mutable state must be cleared")
// VERIFY: Context metadata set even when write fails (transaction close is attempted)
contextWorkflowType, ok := contextutil.ContextMetadataGet(ctx, contextutil.MetadataKeyWorkflowType)
s.True(ok, "context workflow type MUST be set even when write fails")
s.Equal(tv.WorkflowType().GetName(), contextWorkflowType)
contextTaskQueue, ok := contextutil.ContextMetadataGet(ctx, contextutil.MetadataKeyWorkflowTaskQueue)
s.True(ok, "context task queue MUST be set even when write fails")
s.Equal(tv.TaskQueue().GetName(), contextTaskQueue)
})
s.Run("Write failed on sticky task queue", func() {
tv := testvars.New(s.T())
tv = tv.WithRunID(tv.Any().RunID())
s.mockNamespaceCache.EXPECT().GetNamespaceByID(tv.NamespaceID()).Return(tv.Namespace(), nil).AnyTimes()
wfContext := s.createStartedWorkflow(tv)
writeErr := serviceerror.NewResourceExhausted(enumspb.RESOURCE_EXHAUSTED_CAUSE_PERSISTENCE_STORAGE_LIMIT, "write failed")
// First write of MS
s.mockExecutionMgr.EXPECT().UpdateWorkflowExecution(gomock.Any(), gomock.Any()).Return(nil, writeErr)
// Second write of MS to clear stickiness
s.mockExecutionMgr.EXPECT().UpdateWorkflowExecution(gomock.Any(), gomock.Any()).Return(tests.UpdateWorkflowExecutionResponse, nil)
updRequestMsg, upd, serializedTaskToken := s.createSentUpdate(tv, wfContext)
s.NotNil(upd)
ctx := contextutil.WithMetadataContext(context.Background())
_, err := s.workflowTaskCompletedHandler.Invoke(ctx, &historyservice.RespondWorkflowTaskCompletedRequest{
NamespaceId: tv.NamespaceID().String(),
CompleteRequest: &workflowservice.RespondWorkflowTaskCompletedRequest{
TaskToken: serializedTaskToken,
Commands: s.UpdateAcceptCompleteCommands(tv),
Messages: s.UpdateAcceptCompleteMessages(tv, updRequestMsg),
Identity: tv.Any().String(),
StickyAttributes: tv.StickyExecutionAttributes(tv.Any().InfiniteTimeout().AsDuration()),
},
})
s.ErrorIs(err, writeErr)
s.Nil(wfContext.(*workflow.ContextImpl).MutableState, "mutable state must be cleared")
// VERIFY: Context metadata set even when sticky write fails
contextWorkflowType, ok := contextutil.ContextMetadataGet(ctx, contextutil.MetadataKeyWorkflowType)
s.True(ok, "context workflow type MUST be set even when sticky write fails")
s.Equal(tv.WorkflowType().GetName(), contextWorkflowType)
contextTaskQueue, ok := contextutil.ContextMetadataGet(ctx, contextutil.MetadataKeyWorkflowTaskQueue)
s.True(ok, "context task queue MUST be set even when sticky write fails")
s.Equal(tv.TaskQueue().GetName(), contextTaskQueue)
})
s.Run("GetHistory failed", func() {
tv := testvars.New(s.T())
tv = tv.WithRunID(tv.Any().RunID())
s.mockNamespaceCache.EXPECT().GetNamespaceByID(tv.NamespaceID()).Return(tv.Namespace(), nil).AnyTimes()
s.mockNamespaceCache.EXPECT().GetNamespaceName(tv.NamespaceID()).Return(tv.NamespaceName(), nil).AnyTimes()
wfContext := s.createStartedWorkflow(tv)
writtenHistoryCh := createWrittenHistoryCh(1)
updRequestMsg, upd, serializedTaskToken := s.createSentUpdate(tv, wfContext)
s.NotNil(upd)
readHistoryErr := errors.New("get history failed")
s.mockExecutionMgr.EXPECT().ReadHistoryBranch(gomock.Any(), gomock.Any()).Return(nil, readHistoryErr)
ctx := contextutil.WithMetadataContext(context.Background())
_, err := s.workflowTaskCompletedHandler.Invoke(ctx, &historyservice.RespondWorkflowTaskCompletedRequest{
NamespaceId: tv.NamespaceID().String(),
CompleteRequest: &workflowservice.RespondWorkflowTaskCompletedRequest{
TaskToken: serializedTaskToken,
Commands: s.UpdateAcceptCompleteCommands(tv),
Messages: s.UpdateAcceptCompleteMessages(tv, updRequestMsg),
Identity: tv.Any().String(),
ReturnNewWorkflowTask: true,
ForceCreateNewWorkflowTask: true,
},
})
s.ErrorIs(err, readHistoryErr)
updStatus, err := upd.WaitLifecycleStage(context.Background(), enumspb.UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_UNSPECIFIED, time.Duration(0))
s.NoError(err)
s.Equal(enumspb.UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_COMPLETED.String(), updStatus.Stage.String())
s.ProtoEqual(payloads.EncodeString("success-result-of-"+tv.UpdateID()), updStatus.Outcome.GetSuccess())
s.EqualHistoryEvents(`
2 WorkflowTaskScheduled // Speculative WFT events are persisted on WFT completion.
3 WorkflowTaskStarted // Speculative WFT events are persisted on WFT completion.
4 WorkflowTaskCompleted
5 WorkflowExecutionUpdateAccepted
6 WorkflowExecutionUpdateCompleted
7 WorkflowTaskScheduled
8 WorkflowTaskStarted`, <-writtenHistoryCh)
// VERIFY: Context metadata set even when ReadHistoryBranch fails
contextWorkflowType, ok := contextutil.ContextMetadataGet(ctx, contextutil.MetadataKeyWorkflowType)
s.True(ok, "context workflow type MUST be set even when ReadHistoryBranch fails")
s.Equal(tv.WorkflowType().GetName(), contextWorkflowType)
contextTaskQueue, ok := contextutil.ContextMetadataGet(ctx, contextutil.MetadataKeyWorkflowTaskQueue)
s.True(ok, "context task queue MUST be set even when ReadHistoryBranch fails")
s.Equal(tv.TaskQueue().GetName(), contextTaskQueue)
})
s.Run("Discard speculative WFT with events", func() {
tv := testvars.New(s.T())
tv = tv.WithRunID(tv.Any().RunID())
s.mockNamespaceCache.EXPECT().GetNamespaceByID(tv.NamespaceID()).Return(tv.Namespace(), nil).AnyTimes()
wfContext := s.createStartedWorkflow(tv)
// Expect only 2 calls to UpdateWorkflowExecution: for timer started and timer fired events but not Update or WFT events.
writtenHistoryCh := createWrittenHistoryCh(2)
ms, err := wfContext.LoadMutableState(context.Background(), s.workflowTaskCompletedHandler.shardContext)
s.NoError(err)
_, _, err = ms.AddTimerStartedEvent(
1,
&commandpb.StartTimerCommandAttributes{
TimerId: tv.TimerID(),
StartToFireTimeout: tv.Any().InfiniteTimeout(),
},
)
s.NoError(err)
err = wfContext.UpdateWorkflowExecutionAsActive(context.Background(), s.workflowTaskCompletedHandler.shardContext)
s.NoError(err)
s.EqualHistoryEvents(`
2 TimerStarted
`, <-writtenHistoryCh)
updRequestMsg, upd, serializedTaskToken := s.createSentUpdate(tv, wfContext)
s.NotNil(upd)
ctx := contextutil.WithMetadataContext(context.Background())
_, err = s.workflowTaskCompletedHandler.Invoke(ctx, &historyservice.RespondWorkflowTaskCompletedRequest{
NamespaceId: tv.NamespaceID().String(),
CompleteRequest: &workflowservice.RespondWorkflowTaskCompletedRequest{
TaskToken: serializedTaskToken,
Messages: s.UpdateRejectMessages(tv, updRequestMsg),
Identity: tv.Any().String(),
Capabilities: &workflowservice.RespondWorkflowTaskCompletedRequest_Capabilities{
DiscardSpeculativeWorkflowTaskWithEvents: true,
},
},
})
s.NoError(err)
updStatus, err := upd.WaitLifecycleStage(context.Background(), enumspb.UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_UNSPECIFIED, time.Duration(0))
s.NoError(err)
s.Equal(enumspb.UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_COMPLETED.String(), updStatus.Stage.String())
s.Equal("rejection-of-"+tv.UpdateID(), updStatus.Outcome.GetFailure().GetMessage())
ms, err = wfContext.LoadMutableState(context.Background(), s.workflowTaskCompletedHandler.shardContext)
s.NoError(err)
_, err = ms.AddTimerFiredEvent(tv.TimerID())
s.NoError(err)
err = wfContext.UpdateWorkflowExecutionAsActive(context.Background(), s.workflowTaskCompletedHandler.shardContext)
s.NoError(err)
s.EqualHistoryEvents(`
3 TimerFired // No WFT events in between 2 and 3.
`, <-writtenHistoryCh)
// VERIFY: Context metadata set for discard speculative WFT case
contextWorkflowType, ok := contextutil.ContextMetadataGet(ctx, contextutil.MetadataKeyWorkflowType)
s.True(ok, "context workflow type MUST be set when discarding speculative WFT")
s.Equal(tv.WorkflowType().GetName(), contextWorkflowType)
contextTaskQueue, ok := contextutil.ContextMetadataGet(ctx, contextutil.MetadataKeyWorkflowTaskQueue)
s.True(ok, "context task queue MUST be set when discarding speculative WFT")
s.Equal(tv.TaskQueue().GetName(), contextTaskQueue)
})
s.Run("Do not discard speculative WFT with more than 10 events", func() {
tv := testvars.New(s.T())
tv = tv.WithRunID(tv.Any().RunID())
s.mockNamespaceCache.EXPECT().GetNamespaceByID(tv.NamespaceID()).Return(tv.Namespace(), nil).AnyTimes()
wfContext := s.createStartedWorkflow(tv)
// Expect 2 calls to UpdateWorkflowExecution: for timer started and WFT events.
writtenHistoryCh := createWrittenHistoryCh(2)
ms, err := wfContext.LoadMutableState(context.Background(), s.workflowTaskCompletedHandler.shardContext)
s.NoError(err)
for i := range 11 {
_, _, err = ms.AddTimerStartedEvent(
1,
&commandpb.StartTimerCommandAttributes{
TimerId: tv.WithTimerIDNumber(i).TimerID(),
StartToFireTimeout: tv.Any().InfiniteTimeout(),
},
)
s.NoError(err)
}
err = wfContext.UpdateWorkflowExecutionAsActive(context.Background(), s.workflowTaskCompletedHandler.shardContext)
s.NoError(err)
s.EqualHistoryEvents(`
2 TimerStarted
3 TimerStarted
4 TimerStarted
5 TimerStarted
6 TimerStarted
7 TimerStarted
8 TimerStarted
9 TimerStarted
10 TimerStarted
11 TimerStarted
12 TimerStarted
`, <-writtenHistoryCh)
updRequestMsg, upd, serializedTaskToken := s.createSentUpdate(tv, wfContext)
s.NotNil(upd)
ctx := contextutil.WithMetadataContext(context.Background())
_, err = s.workflowTaskCompletedHandler.Invoke(ctx, &historyservice.RespondWorkflowTaskCompletedRequest{
NamespaceId: tv.NamespaceID().String(),
CompleteRequest: &workflowservice.RespondWorkflowTaskCompletedRequest{
TaskToken: serializedTaskToken,
Messages: s.UpdateRejectMessages(tv, updRequestMsg),
Identity: tv.Any().String(),
Capabilities: &workflowservice.RespondWorkflowTaskCompletedRequest_Capabilities{
DiscardSpeculativeWorkflowTaskWithEvents: true,
},
},
})
s.NoError(err)
updStatus, err := upd.WaitLifecycleStage(context.Background(), enumspb.UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_UNSPECIFIED, time.Duration(0))
s.NoError(err)
s.Equal(enumspb.UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_COMPLETED.String(), updStatus.Stage.String())
s.Equal("rejection-of-"+tv.UpdateID(), updStatus.Outcome.GetFailure().GetMessage())
s.EqualHistoryEvents(`
13 WorkflowTaskScheduled // WFT events were created even if it was a rejection (because number of events > 10).
14 WorkflowTaskStarted
15 WorkflowTaskCompleted
`, <-writtenHistoryCh)
// VERIFY: Context metadata set when NOT discarding speculative WFT (>10 events)
contextWorkflowType, ok := contextutil.ContextMetadataGet(ctx, contextutil.MetadataKeyWorkflowType)
s.True(ok, "context workflow type MUST be set when keeping speculative WFT")
s.Equal(tv.WorkflowType().GetName(), contextWorkflowType)
contextTaskQueue, ok := contextutil.ContextMetadataGet(ctx, contextutil.MetadataKeyWorkflowTaskQueue)
s.True(ok, "context task queue MUST be set when keeping speculative WFT")
s.Equal(tv.TaskQueue().GetName(), contextTaskQueue)
})
}
func (s *WorkflowTaskCompletedHandlerSuite) TestForceCreateNewWorkflowTaskOnPausedWorkflow() {
s.Run("Returns error when workflow is paused and ForceCreateNewWorkflowTask is true", func() {
tv := testvars.New(s.T())
tv = tv.WithRunID(tv.Any().RunID())
s.mockNamespaceCache.EXPECT().GetNamespaceByID(tv.NamespaceID()).Return(tv.Namespace(), nil).AnyTimes()
wfContext, serializedTaskToken := s.createPausedWorkflowWithWFT(tv)
ms, err := wfContext.LoadMutableState(context.Background(), s.workflowTaskCompletedHandler.shardContext)
s.NoError(err)
s.True(ms.IsWorkflowExecutionStatusPaused())
ctx := contextutil.WithMetadataContext(context.Background())
_, err = s.workflowTaskCompletedHandler.Invoke(ctx, &historyservice.RespondWorkflowTaskCompletedRequest{
NamespaceId: tv.NamespaceID().String(),
CompleteRequest: &workflowservice.RespondWorkflowTaskCompletedRequest{
TaskToken: serializedTaskToken,
Identity: tv.Any().String(),
ForceCreateNewWorkflowTask: true,
},
})
s.Error(err)
var failedPrecondition *serviceerror.FailedPrecondition
s.ErrorAs(err, &failedPrecondition)
s.Contains(err.Error(), "Workflow is paused and force create new workflow task is not allowed")
// VERIFY: Context metadata set even when paused workflow returns error
contextWorkflowType, ok := contextutil.ContextMetadataGet(ctx, contextutil.MetadataKeyWorkflowType)
s.True(ok, "context workflow type MUST be set even for paused workflow error")
s.Equal(tv.WorkflowType().GetName(), contextWorkflowType)
contextTaskQueue, ok := contextutil.ContextMetadataGet(ctx, contextutil.MetadataKeyWorkflowTaskQueue)
s.True(ok, "context task queue MUST be set even for paused workflow error")
s.Equal(tv.TaskQueue().GetName(), contextTaskQueue)
})
}
func (s *WorkflowTaskCompletedHandlerSuite) TestHandleBufferedQueries() {
constructQueryResults := func(ids []string, resultSize int) map[string]*querypb.WorkflowQueryResult {
results := make(map[string]*querypb.WorkflowQueryResult)
for _, id := range ids {
results[id] = &querypb.WorkflowQueryResult{
ResultType: enumspb.QUERY_RESULT_TYPE_ANSWERED,
Answer: payloads.EncodeBytes(make([]byte, resultSize)),
}
}
return results
}
constructQueryRegistry := func(numQueries int) historyi.QueryRegistry {
queryRegistry := workflow.NewQueryRegistry()
for range numQueries {
queryRegistry.BufferQuery(&querypb.WorkflowQuery{})
}
return queryRegistry
}
assertQueryCounts := func(queryRegistry historyi.QueryRegistry, buffered, completed, unblocked, failed int) {
s.Len(queryRegistry.GetBufferedIDs(), buffered)
s.Len(queryRegistry.GetCompletedIDs(), completed)
s.Len(queryRegistry.GetUnblockedIDs(), unblocked)
s.Len(queryRegistry.GetFailedIDs(), failed)
}
setupBufferedQueriesMocks := func() (historyi.QueryRegistry, *historyi.MockMutableState) {
queryRegistry := constructQueryRegistry(10)
mockMutableState := historyi.NewMockMutableState(s.controller)
mockMutableState.EXPECT().GetQueryRegistry().Return(queryRegistry)
mockMutableState.EXPECT().GetExecutionInfo().Return(&persistencespb.WorkflowExecutionInfo{
WorkflowId: tests.WorkflowID,
}).AnyTimes()
mockMutableState.EXPECT().GetExecutionState().Return(&persistencespb.WorkflowExecutionState{
RunId: tests.RunID,
}).AnyTimes()
return queryRegistry, mockMutableState
}
s.Run("New WorkflowTask", func() {
queryRegistry, mockMutableState := setupBufferedQueriesMocks()
assertQueryCounts(queryRegistry, 10, 0, 0, 0)
queryResults := constructQueryResults(queryRegistry.GetBufferedIDs()[0:5], 10)
s.workflowTaskCompletedHandler.handleBufferedQueries(mockMutableState, queryResults, true, tests.GlobalNamespaceEntry)
assertQueryCounts(queryRegistry, 5, 5, 0, 0)
})
s.Run("No New WorkflowTask", func() {
queryRegistry, mockMutableState := setupBufferedQueriesMocks()
assertQueryCounts(queryRegistry, 10, 0, 0, 0)
queryResults := constructQueryResults(queryRegistry.GetBufferedIDs()[0:5], 10)
s.workflowTaskCompletedHandler.handleBufferedQueries(mockMutableState, queryResults, false, tests.GlobalNamespaceEntry)
assertQueryCounts(queryRegistry, 0, 5, 5, 0)
})
s.Run("Query Too Large", func() {
queryRegistry, mockMutableState := setupBufferedQueriesMocks()
assertQueryCounts(queryRegistry, 10, 0, 0, 0)
bufferedIDs := queryRegistry.GetBufferedIDs()
queryResults := constructQueryResults(bufferedIDs[0:5], 10)
largeQueryResults := constructQueryResults(bufferedIDs[5:10], 10*1024*1024)
maps.Copy(queryResults, largeQueryResults)
s.workflowTaskCompletedHandler.handleBufferedQueries(mockMutableState, queryResults, false, tests.GlobalNamespaceEntry)
assertQueryCounts(queryRegistry, 0, 5, 0, 5)
})
}
func (s *WorkflowTaskCompletedHandlerSuite) createStartedWorkflow(tv *testvars.TestVars) historyi.WorkflowContext {
ms := workflow.TestLocalMutableState(s.workflowTaskCompletedHandler.shardContext, s.mockEventsCache, tv.Namespace(),
tv.WorkflowID(), tv.RunID(), log.NewTestLogger())
startRequest := &workflowservice.StartWorkflowExecutionRequest{
WorkflowId: tv.WorkflowID(),
WorkflowType: tv.WorkflowType(),
TaskQueue: tv.TaskQueue(),
Input: tv.Any().Payloads(),
WorkflowExecutionTimeout: tv.Any().InfiniteTimeout(),
WorkflowRunTimeout: tv.Any().InfiniteTimeout(),
WorkflowTaskTimeout: tv.Any().InfiniteTimeout(),
Identity: tv.ClientIdentity(),
}
_, _ = ms.AddWorkflowExecutionStartedEvent(
tv.WorkflowExecution(),
&historyservice.StartWorkflowExecutionRequest{
Attempt: 1,
NamespaceId: tv.NamespaceID().String(),
StartRequest: startRequest,
ParentExecutionInfo: nil,
},
)
s.mockExecutionMgr.EXPECT().GetWorkflowExecution(gomock.Any(), gomock.Any()).DoAndReturn(
func(ctx context.Context, request *persistence.GetWorkflowExecutionRequest) (*persistence.GetWorkflowExecutionResponse, error) {
return &persistence.GetWorkflowExecutionResponse{State: workflow.TestCloneToProto(ctx, ms)}, nil
}).AnyTimes()
// Create WF context in the cache and load MS for it.
wfContext, release, err := s.workflowCache.GetOrCreateWorkflowExecution(
metrics.AddMetricsContext(context.Background()),
s.mockShard,
tv.NamespaceID(),
tv.WorkflowExecution(),
locks.PriorityHigh,
)
s.NoError(err)
s.NotNil(wfContext)
loadedMS, err := wfContext.LoadMutableState(context.Background(), s.mockShard)
s.NoError(err)
s.NotNil(loadedMS)
release(nil)
return wfContext
}
func (s *WorkflowTaskCompletedHandlerSuite) createSentUpdate(tv *testvars.TestVars, wfContext historyi.WorkflowContext) (*protocolpb.Message, *update.Update, []byte) {
ctx := context.Background()
ms, err := wfContext.LoadMutableState(ctx, s.workflowTaskCompletedHandler.shardContext)
s.NoError(err)
// 1. Create speculative WFT for update.
wt, _ := ms.AddWorkflowTaskScheduledEvent(false, enumsspb.WORKFLOW_TASK_TYPE_SPECULATIVE)
_, _, _ = ms.AddWorkflowTaskStartedEvent(
wt.ScheduledEventID,
tv.RunID(),
tv.StickyTaskQueue(),
tv.Any().String(),
nil,
nil,
nil,
false,
nil,
0,
)
taskToken := &tokenspb.Task{
Attempt: 1,
NamespaceId: tv.NamespaceID().String(),
WorkflowId: tv.WorkflowID(),
RunId: tv.RunID(),
ScheduledEventId: wt.ScheduledEventID,
}
serializedTaskToken, err := taskToken.Marshal()
s.NoError(err)
// 2. Create update.
upd, alreadyExisted, err := wfContext.UpdateRegistry(ctx).FindOrCreate(ctx, tv.UpdateID())
s.False(alreadyExisted)
s.NoError(err)
updReq := &updatepb.Request{
Meta: &updatepb.Meta{UpdateId: tv.UpdateID()},
Input: &updatepb.Input{
Name: tv.HandlerName(),
Args: payloads.EncodeString("args-value-of-" + tv.UpdateID()),
}}
eventStore := workflow.WithEffects(effect.Immediate(ctx), ms)
err = upd.Admit(updReq, eventStore)
s.NoError(err)
seqID := &protocolpb.Message_EventId{EventId: tv.Any().EventID()}
msg := upd.Send(false, seqID)
s.NotNil(msg)
updRequestMsg := &protocolpb.Message{
Id: tv.Any().String(),
ProtocolInstanceId: tv.UpdateID(),
SequencingId: seqID,
Body: protoutils.MarshalAny(s.T(), updReq),
}
return updRequestMsg, upd, serializedTaskToken
}
func (s *WorkflowTaskCompletedHandlerSuite) createPausedWorkflowWithWFT(tv *testvars.TestVars) (historyi.WorkflowContext, []byte) {
ms := workflow.TestLocalMutableState(s.workflowTaskCompletedHandler.shardContext, s.mockEventsCache, tv.Namespace(),
tv.WorkflowID(), tv.RunID(), log.NewTestLogger())
startRequest := &workflowservice.StartWorkflowExecutionRequest{
WorkflowId: tv.WorkflowID(),
WorkflowType: tv.WorkflowType(),
TaskQueue: tv.TaskQueue(),
Input: tv.Any().Payloads(),
WorkflowExecutionTimeout: tv.Any().InfiniteTimeout(),
WorkflowRunTimeout: tv.Any().InfiniteTimeout(),
WorkflowTaskTimeout: tv.Any().InfiniteTimeout(),
Identity: tv.ClientIdentity(),
}
_, _ = ms.AddWorkflowExecutionStartedEvent(
tv.WorkflowExecution(),
&historyservice.StartWorkflowExecutionRequest{
Attempt: 1,
NamespaceId: tv.NamespaceID().String(),
StartRequest: startRequest,
ParentExecutionInfo: nil,
},
)
// Complete the first workflow task to transition state to Running.
wt, _ := ms.AddWorkflowTaskScheduledEvent(false, enumsspb.WORKFLOW_TASK_TYPE_NORMAL)
_, _, _ = ms.AddWorkflowTaskStartedEvent(
wt.ScheduledEventID,
tv.RunID(),
tv.TaskQueue(),
tv.Any().String(),
nil,
nil,
nil,
false,
nil,
0,
)
_, _ = ms.AddWorkflowTaskCompletedEvent(wt, &workflowservice.RespondWorkflowTaskCompletedRequest{
Identity: tv.Any().String(),
}, historyi.WorkflowTaskCompletionLimits{MaxResetPoints: 10, MaxSearchAttributeValueSize: 2048})
// Add a speculative WFT before pausing.
wt2, _ := ms.AddWorkflowTaskScheduledEvent(false, enumsspb.WORKFLOW_TASK_TYPE_SPECULATIVE)
_, _, _ = ms.AddWorkflowTaskStartedEvent(
wt2.ScheduledEventID,
tv.RunID(),
tv.StickyTaskQueue(),
tv.Any().String(),
nil,
nil,
nil,
false,
nil,
0,
)
taskToken := &tokenspb.Task{
Attempt: 1,
NamespaceId: tv.NamespaceID().String(),
WorkflowId: tv.WorkflowID(),
RunId: tv.RunID(),
ScheduledEventId: wt2.ScheduledEventID,
}
serializedTaskToken, err := taskToken.Marshal()
s.NoError(err)
// Pause the workflow
_, err = ms.AddWorkflowExecutionPausedEvent("test-identity", "test-reason", tv.Any().String())
s.NoError(err)
s.True(ms.IsWorkflowExecutionStatusPaused())
ms.FlushBufferedEvents()
s.mockExecutionMgr.EXPECT().GetWorkflowExecution(gomock.Any(), gomock.Any()).DoAndReturn(
func(ctx context.Context, request *persistence.GetWorkflowExecutionRequest) (*persistence.GetWorkflowExecutionResponse, error) {
return &persistence.GetWorkflowExecutionResponse{State: workflow.TestCloneToProto(context.Background(), ms)}, nil
}).AnyTimes()
wfContext, release, err := s.workflowCache.GetOrCreateWorkflowExecution(
metrics.AddMetricsContext(context.Background()),
s.mockShard,
tv.NamespaceID(),
tv.WorkflowExecution(),
locks.PriorityHigh,
)
s.NoError(err)
s.NotNil(wfContext)
loadedMS, err := wfContext.LoadMutableState(context.Background(), s.mockShard)
s.NoError(err)
s.NotNil(loadedMS)
release(nil)
return wfContext, serializedTaskToken
}