rename setting and update changelogs

rcoh · rcoh · commit 2285ff8ad975 · 2025-10-16T10:48:40.000-04:00
diff --git a/.changelog/1760625617.md b/.changelog/1760625617.md
@@ -0,0 +1,15 @@
+---
+applies_to:
+- client
+- aws-sdk-rust
+authors:
+- rcoh
+references: ["smithy-rs#4352", "smithy-rs#4353"]
+breaking: false
+new_feature: false
+bug_fix: true
+---
+Update clients to allow `initial-response` events to be accepted on event streams, even when know modeled initial response exists.
+
+This is required for spec compliance, backwards compatibility, and compatibility with non-smithy-rs based servers that
+MAY unconditionally send `initial-response` messages.
diff --git a/.changelog/1760625769.md b/.changelog/1760625769.md
@@ -0,0 +1,23 @@
+---
+applies_to:
+- server
+authors:
+- rcoh
+references: ["smithy-rs#4352", "smithy-rs#4345"]
+breaking: false
+new_feature: true
+bug_fix: true
+---
+Update smithy-rs servers to support sending `initial-response` events over event streams.
+
+Prior to this change, event streams that had initial responses were unsupported. This change also adds a new codegen setting, `alwaysSendEventStreamInitialResponse`.
+
+When this setting is set to `true`, the generated server will unconditionally send `initial-response` objects, even when empty. This is required for compatibility with smithy-java as well as a few other clients.
+
+This setting defaults to false currently because smithy-rs based clients do not currently support this behavior.
+
+```json
+"codegen": {
+  "alwaysSendEventStreamInitialResponse": true // default false
+}
+```
diff --git a/codegen-core/src/main/kotlin/software/amazon/smithy/rust/codegen/core/testutil/CodegenIntegrationTest.kt b/codegen-core/src/main/kotlin/software/amazon/smithy/rust/codegen/core/testutil/CodegenIntegrationTest.kt
@@ -49,38 +49,39 @@ data class IntegrationTestParams(
 sealed class AdditionalSettings {
     abstract fun toObjectNode(): ObjectNode
 
-    abstract class CoreAdditionalSettings protected constructor(val settings: List<AdditionalSettings>) : AdditionalSettings() {
-        override fun toObjectNode(): ObjectNode {
-            val merged =
-                settings.map { it.toObjectNode() }
-                    .reduce { acc, next -> acc.merge(next) }
-
-            return ObjectNode.builder()
-                .withMember("codegen", merged)
-                .build()
-        }
+    abstract class CoreAdditionalSettings protected constructor(val settings: List<AdditionalSettings>) :
+        AdditionalSettings() {
+            override fun toObjectNode(): ObjectNode {
+                val merged =
+                    settings.map { it.toObjectNode() }
+                        .reduce { acc, next -> acc.merge(next) }
+
+                return ObjectNode.builder()
+                    .withMember("codegen", merged)
+                    .build()
+            }
 
-        abstract class Builder<T : CoreAdditionalSettings> : AdditionalSettings() {
-            protected val settings = mutableListOf<AdditionalSettings>()
+            abstract class Builder<T : CoreAdditionalSettings> : AdditionalSettings() {
+                protected val settings = mutableListOf<AdditionalSettings>()
 
-            fun generateCodegenComments(debugMode: Boolean = true): Builder<T> {
-                settings.add(GenerateCodegenComments(debugMode))
-                return this
-            }
+                fun generateCodegenComments(debugMode: Boolean = true): Builder<T> {
+                    settings.add(GenerateCodegenComments(debugMode))
+                    return this
+                }
 
-            abstract fun build(): T
+                abstract fun build(): T
 
-            override fun toObjectNode(): ObjectNode = build().toObjectNode()
-        }
+                override fun toObjectNode(): ObjectNode = build().toObjectNode()
+            }
 
-        // Core settings that are common to both Servers and Clients should be defined here.
-        data class GenerateCodegenComments(val debugMode: Boolean) : AdditionalSettings() {
-            override fun toObjectNode(): ObjectNode =
-                ObjectNode.builder()
-                    .withMember("debugMode", debugMode)
-                    .build()
+            // Core settings that are common to both Servers and Clients should be defined here.
+            data class GenerateCodegenComments(val debugMode: Boolean) : AdditionalSettings() {
+                override fun toObjectNode(): ObjectNode =
+                    ObjectNode.builder()
+                        .withMember("debugMode", debugMode)
+                        .build()
+            }
         }
-    }
 }
 
 class ClientAdditionalSettings private constructor(settings: List<AdditionalSettings>) :
@@ -109,8 +110,8 @@ class ServerAdditionalSettings private constructor(settings: List<AdditionalSett
                 return this
             }
 
-            fun sendEventStreamInitialResponse(enabled: Boolean = true): Builder {
-                settings.add(SendEventStreamInitialResponse(enabled))
+            fun alwaysSendEventStreamInitialResponse(enabled: Boolean = true): Builder {
+                settings.add(AlwaysSendEventStreamInitialResponse(enabled))
                 return this
             }
 
@@ -131,10 +132,10 @@ class ServerAdditionalSettings private constructor(settings: List<AdditionalSett
                     .build()
         }
 
-        private data class SendEventStreamInitialResponse(val enabled: Boolean) : AdditionalSettings() {
+        private data class AlwaysSendEventStreamInitialResponse(val enabled: Boolean) : AdditionalSettings() {
             override fun toObjectNode(): ObjectNode =
                 ObjectNode.builder()
-                    .withMember("sendEventStreamInitialResponse", enabled)
+                    .withMember("alwaysSendEventStreamInitialResponse", enabled)
                     .build()
         }
 
@@ -167,7 +168,11 @@ fun codegenIntegrationTest(
     invokePlugin(ctx)
     ctx.fileManifest.printGeneratedFiles()
     val logger = Logger.getLogger("CodegenIntegrationTest")
-    val out = params.command?.invoke(testDir) ?: (params.cargoCommand ?: "cargo test --lib --tests").runCommand(testDir, environment = environment)
+    val out =
+        params.command?.invoke(testDir) ?: (params.cargoCommand ?: "cargo test --lib --tests").runCommand(
+            testDir,
+            environment = environment,
+        )
     logger.fine(out.toString())
     return testDir
 }
diff --git a/codegen-server-test/build.gradle.kts b/codegen-server-test/build.gradle.kts
@@ -56,14 +56,14 @@ val allCodegenTests = "../codegen-core/common-test-models".let { commonModels ->
             "smithy.protocoltests.rpcv2Cbor#RpcV2CborService",
             "rpcv2Cbor_extras",
             imports = listOf("$commonModels/rpcv2Cbor-extras.smithy"),
-            extraConfig = """, "codegen": { "sendEventStreamInitialResponse": true } """,
+            extraConfig = """, "codegen": { "alwaysSendEventStreamInitialResponse": true } """,
         ),
         CodegenTest(
             "smithy.protocoltests.rpcv2Cbor#RpcV2CborService",
             "rpcv2Cbor_extras_no_initial_response",
             imports = listOf("$commonModels/rpcv2Cbor-extras.smithy"),
             // This is the default behavior
-            // extraConfig = """, "codegen": { "sendEventStreamInitialResponse": false } """,
+            // extraConfig = """, "codegen": { "alwaysSendEventStreamInitialResponse": false } """,
         ),
         CodegenTest(
             "com.amazonaws.constraints#ConstraintsService",
diff --git a/codegen-server-test/integration-tests/eventstreams/tests/structured_eventstream_tests.rs b/codegen-server-test/integration-tests/eventstreams/tests/structured_eventstream_tests.rs
@@ -375,7 +375,7 @@ async fn test_streaming_operation_with_initial_data_missing() {
     );
 }
 
-/// Test that when sendEventStreamInitialResponse is disabled, no initial-response is sent
+/// Test that when alwaysSendEventStreamInitialResponse is disabled, no initial-response is sent
 #[tokio::test]
 async fn test_server_no_initial_response_when_disabled() {
     use rpcv2cbor_extras_no_initial_response::output;
diff --git a/codegen-server/src/main/kotlin/software/amazon/smithy/rust/codegen/server/smithy/ServerRustSettings.kt b/codegen-server/src/main/kotlin/software/amazon/smithy/rust/codegen/server/smithy/ServerRustSettings.kt
@@ -97,7 +97,7 @@ data class ServerCodegenConfig(
      */
     val experimentalCustomValidationExceptionWithReasonPleaseDoNotUse: String? = defaultExperimentalCustomValidationExceptionWithReasonPleaseDoNotUse,
     val addValidationExceptionToConstrainedOperations: Boolean = DEFAULT_ADD_VALIDATION_EXCEPTION_TO_CONSTRAINED_OPERATIONS,
-    val sendEventStreamInitialResponse: Boolean = DEFAULT_SEND_EVENT_STREAM_INITIAL_RESPONSE,
+    val alwaysSendEventStreamInitialResponse: Boolean = DEFAULT_SEND_EVENT_STREAM_INITIAL_RESPONSE,
 ) : CoreCodegenConfig(
         formatTimeoutSeconds, debugMode,
     ) {
@@ -120,7 +120,10 @@ data class ServerCodegenConfig(
                         .getBooleanMemberOrDefault("publicConstrainedTypes", DEFAULT_PUBLIC_CONSTRAINED_TYPES),
                 ignoreUnsupportedConstraints =
                     node.get()
-                        .getBooleanMemberOrDefault("ignoreUnsupportedConstraints", DEFAULT_IGNORE_UNSUPPORTED_CONSTRAINTS),
+                        .getBooleanMemberOrDefault(
+                            "ignoreUnsupportedConstraints",
+                            DEFAULT_IGNORE_UNSUPPORTED_CONSTRAINTS,
+                        ),
                 experimentalCustomValidationExceptionWithReasonPleaseDoNotUse =
                     node.get().getStringMemberOrDefault(
                         "experimentalCustomValidationExceptionWithReasonPleaseDoNotUse",
@@ -131,9 +134,9 @@ data class ServerCodegenConfig(
                         "addValidationExceptionToConstrainedOperations",
                         DEFAULT_ADD_VALIDATION_EXCEPTION_TO_CONSTRAINED_OPERATIONS,
                     ),
-                sendEventStreamInitialResponse =
+                alwaysSendEventStreamInitialResponse =
                     node.get().getBooleanMemberOrDefault(
-                        "sendEventStreamInitialResponse",
+                        "alwaysSendEventStreamInitialResponse",
                         DEFAULT_SEND_EVENT_STREAM_INITIAL_RESPONSE,
                     ),
             )
diff --git a/codegen-server/src/main/kotlin/software/amazon/smithy/rust/codegen/server/smithy/protocols/ServerHttpBoundProtocolGenerator.kt b/codegen-server/src/main/kotlin/software/amazon/smithy/rust/codegen/server/smithy/protocols/ServerHttpBoundProtocolGenerator.kt
@@ -1484,7 +1484,7 @@ private fun eventStreamWithInitialResponse(
     protocol: ServerProtocol,
     params: EventStreamBodyParams,
 ): Writable {
-    return if (codegenContext.settings.codegenConfig.sendEventStreamInitialResponse) {
+    return if (codegenContext.settings.codegenConfig.alwaysSendEventStreamInitialResponse) {
         val initialResponseGenerator =
             params.eventStreamMarshallerGenerator.renderInitialResponseGenerator(params.payloadContentType)
 

Original file line number	Diff line number	Diff line change
`@@ -375,7 +375,7 @@ async fn test_streaming_operation_with_initial_data_missing() {`
`375`	`375`	`);`
`376`	`376`	`}`
`377`	`377`
`378`		`-/// Test that when sendEventStreamInitialResponse is disabled, no initial-response is sent`
	`378`	`+/// Test that when alwaysSendEventStreamInitialResponse is disabled, no initial-response is sent`
`379`	`379`	`#[tokio::test]`
`380`	`380`	`async fn test_server_no_initial_response_when_disabled() {`
`381`	`381`	`use rpcv2cbor_extras_no_initial_response::output;`