fix honoring overriden user agent

Author: sbiscigl

.cspell.json

@@ -299,7 +299,9 @@
     "OTLP",
     // Region
     "eusc",
-    "EUSC"
+    "EUSC",
+    "CBOR",
+    "cbor"
   ],
   "ignoreWords": [
     // variables defined in ConcurrentStreamBuf

src/aws-cpp-sdk-core/include/aws/core/client/AWSProtocolClient.h

@@ -16,7 +16,7 @@ namespace Aws
     {
         /**
          * Templated base class for protocol-specific AWS clients (JSON, CBOR)
-         * Eliminates code duplication by parameterizing the response type and parsing logic.
+         * Eliminates code duplication by templating the response type and parsing logic.
          */
         template<typename OutcomeType, typename ResponseType>
         class AWSProtocolClient : public AWSClient

src/aws-cpp-sdk-core/include/aws/core/client/UserAgent.h

@@ -53,6 +53,7 @@ class AWS_CORE_API UserAgent {
   const Aws::String m_retryStrategyName;
   const Aws::String m_execEnv;
   const Aws::String m_appId;
+  const Aws::String m_overrideUserAgent;
   const Aws::String m_customizations;
   Aws::Set<UserAgentFeature> m_features;
 };

src/aws-cpp-sdk-core/source/client/UserAgent.cpp

@@ -109,7 +109,8 @@ UserAgent::UserAgent(const ClientConfiguration& clientConfiguration,
       m_compilerMetadata{FilterUserAgentToken(Version::GetCompilerVersionString())},
       m_retryStrategyName{retryStrategyName},
       m_execEnv{FilterUserAgentToken(Aws::Environment::GetEnv(EXEC_ENV_VAR).c_str())},
-      m_appId{FilterUserAgentToken(clientConfiguration.appId.c_str())}
+      m_appId{FilterUserAgentToken(clientConfiguration.appId.c_str())},
+      m_overrideUserAgent{clientConfiguration.userAgent}
 #if defined(AWS_USER_AGENT_CUSTOMIZATION)
 #define XSTR(V) STR(V)
 #define STR(V) #V
@@ -125,6 +126,10 @@ UserAgent::UserAgent(const ClientConfiguration& clientConfiguration,
 }
 
 Aws::String UserAgent::SerializeWithFeatures(const Aws::Set<UserAgentFeature>& features) const {
+  if (!m_overrideUserAgent.empty()) {
+    return m_overrideUserAgent;
+  }
+
   // Need to be in order
   Aws::StringStream userAgentValue;
 

tests/aws-cpp-sdk-s3-unit-tests/S3UnitTests.cpp

@@ -378,6 +378,41 @@ TEST_F(S3UnitTest, PutObjectShouldHaveCorrectUserAgent) {
   EXPECT_TRUE(archMetadata < businessMetrics);
 }
 
+TEST_F(S3UnitTest, PutObjectShouldOverrideUserAgent) {
+  auto request = PutObjectRequest()
+    .WithBucket("ocelot")
+    .WithKey("revolver");
+
+  std::shared_ptr<IOStream> body = Aws::MakeShared<StringStream>(ALLOCATION_TAG, "lalilulelo");
+  request.SetBody(body);
+
+  auto mockRequest = Aws::MakeShared<Standard::StandardHttpRequest>(ALLOCATION_TAG, "major.com/zero", HttpMethod::HTTP_PUT);
+  mockRequest->SetResponseStreamFactory([]() -> IOStream* {
+    return Aws::New<StringStream>(ALLOCATION_TAG, "", std::ios_base::in | std::ios_base::binary);
+  });
+  auto mockResponse = Aws::MakeShared<Standard::StandardHttpResponse>(ALLOCATION_TAG, mockRequest);
+  mockResponse->SetResponseCode(HttpResponseCode::OK);
+
+  _mockHttpClient->AddResponseToReturn(mockResponse);
+
+  const AWSCredentials credentials{"mock", "credentials"};
+  const auto epProvider = Aws::MakeShared<S3EndpointProvider>(ALLOCATION_TAG);
+  ClientConfigurationInitValues initValues;
+  initValues.shouldDisableIMDS = true;
+  S3ClientConfiguration configuration{initValues};
+  configuration.region = "us-east-1";
+  configuration.retryStrategy = Aws::MakeShared<NoRetry>(ALLOCATION_TAG);
+  configuration.userAgent = "youre-pretty-good";
+  const S3Client customUaClient{configuration};
+
+  const auto response = customUaClient.PutObject(request);
+  const auto requestSeen = _mockHttpClient->GetMostRecentHttpRequest();
+  EXPECT_TRUE(requestSeen.HasUserAgent());
+  const auto& userAgent = requestSeen.GetUserAgent();
+  EXPECT_TRUE(!userAgent.empty());
+  EXPECT_EQ("youre-pretty-good", userAgent);
+}
+
 TEST_F(S3UnitTest, PutObjectS3ExpressShouldHaveJMetric) {
   auto request = PutObjectRequest()
     .WithBucket("o-worthy-heart--usw2-az1--x-s3")  // S3Express bucket pattern