misc: generate internal-only clients with internal visibility (#1045)

awslabs · Sep 19, 2023 · 231224f · 231224f
1 parent 7b5747a
commit 231224f
Show file tree

Hide file tree

Showing 6 changed files with 39 additions and 1,490 deletions.
diff --git a/.changes/1371764e-c78a-4127-935c-407d11574af7.json b/.changes/1371764e-c78a-4127-935c-407d11574af7.json
@@ -0,0 +1,5 @@
+{
+    "id": "1371764e-c78a-4127-935c-407d11574af7",
+    "type": "misc",
+    "description": "Generate internal-only clients with `internal` visibility"
+}
diff --git a/aws-runtime/aws-config/api/aws-config.api b/aws-runtime/aws-config/api/aws-config.api
diff --git a/aws-runtime/aws-config/build.gradle.kts b/aws-runtime/aws-config/build.gradle.kts
@@ -114,9 +114,11 @@ codegen {
                     generateDefaultBuildFiles = false
                     generateFullProject = false
                 }
+                apiSettings {
+                    visibility = "internal"
+                }
             }
 
-            // TODO - could we add a trait such that we change visibility to `internal` or a build setting...?
             transforms = listOf(
                 """
                 {
@@ -149,6 +151,9 @@ codegen {
                     generateDefaultBuildFiles = false
                     generateFullProject = false
                 }
+                apiSettings {
+                    visibility = "internal"
+                }
             }
 
             transforms = listOf(
@@ -181,6 +186,9 @@ codegen {
                     generateDefaultBuildFiles = false
                     generateFullProject = false
                 }
+                apiSettings {
+                    visibility = "internal"
+                }
             }
 
             transforms = listOf(

diff --git a/.../smithy-aws-kotlin-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/AwsEndpointDelegator.kt b/.../smithy-aws-kotlin-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/AwsEndpointDelegator.kt
@@ -43,7 +43,7 @@ class AwsEndpointDelegator : EndpointDelegator {
         val defaultProviderSymbol = DefaultEndpointProviderGenerator.getSymbol(ctx.settings)
 
         ctx.delegator.useFileWriter(providerSymbol) {
-            EndpointProviderGenerator(it, providerSymbol, paramsSymbol).render()
+            EndpointProviderGenerator(it, ctx.settings, providerSymbol, paramsSymbol).render()
         }
 
         val endpointFunctions = buildMap {
@@ -58,7 +58,7 @@ class AwsEndpointDelegator : EndpointDelegator {
         }
         if (rules != null) {
             ctx.delegator.useFileWriter(defaultProviderSymbol) {
-                DefaultEndpointProviderGenerator(it, rules, defaultProviderSymbol, providerSymbol, paramsSymbol, endpointFunctions, awsEndpointPropertyRenderers).render()
+                DefaultEndpointProviderGenerator(it, rules, defaultProviderSymbol, providerSymbol, paramsSymbol, ctx.settings, endpointFunctions, awsEndpointPropertyRenderers).render()
             }
         }
     }

diff --git a/...n/src/main/kotlin/aws/sdk/kotlin/codegen/protocols/core/AwsHttpProtocolClientGenerator.kt b/...n/src/main/kotlin/aws/sdk/kotlin/codegen/protocols/core/AwsHttpProtocolClientGenerator.kt
@@ -34,7 +34,11 @@ open class AwsHttpProtocolClientGenerator(
 
     override fun render(writer: KotlinWriter) {
         writer.write("\n\n")
-        writer.write("public const val ServiceApiVersion: String = #S", ctx.service.version)
+        writer.write(
+            "#L const val ServiceApiVersion: String = #S",
+            ctx.settings.api.visibility,
+            ctx.service.version,
+        )
         writer.write("\n\n")
         // set AWS specific span attributes for an operation
         // https://opentelemetry.io/docs/reference/specification/trace/semantic_conventions/instrumentation/aws-sdk/

diff --git a/...k-plugins/src/main/kotlin/aws/sdk/kotlin/gradle/codegen/dsl/SmithyKotlinPluginSettings.kt b/...k-plugins/src/main/kotlin/aws/sdk/kotlin/gradle/codegen/dsl/SmithyKotlinPluginSettings.kt
@@ -11,6 +11,16 @@ import software.amazon.smithy.model.node.ObjectNode
 import software.amazon.smithy.model.node.ToNode
 import java.util.*
 
+class SmithyKotlinApiSettings : ToNode {
+    var visibility: String? = null
+
+    override fun toNode(): Node {
+        val builder = ObjectNode.objectNodeBuilder()
+        builder.withNullableMember("visibility", visibility)
+        return builder.build()
+    }
+}
+
 class SmithyKotlinBuildSettings : ToNode {
     var generateFullProject: Boolean? = null
     var generateDefaultBuildFiles: Boolean? = null
@@ -24,6 +34,7 @@ class SmithyKotlinBuildSettings : ToNode {
 
         val optInArrNode = optInAnnotations?.map { Node.from(it) }?.let { ArrayNode.fromNodes(it) }
         builder.withOptionalMember("optInAnnotations", Optional.ofNullable(optInArrNode))
+
         return builder.build()
     }
 }
@@ -43,6 +54,12 @@ class SmithyKotlinPluginSettings : SmithyBuildPlugin {
         buildSettings!!.apply(configure)
     }
 
+    internal var apiSettings: SmithyKotlinApiSettings? = null
+    fun apiSettings(configure: SmithyKotlinApiSettings.() -> Unit) {
+        if (apiSettings == null) apiSettings = SmithyKotlinApiSettings()
+        apiSettings!!.apply(configure)
+    }
+
     override fun equals(other: Any?): Boolean {
         if (this === other) return true
         if (javaClass != other?.javaClass) return false
@@ -79,6 +96,7 @@ class SmithyKotlinPluginSettings : SmithyBuildPlugin {
             }
             .withNullableMember("sdkId", sdkId)
             .withNullableMember("build", buildSettings)
+            .withNullableMember("api", apiSettings)
 
         return obj.build()
     }