Code generator update for S3 CRT retry strategy config

Author: SergeyRyabinin

tools/code-generation/generator/src/main/java/com/amazonaws/util/awsclientgenerator/generators/cpp/s3/S3RestXmlCppClientGenerator.java

@@ -624,7 +624,7 @@ protected SdkFileEntry generateARNSourceFile(final ServiceModel serviceModel) th
     @Override
     protected SdkFileEntry generateClientConfigurationFile(final ServiceModel serviceModel) throws Exception {
         if ("S3-CRT".equalsIgnoreCase(serviceModel.getMetadata().getProjectName())) {
-            Template template = velocityEngine.getTemplate("/com/amazonaws/util/awsclientgenerator/velocity/cpp/s3/s3-crt/S3CrtClientConfig.vm", StandardCharsets.UTF_8.name());
+            Template template = velocityEngine.getTemplate("/com/amazonaws/util/awsclientgenerator/velocity/cpp/s3/s3-crt/S3CrtClientConfigLegacy.vm", StandardCharsets.UTF_8.name());
 
             VelocityContext context = createContext(serviceModel);
             context.put("exportValue", String.format("AWS_%s_API", serviceModel.getMetadata().getClassNamePrefix().toUpperCase()));

tools/code-generation/generator/src/main/resources/com/amazonaws/util/awsclientgenerator/velocity/cpp/common/ServiceClientConfigurationHeader.vm

@@ -18,6 +18,11 @@
 #if($serviceModel.metadata.serviceId == "S3" || $serviceModel.metadata.serviceId == "S3 Control")
 \#include <aws/core/auth/signer/AWSAuthV4Signer.h>
 #end
+#if($serviceNamespace == "S3Crt")
+\#include <aws/crt/io/Bootstrap.h>
+\#include <aws/crt/io/TlsOptions.h>
+\#include <aws/io/retry_strategy.h>
+#end
 
 
 namespace ${rootNamespace}
@@ -157,6 +162,9 @@ namespace ${rootNamespace}
              * $serviceModel.endpointRuleSetModel.parameters["AccountIdEndpointMode"].documentation
              */
             Aws::String accountIdEndpointMode = "preferred";
+#end
+#if($serviceNamespace == "S3Crt")
+#parse("com/amazonaws/util/awsclientgenerator/velocity/cpp/s3/s3-crt/S3CrtClientConfigHeader.vm")
 #end
         private:
             void Load${serviceNamespace}SpecificConfig(const Aws::String& profileName);

tools/code-generation/generator/src/main/resources/com/amazonaws/util/awsclientgenerator/velocity/cpp/common/ServiceClientConfigurationSource.vm

@@ -6,6 +6,10 @@
 #set($endpointPrefix = $metadata.endpointPrefix)
 #set($serviceNameCaps = $metadata.serviceId.replaceAll("[^a-zA-Z\d]+", "_").toUpperCase())
 \#include <aws/${metadata.projectName}/${metadata.classNamePrefix}ClientConfiguration.h>
+#if($serviceNamespace == "S3Crt")
+\#include <aws/core/Globals.h>
+\#include <aws/core/client/RetryStrategy.h>
+#end
 
 namespace ${rootNamespace}
 {
@@ -171,6 +175,9 @@ ${clsPrefixWSpace}                     ${clsPrefixWSpace}US_EAST_1_REGIONAL_ENDP
   Load${serviceNamespace}SpecificConfig(this->profileName);
 }
 
+#if($serviceNamespace == "S3Crt")
+#parse("com/amazonaws/util/awsclientgenerator/velocity/cpp/s3/s3-crt/S3CrtClientConfigSource.vm")
+#end
 
 } // namespace ${serviceNamespace}
 } // namespace ${rootNamespace}

tools/code-generation/generator/src/main/resources/com/amazonaws/util/awsclientgenerator/velocity/cpp/s3/s3-crt/S3CrtClientConfig.vm

@@ -0,0 +1,74 @@
+
+            /* S3 CRT specifics */
+            S3CrtClientConfiguration(const S3CrtClientConfiguration&) = default;
+            S3CrtClientConfiguration& operator=(const S3CrtClientConfiguration&) = default;
+
+            struct S3CrtConfigFactories
+            {
+                /**
+                 * CRT retry strategy factory method.
+                 * Default will try to match SDK Retry Stratgey (which defaults to DefaultRetryStrategy)
+                 * Note: CRT retry strategy is not SDK retry strategy, retry algorithm and request counting are different.
+                 */
+                std::function<aws_retry_strategy*(const S3Crt::S3CrtClientConfiguration&)> retryStrategyCreateFn;
+
+                static S3CrtConfigFactories defaultFactories;
+            };
+
+            S3CrtConfigFactories crtConfigFactories = S3CrtConfigFactories::defaultFactories;
+
+            /** Client bootstrap used for common staples such as event loop group, host resolver, etc..
+             *  If this is nullptr, SDK will create a default one for you.
+             */
+            std::shared_ptr<Aws::Crt::Io::ClientBootstrap> clientBootstrap;
+
+            /** Size of parts the files will be downloaded or uploaded in. Useful for Put/GetObject APIs
+             *  defaults to 5MB, if user set it to be less than 5MB, SDK will set it to 5MB.
+             */
+            size_t partSize = 5 * 1024 * 1024;
+
+            /** TLS Options to be used for each connection.
+             *  If scheme is Https and tlsConnectionOptions is null, SDK will create a default one for you.
+             */
+            std::shared_ptr<Aws::Crt::Io::TlsConnectionOptions> tlsConnectionOptions;
+
+            /* Throughput target in Gbps that we are trying to reach. Normally it's the NIC's throughput */
+            double throughputTargetGbps = 2.0;
+
+            /** Control the maximum memory used by downloads.
+             *  When set to a value > 0, the SDK uses flow control to bring the memory usage very close
+             *  to the specified window. Without this cap, memory usage grows proportional to file size.
+             */
+            size_t downloadMemoryUsageWindow = 0;
+
+            /* Callback and associated user data for when the client has completed its shutdown process. */
+            std::function<void(void*)> clientShutdownCallback;
+            void *shutdownCallbackUserData = nullptr;
+
+            struct CrtRetryStrategyConfig
+            {
+                enum class CrtRetryStrategyType
+                {
+                    NOT_SET=0, /* Defaults to match SDK retry strategy. */
+                    DEFAULT,
+                    STANDARD,
+                    EXPONENTIAL_BACKOFF,
+                    NO_RETRY=-1,
+                } crtRetryStrategyType = CrtRetryStrategyType::NOT_SET;
+
+                struct ExponentialBackoffConfig
+                {
+                    /**
+                     * EXPONENTIAL_BACKOFF strategy config
+                     */
+                    /* Maximum number of request retries. Specifying 0 here will fall back to the default set by aws-c-io. */
+                    size_t maxRetries = 0;
+
+                    /* Scale factor (in milliseconds) for the back-off value. */
+                    uint32_t scaleFactorMs = 500;
+
+                    /* Maximum delay between retries (in seconds). Specifying 0 here will fall back to the default set by aws-c-io. */
+                    uint32_t maxBackoffSecs = 20;
+                } config;
+            } crtRetryStrategyConfig;
+            /* End of S3 CRT specifics */

tools/code-generation/generator/src/main/resources/com/amazonaws/util/awsclientgenerator/velocity/cpp/s3/s3-crt/S3CrtClientConfigHeader.vm

@@ -0,0 +1,17 @@
+#parse("com/amazonaws/util/awsclientgenerator/velocity/cfamily/Attribution.vm")
+
+#set($metadata = $serviceModel.metadata)
+#set($rootNamespace = $serviceModel.namespace)
+#set($serviceNamespace = $metadata.namespace)
+#pragma once
+
+\#include <aws/${metadata.projectName}/${metadata.classNamePrefix}ClientConfiguration.h>
+
+namespace ${rootNamespace}
+{
+    namespace ${serviceNamespace}
+    {
+        /* Backward compatibility, please use just S3CrtClientConfiguration */
+        using ClientConfiguration = Aws::S3Crt::S3CrtClientConfiguration;
+    }
+}

tools/code-generation/generator/src/main/resources/com/amazonaws/util/awsclientgenerator/velocity/cpp/s3/s3-crt/S3CrtClientConfigLegacy.vm

@@ -0,0 +1,62 @@
+/* S3 CRT specifics */
+S3CrtClientConfiguration::S3CrtConfigFactories S3CrtClientConfiguration::S3CrtConfigFactories::defaultFactories = []()
+{
+  S3CrtConfigFactories factories;
+
+  factories.retryStrategyCreateFn = [](const S3Crt::S3CrtClientConfiguration& config) -> aws_retry_strategy*
+  {
+    aws_event_loop_group *el_group = config.clientBootstrap ?
+      config.clientBootstrap->GetUnderlyingHandle()->event_loop_group : Aws::GetDefaultClientBootstrap()->GetUnderlyingHandle()->event_loop_group;
+
+    using CrtRetryStrategyType = S3Crt::S3CrtClientConfiguration::CrtRetryStrategyConfig::CrtRetryStrategyType;
+
+    CrtRetryStrategyType strategyToUse = config.crtRetryStrategyConfig.crtRetryStrategyType;
+
+    if (strategyToUse == CrtRetryStrategyType::NOT_SET && config.retryStrategy)
+    {
+      if (config.retryStrategy)
+      {
+        if(Aws::String("standard") == config.retryStrategy->GetStrategyName())
+          strategyToUse = CrtRetryStrategyType::STANDARD;
+        else if(Aws::String("adaptive") == config.retryStrategy->GetStrategyName())
+          strategyToUse = CrtRetryStrategyType::EXPONENTIAL_BACKOFF;
+        else
+          strategyToUse = CrtRetryStrategyType::DEFAULT;
+      }
+    }
+
+    if (strategyToUse == CrtRetryStrategyType::DEFAULT)
+    {
+      return nullptr;
+    }
+
+    if (strategyToUse == CrtRetryStrategyType::STANDARD)
+    {
+      aws_standard_retry_options options {};
+      return aws_retry_strategy_new_standard(Aws::get_aws_allocator(), &options);
+    }
+
+    if (strategyToUse == CrtRetryStrategyType::EXPONENTIAL_BACKOFF)
+    {
+      aws_exponential_backoff_retry_options options {};
+      options.el_group = el_group,
+      options.max_retries = config.crtRetryStrategyConfig.config.maxRetries;
+      options.backoff_scale_factor_ms = config.crtRetryStrategyConfig.config.scaleFactorMs;
+      options.max_backoff_secs = config.crtRetryStrategyConfig.config.maxBackoffSecs;
+      options.jitter_mode = AWS_EXPONENTIAL_BACKOFF_JITTER_FULL;
+      return aws_retry_strategy_new_exponential_backoff(Aws::get_aws_allocator(), &options);
+    }
+
+    if (strategyToUse == CrtRetryStrategyType::NO_RETRY)
+    {
+      aws_standard_retry_options options {};
+      options.initial_bucket_capacity = 1;
+      return aws_retry_strategy_new_standard(Aws::get_aws_allocator(), &options);
+    }
+
+    return nullptr;
+  };
+
+  return factories;
+}();
+/* End of S3 CRT specifics */

tools/code-generation/generator/src/main/resources/com/amazonaws/util/awsclientgenerator/velocity/cpp/s3/s3-crt/S3CrtClientConfigSource.vm

@@ -375,6 +375,10 @@ void ${className}::init(const ${clientConfigurationNamespace}::ClientConfigurati
   Aws::Crt::Io::ClientBootstrap* clientBootstrap = config.clientBootstrap ? config.clientBootstrap.get() : Aws::GetDefaultClientBootstrap();
   s3CrtConfig.client_bootstrap = clientBootstrap->GetUnderlyingHandle();
 
+  using CrtRetryStrategyUniquePtr = std::unique_ptr<aws_retry_strategy, decltype(&aws_retry_strategy_release)>;
+  auto retry_strategy = CrtRetryStrategyUniquePtr(config.crtConfigFactories.retryStrategyCreateFn(config), aws_retry_strategy_release);
+  s3CrtConfig.retry_strategy = retry_strategy.get();
+
   m_crtCredProvider = Aws::Crt::Auth::CredentialsProvider::CreateCredentialsProviderDelegate({
      std::bind([](const std::shared_ptr<AWSCredentialsProvider>& provider) {
          if (provider == nullptr) {