-
Notifications
You must be signed in to change notification settings - Fork 107
Adds ProtoJSON support for protobuf inputs #192
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.
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
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| require 'temporal/json' | ||
|
|
||
| module Temporal | ||
| module Connection | ||
| module Converter | ||
| module Payload | ||
| class ProtoJSON | ||
| ENCODING = 'json/protobuf'.freeze | ||
|
|
||
| def encoding | ||
| ENCODING | ||
| end | ||
|
|
||
| def from_payload(payload) | ||
| # TODO: Add error handling. | ||
| message_type = payload.metadata['messageType'] | ||
| descriptor = Google::Protobuf::DescriptorPool.generated_pool.lookup(message_type) | ||
| descriptor.msgclass.decode_json(payload.data) | ||
| end | ||
|
|
||
| def to_payload(data) | ||
| return unless data.is_a?(Google::Protobuf::MessageExts) | ||
| Temporal::Api::Common::V1::Payload.new( | ||
| metadata: { | ||
| 'encoding' => ENCODING, | ||
| 'messageType' => data.class.descriptor.name, | ||
| }, | ||
| data: data.to_json, | ||
| ) | ||
| end | ||
| end | ||
| end | ||
| end | ||
| end | ||
| end |
25 changes: 25 additions & 0 deletions
25
spec/unit/lib/temporal/connection/converter/payload/proto_json_spec.rb
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| require 'temporal/connection/converter/payload/proto_json' | ||
|
|
||
| describe Temporal::Connection::Converter::Payload::ProtoJSON do | ||
| subject { described_class.new } | ||
|
|
||
| describe 'round trip' do | ||
| it 'converts' do | ||
| # Temporal::Api::Common::V1::Payload is a protobuf. | ||
| # Using it as the "input" here to show the roundtrip. | ||
| # #to_payload will return a wrapped Payload around this one. | ||
| input = Temporal::Api::Common::V1::Payload.new( | ||
| metadata: { 'hello' => 'world' }, | ||
| data: 'hello world', | ||
| ) | ||
|
|
||
| expect(subject.from_payload(subject.to_payload(input))).to eq(input) | ||
| end | ||
| end | ||
|
|
||
| it 'skips if not proto message' do | ||
| input = { hello: 'world' } | ||
|
|
||
| expect(subject.to_payload(input)).to be nil | ||
| end | ||
| end | ||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This data type won't get picked by the target converter, right? It's not a subclass of
Google::Protobuf::MessageExtsThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
added comment. using
Temporal::Api::Common::V1::Payloadas the input given it's an available proto message.to_payloadwraps it, so the resultdatais the json'dinputw/ the metadataThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah, I see, makes sense. It might be a bit clearer if you were to pick a proto that has nothing to do with payloads. But the comment solves this issue