use decorator class for query compatible

sbera87 · sbera87 · commit e1e3344cf07f · 2024-11-25T11:57:32.000-05:00
diff --git a/generated/src/aws-cpp-sdk-sqs/include/aws/sqs/SQSErrorMarshaller.h b/generated/src/aws-cpp-sdk-sqs/include/aws/sqs/SQSErrorMarshaller.h
@@ -13,7 +13,7 @@ namespace Aws
 namespace Client
 {
 
-class AWS_SQS_API SQSErrorMarshaller : public Aws::Client::JsonErrorMarshaller
+class AWS_SQS_API SQSErrorMarshaller : public Aws::Client::JsonErrorMarshallerQueryCompatible
 {
 public:
   Aws::Client::AWSError<Aws::Client::CoreErrors> FindErrorByName(const char* exceptionName) const override;
diff --git a/generated/src/aws-cpp-sdk-sqs/include/aws/sqs/SQSRequest.h b/generated/src/aws-cpp-sdk-sqs/include/aws/sqs/SQSRequest.h
@@ -31,6 +31,7 @@ namespace SQS
       if(headers.size() == 0 || (headers.size() > 0 && headers.count(Aws::Http::CONTENT_TYPE_HEADER) == 0))
       {
         headers.emplace(Aws::Http::HeaderValuePair(Aws::Http::CONTENT_TYPE_HEADER, Aws::AMZN_JSON_CONTENT_TYPE_1_0 ));
+        headers.emplace(Aws::Http::HeaderValuePair(Aws::Http::X_AMZN_QUERY_MODE,"true"));
       }
       headers.emplace(Aws::Http::HeaderValuePair(Aws::Http::API_VERSION_HEADER, "2012-11-05"));
       return headers;
diff --git a/src/aws-cpp-sdk-core/include/aws/core/client/AWSError.h b/src/aws-cpp-sdk-core/include/aws/core/client/AWSError.h
@@ -43,6 +43,7 @@ namespace Aws
         // Allow ErrorMarshaller to set error payload.
         friend class XmlErrorMarshaller;
         friend class JsonErrorMarshaller;
+        friend class JsonErrorMarshallerQueryCompatible;
         template<typename T> friend class AWSError;
         public:
             /**
diff --git a/src/aws-cpp-sdk-core/include/aws/core/client/AWSErrorMarshaller.h b/src/aws-cpp-sdk-core/include/aws/core/client/AWSErrorMarshaller.h
@@ -80,21 +80,29 @@ namespace Aws
         {
             using AWSErrorMarshaller::Marshall;
         public:
-         JsonErrorMarshaller(bool queryCompatibilityMode);
-         JsonErrorMarshaller() = default;
          /**
           * Converts an exceptionName and message into an Error object, if it
           * can be parsed. Otherwise, it returns and AWSError with
           * CoreErrors::UNKNOWN as the error type.
           */
-         AWSError<CoreErrors> Marshall(const Aws::Http::HttpResponse& response) const override;
+         virtual AWSError<CoreErrors> Marshall(const Aws::Http::HttpResponse& response) const override;
 
          AWSError<CoreErrors> BuildAWSError(const std::shared_ptr<Http::HttpResponse>& httpResponse) const override;
 
         protected:
          const Aws::Utils::Json::JsonValue& GetJsonPayloadFromError(const AWSError<CoreErrors>&) const;
-         bool isQueryCompatibleMode() const;
-         const bool m_queryCompatibilityMode{false};
+        };
+
+        class AWS_CORE_API JsonErrorMarshallerQueryCompatible : public JsonErrorMarshaller {
+          using AWSErrorMarshaller::Marshall;
+
+         public:
+          /**
+           * Converts an exceptionName and message into an Error object, if it
+           * can be parsed. Otherwise, it returns and AWSError with
+           * CoreErrors::UNKNOWN as the error type.
+           */
+          AWSError<CoreErrors> Marshall(const Aws::Http::HttpResponse& response) const override;
         };
 
         class AWS_CORE_API XmlErrorMarshaller : public AWSErrorMarshaller {
diff --git a/src/aws-cpp-sdk-core/source/client/AWSErrorMarshaller.cpp b/src/aws-cpp-sdk-core/source/client/AWSErrorMarshaller.cpp
@@ -40,11 +40,6 @@ static CoreErrors GuessBodylessErrorType(const Aws::Http::HttpResponseCode respo
     }
 }
 
-JsonErrorMarshaller::JsonErrorMarshaller(bool queryCompatibilityMode)
-    : AWSErrorMarshaller(), m_queryCompatibilityMode{queryCompatibilityMode} {}
-
-bool JsonErrorMarshaller::isQueryCompatibleMode() const { return m_queryCompatibilityMode; }
-
 AWSError<CoreErrors> JsonErrorMarshaller::Marshall(const Aws::Http::HttpResponse& httpResponse) const {
   Aws::StringStream memoryStream;
   std::copy(std::istreambuf_iterator<char>(httpResponse.GetResponseBody()), std::istreambuf_iterator<char>(),
@@ -70,46 +65,6 @@ AWSError<CoreErrors> JsonErrorMarshaller::Marshall(const Aws::Http::HttpResponse
       error.SetMessage(message);
     }
 
-    if (isQueryCompatibleMode() && !error.GetExceptionName().empty()) {
-      /*
-          AWS Query-Compatible mode: This is a special setting that allows
-         certain AWS services to communicate using a specific "query"
-         format, which can send customized error codes. Users are divided
-         into different groups based on how they communicate with the
-         service: Group #1: Users using the AWS Query format, receiving
-         custom error codes. Group #2: Users using the regular AWS JSON
-         format without the trait, receiving standard error codes. Group #3:
-         Users using the AWS JSON format with the trait, receiving custom
-         error codes.
-
-          The header "x-amzn-query-error" shouldn't be present if it's not
-         awsQueryCompatible, so added checks for it.
-      */
-
-      if (httpResponse.HasHeader(QUERY_ERROR_HEADER)) {
-        auto errorCodeString = httpResponse.GetHeader(QUERY_ERROR_HEADER);
-        auto locationOfSemicolon = errorCodeString.find_first_of(';');
-        Aws::String errorCode;
-
-        if (locationOfSemicolon != Aws::String::npos) {
-          errorCode = errorCodeString.substr(0, locationOfSemicolon);
-        } else {
-          errorCode = errorCodeString;
-        }
-
-        error.SetExceptionName(errorCode);
-      }
-      // check for exception name from payload field 'type'
-      else if (payloadView.ValueExists(TYPE)) {
-        // handle missing header and parse code from message
-        const auto& typeStr = payloadView.GetString(TYPE);
-        auto locationOfPound = typeStr.find_first_of('#');
-        if (locationOfPound != Aws::String::npos) {
-          error.SetExceptionName(typeStr.substr(locationOfPound + 1));
-        }
-      }
-    }
-
   } else {
     bool isRetryable = IsRetryableHttpResponseCode(httpResponse.GetResponseCode());
     AWS_LOGSTREAM_ERROR(AWS_ERROR_MARSHALLER_LOG_TAG,
@@ -146,67 +101,60 @@ AWSError<CoreErrors> JsonErrorMarshaller::BuildAWSError(const std::shared_ptr<Ht
   return error;
 }
 
-const JsonValue& JsonErrorMarshaller::GetJsonPayloadFromError(const AWSError<CoreErrors>& error) const
-{
-    return error.GetJsonPayload();
-}
+const JsonValue& JsonErrorMarshaller::GetJsonPayloadFromError(const AWSError<CoreErrors>& error) const { return error.GetJsonPayload(); }
 
-AWSError<CoreErrors> XmlErrorMarshaller::Marshall(const Aws::Http::HttpResponse& httpResponse) const
-{
-    XmlDocument doc = XmlDocument::CreateFromXmlStream(httpResponse.GetResponseBody());
-    AWS_LOGSTREAM_TRACE(AWS_ERROR_MARSHALLER_LOG_TAG, "Error response is " << doc.ConvertToString());
-    bool errorParsed = false;
-    AWSError<CoreErrors> error;
-    if (doc.WasParseSuccessful())
-    {
-        XmlNode errorNode = doc.GetRootElement();
+AWSError<CoreErrors> XmlErrorMarshaller::Marshall(const Aws::Http::HttpResponse& httpResponse) const {
+  XmlDocument doc = XmlDocument::CreateFromXmlStream(httpResponse.GetResponseBody());
+  AWS_LOGSTREAM_TRACE(AWS_ERROR_MARSHALLER_LOG_TAG, "Error response is " << doc.ConvertToString());
+  bool errorParsed = false;
+  AWSError<CoreErrors> error;
+  if (doc.WasParseSuccessful()) {
+    XmlNode errorNode = doc.GetRootElement();
 
-        Aws::String requestId(!errorNode.FirstChild("RequestId").IsNull() ? errorNode.FirstChild("RequestId").GetText() :
-            !errorNode.FirstChild("RequestID").IsNull() ? errorNode.FirstChild("RequestID").GetText() : "");
+    Aws::String requestId(!errorNode.FirstChild("RequestId").IsNull()   ? errorNode.FirstChild("RequestId").GetText()
+                          : !errorNode.FirstChild("RequestID").IsNull() ? errorNode.FirstChild("RequestID").GetText()
+                                                                        : "");
 
-        if (errorNode.GetName() != "Error")
-        {
-            errorNode = doc.GetRootElement().FirstChild("Error");
-        }
-        if (errorNode.IsNull())
-        {
-            errorNode = doc.GetRootElement().FirstChild("Errors");
-            if(!errorNode.IsNull())
-            {
-                errorNode = errorNode.FirstChild("Error");
-            }
-        }
+    if (errorNode.GetName() != "Error") {
+      errorNode = doc.GetRootElement().FirstChild("Error");
+    }
+    if (errorNode.IsNull()) {
+      errorNode = doc.GetRootElement().FirstChild("Errors");
+      if (!errorNode.IsNull()) {
+        errorNode = errorNode.FirstChild("Error");
+      }
+    }
 
-        if (!errorNode.IsNull())
-        {
-            requestId = !requestId.empty() ? requestId : !errorNode.FirstChild("RequestId").IsNull() ? errorNode.FirstChild("RequestId").GetText() :
-                !errorNode.FirstChild("RequestID").IsNull() ? errorNode.FirstChild("RequestID").GetText() : "";
-
-            XmlNode codeNode = errorNode.FirstChild("Code");
-            XmlNode messageNode = errorNode.FirstChild("Message");
-
-            if (!codeNode.IsNull())
-            {
-                error = Marshall(StringUtils::Trim(codeNode.GetText().c_str()),
-                                 StringUtils::Trim(messageNode.GetText().c_str()));
-                errorParsed = true;
-            }
-        }
+    if (!errorNode.IsNull()) {
+      requestId = !requestId.empty()                            ? requestId
+                  : !errorNode.FirstChild("RequestId").IsNull() ? errorNode.FirstChild("RequestId").GetText()
+                  : !errorNode.FirstChild("RequestID").IsNull() ? errorNode.FirstChild("RequestID").GetText()
+                                                                : "";
 
-        error.SetRequestId(requestId);
-    }
+      XmlNode codeNode = errorNode.FirstChild("Code");
+      XmlNode messageNode = errorNode.FirstChild("Message");
 
-    if(!errorParsed)
-    {
-        // An error occurred attempting to parse the httpResponse as an XML stream, so we're just
-        // going to dump the XML parsing error and the http response code as a string
-        AWS_LOGSTREAM_WARN(AWS_ERROR_MARSHALLER_LOG_TAG, "Unable to generate a proper httpResponse from the response "
-                "stream.   Response code: " << static_cast< uint32_t >(httpResponse.GetResponseCode()));
-        error = FindErrorByHttpResponseCode(httpResponse.GetResponseCode());
+      if (!codeNode.IsNull()) {
+        error = Marshall(StringUtils::Trim(codeNode.GetText().c_str()), StringUtils::Trim(messageNode.GetText().c_str()));
+        errorParsed = true;
+      }
     }
 
-    error.SetXmlPayload(std::move(doc));
-    return error;
+    error.SetRequestId(requestId);
+  }
+
+  if (!errorParsed) {
+    // An error occurred attempting to parse the httpResponse as an XML stream, so we're just
+    // going to dump the XML parsing error and the http response code as a string
+    AWS_LOGSTREAM_WARN(AWS_ERROR_MARSHALLER_LOG_TAG,
+                       "Unable to generate a proper httpResponse from the response "
+                       "stream.   Response code: "
+                           << static_cast<uint32_t>(httpResponse.GetResponseCode()));
+    error = FindErrorByHttpResponseCode(httpResponse.GetResponseCode());
+  }
+
+  error.SetXmlPayload(std::move(doc));
+  return error;
 }
 
 AWSError<CoreErrors> XmlErrorMarshaller::BuildAWSError(const std::shared_ptr<Http::HttpResponse>& httpResponse) const
@@ -300,3 +248,82 @@ AWSError<CoreErrors> AWSErrorMarshaller::FindErrorByHttpResponseCode(Aws::Http::
 {
     return CoreErrorsMapper::GetErrorForHttpResponseCode(code);
 }
+
+
+AWSError<CoreErrors> JsonErrorMarshallerQueryCompatible::Marshall(const Aws::Http::HttpResponse& httpResponse) const
+{
+  Aws::StringStream memoryStream;
+  std::copy(std::istreambuf_iterator<char>(httpResponse.GetResponseBody()), std::istreambuf_iterator<char>(),
+            std::ostreambuf_iterator<char>(memoryStream));
+  Aws::String rawPayloadStr = memoryStream.str();
+
+  JsonValue exceptionPayload(rawPayloadStr);
+  JsonView payloadView(exceptionPayload);
+  AWSError<CoreErrors> error;
+  if (exceptionPayload.WasParseSuccessful()) {
+    AWS_LOGSTREAM_TRACE(AWS_ERROR_MARSHALLER_LOG_TAG, "Error response is " << payloadView.WriteReadable());
+
+    Aws::String message(payloadView.ValueExists(MESSAGE_CAMEL_CASE)   ? payloadView.GetString(MESSAGE_CAMEL_CASE)
+                        : payloadView.ValueExists(MESSAGE_LOWER_CASE) ? payloadView.GetString(MESSAGE_LOWER_CASE)
+                                                                      : "");
+
+    if (httpResponse.HasHeader(ERROR_TYPE_HEADER)) {
+      error = Marshall(httpResponse.GetHeader(ERROR_TYPE_HEADER), message);
+    } else if (payloadView.ValueExists(TYPE)) {
+      error = Marshall(payloadView.GetString(TYPE), message);
+    } else {
+      error = FindErrorByHttpResponseCode(httpResponse.GetResponseCode());
+      error.SetMessage(message);
+    }
+
+    if (!error.GetExceptionName().empty()) {
+      /*
+          AWS Query-Compatible mode: This is a special setting that allows
+         certain AWS services to communicate using a specific "query"
+         format, which can send customized error codes. Users are divided
+         into different groups based on how they communicate with the
+         service: Group #1: Users using the AWS Query format, receiving
+         custom error codes. Group #2: Users using the regular AWS JSON
+         format without the trait, receiving standard error codes. Group #3:
+         Users using the AWS JSON format with the trait, receiving custom
+         error codes.
+
+          The header "x-amzn-query-error" shouldn't be present if it's not
+         awsQueryCompatible, so added checks for it.
+      */
+
+      if (httpResponse.HasHeader(QUERY_ERROR_HEADER)) {
+        auto errorCodeString = httpResponse.GetHeader(QUERY_ERROR_HEADER);
+        auto locationOfSemicolon = errorCodeString.find_first_of(';');
+        Aws::String errorCode;
+
+        if (locationOfSemicolon != Aws::String::npos) {
+          errorCode = errorCodeString.substr(0, locationOfSemicolon);
+        } else {
+          errorCode = errorCodeString;
+        }
+
+        error.SetExceptionName(errorCode);
+      }
+      // check for exception name from payload field 'type'
+      else if (payloadView.ValueExists(TYPE)) {
+        // handle missing header and parse code from message
+        const auto& typeStr = payloadView.GetString(TYPE);
+        auto locationOfPound = typeStr.find_first_of('#');
+        if (locationOfPound != Aws::String::npos) {
+          error.SetExceptionName(typeStr.substr(locationOfPound + 1));
+        }
+      }
+    }
+
+  } else {
+    bool isRetryable = IsRetryableHttpResponseCode(httpResponse.GetResponseCode());
+    AWS_LOGSTREAM_ERROR(AWS_ERROR_MARSHALLER_LOG_TAG,
+                        "Failed to parse error payload: " << httpResponse.GetResponseCode() << ": " << rawPayloadStr);
+    error = AWSError<CoreErrors>(CoreErrors::UNKNOWN, "", "Failed to parse error payload: " + rawPayloadStr, isRetryable);
+  }
+
+  error.SetRequestId(httpResponse.HasHeader(REQUEST_ID_HEADER) ? httpResponse.GetHeader(REQUEST_ID_HEADER) : "");
+  error.SetJsonPayload(std::move(exceptionPayload));
+  return error;
+}
diff --git a/tests/aws-cpp-sdk-core-tests/aws/client/AWSErrorMashallerTest.cpp b/tests/aws-cpp-sdk-core-tests/aws/client/AWSErrorMashallerTest.cpp
@@ -474,7 +474,7 @@ TEST_F(AWSErrorMarshallerTest, TestErrorsWithPrefixParse)
     ASSERT_EQ(requestId, error.GetRequestId());
     ASSERT_FALSE(error.ShouldRetry());
 
-    JsonErrorMarshaller awsErrorMarshaller2(true);
+    JsonErrorMarshallerQueryCompatible awsErrorMarshaller2;
     error = awsErrorMarshaller2.Marshall(
         *BuildHttpResponse(exceptionPrefix + "AccessDeniedException", message, requestId, LowerCaseMessage, "AwsQueryErrorCode"));
     ASSERT_EQ(CoreErrors::ACCESS_DENIED, error.GetErrorType());
@@ -743,7 +743,7 @@ TEST_F(AWSErrorMarshallerTest, TestErrorsWithoutPrefixParse)
     ASSERT_EQ(requestId, error.GetRequestId());
     ASSERT_FALSE(error.ShouldRetry());
 
-    JsonErrorMarshaller awsErrorMarshaller2(true);
+    JsonErrorMarshallerQueryCompatible awsErrorMarshaller2;
     error = awsErrorMarshaller2.Marshall(
         *BuildHttpResponse(exceptionPrefix + "AccessDeniedException", message, requestId, LowerCaseMessage, "AwsQueryErrorCode"));
     ASSERT_EQ(CoreErrors::ACCESS_DENIED, error.GetErrorType());
diff --git a/tools/code-generation/generator/src/main/resources/com/amazonaws/util/awsclientgenerator/velocity/cpp/ServiceClientSourceInit.vm b/tools/code-generation/generator/src/main/resources/com/amazonaws/util/awsclientgenerator/velocity/cpp/ServiceClientSourceInit.vm
diff --git a/tools/code-generation/generator/src/main/resources/com/amazonaws/util/awsclientgenerator/velocity/cpp/ServiceClientSourceLegacyConstructors.vm b/tools/code-generation/generator/src/main/resources/com/amazonaws/util/awsclientgenerator/velocity/cpp/ServiceClientSourceLegacyConstructors.vm
diff --git a/tools/code-generation/generator/src/main/resources/com/amazonaws/util/awsclientgenerator/velocity/cpp/json/JsonErrorMarshallerHeader.vm b/tools/code-generation/generator/src/main/resources/com/amazonaws/util/awsclientgenerator/velocity/cpp/json/JsonErrorMarshallerHeader.vm

Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@ namespace Aws`
`13`	`13`	`namespace Client`
`14`	`14`	`{`
`15`	`15`
`16`		`-class AWS_SQS_API SQSErrorMarshaller : public Aws::Client::JsonErrorMarshaller`
	`16`	`+class AWS_SQS_API SQSErrorMarshaller : public Aws::Client::JsonErrorMarshallerQueryCompatible`
`17`	`17`	`{`
`18`	`18`	`public:`
`19`	`19`	`Aws::Client::AWSError<Aws::Client::CoreErrors> FindErrorByName(const char* exceptionName) const override;`
Original file line number	Diff line number	Diff line change
`@@ -31,6 +31,7 @@ namespace SQS`
`31`	`31`	`if(headers.size() == 0 \|\| (headers.size() > 0 && headers.count(Aws::Http::CONTENT_TYPE_HEADER) == 0))`
`32`	`32`	`{`
`33`	`33`	`headers.emplace(Aws::Http::HeaderValuePair(Aws::Http::CONTENT_TYPE_HEADER, Aws::AMZN_JSON_CONTENT_TYPE_1_0 ));`
	`34`	`+ headers.emplace(Aws::Http::HeaderValuePair(Aws::Http::X_AMZN_QUERY_MODE,"true"));`
`34`	`35`	`}`
`35`	`36`	`headers.emplace(Aws::Http::HeaderValuePair(Aws::Http::API_VERSION_HEADER, "2012-11-05"));`
`36`	`37`	`return headers;`