mirror of
https://github.com/hanzoai/tasks.git
synced 2026-10-04 02:04:03 +00:00
Roey BermanandGitHub
6263044d8c
## What changed? - Implemented operation cancelation executors - Fixed bug where we weren't correctly identifying service not found errors - Fixed bug where task would fail instead of operation when service is not found - Fixed bug where context timeout was on the task instead of the request for callback and operation invocations preventing saving the result - Moved `GenerateEventLoadToken` from being a mutable state method to a static method as it does not require access to mutable state and makes this method accessible in more contexts - Added `LoadHistoryEvent` to the `MutableState` interface so it is generated in the mock. ## Why? Part of the functionality for nexus operations. Note that in the future we'll want to support canceling a not yet started operation. There are TODOs in the code base to address this. For now if an operation is canceled before start is recorded, cancelation isn't transmitted to the handler even though the operation may be already started. ## How did you test it? Added and rewrote tests.
590 lines
25 KiB
Go
590 lines
25 KiB
Go
// The MIT License
|
|
//
|
|
// Copyright (c) 2024 Temporal Technologies Inc. All rights reserved.
|
|
//
|
|
// 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 nexusoperations_test
|
|
|
|
import (
|
|
"context"
|
|
"encoding/json"
|
|
"errors"
|
|
"fmt"
|
|
"testing"
|
|
"time"
|
|
|
|
"github.com/golang/mock/gomock"
|
|
"github.com/nexus-rpc/sdk-go/nexus"
|
|
"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"
|
|
nexuspb "go.temporal.io/api/nexus/v1"
|
|
"go.temporal.io/api/serviceerror"
|
|
"go.temporal.io/sdk/converter"
|
|
enumsspb "go.temporal.io/server/api/enums/v1"
|
|
"go.temporal.io/server/api/persistence/v1"
|
|
"go.temporal.io/server/common/definition"
|
|
"go.temporal.io/server/common/dynamicconfig"
|
|
"go.temporal.io/server/common/namespace"
|
|
commonnexus "go.temporal.io/server/common/nexus"
|
|
"go.temporal.io/server/common/nexus/nexustest"
|
|
"go.temporal.io/server/common/testing/protorequire"
|
|
"go.temporal.io/server/components/nexusoperations"
|
|
"go.temporal.io/server/service/history/consts"
|
|
"go.temporal.io/server/service/history/hsm"
|
|
"go.temporal.io/server/service/history/queues"
|
|
)
|
|
|
|
func mustToPayload(t *testing.T, input any) *commonpb.Payload {
|
|
conv := converter.GetDefaultDataConverter()
|
|
payload, err := conv.ToPayload(input)
|
|
require.NoError(t, err)
|
|
return payload
|
|
}
|
|
|
|
type handler struct {
|
|
nexus.UnimplementedHandler
|
|
OnStartOperation func(ctx context.Context, operation string, input *nexus.LazyValue, options nexus.StartOperationOptions) (nexus.HandlerStartOperationResult[any], error)
|
|
OnCancelOperation func(ctx context.Context, operation, operationID string, options nexus.CancelOperationOptions) error
|
|
}
|
|
|
|
func (h handler) StartOperation(ctx context.Context, operation string, input *nexus.LazyValue, options nexus.StartOperationOptions) (nexus.HandlerStartOperationResult[any], error) {
|
|
return h.OnStartOperation(ctx, operation, input, options)
|
|
}
|
|
|
|
func (h handler) CancelOperation(ctx context.Context, operation, operationID string, options nexus.CancelOperationOptions) error {
|
|
return h.OnCancelOperation(ctx, operation, operationID, options)
|
|
}
|
|
|
|
func TestProcessInvocationTask(t *testing.T) {
|
|
cases := []struct {
|
|
name string
|
|
serviceNotFound bool
|
|
onStartOperation func(ctx context.Context, operation string, input *nexus.LazyValue, options nexus.StartOperationOptions) (nexus.HandlerStartOperationResult[any], error)
|
|
checkOutcome func(t *testing.T, op nexusoperations.Operation, events []*historypb.HistoryEvent)
|
|
requestTimeout time.Duration
|
|
}{
|
|
{
|
|
name: "async start",
|
|
requestTimeout: time.Hour,
|
|
onStartOperation: func(ctx context.Context, operation string, input *nexus.LazyValue, options nexus.StartOperationOptions) (nexus.HandlerStartOperationResult[any], error) {
|
|
return &nexus.HandlerStartOperationResultAsync{OperationID: "op-id"}, nil
|
|
},
|
|
checkOutcome: func(t *testing.T, op nexusoperations.Operation, events []*historypb.HistoryEvent) {
|
|
require.Equal(t, enumsspb.NEXUS_OPERATION_STATE_STARTED, op.State())
|
|
require.Equal(t, 1, len(events))
|
|
require.Equal(t, enumspb.EVENT_TYPE_NEXUS_OPERATION_STARTED, events[0].EventType)
|
|
protorequire.ProtoEqual(t, &historypb.NexusOperationStartedEventAttributes{
|
|
ScheduledEventId: 1,
|
|
OperationId: "op-id",
|
|
}, events[0].GetNexusOperationStartedEventAttributes())
|
|
},
|
|
},
|
|
{
|
|
name: "sync start",
|
|
requestTimeout: time.Hour,
|
|
onStartOperation: func(ctx context.Context, operation string, input *nexus.LazyValue, options nexus.StartOperationOptions) (nexus.HandlerStartOperationResult[any], error) {
|
|
// Also use this test case to check the input and options provided.
|
|
if operation != "operation" {
|
|
return nil, nexus.HandlerErrorf(nexus.HandlerErrorTypeBadRequest, "invalid operation name")
|
|
}
|
|
if options.CallbackHeader.Get("temporal-callback-token") == "" {
|
|
return nil, nexus.HandlerErrorf(nexus.HandlerErrorTypeBadRequest, "empty callback token")
|
|
}
|
|
if options.CallbackURL != "http://localhost/callback" {
|
|
return nil, nexus.HandlerErrorf(nexus.HandlerErrorTypeBadRequest, "invalid callback URL")
|
|
}
|
|
var v string
|
|
if err := input.Consume(&v); err != nil || v != "input" {
|
|
return nil, nexus.HandlerErrorf(nexus.HandlerErrorTypeBadRequest, "invalid input")
|
|
}
|
|
return &nexus.HandlerStartOperationResultSync[any]{Value: "result"}, nil
|
|
},
|
|
checkOutcome: func(t *testing.T, op nexusoperations.Operation, events []*historypb.HistoryEvent) {
|
|
require.Equal(t, enumsspb.NEXUS_OPERATION_STATE_SUCCEEDED, op.State())
|
|
require.Equal(t, 1, len(events))
|
|
require.Equal(t, enumspb.EVENT_TYPE_NEXUS_OPERATION_COMPLETED, events[0].EventType)
|
|
attrs := &historypb.NexusOperationCompletedEventAttributes{
|
|
ScheduledEventId: 1,
|
|
Result: mustToPayload(t, "result"),
|
|
}
|
|
protorequire.ProtoEqual(t, attrs, events[0].GetNexusOperationCompletedEventAttributes())
|
|
},
|
|
},
|
|
{
|
|
name: "sync failed",
|
|
requestTimeout: time.Hour,
|
|
onStartOperation: func(ctx context.Context, operation string, input *nexus.LazyValue, options nexus.StartOperationOptions) (nexus.HandlerStartOperationResult[any], error) {
|
|
return nil, &nexus.UnsuccessfulOperationError{
|
|
Failure: nexus.Failure{Message: "operation failed from handler", Metadata: map[string]string{"encoding": "json/plain"}, Details: json.RawMessage("\"details\"")},
|
|
State: nexus.OperationStateFailed,
|
|
}
|
|
},
|
|
checkOutcome: func(t *testing.T, op nexusoperations.Operation, events []*historypb.HistoryEvent) {
|
|
require.Equal(t, enumsspb.NEXUS_OPERATION_STATE_FAILED, op.State())
|
|
require.Equal(t, 1, len(events))
|
|
require.Equal(t, enumspb.EVENT_TYPE_NEXUS_OPERATION_FAILED, events[0].EventType)
|
|
attrs := &historypb.NexusOperationFailedEventAttributes{
|
|
ScheduledEventId: 1,
|
|
Failure: &failurepb.Failure{
|
|
Message: "nexus operation completed unsuccessfully",
|
|
FailureInfo: &failurepb.Failure_NexusOperationExecutionFailureInfo{
|
|
NexusOperationExecutionFailureInfo: &failurepb.NexusOperationFailureInfo{
|
|
ScheduledEventId: 1,
|
|
Service: "service",
|
|
Operation: "operation",
|
|
},
|
|
},
|
|
Cause: &failurepb.Failure{
|
|
Message: "operation failed from handler",
|
|
FailureInfo: &failurepb.Failure_ApplicationFailureInfo{
|
|
ApplicationFailureInfo: &failurepb.ApplicationFailureInfo{
|
|
Type: "NexusOperationFailure",
|
|
Details: &commonpb.Payloads{
|
|
Payloads: []*commonpb.Payload{
|
|
mustToPayload(t, "details"),
|
|
},
|
|
},
|
|
NonRetryable: true,
|
|
},
|
|
},
|
|
},
|
|
},
|
|
}
|
|
protorequire.ProtoEqual(t, attrs, events[0].GetNexusOperationFailedEventAttributes())
|
|
},
|
|
},
|
|
{
|
|
name: "sync canceled",
|
|
requestTimeout: time.Hour,
|
|
onStartOperation: func(ctx context.Context, operation string, input *nexus.LazyValue, options nexus.StartOperationOptions) (nexus.HandlerStartOperationResult[any], error) {
|
|
return nil, &nexus.UnsuccessfulOperationError{
|
|
Failure: nexus.Failure{Message: "operation canceled from handler", Metadata: map[string]string{"encoding": "json/plain"}, Details: json.RawMessage("\"details\"")},
|
|
State: nexus.OperationStateCanceled,
|
|
}
|
|
},
|
|
checkOutcome: func(t *testing.T, op nexusoperations.Operation, events []*historypb.HistoryEvent) {
|
|
require.Equal(t, enumsspb.NEXUS_OPERATION_STATE_CANCELED, op.State())
|
|
require.Equal(t, 1, len(events))
|
|
require.Equal(t, enumspb.EVENT_TYPE_NEXUS_OPERATION_CANCELED, events[0].EventType)
|
|
attrs := &historypb.NexusOperationCanceledEventAttributes{
|
|
ScheduledEventId: 1,
|
|
Failure: &failurepb.Failure{
|
|
Message: "nexus operation completed unsuccessfully",
|
|
FailureInfo: &failurepb.Failure_NexusOperationExecutionFailureInfo{
|
|
NexusOperationExecutionFailureInfo: &failurepb.NexusOperationFailureInfo{
|
|
ScheduledEventId: 1,
|
|
Service: "service",
|
|
Operation: "operation",
|
|
},
|
|
},
|
|
Cause: &failurepb.Failure{
|
|
Message: "operation canceled from handler",
|
|
FailureInfo: &failurepb.Failure_CanceledFailureInfo{
|
|
CanceledFailureInfo: &failurepb.CanceledFailureInfo{
|
|
Details: &commonpb.Payloads{
|
|
Payloads: []*commonpb.Payload{
|
|
mustToPayload(t, "details"),
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
}
|
|
protorequire.ProtoEqual(t, attrs, events[0].GetNexusOperationCanceledEventAttributes())
|
|
},
|
|
},
|
|
{
|
|
name: "transient error",
|
|
requestTimeout: time.Hour,
|
|
onStartOperation: func(ctx context.Context, operation string, input *nexus.LazyValue, options nexus.StartOperationOptions) (nexus.HandlerStartOperationResult[any], error) {
|
|
return nil, nexus.HandlerErrorf(nexus.HandlerErrorTypeInternal, "internal server error")
|
|
},
|
|
checkOutcome: func(t *testing.T, op nexusoperations.Operation, events []*historypb.HistoryEvent) {
|
|
require.Equal(t, enumsspb.NEXUS_OPERATION_STATE_BACKING_OFF, op.State())
|
|
require.NotNil(t, op.LastAttemptFailure.GetApplicationFailureInfo())
|
|
require.Equal(t, "unexpected response status: \"500 Internal Server Error\": internal server error", op.LastAttemptFailure.Message)
|
|
require.Equal(t, 0, len(events))
|
|
},
|
|
},
|
|
{
|
|
name: "invocation timeout",
|
|
requestTimeout: time.Microsecond,
|
|
onStartOperation: func(ctx context.Context, operation string, input *nexus.LazyValue, options nexus.StartOperationOptions) (nexus.HandlerStartOperationResult[any], error) {
|
|
time.Sleep(time.Millisecond * 100)
|
|
return &nexus.HandlerStartOperationResultAsync{OperationID: "op-id"}, nil
|
|
},
|
|
checkOutcome: func(t *testing.T, op nexusoperations.Operation, events []*historypb.HistoryEvent) {
|
|
require.Equal(t, enumsspb.NEXUS_OPERATION_STATE_BACKING_OFF, op.State())
|
|
require.NotNil(t, op.LastAttemptFailure.GetApplicationFailureInfo())
|
|
require.Regexp(t, "Post \"http://localhost:\\d+/operation\\?callback=http%3A%2F%2Flocalhost%2Fcallback\": context deadline exceeded", op.LastAttemptFailure.Message)
|
|
require.Equal(t, 0, len(events))
|
|
},
|
|
},
|
|
{
|
|
name: "service not found",
|
|
serviceNotFound: true,
|
|
requestTimeout: time.Hour,
|
|
onStartOperation: nil, // This should not be called if the service is not found.
|
|
checkOutcome: func(t *testing.T, op nexusoperations.Operation, events []*historypb.HistoryEvent) {
|
|
require.Equal(t, enumsspb.NEXUS_OPERATION_STATE_FAILED, op.State())
|
|
require.NotNil(t, op.LastAttemptFailure.GetApplicationFailureInfo())
|
|
require.Equal(t, "cannot find service in namespace outgoing registry", op.LastAttemptFailure.Message)
|
|
require.Equal(t, 1, len(events))
|
|
},
|
|
},
|
|
}
|
|
for _, tc := range cases {
|
|
tc := tc
|
|
t.Run(tc.name, func(t *testing.T) {
|
|
t.Parallel()
|
|
ctrl := gomock.NewController(t)
|
|
listenAddr := nexustest.AllocListenAddress(t)
|
|
h := handler{}
|
|
h.OnStartOperation = tc.onStartOperation
|
|
nexustest.NewNexusServer(t, listenAddr, h)
|
|
|
|
reg := newRegistry(t)
|
|
backend := &nodeBackend{}
|
|
node := newOperationNode(t, backend, time.Now(), time.Hour)
|
|
env := fakeEnv{node}
|
|
namespaceRegistry := namespace.NewMockRegistry(ctrl)
|
|
if tc.serviceNotFound {
|
|
namespaceRegistry.EXPECT().NexusOutgoingService(namespace.ID("ns-id"), "svc-name").Return(
|
|
nil, serviceerror.NewNotFound("service not found"))
|
|
} else {
|
|
namespaceRegistry.EXPECT().GetNamespaceByID(namespace.ID("ns-id")).Return(
|
|
namespace.NewNamespaceForTest(&persistence.NamespaceInfo{Name: "ns-name"}, nil, false, nil, 0), nil)
|
|
namespaceRegistry.EXPECT().NexusOutgoingService(namespace.ID("ns-id"), "svc-name").Return(
|
|
&nexuspb.OutgoingServiceSpec{Url: fmt.Sprintf("http://%s", listenAddr), PublicCallbackUrl: "http://localhost/callback"}, nil)
|
|
}
|
|
|
|
require.NoError(t, nexusoperations.RegisterExecutor(reg, nexusoperations.ActiveExecutorOptions{
|
|
Config: &nexusoperations.Config{
|
|
Enabled: dynamicconfig.GetBoolPropertyFnFilteredByNamespace(true),
|
|
RequestTimeout: dynamicconfig.GetDurationPropertyFnFilteredByNamespace(tc.requestTimeout),
|
|
},
|
|
CallbackTokenGenerator: commonnexus.NewCallbackTokenGenerator(),
|
|
NamespaceRegistry: namespaceRegistry,
|
|
ClientProvider: func(nid queues.NamespaceIDAndDestination, spec *nexuspb.OutgoingServiceSpec) (*nexus.Client, error) {
|
|
return nexus.NewClient(nexus.ClientOptions{
|
|
ServiceBaseURL: spec.Url,
|
|
Serializer: commonnexus.PayloadSerializer,
|
|
})
|
|
},
|
|
}))
|
|
|
|
err := hsm.Execute(context.Background(), reg, env, hsm.Ref{WorkflowKey: definition.NewWorkflowKey("ns-id", "wf-id", "run-id"), StateMachineRef: &persistence.StateMachineRef{}}, nexusoperations.InvocationTask{Destination: "svc-name"})
|
|
require.NoError(t, err)
|
|
op, err := hsm.MachineData[nexusoperations.Operation](node)
|
|
require.NoError(t, err)
|
|
tc.checkOutcome(t, op, backend.events)
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestProcessBackoffTask(t *testing.T) {
|
|
reg := newRegistry(t)
|
|
backend := &nodeBackend{}
|
|
node := newOperationNode(t, backend, time.Now(), time.Hour)
|
|
env := fakeEnv{node}
|
|
|
|
require.NoError(t, nexusoperations.RegisterExecutor(reg, nexusoperations.ActiveExecutorOptions{}))
|
|
err := hsm.MachineTransition(node, func(op nexusoperations.Operation) (hsm.TransitionOutput, error) {
|
|
return nexusoperations.TransitionAttemptFailed.Apply(op, nexusoperations.EventAttemptFailed{
|
|
Node: node,
|
|
AttemptFailure: nexusoperations.AttemptFailure{
|
|
Time: time.Now(),
|
|
Err: errors.New("test"),
|
|
},
|
|
})
|
|
})
|
|
require.NoError(t, err)
|
|
|
|
err = hsm.Execute(context.Background(), reg, env, hsm.Ref{}, nexusoperations.BackoffTask{})
|
|
require.NoError(t, err)
|
|
op, err := hsm.MachineData[nexusoperations.Operation](node)
|
|
require.NoError(t, err)
|
|
require.Equal(t, enumsspb.NEXUS_OPERATION_STATE_SCHEDULED, op.State())
|
|
require.Equal(t, 0, len(backend.events))
|
|
}
|
|
|
|
func TestProcessTimeoutTask(t *testing.T) {
|
|
reg := newRegistry(t)
|
|
backend := &nodeBackend{}
|
|
node := newOperationNode(t, backend, time.Now(), time.Hour)
|
|
env := fakeEnv{node}
|
|
|
|
require.NoError(t, nexusoperations.RegisterExecutor(reg, nexusoperations.ActiveExecutorOptions{}))
|
|
|
|
err := hsm.Execute(context.Background(), reg, env, hsm.Ref{}, nexusoperations.TimeoutTask{})
|
|
require.NoError(t, err)
|
|
op, err := hsm.MachineData[nexusoperations.Operation](node)
|
|
require.NoError(t, err)
|
|
require.Equal(t, enumsspb.NEXUS_OPERATION_STATE_TIMED_OUT, op.State())
|
|
require.Equal(t, 1, len(backend.events))
|
|
require.Equal(t, enumspb.EVENT_TYPE_NEXUS_OPERATION_TIMED_OUT, backend.events[0].EventType)
|
|
protorequire.ProtoEqual(t, &historypb.NexusOperationTimedOutEventAttributes{
|
|
ScheduledEventId: 1,
|
|
Failure: &failurepb.Failure{
|
|
Message: "nexus operation completed unsuccessfully",
|
|
FailureInfo: &failurepb.Failure_NexusOperationExecutionFailureInfo{
|
|
NexusOperationExecutionFailureInfo: &failurepb.NexusOperationFailureInfo{
|
|
ScheduledEventId: 1,
|
|
Service: "service",
|
|
Operation: "operation",
|
|
},
|
|
},
|
|
Cause: &failurepb.Failure{
|
|
Message: "operation timed out",
|
|
FailureInfo: &failurepb.Failure_TimeoutFailureInfo{
|
|
TimeoutFailureInfo: &failurepb.TimeoutFailureInfo{
|
|
TimeoutType: enumspb.TIMEOUT_TYPE_SCHEDULE_TO_CLOSE,
|
|
},
|
|
},
|
|
},
|
|
},
|
|
}, backend.events[0].GetNexusOperationTimedOutEventAttributes())
|
|
}
|
|
|
|
func TestProcessCancelationTask(t *testing.T) {
|
|
cases := []struct {
|
|
name string
|
|
serviceNotFound bool
|
|
onCancelOperation func(ctx context.Context, operation, operationID string, options nexus.CancelOperationOptions) error
|
|
checkOutcome func(t *testing.T, op nexusoperations.Cancelation)
|
|
requestTimeout time.Duration
|
|
}{
|
|
{
|
|
name: "failure",
|
|
requestTimeout: time.Hour,
|
|
onCancelOperation: func(ctx context.Context, operation, operationID string, options nexus.CancelOperationOptions) error {
|
|
return nexus.HandlerErrorf(nexus.HandlerErrorTypeNotFound, "operation not found")
|
|
},
|
|
checkOutcome: func(t *testing.T, c nexusoperations.Cancelation) {
|
|
require.Equal(t, enumspb.NEXUS_OPERATION_CANCELLATION_STATE_FAILED, c.State())
|
|
require.NotNil(t, c.LastAttemptFailure.GetApplicationFailureInfo())
|
|
require.Equal(t, "unexpected response status: \"404 Not Found\": operation not found", c.LastAttemptFailure.Message)
|
|
},
|
|
},
|
|
{
|
|
name: "success",
|
|
requestTimeout: time.Hour,
|
|
onCancelOperation: func(ctx context.Context, operation, operationID string, options nexus.CancelOperationOptions) error {
|
|
return nil
|
|
},
|
|
checkOutcome: func(t *testing.T, c nexusoperations.Cancelation) {
|
|
require.Equal(t, enumspb.NEXUS_OPERATION_CANCELLATION_STATE_SUCCEEDED, c.State())
|
|
require.Nil(t, c.LastAttemptFailure.GetApplicationFailureInfo())
|
|
},
|
|
},
|
|
{
|
|
name: "transient error",
|
|
requestTimeout: time.Hour,
|
|
onCancelOperation: func(ctx context.Context, operation, operationID string, options nexus.CancelOperationOptions) error {
|
|
return nexus.HandlerErrorf(nexus.HandlerErrorTypeInternal, "internal server error")
|
|
},
|
|
checkOutcome: func(t *testing.T, c nexusoperations.Cancelation) {
|
|
require.Equal(t, enumspb.NEXUS_OPERATION_CANCELLATION_STATE_BACKING_OFF, c.State())
|
|
require.NotNil(t, c.LastAttemptFailure.GetApplicationFailureInfo())
|
|
require.Equal(t, "unexpected response status: \"500 Internal Server Error\": internal server error", c.LastAttemptFailure.Message)
|
|
},
|
|
},
|
|
{
|
|
name: "invocation timeout",
|
|
requestTimeout: time.Microsecond,
|
|
onCancelOperation: func(ctx context.Context, operation, operationID string, options nexus.CancelOperationOptions) error {
|
|
time.Sleep(time.Millisecond * 100)
|
|
return nil
|
|
},
|
|
checkOutcome: func(t *testing.T, c nexusoperations.Cancelation) {
|
|
require.Equal(t, enumspb.NEXUS_OPERATION_CANCELLATION_STATE_BACKING_OFF, c.State())
|
|
require.NotNil(t, c.LastAttemptFailure.GetApplicationFailureInfo())
|
|
require.Regexp(t, "Post \"http://localhost:\\d+/operation/op-id/cancel\": context deadline exceeded", c.LastAttemptFailure.Message)
|
|
},
|
|
},
|
|
{
|
|
name: "service not found",
|
|
serviceNotFound: true,
|
|
requestTimeout: time.Hour,
|
|
onCancelOperation: nil, // This should not be called if the service is not found.
|
|
checkOutcome: func(t *testing.T, c nexusoperations.Cancelation) {
|
|
require.Equal(t, enumspb.NEXUS_OPERATION_CANCELLATION_STATE_FAILED, c.State())
|
|
require.NotNil(t, c.LastAttemptFailure.GetApplicationFailureInfo())
|
|
require.Equal(t, "cannot find service in namespace outgoing registry", c.LastAttemptFailure.Message)
|
|
},
|
|
},
|
|
}
|
|
for _, tc := range cases {
|
|
tc := tc
|
|
t.Run(tc.name, func(t *testing.T) {
|
|
t.Parallel()
|
|
ctrl := gomock.NewController(t)
|
|
listenAddr := nexustest.AllocListenAddress(t)
|
|
h := handler{}
|
|
h.OnCancelOperation = tc.onCancelOperation
|
|
nexustest.NewNexusServer(t, listenAddr, h)
|
|
|
|
reg := newRegistry(t)
|
|
backend := &nodeBackend{}
|
|
node := newOperationNode(t, backend, time.Now(), time.Hour)
|
|
op, err := hsm.MachineData[nexusoperations.Operation](node)
|
|
require.NoError(t, err)
|
|
_, err = nexusoperations.TransitionStarted.Apply(op, nexusoperations.EventStarted{
|
|
Time: time.Now(),
|
|
Attributes: &historypb.NexusOperationStartedEventAttributes{
|
|
OperationId: "op-id",
|
|
},
|
|
Node: node,
|
|
})
|
|
require.NoError(t, err)
|
|
_, err = op.Cancel(node, time.Now())
|
|
require.NoError(t, err)
|
|
node, err = node.Child([]hsm.Key{nexusoperations.CancelationMachineKey})
|
|
require.NoError(t, err)
|
|
|
|
env := fakeEnv{node}
|
|
namespaceRegistry := namespace.NewMockRegistry(ctrl)
|
|
if tc.serviceNotFound {
|
|
namespaceRegistry.EXPECT().NexusOutgoingService(namespace.ID("ns-id"), "svc-name").Return(
|
|
nil, serviceerror.NewNotFound("service not found"))
|
|
} else {
|
|
namespaceRegistry.EXPECT().GetNamespaceByID(namespace.ID("ns-id")).Return(
|
|
namespace.NewNamespaceForTest(&persistence.NamespaceInfo{Name: "ns-name"}, nil, false, nil, 0), nil)
|
|
namespaceRegistry.EXPECT().NexusOutgoingService(namespace.ID("ns-id"), "svc-name").Return(
|
|
&nexuspb.OutgoingServiceSpec{Url: fmt.Sprintf("http://%s", listenAddr), PublicCallbackUrl: "http://localhost/callback"}, nil)
|
|
}
|
|
|
|
require.NoError(t, nexusoperations.RegisterExecutor(reg, nexusoperations.ActiveExecutorOptions{
|
|
Config: &nexusoperations.Config{
|
|
Enabled: dynamicconfig.GetBoolPropertyFnFilteredByNamespace(true),
|
|
RequestTimeout: dynamicconfig.GetDurationPropertyFnFilteredByNamespace(tc.requestTimeout),
|
|
},
|
|
NamespaceRegistry: namespaceRegistry,
|
|
ClientProvider: func(nid queues.NamespaceIDAndDestination, spec *nexuspb.OutgoingServiceSpec) (*nexus.Client, error) {
|
|
return nexus.NewClient(nexus.ClientOptions{
|
|
ServiceBaseURL: spec.Url,
|
|
Serializer: commonnexus.PayloadSerializer,
|
|
})
|
|
},
|
|
}))
|
|
|
|
err = hsm.Execute(context.Background(), reg, env, hsm.Ref{WorkflowKey: definition.NewWorkflowKey("ns-id", "wf-id", "run-id"), StateMachineRef: &persistence.StateMachineRef{}}, nexusoperations.CancelationTask{Destination: "svc-name"})
|
|
require.NoError(t, err)
|
|
cancelation, err := hsm.MachineData[nexusoperations.Cancelation](node)
|
|
require.NoError(t, err)
|
|
tc.checkOutcome(t, cancelation)
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestProcessCancelationTask_OperationCompleted(t *testing.T) {
|
|
t.Parallel()
|
|
ctrl := gomock.NewController(t)
|
|
|
|
reg := newRegistry(t)
|
|
backend := &nodeBackend{}
|
|
node := newOperationNode(t, backend, time.Now(), time.Hour)
|
|
op, err := hsm.MachineData[nexusoperations.Operation](node)
|
|
require.NoError(t, err)
|
|
_, err = nexusoperations.TransitionStarted.Apply(op, nexusoperations.EventStarted{
|
|
Time: time.Now(),
|
|
Attributes: &historypb.NexusOperationStartedEventAttributes{
|
|
OperationId: "op-id",
|
|
},
|
|
Node: node,
|
|
})
|
|
require.NoError(t, err)
|
|
_, err = op.Cancel(node, time.Now())
|
|
require.NoError(t, err)
|
|
_, err = nexusoperations.TransitionSucceeded.Apply(op, nexusoperations.EventSucceeded{
|
|
Node: node,
|
|
})
|
|
require.NoError(t, err)
|
|
node, err = node.Child([]hsm.Key{nexusoperations.CancelationMachineKey})
|
|
require.NoError(t, err)
|
|
|
|
env := fakeEnv{node}
|
|
namespaceRegistry := namespace.NewMockRegistry(ctrl)
|
|
namespaceRegistry.EXPECT().NexusOutgoingService(namespace.ID("ns-id"), "svc-name").Return(
|
|
&nexuspb.OutgoingServiceSpec{Url: "http://dont-care", PublicCallbackUrl: "http://localhost/callback"}, nil)
|
|
|
|
require.NoError(t, nexusoperations.RegisterExecutor(reg, nexusoperations.ActiveExecutorOptions{
|
|
Config: &nexusoperations.Config{
|
|
Enabled: dynamicconfig.GetBoolPropertyFnFilteredByNamespace(true),
|
|
RequestTimeout: dynamicconfig.GetDurationPropertyFnFilteredByNamespace(time.Hour),
|
|
},
|
|
NamespaceRegistry: namespaceRegistry,
|
|
ClientProvider: func(nid queues.NamespaceIDAndDestination, spec *nexuspb.OutgoingServiceSpec) (*nexus.Client, error) {
|
|
return nexus.NewClient(nexus.ClientOptions{
|
|
ServiceBaseURL: spec.Url,
|
|
Serializer: commonnexus.PayloadSerializer,
|
|
})
|
|
},
|
|
}))
|
|
|
|
err = hsm.Execute(context.Background(), reg, env, hsm.Ref{WorkflowKey: definition.NewWorkflowKey("ns-id", "wf-id", "run-id"), StateMachineRef: &persistence.StateMachineRef{}}, nexusoperations.CancelationTask{Destination: "svc-name"})
|
|
require.ErrorIs(t, err, consts.ErrStaleReference)
|
|
}
|
|
|
|
func TestProcessCancelationBackoffTask(t *testing.T) {
|
|
reg := newRegistry(t)
|
|
backend := &nodeBackend{}
|
|
node := newOperationNode(t, backend, time.Now(), time.Hour)
|
|
op, err := hsm.MachineData[nexusoperations.Operation](node)
|
|
require.NoError(t, err)
|
|
_, err = nexusoperations.TransitionStarted.Apply(op, nexusoperations.EventStarted{
|
|
Time: time.Now(),
|
|
Attributes: &historypb.NexusOperationStartedEventAttributes{
|
|
OperationId: "op-id",
|
|
},
|
|
Node: node,
|
|
})
|
|
require.NoError(t, err)
|
|
_, err = op.Cancel(node, time.Now())
|
|
require.NoError(t, err)
|
|
|
|
node, err = node.Child([]hsm.Key{nexusoperations.CancelationMachineKey})
|
|
require.NoError(t, err)
|
|
|
|
err = hsm.MachineTransition(node, func(c nexusoperations.Cancelation) (hsm.TransitionOutput, error) {
|
|
return nexusoperations.TransitionCancelationAttemptFailed.Apply(c, nexusoperations.EventCancelationAttemptFailed{
|
|
Time: time.Now(),
|
|
Err: fmt.Errorf("test attempt failed"),
|
|
Node: node,
|
|
})
|
|
})
|
|
require.NoError(t, err)
|
|
|
|
env := fakeEnv{node}
|
|
|
|
require.NoError(t, nexusoperations.RegisterExecutor(reg, nexusoperations.ActiveExecutorOptions{}))
|
|
|
|
err = hsm.Execute(context.Background(), reg, env, hsm.Ref{}, nexusoperations.CancelationBackoffTask{})
|
|
require.NoError(t, err)
|
|
c, err := hsm.MachineData[nexusoperations.Cancelation](node)
|
|
require.NoError(t, err)
|
|
require.Equal(t, enumspb.NEXUS_OPERATION_CANCELLATION_STATE_SCHEDULED, c.State())
|
|
require.Equal(t, 0, len(backend.events))
|
|
}
|