Files
tasks/host/workflow_task_test.go

868 lines
29 KiB
Go

// The MIT License
//
// Copyright (c) 2020 Temporal Technologies Inc. All rights reserved.
//
// Copyright (c) 2020 Uber Technologies, Inc.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
package host
import (
"strconv"
"time"
"github.com/pborman/uuid"
commandpb "go.temporal.io/api/command/v1"
commonpb "go.temporal.io/api/common/v1"
enumspb "go.temporal.io/api/enums/v1"
"go.temporal.io/api/serviceerror"
taskqueuepb "go.temporal.io/api/taskqueue/v1"
"go.temporal.io/api/workflowservice/v1"
"go.temporal.io/server/common/codec"
"go.temporal.io/server/common/payloads"
"go.temporal.io/server/common/primitives/timestamp"
)
func (s *integrationSuite) TestWorkflowTaskHeartbeatingWithEmptyResult() {
id := uuid.New()
wt := "integration-workflow-workflow-task-heartbeating-local-activities"
tl := id
identity := "worker1"
workflowType := &commonpb.WorkflowType{Name: wt}
taskQueue := &taskqueuepb.TaskQueue{
Name: tl,
Kind: enumspb.TASK_QUEUE_KIND_NORMAL,
}
stikyTaskQueue := &taskqueuepb.TaskQueue{
Name: "test-sticky-taskqueue",
Kind: enumspb.TASK_QUEUE_KIND_STICKY,
}
request := &workflowservice.StartWorkflowExecutionRequest{
RequestId: uuid.New(),
Namespace: s.namespace,
WorkflowId: id,
WorkflowType: workflowType,
TaskQueue: taskQueue,
Input: nil,
WorkflowRunTimeout: timestamp.DurationPtr(20 * time.Second),
WorkflowTaskTimeout: timestamp.DurationPtr(3 * time.Second),
Identity: identity,
}
resp0, err0 := s.engine.StartWorkflowExecution(NewContext(), request)
s.NoError(err0)
we := &commonpb.WorkflowExecution{
WorkflowId: id,
RunId: resp0.RunId,
}
s.assertLastHistoryEvent(we, 2, enumspb.EVENT_TYPE_WORKFLOW_TASK_SCHEDULED)
// start workflow task
resp1, err1 := s.engine.PollWorkflowTaskQueue(NewContext(), &workflowservice.PollWorkflowTaskQueueRequest{
Namespace: s.namespace,
TaskQueue: taskQueue,
Identity: identity,
})
s.NoError(err1)
s.Equal(int32(1), resp1.GetAttempt())
s.assertLastHistoryEvent(we, 3, enumspb.EVENT_TYPE_WORKFLOW_TASK_STARTED)
taskToken := resp1.GetTaskToken()
hbTimeout := 0
for i := 0; i < 12; i++ {
resp2, err2 := s.engine.RespondWorkflowTaskCompleted(NewContext(), &workflowservice.RespondWorkflowTaskCompletedRequest{
TaskToken: taskToken,
Commands: []*commandpb.Command{},
StickyAttributes: &taskqueuepb.StickyExecutionAttributes{
WorkerTaskQueue: stikyTaskQueue,
ScheduleToStartTimeout: timestamp.DurationPtr(5 * time.Second),
},
ReturnNewWorkflowTask: true,
ForceCreateNewWorkflowTask: true,
})
if _, isNotFound := err2.(*serviceerror.NotFound); isNotFound {
hbTimeout++
s.IsType(&workflowservice.RespondWorkflowTaskCompletedResponse{}, resp2)
resp, err := s.engine.PollWorkflowTaskQueue(NewContext(), &workflowservice.PollWorkflowTaskQueueRequest{
Namespace: s.namespace,
TaskQueue: taskQueue,
Identity: identity,
})
s.NoError(err)
taskToken = resp.GetTaskToken()
} else {
s.NoError(err2)
taskToken = resp2.WorkflowTask.GetTaskToken()
}
time.Sleep(time.Second)
}
s.Equal(2, hbTimeout)
resp5, err5 := s.engine.RespondWorkflowTaskCompleted(NewContext(), &workflowservice.RespondWorkflowTaskCompletedRequest{
TaskToken: taskToken,
Commands: []*commandpb.Command{
{
CommandType: enumspb.COMMAND_TYPE_COMPLETE_WORKFLOW_EXECUTION,
Attributes: &commandpb.Command_CompleteWorkflowExecutionCommandAttributes{CompleteWorkflowExecutionCommandAttributes: &commandpb.CompleteWorkflowExecutionCommandAttributes{
Result: payloads.EncodeString("efg"),
},
},
}},
StickyAttributes: &taskqueuepb.StickyExecutionAttributes{
WorkerTaskQueue: stikyTaskQueue,
ScheduleToStartTimeout: timestamp.DurationPtr(5 * time.Second),
},
ReturnNewWorkflowTask: true,
ForceCreateNewWorkflowTask: false,
})
s.NoError(err5)
s.Nil(resp5.WorkflowTask)
s.assertLastHistoryEvent(we, 47, enumspb.EVENT_TYPE_WORKFLOW_EXECUTION_COMPLETED)
}
func (s *integrationSuite) TestWorkflowTaskHeartbeatingWithLocalActivitiesResult() {
id := uuid.New()
wt := "integration-workflow-workflow-task-heartbeating-local-activities"
tl := id
identity := "worker1"
workflowType := &commonpb.WorkflowType{Name: wt}
taskQueue := &taskqueuepb.TaskQueue{
Name: tl,
Kind: enumspb.TASK_QUEUE_KIND_NORMAL,
}
stikyTaskQueue := &taskqueuepb.TaskQueue{
Name: "test-sticky-taskqueue",
Kind: enumspb.TASK_QUEUE_KIND_STICKY,
}
request := &workflowservice.StartWorkflowExecutionRequest{
RequestId: uuid.New(),
Namespace: s.namespace,
WorkflowId: id,
WorkflowType: workflowType,
TaskQueue: taskQueue,
Input: nil,
WorkflowRunTimeout: timestamp.DurationPtr(20 * time.Second),
WorkflowTaskTimeout: timestamp.DurationPtr(5 * time.Second),
Identity: identity,
}
resp0, err0 := s.engine.StartWorkflowExecution(NewContext(), request)
s.NoError(err0)
we := &commonpb.WorkflowExecution{
WorkflowId: id,
RunId: resp0.RunId,
}
s.assertLastHistoryEvent(we, 2, enumspb.EVENT_TYPE_WORKFLOW_TASK_SCHEDULED)
// start workflow task
resp1, err1 := s.engine.PollWorkflowTaskQueue(NewContext(), &workflowservice.PollWorkflowTaskQueueRequest{
Namespace: s.namespace,
TaskQueue: taskQueue,
Identity: identity,
})
s.NoError(err1)
s.Equal(int32(1), resp1.GetAttempt())
s.assertLastHistoryEvent(we, 3, enumspb.EVENT_TYPE_WORKFLOW_TASK_STARTED)
resp2, err2 := s.engine.RespondWorkflowTaskCompleted(NewContext(), &workflowservice.RespondWorkflowTaskCompletedRequest{
TaskToken: resp1.GetTaskToken(),
Commands: []*commandpb.Command{},
StickyAttributes: &taskqueuepb.StickyExecutionAttributes{
WorkerTaskQueue: stikyTaskQueue,
ScheduleToStartTimeout: timestamp.DurationPtr(5 * time.Second),
},
ReturnNewWorkflowTask: true,
ForceCreateNewWorkflowTask: true,
})
s.NoError(err2)
resp3, err3 := s.engine.RespondWorkflowTaskCompleted(NewContext(), &workflowservice.RespondWorkflowTaskCompletedRequest{
TaskToken: resp2.WorkflowTask.GetTaskToken(),
Commands: []*commandpb.Command{
{
CommandType: enumspb.COMMAND_TYPE_RECORD_MARKER,
Attributes: &commandpb.Command_RecordMarkerCommandAttributes{RecordMarkerCommandAttributes: &commandpb.RecordMarkerCommandAttributes{
MarkerName: "localActivity1",
Details: map[string]*commonpb.Payloads{
"data": payloads.EncodeString("local activity marker"),
"result": payloads.EncodeString("local activity result"),
}}},
}},
StickyAttributes: &taskqueuepb.StickyExecutionAttributes{
WorkerTaskQueue: stikyTaskQueue,
ScheduleToStartTimeout: timestamp.DurationPtr(5 * time.Second),
},
ReturnNewWorkflowTask: true,
ForceCreateNewWorkflowTask: true,
})
s.NoError(err3)
resp4, err4 := s.engine.RespondWorkflowTaskCompleted(NewContext(), &workflowservice.RespondWorkflowTaskCompletedRequest{
TaskToken: resp3.WorkflowTask.GetTaskToken(),
Commands: []*commandpb.Command{
{
CommandType: enumspb.COMMAND_TYPE_RECORD_MARKER,
Attributes: &commandpb.Command_RecordMarkerCommandAttributes{RecordMarkerCommandAttributes: &commandpb.RecordMarkerCommandAttributes{
MarkerName: "localActivity2",
Details: map[string]*commonpb.Payloads{
"data": payloads.EncodeString("local activity marker"),
"result": payloads.EncodeString("local activity result"),
}}},
}},
StickyAttributes: &taskqueuepb.StickyExecutionAttributes{
WorkerTaskQueue: stikyTaskQueue,
ScheduleToStartTimeout: timestamp.DurationPtr(5 * time.Second),
},
ReturnNewWorkflowTask: true,
ForceCreateNewWorkflowTask: true,
})
s.NoError(err4)
resp5, err5 := s.engine.RespondWorkflowTaskCompleted(NewContext(), &workflowservice.RespondWorkflowTaskCompletedRequest{
TaskToken: resp4.WorkflowTask.GetTaskToken(),
Commands: []*commandpb.Command{
{
CommandType: enumspb.COMMAND_TYPE_COMPLETE_WORKFLOW_EXECUTION,
Attributes: &commandpb.Command_CompleteWorkflowExecutionCommandAttributes{CompleteWorkflowExecutionCommandAttributes: &commandpb.CompleteWorkflowExecutionCommandAttributes{
Result: payloads.EncodeString("efg"),
},
},
}},
StickyAttributes: &taskqueuepb.StickyExecutionAttributes{
WorkerTaskQueue: stikyTaskQueue,
ScheduleToStartTimeout: timestamp.DurationPtr(5 * time.Second),
},
ReturnNewWorkflowTask: true,
ForceCreateNewWorkflowTask: false,
})
s.NoError(err5)
s.Nil(resp5.WorkflowTask)
expectedHistory := []enumspb.EventType{
enumspb.EVENT_TYPE_WORKFLOW_EXECUTION_STARTED,
enumspb.EVENT_TYPE_WORKFLOW_TASK_SCHEDULED,
enumspb.EVENT_TYPE_WORKFLOW_TASK_STARTED,
enumspb.EVENT_TYPE_WORKFLOW_TASK_COMPLETED,
enumspb.EVENT_TYPE_WORKFLOW_TASK_SCHEDULED,
enumspb.EVENT_TYPE_WORKFLOW_TASK_STARTED,
enumspb.EVENT_TYPE_WORKFLOW_TASK_COMPLETED,
enumspb.EVENT_TYPE_MARKER_RECORDED,
enumspb.EVENT_TYPE_WORKFLOW_TASK_SCHEDULED,
enumspb.EVENT_TYPE_WORKFLOW_TASK_STARTED,
enumspb.EVENT_TYPE_WORKFLOW_TASK_COMPLETED,
enumspb.EVENT_TYPE_MARKER_RECORDED,
enumspb.EVENT_TYPE_WORKFLOW_TASK_SCHEDULED,
enumspb.EVENT_TYPE_WORKFLOW_TASK_STARTED,
enumspb.EVENT_TYPE_WORKFLOW_TASK_COMPLETED,
enumspb.EVENT_TYPE_WORKFLOW_EXECUTION_COMPLETED,
}
s.assertHistory(we, expectedHistory)
}
func (s *integrationSuite) TestWorkflowTerminationSignalBeforeRegularWorkflowTaskStarted() {
id := uuid.New()
wt := "integration-workflow-transient-workflow-task-test-type"
tl := id
identity := "worker1"
workflowType := &commonpb.WorkflowType{Name: wt}
taskQueue := &taskqueuepb.TaskQueue{Name: tl}
request := &workflowservice.StartWorkflowExecutionRequest{
RequestId: uuid.New(),
Namespace: s.namespace,
WorkflowId: id,
WorkflowType: workflowType,
TaskQueue: taskQueue,
Input: nil,
WorkflowRunTimeout: timestamp.DurationPtr(3 * time.Second),
WorkflowTaskTimeout: timestamp.DurationPtr(10 * time.Second),
Identity: identity,
}
resp0, err0 := s.engine.StartWorkflowExecution(NewContext(), request)
s.NoError(err0)
we := &commonpb.WorkflowExecution{
WorkflowId: id,
RunId: resp0.RunId,
}
s.assertLastHistoryEvent(we, 2, enumspb.EVENT_TYPE_WORKFLOW_TASK_SCHEDULED)
_, err0 = s.engine.SignalWorkflowExecution(NewContext(), &workflowservice.SignalWorkflowExecutionRequest{
Namespace: s.namespace,
WorkflowExecution: we,
SignalName: "sig-for-integ-test",
Input: payloads.EncodeString(""),
Identity: "integ test",
RequestId: uuid.New(),
})
s.NoError(err0)
s.assertLastHistoryEvent(we, 3, enumspb.EVENT_TYPE_WORKFLOW_EXECUTION_SIGNALED)
// start this transient workflow task, the attempt should be cleared and it becomes again a regular workflow task
resp1, err1 := s.engine.PollWorkflowTaskQueue(NewContext(), &workflowservice.PollWorkflowTaskQueueRequest{
Namespace: s.namespace,
TaskQueue: taskQueue,
Identity: identity,
})
s.NoError(err1)
s.Equal(int32(1), resp1.GetAttempt())
s.assertLastHistoryEvent(we, 4, enumspb.EVENT_TYPE_WORKFLOW_TASK_STARTED)
// then terminate the worklfow
_, err := s.engine.TerminateWorkflowExecution(NewContext(), &workflowservice.TerminateWorkflowExecutionRequest{
Namespace: s.namespace,
WorkflowExecution: we,
Reason: "test-reason",
})
s.NoError(err)
expectedHistory := []enumspb.EventType{
enumspb.EVENT_TYPE_WORKFLOW_EXECUTION_STARTED,
enumspb.EVENT_TYPE_WORKFLOW_TASK_SCHEDULED,
enumspb.EVENT_TYPE_WORKFLOW_EXECUTION_SIGNALED,
enumspb.EVENT_TYPE_WORKFLOW_TASK_STARTED,
enumspb.EVENT_TYPE_WORKFLOW_TASK_FAILED,
enumspb.EVENT_TYPE_WORKFLOW_EXECUTION_TERMINATED,
}
s.assertHistory(we, expectedHistory)
}
func (s *integrationSuite) TestWorkflowTerminationSignalAfterRegularWorkflowTaskStarted() {
id := uuid.New()
wt := "integration-workflow-transient-workflow-task-test-type"
tl := id
identity := "worker1"
workflowType := &commonpb.WorkflowType{Name: wt}
taskQueue := &taskqueuepb.TaskQueue{Name: tl}
request := &workflowservice.StartWorkflowExecutionRequest{
RequestId: uuid.New(),
Namespace: s.namespace,
WorkflowId: id,
WorkflowType: workflowType,
TaskQueue: taskQueue,
Input: nil,
WorkflowRunTimeout: timestamp.DurationPtr(3 * time.Second),
WorkflowTaskTimeout: timestamp.DurationPtr(10 * time.Second),
Identity: identity,
}
resp0, err0 := s.engine.StartWorkflowExecution(NewContext(), request)
s.NoError(err0)
we := &commonpb.WorkflowExecution{
WorkflowId: id,
RunId: resp0.RunId,
}
s.assertLastHistoryEvent(we, 2, enumspb.EVENT_TYPE_WORKFLOW_TASK_SCHEDULED)
// start workflow task to make signals into bufferedEvents
_, err1 := s.engine.PollWorkflowTaskQueue(NewContext(), &workflowservice.PollWorkflowTaskQueueRequest{
Namespace: s.namespace,
TaskQueue: taskQueue,
Identity: identity,
})
s.NoError(err1)
s.assertLastHistoryEvent(we, 3, enumspb.EVENT_TYPE_WORKFLOW_TASK_STARTED)
// this signal should be buffered
_, err0 = s.engine.SignalWorkflowExecution(NewContext(), &workflowservice.SignalWorkflowExecutionRequest{
Namespace: s.namespace,
WorkflowExecution: we,
SignalName: "sig-for-integ-test",
Input: payloads.EncodeString(""),
Identity: "integ test",
RequestId: uuid.New(),
})
s.NoError(err0)
s.assertLastHistoryEvent(we, 3, enumspb.EVENT_TYPE_WORKFLOW_TASK_STARTED)
// then terminate the worklfow
_, err := s.engine.TerminateWorkflowExecution(NewContext(), &workflowservice.TerminateWorkflowExecutionRequest{
Namespace: s.namespace,
WorkflowExecution: we,
Reason: "test-reason",
})
s.NoError(err)
expectedHistory := []enumspb.EventType{
enumspb.EVENT_TYPE_WORKFLOW_EXECUTION_STARTED,
enumspb.EVENT_TYPE_WORKFLOW_TASK_SCHEDULED,
enumspb.EVENT_TYPE_WORKFLOW_TASK_STARTED,
enumspb.EVENT_TYPE_WORKFLOW_TASK_FAILED,
enumspb.EVENT_TYPE_WORKFLOW_EXECUTION_SIGNALED,
enumspb.EVENT_TYPE_WORKFLOW_EXECUTION_TERMINATED,
}
s.assertHistory(we, expectedHistory)
}
func (s *integrationSuite) TestWorkflowTerminationSignalAfterRegularWorkflowTaskStartedAndFailWorkflowTask() {
id := uuid.New()
wt := "integration-workflow-transient-workflow-task-test-type"
tl := id
identity := "worker1"
workflowType := &commonpb.WorkflowType{Name: wt}
taskQueue := &taskqueuepb.TaskQueue{Name: tl}
request := &workflowservice.StartWorkflowExecutionRequest{
RequestId: uuid.New(),
Namespace: s.namespace,
WorkflowId: id,
WorkflowType: workflowType,
TaskQueue: taskQueue,
Input: nil,
WorkflowRunTimeout: timestamp.DurationPtr(3 * time.Second),
WorkflowTaskTimeout: timestamp.DurationPtr(10 * time.Second),
Identity: identity,
}
resp0, err0 := s.engine.StartWorkflowExecution(NewContext(), request)
s.NoError(err0)
we := &commonpb.WorkflowExecution{
WorkflowId: id,
RunId: resp0.RunId,
}
s.assertLastHistoryEvent(we, 2, enumspb.EVENT_TYPE_WORKFLOW_TASK_SCHEDULED)
cause := enumspb.WORKFLOW_TASK_FAILED_CAUSE_WORKFLOW_WORKER_UNHANDLED_FAILURE
// start workflow task to make signals into bufferedEvents
resp1, err1 := s.engine.PollWorkflowTaskQueue(NewContext(), &workflowservice.PollWorkflowTaskQueueRequest{
Namespace: s.namespace,
TaskQueue: taskQueue,
Identity: identity,
})
s.NoError(err1)
s.assertLastHistoryEvent(we, 3, enumspb.EVENT_TYPE_WORKFLOW_TASK_STARTED)
// this signal should be buffered
_, err0 = s.engine.SignalWorkflowExecution(NewContext(), &workflowservice.SignalWorkflowExecutionRequest{
Namespace: s.namespace,
WorkflowExecution: we,
SignalName: "sig-for-integ-test",
Input: payloads.EncodeString(""),
Identity: "integ test",
RequestId: uuid.New(),
})
s.NoError(err0)
s.assertLastHistoryEvent(we, 3, enumspb.EVENT_TYPE_WORKFLOW_TASK_STARTED)
// fail this workflow task to flush buffer, and then another workflow task will be scheduled
_, err2 := s.engine.RespondWorkflowTaskFailed(NewContext(), &workflowservice.RespondWorkflowTaskFailedRequest{
TaskToken: resp1.GetTaskToken(),
Cause: cause,
Identity: "integ test",
})
s.NoError(err2)
s.assertLastHistoryEvent(we, 6, enumspb.EVENT_TYPE_WORKFLOW_TASK_SCHEDULED)
// then terminate the worklfow
_, err := s.engine.TerminateWorkflowExecution(NewContext(), &workflowservice.TerminateWorkflowExecutionRequest{
Namespace: s.namespace,
WorkflowExecution: we,
Reason: "test-reason",
})
s.NoError(err)
expectedHistory := []enumspb.EventType{
enumspb.EVENT_TYPE_WORKFLOW_EXECUTION_STARTED,
enumspb.EVENT_TYPE_WORKFLOW_TASK_SCHEDULED,
enumspb.EVENT_TYPE_WORKFLOW_TASK_STARTED,
enumspb.EVENT_TYPE_WORKFLOW_TASK_FAILED,
enumspb.EVENT_TYPE_WORKFLOW_EXECUTION_SIGNALED,
enumspb.EVENT_TYPE_WORKFLOW_TASK_SCHEDULED,
enumspb.EVENT_TYPE_WORKFLOW_EXECUTION_TERMINATED,
}
s.assertHistory(we, expectedHistory)
}
func (s *integrationSuite) TestWorkflowTerminationSignalBeforeTransientWorkflowTaskStarted() {
id := uuid.New()
wt := "integration-workflow-transient-workflow-task-test-type"
tl := id
identity := "worker1"
workflowType := &commonpb.WorkflowType{Name: wt}
taskQueue := &taskqueuepb.TaskQueue{Name: tl}
request := &workflowservice.StartWorkflowExecutionRequest{
RequestId: uuid.New(),
Namespace: s.namespace,
WorkflowId: id,
WorkflowType: workflowType,
TaskQueue: taskQueue,
Input: nil,
WorkflowRunTimeout: timestamp.DurationPtr(3 * time.Second),
WorkflowTaskTimeout: timestamp.DurationPtr(10 * time.Second),
Identity: identity,
}
resp0, err0 := s.engine.StartWorkflowExecution(NewContext(), request)
s.NoError(err0)
we := &commonpb.WorkflowExecution{
WorkflowId: id,
RunId: resp0.RunId,
}
s.assertLastHistoryEvent(we, 2, enumspb.EVENT_TYPE_WORKFLOW_TASK_SCHEDULED)
cause := enumspb.WORKFLOW_TASK_FAILED_CAUSE_WORKFLOW_WORKER_UNHANDLED_FAILURE
for i := 0; i < 10; i++ {
resp1, err1 := s.engine.PollWorkflowTaskQueue(NewContext(), &workflowservice.PollWorkflowTaskQueueRequest{
Namespace: s.namespace,
TaskQueue: taskQueue,
Identity: identity,
})
s.NoError(err1)
s.Equal(int32(i+1), resp1.GetAttempt())
if i == 0 {
// first time is regular workflow task
s.Equal(int64(3), resp1.GetStartedEventId())
} else {
// the rest is transient workflow task
s.Equal(int64(6), resp1.GetStartedEventId())
}
_, err2 := s.engine.RespondWorkflowTaskFailed(NewContext(), &workflowservice.RespondWorkflowTaskFailedRequest{
TaskToken: resp1.GetTaskToken(),
Cause: cause,
Identity: "integ test",
})
s.NoError(err2)
}
s.assertLastHistoryEvent(we, 4, enumspb.EVENT_TYPE_WORKFLOW_TASK_FAILED)
_, err0 = s.engine.SignalWorkflowExecution(NewContext(), &workflowservice.SignalWorkflowExecutionRequest{
Namespace: s.namespace,
WorkflowExecution: we,
SignalName: "sig-for-integ-test",
Input: payloads.EncodeString(""),
Identity: "integ test",
RequestId: uuid.New(),
})
s.NoError(err0)
s.assertLastHistoryEvent(we, 5, enumspb.EVENT_TYPE_WORKFLOW_EXECUTION_SIGNALED)
// start this transient workflow task, the attempt should be cleared and it becomes again a regular workflow task
resp1, err1 := s.engine.PollWorkflowTaskQueue(NewContext(), &workflowservice.PollWorkflowTaskQueueRequest{
Namespace: s.namespace,
TaskQueue: taskQueue,
Identity: identity,
})
s.NoError(err1)
s.Equal(int32(1), resp1.GetAttempt())
s.assertLastHistoryEvent(we, 7, enumspb.EVENT_TYPE_WORKFLOW_TASK_STARTED)
// then terminate the worklfow
_, err := s.engine.TerminateWorkflowExecution(NewContext(), &workflowservice.TerminateWorkflowExecutionRequest{
Namespace: s.namespace,
WorkflowExecution: we,
Reason: "test-reason",
})
s.NoError(err)
expectedHistory := []enumspb.EventType{
enumspb.EVENT_TYPE_WORKFLOW_EXECUTION_STARTED,
enumspb.EVENT_TYPE_WORKFLOW_TASK_SCHEDULED,
enumspb.EVENT_TYPE_WORKFLOW_TASK_STARTED,
enumspb.EVENT_TYPE_WORKFLOW_TASK_FAILED,
enumspb.EVENT_TYPE_WORKFLOW_EXECUTION_SIGNALED,
enumspb.EVENT_TYPE_WORKFLOW_TASK_SCHEDULED,
enumspb.EVENT_TYPE_WORKFLOW_TASK_STARTED,
enumspb.EVENT_TYPE_WORKFLOW_TASK_FAILED,
enumspb.EVENT_TYPE_WORKFLOW_EXECUTION_TERMINATED,
}
s.assertHistory(we, expectedHistory)
}
func (s *integrationSuite) TestWorkflowTerminationSignalAfterTransientWorkflowTaskStarted() {
id := uuid.New()
wt := "integration-workflow-transient-workflow-task-test-type"
tl := id
identity := "worker1"
workflowType := &commonpb.WorkflowType{Name: wt}
taskQueue := &taskqueuepb.TaskQueue{Name: tl}
request := &workflowservice.StartWorkflowExecutionRequest{
RequestId: uuid.New(),
Namespace: s.namespace,
WorkflowId: id,
WorkflowType: workflowType,
TaskQueue: taskQueue,
Input: nil,
WorkflowRunTimeout: timestamp.DurationPtr(3 * time.Second),
WorkflowTaskTimeout: timestamp.DurationPtr(10 * time.Second),
Identity: identity,
}
resp0, err0 := s.engine.StartWorkflowExecution(NewContext(), request)
s.NoError(err0)
we := &commonpb.WorkflowExecution{
WorkflowId: id,
RunId: resp0.RunId,
}
s.assertLastHistoryEvent(we, 2, enumspb.EVENT_TYPE_WORKFLOW_TASK_SCHEDULED)
cause := enumspb.WORKFLOW_TASK_FAILED_CAUSE_WORKFLOW_WORKER_UNHANDLED_FAILURE
for i := 0; i < 10; i++ {
resp1, err1 := s.engine.PollWorkflowTaskQueue(NewContext(), &workflowservice.PollWorkflowTaskQueueRequest{
Namespace: s.namespace,
TaskQueue: taskQueue,
Identity: identity,
})
s.NoError(err1)
s.Equal(int32(i+1), resp1.GetAttempt())
if i == 0 {
// first time is regular workflow task
s.Equal(int64(3), resp1.GetStartedEventId())
} else {
// the rest is transient workflow task
s.Equal(int64(6), resp1.GetStartedEventId())
}
_, err2 := s.engine.RespondWorkflowTaskFailed(NewContext(), &workflowservice.RespondWorkflowTaskFailedRequest{
TaskToken: resp1.GetTaskToken(),
Cause: cause,
Identity: "integ test",
})
s.NoError(err2)
}
s.assertLastHistoryEvent(we, 4, enumspb.EVENT_TYPE_WORKFLOW_TASK_FAILED)
// start workflow task to make signals into bufferedEvents
_, err1 := s.engine.PollWorkflowTaskQueue(NewContext(), &workflowservice.PollWorkflowTaskQueueRequest{
Namespace: s.namespace,
TaskQueue: taskQueue,
Identity: identity,
})
s.NoError(err1)
s.assertLastHistoryEvent(we, 4, enumspb.EVENT_TYPE_WORKFLOW_TASK_FAILED)
// this signal should be buffered
_, err0 = s.engine.SignalWorkflowExecution(NewContext(), &workflowservice.SignalWorkflowExecutionRequest{
Namespace: s.namespace,
WorkflowExecution: we,
SignalName: "sig-for-integ-test",
Input: payloads.EncodeString(""),
Identity: "integ test",
RequestId: uuid.New(),
})
s.NoError(err0)
s.assertLastHistoryEvent(we, 4, enumspb.EVENT_TYPE_WORKFLOW_TASK_FAILED)
// then terminate the worklfow
_, err := s.engine.TerminateWorkflowExecution(NewContext(), &workflowservice.TerminateWorkflowExecutionRequest{
Namespace: s.namespace,
WorkflowExecution: we,
Reason: "test-reason",
})
s.NoError(err)
expectedHistory := []enumspb.EventType{
enumspb.EVENT_TYPE_WORKFLOW_EXECUTION_STARTED,
enumspb.EVENT_TYPE_WORKFLOW_TASK_SCHEDULED,
enumspb.EVENT_TYPE_WORKFLOW_TASK_STARTED,
enumspb.EVENT_TYPE_WORKFLOW_TASK_FAILED,
enumspb.EVENT_TYPE_WORKFLOW_EXECUTION_SIGNALED,
enumspb.EVENT_TYPE_WORKFLOW_EXECUTION_TERMINATED,
}
s.assertHistory(we, expectedHistory)
}
func (s *integrationSuite) TestWorkflowTerminationSignalAfterTransientWorkflowTaskStartedAndFailWorkflowTask() {
id := uuid.New()
wt := "integration-workflow-transient-workflow-task-test-type"
tl := id
identity := "worker1"
workflowType := &commonpb.WorkflowType{Name: wt}
taskQueue := &taskqueuepb.TaskQueue{Name: tl}
request := &workflowservice.StartWorkflowExecutionRequest{
RequestId: uuid.New(),
Namespace: s.namespace,
WorkflowId: id,
WorkflowType: workflowType,
TaskQueue: taskQueue,
Input: nil,
WorkflowRunTimeout: timestamp.DurationPtr(3 * time.Second),
WorkflowTaskTimeout: timestamp.DurationPtr(10 * time.Second),
Identity: identity,
}
resp0, err0 := s.engine.StartWorkflowExecution(NewContext(), request)
s.NoError(err0)
we := &commonpb.WorkflowExecution{
WorkflowId: id,
RunId: resp0.RunId,
}
s.assertLastHistoryEvent(we, 2, enumspb.EVENT_TYPE_WORKFLOW_TASK_SCHEDULED)
cause := enumspb.WORKFLOW_TASK_FAILED_CAUSE_WORKFLOW_WORKER_UNHANDLED_FAILURE
for i := 0; i < 10; i++ {
resp1, err1 := s.engine.PollWorkflowTaskQueue(NewContext(), &workflowservice.PollWorkflowTaskQueueRequest{
Namespace: s.namespace,
TaskQueue: taskQueue,
Identity: identity,
})
s.NoError(err1)
s.Equal(int32(i+1), resp1.GetAttempt())
if i == 0 {
// first time is regular workflow task
s.Equal(int64(3), resp1.GetStartedEventId())
} else {
// the rest is transient workflow task
s.Equal(int64(6), resp1.GetStartedEventId())
}
_, err2 := s.engine.RespondWorkflowTaskFailed(NewContext(), &workflowservice.RespondWorkflowTaskFailedRequest{
TaskToken: resp1.GetTaskToken(),
Cause: cause,
Identity: "integ test",
})
s.NoError(err2)
}
s.assertLastHistoryEvent(we, 4, enumspb.EVENT_TYPE_WORKFLOW_TASK_FAILED)
// start workflow task to make signals into bufferedEvents
resp1, err1 := s.engine.PollWorkflowTaskQueue(NewContext(), &workflowservice.PollWorkflowTaskQueueRequest{
Namespace: s.namespace,
TaskQueue: taskQueue,
Identity: identity,
})
s.NoError(err1)
s.assertLastHistoryEvent(we, 4, enumspb.EVENT_TYPE_WORKFLOW_TASK_FAILED)
// this signal should be buffered
_, err0 = s.engine.SignalWorkflowExecution(NewContext(), &workflowservice.SignalWorkflowExecutionRequest{
Namespace: s.namespace,
WorkflowExecution: we,
SignalName: "sig-for-integ-test",
Input: payloads.EncodeString(""),
Identity: "integ test",
RequestId: uuid.New(),
})
s.NoError(err0)
s.assertLastHistoryEvent(we, 4, enumspb.EVENT_TYPE_WORKFLOW_TASK_FAILED)
// fail this workflow task to flush buffer
_, err2 := s.engine.RespondWorkflowTaskFailed(NewContext(), &workflowservice.RespondWorkflowTaskFailedRequest{
TaskToken: resp1.GetTaskToken(),
Cause: cause,
Identity: "integ test",
})
s.NoError(err2)
s.assertLastHistoryEvent(we, 6, enumspb.EVENT_TYPE_WORKFLOW_TASK_SCHEDULED)
// then terminate the worklfow
_, err := s.engine.TerminateWorkflowExecution(NewContext(), &workflowservice.TerminateWorkflowExecutionRequest{
Namespace: s.namespace,
WorkflowExecution: we,
Reason: "test-reason",
})
s.NoError(err)
expectedHistory := []enumspb.EventType{
enumspb.EVENT_TYPE_WORKFLOW_EXECUTION_STARTED,
enumspb.EVENT_TYPE_WORKFLOW_TASK_SCHEDULED,
enumspb.EVENT_TYPE_WORKFLOW_TASK_STARTED,
enumspb.EVENT_TYPE_WORKFLOW_TASK_FAILED,
enumspb.EVENT_TYPE_WORKFLOW_EXECUTION_SIGNALED,
enumspb.EVENT_TYPE_WORKFLOW_TASK_SCHEDULED,
enumspb.EVENT_TYPE_WORKFLOW_EXECUTION_TERMINATED,
}
s.assertHistory(we, expectedHistory)
}
func (s *integrationSuite) assertHistory(we *commonpb.WorkflowExecution, expectedHistory []enumspb.EventType) {
historyResponse, err := s.engine.GetWorkflowExecutionHistory(NewContext(), &workflowservice.GetWorkflowExecutionHistoryRequest{
Namespace: s.namespace,
Execution: we,
})
s.NoError(err)
history := historyResponse.History
encoder := codec.NewJSONPBIndentEncoder(" ")
data, err := encoder.Encode(history)
s.NoError(err)
s.Equal(len(expectedHistory), len(history.Events), string(data))
for i, e := range history.Events {
s.Equal(expectedHistory[i], e.GetEventType(), "%v, %v, %v", strconv.Itoa(i), e.GetEventType().String(), string(data))
}
}
func (s *integrationSuite) assertLastHistoryEvent(we *commonpb.WorkflowExecution, count int, eventType enumspb.EventType) {
historyResponse, err := s.engine.GetWorkflowExecutionHistory(NewContext(), &workflowservice.GetWorkflowExecutionHistoryRequest{
Namespace: s.namespace,
Execution: we,
})
s.NoError(err)
history := historyResponse.History
encoder := codec.NewJSONPBIndentEncoder(" ")
data, err := encoder.Encode(history)
s.NoError(err)
s.Equal(count, len(history.Events), string(data))
s.Equal(eventType, history.Events[len(history.Events)-1].GetEventType(), string(data))
}