-
Notifications
You must be signed in to change notification settings - Fork 177
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
Add RPC v2 support #2544
Draft
david-perez
wants to merge
57
commits into
main
Choose a base branch
from
smithy-rpc-v2
base: main
Could not load branches
Branch not found: {{ refName }}
Could not load tags
Nothing to show
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Add RPC v2 support #2544
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
RPC v2 is a new protocol that is being added to the Smithy specification.
…nt-type-in-all-protocols
…nt-type-in-all-protocols
… 9cde04f31a96a37b49c4f88a91d87aae44efecbd`, compile
…itted for a double / float.
…an output defined.
3 tasks
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.
RPC v2 is a new protocol that
is being addedhas recently been added to the Smithyspecification.
(I'll add more details here as the patchset evolves)
Credit goes to @jjant for initial implementation of the router, which I built on top of from his
jjant/smithy-rpc-v2-exploration
branch.Caveats
TODO
s are currently exhaustively sprinkled throughout the patch documenting what remains to be done. Most of these need to be addressed before this can be merged in; some can be punted on to not make this PR bigger.However, I'd like to call out the major caveats and blockers here. I'll keep updating this list as the patchset evolves.
smithy-rpc-v2
branch. The following are prerrequisites for this PR to be merged; until they are done CI on this PR will fail:serde
to round-trip messages and compareserde
's encoders and decoders with ours for correctness.smithy-protocol-tests
directory in Smithy.[ ] Smithydocument
shapes are not supported. RPC v2's specification currently doesn't indicate how to implement them.Prerequisite PRs
This section lists prerequisite PRs and issues that would make the diff for this one lighter or easier to understand. It's preferable that these PRs be merged prior to this one; some are hard prerequisites. They mostly relate to parts of the codebase I've had to touch or
pilferinspect in this PR where I've made necessary changes, refactors and "drive-by improvements" that are mostly unrelated, although some directly unlock things I've needed in this patchset. It makes sense to pull them out to ease reviewability and make this patch more semantically self-contained.ignoreUnsupportedConstraintTraits
from integration test models #2516RuntimeError
andRequestRejection
by protocol #2517aws_smithy_types::primitive::Parse
in the server #2528Protocol
sstructuredDataParser
,structuredDataSerializer
#2536RestRequestSpecGenerator
intocodegen-server
#2537Content-Type
header in all server protocols #2531#[allow(unused_variables)]
in JSON serializers when structure has no members #2538ignoreUnsupportedConstraintTraits
has no effect #2539Testing
RPC v2 has still not been added to the Smithy specification. It is currently being worked on over in the
smithy-rpc-v2
branch.This can only be tested locally following these steps:
1. Clone the Smithy repository and checkout thesmithy-rpc-v2
branch.2. Inside your local checkout of smithy-rs pointing to this PR's branch, make sure you've added
mavenLocal()
as a repository in thebuild.gradle.kts
files. Example.4. Inside your local checkout of Smithy's
smithy-rpc-v2
branch:1. Set
VERSION
to the current Smithy version used in smithy-rs (1.28.1 as of writing, but check here).2. Run
./gradlew clean build pTML
.6.1. In your local checkout of the smithy-rs'ssmithy-rpc-v2
branch, run./gradlew codegen-server-test:build -P modules='rpcv2'
.You can troubleshoot whether you have Smithy correctly set up locally by inspecting~/.m2/repository/software/amazon/smithy/smithy-protocols-traits
.Checklist
CHANGELOG.next.toml
if I made changes to the smithy-rs codegen or runtime cratesBy submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.