software.amazon.smithy.kotlin.codegen.transforms.RemoveDeprecatedShapes.kt Maven / Gradle / Ivy

Go to download
/*
 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 * SPDX-License-Identifier: Apache-2.0
 */
package software.amazon.smithy.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() {
    class Config {
        var until: String = "1970-01-01" // yyyy-MM-dd
    }

    override fun getName(): String = "awsSmithyKotlinRemoveDeprecatedShapes"

    override fun getConfigType(): Class = 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 ->
    val since = shape.getTrait()?.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 }