feat: Support generating presigned url for UploadPart operation #1809
Conversation
|
After 9e3244e the generated URL's are correct and uploading works :). Will look into writing tests for this now. |
| if let partNumber = input.partNumber { | ||
| let queryItem = Smithy.URIQueryItem(name: "partNumber".urlPercentEncoding(), value: Swift.String(partNumber).urlPercentEncoding()) | ||
| builder.withQueryItem(queryItem) | ||
| } | ||
| if let uploadId = input.uploadId { | ||
| let queryItem = Smithy.URIQueryItem(name: "uploadId".urlPercentEncoding(), value: Swift.String(uploadId).urlPercentEncoding()) | ||
| builder.withQueryItem(queryItem) | ||
| } |
There was a problem hiding this comment.
Wondering if there is a way to generate this.
There was a problem hiding this comment.
Query item provider is already generated here. It handles adding input values with @httpQuery trait in Smithy model for the service to the request at runtime.
The UploadPartInput.queryItemProvider gets used here for normal request flow, and to add QueryItemMiddleware for the presignURL method, only change that needs to be made is probably adding the middleware codegen back for UploadPart in here. I.e., this custom middleware is not necessary.
plu
changed the title
plu
changed the title
| if let partNumber = input.partNumber { | ||
| let queryItem = Smithy.URIQueryItem(name: "partNumber".urlPercentEncoding(), value: Swift.String(partNumber).urlPercentEncoding()) | ||
| builder.withQueryItem(queryItem) | ||
| } | ||
| if let uploadId = input.uploadId { | ||
| let queryItem = Smithy.URIQueryItem(name: "uploadId".urlPercentEncoding(), value: Swift.String(uploadId).urlPercentEncoding()) | ||
| builder.withQueryItem(queryItem) | ||
| } |
There was a problem hiding this comment.
Query item provider is already generated here. It handles adding input values with @httpQuery trait in Smithy model for the service to the request at runtime.
The UploadPartInput.queryItemProvider gets used here for normal request flow, and to add QueryItemMiddleware for the presignURL method, only change that needs to be made is probably adding the middleware codegen back for UploadPart in here. I.e., this custom middleware is not necessary.
| @@ -86,6 +89,9 @@ class PresignableUrlIntegration(private val presignedOperations: Map<String, Set | |||
| "com.amazonaws.s3#PutObject" -> { | |||
| renderMiddlewareClassForPutObject(ctx, delegator, op) | |||
| } | |||
| "com.amazonaws.s3#UploadPart" -> { | |||
| renderMiddlewareClassForUploadPart(ctx, delegator, op) | |||
| } | |||
There was a problem hiding this comment.
As per previous comment, to use the already generated queryItemProvider for UploadPartInput, you won't need to add this custom middleware here anymore.
| "com.amazonaws.s3#UploadPart" -> { | ||
| operationMiddlewareCopy.removeMiddleware(op, "OperationInputBodyMiddleware") | ||
| operationMiddlewareCopy.appendMiddleware(op, UploadPartPresignedURLMiddlewareRenderable()) | ||
| } |
There was a problem hiding this comment.
This is where you could just add back the QueryItemMiddleware which has the name OperationInputQueryItemMiddleware; it's located here.
| private fun renderMiddlewareClassForUploadPart(codegenContext: SwiftCodegenContext, delegator: SwiftDelegator, op: OperationShape) { | ||
|
|
||
| val serviceShape = codegenContext.model.expectShape<ServiceShape>(codegenContext.settings.service) | ||
| val ctx = codegenContext.toProtocolGenerationContext(serviceShape, delegator)?.let { it } ?: run { return } | ||
|
|
||
| val opIndex = OperationIndex.of(ctx.model) | ||
| val inputShape = opIndex.getInput(op).get() | ||
| val outputShape = opIndex.getOutput(op).get() | ||
| val operationErrorName = MiddlewareShapeUtils.outputErrorSymbolName(op) | ||
| val inputSymbol = ctx.symbolProvider.toSymbol(inputShape) | ||
| val outputSymbol = ctx.symbolProvider.toSymbol(outputShape) | ||
| val outputErrorSymbol = Symbol.builder().name(operationErrorName).build() | ||
| val filename = ModelFileUtils.filename(ctx.settings, "${inputSymbol.name}+QueryItemMiddlewareForPresignUrl") | ||
| val headerMiddlewareSymbol = Symbol.builder() | ||
| .definitionFile(filename) | ||
| .name(inputSymbol.name) | ||
| .build() | ||
| delegator.useShapeWriter(headerMiddlewareSymbol) { writer -> | ||
| val queryItemMiddleware = UploadPartPresignedURLMiddleware( | ||
| inputSymbol, | ||
| outputSymbol, | ||
| outputErrorSymbol, | ||
| writer | ||
| ) | ||
| MiddlewareGenerator(writer, queryItemMiddleware).generate() | ||
| } | ||
| } | ||
|
|
There was a problem hiding this comment.
Not needed if using preexisting codegen'd query item provider & runtime library's query item middleware
| package software.amazon.smithy.aws.swift.codegen.middleware | ||
|
|
||
| import software.amazon.smithy.model.shapes.OperationShape | ||
| import software.amazon.smithy.swift.codegen.SwiftWriter | ||
| import software.amazon.smithy.swift.codegen.integration.ProtocolGenerator | ||
| import software.amazon.smithy.swift.codegen.middleware.MiddlewareRenderable | ||
|
|
||
| // This middleware renderer inserts a custom middleware named `UploadPartPresignedURLMiddleware` | ||
| // into the operation stack. It is only intended for use with S3 `UploadPart` and only when | ||
| // generating a pre-signed URL. | ||
| class UploadPartPresignedURLMiddlewareRenderable : MiddlewareRenderable { | ||
|
|
||
| override val name = "UploadPartPresignedURLMiddleware" | ||
|
|
||
| override fun render( | ||
| ctx: ProtocolGenerator.GenerationContext, | ||
| writer: SwiftWriter, | ||
| op: OperationShape, | ||
| operationStackName: String | ||
| ) { | ||
| super.renderSpecific(ctx, writer, op, operationStackName, "serialize") | ||
| } | ||
|
|
||
| override fun renderMiddlewareInit( | ||
| ctx: ProtocolGenerator.GenerationContext, | ||
| writer: SwiftWriter, | ||
| op: OperationShape | ||
| ) { | ||
| writer.write("\$L()", name) | ||
| } | ||
| } |
There was a problem hiding this comment.
Not needed if using preexisting codegen'd query item provider & runtime library's query item middleware
It adds methods to generate a presigned url for the
UploadPartoperation.Issue
Fixes #1808, #723
Description of changes
It generates two new methods:
UploadPartInput.presignURL(config:expiration:)S3Client.presignedURLForUploadPart(input:expiration:)By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.