Files
tasks/components/callbacks/hsm_invocation.go
Roey BermanandGitHub 03d7a6dbdb Nexus callback and task validation fixes (#6918)
## What changed?

- Fixed the callback executor to not fail a task on retryable error (a
regression introduced while refactoring to support HSM callbacks)
- No longer use `ValidateNotTransitioned` in task validation logic. We
can deprecate the `transition_count` field on the state machine node
proto after this.

## Why?

The first fix is a simple bug fix, the second change is for unblocking
the state replication efforts.

## How did you test it?

Leveraged existing tests.
2024-12-03 12:57:34 -08:00

116 lines
3.7 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 callbacks
import (
"context"
"fmt"
"time"
"go.temporal.io/server/api/historyservice/v1"
persistencespb "go.temporal.io/server/api/persistence/v1"
"go.temporal.io/server/common/log/tag"
"go.temporal.io/server/common/metrics"
"go.temporal.io/server/common/namespace"
"google.golang.org/grpc/codes"
"google.golang.org/grpc/status"
)
type CanGetHSMCompletionCallbackArg interface {
GetHSMCompletionCallbackArg(ctx context.Context) (*persistencespb.HSMCompletionCallbackArg, error)
}
type hsmInvocation struct {
hsm *persistencespb.Callback_HSM
callbackArg *persistencespb.HSMCompletionCallbackArg
}
func isRetryableRpcResponse(err error) bool {
var st *status.Status
stGetter, ok := err.(interface{ Status() *status.Status })
if ok {
st = stGetter.Status()
} else {
st, ok = status.FromError(err)
if !ok {
// Not a gRPC induced error
return false
}
}
// nolint:exhaustive
switch st.Code() {
case codes.Canceled,
codes.Unknown,
codes.Unavailable,
codes.DeadlineExceeded,
codes.ResourceExhausted,
codes.Aborted,
codes.Internal:
return true
default:
return false
}
}
func (s hsmInvocation) WrapError(invocationResult, error) error {
// No short-circuit
return nil
}
func (s hsmInvocation) Invoke(ctx context.Context, ns *namespace.Namespace, e taskExecutor, task InvocationTask) invocationResult {
// TODO(Tianyu): Will this ever be too big for an RPC call?
callbackArgSerialized, err := s.callbackArg.Marshal()
if err != nil {
return invocationResultFail{fmt.Errorf("failed to serialize completion event: %w", err)}
}
request := historyservice.InvokeStateMachineMethodRequest{
NamespaceId: s.hsm.NamespaceId,
WorkflowId: s.hsm.WorkflowId,
RunId: s.hsm.RunId,
Ref: s.hsm.Ref,
MethodName: s.hsm.Method,
Input: callbackArgSerialized,
}
startTime := time.Now()
_, err = e.HistoryClient.InvokeStateMachineMethod(ctx, &request)
// Log down metrics about the call
namespaceTag := metrics.NamespaceTag(ns.Name().String())
destTag := metrics.DestinationTag(task.Destination())
statusCodeTag := metrics.OutcomeTag(fmt.Sprintf("status:%d", status.Code(err)))
e.MetricsHandler.Counter(RequestCounter.Name()).Record(1, namespaceTag, destTag, statusCodeTag)
e.MetricsHandler.Timer(RequestLatencyHistogram.Name()).Record(time.Since(startTime), namespaceTag, destTag, statusCodeTag)
if err != nil {
e.Logger.Error("Callback request failed", tag.Error(err))
if isRetryableRpcResponse(err) {
return invocationResultRetry{err}
}
return invocationResultFail{err}
}
return invocationResultOK{}
}