From 21e831f071b7f7ade5dbb527dbbf348680a0a6c6 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Gabriel=20Ostroluck=C3=BD?= <gabriel.ostrolucky@gmail.com>
Date: Wed, 20 Dec 2023 21:50:28 +0100
Subject: [PATCH] Fix inconsistency with .env loaders out of the box

PHP .env loaders such as `symfony/dotenv` or `vlucas/phpdotenv` populate `$_ENV` out of the box, but don't call `putenv()` in order to preserve thread safeness. This means .env is loaded by them, but AWS SDK does not read it, creating inconsistent experience when handling real env variables and env variables loaded by these loaders
---
 .../Aws/Test/Integ/ClientSideMonitoringContext.php       | 2 ++
 features/bootstrap/Aws/Test/Integ/IntegUtils.php         | 2 ++
 src/AbstractConfigurationProvider.php                    | 2 ++
 src/ClientResolver.php                                   | 2 ++
 src/ClientSideMonitoring/ConfigurationProvider.php       | 2 ++
 src/Configuration/ConfigurationResolver.php              | 2 ++
 .../AssumeRoleWithWebIdentityCredentialProvider.php      | 2 ++
 src/Credentials/CredentialProvider.php                   | 2 ++
 src/Credentials/EcsCredentialProvider.php                | 2 ++
 src/Credentials/InstanceProfileProvider.php              | 2 ++
 src/DefaultsMode/ConfigurationProvider.php               | 2 ++
 .../UseDualstackEndpoint/ConfigurationProvider.php       | 2 ++
 src/Endpoint/UseFipsEndpoint/ConfigurationProvider.php   | 2 ++
 src/EndpointDiscovery/ConfigurationProvider.php          | 2 ++
 src/Middleware.php                                       | 2 ++
 src/Retry/ConfigurationProvider.php                      | 2 ++
 src/S3/RegionalEndpoint/ConfigurationProvider.php        | 2 ++
 src/S3/UseArnRegion/ConfigurationProvider.php            | 2 ++
 src/Sts/RegionalEndpoints/ConfigurationProvider.php      | 2 ++
 src/Token/ParsesIniTrait.php                             | 2 ++
 src/Token/SsoTokenProvider.php                           | 2 ++
 src/Token/TokenProvider.php                              | 2 ++
 src/functions.php                                        | 8 ++++++++
 tests/FunctionsTest.php                                  | 9 +++++++++
 24 files changed, 61 insertions(+)

diff --git a/features/bootstrap/Aws/Test/Integ/ClientSideMonitoringContext.php b/features/bootstrap/Aws/Test/Integ/ClientSideMonitoringContext.php
index 34e1502770..398ba822da 100644
--- a/features/bootstrap/Aws/Test/Integ/ClientSideMonitoringContext.php
+++ b/features/bootstrap/Aws/Test/Integ/ClientSideMonitoringContext.php
@@ -21,6 +21,8 @@
 use PHPUnit\Framework\Assert;
 use Yoast\PHPUnitPolyfills\TestCases\TestCase;
 
+use function Aws\getenv;
+
 class ClientSideMonitoringContext extends TestCase
     implements Context, SnippetAcceptingContext
 {
diff --git a/features/bootstrap/Aws/Test/Integ/IntegUtils.php b/features/bootstrap/Aws/Test/Integ/IntegUtils.php
index 46bdd1e6f0..2d2c84a187 100644
--- a/features/bootstrap/Aws/Test/Integ/IntegUtils.php
+++ b/features/bootstrap/Aws/Test/Integ/IntegUtils.php
@@ -1,6 +1,8 @@
 <?php
 namespace Aws\Test\Integ;
 
+use function Aws\getenv;
+
 trait IntegUtils
 {
     private static $originalCsmEnabled;
diff --git a/src/AbstractConfigurationProvider.php b/src/AbstractConfigurationProvider.php
index 78a5cdadaf..5cf3fb10b6 100644
--- a/src/AbstractConfigurationProvider.php
+++ b/src/AbstractConfigurationProvider.php
@@ -3,6 +3,8 @@
 
 use GuzzleHttp\Promise;
 
+use function Aws\getenv;
+
 /**
  * A configuration provider is a function that returns a promise that is
  * fulfilled with a configuration object. This class provides base functionality
diff --git a/src/ClientResolver.php b/src/ClientResolver.php
index 2414f0aea2..ed6cd3875d 100644
--- a/src/ClientResolver.php
+++ b/src/ClientResolver.php
@@ -36,6 +36,8 @@
 use InvalidArgumentException as IAE;
 use Psr\Http\Message\RequestInterface;
 
+use function Aws\getenv;
+
 /**
  * @internal Resolves a hash of client arguments to construct a client.
  */
diff --git a/src/ClientSideMonitoring/ConfigurationProvider.php b/src/ClientSideMonitoring/ConfigurationProvider.php
index b83de70f84..9ac125029e 100644
--- a/src/ClientSideMonitoring/ConfigurationProvider.php
+++ b/src/ClientSideMonitoring/ConfigurationProvider.php
@@ -8,6 +8,8 @@
 use GuzzleHttp\Promise;
 use GuzzleHttp\Promise\PromiseInterface;
 
+use function Aws\getenv;
+
 /**
  * A configuration provider is a function that accepts no arguments and returns
  * a promise that is fulfilled with a {@see \Aws\ClientSideMonitoring\ConfigurationInterface}
diff --git a/src/Configuration/ConfigurationResolver.php b/src/Configuration/ConfigurationResolver.php
index a08595a75d..3383ca5267 100644
--- a/src/Configuration/ConfigurationResolver.php
+++ b/src/Configuration/ConfigurationResolver.php
@@ -2,6 +2,8 @@
 
 namespace Aws\Configuration;
 
+use function Aws\getenv;
+
 class ConfigurationResolver
 {
     const ENV_PROFILE = 'AWS_PROFILE';
diff --git a/src/Credentials/AssumeRoleWithWebIdentityCredentialProvider.php b/src/Credentials/AssumeRoleWithWebIdentityCredentialProvider.php
index 7e8057e9dd..c75c386a8a 100644
--- a/src/Credentials/AssumeRoleWithWebIdentityCredentialProvider.php
+++ b/src/Credentials/AssumeRoleWithWebIdentityCredentialProvider.php
@@ -7,6 +7,8 @@
 use Aws\Sts\StsClient;
 use GuzzleHttp\Promise;
 
+use function Aws\getenv;
+
 /**
  * Credential provider that provides credentials via assuming a role with a web identity
  * More Information, see: https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-sts-2011-06-15.html#assumerolewithwebidentity
diff --git a/src/Credentials/CredentialProvider.php b/src/Credentials/CredentialProvider.php
index 1647fe0da9..4332c896ce 100644
--- a/src/Credentials/CredentialProvider.php
+++ b/src/Credentials/CredentialProvider.php
@@ -7,6 +7,8 @@
 use Aws\Exception\CredentialsException;
 use Aws\Sts\StsClient;
 use GuzzleHttp\Promise;
+
+use function Aws\getenv;
 /**
  * Credential providers are functions that accept no arguments and return a
  * promise that is fulfilled with an {@see \Aws\Credentials\CredentialsInterface}
diff --git a/src/Credentials/EcsCredentialProvider.php b/src/Credentials/EcsCredentialProvider.php
index 18c210547c..7325abf93d 100644
--- a/src/Credentials/EcsCredentialProvider.php
+++ b/src/Credentials/EcsCredentialProvider.php
@@ -7,6 +7,8 @@
 use GuzzleHttp\Promise\PromiseInterface;
 use Psr\Http\Message\ResponseInterface;
 
+use function Aws\getenv;
+
 /**
  * Credential provider that fetches container credentials with GET request.
  * container environment variables are used in constructing request URI.
diff --git a/src/Credentials/InstanceProfileProvider.php b/src/Credentials/InstanceProfileProvider.php
index e820a04cba..f5b85e259f 100644
--- a/src/Credentials/InstanceProfileProvider.php
+++ b/src/Credentials/InstanceProfileProvider.php
@@ -11,6 +11,8 @@
 use GuzzleHttp\Promise\PromiseInterface;
 use Psr\Http\Message\ResponseInterface;
 
+use function Aws\getenv;
+
 /**
  * Credential provider that provides credentials from the EC2 metadata service.
  */
diff --git a/src/DefaultsMode/ConfigurationProvider.php b/src/DefaultsMode/ConfigurationProvider.php
index 86229aca4c..de4acdb270 100644
--- a/src/DefaultsMode/ConfigurationProvider.php
+++ b/src/DefaultsMode/ConfigurationProvider.php
@@ -8,6 +8,8 @@
 use GuzzleHttp\Promise;
 use GuzzleHttp\Promise\PromiseInterface;
 
+use function Aws\getenv;
+
 /**
  * A configuration provider is a function that returns a promise that is
  * fulfilled with a {@see \Aws\DefaultsMode\ConfigurationInterface}
diff --git a/src/Endpoint/UseDualstackEndpoint/ConfigurationProvider.php b/src/Endpoint/UseDualstackEndpoint/ConfigurationProvider.php
index b7d8e531a6..d513fa2eb8 100644
--- a/src/Endpoint/UseDualstackEndpoint/ConfigurationProvider.php
+++ b/src/Endpoint/UseDualstackEndpoint/ConfigurationProvider.php
@@ -7,6 +7,8 @@
 use Aws\Endpoint\UseDualstackEndpoint\Exception\ConfigurationException;
 use GuzzleHttp\Promise;
 
+use function Aws\getenv;
+
 /**
  * A configuration provider is a function that returns a promise that is
  * fulfilled with a {@see \Aws\Endpoint\UseDualstackEndpoint\onfigurationInterface}
diff --git a/src/Endpoint/UseFipsEndpoint/ConfigurationProvider.php b/src/Endpoint/UseFipsEndpoint/ConfigurationProvider.php
index 0b344488aa..20d8cb086d 100644
--- a/src/Endpoint/UseFipsEndpoint/ConfigurationProvider.php
+++ b/src/Endpoint/UseFipsEndpoint/ConfigurationProvider.php
@@ -7,6 +7,8 @@
 use Aws\Endpoint\UseFipsEndpoint\Exception\ConfigurationException;
 use GuzzleHttp\Promise;
 
+use function Aws\getenv;
+
 /**
  * A configuration provider is a function that returns a promise that is
  * fulfilled with a {@see \Aws\Endpoint\UseFipsEndpoint\onfigurationInterface}
diff --git a/src/EndpointDiscovery/ConfigurationProvider.php b/src/EndpointDiscovery/ConfigurationProvider.php
index 77404a81d0..7331a32383 100644
--- a/src/EndpointDiscovery/ConfigurationProvider.php
+++ b/src/EndpointDiscovery/ConfigurationProvider.php
@@ -8,6 +8,8 @@
 use GuzzleHttp\Promise;
 use GuzzleHttp\Promise\PromiseInterface;
 
+use function Aws\getenv;
+
 /**
  * A configuration provider is a function that returns a promise that is
  * fulfilled with a {@see \Aws\EndpointDiscovery\ConfigurationInterface}
diff --git a/src/Middleware.php b/src/Middleware.php
index cb627efc04..7bc00f15ca 100644
--- a/src/Middleware.php
+++ b/src/Middleware.php
@@ -14,6 +14,8 @@
 use GuzzleHttp\Psr7\LazyOpenStream;
 use Psr\Http\Message\RequestInterface;
 
+use function Aws\getenv;
+
 final class Middleware
 {
     /**
diff --git a/src/Retry/ConfigurationProvider.php b/src/Retry/ConfigurationProvider.php
index db641f2204..a42b41e86b 100644
--- a/src/Retry/ConfigurationProvider.php
+++ b/src/Retry/ConfigurationProvider.php
@@ -8,6 +8,8 @@
 use GuzzleHttp\Promise;
 use GuzzleHttp\Promise\PromiseInterface;
 
+use function Aws\getenv;
+
 /**
  * A configuration provider is a function that returns a promise that is
  * fulfilled with a {@see \Aws\Retry\ConfigurationInterface}
diff --git a/src/S3/RegionalEndpoint/ConfigurationProvider.php b/src/S3/RegionalEndpoint/ConfigurationProvider.php
index 19b715137a..e155a6fdc1 100644
--- a/src/S3/RegionalEndpoint/ConfigurationProvider.php
+++ b/src/S3/RegionalEndpoint/ConfigurationProvider.php
@@ -7,6 +7,8 @@
 use Aws\S3\RegionalEndpoint\Exception\ConfigurationException;
 use GuzzleHttp\Promise;
 
+use function Aws\getenv;
+
 /**
  * A configuration provider is a function that returns a promise that is
  * fulfilled with a {@see \Aws\S3\RegionalEndpoint\ConfigurationInterface}
diff --git a/src/S3/UseArnRegion/ConfigurationProvider.php b/src/S3/UseArnRegion/ConfigurationProvider.php
index b9ced4e3cc..23399c9818 100644
--- a/src/S3/UseArnRegion/ConfigurationProvider.php
+++ b/src/S3/UseArnRegion/ConfigurationProvider.php
@@ -7,6 +7,8 @@
 use Aws\S3\UseArnRegion\Exception\ConfigurationException;
 use GuzzleHttp\Promise;
 
+use function Aws\getenv;
+
 /**
  * A configuration provider is a function that returns a promise that is
  * fulfilled with a {@see \Aws\S3\UseArnRegion\ConfigurationInterface}
diff --git a/src/Sts/RegionalEndpoints/ConfigurationProvider.php b/src/Sts/RegionalEndpoints/ConfigurationProvider.php
index 1720980240..85b28b1bb3 100644
--- a/src/Sts/RegionalEndpoints/ConfigurationProvider.php
+++ b/src/Sts/RegionalEndpoints/ConfigurationProvider.php
@@ -8,6 +8,8 @@
 use GuzzleHttp\Promise;
 use GuzzleHttp\Promise\PromiseInterface;
 
+use function Aws\getenv;
+
 /**
  * A configuration provider is a function that returns a promise that is
  * fulfilled with a {@see \Aws\Sts\RegionalEndpoints\ConfigurationInterface}
diff --git a/src/Token/ParsesIniTrait.php b/src/Token/ParsesIniTrait.php
index b96a6d97bc..ca7cb5d97d 100644
--- a/src/Token/ParsesIniTrait.php
+++ b/src/Token/ParsesIniTrait.php
@@ -1,6 +1,8 @@
 <?php
 namespace Aws\Token;
 
+use function Aws\getenv;
+
 trait ParsesIniTrait
 {
     /**
diff --git a/src/Token/SsoTokenProvider.php b/src/Token/SsoTokenProvider.php
index 83a0e2c288..b3a8df976c 100644
--- a/src/Token/SsoTokenProvider.php
+++ b/src/Token/SsoTokenProvider.php
@@ -4,6 +4,8 @@
 use Aws\Exception\TokenException;
 use GuzzleHttp\Promise;
 
+use function Aws\getenv;
+
 /**
  * Token that comes from the SSO provider
  */
diff --git a/src/Token/TokenProvider.php b/src/Token/TokenProvider.php
index 1d7014c888..1ee71564ae 100644
--- a/src/Token/TokenProvider.php
+++ b/src/Token/TokenProvider.php
@@ -7,6 +7,8 @@
 use Aws\Exception\TokenException;
 use GuzzleHttp\Promise;
 
+use function Aws\getenv;
+
 /**
  * Token providers are functions that accept no arguments and return a
  * promise that is fulfilled with an {@see \Aws\Token\TokenInterface}
diff --git a/src/functions.php b/src/functions.php
index 4533728021..60ed3a8310 100644
--- a/src/functions.php
+++ b/src/functions.php
@@ -603,3 +603,11 @@ function strip_fips_pseudo_regions($region)
     return str_replace(['fips-', '-fips'], ['', ''], $region);
 }
 
+/** @return string|false */
+function getenv(string $name)
+{
+    $out = \getenv($name);
+
+    return $out === false ? ($_ENV[$name] ?? false) : $out;
+}
+
diff --git a/tests/FunctionsTest.php b/tests/FunctionsTest.php
index f430f10272..cb8358f0a4 100644
--- a/tests/FunctionsTest.php
+++ b/tests/FunctionsTest.php
@@ -516,4 +516,13 @@ public function getIniFileServiceTestCases()
             ]
         ];
     }
+
+    /**
+     * @covers Aws\getenv()
+     */
+    public function testgetenv()
+    {
+        $this->assertEquals(false, Aws\getenv('FOO'));
+        $this->assertEquals($_ENV['FOO'] = 'bar', Aws\getenv('FOO'));
+    }
 }