Unverified Commit c63e7924 authored Jul 17, 2024 by david-perez Committed by GitHub Jul 17, 2024

Add server RPC v2 CBOR support (#2544)

RPC v2 CBOR is a new protocol that ~is being added~ has [recently been
added](https://smithy.io/2.0/additional-specs/protocols/smithy-rpc-v2.html)
to the Smithy
specification.

_(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`](https://github.com/awslabs/smithy-rs/tree/jjant/smithy-rpc-v2-exploration)
branch.

Tracking issue: https://github.com/smithy-lang/smithy-rs/issues/3573.

## 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.

- [x] RPC v2 has still not been added to the Smithy specification. It is
currently being worked on over in the
[`smithy-rpc-v2`](https://github.com/awslabs/smithy/tree/smithy-rpc-v2)
branch. The following are prerrequisites for this PR to be merged;
**until they are done CI on this PR will fail**:
    - [x] Smithy merges in RPC v2 support.
    - [x] Smithy releases a new version incorporating RPC v2 support.
- Released in [Smithy
v1.47](https://github.com/smithy-lang/smithy/releases/tag/1.47.0)
    - [x] smithy-rs updates to the new version.
        - Updated in https://github.com/smithy-lang/smithy-rs/pull/3552
- [x] ~Protocol tests for the protocol do not currently exist in Smithy.
Until those get written~, this PR resorts to Rust unit tests and
integration tests that use `serde` to round-trip messages and compare
`serde`'s encoders and decoders with ours for correctness.
- Protocol tests are under the
[`smithy-protocol-tests`](https://github.com/smithy-lang/smithy/tree/main/smithy-protocol-tests/model/rpcv2Cbor)
directory in Smithy.
- We're keeping the `serde_cbor` round-trip tests for defense in depth.
- [ ] https://github.com/smithy-lang/smithy-rs/issues/3709 - Currently
only server-side support has been implemented, because that's what I'm
most familiar. However, we're almost all the way there to add
client-side support.
- ~[ ] [Smithy `document`
shapes](https://smithy.io/2.0/spec/simple-types.html#document) are not
supported. RPC v2's specification currently doesn't indicate how to
implement them.~
- [The
spec](https://smithy.io/2.0/additional-specs/protocols/smithy-rpc-v2.html#shape-serialization)
ended up leaving them as unsupported: "Document types are not currently
supported in this protocol."

## 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 ~pilfer~
inspect 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.

- https://github.com/awslabs/smithy-rs/pull/2516
- https://github.com/awslabs/smithy-rs/pull/2517
- https://github.com/awslabs/smithy-rs/pull/2522
- https://github.com/awslabs/smithy-rs/pull/2524
- https://github.com/awslabs/smithy-rs/pull/2528
- https://github.com/awslabs/smithy-rs/pull/2536
- https://github.com/awslabs/smithy-rs/pull/2537
- https://github.com/awslabs/smithy-rs/pull/2531
- https://github.com/awslabs/smithy-rs/pull/2538
- https://github.com/awslabs/smithy-rs/pull/2539
- https://github.com/awslabs/smithy-rs/pull/2542
- https://github.com/smithy-lang/smithy-rs/pull/3684
- https://github.com/smithy-lang/smithy-rs/pull/3678
- https://github.com/smithy-lang/smithy-rs/pull/3690
- https://github.com/smithy-lang/smithy-rs/pull/3713
- https://github.com/smithy-lang/smithy-rs/pull/3726
- https://github.com/smithy-lang/smithy-rs/pull/3752

## Testing
<!--- Please describe in detail how you tested your changes -->
<!--- Include details of your testing environment, and the tests you ran
to -->
<!--- see how your change affects other areas of the code, etc. -->

~RPC v2 has still not been added to the Smithy specification. It is
currently being worked on over in the
[`smithy-rpc-v2`](https://github.com/awslabs/smithy/tree/smithy-rpc-v2)
branch.~

This can only be tested _locally_ following these steps:

~1. Clone [the Smithy
repository](https://github.com/smithy-lang/smithy/tree/smithy-rpc-v2)
and checkout the `smithy-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 the
`build.gradle.kts` files.
[Example](https://github.com/smithy-lang/smithy-rs/pull/2544/commits/8df82fd3fc92434ea4f4ffb10b02df2da458624c).
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](https://github.com/awslabs/smithy-rs/blob/main/gradle.properties#L21)).
    2. Run `./gradlew clean build pTML`.~
~6.~ 1. In your local checkout of the smithy-rs's `smithy-rpc-v2`
branch, run `./gradlew codegen-server-test:build -P
modules='rpcv2Cbor'`.

~You can troubleshoot whether you have Smithy correctly set up locally
by inspecting
`~/.m2/repository/software/amazon/smithy/smithy-protocols-traits`.~

## Checklist
<!--- If a checkbox below is not applicable, then please DELETE it
rather than leaving it unchecked -->
- [ ] I have updated `CHANGELOG.next.toml` if I made changes to the
smithy-rs codegen or runtime crates

----

_By submitting this pull request, I confirm that you can use, modify,
copy, and redistribute this contribution, under the terms of your
choice._

parent e4ced339

.cargo-deny-config.toml

+3 −0

Original line number	Diff line number	Diff line
		@@ -25,6 +25,9 @@ exceptions = [
		{ allow = ["OpenSSL"], name = "ring", version = "*" },
		{ allow = ["OpenSSL"], name = "aws-lc-sys", version = "*" },
		{ allow = ["OpenSSL"], name = "aws-lc-fips-sys", version = "*" },
		{ allow = ["BlueOak-1.0.0"], name = "minicbor", version = "<=0.24.2" },
		# Safe to bump as long as license does not change -------------^
		# See D105255799.
		]

		[[licenses.clarify]]

buildSrc/src/main/kotlin/CodegenTestCommon.kt

+77 −2

Original line number	Diff line number	Diff line
		@@ -26,7 +26,82 @@ fun generateImports(imports: List<String>): String =
		if (imports.isEmpty()) {
		""
		} else {
		"\"imports\": [${imports.map { "\"$it\"" }.joinToString(", ")}],"
		"\"imports\": [${imports.joinToString(", ") { "\"$it\"" }}],"
		}

		val RustKeywords =
		setOf(
		"as",
		"break",
		"const",
		"continue",
		"crate",
		"else",
		"enum",
		"extern",
		"false",
		"fn",
		"for",
		"if",
		"impl",
		"in",
		"let",
		"loop",
		"match",
		"mod",
		"move",
		"mut",
		"pub",
		"ref",
		"return",
		"self",
		"Self",
		"static",
		"struct",
		"super",
		"trait",
		"true",
		"type",
		"unsafe",
		"use",
		"where",
		"while",
		"async",
		"await",
		"dyn",
		"abstract",
		"become",
		"box",
		"do",
		"final",
		"macro",
		"override",
		"priv",
		"typeof",
		"unsized",
		"virtual",
		"yield",
		"try",
		)

		fun toRustCrateName(input: String): String {
		if (input.isBlank()) {
		throw IllegalArgumentException("Rust crate name cannot be empty")
		}
		val lowerCased = input.lowercase()
		// Replace any sequence of characters that are not lowercase letters, numbers, dashes, or underscores with a single underscore.
		val sanitized = lowerCased.replace(Regex("[^a-z0-9_-]+"), "_")
		// Trim leading or trailing underscores.
		val trimmed = sanitized.trim('_')
		// Check if the resulting string is empty, purely numeric, or a reserved name
		val finalName =
		when {
		trimmed.isEmpty() -> throw IllegalArgumentException("Rust crate name after sanitizing cannot be empty.")
		trimmed.matches(Regex("\\d+")) -> "n$trimmed" // Prepend 'n' if the name is purely numeric.
		trimmed in RustKeywords -> "${trimmed}_" // Append an underscore if the name is reserved.
		else -> trimmed
		}
		return finalName
		}

		private fun generateSmithyBuild(
		@@ -48,7 +123,7 @@ private fun generateSmithyBuild(
		${it.extraCodegenConfig ?: ""}
		},
		"service": "${it.service}",
		"module": "${it.module}",
		"module": "${toRustCrateName(it.module)}",
		"moduleVersion": "0.0.1",
		"moduleDescription": "test",
		"moduleAuthors": ["protocoltest@example.com"]

buildSrc/src/main/kotlin/CrateSet.kt

+1 −0

Original line number	Diff line number	Diff line
		@@ -56,6 +56,7 @@ object CrateSet {
		val SMITHY_RUNTIME_COMMON =
		listOf(
		"aws-smithy-async",
		"aws-smithy-cbor",
		"aws-smithy-checksums",
		"aws-smithy-compression",
		"aws-smithy-client",

codegen-client/build.gradle.kts

+2 −1

Original line number	Diff line number	Diff line
		@@ -27,6 +27,7 @@ dependencies {
		implementation("software.amazon.smithy:smithy-protocol-test-traits:$smithyVersion")
		implementation("software.amazon.smithy:smithy-waiters:$smithyVersion")
		implementation("software.amazon.smithy:smithy-rules-engine:$smithyVersion")
		implementation("software.amazon.smithy:smithy-protocol-traits:$smithyVersion")

		// `smithy.framework#ValidationException` is defined here, which is used in event stream
		// marshalling/unmarshalling tests.

codegen-client/src/main/kotlin/software/amazon/smithy/rust/codegen/client/smithy/customize/ClientCodegenDecorator.kt

+0 −17

Original line number	Diff line number	Diff line
		@@ -19,7 +19,6 @@ import software.amazon.smithy.rust.codegen.client.smithy.generators.error.ErrorC
		import software.amazon.smithy.rust.codegen.core.rustlang.Writable
		import software.amazon.smithy.rust.codegen.core.smithy.customize.CombinedCoreCodegenDecorator
		import software.amazon.smithy.rust.codegen.core.smithy.customize.CoreCodegenDecorator
		import software.amazon.smithy.rust.codegen.core.smithy.generators.protocol.ProtocolTestGenerator
		import software.amazon.smithy.rust.codegen.core.smithy.protocols.ProtocolMap
		import java.util.ServiceLoader
		import java.util.logging.Logger
		@@ -93,14 +92,6 @@ interface ClientCodegenDecorator : CoreCodegenDecorator<ClientCodegenContext, Cl
		codegenContext: ClientCodegenContext,
		baseCustomizations: List<ServiceRuntimePluginCustomization>,
		): List<ServiceRuntimePluginCustomization> = baseCustomizations

		/**
		* Hook to override the protocol test generator
		*/
		fun protocolTestGenerator(
		codegenContext: ClientCodegenContext,
		baseGenerator: ProtocolTestGenerator,
		): ProtocolTestGenerator = baseGenerator
		}

		/**
		@@ -176,14 +167,6 @@ open class CombinedClientCodegenDecorator(decorators: List<ClientCodegenDecorato
		decorator.serviceRuntimePluginCustomizations(codegenContext, customizations)
		}

		override fun protocolTestGenerator(
		codegenContext: ClientCodegenContext,
		baseGenerator: ProtocolTestGenerator,
		): ProtocolTestGenerator =
		combineCustomizations(baseGenerator) { decorator, gen ->
		decorator.protocolTestGenerator(codegenContext, gen)
		}

		companion object {
		fun fromClasspath(
		context: PluginContext,