chore: Build service clients with exact dependencies (#953)

Author: jbelkins

smithy-swift-codegen/src/main/kotlin/software/amazon/smithy/swift/codegen/DirectedSwiftCodegen.kt

@@ -98,8 +98,15 @@ class DirectedSwiftCodegen(
             LOGGER.info("[${service.id}] Generating smoke tests for service")
             generateSmokeTests(ctx)
 
-            LOGGER.info("Generating package manifest file")
-            PackageManifestGenerator(ctx).writePackageManifest(writers.dependencies)
+            if (settings.generatePackageManifest) {
+                LOGGER.info("Generating package manifest file")
+                PackageManifestGenerator(ctx).writePackageManifest(writers.dependencies)
+            }
+
+            if (settings.generateDependencyJSON) {
+                LOGGER.info("Generating dependency JSON file")
+                DependencyJSONGenerator(ctx).writePackageJSON(writers.dependencies)
+            }
 
             LOGGER.info("Flushing swift writers")
             writers.flushWriters()

smithy-swift-codegen/src/main/kotlin/software/amazon/smithy/swift/codegen/PackageManifestGenerator.kt

@@ -8,13 +8,11 @@ import software.amazon.smithy.codegen.core.SymbolDependency
 import software.amazon.smithy.swift.codegen.integration.ProtocolGenerator
 import kotlin.jvm.optionals.getOrNull
 
-val PACKAGE_MANIFEST_NAME = "Package.swift.txt"
-
 class PackageManifestGenerator(
     val ctx: ProtocolGenerator.GenerationContext,
 ) {
     fun writePackageManifest(dependencies: List<SymbolDependency>) {
-        ctx.delegator.useFileWriter(PACKAGE_MANIFEST_NAME) { writer ->
+        ctx.delegator.useFileWriter("Package.swift") { writer ->
             writer.write("// swift-tools-version: \$L", ctx.settings.swiftVersion)
             writer.write("")
             writer.write("import PackageDescription")

smithy-swift-codegen/src/main/kotlin/software/amazon/smithy/swift/codegen/ServiceClientJSONGenerator.kt

@@ -0,0 +1,39 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0.
+ */
+package software.amazon.smithy.swift.codegen
+
+import software.amazon.smithy.codegen.core.SymbolDependency
+import software.amazon.smithy.swift.codegen.integration.ProtocolGenerator
+import kotlin.jvm.optionals.getOrNull
+
+val DEPENDENCY_JSON_NAME = "Dependencies.json"
+
+class DependencyJSONGenerator(
+    val ctx: ProtocolGenerator.GenerationContext,
+) {
+    fun writePackageJSON(dependencies: List<SymbolDependency>) {
+        ctx.delegator.useFileWriter(DEPENDENCY_JSON_NAME) { writer ->
+            writer.openBlock("[", "]") {
+                val externalDependencies =
+                    dependencies
+                        .filter {
+                            it.getProperty("url", String::class.java).getOrNull() != null ||
+                                it.getProperty("scope", String::class.java).getOrNull() != null
+                        }
+
+                val dependenciesByTarget =
+                    externalDependencies
+                        .distinctBy { it.targetName() + it.packageName }
+                        .sortedBy { it.targetName() }
+
+                dependenciesByTarget.forEach { writer.write("\$S,", it.targetName()) }
+                writer.unwrite(",\n")
+                writer.write("")
+            }
+        }
+    }
+}
+
+private fun SymbolDependency.targetName(): String = expectProperty("target", String::class.java)

smithy-swift-codegen/src/main/kotlin/software/amazon/smithy/swift/codegen/SwiftDependency.kt

@@ -40,7 +40,7 @@ class SwiftDependency(
                 "",
                 "",
                 "",
-                SwiftDependency.DistributionMethod.GIT,
+                DistributionMethod.GIT,
             )
         val XCTest =
             SwiftDependency(
@@ -60,11 +60,8 @@ class SwiftDependency(
         val SMITHY_HTTP_API = smithySwiftDependency("SmithyHTTPAPI")
         val SMITHY_HTTP_AUTH_API = smithySwiftDependency("SmithyHTTPAuthAPI")
         val SMITHY_HTTP_AUTH = smithySwiftDependency("SmithyHTTPAuth")
-        val SMITHY_CHECKSUMS_API = smithySwiftDependency("SmithyChecksumsAPI")
-        val SMITHY_CHECKSUMS = smithySwiftDependency("SmithyChecksums")
         val SMITHY_STREAMS = smithySwiftDependency("SmithyStreams")
         val SMITHY_EVENT_STREAMS_API = smithySwiftDependency("SmithyEventStreamsAPI")
-        val SMITHY_EVENT_STREAMS_AUTH_API = smithySwiftDependency("SmithyEventStreamsAuthAPI")
         val SMITHY_EVENT_STREAMS = smithySwiftDependency("SmithyEventStreams")
         val SMITHY_TEST_UTIL = smithySwiftDependency("SmithyTestUtil")
         val SMITHY_READ_WRITE = smithySwiftDependency("SmithyReadWrite")

smithy-swift-codegen/src/main/kotlin/software/amazon/smithy/swift/codegen/SwiftSettings.kt

@@ -38,7 +38,8 @@ private const val MERGE_MODELS = "mergeModels"
 private const val COPYRIGHT_NOTICE = "copyrightNotice"
 private const val VISIBILITY = "visibility"
 private const val INTERNAL_CLIENT = "internalClient"
-private const val FOR_PROTOCOL_TESTS = "forProtocolTests"
+private const val GENERATE_PACKAGE_MANIFEST = "generatePackageManifest"
+private const val GENERATE_DEPENDENCY_JSON = "generateDependencyJSON"
 
 // Prioritized list of protocols supported for code generation
 private val DEFAULT_PROTOCOL_RESOLUTION_PRIORITY =
@@ -66,7 +67,8 @@ class SwiftSettings(
     val copyrightNotice: String,
     val visibility: String,
     val internalClient: Boolean,
-    val forProtocolTests: Boolean,
+    val generatePackageManifest: Boolean,
+    val generateDependencyJSON: Boolean,
 ) {
     companion object {
         private val LOGGER: Logger = Logger.getLogger(SwiftSettings::class.java.name)
@@ -97,7 +99,9 @@ class SwiftSettings(
                     MERGE_MODELS,
                     COPYRIGHT_NOTICE,
                     VISIBILITY,
-                    FOR_PROTOCOL_TESTS,
+                    INTERNAL_CLIENT,
+                    GENERATE_PACKAGE_MANIFEST,
+                    GENERATE_DEPENDENCY_JSON,
                 ),
             )
 
@@ -123,7 +127,8 @@ class SwiftSettings(
                 )
             val visibility = config.getStringMemberOrDefault(VISIBILITY, "public")
             val internalClient = config.getBooleanMemberOrDefault(INTERNAL_CLIENT, false)
-            val forProtocolTests = config.getBooleanMemberOrDefault(FOR_PROTOCOL_TESTS, false)
+            val generatePackageManifest = config.getBooleanMemberOrDefault(GENERATE_PACKAGE_MANIFEST, true)
+            val generateDependencyJSON = config.getBooleanMemberOrDefault(GENERATE_DEPENDENCY_JSON, false)
 
             return SwiftSettings(
                 serviceId,
@@ -139,7 +144,8 @@ class SwiftSettings(
                 copyrightNotice,
                 visibility,
                 internalClient,
-                forProtocolTests,
+                generatePackageManifest,
+                generateDependencyJSON,
             )
         }
 

smithy-swift-codegen/src/main/kotlin/software/amazon/smithy/swift/codegen/SwiftWriter.kt

@@ -174,7 +174,7 @@ class SwiftWriter(
         //
         // Also leave out the headers when JSON or the version file is being written,
         // as indicated by the file extension.
-        val isPackageManifest = listOf(PACKAGE_MANIFEST_NAME, (PACKAGE_MANIFEST_NAME + ".swift")).contains(fullPackageName)
+        val isPackageManifest = fullPackageName == "Package"
         val isNonSwiftSourceFile = listOf(".json", ".version").any { fullPackageName.endsWith(it) }
         val noHeader = isPackageManifest || isNonSwiftSourceFile
         return contents.takeIf { noHeader } ?: (copyrightNotice + imports + contents)

smithy-swift-codegen/src/test/kotlin/software/amazon/smithy/swift/codegen/codegencomponents/SwiftSettingsTest.kt

@@ -193,8 +193,9 @@ class SwiftSettingsTest {
             mergeModels = false,
             copyrightNotice = "// Test copyright",
             visibility = "public",
-            forProtocolTests = false,
             internalClient = false,
+            generatePackageManifest = false,
+            generateDependencyJSON = true,
         )
 
     private fun createServiceWithProtocols(protocols: Set<ShapeId>): ServiceShape {

smithy-swift-codegen/src/test/kotlin/software/amazon/smithy/swift/codegen/manifestanddocs/PackageManifestGeneratorTests.kt

@@ -19,14 +19,14 @@ class PackageManifestGeneratorTests {
 
     @Test
     fun `it starts with a swift-tools-version statement`() {
-        val packageManifest = testContext.manifest.getFileString("Package.swift.txt").get()
+        val packageManifest = testContext.manifest.getFileString("Package.swift").get()
         assertNotNull(packageManifest)
         packageManifest.shouldStartWith("// swift-tools-version: 5.5.0")
     }
 
     @Test
     fun `it renders package manifest file with macOS and iOS platforms block`() {
-        val packageManifest = testContext.manifest.getFileString("Package.swift.txt").get()
+        val packageManifest = testContext.manifest.getFileString("Package.swift").get()
         assertNotNull(packageManifest)
         val expected = """
     platforms: [
@@ -38,7 +38,7 @@ class PackageManifestGeneratorTests {
 
     @Test
     fun `it renders package manifest file with single library in product block`() {
-        val packageManifest = testContext.manifest.getFileString("Package.swift.txt").get()
+        val packageManifest = testContext.manifest.getFileString("Package.swift").get()
         assertNotNull(packageManifest)
         val expected = """
     products: [
@@ -50,7 +50,7 @@ class PackageManifestGeneratorTests {
 
     @Test
     fun `it renders package manifest file with target and test target`() {
-        val packageManifest = testContext.manifest.getFileString("Package.swift.txt").get()
+        val packageManifest = testContext.manifest.getFileString("Package.swift").get()
         assertNotNull(packageManifest)
         val expected = """
     targets: [

smithy-swift-codegen/src/test/kotlin/software/amazon/smithy/swift/codegen/manifestanddocs/ServiceClientJSONManifestGeneratorTests.kt

@@ -0,0 +1,42 @@
+package software.amazon.smithy.swift.codegen.manifestanddocs
+
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0.
+ */
+
+import io.kotest.matchers.string.shouldContain
+import org.junit.jupiter.api.Assertions.assertNotNull
+import org.junit.jupiter.api.Test
+import software.amazon.smithy.swift.codegen.DependencyJSONGenerator
+import software.amazon.smithy.swift.codegen.TestContext
+import software.amazon.smithy.swift.codegen.defaultSettings
+import software.amazon.smithy.swift.codegen.protocolgeneratormocks.MockHTTPAWSJson11ProtocolGenerator
+
+class ServiceClientJSONManifestGeneratorTests {
+    private val testContext = setupTests("simple-service-with-operation-and-dependency.smithy", "smithy.example#Example")
+
+    @Test
+    fun `it renders package manifest JSON with dependencies`() {
+        val packageManifest = testContext.manifest.getFileString("Dependencies.json").get()
+        assertNotNull(packageManifest)
+        val expected = """[
+
+]
+"""
+        packageManifest.shouldContain(expected)
+    }
+
+    private fun setupTests(
+        smithyFile: String,
+        serviceShapeId: String,
+    ): TestContext {
+        val context =
+            TestContext.initContextFrom(smithyFile, serviceShapeId, MockHTTPAWSJson11ProtocolGenerator()) { model ->
+                model.defaultSettings(serviceShapeId, "MockSDK", "2019-12-16", "MockSDKID")
+            }
+        DependencyJSONGenerator(context.generationCtx).writePackageJSON(context.generationCtx.delegator.dependencies)
+        context.generationCtx.delegator.flushWriters()
+        return context
+    }
+}