feat: remove deprecated shapes since one date until another date (#1100)

Author: lauzadis

.changes/c79af2ed-bfad-4196-bf5c-87d647ecbcd1.json

@@ -0,0 +1,6 @@
+{
+    "id": "c79af2ed-bfad-4196-bf5c-87d647ecbcd1",
+    "type": "feature",
+    "description": "**BREAKING**: Remove operations/fields which were marked deprecated before 11/28/2023. See [this discussion post](https://github.com/awslabs/aws-sdk-kotlin/discussions/1103) for more details.",
+    "requiresMinorVersionBump": true
+}

codegen/sdk/build.gradle.kts

@@ -112,7 +112,7 @@ fun awsServiceProjections(): Provider<List<SmithyProjection>> {
                     importPaths.add(service.modelExtrasDir)
                 }
                 imports = importPaths
-                transforms = transformsForService(service) ?: emptyList()
+                transforms = (transformsForService(service) ?: emptyList()) + removeDeprecatedShapesTransform("2023-11-28")
 
                 smithyKotlinPlugin {
                     serviceShapeId = service.serviceShapeId
@@ -155,6 +155,15 @@ fun transformsForService(service: AwsService): List<String>? {
     }
 }
 
+fun removeDeprecatedShapesTransform(removeDeprecatedShapesUntil: String): String = """
+    {
+        "name": "AwsSdkKotlinRemoveDeprecatedShapes",
+        "args": {
+            "until": "$removeDeprecatedShapesUntil"
+        }
+    }
+""".trimIndent()
+
 val discoveredServices: List<AwsService> by lazy { discoverServices() }
 
 // The root namespace prefix for SDKs

codegen/smithy-aws-kotlin-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/transforms/RemoveDeprecatedShapes.kt

@@ -0,0 +1,56 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+package aws.sdk.kotlin.codegen.transforms
+
+import software.amazon.smithy.build.TransformContext
+import software.amazon.smithy.build.transforms.ConfigurableProjectionTransformer
+import software.amazon.smithy.kotlin.codegen.model.getTrait
+import software.amazon.smithy.kotlin.codegen.utils.getOrNull
+import software.amazon.smithy.model.Model
+import software.amazon.smithy.model.shapes.Shape
+import software.amazon.smithy.model.traits.DeprecatedTrait
+import java.time.DateTimeException
+import java.time.LocalDate
+import java.time.format.DateTimeFormatter
+import java.util.function.Predicate
+
+// A date formatter used to parse Smithy @deprecated trait's `since` field
+private val DEPRECATED_SINCE_DATE_FORMATTER = DateTimeFormatter.ofPattern("yyyy-MM-dd")
+
+class RemoveDeprecatedShapes : ConfigurableProjectionTransformer<RemoveDeprecatedShapes.Config>() {
+    class Config {
+        var until: String = "1970-01-01" // yyyy-MM-dd
+    }
+
+    override fun getName(): String = "AwsSdkKotlinRemoveDeprecatedShapes"
+
+    override fun getConfigType(): Class<Config> = Config::class.java
+
+    /**
+     * Filter out shapes which have a [DeprecatedTrait] with a `since` property _date_ set, up to [Config.until].
+     * NOTE: Smithy supports modeling `since` as a version _or_ date, this transformer only considers those modeled as a date.
+     */
+    override fun transformWithConfig(context: TransformContext, config: Config): Model {
+        val until = requireNotNull(config.until.toLocalDate()) { "Failed to parse configured `until` date ${config.until}" }
+        println("Removing deprecated shapes using the configured `until` date $until")
+
+        return context.transformer.removeShapesIf(context.model, shouldRemoveDeprecatedShape(until))
+    }
+}
+
+internal fun shouldRemoveDeprecatedShape(removeDeprecatedShapesUntil: LocalDate) = Predicate<Shape> { shape ->
+    val since = shape.getTrait<DeprecatedTrait>()?.since?.getOrNull() ?: return@Predicate false
+
+    val deprecatedDate = since.toLocalDate() ?: return@Predicate false.also {
+        println("Failed to parse `since` field $since as a date, skipping removal of deprecated shape $shape")
+    }
+
+    deprecatedDate < removeDeprecatedShapesUntil
+}
+
+/**
+ * Parses a string of yyyy-MM-dd format to [LocalDate], returning `null` if parsing fails.
+ */
+internal fun String.toLocalDate(): LocalDate? = try { LocalDate.parse(this, DEPRECATED_SINCE_DATE_FORMATTER) } catch (e: DateTimeException) { null }

codegen/smithy-aws-kotlin-codegen/src/main/resources/META-INF/services/software.amazon.smithy.build.ProjectionTransformer

@@ -1 +1,2 @@
-aws.sdk.kotlin.codegen.transforms.IncludeOperations
+aws.sdk.kotlin.codegen.transforms.IncludeOperations
+aws.sdk.kotlin.codegen.transforms.RemoveDeprecatedShapes

codegen/smithy-aws-kotlin-codegen/src/test/kotlin/aws/sdk/kotlin/codegen/transforms/RemoveDeprecatedShapesTest.kt

@@ -0,0 +1,54 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+package aws.sdk.kotlin.codegen.transforms
+
+import software.amazon.smithy.model.shapes.FloatShape
+import software.amazon.smithy.model.shapes.Shape
+import software.amazon.smithy.model.shapes.ShapeId
+import software.amazon.smithy.model.traits.DeprecatedTrait
+import kotlin.test.Test
+import kotlin.test.assertFalse
+import kotlin.test.assertTrue
+
+class RemoveDeprecatedShapesTest {
+    private fun shapeDeprecatedSince(since: String?): Shape {
+        val deprecatedTrait = DeprecatedTrait.builder()
+            .since(since)
+            .build()
+
+        return FloatShape.builder()
+            .addTrait(deprecatedTrait)
+            .id(ShapeId.from("aws.sdk.kotlin#testing"))
+            .build()
+    }
+
+    @Test
+    fun testShouldBeRemoved() {
+        val shape = shapeDeprecatedSince("2022-01-01")
+        val removeDeprecatedShapesUntil = "2023-01-01".toLocalDate()!!
+        assertTrue(shouldRemoveDeprecatedShape(removeDeprecatedShapesUntil).test(shape))
+    }
+
+    @Test
+    fun testShouldNotBeRemoved() {
+        val shape = shapeDeprecatedSince("2024-01-01")
+        val removeDeprecatedShapesUntil = "2023-01-01".toLocalDate()!!
+        assertFalse(shouldRemoveDeprecatedShape(removeDeprecatedShapesUntil).test(shape))
+    }
+
+    @Test
+    fun testShouldNotBeRemovedIfDeprecatedSameDay() {
+        val shape = shapeDeprecatedSince("2023-01-01")
+        val removeDeprecatedShapesUntil = "2023-01-01".toLocalDate()!!
+        assertFalse(shouldRemoveDeprecatedShape(removeDeprecatedShapesUntil).test(shape))
+    }
+
+    @Test
+    fun testShouldNotBeRemovedIfMissingSinceField() {
+        val shape = shapeDeprecatedSince(null)
+        val removeDeprecatedShapesUntil = "2023-01-01".toLocalDate()!!
+        assertFalse(shouldRemoveDeprecatedShape(removeDeprecatedShapesUntil).test(shape))
+    }
+}