Files
tasks/service/worker/scheduler/responsebuilder_test.go
zeekay 5a601d081b rebrand: go.temporal.io/server -> github.com/hanzoai/tasks
Full module path rebrand from Temporal to Hanzo Tasks:
- go.mod module: github.com/hanzoai/tasks
- All internal Go imports updated (1906 files)
- cmd/server renamed to cmd/tasksd
- Binary name: tasksd (was temporal-server)
- Docker images: hanzoai/tasks (was temporalio/server)
- README rewritten with Hanzo Tasks branding
- LLM.md created with integration notes
- Makefile, goreleaser, CI workflows updated
- go.temporal.io/sdk and go.temporal.io/api imports preserved (separate repos)

Fork of Temporal.io (MIT license).
2026-03-19 10:36:40 -07:00

304 lines
10 KiB
Go

package scheduler
import (
"fmt"
"testing"
"github.com/stretchr/testify/require"
commonpb "go.temporal.io/api/common/v1"
enumspb "go.temporal.io/api/enums/v1"
failurepb "go.temporal.io/api/failure/v1"
historypb "go.temporal.io/api/history/v1"
schedulespb "github.com/hanzoai/tasks/api/schedule/v1"
"github.com/hanzoai/tasks/common/log"
"google.golang.org/protobuf/proto"
)
func TestResponseBuilder(t *testing.T) {
nilLogger := log.NewNoopLogger()
request := schedulespb.WatchWorkflowRequest{
Execution: &commonpb.WorkflowExecution{WorkflowId: "workflow-id-1"},
}
t.Run("when execution status is RUNNING", func(t *testing.T) {
status := enumspb.WORKFLOW_EXECUTION_STATUS_RUNNING
t.Run("when LogPoll requested will return errTryAgain", func(t *testing.T) {
longPollRequest := schedulespb.WatchWorkflowRequest{LongPoll: true}
rb := newResponseBuilder(&longPollRequest, status, nilLogger, eventStorageSize-recordOverheadSize)
event := historypb.HistoryEvent{}
response, err := rb.Build(&event)
assertError(t, err, errTryAgain)
assertResponseIsNil(t, response)
})
t.Run("when it is not a LongPoll will return response with nil result", func(t *testing.T) {
rb := newResponseBuilder(&request, status, nilLogger, eventStorageSize-recordOverheadSize)
event := historypb.HistoryEvent{}
response, err := rb.Build(&event)
assertError(t, err, nil)
assertResponseResult(t, response, nil)
assertResponseStatus(t, response, enumspb.WORKFLOW_EXECUTION_STATUS_RUNNING)
})
})
t.Run("when status is COMPLETED", func(t *testing.T) {
status := enumspb.WORKFLOW_EXECUTION_STATUS_COMPLETED
t.Run("when no attrs return errNoAttrs", func(t *testing.T) {
rb := newResponseBuilder(&request, status, nilLogger, eventStorageSize-recordOverheadSize)
event := historypb.HistoryEvent{}
response, err := rb.Build(&event)
assertError(t, err, errNoAttrs)
assertResponseIsNil(t, response)
})
t.Run("when NewExecutionRunId is non empty returns errFollow", func(t *testing.T) {
rb := newResponseBuilder(&request, status, nilLogger, eventStorageSize-recordOverheadSize)
event := historypb.HistoryEvent{
Attributes: &historypb.HistoryEvent_WorkflowExecutionCompletedEventAttributes{
WorkflowExecutionCompletedEventAttributes: &historypb.WorkflowExecutionCompletedEventAttributes{
NewExecutionRunId: "some-run-id",
},
},
}
response, err := rb.Build(&event)
assertError(t, err, errFollow("some-run-id"))
assertResponseIsNil(t, response)
})
t.Run("when result is smaller then maximum should place result in response", func(t *testing.T) {
rb := newResponseBuilder(&request, status, nilLogger, eventStorageSize-recordOverheadSize)
data1K := make([]byte, 1024)
payload := commonpb.Payload{
Data: data1K,
}
payloads := []*commonpb.Payload{&payload}
event := historypb.HistoryEvent{
Attributes: &historypb.HistoryEvent_WorkflowExecutionCompletedEventAttributes{
WorkflowExecutionCompletedEventAttributes: &historypb.WorkflowExecutionCompletedEventAttributes{
Result: &commonpb.Payloads{
Payloads: payloads,
},
},
},
}
response, err := rb.Build(&event)
assertError(t, err, nil)
assertResponsePayload(t, response, payloads)
assertResponseStatus(t, response, enumspb.WORKFLOW_EXECUTION_STATUS_COMPLETED)
})
t.Run("when result is bigger then eventStorageSize will drop the result", func(t *testing.T) {
rb := newResponseBuilder(&request, status, nilLogger, eventStorageSize-recordOverheadSize)
hugeData := make([]byte, eventStorageSize-recordOverheadSize+1)
payload := commonpb.Payload{
Data: hugeData,
}
payloads := []*commonpb.Payload{&payload}
event := historypb.HistoryEvent{
Attributes: &historypb.HistoryEvent_WorkflowExecutionCompletedEventAttributes{
WorkflowExecutionCompletedEventAttributes: &historypb.WorkflowExecutionCompletedEventAttributes{
Result: &commonpb.Payloads{
Payloads: payloads,
},
},
},
}
response, err := rb.Build(&event)
assertError(t, err, nil)
assertResponsePayload(t, response, nil)
assertResponseStatus(t, response, enumspb.WORKFLOW_EXECUTION_STATUS_COMPLETED)
})
})
t.Run("when status is FAILED", func(t *testing.T) {
rb := newResponseBuilder(&request, enumspb.WORKFLOW_EXECUTION_STATUS_FAILED, nilLogger, eventStorageSize-recordOverheadSize)
t.Run("when result is nil returns errNoAttrs", func(t *testing.T) {
event := historypb.HistoryEvent{
Attributes: nil,
}
response, err := rb.Build(&event)
assertError(t, err, errNoAttrs)
assertResponseIsNil(t, response)
})
t.Run("when NewExecutionRunId not empty returns errFollow", func(t *testing.T) {
event := historypb.HistoryEvent{
Attributes: &historypb.HistoryEvent_WorkflowExecutionFailedEventAttributes{
WorkflowExecutionFailedEventAttributes: &historypb.WorkflowExecutionFailedEventAttributes{
NewExecutionRunId: "some-run-id",
},
},
}
response, err := rb.Build(&event)
assertError(t, err, errFollow("some-run-id"))
assertResponseIsNil(t, response)
})
t.Run("when NewExecutionRunId empty return failure from event", func(t *testing.T) {
event := historypb.HistoryEvent{
Attributes: &historypb.HistoryEvent_WorkflowExecutionFailedEventAttributes{
WorkflowExecutionFailedEventAttributes: &historypb.WorkflowExecutionFailedEventAttributes{
Failure: &failurepb.Failure{Message: "some failure"},
},
},
}
response, err := rb.Build(&event)
assertError(t, err, nil)
assertResponsePayload(t, response, nil)
assertResponseStatus(t, response, enumspb.WORKFLOW_EXECUTION_STATUS_FAILED)
})
})
cancelledOrTerminated := []enumspb.WorkflowExecutionStatus{
enumspb.WORKFLOW_EXECUTION_STATUS_CANCELED,
enumspb.WORKFLOW_EXECUTION_STATUS_TERMINATED}
for _, status := range cancelledOrTerminated {
t.Run(fmt.Sprintf("when status is %v return empty", status), func(t *testing.T) {
rb := newResponseBuilder(&request, status, nilLogger, eventStorageSize-recordOverheadSize)
event := historypb.HistoryEvent{}
response, err := rb.Build(&event)
assertError(t, err, nil)
assertResponseResult(t, response, nil)
assertResponseStatus(t, response, status)
})
}
t.Run("when status CONTINUED_AS_NEW", func(t *testing.T) {
rb := newResponseBuilder(
&request,
enumspb.WORKFLOW_EXECUTION_STATUS_CONTINUED_AS_NEW,
nilLogger,
eventStorageSize-recordOverheadSize,
)
t.Run("when scheduled workflow result is nil returns errNoAttr", func(t *testing.T) {
event := historypb.HistoryEvent{Attributes: nil}
response, err := rb.Build(&event)
assertError(t, err, errNoAttrs)
assertResponseIsNil(t, response)
})
t.Run("when result not nil will return errFollow", func(t *testing.T) {
event := historypb.HistoryEvent{
Attributes: &historypb.HistoryEvent_WorkflowExecutionContinuedAsNewEventAttributes{
WorkflowExecutionContinuedAsNewEventAttributes: &historypb.WorkflowExecutionContinuedAsNewEventAttributes{
NewExecutionRunId: "some-run-id",
},
},
}
response, err := rb.Build(&event)
assertError(t, err, errFollow("some-run-id"))
assertResponseIsNil(t, response)
})
})
t.Run("when status TIMED_OUT", func(t *testing.T) {
rb := newResponseBuilder(
&request, enumspb.WORKFLOW_EXECUTION_STATUS_TIMED_OUT, nilLogger, eventStorageSize-recordOverheadSize)
t.Run("when scheduled workflow result is nil returns errNoAttr", func(t *testing.T) {
event := historypb.HistoryEvent{Attributes: nil}
response, err := rb.Build(&event)
assertError(t, err, errNoAttrs)
assertResponseIsNil(t, response)
})
t.Run("when newExecutionRunId is not empty will return errFollow", func(t *testing.T) {
event := historypb.HistoryEvent{
Attributes: &historypb.HistoryEvent_WorkflowExecutionTimedOutEventAttributes{
WorkflowExecutionTimedOutEventAttributes: &historypb.WorkflowExecutionTimedOutEventAttributes{
NewExecutionRunId: "some-run-id",
},
},
}
response, err := rb.Build(&event)
assertError(t, err, errFollow("some-run-id"))
assertResponseIsNil(t, response)
})
t.Run("when newExecutionRunId is empty will return empty result", func(t *testing.T) {
event := historypb.HistoryEvent{
Attributes: &historypb.HistoryEvent_WorkflowExecutionTimedOutEventAttributes{
WorkflowExecutionTimedOutEventAttributes: &historypb.WorkflowExecutionTimedOutEventAttributes{},
},
}
response, err := rb.Build(&event)
assertError(t, err, nil)
assertResponseResult(t, response, nil)
assertResponseStatus(t, response, enumspb.WORKFLOW_EXECUTION_STATUS_TIMED_OUT)
})
})
t.Run("when status is UNSPECIFIED will return errUnknownFlow", func(t *testing.T) {
rb := newResponseBuilder(
&request, enumspb.WORKFLOW_EXECUTION_STATUS_UNSPECIFIED, nilLogger, eventStorageSize-recordOverheadSize)
event := historypb.HistoryEvent{}
response, err := rb.Build(&event)
assertError(t, err, errUnkownWorkflowStatus)
assertResponseIsNil(t, response)
})
}
func assertResponseResult(t *testing.T, response *schedulespb.WatchWorkflowResponse, expectedResult *commonpb.Payloads) {
t.Helper()
require.Truef(
t,
proto.Equal(response.GetResult(), expectedResult),
"incorrect response result expected %v, got %v",
expectedResult,
response.GetResult(),
)
}
func assertResponseIsNil(t *testing.T, response *schedulespb.WatchWorkflowResponse) {
t.Helper()
require.Nilf(t, response, "expected response to be nil, got %v", response)
}
func assertResponsePayload(t *testing.T, response *schedulespb.WatchWorkflowResponse, expectedPayload []*commonpb.Payload) {
t.Helper()
var actualPayloads = response.GetResult().GetPayloads()
require.Equal(t, expectedPayload, actualPayloads, "incorrect response payload expected %v, got %v")
}
func assertResponseStatus(t *testing.T, response *schedulespb.WatchWorkflowResponse, expectedStatus enumspb.WorkflowExecutionStatus) {
t.Helper()
require.Equal(
t,
expectedStatus,
response.Status,
"wrong response status expected %v, got %v",
expectedStatus,
response.Status,
)
}
func assertError(t *testing.T, err error, expectedError error) {
t.Helper()
require.ErrorIsf(t, err, expectedError, "expected error %v, got %v", expectedError, err)
}