Files
tasks/common/rpc/interceptor/mask_internal_error.go
Jacob BarzeeandGitHub 06171037f0 Import alignment (#6426)
## What changed?
Make import formatting a part of the build, and test validity with
"ensure-no-changes" target

## Why?
So we never discuss import order again (hopefully)

## How did you test it?
its a build change, so the build will test it!

## Potential risks
As long as build works, the only thing I risk is the ire of coworker who
want imports to be different ;)

## Documentation
N/A

## Is hotfix candidate?
No
2024-08-23 14:48:10 -06:00

93 lines
3.0 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 interceptor
import (
"context"
"fmt"
"go.temporal.io/api/serviceerror"
"go.temporal.io/server/common"
"go.temporal.io/server/common/dynamicconfig"
"go.temporal.io/server/common/namespace"
"google.golang.org/grpc"
"google.golang.org/grpc/codes"
"google.golang.org/grpc/status"
)
var errorFrontendMasked = "something went wrong, please retry"
type MaskInternalErrorDetailsInterceptor struct {
maskInternalError dynamicconfig.BoolPropertyFnWithNamespaceFilter
namespaceRegistry namespace.Registry
}
func NewMaskInternalErrorDetailsInterceptor(
maskErrorSetting dynamicconfig.BoolPropertyFnWithNamespaceFilter,
namespaceRegistry namespace.Registry,
) *MaskInternalErrorDetailsInterceptor {
return &MaskInternalErrorDetailsInterceptor{
maskInternalError: maskErrorSetting,
namespaceRegistry: namespaceRegistry,
}
}
func (i *MaskInternalErrorDetailsInterceptor) Intercept(
ctx context.Context,
req interface{},
_ *grpc.UnaryServerInfo,
handler grpc.UnaryHandler,
) (interface{}, error) {
resp, err := handler(ctx, req)
if err != nil && i.shouldMaskErrors(req) {
err = maskUnknownOrInternalErrors(err)
}
return resp, err
}
func (i *MaskInternalErrorDetailsInterceptor) shouldMaskErrors(req any) bool {
ns := MustGetNamespaceName(i.namespaceRegistry, req)
if ns.IsEmpty() {
return false
}
return i.maskInternalError(ns.String())
}
func maskUnknownOrInternalErrors(err error) error {
st := serviceerror.ToStatus(err)
if st.Code() != codes.Unknown && st.Code() != codes.Internal {
return err
}
// convert internal and unknown errors into neutral error with hash code of the original error
errorHash := common.ErrorHash(err)
maskedErrorMessage := fmt.Sprintf("%s (%s)", errorFrontendMasked, errorHash)
return status.New(st.Code(), maskedErrorMessage).Err()
}