Files
tasks/tools/tdbg/task_queue_commands.go
Michael SnowdenandGitHub 5a7b66b4a6 Get rid of tdbg.cFactory global variable (#4896)
<!-- Describe what has changed in this PR -->
**What changed?**
I got rid of the `cFactory` global variable in the `tdbg` package in
favor of a parameter to the `NewCliApp` method. I also refactored the
DLQ client to re-use some of its flag variables to keep the code a bit
more DRY.

<!-- Tell your future self why have you made these changes -->
**Why?**
I need to override this variable in a unit test, and I don't want to do
it globally because that would mean that the tests can't run in
parallel.

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


<!-- 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?**
2023-10-09 15:48:30 -07:00

108 lines
3.2 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 tdbg
import (
"fmt"
"github.com/urfave/cli/v2"
enumspb "go.temporal.io/api/enums/v1"
"go.temporal.io/server/api/adminservice/v1"
)
// AdminListTaskQueueTasks displays task information
func AdminListTaskQueueTasks(c *cli.Context, clientFactory ClientFactory) error {
namespace, err := getRequiredOption(c, FlagNamespace)
if err != nil {
return err
}
tqName := c.String(FlagTaskQueue)
tlTypeInt, err := StringToEnum(c.String(FlagTaskQueueType), enumspb.TaskQueueType_value)
if err != nil {
return fmt.Errorf("invalid task queue type: %v", err)
}
tqType := enumspb.TaskQueueType(tlTypeInt)
if tqType == enumspb.TASK_QUEUE_TYPE_UNSPECIFIED {
return fmt.Errorf("missing Task Queue type")
}
minTaskID := c.Int64(FlagMinTaskID)
maxTaskID := c.Int64(FlagMaxTaskID)
pageSize := defaultPageSize
if c.IsSet(FlagPageSize) {
pageSize = c.Int(FlagPageSize)
}
workflowID := c.String(FlagWorkflowID)
runID := c.String(FlagRunID)
client := clientFactory.AdminClient(c)
req := &adminservice.GetTaskQueueTasksRequest{
Namespace: namespace,
TaskQueue: tqName,
TaskQueueType: tqType,
MinTaskId: minTaskID,
MaxTaskId: maxTaskID,
BatchSize: int32(pageSize),
}
ctx, cancel := newContext(c)
defer cancel()
paginationFunc := func(paginationToken []byte) ([]interface{}, []byte, error) {
req.NextPageToken = paginationToken
response, err := client.GetTaskQueueTasks(ctx, req)
if err != nil {
return nil, nil, err
}
tasks := response.Tasks
if workflowID != "" {
filteredTasks := tasks[:0]
for _, task := range tasks {
if task.Data.WorkflowId != workflowID {
continue
}
if runID != "" && task.Data.RunId != runID {
continue
}
filteredTasks = append(filteredTasks, task)
}
tasks = filteredTasks
}
var items []interface{}
for _, task := range tasks {
items = append(items, task)
}
return items, nil, nil
}
if err := paginate(c, paginationFunc, pageSize); err != nil {
return fmt.Errorf("unable to list Task Queue Tasks: %v", err)
}
return nil
}