feedback

smithy-lang · Oct 20, 2023 · 85aa20c · 85aa20c
1 parent fb94a1b
commit 85aa20c
Show file tree

Hide file tree

Showing 5 changed files with 8 additions and 16 deletions.
diff --git a/...s-signing-common/common/src/aws/smithy/kotlin/runtime/auth/awssigning/AwsSigningConfig.kt b/...s-signing-common/common/src/aws/smithy/kotlin/runtime/auth/awssigning/AwsSigningConfig.kt
@@ -170,7 +170,7 @@ public class AwsSigningConfig(builder: Builder) {
      * This is an opt-in configuration because these intermediate outputs may contain sensitive fields bound
      * to headers, URI, or query parameters.
      */
-    public val enableTraceLogging: Boolean = builder.enableTraceLogging
+    public val logRequest: Boolean = builder.logRequest
 
     public fun toBuilder(): Builder = Builder().also {
         it.region = region
@@ -186,7 +186,7 @@ public class AwsSigningConfig(builder: Builder) {
         it.signedBodyHeader = signedBodyHeader
         it.credentials = credentials
         it.expiresAfter = expiresAfter
-        it.enableTraceLogging = enableTraceLogging
+        it.logRequest = logRequest
     }
 
     public class Builder {
@@ -203,7 +203,7 @@ public class AwsSigningConfig(builder: Builder) {
         public var signedBodyHeader: AwsSignedBodyHeader = AwsSignedBodyHeader.NONE
         public var credentials: Credentials? = null
         public var expiresAfter: Duration? = null
-        public var enableTraceLogging: Boolean = false
+        public var logRequest: Boolean = false
 
         public fun build(): AwsSigningConfig = AwsSigningConfig(this)
     }

diff --git a/...-signing-default/common/src/aws/smithy/kotlin/runtime/auth/awssigning/DefaultAwsSigner.kt b/...-signing-default/common/src/aws/smithy/kotlin/runtime/auth/awssigning/DefaultAwsSigner.kt
@@ -25,7 +25,7 @@ internal class DefaultAwsSignerImpl(
         require(config.algorithm == AwsSigningAlgorithm.SIGV4) { "${config.algorithm} support is not yet implemented" }
 
         val canonical = canonicalizer.canonicalRequest(request, config)
-        if (config.enableTraceLogging) {
+        if (config.logRequest) {
             logger.trace { "Canonical request:\n${canonical.requestString}" }
         }
 

diff --git a/runtime/auth/http-auth-aws/common/src/aws/smithy/kotlin/runtime/http/auth/AwsHttpSigner.kt b/runtime/auth/http-auth-aws/common/src/aws/smithy/kotlin/runtime/http/auth/AwsHttpSigner.kt
@@ -140,7 +140,7 @@ public class AwsHttpSigner(private val config: Config) : HttpSigner {
             shouldSignHeader = config.shouldSignHeader
 
             signedBodyHeader = contextSignedBodyHeader ?: config.signedBodyHeader
-            enableTraceLogging = attributes.getOrNull(SdkClientOption.LogMode)?.isEnabled(LogMode.LogSigning) == true
+            logRequest = attributes.getOrNull(SdkClientOption.LogMode)?.isEnabled(LogMode.LogRequest) == true
 
             // SDKs are supposed to default to signed payload _always_ when possible (and when `unsignedPayload` trait
             // isn't present). The only exception is when the customer explicitly disables signed payloads (via Config.isUnsignedPayload).

diff --git a/runtime/smithy-client/common/src/aws/smithy/kotlin/runtime/client/LogMode.kt b/runtime/smithy-client/common/src/aws/smithy/kotlin/runtime/client/LogMode.kt
@@ -52,13 +52,6 @@ public sealed class LogMode(private val mask: Int) {
         override fun toString(): String = "LogResponseWithBody"
     }
 
-    /**
-     * Log intermediate signing details (e.g. canonical request, string to sign, etc)
-     */
-    public object LogSigning : LogMode(0x10) {
-        override fun toString(): String = "LogSigning"
-    }
-
     internal class Composite(mask: Int) : LogMode(mask)
 
     public operator fun plus(mode: LogMode): LogMode = Composite(mask or mode.mask)
@@ -80,7 +73,6 @@ public sealed class LogMode(private val mask: Int) {
             LogRequestWithBody,
             LogResponse,
             LogResponseWithBody,
-            LogSigning,
         )
 
         /**

diff --git a/runtime/smithy-client/common/test/aws/smithy/kotlin/runtime/client/LogModeTest.kt b/runtime/smithy-client/common/test/aws/smithy/kotlin/runtime/client/LogModeTest.kt
@@ -33,7 +33,7 @@ class LogModeTest {
     fun testToString() {
         val mode = LogMode.allModes().reduce { acc, curr -> acc + curr }
         assertTrue { LogMode.allModes().all { mode.isEnabled(it) } }
-        val expected = "LogRequest|LogRequestWithBody|LogResponse|LogResponseWithBody|LogSigning"
+        val expected = "LogRequest|LogRequestWithBody|LogResponse|LogResponseWithBody"
         assertEquals(expected, mode.toString())
     }
 
@@ -45,8 +45,8 @@ class LogModeTest {
     @Test
     fun testFromStringComposite() {
         assertEquals(
-            LogMode.fromString("LogRequest|LogRequestWithBody|LogResponse|LogSigning"),
-            (LogMode.LogRequest + LogMode.LogRequestWithBody + LogMode.LogResponse + LogMode.LogSigning),
+            LogMode.fromString("LogRequest|LogRequestWithBody|LogResponse"),
+            (LogMode.LogRequest + LogMode.LogRequestWithBody + LogMode.LogResponse),
         )
     }