mirror of
https://github.com/hanzoai/tasks.git
synced 2026-10-04 02:04:03 +00:00
64794044a3
## What changed? <!-- Describe what has changed in this PR --> Add an interceptor for frontend service. Interceptor will looks at error messages and replace unknown/internal messages to a common message ## Why? <!-- Tell your future self why have you made these changes --> We are exposing/can expose to much of the internal details/customer info in errors. Instead external error will be a simple message, and real error will be logged. ## How did you test it? <!-- How have you verified this change? Tested locally? Added a unit test? Checked in staging env? --> Add unit test. Build/run tests ## Potential risks <!-- Assuming the worst case, what can be broken when deploying this change to production? --> N/A ## Documentation <!-- Have you made sure this change doesn't falsify anything currently stated in `docs/`? If significant new behavior is added, have you described that in `docs/`? --> N/A ## Is hotfix candidate? <!-- Is this PR a hotfix candidate or does it require a notification to be sent to the broader community? (Yes/No) --> No --------- Co-authored-by: Yichao Yang <[email protected]>
95 lines
3.0 KiB
Go
95 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"
|
|
|
|
"google.golang.org/grpc"
|
|
"google.golang.org/grpc/codes"
|
|
"google.golang.org/grpc/status"
|
|
|
|
"go.temporal.io/server/common"
|
|
"go.temporal.io/server/common/dynamicconfig"
|
|
"go.temporal.io/server/common/namespace"
|
|
)
|
|
|
|
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()
|
|
}
|