Use DateTimeImmutable instead of DateTimeInterface (#365)

* Use DateTimeImmutable instead of DateTimeInterface

* Short syntax

Author: Nyholm

src/AbstractApi.php

@@ -80,7 +80,7 @@ final public function getConfiguration(): Configuration
         return $this->configuration;
     }
 
-    final public function presign(Input $input, ?\DateTimeInterface $expires = null): string
+    final public function presign(Input $input, ?\DateTimeImmutable $expires = null): string
     {
         $request = $input->request();
         $request->setEndpoint($this->getEndpoint($request->getUri(), $request->getQuery()));

src/Credentials/Credentials.php

@@ -25,7 +25,7 @@ public function __construct(
         string $accessKeyId,
         string $secretKey,
         ?string $sessionToken = null,
-        ?\DateTimeInterface $expireDate = null
+        ?\DateTimeImmutable $expireDate = null
     ) {
         $this->accessKeyId = $accessKeyId;
         $this->secretKey = $secretKey;
@@ -48,14 +48,14 @@ public function getSessionToken(): ?string
         return $this->sessionToken;
     }
 
-    public function getExpireDate(): ?\DateTimeInterface
+    public function getExpireDate(): ?\DateTimeImmutable
     {
         return $this->expireDate;
     }
 
     public function isExpired(): bool
     {
-        return null !== $this->expireDate && new \DateTime() >= $this->expireDate;
+        return null !== $this->expireDate && new \DateTimeImmutable() >= $this->expireDate;
     }
 
     public function getCredentials(Configuration $configuration): ?Credentials

src/RequestContext.php

@@ -25,20 +25,20 @@ class RequestContext
     private $operation;
 
     /**
-     * @var \DateTimeInterface|null
+     * @var \DateTimeImmutable|null
      */
     private $expirationDate;
 
     /**
-     * @var \DateTimeInterface|null
+     * @var \DateTimeImmutable|null
      */
     private $currentDate;
 
     /**
      * @param array{
      *  operation?: null|string
-     *  expirationDate?: null|\\DateTimeInterface
-     *  currentDate?: null|\\DateTimeInterface
+     *  expirationDate?: null|\DateTimeImmutable
+     *  currentDate?: null|\DateTimeImmutable
      * }
      */
     public function __construct(array $options = [])
@@ -57,12 +57,12 @@ public function getOperation(): ?string
         return $this->operation;
     }
 
-    public function getExpirationDate(): ?\DateTimeInterface
+    public function getExpirationDate(): ?\DateTimeImmutable
     {
         return $this->expirationDate;
     }
 
-    public function getCurrentDate(): ?\DateTimeInterface
+    public function getCurrentDate(): ?\DateTimeImmutable
     {
         return $this->currentDate;
     }

src/Signer/SignerV4.php

@@ -61,11 +61,8 @@ public function __construct(string $scopeName, string $region)
 
     public function presign(Request $request, Credentials $credentials, RequestContext $context): void
     {
-        if (null === $now = $context->getCurrentDate()) {
-            $now = new \DateTimeImmutable();
-        } else {
-            $now = new \DateTimeImmutable($now->format(\DateTimeInterface::ATOM));
-        }
+        $now = $context->getCurrentDate() ?? new \DateTimeImmutable();
+
         // Signer date have to be UTC https://docs.aws.amazon.com/general/latest/gr/sigv4-date-handling.html
         $now = $now->setTimezone(new \DateTimeZone('UTC'));
         $expires = $context->getExpirationDate() ?? $now->add(new \DateInterval('PT1H'));
@@ -75,11 +72,8 @@ public function presign(Request $request, Credentials $credentials, RequestConte
 
     public function sign(Request $request, Credentials $credentials, RequestContext $context): void
     {
-        if (null === $now = $context->getCurrentDate()) {
-            $now = new \DateTimeImmutable();
-        } else {
-            $now = new \DateTimeImmutable($now->format(\DateTimeInterface::ATOM));
-        }
+        $now = $context->getCurrentDate() ?? new \DateTimeImmutable();
+
         // Signer date have to be UTC https://docs.aws.amazon.com/general/latest/gr/sigv4-date-handling.html
         $now = $now->setTimezone(new \DateTimeZone('UTC'));
 
@@ -106,7 +100,7 @@ protected function buildBodyDigest(Request $request, bool $isPresign): string
         return $hash;
     }
 
-    private function handleSignature(Request $request, Credentials $credentials, \DateTimeInterface $now, \DateTimeInterface $expires, bool $isPresign): void
+    private function handleSignature(Request $request, Credentials $credentials, \DateTimeImmutable $now, \DateTimeImmutable $expires, bool $isPresign): void
     {
         $this->removePresign($request);
         $this->sanitizeHostForHeader($request);
@@ -197,7 +191,7 @@ private function assignAmzQueryValues(Request $request, Credentials $credentials
         }
     }
 
-    private function buildTime(Request $request, \DateTimeInterface $now, \DateTimeInterface $expires, bool $isPresign): void
+    private function buildTime(Request $request, \DateTimeImmutable $now, \DateTimeImmutable $expires, bool $isPresign): void
     {
         if ($isPresign) {
             $duration = $expires->getTimestamp() - $now->getTimestamp();
@@ -215,7 +209,7 @@ private function buildTime(Request $request, \DateTimeInterface $now, \DateTimeI
         }
     }
 
-    private function buildCredentialString(Request $request, Credentials $credentials, \DateTimeInterface $now, bool $isPresign): array
+    private function buildCredentialString(Request $request, Credentials $credentials, \DateTimeImmutable $now, bool $isPresign): array
     {
         $credentialScope = [$now->format('Ymd'), $this->region, $this->scopeName, 'aws4_request'];
 
@@ -259,7 +253,7 @@ private function convertBodyToQuery(Request $request): void
         $request->setBody(StringStream::create(''));
     }
 
-    private function convertBodyToStream(Request $request, \DateTimeInterface $now, string $credentialString, string $signingKey, string &$signature): void
+    private function convertBodyToStream(Request $request, \DateTimeImmutable $now, string $credentialString, string $signingKey, string &$signature): void
     {
         $body = $request->getBody();
         if ($request->hasHeader('content-length')) {
@@ -388,7 +382,7 @@ private function buildCanonicalPath(Request $request): string
         return '/' . str_replace('%2F', '/', $doubleEncoded);
     }
 
-    private function buildStringToSign(\DateTimeInterface $now, string $credentialString, string $canonicalRequest): string
+    private function buildStringToSign(\DateTimeImmutable $now, string $credentialString, string $canonicalRequest): string
     {
         return implode("\n", [
             self::ALGORITHM_REQUEST,
@@ -398,7 +392,7 @@ private function buildStringToSign(\DateTimeInterface $now, string $credentialSt
         ]);
     }
 
-    private function buildChunkStringToSign(\DateTimeInterface $now, string $credentialString, string $signature, string $chunk): string
+    private function buildChunkStringToSign(\DateTimeImmutable $now, string $credentialString, string $signature, string $chunk): string
     {
         static $emptyHash;
         $emptyHash = $emptyHash ?? hash('sha256', '');

src/Sts/ValueObject/Credentials.php

@@ -29,7 +29,7 @@ class Credentials
      *   AccessKeyId: string,
      *   SecretAccessKey: string,
      *   SessionToken: string,
-     *   Expiration: \DateTimeInterface,
+     *   Expiration: \DateTimeImmutable,
      * } $input
      */
     public function __construct(array $input)
@@ -50,7 +50,7 @@ public function getAccessKeyId(): string
         return $this->AccessKeyId;
     }
 
-    public function getExpiration(): \DateTimeInterface
+    public function getExpiration(): \DateTimeImmutable
     {
         return $this->Expiration;
     }