feat: support default checksums #1191
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,66 @@ | ||
| package software.amazon.smithy.kotlin.codegen.rendering.checksums | ||
|
|
||
| import software.amazon.smithy.aws.traits.HttpChecksumTrait | ||
| import software.amazon.smithy.kotlin.codegen.KotlinSettings | ||
| import software.amazon.smithy.kotlin.codegen.core.KotlinWriter | ||
| import software.amazon.smithy.kotlin.codegen.core.RuntimeTypes | ||
| import software.amazon.smithy.kotlin.codegen.integration.KotlinIntegration | ||
| import software.amazon.smithy.kotlin.codegen.model.hasTrait | ||
| import software.amazon.smithy.kotlin.codegen.rendering.protocol.ProtocolGenerator | ||
| import software.amazon.smithy.kotlin.codegen.rendering.protocol.ProtocolMiddleware | ||
| import software.amazon.smithy.model.Model | ||
| import software.amazon.smithy.model.shapes.OperationShape | ||
| import software.amazon.smithy.model.traits.HttpChecksumRequiredTrait | ||
|
|
||
| /** | ||
| * Handles the `httpChecksumRequired` trait. | ||
| * See: https://smithy.io/2.0/spec/http-bindings.html#httpchecksumrequired-trait | ||
| */ | ||
| class HttpChecksumRequiredIntegration : KotlinIntegration { | ||
| override fun enabledForService(model: Model, settings: KotlinSettings): Boolean = | ||
| model.isTraitApplied(HttpChecksumRequiredTrait::class.java) | ||
|
|
||
| override fun customizeMiddleware( | ||
| ctx: ProtocolGenerator.GenerationContext, | ||
| resolved: List<ProtocolMiddleware>, | ||
| ): List<ProtocolMiddleware> = resolved + httpChecksumRequiredDefaultAlgorithmMiddleware + httpChecksumRequiredMiddleware | ||
| } | ||
|
|
||
| /** | ||
| * Adds default checksum algorithm to the execution context | ||
| */ | ||
| private val httpChecksumRequiredDefaultAlgorithmMiddleware = object : ProtocolMiddleware { | ||
| override val name: String = "httpChecksumRequiredDefaultAlgorithmMiddleware" | ||
| override val order: Byte = -2 // Before S3 Express (possibly) changes the default (-1) and before calculating checksum (0) | ||
|
|
||
| override fun isEnabledFor(ctx: ProtocolGenerator.GenerationContext, op: OperationShape): Boolean = | ||
| op.hasTrait<HttpChecksumRequiredTrait>() && !op.hasTrait<HttpChecksumTrait>() | ||
|
|
||
| override fun render(ctx: ProtocolGenerator.GenerationContext, op: OperationShape, writer: KotlinWriter) { | ||
| writer.write( | ||
| "op.context[#T.DefaultChecksumAlgorithm] = #S", | ||
| RuntimeTypes.HttpClient.Operation.HttpOperationContext, | ||
| "MD5", | ||
|
There was a problem hiding this comment. question/correctness: Can/should we store this as a There was a problem hiding this comment. We could, I think we would have to initialize the |
||
| ) | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Adds interceptor to calculate request checksums. | ||
| * The `httpChecksum` trait supersedes the `httpChecksumRequired` trait. If both are applied to an operation use `httpChecksum`. | ||
| * | ||
| * See: https://smithy.io/2.0/aws/aws-core.html#behavior-with-httpchecksumrequired | ||
| */ | ||
| private val httpChecksumRequiredMiddleware = object : ProtocolMiddleware { | ||
| override val name: String = "httpChecksumRequiredMiddleware" | ||
|
|
||
| override fun isEnabledFor(ctx: ProtocolGenerator.GenerationContext, op: OperationShape): Boolean = | ||
| op.hasTrait<HttpChecksumRequiredTrait>() && !op.hasTrait<HttpChecksumTrait>() | ||
|
|
||
| override fun render(ctx: ProtocolGenerator.GenerationContext, op: OperationShape, writer: KotlinWriter) { | ||
| writer.write( | ||
| "op.interceptors.add(#T())", | ||
| RuntimeTypes.HttpClient.Interceptors.HttpChecksumRequiredInterceptor, | ||
| ) | ||
| } | ||
| } | ||
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
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
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,44 @@ | ||
| package aws.smithy.kotlin.runtime.http.interceptors | ||
|
|
||
| import aws.smithy.kotlin.runtime.businessmetrics.emitBusinessMetric | ||
| import aws.smithy.kotlin.runtime.client.ProtocolRequestInterceptorContext | ||
| import aws.smithy.kotlin.runtime.hashing.HashFunction | ||
| import aws.smithy.kotlin.runtime.hashing.resolveChecksumAlgorithmHeaderName | ||
| import aws.smithy.kotlin.runtime.hashing.toBusinessMetric | ||
| import aws.smithy.kotlin.runtime.http.operation.HttpOperationContext | ||
| import aws.smithy.kotlin.runtime.http.request.HttpRequest | ||
| import aws.smithy.kotlin.runtime.http.request.toBuilder | ||
| import aws.smithy.kotlin.runtime.http.toCompletingBody | ||
| import aws.smithy.kotlin.runtime.http.toHashingBody | ||
| import kotlinx.coroutines.CompletableDeferred | ||
| import kotlinx.coroutines.job | ||
|
|
||
| /** | ||
| * Configures [HttpRequest] with AWS chunked streaming to calculate checksum during transmission | ||
| * @return [HttpRequest] | ||
| */ | ||
| internal fun calculateAwsChunkedStreamingChecksum( | ||
| context: ProtocolRequestInterceptorContext<Any, HttpRequest>, | ||
| checksumAlgorithm: HashFunction, | ||
| ): HttpRequest { | ||
| val request = context.protocolRequest.toBuilder() | ||
| val deferredChecksum = CompletableDeferred<String>(context.executionContext.coroutineContext.job) | ||
| val checksumHeader = checksumAlgorithm.resolveChecksumAlgorithmHeaderName() | ||
|
|
||
| request.body = request.body | ||
| .toHashingBody(checksumAlgorithm, request.body.contentLength) | ||
| .toCompletingBody(deferredChecksum) | ||
|
|
||
| request.headers.append("x-amz-trailer", checksumHeader) | ||
| request.trailingHeaders.append(checksumHeader, deferredChecksum) | ||
|
|
||
| context.executionContext.emitBusinessMetric(checksumAlgorithm.toBusinessMetric()) | ||
|
|
||
| return request.build() | ||
| } | ||
|
|
||
| /** | ||
| * @return The default checksum algorithm name in the execution context, null if default checksums are disabled. | ||
| */ | ||
| internal val ProtocolRequestInterceptorContext<Any, HttpRequest>.defaultChecksumAlgorithmName: String? | ||
| get() = executionContext.getOrNull(HttpOperationContext.DefaultChecksumAlgorithm) |
Oops, something went wrong.
Oops, something went wrong.
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.
nit/docs: Explain more about how it "handles" the trait
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.
The "meat" of the integration is the middleware and both of them have their own Kdocs. It feels like docs overkill to also add a summary of what each middleware is doing here