Files
tasks/tools/tdbg/task_queue_commands.go
Stephan BehnkeandDavid Reiss 8ee1f49318 tdbg for list fairness tasks (#8010)
## What changed?
Added new flag to tdbg's `list-tasks` command to query the fairness
table instead.

## Why?
Allow operation on fairness table, too.

## How did you test it?
- [ ] built
- [x] run locally and tested manually
- [ ] covered by existing tests
- [ ] added new unit test(s)
- [ ] added new functional test(s)

```
./tdbg taskqueue list-tasks --task-queue-type TASK_QUEUE_TYPE_WORKFLOW --task-queue test --min-pass 1
```

It's late ... I didn't manage to see a result, though. But it didn't
fail and I saw the query being executed in the debugger.
2025-07-22 16:38:22 +01:00

252 lines
6.6 KiB
Go

package tdbg
import (
"errors"
"fmt"
"github.com/urfave/cli/v2"
enumspb "go.temporal.io/api/enums/v1"
taskqueuepb "go.temporal.io/api/taskqueue/v1"
"go.temporal.io/server/api/adminservice/v1"
taskqueuespb "go.temporal.io/server/api/taskqueue/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 := c.Int(FlagPageSize)
workflowID := c.String(FlagWorkflowID)
runID := c.String(FlagRunID)
subqueue := c.Int(FlagSubqueue)
var minPass int64
if c.Bool(FlagFair) {
minPass = c.Int64(FlagMinPass)
} else if c.IsSet(FlagMinPass) {
return fmt.Errorf("flag --%s is only valid with --%s", FlagMinPass, FlagFair)
}
client := clientFactory.AdminClient(c)
req := &adminservice.GetTaskQueueTasksRequest{
Namespace: namespace,
TaskQueue: tqName,
TaskQueueType: tqType,
MinTaskId: minTaskID,
MaxTaskId: maxTaskID,
BatchSize: int32(pageSize),
Subqueue: int32(subqueue),
MinPass: minPass,
}
paginationFunc := func(paginationToken []byte) ([]interface{}, []byte, error) {
ctx, cancel := newContext(c)
defer cancel()
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, response.NextPageToken, nil
}
if err := paginate(c, paginationFunc, pageSize); err != nil {
return fmt.Errorf("unable to list Task Queue Tasks: %v", err)
}
return nil
}
// AdminDescribeTaskQueuePartition displays task queue partition information
func AdminDescribeTaskQueuePartition(c *cli.Context, clientFactory ClientFactory) error {
// extracting the namespace
namespace, err := getRequiredOption(c, FlagNamespace)
if err != nil {
return err
}
// extracting the task queue name
tqName, err := getRequiredOption(c, FlagTaskQueue)
if err != nil {
return err
}
// extracting the task queue type
tqTypeString, err := getRequiredOption(c, FlagTaskQueueType)
if err != nil {
return err
}
tlTypeInt, err := StringToEnum(tqTypeString, enumspb.TaskQueueType_value)
if err != nil {
return fmt.Errorf("invalid task queue type: %w", err)
}
tqType := enumspb.TaskQueueType(tlTypeInt)
if tqType == enumspb.TASK_QUEUE_TYPE_UNSPECIFIED {
return errors.New("invalid task queue type") // nolint
}
// extracting the task queue partition id
partitionID := 0
if c.IsSet(FlagPartitionID) {
partitionID = c.Int(FlagPartitionID)
}
// extracting the task queue partition sticky name
stickyName := ""
if c.IsSet(FlagStickyName) {
stickyName = c.String(FlagStickyName)
}
// extracting the task queue partition buildId's
buildIDs := make([]string, 0)
if c.IsSet(FlagBuildIDs) {
buildIDs = c.StringSlice(FlagBuildIDs)
}
// extracting the unversioned flag
unversioned := true
if c.IsSet(FlagUnversioned) {
unversioned = c.Bool(FlagUnversioned)
}
// extracting the allActive flag
allActive := true
if c.IsSet(FlagAllActive) {
allActive = c.Bool(FlagAllActive)
}
tqPartition := &taskqueuespb.TaskQueuePartition{
TaskQueue: tqName,
TaskQueueType: tqType,
}
if stickyName != "" {
tqPartition.PartitionId = &taskqueuespb.TaskQueuePartition_StickyName{StickyName: stickyName}
} else {
tqPartition.PartitionId = &taskqueuespb.TaskQueuePartition_NormalPartitionId{NormalPartitionId: int32(partitionID)}
}
client := clientFactory.AdminClient(c)
req := &adminservice.DescribeTaskQueuePartitionRequest{
Namespace: namespace,
TaskQueuePartition: tqPartition,
BuildIds: &taskqueuepb.TaskQueueVersionSelection{
BuildIds: buildIDs,
Unversioned: unversioned,
AllActive: allActive,
},
}
ctx, cancel := newContext(c)
defer cancel()
if response, e := client.DescribeTaskQueuePartition(ctx, req); e != nil {
return fmt.Errorf("unable to describe Task Queue Partition: %w", e)
} else {
prettyPrintJSONObject(c, response)
}
return nil
}
// AdminForceUnloadTaskQueuePartition forcefully unloads a task queue partition
func AdminForceUnloadTaskQueuePartition(c *cli.Context, clientFactory ClientFactory) error {
// extracting the namespace
namespace, err := getRequiredOption(c, FlagNamespace)
if err != nil {
return err
}
// extracting the task queue name
tqName, err := getRequiredOption(c, FlagTaskQueue)
if err != nil {
return err
}
// extracting the task queue type
tqTypeString, err := getRequiredOption(c, FlagTaskQueueType)
if err != nil {
return err
}
tlTypeInt, err := StringToEnum(tqTypeString, enumspb.TaskQueueType_value)
if err != nil {
return fmt.Errorf("invalid task queue type: %w", err)
}
tqType := enumspb.TaskQueueType(tlTypeInt)
if tqType == enumspb.TASK_QUEUE_TYPE_UNSPECIFIED {
return errors.New("invalid task queue type") // nolint
}
// extracting the task queue partition id
partitionID := 0
if c.IsSet(FlagPartitionID) {
partitionID = c.Int(FlagPartitionID)
}
// extracting the task queue partition sticky name
stickyName := ""
if c.IsSet(FlagStickyName) {
stickyName = c.String(FlagStickyName)
}
tqPartition := &taskqueuespb.TaskQueuePartition{
TaskQueue: tqName,
TaskQueueType: tqType,
}
if stickyName != "" {
tqPartition.PartitionId = &taskqueuespb.TaskQueuePartition_StickyName{StickyName: stickyName}
} else {
tqPartition.PartitionId = &taskqueuespb.TaskQueuePartition_NormalPartitionId{NormalPartitionId: int32(partitionID)}
}
client := clientFactory.AdminClient(c)
req := &adminservice.ForceUnloadTaskQueuePartitionRequest{
Namespace: namespace,
TaskQueuePartition: tqPartition,
}
ctx, cancel := newContext(c)
defer cancel()
if response, e := client.ForceUnloadTaskQueuePartition(ctx, req); e != nil {
return fmt.Errorf("unable to describe Task Queue Partition: %w", e)
} else {
prettyPrintJSONObject(c, response)
}
return nil
}