Skip to content

Commit 3f76376

Browse files
authored
Fix protobuf syntax that is causing an error in protobufjs (#589)
**What changed?** - Fix a double semicolon introduced in #579. **Why?** - The double semicolon sequence is causing a compilation error in `protobufjs`, even though this is technically valid according to [the official Protobuf 3 spec](https://protobuf.dev/reference/protobuf/proto3-spec/#emptystatement). This is a bug in `protobufjs`, for which there's been [an open issue ticket](protobufjs/protobuf.js#1322) since 2019, but it was never acknowledged, and a PR fixing this has been ignored for more than a year. Given that there's simply no reason to use a double semicolon sequence anyway, it appears preferable to simply avoid that in our proto definitions.
1 parent ec8d4ef commit 3f76376

File tree

3 files changed

+9
-7
lines changed

3 files changed

+9
-7
lines changed

openapi/openapiv2.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15407,7 +15407,7 @@
1540715407
},
1540815408
"header": {
1540915409
"$ref": "#/definitions/v1Header",
15410-
"description": "Headers that were passed by the sender of the signal and copied by temporal \nserver into the workflow task."
15410+
"description": "Headers that were passed by the sender of the signal and copied by temporal\nserver into the workflow task."
1541115411
},
1541215412
"skipGenerateWorkflowTask": {
1541315413
"type": "boolean",

openapi/openapiv3.yaml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12911,7 +12911,9 @@ components:
1291112911
header:
1291212912
allOf:
1291312913
- $ref: '#/components/schemas/Header'
12914-
description: "Headers that were passed by the sender of the signal and copied by temporal \n server into the workflow task."
12914+
description: |-
12915+
Headers that were passed by the sender of the signal and copied by temporal
12916+
server into the workflow task.
1291512917
skipGenerateWorkflowTask:
1291612918
type: boolean
1291712919
description: This field is deprecated and never respected. It should always be set to false.

temporal/api/history/v1/message.proto

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ message WorkflowExecutionStartedEventAttributes {
3535
// Contains information about parent workflow execution that initiated the child workflow these attributes belong to.
3636
// If the workflow these attributes belong to is not a child workflow of any other execution, this field will not be populated.
3737
temporal.api.common.v1.WorkflowExecution parent_workflow_execution = 3;
38-
// EventID of the child execution initiated event in parent workflow
38+
// EventID of the child execution initiated event in parent workflow
3939
int64 parent_initiated_event_id = 4;
4040
temporal.api.taskqueue.v1.TaskQueue task_queue = 5;
4141
// SDK will deserialize this and provide it as arguments to the workflow function
@@ -440,7 +440,7 @@ message ActivityTaskCanceledEventAttributes {
440440
string identity = 5;
441441
// Version info of the worker who processed this workflow task.
442442
// Deprecated. This field should be cleaned up when versioning-2 API is removed. [cleanup-experimental-wv]
443-
temporal.api.common.v1.WorkerVersionStamp worker_version = 6 [deprecated = true];;
443+
temporal.api.common.v1.WorkerVersionStamp worker_version = 6 [deprecated = true];
444444
}
445445

446446
message TimerStartedEventAttributes {
@@ -475,8 +475,8 @@ message TimerCanceledEventAttributes {
475475

476476
message WorkflowExecutionCancelRequestedEventAttributes {
477477
// User provided reason for requesting cancellation
478-
// TODO: shall we create a new field with name "reason" and deprecate this one?
479-
string cause = 1;
478+
// TODO: shall we create a new field with name "reason" and deprecate this one?
479+
string cause = 1;
480480
// TODO: Is this the ID of the event in the workflow which initiated this cancel, if there was one?
481481
int64 external_initiated_event_id = 2;
482482
temporal.api.common.v1.WorkflowExecution external_workflow_execution = 3;
@@ -509,7 +509,7 @@ message WorkflowExecutionSignaledEventAttributes {
509509
temporal.api.common.v1.Payloads input = 2;
510510
// id of the worker/client who sent this signal
511511
string identity = 3;
512-
// Headers that were passed by the sender of the signal and copied by temporal
512+
// Headers that were passed by the sender of the signal and copied by temporal
513513
// server into the workflow task.
514514
temporal.api.common.v1.Header header = 4;
515515
// This field is deprecated and never respected. It should always be set to false.

0 commit comments

Comments
 (0)