fix: Route 53 TrimHostedZone customization is incomplete #1445

jbelkins · 2024-04-20T19:11:09Z

Issue #

#1444 (reusable middleware refactor)
#1446 (apply customization to all operations)

Description of changes

Fix more Route 53 operations

Currently, the "trim hosted zone" customization fixes fourteen AWS Route 53 operations where a string-typed input member named "HostedZoneId" is bound to a URL component.

Integration testing shows that there are six other Route 53 operations that require the same customization, but do not have it applied because they carry a hosted zone ID in a field not named "HostedZoneId".

This PR performs the "trim hosted zone" customization for six additional Route 53 operations where a HostedZone is used in the URL but the name of the property is something other than "HostedZoneId".

Reusable middleware refactor

Currently, a custom middleware is rendered for each of the 14 operations that require the "trim hosted zone" customization.

Instead, a single reusable middleware is provided, and it is inserted into the operation stack for the operations that need it. A key path is passed into the middleware to account for the varying names of the field containing hosted zone ID.

This saves 500 lines of generated code by not generating 20 custom middlewares. A regenerated Route 53 service client is included in this PR for reference.

Integration Test

An integration test is added which uses the createHostedZone, changeResourceRecordSets, and deleteHostedZone operations to manipulate live Route 53. This test fails if the fix to the customization above is not applied because deleteHostedZone takes the hosted zone ID in a field not named "HostedZoneId". With the fix applied, the test passes.

New/existing dependencies impact assessment, if applicable

No new dependencies were added to this change.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

jbelkins · 2024-04-20T19:13:24Z

Sources/Core/AWSClientRuntime/Middlewares/Route53TrimHostedZoneMiddleware.swift

+
+import ClientRuntime
+
+public struct Route53TrimHostedZoneMiddleware<Input, Output>: ClientRuntime.Middleware {


This is the same as the previously code-generated middleware, except:

The input & output are generics that get substituted for each operation at compile time.

The hosted zone ID on the input model is accessed via a key path that is passed in at initialization.

jbelkins · 2024-04-20T19:14:06Z

...tlin/software/amazon/smithy/aws/swift/codegen/customization/route53/Route53TrimHostedZone.kt

@@ -38,8 +39,7 @@ class Route53TrimHostedZone : SwiftIntegration {
        val inputShape = MiddlewareShapeUtils.inputShape(ctx.model, operationShape)
        val hostedZoneMember = inputShape.members().find { it.hasTrait<TrimHostedZone>() }
        if (hostedZoneMember != null) {
-            StripHostedZoneURLPathMiddleware.renderMiddleware(ctx, operationShape)
-            operationMiddleware.prependMiddleware(operationShape, StripHostedZoneUrlPathMiddlewareRenderable(ctx.model, ctx.symbolProvider))
+            operationMiddleware.prependMiddleware(operationShape, StripHostedZoneURLPathMiddlewareRenderable(ctx.model, ctx.symbolProvider))


The middleware is no longer rendered for each operation that needs it since a reusable one is used instead.

jbelkins · 2024-04-20T19:14:22Z

...smithy/aws/swift/codegen/customization/route53/StripHostedZoneURLPathMiddlewareRenderable.kt

 import software.amazon.smithy.swift.codegen.middleware.MiddlewarePosition
 import software.amazon.smithy.swift.codegen.middleware.MiddlewareRenderable
 import software.amazon.smithy.swift.codegen.middleware.MiddlewareStep

-class StripHostedZoneUrlPathMiddlewareRenderable(
+class StripHostedZoneURLPathMiddlewareRenderable(


Type renamed

jbelkins · 2024-04-20T19:15:43Z

...smithy/aws/swift/codegen/customization/route53/StripHostedZoneURLPathMiddlewareRenderable.kt

@@ -21,7 +20,6 @@ class StripHostedZoneUrlPathMiddlewareRenderable(
    override val position = MiddlewarePosition.AFTER

    override fun render(ctx: ProtocolGenerator.GenerationContext, writer: SwiftWriter, op: OperationShape, operationStackName: String) {
-        val inputShapeName = MiddlewareShapeUtils.inputSymbol(symbolProvider, model, op).name
-        writer.write("$operationStackName.${middlewareStep.stringValue()}.intercept(position: ${position.stringValue()}, middleware: ${inputShapeName}StripHostedZoneMiddleware())")
+        writer.write("$operationStackName.${middlewareStep.stringValue()}.intercept(position: ${position.stringValue()}, middleware: Route53TrimHostedZoneMiddleware(\\.hostedZoneId))")


The reusable middleware, initialized with a key path, is inserted into the operation stack instead of a code-generated middleware.

jbelkins · 2024-04-20T19:31:08Z

...re/amazon/smithy/aws/swift/codegen/customization/route53/StripHostedZoneURLPathMiddleware.kt

-import software.amazon.smithy.swift.codegen.integration.middlewares.handlers.MiddlewareShapeUtils
-import software.amazon.smithy.swift.codegen.integration.steps.OperationInitializeStep
-
-class StripHostedZoneURLPathMiddleware(


This middleware is no longer rendered since a reusable one in AWSClientRuntime is used instead.

jbelkins · 2024-04-21T17:16:10Z

Sources/Services/AWSRoute53/models/Models.swift

@@ -96,31 +96,6 @@ extension Route53ClientTypes {
    }
 }

-public struct ActivateKeySigningKeyInputStripHostedZoneMiddleware: ClientRuntime.Middleware {


14 generated middlewares are removed from Models, because the reusable one is used instead.

jbelkins · 2024-04-21T17:17:52Z

Sources/Services/AWSRoute53/Route53Client.swift

                      .withIdentityResolver(value: config.awsCredentialIdentityResolver, schemeID: "aws.auth#sigv4")
                      .withIdentityResolver(value: config.awsCredentialIdentityResolver, schemeID: "aws.auth#sigv4a")
                      .withRegion(value: config.region)
                      .withSigningName(value: "route53")
                      .withSigningRegion(value: config.signingRegion)
                      .build()
        var operation = ClientRuntime.OperationStack<ActivateKeySigningKeyInput, ActivateKeySigningKeyOutput>(id: "activateKeySigningKey")
-        operation.initializeStep.intercept(position: .after, middleware: ActivateKeySigningKeyInputStripHostedZoneMiddleware())
+        operation.initializeStep.intercept(position: .after, middleware: Route53TrimHostedZoneMiddleware(\.hostedZoneId))


Middleware insertion is updated to use the new, reusable middleware and to pass in the key path to the field holding the hosted zone ID.

Six additional operations get the customization as well; these are ones that use a hosted zone ID but it is not exactly named "HostedZoneId".

jbelkins · 2024-04-21T17:19:11Z

.../smithy/aws/swift/codegen/customization/route53/TrimHostedZoneURLPathMiddlewareRenderable.kt


-class StripHostedZoneUrlPathMiddlewareRenderable(
+class TrimHostedZoneURLPathMiddlewareRenderable(


Types are renamed

Code cleanup

The reusable middleware is inserted instead of the custom one

jbelkins · 2024-04-21T17:24:01Z

IntegrationTests/Services/AWSRoute53IntegrationTests/AWSRoute53Tests.swift

+//
+
+import XCTest
+import AWSRoute53


A simple integration test for Route 53:

creates a hosted zone,

creates an A record in that zone,

deletes the A record,

deletes the hosted zone.

All operations used after creating the zone require the TrimHostedZone customization in order to succeed.

jbelkins · 2024-04-21T18:00:08Z

...tlin/software/amazon/smithy/aws/swift/codegen/customization/route53/Route53TrimHostedZone.kt

        }
    }

    private fun isHostId(shape: Shape): Boolean {
-        return (shape is MemberShape && shape.target == ShapeId.from("com.amazonaws.route53#ResourceId")) && shape.hasTrait<HttpLabelTrait>() && shape.memberName == "HostedZoneId"
+        return (shape is MemberShape && shape.target == ShapeId.from("com.amazonaws.route53#ResourceId")) && shape.hasTrait<HttpLabelTrait>()


The overly-restrictive requirement that the member be named HostedZoneId is removed.

Reusable middleware for Route 53 TrimHostedZone

38ffb47

jbelkins commented Apr 20, 2024

View reviewed changes

jbelkins marked this pull request as ready for review April 20, 2024 19:15

jbelkins requested review from dayaffe and sichanyoo April 20, 2024 19:18

Fix swiftlint

9ace770

jbelkins commented Apr 20, 2024

View reviewed changes

jbelkins added 2 commits April 20, 2024 17:47

Add Route53 TrimHostedZone middleware no matter the property name

f9e845b

Fix ktlint

3108dc5

jbelkins changed the title ~~chore: Reusable middleware for Route 53 TrimHostedZone~~ fix: Route 53 TrimHostedZone customization is incomplete Apr 21, 2024

Add Route 53 integration test, update generated Route 53 code

3381dd0

jbelkins commented Apr 21, 2024

View reviewed changes

Package manifest regen & test cleanup

ad88ccc

jbelkins commented Apr 21, 2024

View reviewed changes

jbelkins mentioned this pull request Apr 21, 2024

AWS Route 53 InvalidBatchError customization does not work #1447

Closed

sichanyoo approved these changes Apr 22, 2024

View reviewed changes

dayaffe approved these changes Apr 22, 2024

View reviewed changes

jbelkins added 2 commits April 22, 2024 18:56

Merge branch 'main' into jbe/reusable_trim_hosted_zone

5d0e97b

Merge branch 'main' into jbe/reusable_trim_hosted_zone

e0fe7b6

jbelkins merged commit f8cbbab into main Apr 23, 2024
17 checks passed

jbelkins deleted the jbe/reusable_trim_hosted_zone branch April 23, 2024 19:43

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: Route 53 TrimHostedZone customization is incomplete #1445

fix: Route 53 TrimHostedZone customization is incomplete #1445

jbelkins commented Apr 20, 2024 •

edited

Loading

jbelkins Apr 20, 2024

jbelkins Apr 20, 2024

jbelkins Apr 20, 2024

jbelkins Apr 20, 2024

jbelkins Apr 20, 2024

jbelkins Apr 21, 2024

jbelkins Apr 21, 2024

jbelkins Apr 21, 2024

jbelkins Apr 21, 2024

jbelkins Apr 21, 2024


		import ClientRuntime

		public struct Route53TrimHostedZoneMiddleware<Input, Output>: ClientRuntime.Middleware {


		class StripHostedZoneUrlPathMiddlewareRenderable(
		class TrimHostedZoneURLPathMiddlewareRenderable(

fix: Route 53 TrimHostedZone customization is incomplete #1445

fix: Route 53 TrimHostedZone customization is incomplete #1445

Conversation

jbelkins commented Apr 20, 2024 • edited Loading

Issue #

Description of changes

Fix more Route 53 operations

Reusable middleware refactor

Integration Test

New/existing dependencies impact assessment, if applicable

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jbelkins commented Apr 20, 2024 •

edited

Loading