feat: add support for new waiter expressions, upgrade Smithy to 1.22 (#672)

Author: ianbotsf

.changes/5bdddd68-7b25-4785-9a20-03790e330f27.json

@@ -0,0 +1,5 @@
+{
+    "id": "5bdddd68-7b25-4785-9a20-03790e330f27",
+    "type": "feature",
+    "description": "Add support for NOT, OR, and AND JMESPath expressions in waiters"
+}

.changes/ba998d36-ef93-4b63-8830-18e0f38c3b9a.json

@@ -0,0 +1,8 @@
+{
+    "id": "ba998d36-ef93-4b63-8830-18e0f38c3b9a",
+    "type": "misc",
+    "description": "Upgrade Smithy version to 1.22",
+    "issues": [
+        "awslabs/smithy-kotlin#599"
+    ]
+}

gradle.properties

@@ -24,7 +24,7 @@ jsoupVersion=1.14.3
 okHttpVersion=5.0.0-alpha.9
 
 # codegen
-smithyVersion=1.17.0
+smithyVersion=1.22.0
 smithyGradleVersion=0.5.3
 
 # testing/utility

runtime/utils/common/src/aws/smithy/kotlin/runtime/util/Convenience.kt

@@ -18,3 +18,16 @@ inline fun <reified T> Collection<T>.flattenIfPossible(): Collection<T> = this
 
 @JvmName("flattenNestedCollection")
 inline fun <reified T> Collection<Collection<T>>.flattenIfPossible(): Collection<T> = flatten()
+
+/**
+ * Evaluates the "truthiness" of a value based on
+ * [JMESPath definitions](https://jmespath.org/specification.html#or-expressions).
+ */
+fun truthiness(value: Any?): Boolean = when (value) {
+    is Boolean -> value
+    is Collection<*> -> value.isNotEmpty()
+    is Map<*, *> -> value.isNotEmpty()
+    is String -> value.isNotEmpty()
+    null -> false
+    else -> true
+}

smithy-kotlin-codegen/src/main/kotlin/software/amazon/smithy/kotlin/codegen/core/CodeWriterExt.kt renamed to smithy-kotlin-codegen/src/main/kotlin/software/amazon/smithy/kotlin/codegen/core/AbstractCodeWriterExt.kt

@@ -5,7 +5,8 @@
 package software.amazon.smithy.kotlin.codegen.core
 
 import software.amazon.smithy.kotlin.codegen.integration.SectionId
-import software.amazon.smithy.utils.CodeWriter
+import software.amazon.smithy.utils.AbstractCodeWriter
+import software.amazon.smithy.utils.SimpleCodeWriter
 import java.util.function.BiFunction
 
 /**
@@ -26,7 +27,7 @@ import java.util.function.BiFunction
  * writer.closeBlock("}")
  * ```
  */
-fun <T : CodeWriter> T.withBlock(
+fun <T : AbstractCodeWriter<T>> T.withBlock(
     textBeforeNewLine: String,
     textAfterNewLine: String,
     vararg args: Any,
@@ -36,7 +37,7 @@ fun <T : CodeWriter> T.withBlock(
 /**
  * Like [withBlock], except the closing write of [textAfterNewLine] does NOT include a line break.
  */
-fun <T : CodeWriter> T.withInlineBlock(
+fun <T : AbstractCodeWriter<T>> T.withInlineBlock(
     textBeforeNewLine: String,
     textAfterNewLine: String,
     vararg args: Any,
@@ -66,7 +67,7 @@ fun <T : CodeWriter> T.withInlineBlock(
  * if (foo == bar) writer.closeBlock("}")
  * ```
  */
-fun <T : CodeWriter> T.wrapBlockIf(
+fun <T : AbstractCodeWriter<T>> T.wrapBlockIf(
     condition: Boolean,
     textBeforeNewLine: String,
     textAfterNewLine: String,
@@ -80,9 +81,9 @@ fun <T : CodeWriter> T.wrapBlockIf(
 }
 
 /**
- * Like [CodeWriter.closeBlock], except the closing write of [textAfterNewLine] does NOT include a line break.
+ * Like [AbstractCodeWriter.closeBlock], except the closing write of [textAfterNewLine] does NOT include a line break.
  */
-fun <T : CodeWriter> T.closeInlineBlock(textAfterNewLine: String): T {
+fun <T : AbstractCodeWriter<T>> T.closeInlineBlock(textAfterNewLine: String): T {
     writeInline("\n")
     dedent()
     writeInline(textAfterNewLine)
@@ -103,7 +104,7 @@ fun <T : CodeWriter> T.closeInlineBlock(textAfterNewLine: String): T {
  *     .closeBlock("}")
  * ```
  */
-fun <T : CodeWriter> T.closeAndOpenBlock(
+fun <T : AbstractCodeWriter<T>> T.closeAndOpenBlock(
     textBeforeNewLine: String,
     vararg args: Any,
 ): T = apply {
@@ -116,7 +117,11 @@ fun <T : CodeWriter> T.closeAndOpenBlock(
  * of the type housing the codegen associated with the section. This keeps [SectionId]s closely
  * associated with their targets.
  */
-fun <T : CodeWriter> T.declareSection(id: SectionId, context: Map<String, Any?> = emptyMap(), block: T.() -> Unit = {}): T {
+fun <T : AbstractCodeWriter<T>> T.declareSection(
+    id: SectionId,
+    context: Map<String, Any?> = emptyMap(),
+    block: T.() -> Unit = { },
+): T {
     putContext(context)
     pushState(id.javaClass.canonicalName)
     block(this)
@@ -125,25 +130,27 @@ fun <T : CodeWriter> T.declareSection(id: SectionId, context: Map<String, Any?>
     return this
 }
 
-private fun <T : CodeWriter> T.removeContext(context: Map<String, Any?>): Unit =
+private fun <T : AbstractCodeWriter<T>> T.removeContext(context: Map<String, Any?>): Unit =
     context.keys.forEach { key -> removeContext(key) }
 
 /**
  * Convenience function to get a typed value out of the context or throw if the key doesn't exist
  * or the type is wrong
  */
-inline fun <reified T> CodeWriter.getContextValue(key: String): T = checkNotNull(getContext(key) as? T) {
-    "Expected `$key` in CodeWriter context"
-}
+inline fun <W : AbstractCodeWriter<W>, reified V> AbstractCodeWriter<W>.getContextValue(key: String): V =
+    checkNotNull(getContext(key) as? V) {
+        "Expected `$key` in CodeWriter context"
+    }
+
+typealias InlineCodeWriter = AbstractCodeWriter<*>.() -> Unit
 
-// Specifies a function that receives a [CodeWriter]
-typealias InlineCodeWriter = CodeWriter.() -> Unit
 /**
  * Formatter to enable passing a writing function
- * @param codeWriterCreator function that creates a new [CodeWriter] instance used to generate output of inline content
+ * @param codeWriterCreator function that creates a new [AbstractCodeWriter] instance used to generate output of inline
+ * content
  */
 class InlineCodeWriterFormatter(
-    private val codeWriterCreator: () -> CodeWriter = { CodeWriter() }
+    private val codeWriterCreator: () -> AbstractCodeWriter<*> = ::SimpleCodeWriter
 ) : BiFunction<Any, String, String> {
     @Suppress("UNCHECKED_CAST")
     override fun apply(t: Any, u: String): String {
@@ -158,7 +165,7 @@ class InlineCodeWriterFormatter(
  * Optionally call the [Runnable] if [test] is true, otherwise do nothing and return the instance without
  * running the block
  */
-fun CodeWriter.callIf(test: Boolean, runnable: Runnable): CodeWriter {
+fun <T : AbstractCodeWriter<T>> T.callIf(test: Boolean, runnable: Runnable): T {
     if (test) {
         runnable.run()
     }

smithy-kotlin-codegen/src/main/kotlin/software/amazon/smithy/kotlin/codegen/core/KotlinSymbolProvider.kt

@@ -13,6 +13,7 @@ import software.amazon.smithy.model.shapes.*
 import software.amazon.smithy.model.traits.BoxTrait
 import software.amazon.smithy.model.traits.SparseTrait
 import software.amazon.smithy.model.traits.StreamingTrait
+import software.amazon.smithy.model.traits.UniqueItemsTrait
 import java.util.logging.Logger
 
 /**
@@ -94,7 +95,7 @@ class KotlinSymbolProvider(private val model: Model, private val settings: Kotli
         createSymbolBuilder(shape, "String", boxed = true, namespace = "kotlin").build()
     }
 
-    fun createEnumSymbol(shape: StringShape): Symbol {
+    private fun createEnumSymbol(shape: StringShape): Symbol {
         val namespace = "$rootNamespace.model"
         return createSymbolBuilder(shape, shape.defaultName(service), namespace, boxed = true)
             .definitionFile("${shape.defaultName(service)}.kt")
@@ -146,12 +147,19 @@ class KotlinSymbolProvider(private val model: Model, private val settings: Kotli
     override fun listShape(shape: ListShape): Symbol {
         val reference = toSymbol(shape.member)
         val valueType = if (shape.hasTrait<SparseTrait>()) "${reference.name}?" else reference.name
-
-        return createSymbolBuilder(shape, "List<$valueType>", boxed = true)
-            .addReferences(reference)
-            .putProperty(SymbolProperty.MUTABLE_COLLECTION_FUNCTION, "mutableListOf<$valueType>")
-            .putProperty(SymbolProperty.IMMUTABLE_COLLECTION_FUNCTION, "listOf<$valueType>")
-            .build()
+        return if (shape.hasTrait<UniqueItemsTrait>()) {
+            createSymbolBuilder(shape, "Set<$valueType>", boxed = true)
+                .addReference(reference)
+                .putProperty(SymbolProperty.MUTABLE_COLLECTION_FUNCTION, "mutableSetOf<$valueType>")
+                .putProperty(SymbolProperty.IMMUTABLE_COLLECTION_FUNCTION, "setOf<$valueType>")
+                .build()
+        } else {
+            createSymbolBuilder(shape, "List<$valueType>", boxed = true)
+                .addReferences(reference)
+                .putProperty(SymbolProperty.MUTABLE_COLLECTION_FUNCTION, "mutableListOf<$valueType>")
+                .putProperty(SymbolProperty.IMMUTABLE_COLLECTION_FUNCTION, "listOf<$valueType>")
+                .build()
+        }
     }
 
     override fun mapShape(shape: MapShape): Symbol {
@@ -166,15 +174,6 @@ class KotlinSymbolProvider(private val model: Model, private val settings: Kotli
             .build()
     }
 
-    override fun setShape(shape: SetShape): Symbol {
-        val reference = toSymbol(shape.member)
-        return createSymbolBuilder(shape, "Set<${reference.name}>", boxed = true)
-            .addReference(reference)
-            .putProperty(SymbolProperty.MUTABLE_COLLECTION_FUNCTION, "mutableSetOf<${reference.name}>")
-            .putProperty(SymbolProperty.IMMUTABLE_COLLECTION_FUNCTION, "setOf<${reference.name}>")
-            .build()
-    }
-
     override fun memberShape(shape: MemberShape): Symbol {
         val targetShape =
             model.getShape(shape.target).orElseThrow { CodegenException("Shape not found: ${shape.target}") }

smithy-kotlin-codegen/src/main/kotlin/software/amazon/smithy/kotlin/codegen/core/KotlinWriter.kt

@@ -22,7 +22,7 @@ import software.amazon.smithy.model.shapes.MemberShape
 import software.amazon.smithy.model.shapes.Shape
 import software.amazon.smithy.model.traits.DocumentationTrait
 import software.amazon.smithy.model.traits.EnumDefinition
-import software.amazon.smithy.utils.CodeWriter
+import software.amazon.smithy.utils.AbstractCodeWriter
 import java.util.function.BiFunction
 
 /**
@@ -42,16 +42,18 @@ class KotlinWriter(
     val fullyQualifiedSymbols: MutableSet<FullyQualifiedSymbolName> = mutableSetOf(),
     val dependencies: MutableSet<SymbolDependency> = mutableSetOf(),
     val imports: ImportDeclarations = ImportDeclarations()
-) : CodeWriter() {
+) : AbstractCodeWriter<KotlinWriter>() {
 
     init {
         trimBlankLines()
         trimTrailingSpaces()
-        setIndentText("    ")
+
+        indentText = "    "
         expressionStart = '#'
 
         // type name: `Foo`
         putFormatter('T', KotlinSymbolFormatter(this) { symbol -> fullyQualifiedSymbols.contains(symbol.toFullyQualifiedSymbolName()) })
+
         // fully qualified type: `aws.sdk.kotlin.model.Foo`
         putFormatter('Q', KotlinSymbolFormatter(this) { true })
 
@@ -173,7 +175,7 @@ class KotlinWriter(
     fun dokka(block: KotlinWriter.() -> Unit): KotlinWriter {
         pushState()
         write("/**")
-        setNewlinePrefix(" * ")
+        newlinePrefix = " * "
         block(this)
         popState()
         write(" */")
@@ -234,7 +236,7 @@ class KotlinWriter(
 /**
  * Registers a [SectionWriter] given a [SectionId] to a specific writer.  This will cause the
  * [SectionWriter.write] to be called at the point in which the section is declared via
- * the [CodeWriter.declareSection] function.
+ * the [declareSection] function.
  */
 fun KotlinWriter.registerSectionWriter(id: SectionId, writer: SectionWriter): KotlinWriter {
     onSection(id.javaClass.canonicalName) { default ->
@@ -334,7 +336,7 @@ class KotlinPropertyFormatter(
 typealias InlineKotlinWriter = KotlinWriter.() -> Unit
 /**
  * Formatter to enable passing a writing function
- * @param codeWriterCreator function that creates a new [CodeWriter] instance used to generate output of inline content
+ * @param parent a [KotlinWriter] which provides inherited state for this inner writer.
  */
 class InlineKotlinWriterFormatter(private val parent: KotlinWriter) : BiFunction<Any, String, String> {
     @Suppress("UNCHECKED_CAST")
@@ -351,14 +353,6 @@ class InlineKotlinWriterFormatter(private val parent: KotlinWriter) : BiFunction
     }
 }
 
-// Remove all strings from source string and return the result
-private fun String.stripAll(stripList: List<String>): String {
-    var newStr = this
-    for (item in stripList) newStr = newStr.replace(item, "")
-
-    return newStr
-}
-
 // Remove leading, trailing, and consecutive blank lines
 private fun formatDocumentation(doc: String, lineSeparator: String = "\n") =
     doc

smithy-kotlin-codegen/src/main/kotlin/software/amazon/smithy/kotlin/codegen/core/RuntimeTypes.kt

@@ -137,6 +137,7 @@ object RuntimeTypes {
         val AttributeKey = runtimeSymbol("AttributeKey", KotlinDependency.UTILS)
         val flattenIfPossible = runtimeSymbol("flattenIfPossible", KotlinDependency.UTILS)
         val length = runtimeSymbol("length", KotlinDependency.UTILS)
+        val truthiness = runtimeSymbol("truthiness", KotlinDependency.UTILS)
         val urlEncodeComponent = runtimeSymbol("urlEncodeComponent", KotlinDependency.UTILS, "text")
     }
 

smithy-kotlin-codegen/src/main/kotlin/software/amazon/smithy/kotlin/codegen/model/SetRefactorPreprocessor.kt

@@ -0,0 +1,41 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0.
+ */
+package software.amazon.smithy.kotlin.codegen.model
+
+import software.amazon.smithy.kotlin.codegen.KotlinSettings
+import software.amazon.smithy.kotlin.codegen.integration.KotlinIntegration
+import software.amazon.smithy.model.Model
+import software.amazon.smithy.model.shapes.CollectionShape
+import software.amazon.smithy.model.shapes.ListShape
+import software.amazon.smithy.model.shapes.Shape
+import software.amazon.smithy.model.traits.UniqueItemsTrait
+import software.amazon.smithy.model.transform.ModelTransformer
+
+/**
+ * Replaces deprecated Smithy `set` shapes with `list` shapes annotated with the `@uniqueItems` trait. This transformer
+ * should only be necessary until all models have migrated away from `set` shapes.
+ */
+class SetRefactorPreprocessor : KotlinIntegration {
+    override fun preprocessModel(model: Model, settings: KotlinSettings): Model {
+        val replaced = model
+            .shapeIds
+            .map(model::expectShape)
+            .mapNotNull(::toSetShapeOrNull)
+            .map(::toUniqueValuedList)
+
+        return ModelTransformer.create().replaceShapes(model, replaced)
+    }
+}
+
+// Necessary to suppress deprecation because we're detecting deprecated shapes!
+@Suppress("DEPRECATION")
+private fun toSetShapeOrNull(shape: Shape) = shape as? software.amazon.smithy.model.shapes.SetShape
+
+private fun toUniqueValuedList(shape: CollectionShape): ListShape = ListShape
+    .builder()
+    .id(shape.id)
+    .member(shape.member)
+    .traits(shape.allTraits.values + UniqueItemsTrait())
+    .build()

smithy-kotlin-codegen/src/main/kotlin/software/amazon/smithy/kotlin/codegen/model/knowledge/SerdeIndex.kt

@@ -129,7 +129,6 @@ private fun walkNestedShapesRequiringSerde(model: Model, shapes: Set<Shape>): Se
                 RelationshipType.MEMBER_TARGET,
                 RelationshipType.STRUCTURE_MEMBER,
                 RelationshipType.LIST_MEMBER,
-                RelationshipType.SET_MEMBER,
                 RelationshipType.MAP_VALUE,
                 RelationshipType.UNION_MEMBER -> true
                 else -> false