Files
tasks/service/frontend/nexus_completion_http_handler.go
Stephan BehnkeandGitHub 4f62eb79b1 Nexus CHASM async completion (2/2) (#9972)
## What changed?

Support completion-before-start.

## How did you test it?
- [ ] built
- [ ] run locally and tested manually
- [ ] covered by existing tests
- [x] added new unit test(s)
- [ ] added new functional test(s)
2026-04-23 08:14:57 -07:00

651 lines
26 KiB
Go

package frontend
import (
"context"
"errors"
"fmt"
"net/http"
"net/http/httptrace"
"net/url"
"runtime/debug"
"strconv"
"strings"
"time"
"github.com/gorilla/mux"
"github.com/nexus-rpc/sdk-go/nexus"
commonpb "go.temporal.io/api/common/v1"
"go.temporal.io/api/serviceerror"
"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/authorization"
"go.temporal.io/server/common/cluster"
"go.temporal.io/server/common/headers"
"go.temporal.io/server/common/log"
"go.temporal.io/server/common/log/tag"
"go.temporal.io/server/common/metrics"
"go.temporal.io/server/common/namespace"
commonnexus "go.temporal.io/server/common/nexus"
"go.temporal.io/server/common/nexus/nexusrpc"
"go.temporal.io/server/common/resource"
"go.temporal.io/server/common/rpc"
"go.temporal.io/server/common/rpc/interceptor"
"go.temporal.io/server/service/frontend/configs"
"google.golang.org/grpc/credentials"
"google.golang.org/grpc/metadata"
"google.golang.org/protobuf/proto"
"google.golang.org/protobuf/types/known/timestamppb"
)
const nexusCompletionAPIName = configs.CompleteNexusOperation
const nexusCompletionMethodNameForMetrics = "CompleteNexusOperation"
type nexusCompletionHandler struct {
ClusterMetadata cluster.Metadata
NamespaceRegistry namespace.Registry
Logger log.Logger
MetricsHandler metrics.Handler
Config *Config
CallbackTokenGenerator *commonnexus.CallbackTokenGenerator
HistoryClient resource.HistoryClient
TelemetryInterceptor *interceptor.TelemetryInterceptor
RequestErrorHandler *interceptor.RequestErrorHandler
NamespaceValidationInterceptor *interceptor.NamespaceValidatorInterceptor
NamespaceRateLimitInterceptor interceptor.NamespaceRateLimitInterceptor
NamespaceConcurrencyLimitInterceptor *interceptor.ConcurrentRequestLimitInterceptor
RateLimitInterceptor *interceptor.RateLimitInterceptor
AuthInterceptor *authorization.Interceptor
RedirectionInterceptor *interceptor.Redirection
ForwardingClients *cluster.FrontendHTTPClientCache
HTTPTraceProvider commonnexus.HTTPClientTraceProvider
clientVersionChecker headers.VersionChecker
preProcessErrorsCounter metrics.CounterIface
}
type nexusCompletionHTTPHandler struct {
httpHandler http.Handler
}
func newNexusCompletionHandler(
clusterMetadata cluster.Metadata,
namespaceRegistry namespace.Registry,
logger log.Logger,
metricsHandler metrics.Handler,
serviceConfig *Config,
callbackTokenGenerator *commonnexus.CallbackTokenGenerator,
historyClient resource.HistoryClient,
telemetryInterceptor *interceptor.TelemetryInterceptor,
requestErrorHandler *interceptor.RequestErrorHandler,
namespaceValidationInterceptor *interceptor.NamespaceValidatorInterceptor,
namespaceRateLimitInterceptor interceptor.NamespaceRateLimitInterceptor,
namespaceConcurrencyLimitInterceptor *interceptor.ConcurrentRequestLimitInterceptor,
rateLimitInterceptor *interceptor.RateLimitInterceptor,
authInterceptor *authorization.Interceptor,
redirectionInterceptor *interceptor.Redirection,
forwardingClients *cluster.FrontendHTTPClientCache,
httpTraceProvider commonnexus.HTTPClientTraceProvider,
) *nexusCompletionHandler {
return &nexusCompletionHandler{
ClusterMetadata: clusterMetadata,
NamespaceRegistry: namespaceRegistry,
Logger: logger,
MetricsHandler: metricsHandler,
Config: serviceConfig,
CallbackTokenGenerator: callbackTokenGenerator,
HistoryClient: historyClient,
TelemetryInterceptor: telemetryInterceptor,
RequestErrorHandler: requestErrorHandler,
NamespaceValidationInterceptor: namespaceValidationInterceptor,
NamespaceRateLimitInterceptor: namespaceRateLimitInterceptor,
NamespaceConcurrencyLimitInterceptor: namespaceConcurrencyLimitInterceptor,
RateLimitInterceptor: rateLimitInterceptor,
AuthInterceptor: authInterceptor,
RedirectionInterceptor: redirectionInterceptor,
ForwardingClients: forwardingClients,
HTTPTraceProvider: httpTraceProvider,
clientVersionChecker: headers.NewDefaultVersionChecker(),
preProcessErrorsCounter: metricsHandler.Counter(metrics.NexusCompletionRequestPreProcessErrors.Name()),
}
}
func newNexusCompletionHTTPHandler(handler *nexusCompletionHandler, logger log.Logger) *nexusCompletionHTTPHandler {
return &nexusCompletionHTTPHandler{
httpHandler: nexusrpc.NewCompletionHTTPHandler(nexusrpc.CompletionHandlerOptions{
Handler: handler,
Logger: log.NewSlogLogger(logger),
Serializer: commonnexus.PayloadSerializer,
}),
}
}
// CompleteOperation implements nexus.CompletionHandler.
// nolint:revive // (cyclomatic complexity) This function is long but the complexity is justified.
func (h *nexusCompletionHandler) CompleteOperation(ctx context.Context, r *nexusrpc.CompletionRequest) (retErr error) {
startTime := time.Now()
token, err := commonnexus.DecodeCallbackToken(r.HTTPRequest.Header.Get(commonnexus.CallbackTokenHeader))
if err != nil {
h.Logger.Error("failed to decode callback token", tag.Error(err))
return nexus.NewHandlerErrorf(nexus.HandlerErrorTypeBadRequest, "invalid callback token")
}
completion, err := h.CallbackTokenGenerator.DecodeCompletion(token)
if err != nil {
h.Logger.Error("failed to decode completion from token", tag.Error(err))
return nexus.NewHandlerErrorf(nexus.HandlerErrorTypeBadRequest, "invalid callback token")
}
// Determine the target namespace, workflow, and run ID from the completion token.
targetNamespaceID := completion.GetNamespaceId()
targetBusinessID := completion.GetWorkflowId()
targetRunID := completion.GetRunId()
if len(completion.GetComponentRef()) > 0 {
ref := &persistencespb.ChasmComponentRef{}
if err := proto.Unmarshal(completion.GetComponentRef(), ref); err != nil {
h.Logger.Error("failed to unmarshal CHASM component ref", tag.Error(err))
return nexus.NewHandlerErrorf(nexus.HandlerErrorTypeBadRequest, "invalid callback token")
}
targetNamespaceID = ref.GetNamespaceId()
targetBusinessID = ref.GetBusinessId()
targetRunID = ref.GetRunId()
}
ns, err := h.NamespaceRegistry.GetNamespaceByID(namespace.ID(targetNamespaceID))
if err != nil {
h.Logger.Error("failed to get namespace for nexus completion request", tag.WorkflowNamespaceID(targetNamespaceID), tag.Error(err))
h.preProcessErrorsCounter.Record(1)
var nfe *serviceerror.NamespaceNotFound
if errors.As(err, &nfe) {
return nexus.NewHandlerErrorf(nexus.HandlerErrorTypeNotFound, "namespace %q not found", targetNamespaceID)
}
return commonnexus.ConvertGRPCError(err, false)
}
logger := log.With(
h.Logger,
tag.WorkflowNamespace(ns.Name().String()),
tag.WorkflowID(targetBusinessID),
tag.WorkflowRunID(targetRunID),
)
rCtx := &requestContext{
nexusCompletionHandler: h,
namespace: ns,
businessID: targetBusinessID,
logger: log.With(h.Logger, tag.WorkflowNamespace(ns.Name().String())),
metricsHandler: h.MetricsHandler.WithTags(metrics.NamespaceTag(ns.Name().String())),
metricsHandlerForInterceptors: h.MetricsHandler.WithTags(
metrics.OperationTag(nexusCompletionMethodNameForMetrics),
metrics.NamespaceTag(ns.Name().String()),
),
requestStartTime: startTime,
}
if r.HTTPRequest.Header != nil {
rCtx.originalHeaders = r.HTTPRequest.Header.Clone()
}
ctx = rCtx.augmentContext(ctx, r.HTTPRequest.Header)
defer rCtx.capturePanicAndRecordMetrics(&ctx, &retErr)
if r.HTTPRequest.URL.Path != commonnexus.PathCompletionCallbackNoIdentifier {
nsNameEscaped := commonnexus.RouteCompletionCallback.Deserialize(mux.Vars(r.HTTPRequest))
nsName, err := url.PathUnescape(nsNameEscaped)
if err != nil {
h.Logger.Error("failed to extract namespace from request", tag.Error(err))
h.preProcessErrorsCounter.Record(1)
return nexus.NewHandlerErrorf(nexus.HandlerErrorTypeBadRequest, "invalid URL")
}
if nsName != ns.Name().String() {
logger.Error(
"namespace ID in token doesn't match the token",
tag.WorkflowNamespaceID(ns.ID().String()),
tag.Error(err),
tag.String("completion-namespace-id", targetNamespaceID),
)
return nexus.NewHandlerErrorf(nexus.HandlerErrorTypeBadRequest, "invalid callback token")
}
}
if err := rCtx.interceptRequest(ctx, r); err != nil {
var notActiveErr *serviceerror.NamespaceNotActive
if errors.As(err, &notActiveErr) {
return h.forwardCompleteOperation(ctx, r, rCtx)
}
return err
}
tokenLimit := h.Config.MaxNexusOperationTokenLength(ns.Name().String())
if len(r.OperationToken) > tokenLimit {
return nexus.NewHandlerErrorf(nexus.HandlerErrorTypeBadRequest, "operation token length exceeds allowed limit (%d/%d)", len(r.OperationToken), tokenLimit)
}
var links []*commonpb.Link
for _, nexusLink := range r.Links {
switch nexusLink.Type {
case string((&commonpb.Link_WorkflowEvent{}).ProtoReflect().Descriptor().FullName()):
link, err := commonnexus.ConvertNexusLinkToLinkWorkflowEvent(nexusLink)
if err != nil {
// TODO(rodrigozhou): links are non-essential for the execution of the workflow,
// so ignoring the error for now; we will revisit how to handle these errors later.
h.Logger.Warn(
fmt.Sprintf("failed to parse link to %q: %s", nexusLink.Type, nexusLink.URL),
tag.Error(err),
)
continue
}
links = append(links, &commonpb.Link{
Variant: &commonpb.Link_WorkflowEvent_{
WorkflowEvent: link,
},
})
default:
// If the link data type is unsupported, just ignore it for now.
h.Logger.Warn(fmt.Sprintf("invalid link data type: %q", nexusLink.Type))
}
}
var successPayload *commonpb.Payload
switch r.State { // nolint:exhaustive
case nexus.OperationStateFailed, nexus.OperationStateCanceled:
// no validation needed
case nexus.OperationStateSucceeded:
var result *commonpb.Payload
if err := r.Result.Consume(&result); err != nil {
logger.Error("cannot deserialize payload from completion result", tag.Error(err))
return nexus.NewHandlerErrorf(nexus.HandlerErrorTypeBadRequest, "invalid result content")
}
if result.Size() > h.Config.BlobSizeLimitError(ns.Name().String()) {
logger.Error("payload size exceeds error limit for Nexus CompleteOperation request", tag.WorkflowNamespace(ns.Name().String()))
return nexus.NewHandlerErrorf(nexus.HandlerErrorTypeBadRequest, "result exceeds size limit")
}
successPayload = result
default:
// The Nexus SDK ensures this never happens but just in case...
logger.Error("invalid operation state in completion request", tag.String("state", string(r.State)))
return nexus.NewHandlerErrorf(nexus.HandlerErrorTypeBadRequest, "invalid completion state")
}
if len(completion.GetComponentRef()) > 0 {
err = h.completeChasmOperation(ctx, logger, completion, successPayload, r, links)
} else {
err = h.completeHSMOperation(ctx, completion, successPayload, r, links)
}
if err == nil {
return nil
}
logger.Error("failed to process nexus completion request", tag.Error(err))
var namespaceInactiveErr *serviceerror.NamespaceNotActive
if errors.As(err, &namespaceInactiveErr) {
return nexus.NewHandlerErrorf(nexus.HandlerErrorTypeUnavailable, "cluster inactive")
}
var notFoundErr *serviceerror.NotFound
if errors.As(err, &notFoundErr) {
return commonnexus.ConvertGRPCError(err, true)
}
return commonnexus.ConvertGRPCError(err, false)
}
func (h *nexusCompletionHandler) completeHSMOperation(
ctx context.Context,
completion *tokenspb.NexusOperationCompletion,
successPayload *commonpb.Payload,
req *nexusrpc.CompletionRequest,
links []*commonpb.Link,
) error {
hr := &historyservice.CompleteNexusOperationRequest{
Completion: completion,
State: string(req.State),
OperationToken: req.OperationToken,
StartTime: timestamppb.New(req.StartTime),
Links: links,
}
switch req.State { // nolint:exhaustive
case nexus.OperationStateFailed, nexus.OperationStateCanceled:
hr.Outcome = &historyservice.CompleteNexusOperationRequest_Failure{
Failure: commonnexus.NexusFailureToProtoFailure(*req.Error.OriginalFailure),
}
case nexus.OperationStateSucceeded:
hr.Outcome = &historyservice.CompleteNexusOperationRequest_Success{
Success: successPayload,
}
default:
// Should be unreachable as validated earlier.
return nexus.NewHandlerErrorf(nexus.HandlerErrorTypeBadRequest, "invalid completion state")
}
_, err := h.HistoryClient.CompleteNexusOperation(ctx, hr)
return err
}
func (h *nexusCompletionHandler) completeChasmOperation(
ctx context.Context,
logger log.Logger,
completion *tokenspb.NexusOperationCompletion,
successPayload *commonpb.Payload,
req *nexusrpc.CompletionRequest,
links []*commonpb.Link,
) error {
hr := &historyservice.CompleteNexusOperationChasmRequest{
Completion: &tokenspb.NexusOperationCompletion{
RequestId: completion.GetRequestId(),
ComponentRef: completion.GetComponentRef(),
},
Links: links,
OperationToken: req.OperationToken,
}
if !req.StartTime.IsZero() {
hr.StartTime = timestamppb.New(req.StartTime)
}
if !req.CloseTime.IsZero() {
hr.CloseTime = timestamppb.New(req.CloseTime)
}
switch req.State { // nolint:exhaustive
case nexus.OperationStateFailed, nexus.OperationStateCanceled:
failure, err := commonnexus.NexusFailureToTemporalFailure(*req.Error.OriginalFailure)
if err != nil {
logger.Error("cannot convert nexus failure from completion request", tag.Error(err))
return nexus.NewHandlerErrorf(nexus.HandlerErrorTypeBadRequest, "invalid failure content")
}
hr.Outcome = &historyservice.CompleteNexusOperationChasmRequest_Failure{
Failure: failure,
}
case nexus.OperationStateSucceeded:
hr.Outcome = &historyservice.CompleteNexusOperationChasmRequest_Success{
Success: successPayload,
}
default:
// Should be unreachable as validated earlier.
return nexus.NewHandlerErrorf(nexus.HandlerErrorTypeBadRequest, "invalid completion state")
}
_, err := h.HistoryClient.CompleteNexusOperationChasm(ctx, hr)
return err
}
func (h *nexusCompletionHandler) forwardCompleteOperation(ctx context.Context, r *nexusrpc.CompletionRequest, rCtx *requestContext) error {
targetCluster := rCtx.namespace.ActiveClusterName(namespace.RoutingKey{ID: rCtx.businessID})
client, err := h.ForwardingClients.Get(targetCluster)
if err != nil {
h.Logger.Error("unable to get HTTP client for forward request", tag.Operation(nexusCompletionAPIName), tag.WorkflowNamespace(rCtx.namespace.Name().String()), tag.Error(err), tag.SourceCluster(h.ClusterMetadata.GetCurrentClusterName()), tag.TargetCluster(targetCluster))
return nexus.NewHandlerErrorf(nexus.HandlerErrorTypeInternal, "internal error")
}
forwardURL, err := url.JoinPath(client.BaseURL(), commonnexus.RouteCompletionCallback.Path(rCtx.namespace.Name().String()))
if err != nil {
h.Logger.Error("failed to construct forwarding request URL", tag.Operation(nexusCompletionAPIName), tag.WorkflowNamespace(rCtx.namespace.Name().String()), tag.Error(err), tag.TargetCluster(targetCluster))
return nexus.NewHandlerErrorf(nexus.HandlerErrorTypeInternal, "internal error")
}
if h.HTTPTraceProvider != nil {
traceLogger := log.With(h.Logger,
tag.Operation(nexusCompletionAPIName),
tag.WorkflowNamespace(rCtx.namespace.Name().String()),
tag.AttemptStart(time.Now().UTC()),
tag.SourceCluster(h.ClusterMetadata.GetCurrentClusterName()),
tag.TargetCluster(targetCluster),
)
if trace := h.HTTPTraceProvider.NewForwardingTrace(traceLogger); trace != nil {
ctx = httptrace.WithClientTrace(ctx, trace)
}
}
var completion nexusrpc.CompleteOperationOptions
switch r.State {
case nexus.OperationStateSucceeded:
completion = nexusrpc.CompleteOperationOptions{
Result: r.Result.Reader,
OperationToken: r.OperationToken,
StartTime: r.StartTime,
CloseTime: r.CloseTime,
Links: r.Links,
}
case nexus.OperationStateFailed, nexus.OperationStateCanceled:
// For unsuccessful operations, the Nexus framework reads and closes the original request body to deserialize
// the failure, so we must construct a new completion to forward.
completion = nexusrpc.CompleteOperationOptions{
Error: r.Error,
OperationToken: r.OperationToken,
StartTime: r.StartTime,
CloseTime: r.CloseTime,
Links: r.Links,
}
default:
return nexus.NewHandlerErrorf(nexus.HandlerErrorTypeBadRequest, "invalid operation state: %q", r.State)
}
rCtx.originalHeaders.Set(interceptor.DCRedirectionApiHeaderName, "true")
cc := nexusrpc.NewCompletionHTTPClient(nexusrpc.CompletionHTTPClientOptions{
HTTPCaller: (&forwardingHTTPHeaderWrapper{
client: client,
originalRequestHeaders: rCtx.originalHeaders,
}).Do,
})
return cc.CompleteOperation(ctx, forwardURL, completion)
}
func (h *nexusCompletionHTTPHandler) RegisterRoutes(r *mux.Router) {
r.Path("/" + commonnexus.RouteCompletionCallback.Representation()).HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
r.Body = http.MaxBytesReader(w, r.Body, rpc.MaxNexusAPIRequestBodyBytes)
h.httpHandler.ServeHTTP(w, r)
})
r.Path(commonnexus.PathCompletionCallbackNoIdentifier).HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
r.Body = http.MaxBytesReader(w, r.Body, rpc.MaxNexusAPIRequestBodyBytes)
h.httpHandler.ServeHTTP(w, r)
})
}
type forwardingHTTPHeaderWrapper struct {
client *common.FrontendHTTPClient
originalRequestHeaders http.Header
}
func (f *forwardingHTTPHeaderWrapper) Do(req *http.Request) (*http.Response, error) {
// For forwarded requests, copy the original HTTP headers without sanitization.
for k, v := range f.originalRequestHeaders {
if req.Header.Get(k) == "" {
req.Header.Set(k, v[0])
}
}
return f.client.Do(req)
}
type requestContext struct {
*nexusCompletionHandler
logger log.Logger
metricsHandler metrics.Handler
metricsHandlerForInterceptors metrics.Handler
namespace *namespace.Namespace
businessID string
cleanupFunctions []func(error)
requestStartTime time.Time
outcomeTag metrics.Tag
forwarded bool
originalHeaders http.Header
}
func (c *requestContext) augmentContext(ctx context.Context, header http.Header) context.Context {
ctx = metrics.AddMetricsContext(ctx)
ctx = interceptor.AddTelemetryContext(ctx, c.metricsHandlerForInterceptors)
ctx = interceptor.PopulateCallerInfo(
ctx,
func() string { return c.namespace.Name().String() },
func() string { return nexusCompletionMethodNameForMetrics },
)
if userAgent := header.Get(headerUserAgent); userAgent != "" {
// Preserve original strict behavior: only process if exactly one delimiter present.
if strings.Count(userAgent, clientNameVersionDelim) == 1 {
parts := strings.SplitN(userAgent, clientNameVersionDelim, 2)
if len(parts) == 2 { // defensive
mdIncoming, ok := metadata.FromIncomingContext(ctx)
if !ok {
mdIncoming = metadata.MD{}
}
mdIncoming.Set(headers.ClientNameHeaderName, parts[0])
mdIncoming.Set(headers.ClientVersionHeaderName, parts[1])
ctx = metadata.NewIncomingContext(ctx, mdIncoming)
}
}
}
return headers.Propagate(ctx)
}
func (c *requestContext) capturePanicAndRecordMetrics(ctxPtr *context.Context, errPtr *error) {
recovered := recover() //nolint:revive
if recovered != nil {
err, ok := recovered.(error)
if !ok {
err = fmt.Errorf("panic: %v", recovered)
}
st := string(debug.Stack())
c.logger.Error("Panic captured", tag.SysStackTrace(st), tag.Error(err))
*errPtr = err
}
if *errPtr == nil {
if c.forwarded {
c.metricsHandler = c.metricsHandler.WithTags(metrics.OutcomeTag("request_forwarded"))
} else {
c.metricsHandler = c.metricsHandler.WithTags(metrics.OutcomeTag("success"))
}
} else if c.outcomeTag.Key != "" {
c.metricsHandler = c.metricsHandler.WithTags(c.outcomeTag)
} else {
var he *nexus.HandlerError
if errors.As(*errPtr, &he) {
c.metricsHandler = c.metricsHandler.WithTags(metrics.OutcomeTag("error_" + strings.ToLower(string(he.Type))))
} else {
c.metricsHandler = c.metricsHandler.WithTags(metrics.OutcomeTag("error_internal"))
}
}
// Record Nexus-specific metrics
c.metricsHandler.Counter(metrics.NexusCompletionRequests.Name()).Record(1)
c.metricsHandler.Histogram(metrics.NexusCompletionLatencyHistogram.Name(), metrics.Milliseconds).Record(time.Since(c.requestStartTime).Milliseconds())
// Record general telemetry metrics
metrics.ServiceRequests.With(c.metricsHandlerForInterceptors).Record(1)
c.TelemetryInterceptor.RecordLatencyMetrics(*ctxPtr, c.requestStartTime, c.metricsHandlerForInterceptors)
for _, fn := range c.cleanupFunctions {
fn(*errPtr)
}
}
// TODO(bergundy): Merge this with the interceptRequest method in nexus_handler.go.
func (c *requestContext) interceptRequest(ctx context.Context, request *nexusrpc.CompletionRequest) error {
var tlsInfo *credentials.TLSInfo
if request.HTTPRequest.TLS != nil {
tlsInfo = &credentials.TLSInfo{
State: *request.HTTPRequest.TLS,
CommonAuthInfo: credentials.CommonAuthInfo{SecurityLevel: credentials.PrivacyAndIntegrity},
}
}
authInfo := c.AuthInterceptor.GetAuthInfo(tlsInfo, request.HTTPRequest.Header, func() string {
return "" // TODO: support audience getter
})
var claims *authorization.Claims
var err error
if authInfo != nil {
claims, err = c.AuthInterceptor.GetClaims(authInfo)
if err != nil {
return err
}
// Make the auth info and claims available on the context.
ctx = c.AuthInterceptor.EnhanceContext(ctx, authInfo, claims)
}
_, err = c.AuthInterceptor.Authorize(ctx, claims, &authorization.CallTarget{
APIName: nexusCompletionAPIName,
Namespace: c.namespace.Name().String(),
Request: request,
})
if err != nil {
// If frontend.exposeAuthorizerErrors is false, Authorize err is either an explicitly set reason, or a generic
// "Request unauthorized." message.
// Otherwise, expose the underlying error.
var permissionDeniedError *serviceerror.PermissionDenied
if errors.As(err, &permissionDeniedError) {
c.outcomeTag = metrics.OutcomeTag("unauthorized")
return commonnexus.AdaptAuthorizeError(permissionDeniedError)
}
c.outcomeTag = metrics.OutcomeTag("internal_auth_error")
c.logger.Error("Authorization internal error with processing nexus callback", tag.Error(err))
return commonnexus.ConvertGRPCError(err, false)
}
if err := c.NamespaceValidationInterceptor.ValidateState(c.namespace, nexusCompletionAPIName, c.businessID); err != nil {
c.outcomeTag = metrics.OutcomeTag("invalid_namespace_state")
return commonnexus.ConvertGRPCError(err, false)
}
// Redirect if current cluster is passive for this namespace.
if c.namespace.ActiveClusterName(namespace.RoutingKey{ID: c.businessID}) != c.ClusterMetadata.GetCurrentClusterName() {
if c.shouldForwardRequest(ctx, request.HTTPRequest.Header, c.businessID) {
c.forwarded = true
handler, forwardStartTime := c.RedirectionInterceptor.BeforeCall(nexusCompletionMethodNameForMetrics)
c.cleanupFunctions = append(c.cleanupFunctions, func(retErr error) {
c.RedirectionInterceptor.AfterCall(handler, forwardStartTime, c.namespace.ActiveClusterName(namespace.RoutingKey{ID: c.businessID}), c.namespace.Name().String(), retErr)
})
// Handler methods should have special logic to forward requests if this method returns a serviceerror.NamespaceNotActive error.
return serviceerror.NewNamespaceNotActive(c.namespace.Name().String(), c.ClusterMetadata.GetCurrentClusterName(), c.namespace.ActiveClusterName(namespace.RoutingKey{ID: c.businessID}))
}
c.metricsHandler = c.metricsHandler.WithTags(metrics.OutcomeTag("namespace_inactive_forwarding_disabled"))
return nexus.NewHandlerErrorf(nexus.HandlerErrorTypeUnavailable, "cluster inactive")
}
c.cleanupFunctions = append(c.cleanupFunctions, func(retErr error) {
if retErr != nil {
c.RequestErrorHandler.HandleError(
request,
"",
c.metricsHandlerForInterceptors,
[]tag.Tag{tag.Operation(nexusCompletionMethodNameForMetrics), tag.WorkflowNamespace(c.namespace.Name().String())},
retErr,
c.namespace.Name(),
)
}
})
cleanup, err := c.NamespaceConcurrencyLimitInterceptor.Allow(c.namespace.Name(), nexusCompletionAPIName, c.metricsHandlerForInterceptors, request)
c.cleanupFunctions = append(c.cleanupFunctions, func(error) { cleanup() })
if err != nil {
c.outcomeTag = metrics.OutcomeTag("namespace_concurrency_limited")
return commonnexus.ConvertGRPCError(err, false)
}
if err := c.NamespaceRateLimitInterceptor.Allow(c.namespace.Name(), nexusCompletionAPIName, request.HTTPRequest.Header); err != nil {
c.outcomeTag = metrics.OutcomeTag("namespace_rate_limited")
return commonnexus.ConvertGRPCError(err, true)
}
if err := c.RateLimitInterceptor.Allow(nexusCompletionAPIName, request.HTTPRequest.Header); err != nil {
c.outcomeTag = metrics.OutcomeTag("global_rate_limited")
return commonnexus.ConvertGRPCError(err, true)
}
if err := c.clientVersionChecker.ClientSupported(ctx); err != nil {
c.outcomeTag = metrics.OutcomeTag("unsupported_client")
return commonnexus.ConvertGRPCError(err, true)
}
return nil
}
// TODO: copied from nexus_handler.go; should be combined with other intercept logic.
// Combines logic from RedirectionInterceptor.redirectionAllowed and some from
// SelectedAPIsForwardingRedirectionPolicy.getTargetClusterAndIsNamespaceNotActiveAutoForwarding so all
// redirection conditions can be checked at once. If either of those methods are updated, this should
// be kept in sync.
func (c *requestContext) shouldForwardRequest(ctx context.Context, header http.Header, businessID string) bool {
redirectHeader := header.Get(interceptor.DCRedirectionContextHeaderName)
redirectAllowed, err := strconv.ParseBool(redirectHeader)
if err != nil {
redirectAllowed = true
}
return redirectAllowed &&
c.RedirectionInterceptor.RedirectionAllowed(ctx) &&
c.namespace.IsGlobalNamespace() &&
c.Config.EnableNamespaceNotActiveAutoForwarding(c.namespace.Name().String())
}