-
Notifications
You must be signed in to change notification settings - Fork 79
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
feat: add support for flexible checksums on Normal payloads #1304
Merged
Merged
Changes from 1 commit
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
4807784
add support for flexible checksums on Normal payloads
dayaffe 9980249
replace .getOrNull() with .orElse(null)
dayaffe 951c1b4
Merge branch 'main' into day/normal-payloads-checksums
dayaffe 953b658
put back .getOrNull
dayaffe dfb23ca
chore: Updated codegen (#1320)
jbelkins f0d59a8
chore: Remove several unneeded services from codegen for integration …
jbelkins 55dbd2d
feat!: Eliminate service client protocols (#1322)
jbelkins 6aae481
input should be checksum provided by user & update codegen test
dayaffe 6fea2bc
Merge branch 'main' into day/normal-payloads-checksums
dayaffe dcb0bad
Merge branch 'main' into day/normal-payloads-checksums
dayaffe 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
68 changes: 68 additions & 0 deletions
68
.../aws/swift/codegen/customization/flexiblechecksums/FlexibleChecksumsRequestIntegration.kt
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,68 @@ | ||
| package software.amazon.smithy.aws.swift.codegen.customization.flexiblechecksums | ||
|
|
||
| import software.amazon.smithy.aws.traits.HttpChecksumTrait | ||
| import software.amazon.smithy.model.Model | ||
| import software.amazon.smithy.model.shapes.OperationShape | ||
| import software.amazon.smithy.model.shapes.StructureShape | ||
| import software.amazon.smithy.swift.codegen.ClientRuntimeTypes | ||
| import software.amazon.smithy.swift.codegen.SwiftSettings | ||
| import software.amazon.smithy.swift.codegen.SwiftWriter | ||
| import software.amazon.smithy.swift.codegen.getOrNull | ||
| import software.amazon.smithy.swift.codegen.integration.ProtocolGenerator | ||
| import software.amazon.smithy.swift.codegen.integration.SwiftIntegration | ||
| import software.amazon.smithy.swift.codegen.integration.middlewares.handlers.MiddlewareShapeUtils | ||
| import software.amazon.smithy.swift.codegen.middleware.MiddlewarePosition | ||
| import software.amazon.smithy.swift.codegen.middleware.MiddlewareRenderable | ||
| import software.amazon.smithy.swift.codegen.middleware.MiddlewareStep | ||
| import software.amazon.smithy.swift.codegen.middleware.OperationMiddleware | ||
| import software.amazon.smithy.swift.codegen.model.expectShape | ||
| import software.amazon.smithy.swift.codegen.model.shapes | ||
|
|
||
| class FlexibleChecksumsRequestIntegration : SwiftIntegration { | ||
| override fun enabledForService(model: Model, settings: SwiftSettings): Boolean = model | ||
| .shapes<OperationShape>() | ||
| .any { it.hasTrait(HttpChecksumTrait::class.java) } | ||
|
|
||
| override fun customizeMiddleware( | ||
| ctx: ProtocolGenerator.GenerationContext, | ||
| operationShape: OperationShape, | ||
| operationMiddleware: OperationMiddleware, | ||
| ) { | ||
| val httpChecksumTrait = operationShape.getTrait(HttpChecksumTrait::class.java).getOrNull() | ||
| val input = operationShape.input.getOrNull()?.let { ctx.model.expectShape<StructureShape>(it) } | ||
|
|
||
| val useFlexibleChecksum = (httpChecksumTrait != null) && | ||
| (httpChecksumTrait.requestAlgorithmMember?.getOrNull() != null) && | ||
| (input?.memberNames?.any { it == httpChecksumTrait.requestAlgorithmMember.get() } == true) | ||
|
|
||
| if (useFlexibleChecksum) { | ||
| operationMiddleware.appendMiddleware(operationShape, FlexibleChecksumRequestMiddleware) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private object FlexibleChecksumRequestMiddleware : MiddlewareRenderable { | ||
| override val name = "FlexibleChecksumRequestMiddleware" | ||
|
|
||
| override val middlewareStep = MiddlewareStep.SERIALIZESTEP | ||
|
|
||
| override val position = MiddlewarePosition.AFTER | ||
|
|
||
| override fun render(ctx: ProtocolGenerator.GenerationContext, writer: SwiftWriter, op: OperationShape, operationStackName: String) { | ||
| val inputShapeName = MiddlewareShapeUtils.inputSymbol(ctx.symbolProvider, ctx.model, op).name | ||
| val outputShapeName = MiddlewareShapeUtils.outputSymbol(ctx.symbolProvider, ctx.model, op).name | ||
| val httpChecksumTrait = op.getTrait(HttpChecksumTrait::class.java).getOrNull() | ||
| val inputMemberName = httpChecksumTrait?.requestAlgorithmMember?.get() | ||
| val algorithmMember = ctx.model.expectShape(op.inputShape).getMember(inputMemberName) | ||
| val algorithmEnumShape = ctx.model.expectShape(algorithmMember.getOrNull()?.target) | ||
|
|
||
| // Will pass list of checksums to Swift middleware to handle the rest | ||
| val algorithmNames: List<String> = algorithmEnumShape.members().map { it.memberName } | ||
|
|
||
| // Convert algorithmNames list to a Swift array representation | ||
| val algorithmNamesSwiftArray = algorithmNames.joinToString(separator = ", ") { "\"$it\"" } | ||
| val middlewareInit = "${ClientRuntimeTypes.Middleware.FlexibleChecksumsRequestMiddleware}<$inputShapeName, $outputShapeName>(checksumAlgorithms: [$algorithmNamesSwiftArray])" | ||
|
|
||
| writer.write("$operationStackName.${middlewareStep.stringValue()}.intercept(position: ${position.stringValue()}, middleware: $middlewareInit)") | ||
| } | ||
| } | ||
63 changes: 63 additions & 0 deletions
63
...aws/swift/codegen/customization/flexiblechecksums/FlexibleChecksumsResponseIntegration.kt
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,63 @@ | ||
| package software.amazon.smithy.aws.swift.codegen.customization.flexiblechecksums | ||
|
|
||
| import software.amazon.smithy.aws.traits.HttpChecksumTrait | ||
| import software.amazon.smithy.model.Model | ||
| import software.amazon.smithy.model.shapes.OperationShape | ||
| import software.amazon.smithy.model.shapes.StructureShape | ||
| import software.amazon.smithy.swift.codegen.ClientRuntimeTypes | ||
| import software.amazon.smithy.swift.codegen.SwiftSettings | ||
| import software.amazon.smithy.swift.codegen.SwiftWriter | ||
| import software.amazon.smithy.swift.codegen.getOrNull | ||
| import software.amazon.smithy.swift.codegen.integration.ProtocolGenerator | ||
| import software.amazon.smithy.swift.codegen.integration.SwiftIntegration | ||
| import software.amazon.smithy.swift.codegen.integration.middlewares.handlers.MiddlewareShapeUtils | ||
| import software.amazon.smithy.swift.codegen.middleware.MiddlewarePosition | ||
| import software.amazon.smithy.swift.codegen.middleware.MiddlewareRenderable | ||
| import software.amazon.smithy.swift.codegen.middleware.MiddlewareStep | ||
| import software.amazon.smithy.swift.codegen.middleware.OperationMiddleware | ||
| import software.amazon.smithy.swift.codegen.model.expectShape | ||
| import software.amazon.smithy.swift.codegen.model.shapes | ||
|
|
||
| class FlexibleChecksumsResponseIntegration : SwiftIntegration { | ||
| override fun enabledForService(model: Model, settings: SwiftSettings): Boolean = model | ||
| .shapes<OperationShape>() | ||
| .any { it.hasTrait(HttpChecksumTrait::class.java) } | ||
|
|
||
| override fun customizeMiddleware( | ||
| ctx: ProtocolGenerator.GenerationContext, | ||
| operationShape: OperationShape, | ||
| operationMiddleware: OperationMiddleware, | ||
| ) { | ||
| val httpChecksumTrait = operationShape.getTrait(HttpChecksumTrait::class.java).getOrNull() | ||
| val input = operationShape.input.getOrNull()?.let { ctx.model.expectShape<StructureShape>(it) } | ||
|
|
||
| val useFlexibleChecksum = (httpChecksumTrait != null) && | ||
| (httpChecksumTrait.requestValidationModeMember?.getOrNull() != null) && | ||
| (input?.memberNames?.any { it == httpChecksumTrait.requestValidationModeMember.get() } == true) | ||
|
|
||
| if (useFlexibleChecksum) { | ||
| operationMiddleware.appendMiddleware(operationShape, FlexibleChecksumResponseMiddleware) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private object FlexibleChecksumResponseMiddleware : MiddlewareRenderable { | ||
| override val name = "FlexibleChecksumResponseMiddleware" | ||
|
|
||
| override val middlewareStep = MiddlewareStep.DESERIALIZESTEP | ||
|
|
||
| override val position = MiddlewarePosition.AFTER | ||
|
|
||
| override fun render(ctx: ProtocolGenerator.GenerationContext, writer: SwiftWriter, op: OperationShape, operationStackName: String) { | ||
| val outputShapeName = MiddlewareShapeUtils.outputSymbol(ctx.symbolProvider, ctx.model, op).name | ||
| val httpChecksumTrait = op.getTrait(HttpChecksumTrait::class.java).getOrNull() | ||
| val inputMemberName = httpChecksumTrait?.requestValidationModeMember?.get() | ||
| val validationModeMember = ctx.model.expectShape(op.inputShape).getMember(inputMemberName) | ||
| val requestValidationModeEnumShape = ctx.model.expectShape(validationModeMember.getOrNull()?.target) | ||
|
|
||
| // Will pass the validation mode to validation middleware | ||
| val validationMode: Boolean = requestValidationModeEnumShape.members().map { it.memberName }.first().equals("ENABLED") | ||
| val middlewareInit = "${ClientRuntimeTypes.Middleware.FlexibleChecksumsResponseMiddleware}<$outputShapeName>(validationMode: $validationMode)" | ||
| writer.write("$operationStackName.${middlewareStep.stringValue()}.intercept(position: ${position.stringValue()}, middleware: $middlewareInit)") | ||
| } | ||
| } |
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
74 changes: 74 additions & 0 deletions
74
...oftware/amazon/smithy/aws/swift/codegen/customizations/FlexibleChecksumMiddlewareTests.kt
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,74 @@ | ||
| package software.amazon.smithy.aws.swift.codegen.customizations | ||
|
|
||
| import io.kotest.matchers.string.shouldContainOnlyOnce | ||
| import org.junit.jupiter.api.Test | ||
| import software.amazon.smithy.aws.swift.codegen.TestContext | ||
| import software.amazon.smithy.aws.swift.codegen.TestContextGenerator | ||
| import software.amazon.smithy.aws.swift.codegen.restjson.AWSRestJson1ProtocolGenerator | ||
| import software.amazon.smithy.aws.swift.codegen.shouldSyntacticSanityCheck | ||
| import software.amazon.smithy.aws.traits.protocols.RestJson1Trait | ||
|
|
||
| class FlexibleChecksumMiddlewareTests { | ||
|
|
||
| @Test | ||
| fun `Test that FlexibleChecksumsRequestMiddleware and FlexibleChecksumsResponseMiddleware are properly generated`() { | ||
| val context = setupTests("flexible-checksums.smithy", "aws.flex.checks#ChecksumTests") | ||
| val contents = TestContextGenerator.getFileContents(context.manifest, "/Example/ChecksumTestsClient.swift") | ||
| contents.shouldSyntacticSanityCheck() | ||
| val expectedContents = """ | ||
| extension ChecksumTestsClient: ChecksumTestsClientProtocol { | ||
| /// Performs the `SomeOperation` operation on the `ChecksumTests` service. | ||
| /// | ||
| /// | ||
| /// - Parameter SomeOperationInput : [no documentation found] | ||
| /// | ||
| /// - Returns: `SomeOperationOutput` : [no documentation found] | ||
| public func someOperation(input: SomeOperationInput) async throws -> SomeOperationOutput | ||
| { | ||
| let context = ClientRuntime.HttpContextBuilder() | ||
| .withEncoder(value: encoder) | ||
| .withDecoder(value: decoder) | ||
| .withMethod(value: .post) | ||
| .withServiceName(value: serviceName) | ||
| .withOperation(value: "someOperation") | ||
| .withIdempotencyTokenGenerator(value: config.idempotencyTokenGenerator) | ||
| .withLogger(value: config.logger) | ||
| .withPartitionID(value: config.partitionID) | ||
| .withCredentialsProvider(value: config.credentialsProvider) | ||
| .withRegion(value: config.region) | ||
| .build() | ||
| var operation = ClientRuntime.OperationStack<SomeOperationInput, SomeOperationOutput>(id: "someOperation") | ||
| operation.initializeStep.intercept(position: .after, middleware: ClientRuntime.URLPathMiddleware<SomeOperationInput, SomeOperationOutput>()) | ||
| operation.initializeStep.intercept(position: .after, middleware: ClientRuntime.URLHostMiddleware<SomeOperationInput, SomeOperationOutput>()) | ||
| operation.buildStep.intercept(position: .before, middleware: ClientRuntime.ContentMD5Middleware<SomeOperationOutput>()) | ||
| let endpointParams = EndpointParams() | ||
| operation.buildStep.intercept(position: .before, middleware: EndpointResolverMiddleware<SomeOperationOutput>(endpointResolver: config.serviceSpecific.endpointResolver, endpointParams: endpointParams)) | ||
| operation.buildStep.intercept(position: .before, middleware: AWSClientRuntime.UserAgentMiddleware(metadata: AWSClientRuntime.AWSUserAgentMetadata.fromConfig(serviceID: serviceName, version: "1.0.0", config: config))) | ||
| operation.serializeStep.intercept(position: .after, middleware: ClientRuntime.HeaderMiddleware<SomeOperationInput, SomeOperationOutput>()) | ||
| operation.serializeStep.intercept(position: .after, middleware: ContentTypeMiddleware<SomeOperationInput, SomeOperationOutput>(contentType: "application/octet-stream")) | ||
| operation.serializeStep.intercept(position: .after, middleware: ClientRuntime.BlobBodyMiddleware<SomeOperationInput, SomeOperationOutput>(keyPath: \.content)) | ||
| operation.serializeStep.intercept(position: .after, middleware: ClientRuntime.FlexibleChecksumsRequestMiddleware<SomeOperationInput, SomeOperationOutput>(checksumAlgorithms: ["CRC32C", "CRC32", "SHA1", "SHA256"])) | ||
| operation.finalizeStep.intercept(position: .before, middleware: ClientRuntime.ContentLengthMiddleware()) | ||
| operation.finalizeStep.intercept(position: .after, middleware: ClientRuntime.RetryMiddleware<ClientRuntime.DefaultRetryStrategy, AWSClientRuntime.AWSRetryErrorInfoProvider, SomeOperationOutput>(options: config.retryStrategyOptions)) | ||
| operation.deserializeStep.intercept(position: .after, middleware: ClientRuntime.DeserializeMiddleware<SomeOperationOutput>(responseClosure(decoder: decoder), responseErrorClosure(SomeOperationOutputError.self, decoder: decoder))) | ||
| operation.deserializeStep.intercept(position: .after, middleware: ClientRuntime.LoggerMiddleware<SomeOperationOutput>(clientLogMode: config.clientLogMode)) | ||
| operation.deserializeStep.intercept(position: .after, middleware: ClientRuntime.FlexibleChecksumsResponseMiddleware<SomeOperationOutput>(validationMode: true)) | ||
| let result = try await operation.handleMiddleware(context: context, input: input, next: client.getHandler()) | ||
| return result | ||
| } | ||
|
|
||
| } | ||
| """.trimIndent() | ||
| contents.shouldContainOnlyOnce(expectedContents) | ||
| } | ||
|
|
||
| private fun setupTests(smithyFile: String, serviceShapeId: String): TestContext { | ||
| val context = | ||
| TestContextGenerator.initContextFrom(smithyFile, serviceShapeId, RestJson1Trait.ID) | ||
|
|
||
| val generator = AWSRestJson1ProtocolGenerator() | ||
| generator.generateProtocolUnitTests(context.ctx) | ||
| context.ctx.delegator.flushWriters() | ||
| return context | ||
| } | ||
| } |
53 changes: 53 additions & 0 deletions
53
...gen/src/test/resources/software.amazon.smithy.aws.swift.codegen/flexible-checksums.smithy
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,53 @@ | ||
| $version: "2.0" | ||
|
|
||
| namespace aws.flex.checks | ||
|
|
||
| use aws.api#service | ||
| use aws.protocols#httpChecksum | ||
| use aws.protocols#restJson1 | ||
|
|
||
| @restJson1 | ||
| @service(sdkId: "ChecksumTests") | ||
| service ChecksumTests { | ||
| version: "1.0.0", | ||
| operations: [SomeOperation] | ||
| } | ||
|
|
||
| // Define the operation | ||
| @httpChecksum( | ||
| requestChecksumRequired: true, | ||
| requestAlgorithmMember: "checksumAlgorithm", | ||
| requestValidationModeMember: "validationMode", | ||
| responseAlgorithms: ["CRC32C", "CRC32", "SHA1", "SHA256"] | ||
| ) | ||
| @http(method: "POST", uri: "/foo") | ||
| operation SomeOperation { | ||
| input: PutSomethingInput | ||
| output: PutSomethingOutput | ||
| } | ||
|
|
||
| structure PutSomethingInput { | ||
| @httpHeader("x-amz-request-algorithm") | ||
| checksumAlgorithm: ChecksumAlgorithm | ||
|
|
||
| @httpHeader("x-amz-response-validation-mode") | ||
| validationMode: ValidationMode | ||
|
|
||
| @httpPayload | ||
| content: Blob | ||
| } | ||
|
|
||
| structure PutSomethingOutput { | ||
| foo: String | ||
| } | ||
|
|
||
| enum ChecksumAlgorithm { | ||
| CRC32C | ||
| CRC32 | ||
| SHA1 | ||
| SHA256 | ||
| } | ||
|
|
||
| enum ValidationMode { | ||
| ENABLED | ||
| } |
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.
Is this the same
.getOrNull()that I'm eliminating in the XML branch?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.
(I think we decided to use
.orElse(null)which is a Kotlin built-in)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
.orElse(null)we were talking about I believe works on Java types not Kotlin types where we prefer to use?.that work on optionals. I can check where .getOrNull() is used and see if we can switch it over to the kotlin optionals. It seems like that method .getOrNull() was created to work on either Java or Kotlin types