Files
38ad2f41ac Return Unavailable to frontend rpcs until healthy (#5069)
**What changed?**
Add an interceptor to return Unavailable to WorkflowService methods
until the frontend considers itself "healthy", which currently means
"membership is initialized".

**Why?**
Fixes #5015 

**How did you test it?**
mostly manually

**Potential risks**
This adds a window of time where frontend can now return Unavailable
where previously it might have succeeded or returned a different error
code. Specifically note that client.Dial in go sdk (at least) will fail
fast on this error and the caller will need to retry.

---------

Co-authored-by: Tim Deeb-Swihart <[email protected]>
2023-12-12 12:43:43 -08:00

72 lines
2.3 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"
"strings"
"sync/atomic"
"go.temporal.io/api/serviceerror"
"google.golang.org/grpc"
"go.temporal.io/server/common/api"
)
type (
HealthInterceptor struct {
healthy atomic.Bool
}
)
var _ grpc.UnaryServerInterceptor = (*HealthInterceptor)(nil).Intercept
var notHealthyErr = serviceerror.NewUnavailable("Frontend is not healthy yet")
// NewHealthInterceptor returns a new HealthInterceptor. It starts with state not healthy.
func NewHealthInterceptor() *HealthInterceptor {
return &HealthInterceptor{}
}
func (i *HealthInterceptor) Intercept(
ctx context.Context,
req interface{},
info *grpc.UnaryServerInfo,
handler grpc.UnaryHandler,
) (interface{}, error) {
// only enforce health check on WorkflowService and OperatorService
if strings.HasPrefix(info.FullMethod, api.WorkflowServicePrefix) ||
strings.HasPrefix(info.FullMethod, api.OperatorServicePrefix) {
if !i.healthy.Load() {
return nil, notHealthyErr
}
}
return handler(ctx, req)
}
func (i *HealthInterceptor) SetHealthy(healthy bool) {
i.healthy.Store(healthy)
}