Allow JSONProtoPayloadConverter to accept ignore_unknown_fields as an optional argument
#365
Conversation
This file contains 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
|
|
cretz
reviewed
Aug 8, 2023
temporalio/converter.py
Outdated
| @@ -388,6 +388,16 @@ def from_payload( | |||
| class JSONProtoPayloadConverter(EncodingPayloadConverter): | |||
| """Converter for 'json/protobuf' payloads supporting protobuf Message values.""" | |||
|
|
|||
| def __init__(self, ignore_unknown_fields: Optional[bool] = False): | |||
There was a problem hiding this comment.
Suggested change
| def __init__(self, ignore_unknown_fields: Optional[bool] = False): | |
| def __init__(self, ignore_unknown_fields: bool = False): |
(can run poe lint-types to confirm types or just poe lint to confirm all is well in general)
There was a problem hiding this comment.
Thank you!
william-almy-skydio
force-pushed
the
main
branch
from
fd3bb1b
to
84d51ce
Compare
william-almy-skydio
force-pushed
the
main
branch
from
84d51ce
to
032f07c
Compare
cretz
approved these changes
Aug 16, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 was changed
This commit enables the
JSONProtoPayloadConverterto acceptignore_unknown_fieldsas an optional argument so that we can utilize this functionality when converting proto to json.Why?
When deploying multiple services out-of-sync with Temporal, proto fields may change in a way that would not necessarily cause the workflow to fail, however without setting the
ignore_unknown_fieldsoption above, otherwise backwards-compatible proto changes result in conversion errors. As mentioned in the linked issue below, "People may want to ignore unknown fields and right now they have to remake the class themselves"Checklist
Closes [Feature Request] Support constructing JSONProtoPayloadConverter with google.protobuf.json_format.Parse options #315
How was this tested: