Fix protobuf syntax that is causing an error in protobufjs#589
Merged
Fix protobuf syntax that is causing an error in protobufjs#589
Conversation
| string identity = 5; | ||
| // Version info of the worker who processed this workflow task. | ||
| // Deprecated. This field should be cleaned up when versioning-2 API is removed. [cleanup-experimental-wv] | ||
| temporal.api.common.v1.WorkerVersionStamp worker_version = 6 [deprecated = true];; |
Contributor
There was a problem hiding this comment.
Can we add some CI step to prevent this in the future?
Contributor
Author
There was a problem hiding this comment.
It is technically possible, but since this is technically valid according to the spec and the official protoc tool, detecting that would require adding protobufjs to this repository, or to do some specifically tailored checks (e.g. grep ';;' on all .proto files, which might trigger false-positives). That would most likely incurs more maintenance hassle than what it would save us.
So after discussion with the team, we agreed to not automate this check.
Quinn-With-Two-Ns
approved these changes
May 14, 2025
mjameswh
changed the title
carlydf
approved these changes
May 14, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changed?
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.This is a bug in
protobufjs, for which there's been an open issue ticket 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.