mirror of
https://github.com/hanzoai/tasks.git
synced 2026-10-04 02:04:03 +00:00
Michael SnowdenandGitHub
116bcbb5bc
<!-- Describe what has changed in this PR --> **What changed?** 1. I added a task category registry and plumbed it through our dependency graph, removing the global methods like `GetCategoryByID` and `NewCategory`. 2. I also changed the signature to use an `int` instead of an `int32` for the category ID <!-- Tell your future self why have you made these changes --> **Why?** 1. To make it easier to add dynamic task categories without relying on init side effects calling `NewCategory`. Basically, the general rationale for why to avoid global state. However, in addition, I'll soon need a dynamic task category decoder registry for the DLQ. This isn't strictly a prerequisite, but I figured I'd fix it while I'm doing this. 2. To avoid proliferation of the int32 type. The fact that the proto field type of the TaskCategory enum is an int32 is an implementation detail, and it should only be needed when we're converting to/from protos. <!-- How have you verified this change? Tested locally? Added a unit test? Checked in staging env? --> **How did you test it?** The existing `server_test.go` verifies that the fx graph builds. I also ensured that the conditional archival task category registration still has unit tests. <!-- Assuming the worst case, what can be broken when deploying this change to production? --> **Potential risks** <!-- Is this PR a hotfix candidate or require that a notification be sent to the broader community? (Yes/No) --> **Is hotfix candidate?**
113 lines
3.4 KiB
Go
113 lines
3.4 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 getdlqtasks_test
|
|
|
|
import (
|
|
"context"
|
|
"errors"
|
|
"testing"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/require"
|
|
"go.temporal.io/api/serviceerror"
|
|
|
|
commonspb "go.temporal.io/server/api/common/v1"
|
|
"go.temporal.io/server/api/historyservice/v1"
|
|
"go.temporal.io/server/common/persistence"
|
|
"go.temporal.io/server/service/history/api/getdlqtasks"
|
|
"go.temporal.io/server/service/history/consts"
|
|
"go.temporal.io/server/service/history/tasks"
|
|
)
|
|
|
|
// failingHistoryTaskQueueManager is a [persistence.HistoryTaskQueueManager] that always fails.
|
|
type failingHistoryTaskQueueManager struct {
|
|
persistence.HistoryTaskQueueManager
|
|
}
|
|
|
|
func TestInvoke_InvalidTaskCategory(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
_, err := getdlqtasks.Invoke(context.Background(),
|
|
nil,
|
|
tasks.NewDefaultTaskCategoryRegistry(),
|
|
&historyservice.GetDLQTasksRequest{
|
|
DlqKey: &commonspb.HistoryDLQKey{
|
|
TaskCategory: -1,
|
|
},
|
|
})
|
|
|
|
var invalidArgErr *serviceerror.InvalidArgument
|
|
|
|
require.ErrorAs(t, err, &invalidArgErr)
|
|
assert.ErrorContains(t, invalidArgErr, "Invalid task category")
|
|
assert.ErrorContains(t, invalidArgErr, "-1")
|
|
}
|
|
|
|
func TestInvoke_ZeroPageSize(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
_, err := getdlqtasks.Invoke(
|
|
context.Background(),
|
|
new(persistence.HistoryTaskQueueManagerImpl),
|
|
tasks.NewDefaultTaskCategoryRegistry(),
|
|
&historyservice.GetDLQTasksRequest{
|
|
DlqKey: &commonspb.HistoryDLQKey{
|
|
TaskCategory: int32(tasks.CategoryTransfer.ID()),
|
|
},
|
|
PageSize: 0,
|
|
},
|
|
)
|
|
|
|
assert.ErrorIs(t, err, consts.ErrInvalidPageSize)
|
|
}
|
|
|
|
func TestInvoke_UnavailableError(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
_, err := getdlqtasks.Invoke(
|
|
context.Background(),
|
|
failingHistoryTaskQueueManager{},
|
|
tasks.NewDefaultTaskCategoryRegistry(),
|
|
&historyservice.GetDLQTasksRequest{
|
|
DlqKey: &commonspb.HistoryDLQKey{
|
|
TaskCategory: int32(tasks.CategoryTransfer.ID()),
|
|
},
|
|
PageSize: 0,
|
|
},
|
|
)
|
|
|
|
var unavailableErr *serviceerror.Unavailable
|
|
|
|
require.ErrorAs(t, err, &unavailableErr)
|
|
assert.ErrorContains(t, unavailableErr, "some random error")
|
|
}
|
|
|
|
func (m failingHistoryTaskQueueManager) ReadRawTasks(
|
|
context.Context,
|
|
*persistence.ReadRawTasksRequest,
|
|
) (*persistence.ReadRawTasksResponse, error) {
|
|
return nil, errors.New("some random error")
|
|
}
|