feat: Selectively generate read & write methods for structs & unions #721
Conversation
| @@ -55,6 +56,7 @@ class SwiftCodegenPlugin : SmithyBuildPlugin { | |||
| resolvedModel = NestedShapeTransformer.transform(resolvedModel, settings.getService(resolvedModel)) | |||
| resolvedModel = UnionIndirectivizer.transform(resolvedModel) | |||
| resolvedModel = EquatableConformanceTransformer.transform(resolvedModel, settings.getService(resolvedModel)) | |||
| resolvedModel = NeedsReaderWriterTransformer.transform(resolvedModel, settings.getService(resolvedModel)) | |||
There was a problem hiding this comment.
Adds a new model transformer before codegen.
| import software.amazon.smithy.model.shapes.ShapeId | ||
| import software.amazon.smithy.model.traits.Trait | ||
|
|
||
| class NeedsReaderTrait : Trait { |
There was a problem hiding this comment.
A simple custom trait we can use to mark the struct or union shapes that need to have a reader code-generated for them.
| import software.amazon.smithy.model.shapes.ShapeId | ||
| import software.amazon.smithy.model.traits.Trait | ||
|
|
||
| class NeedsWriterTrait : Trait { |
There was a problem hiding this comment.
A simple custom trait we can use to mark the struct or union shapes that need to have a writer code-generated for them.
| @@ -220,17 +223,40 @@ abstract class HTTPBindingProtocolGenerator( | |||
| // get all members sorted by name and filter out either all members with other traits OR members with the payload trait | |||
| val httpBodyMembers = members.filter { it.isInHttpBody() } | |||
| val path = "properties.".takeIf { shape.hasTrait<ErrorTrait>() } ?: "" | |||
| writer.write("") | |||
There was a problem hiding this comment.
Check if the NeedsWriter trait is present before generating a writer, and that the NeedsReader trait is present before generating a reader.
(code looks substantially different because it was reformatted but the method calls are identical.)
| return modelToReturn | ||
| } | ||
|
|
||
| private fun transform(model: Model, structure: StructureShape, trait: Trait): Model { |
There was a problem hiding this comment.
This function is used recursively to traverse the model tree and add the trait (either NeedsReader or NeedsWriter) to structs and unions that descend from either an input (for NeedsWriter) or an output (for NeedsReader.)
There was a problem hiding this comment.
Shapes that already have the trait are excluded from the transformation to prevent endless loops when shapes have self-references.
| @@ -135,6 +135,24 @@ fun Model.getNestedShapes(shape: Shape): Set<Shape> { | |||
| .select(this) | |||
| } | |||
|
|
|||
There was a problem hiding this comment.
These model selectors are used to extract the needed subset of shapes from the model for use above.
| @@ -144,13 +144,6 @@ extension RestJsonProtocolClientTypes.RenamedGreeting { | |||
| guard let value else { return } | |||
| try writer["salutation"].write(value.salutation) | |||
| } | |||
There was a problem hiding this comment.
This and following are test files, the NeedsReaderWriterTransformer has to be applied to the text contexts, and some test expectations no longer have both a reader & writer.
Issue #
awslabs/aws-sdk-swift#1495
Description of changes
Only code-generate read / write methods for structures & unions that are actually used by AWS operations.
This saves ~100,000 lines of dead code across all AWS service clients.
Scope
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.