Skip to content

Commit

Permalink
Support for wrapped errors in matchings error handler (#6263)
Browse files Browse the repository at this point in the history
What changed?

Added test for handleErr
Added support for wrapped errors in handleErr
Why?
Some errors are not recognized correctly because they are wrapped, with the introduction of wrapped errors in go we should never check the type directly

How did you test it?
Unit test

Potential risks

Release notes

Documentation Changes
  • Loading branch information
jakobht authored Sep 3, 2024
1 parent 3f1f3a6 commit 05852ef
Show file tree
Hide file tree
Showing 2 changed files with 143 additions and 13 deletions.
27 changes: 14 additions & 13 deletions service/matching/handler/context.go
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ package handler

import (
"context"
"errors"
"sync"

"github.com/uber/cadence/common"
Expand Down Expand Up @@ -66,42 +67,42 @@ func (reqCtx *handlerContext) handleErr(err error) error {
return nil
}

switch err.(type) {
case *types.InternalServiceError:
switch {
case errors.As(err, new(*types.InternalServiceError)):
reqCtx.scope.IncCounter(metrics.CadenceFailuresPerTaskList)
reqCtx.logger.Error("Internal service error", tag.Error(err))
return err
case *types.BadRequestError:
case errors.As(err, new(*types.BadRequestError)):
reqCtx.scope.IncCounter(metrics.CadenceErrBadRequestPerTaskListCounter)
return err
case *types.EntityNotExistsError:
case errors.As(err, new(*types.EntityNotExistsError)):
reqCtx.scope.IncCounter(metrics.CadenceErrEntityNotExistsPerTaskListCounter)
return err
case *types.WorkflowExecutionAlreadyStartedError:
case errors.As(err, new(*types.WorkflowExecutionAlreadyStartedError)):
reqCtx.scope.IncCounter(metrics.CadenceErrExecutionAlreadyStartedPerTaskListCounter)
return err
case *types.DomainAlreadyExistsError:
case errors.As(err, new(*types.DomainAlreadyExistsError)):
reqCtx.scope.IncCounter(metrics.CadenceErrDomainAlreadyExistsPerTaskListCounter)
return err
case *types.QueryFailedError:
case errors.As(err, new(*types.QueryFailedError)):
reqCtx.scope.IncCounter(metrics.CadenceErrQueryFailedPerTaskListCounter)
return err
case *types.LimitExceededError:
case errors.As(err, new(*types.LimitExceededError)):
reqCtx.scope.IncCounter(metrics.CadenceErrLimitExceededPerTaskListCounter)
return err
case *types.ServiceBusyError:
case errors.As(err, new(*types.ServiceBusyError)):
reqCtx.scope.IncCounter(metrics.CadenceErrServiceBusyPerTaskListCounter)
return err
case *types.DomainNotActiveError:
case errors.As(err, new(*types.DomainNotActiveError)):
reqCtx.scope.IncCounter(metrics.CadenceErrDomainNotActivePerTaskListCounter)
return err
case *types.RemoteSyncMatchedError:
case errors.As(err, new(*types.RemoteSyncMatchedError)):
reqCtx.scope.IncCounter(metrics.CadenceErrRemoteSyncMatchFailedPerTaskListCounter)
return err
case *types.StickyWorkerUnavailableError:
case errors.As(err, new(*types.StickyWorkerUnavailableError)):
reqCtx.scope.IncCounter(metrics.CadenceErrStickyWorkerUnavailablePerTaskListCounter)
return err
case *cadence_errors.TaskListNotOwnedByHostError:
case errors.As(err, new(*cadence_errors.TaskListNotOwnedByHostError)):
reqCtx.scope.IncCounter(metrics.CadenceErrTaskListNotOwnedByHostPerTaskListCounter)
return err
default:
Expand Down
129 changes: 129 additions & 0 deletions service/matching/handler/context_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,129 @@
// The MIT License (MIT)

// Copyright (c) 2017-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 handler

import (
"fmt"
"testing"

"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"

cadence_errors "github.com/uber/cadence/common/errors"
"github.com/uber/cadence/common/log"
"github.com/uber/cadence/common/metrics"
"github.com/uber/cadence/common/types"
)

func TestHandleErrNil(t *testing.T) {
reqCtx := &handlerContext{
scope: metrics.NoopScope(metrics.Matching),
logger: log.NewNoop(),
}

err := reqCtx.handleErr(nil)
assert.NoError(t, err)
}

func TestHandleErrKnowErrors(t *testing.T) {
testCases := []struct {
name string
err error
wantErr error
}{
{
name: "InternalServiceError",
err: &types.InternalServiceError{},
},
{
name: "BadRequestError",
err: &types.BadRequestError{},
},
{
name: "EntityNotExistsError",
err: &types.EntityNotExistsError{},
},
{
name: "WorkflowExecutionAlreadyStartedError",
err: &types.WorkflowExecutionAlreadyStartedError{},
},
{
name: "DomainAlreadyExistsError",
err: &types.DomainAlreadyExistsError{},
},
{
name: "QueryFailedError",
err: &types.QueryFailedError{},
},
{
name: "LimitExceededError",
err: &types.LimitExceededError{},
},
{
name: "ServiceBusyError",
err: &types.ServiceBusyError{},
},
{
name: "DomainNotActiveError",
err: &types.DomainNotActiveError{},
},
{
name: "RemoteSyncMatchedError",
err: &types.RemoteSyncMatchedError{},
},
{
name: "StickyWorkerUnavailableError",
err: &types.StickyWorkerUnavailableError{},
},
{
name: "TaskListNotOwnedByHostError",
err: &cadence_errors.TaskListNotOwnedByHostError{},
},
}

for _, tc := range testCases {
reqCtx := &handlerContext{
scope: metrics.NoopScope(metrics.Matching),
logger: log.NewNoop(),
}

t.Run(tc.name, func(t *testing.T) {
handledErr := reqCtx.handleErr(tc.err)
require.Equal(t, tc.err, handledErr)

wrappedErr := fmt.Errorf("wrapped: %w", tc.err)
wrappedHandledErr := reqCtx.handleErr(wrappedErr)
require.Equal(t, wrappedErr, wrappedHandledErr)
})
}
}

func TestHandleErrUncategorizedError(t *testing.T) {
reqCtx := &handlerContext{
scope: metrics.NoopScope(metrics.Matching),
logger: log.NewNoop(),
}

err := reqCtx.handleErr(assert.AnError)
assert.ErrorAs(t, err, new(*types.InternalServiceError))
}

0 comments on commit 05852ef

Please sign in to comment.