Skip to content

Commit

Permalink
Add context deadline exceeded error to deep health check aggregator (#…
Browse files Browse the repository at this point in the history
…7038)

## What changed?
<!-- Describe what has changed in this PR -->

## Why?
Context deadline exceeded should be treated as unhealthy any time it is
emitted.

## How did you test it?
<!-- How have you verified this change? Tested locally? Added a unit
test? Checked in staging env? -->

## Potential risks
<!-- Assuming the worst case, what can be broken when deploying this
change to production? -->

## 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/`? -->

## Is hotfix candidate?
<!-- Is this PR a hotfix candidate or does it require a notification to
be sent to the broader community? (Yes/No) -->
  • Loading branch information
laniehei authored Dec 30, 2024
1 parent 480a0f5 commit 2d8afd4
Show file tree
Hide file tree
Showing 2 changed files with 87 additions and 3 deletions.
7 changes: 4 additions & 3 deletions common/persistence/health_signal_aggregator.go
Original file line number Diff line number Diff line change
Expand Up @@ -189,13 +189,14 @@ func isUnhealthyError(err error) bool {
if common.IsContextCanceledErr(err) {
return true
}
if common.IsContextDeadlineExceededErr(err) {
return true
}

switch err.(type) {
case *AppendHistoryTimeoutError,
*TimeoutError:
return true

default:
return false
}
return false
}
83 changes: 83 additions & 0 deletions common/persistence/health_signal_aggregator_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
// 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 persistence

import (
"testing"

"go.temporal.io/api/serviceerror"
)

func Test_isUnhealthyError(t *testing.T) {
type args struct {
err error
}
tests := []struct {
name string
args args
want bool
}{
{
name: "nil error",
args: args{err: nil},
want: false,
},
{
name: "context canceled error",
args: args{err: &serviceerror.Canceled{
Message: "context canceled",
}},
want: true,
},
{
name: "context deadline exceeded error",
args: args{err: &serviceerror.DeadlineExceeded{
Message: "context deadline exceeded",
}},
want: true,
},
{
name: "AppendHistoryTimeoutError",
args: args{err: &AppendHistoryTimeoutError{
Msg: "append history timeout",
}},
want: true,
},
{
name: "InvalidPersistenceRequestError",
args: args{err: &InvalidPersistenceRequestError{
Msg: "invalid persistence request",
}},
want: false,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
if got := isUnhealthyError(tt.args.err); got != tt.want {
t.Errorf("isUnhealthyError() = %v, want %v", got, tt.want)
}
})
}
}

0 comments on commit 2d8afd4

Please sign in to comment.