Protobuf support #1455
Merged
Protobuf support #1455
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
kubukoz
reviewed
Apr 4, 2024
kubukoz
reviewed
Apr 4, 2024
|
Looks good UX-wise. Do we have a plan to support full-blown gRPC as well? |
Not at this point. It'd be really easy to do with http4s-grpc (which is still reasonably young) or with the official grpc lib (which is java only), but I don't currently want to a assume the maintenance of a gRPC module in open-source. So it's left as an exercise to the user 😄 |
|
I call dibs on the blogpost then. @velvetbaldmime don't you dare 🤣 |
kubukoz
reviewed
Apr 5, 2024
modules/protobuf/src/main/scala/smithy4s/protobuf/ProtobufCodec.scala
Outdated
Show resolved
Hide resolved
modules/protobuf/src/main/scala/smithy4s/protobuf/internals/TaggedCodec.scala
Outdated
Show resolved
Hide resolved
modules/protobuf/src/main/scala/smithy4s/protobuf/internals/TaggedCodecSchemaVisitor.scala
Outdated
Show resolved
Hide resolved
Add test to ensure that decoding an unset value into a required field in protobuf is recovered. We could make it throw, in the future.
Changed the logic to ensure that decoding protobuf message fields that are required fails if the field was unset. Also change the ProtobufReadError model to make it an ADT
kubukoz
approved these changes
Apr 15, 2024
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.
This adds a
smithy4s-protobufmodule, which provides support for protobuf serialisation following the alloy semantics.The module depends on the official
protobuf-javalibrary, which provides low-level primitives for parsing protobuf from raw bytes. On scala-js/scala-native, the module depends onprotobuf-runtime-scala, a pure-scala implementation ofprotobuf-javaprovided by the awesome ScalaPB library.The implementation is tested against ScalaPB. The tests involve a conversion from smithy to the proto IDL, performed by means of smithy-translate.
Additionally, this PR adds a documentation page, summarising various serialisation constructs provided by smithy4s out-of-the-box (including Document/JSON/XML/Protobuf). This documentation is by no mean exhaustive but should be helpful to users.
PR Checklist (not all items are relevant to all PRs)