Reading Env and Config for UseRequestCompression setting

Author: sdavtaker

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

@@ -45,6 +45,15 @@ namespace Aws
             NEVER
         };
 
+        /**
+         * This setting is an enumeration, not a boolean, to allow for future expansion.
+         */
+        enum class UseRequestCompression
+        {
+          FALSE,
+          TRUE,
+        };
+
         /**
          * This mutable structure is used to configure any of the AWS clients.
          * Default values can only be overwritten prior to passing to the client constructors.
@@ -265,7 +274,14 @@ namespace Aws
             Aws::String profileName;
 
             /**
-             * A helper function to read config value from env variable of aws profile config
+             * Use request compression when available.
+             * To use this feature, the service needs to provide the support, and the compression
+             * algorithms needs to be available at SDK build time.
+             */
+            Aws::Client::UseRequestCompression useRequestCompression;
+
+            /**
+             * A helper function to read config value from env variable or aws profile config
              */
             static Aws::String LoadConfigFromEnvOrProfile(const Aws::String& envKey,
                                                           const Aws::String& profile,

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

@@ -28,6 +28,8 @@ namespace Client
 {
 
 static const char* CLIENT_CONFIG_TAG = "ClientConfiguration";
+static const char* USE_REQUEST_COMPRESSION_ENV_VAR = "USE_REQUEST_COMPRESSION";
+static const char* USE_REQUEST_COMPRESSION_CONFIG_VAR = "use_request_compression";
 
 Aws::String ComputeUserAgentString()
 {
@@ -70,6 +72,21 @@ void setLegacyClientConfigurationParameters(ClientConfiguration& clientConfig)
     clientConfig.enableHostPrefixInjection = true;
     clientConfig.profileName = Aws::Auth::GetConfigProfileName();
 
+    Aws::String useCompressionConfig = clientConfig.LoadConfigFromEnvOrProfile(
+        USE_REQUEST_COMPRESSION_ENV_VAR,
+        Aws::Auth::GetConfigProfileName(),
+        USE_REQUEST_COMPRESSION_CONFIG_VAR,
+        {"TRUE", "FALSE", "true", "false"},
+        "TRUE"
+        );
+
+    if (Aws::Utils::StringUtils::ToLower(useCompressionConfig.c_str())  == "false") {
+      clientConfig.useRequestCompression = Aws::Client::UseRequestCompression::FALSE;
+    } else {
+      //Using default to true for forward compatibility in case new config is added but SDK is not updated.
+      clientConfig.useRequestCompression = Aws::Client::UseRequestCompression::TRUE;
+    }
+
     AWS_LOGSTREAM_DEBUG(CLIENT_CONFIG_TAG, "ClientConfiguration will use SDK Auto Resolved profile: [" << clientConfig.profileName << "] if not specified by users.");
 
     // Automatically determine the AWS region from environment variables, configuration file and EC2 metadata.

tests/aws-cpp-sdk-core-tests/aws/client/AwsConfigTest.cpp

@@ -27,6 +27,7 @@ class AWSConfigTestSuite : public ::testing::Test
     SaveEnvironmentVariable("AWS_DEFAULT_REGION");
     SaveEnvironmentVariable("AWS_REGION");
     SaveEnvironmentVariable("AWS_EC2_METADATA_SERVICE_ENDPOINT");
+    SaveEnvironmentVariable("USE_REQUEST_COMPRESSION");
 
     Aws::StringStream ss;
     ss << Aws::Auth::GetConfigProfileFilename() + "_blah" << std::this_thread::get_id();
@@ -37,6 +38,7 @@ class AWSConfigTestSuite : public ::testing::Test
     Aws::Environment::UnSetEnv("AWS_DEFAULT_REGION");
     Aws::Environment::UnSetEnv("AWS_REGION");
     Aws::Environment::UnSetEnv("AWS_EC2_METADATA_SERVICE_ENDPOINT");
+    Aws::Environment::UnSetEnv("USE_REQUEST_COMPRESSION");
 
     auto profileDirectory = Aws::Auth::ProfileConfigFileAWSCredentialsProvider::GetProfileDirectory();
     Aws::FileSystem::CreateDirectoryIfNotExists(profileDirectory.c_str());
@@ -115,6 +117,78 @@ TEST_F(AWSConfigTestSuite, TestClientConfigurationSetsRegionToProfile)
   EXPECT_EQ(Aws::Region::US_WEST_2, config.region);
   EXPECT_STREQ("Dijkstra", config.profileName.c_str());
 
+  // cleanup
+  Aws::FileSystem::RemoveFileIfExists(m_configFileName.c_str());
+}
+
+TEST_F(AWSConfigTestSuite, TestNoEnvNoConfigSetsUseRequestCompressionToTrue){
+  // create an empty config file
+  Aws::OFStream configFileNew(m_configFileName.c_str(), Aws::OFStream::out | Aws::OFStream::trunc);
+
+  configFileNew.flush();
+  configFileNew.close();
+  Aws::Config::ReloadCachedConfigFile();
+
+  Aws::Client::ClientConfiguration config;
+
+  EXPECT_EQ(Aws::Client::UseRequestCompression::TRUE, config.useRequestCompression);
+
+  // cleanup
+  Aws::FileSystem::RemoveFileIfExists(m_configFileName.c_str());
+}
+
+TEST_F(AWSConfigTestSuite, TestEnvToFalseAndNoConfigSetsUseRequestCompressionToFalse){
+  //Set Env variable
+  Aws::Environment::SetEnv("USE_REQUEST_COMPRESSION", "FALSE", 1/*overwrite*/);
+  // create an empty config file
+  Aws::OFStream configFileNew(m_configFileName.c_str(), Aws::OFStream::out | Aws::OFStream::trunc);
+
+  configFileNew.flush();
+  configFileNew.close();
+  Aws::Config::ReloadCachedConfigFile();
+
+  Aws::Client::ClientConfiguration config;
+
+  EXPECT_EQ(Aws::Client::UseRequestCompression::FALSE, config.useRequestCompression);
+
+  // cleanup
+  Aws::FileSystem::RemoveFileIfExists(m_configFileName.c_str());
+}
+
+TEST_F(AWSConfigTestSuite, TestEnvToTrueAndConfigSetToFalseSetsUseRequestCompressionToTrue){
+  //Set Env variable
+  Aws::Environment::SetEnv("USE_REQUEST_COMPRESSION", "TRUE", 1/*overwrite*/);
+  // create an empty config file
+  Aws::OFStream configFileNew(m_configFileName.c_str(), Aws::OFStream::out | Aws::OFStream::trunc);
+  configFileNew << "[profile Dijkstra]" << std::endl;  // profile keyword is mandatory per specification
+  configFileNew << "use_request_compression = false" << std::endl;
+
+  configFileNew.flush();
+  configFileNew.close();
+  Aws::Config::ReloadCachedConfigFile();
+
+  Aws::Client::ClientConfiguration config("Dijkstra");
+
+  EXPECT_EQ(Aws::Client::UseRequestCompression::TRUE, config.useRequestCompression);
+
+  // cleanup
+  Aws::FileSystem::RemoveFileIfExists(m_configFileName.c_str());
+}
+
+TEST_F(AWSConfigTestSuite, TestNoEnvAndConfigSetToFalseSetsUseRequestCompressionToFalse){
+  // create an empty config file
+  Aws::OFStream configFileNew(m_configFileName.c_str(), Aws::OFStream::out | Aws::OFStream::trunc);
+  configFileNew << "[profile default]" << std::endl;  // profile keyword is mandatory per specification
+  configFileNew << "use_request_compression = false" << std::endl;
+
+  configFileNew.flush();
+  configFileNew.close();
+  Aws::Config::ReloadCachedConfigFile();
+
+  Aws::Client::ClientConfiguration config;
+
+  EXPECT_EQ(Aws::Client::UseRequestCompression::FALSE, config.useRequestCompression);
+
   // cleanup
   Aws::FileSystem::RemoveFileIfExists(m_configFileName.c_str());
 }