Skip to content

New matching RPC: Check if version exists in TaskQueue #8772

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Shivs11 merged 8 commits into from
Dec 11, 2025
Merged

New matching RPC: Check if version exists in TaskQueue #8772

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
77b8aa8
add RPC, add tests
Shivs11 Dec 8, 2025
b1cf752
make check better
Shivs11 Dec 8, 2025
9fed5c5
change proto to have string instead of task queue
Shivs11 Dec 10, 2025
99fedcf
use existing helper
Shivs11 Dec 10, 2025
f6d5147
Merge branch 'main' into ss/matching-rpc-task-queue-in-version
Shivs11 Dec 10, 2025
85ea320
Merge branch 'main' into ss/matching-rpc-task-queue-in-version
Shivs11 Dec 11, 2025
15f5080
add api in unit-test so that it does not fail
Shivs11 Dec 11, 2025
ff2ea79
Merge branch 'main' into ss/matching-rpc-task-queue-in-version
Shivs11 Dec 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
74 changes: 74 additions & 0 deletions api/matchingservice/v1/request_response.go-helpers.pb.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

697 changes: 411 additions & 286 deletions api/matchingservice/v1/request_response.pb.go
View file
Open in desktop

Large diffs are not rendered by default.

161 changes: 83 additions & 78 deletions api/matchingservice/v1/service.pb.go
View file
Open in desktop

Large diffs are not rendered by default.

39 changes: 39 additions & 0 deletions api/matchingservice/v1/service_grpc.pb.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

35 changes: 35 additions & 0 deletions api/matchingservicemock/v1/service_grpc.pb.mock.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

20 changes: 20 additions & 0 deletions client/matching/client_gen.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

14 changes: 14 additions & 0 deletions client/matching/metric_client_gen.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

15 changes: 15 additions & 0 deletions client/matching/retryable_client_gen.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 4 additions & 0 deletions common/rpc/interceptor/logtags/matching_service_server_gen.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

23 changes: 11 additions & 12 deletions common/worker_versioning/worker_versioning.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ import (
deploymentpb "go.temporal.io/api/deployment/v1"
enumspb "go.temporal.io/api/enums/v1"
"go.temporal.io/api/serviceerror"
taskqueuepb "go.temporal.io/api/taskqueue/v1"
workflowpb "go.temporal.io/api/workflow/v1"
deploymentspb "go.temporal.io/server/api/deployment/v1"
"go.temporal.io/server/api/matchingservice/v1"
Expand Down Expand Up @@ -265,21 +266,19 @@ func GetIsWFTaskQueueInVersionDetector(matchingClient resource.MatchingClient) I
return func(ctx context.Context,
namespaceID, tq string,
version *deploymentpb.WorkerDeploymentVersion) (bool, error) {
resp, err := matchingClient.GetTaskQueueUserData(ctx,
&matchingservice.GetTaskQueueUserDataRequest{
NamespaceId: namespaceID,
TaskQueue: tq,
TaskQueueType: enumspb.TASK_QUEUE_TYPE_WORKFLOW,
})
resp, err := matchingClient.CheckTaskQueueVersionMembership(ctx, &matchingservice.CheckTaskQueueVersionMembershipRequest{
NamespaceId: namespaceID,
TaskQueue: &taskqueuepb.TaskQueue{Name: tq, Kind: enumspb.TASK_QUEUE_KIND_NORMAL},
TaskQueueType: enumspb.TASK_QUEUE_TYPE_WORKFLOW,
Version: &deploymentspb.WorkerDeploymentVersion{
DeploymentName: version.GetDeploymentName(),
BuildId: version.GetBuildId(),
},
})
if err != nil {
return false, err
}
tqData, ok := resp.GetUserData().GetData().GetPerType()[int32(enumspb.TASK_QUEUE_TYPE_WORKFLOW)]
if !ok {
// The TQ is unversioned
return false, nil
}
return HasDeploymentVersion(tqData.GetDeploymentData(), DeploymentVersionFromDeployment(DeploymentFromExternalDeploymentVersion(version))), nil
return resp.GetIsMember(), nil
}
}

Expand Down
11 changes: 11 additions & 0 deletions proto/internal/temporal/server/api/matchingservice/v1/request_response.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -641,3 +641,14 @@ message DescribeWorkerRequest {
message DescribeWorkerResponse {
temporal.api.worker.v1.WorkerInfo worker_info = 1;
}

message CheckTaskQueueVersionMembershipRequest {
string namespace_id = 1;
temporal.api.taskqueue.v1.TaskQueue task_queue = 2;
Copy link
Contributor

@ShahabT ShahabT Dec 9, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we're trying to move away from this proto as much as possible because it mixes multiple levels of TQs. In this case the API is only relevant to normal TQs, so just a string field is enough.

temporal.api.enums.v1.TaskQueueType task_queue_type = 3;
Copy link
Member Author

@Shivs11 Shivs11 Dec 8, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Technically, we don't need this (right now) since all the version presence checks for a task queue go through the workflow task queue type. However, I just wanted to be consistent with other matching API's since those that accept task-queue also accept the type. Moreover, we could have a future use-case of involving the activity task queue type of a task queue.

temporal.server.api.deployment.v1.WorkerDeploymentVersion version = 4;
}

message CheckTaskQueueVersionMembershipResponse {
bool is_member = 1;
}
3 changes: 3 additions & 0 deletions proto/internal/temporal/server/api/matchingservice/v1/service.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -190,5 +190,8 @@ service MatchingService {
// Returns an error if the namespace or worker doesn't exist.
rpc DescribeWorker (DescribeWorkerRequest) returns (DescribeWorkerResponse) {}

// CheckTaskQueueVersionMembership checks if a task queue is part of a specific deployment version.
rpc CheckTaskQueueVersionMembership(CheckTaskQueueVersionMembershipRequest) returns (CheckTaskQueueVersionMembershipResponse) {}

}

8 changes: 8 additions & 0 deletions service/matching/handler.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -475,6 +475,14 @@ func (h *Handler) CheckTaskQueueUserDataPropagation(
return h.engine.CheckTaskQueueUserDataPropagation(ctx, request)
}

func (h *Handler) CheckTaskQueueVersionMembership(
ctx context.Context,
request *matchingservice.CheckTaskQueueVersionMembershipRequest,
) (_ *matchingservice.CheckTaskQueueVersionMembershipResponse, retError error) {
defer log.CapturePanic(h.logger, &retError)
return h.engine.CheckTaskQueueVersionMembership(ctx, request)
}

func (h *Handler) DispatchNexusTask(ctx context.Context, request *matchingservice.DispatchNexusTaskRequest) (_ *matchingservice.DispatchNexusTaskResponse, retError error) {
defer log.CapturePanic(h.logger, &retError)
return h.engine.DispatchNexusTask(ctx, request)
Expand Down
Loading
Loading