Skip to content

Commit bc69dcd

Browse files
Reserve Field Tag 7 in PollWorkflowTaskQueueRequest and PollActivityTaskQueueRequest (#712)
_**READ BEFORE MERGING:** All PRs require approval by both Server AND SDK teams before merging! This is why the number of required approvals is "2" and not "1"--two reviewers from the same team is NOT sufficient. If your PR is not approved by someone in BOTH teams, it may be summarily reverted._ <!-- Describe what has changed in this PR --> **What changed?** - reserve field tag 7 in temporal.api.workflowservice.v1.PollWorkflowTaskQueueRequest and temporal.api.workflowservice.v1.PollActivityTaskQueueRequest. - Move worker_instance_key to tag 8 in those messages. - Add buf ignore to allow the name worker_instance_key to be retagged. <!-- Tell your future self why have you made these changes --> **Why?** This addresses a wire incompatibility between APIs version 1.50-1.54 and 1.62. Field tag 7 was [removed from these messages in API version 1.55](v1.54.0...v1.55.0). <!-- Are there any breaking changes on binary or code level? --> **Breaking changes** <!-- If this breaks the Server, please provide the Server PR to merge right after this PR was merged. --> **Server PR**
1 parent f66d869 commit bc69dcd

2 files changed

Lines changed: 12 additions & 2 deletions

File tree

buf.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ breaking:
1616
- temporal/api/enums/v1/failed_cause.proto
1717
# TODO: remove this once the changes with WorkflowExecutionExtendedInfo.pause_info is merged
1818
- temporal/api/workflow/v1/message.proto
19+
# TODO (amazzeo): remove this once worker_instance_key has successfully been retagged in PollWorkflowTaskQueueRequest and PollActivityTaskQueueRequest
20+
- temporal/api/workflowservice/v1/request_response.proto
1921
lint:
2022
use:
2123
- DEFAULT

temporal/api/workflowservice/v1/request_response.proto

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -261,7 +261,7 @@ message PollWorkflowTaskQueueRequest {
261261
string identity = 3;
262262
// A unique key for this worker instance, used for tracking worker lifecycle.
263263
// This is guaranteed to be unique, whereas identity is not guaranteed to be unique.
264-
string worker_instance_key = 7;
264+
string worker_instance_key = 8;
265265
// Deprecated. Use deployment_options instead.
266266
// Each worker process should provide an ID unique to the specific set of code it is running
267267
// "checksum" in this field name isn't very accurate, it should be though of as an id.
@@ -273,6 +273,10 @@ message PollWorkflowTaskQueueRequest {
273273
// Worker deployment options that user has set in the worker.
274274
// Experimental. Worker Deployments are experimental and might significantly change in the future.
275275
temporal.api.deployment.v1.WorkerDeploymentOptions deployment_options = 6;
276+
277+
// Removed in 1.55.0; was temporal.api.worker.v1.WorkerHeartbeat worker_heartbeat
278+
reserved 7;
279+
reserved "worker_heartbeat";
276280
}
277281

278282
message PollWorkflowTaskQueueResponse {
@@ -439,14 +443,18 @@ message PollActivityTaskQueueRequest {
439443
string identity = 3;
440444
// A unique key for this worker instance, used for tracking worker lifecycle.
441445
// This is guaranteed to be unique, whereas identity is not guaranteed to be unique.
442-
string worker_instance_key = 7;
446+
string worker_instance_key = 8;
443447
temporal.api.taskqueue.v1.TaskQueueMetadata task_queue_metadata = 4;
444448
// Information about this worker's build identifier and if it is choosing to use the versioning
445449
// feature. See the `WorkerVersionCapabilities` docstring for more.
446450
// Deprecated. Replaced by deployment_options.
447451
temporal.api.common.v1.WorkerVersionCapabilities worker_version_capabilities = 5 [deprecated = true];
448452
// Worker deployment options that user has set in the worker.
449453
temporal.api.deployment.v1.WorkerDeploymentOptions deployment_options = 6;
454+
455+
// Removed in 1.55.0; was temporal.api.worker.v1.WorkerHeartbeat worker_heartbeat
456+
reserved 7;
457+
reserved "worker_heartbeat";
450458
}
451459

452460
message PollActivityTaskQueueResponse {

0 commit comments

Comments
 (0)