Use int as the PHP representation of long fields in generated code (#…

…1471) * Use int as the PHP representation of long fields in generated code * Add changelog entries for signature changes affecting strict types * Remove generator hacks needed for endpoint shapes to force the type Now that long fields are always defined as integer, we don't need such hacks anymore
async-aws · Jun 28, 2023 · 972d2ae · 972d2ae
1 parent 6e674c8
commit 972d2ae
Show file tree

Hide file tree

Showing 11 changed files with 35 additions and 26 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,15 @@
 
 ## NOT RELEASED
 
+### BC-BREAK
+
+- The type for `\AsyncAws\S3\Input\PutObjectRequest::getContentLength` and `\AsyncAws\S3\Input\PutObjectRequest::setContentLength` uses `int` instead of `string` to reflect the AWS type.
+- The type for `\AsyncAws\S3\Input\UploadPartRequest::getContentLength` and `\AsyncAws\S3\Input\UploadPartRequest::setContentLength` uses `int` instead of `string` to reflect the AWS type.
+- The return type for `\AsyncAws\S3\Result\GetObjectOutput::getContentLength` uses `int` instead of `string` to reflect the AWS type.
+- The return type for `\AsyncAws\S3\Result\HeadObjectOutput::getContentLength` uses `int` instead of `string` to reflect the AWS type.
+- The return type for `\AsyncAws\S3\ValueObject\AwsObject::getSize` uses `int` instead of `string` to reflect the AWS type.
+- The return type for `\AsyncAws\S3\ValueObject\Part::getSize` uses `int` instead of `string` to reflect the AWS type.
+
 ## 1.14.0
 
 ### Added

diff --git a/src/Input/PutObjectRequest.php b/src/Input/PutObjectRequest.php
@@ -101,7 +101,7 @@ final class PutObjectRequest extends Input
      *
      * [^1]: https://www.rfc-editor.org/rfc/rfc9110.html#name-content-length
      *
-     * @var string|null
+     * @var int|null
      */
     private $contentLength;
 
@@ -401,7 +401,7 @@ final class PutObjectRequest extends Input
      *   ContentDisposition?: string,
      *   ContentEncoding?: string,
      *   ContentLanguage?: string,
-     *   ContentLength?: string,
+     *   ContentLength?: int,
      *   ContentMD5?: string,
      *   ContentType?: string,
      *   ChecksumAlgorithm?: ChecksumAlgorithm::*,
@@ -485,7 +485,7 @@ public function __construct(array $input = [])
      *   ContentDisposition?: string,
      *   ContentEncoding?: string,
      *   ContentLanguage?: string,
-     *   ContentLength?: string,
+     *   ContentLength?: int,
      *   ContentMD5?: string,
      *   ContentType?: string,
      *   ChecksumAlgorithm?: ChecksumAlgorithm::*,
@@ -597,7 +597,7 @@ public function getContentLanguage(): ?string
         return $this->contentLanguage;
     }
 
-    public function getContentLength(): ?string
+    public function getContentLength(): ?int
     {
         return $this->contentLength;
     }
@@ -761,7 +761,7 @@ public function request(): Request
             $headers['Content-Language'] = $this->contentLanguage;
         }
         if (null !== $this->contentLength) {
-            $headers['Content-Length'] = $this->contentLength;
+            $headers['Content-Length'] = (string) $this->contentLength;
         }
         if (null !== $this->contentMd5) {
             $headers['Content-MD5'] = $this->contentMd5;
@@ -990,7 +990,7 @@ public function setContentLanguage(?string $value): self
         return $this;
     }
 
-    public function setContentLength(?string $value): self
+    public function setContentLength(?int $value): self
     {
         $this->contentLength = $value;
 

diff --git a/src/Input/UploadPartRequest.php b/src/Input/UploadPartRequest.php
@@ -44,7 +44,7 @@ final class UploadPartRequest extends Input
     /**
      * Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically.
      *
-     * @var string|null
+     * @var int|null
      */
     private $contentLength;
 
@@ -186,7 +186,7 @@ final class UploadPartRequest extends Input
      * @param array{
      *   Body?: string|resource|(callable(int): string)|iterable<string>,
      *   Bucket?: string,
-     *   ContentLength?: string,
+     *   ContentLength?: int,
      *   ContentMD5?: string,
      *   ChecksumAlgorithm?: ChecksumAlgorithm::*,
      *   ChecksumCRC32?: string,
@@ -230,7 +230,7 @@ public function __construct(array $input = [])
      * @param array{
      *   Body?: string|resource|(callable(int): string)|iterable<string>,
      *   Bucket?: string,
-     *   ContentLength?: string,
+     *   ContentLength?: int,
      *   ContentMD5?: string,
      *   ChecksumAlgorithm?: ChecksumAlgorithm::*,
      *   ChecksumCRC32?: string,
@@ -294,7 +294,7 @@ public function getChecksumSha256(): ?string
         return $this->checksumSha256;
     }
 
-    public function getContentLength(): ?string
+    public function getContentLength(): ?int
     {
         return $this->contentLength;
     }
@@ -355,7 +355,7 @@ public function request(): Request
         // Prepare headers
         $headers = [];
         if (null !== $this->contentLength) {
-            $headers['Content-Length'] = $this->contentLength;
+            $headers['Content-Length'] = (string) $this->contentLength;
         }
         if (null !== $this->contentMd5) {
             $headers['Content-MD5'] = $this->contentMd5;
@@ -482,7 +482,7 @@ public function setChecksumSha256(?string $value): self
         return $this;
     }
 
-    public function setContentLength(?string $value): self
+    public function setContentLength(?int $value): self
     {
         $this->contentLength = $value;
 

diff --git a/src/Result/GetObjectOutput.php b/src/Result/GetObjectOutput.php
@@ -301,7 +301,7 @@ public function getContentLanguage(): ?string
         return $this->contentLanguage;
     }
 
-    public function getContentLength(): ?string
+    public function getContentLength(): ?int
     {
         $this->initialize();
 

diff --git a/src/Result/HeadObjectOutput.php b/src/Result/HeadObjectOutput.php
@@ -342,7 +342,7 @@ public function getContentLanguage(): ?string
         return $this->contentLanguage;
     }
 
-    public function getContentLength(): ?string
+    public function getContentLength(): ?int
     {
         $this->initialize();
 

diff --git a/src/Result/ListObjectsV2Output.php b/src/Result/ListObjectsV2Output.php
@@ -392,7 +392,7 @@ private function populateResultObjectList(\SimpleXMLElement $xml): array
                 'LastModified' => ($v = $item->LastModified) ? new \DateTimeImmutable((string) $v) : null,
                 'ETag' => ($v = $item->ETag) ? (string) $v : null,
                 'ChecksumAlgorithm' => !$item->ChecksumAlgorithm ? null : $this->populateResultChecksumAlgorithmList($item->ChecksumAlgorithm),
-                'Size' => ($v = $item->Size) ? (string) $v : null,
+                'Size' => ($v = $item->Size) ? (int) (string) $v : null,
                 'StorageClass' => ($v = $item->StorageClass) ? (string) $v : null,
                 'Owner' => !$item->Owner ? null : new Owner([
                     'DisplayName' => ($v = $item->Owner->DisplayName) ? (string) $v : null,

diff --git a/src/Result/ListPartsOutput.php b/src/Result/ListPartsOutput.php
@@ -308,7 +308,7 @@ private function populateResultParts(\SimpleXMLElement $xml): array
                 'PartNumber' => ($v = $item->PartNumber) ? (int) (string) $v : null,
                 'LastModified' => ($v = $item->LastModified) ? new \DateTimeImmutable((string) $v) : null,
                 'ETag' => ($v = $item->ETag) ? (string) $v : null,
-                'Size' => ($v = $item->Size) ? (string) $v : null,
+                'Size' => ($v = $item->Size) ? (int) (string) $v : null,
                 'ChecksumCRC32' => ($v = $item->ChecksumCRC32) ? (string) $v : null,
                 'ChecksumCRC32C' => ($v = $item->ChecksumCRC32C) ? (string) $v : null,
                 'ChecksumSHA1' => ($v = $item->ChecksumSHA1) ? (string) $v : null,

diff --git a/src/S3Client.php b/src/S3Client.php
@@ -2060,7 +2060,7 @@ public function putBucketTagging($input): Result
      *   ContentDisposition?: string,
      *   ContentEncoding?: string,
      *   ContentLanguage?: string,
-     *   ContentLength?: string,
+     *   ContentLength?: int,
      *   ContentMD5?: string,
      *   ContentType?: string,
      *   ChecksumAlgorithm?: ChecksumAlgorithm::*,
@@ -2419,7 +2419,7 @@ public function putObjectTagging($input): PutObjectTaggingOutput
      * @param array{
      *   Body?: string|resource|(callable(int): string)|iterable<string>,
      *   Bucket: string,
-     *   ContentLength?: string,
+     *   ContentLength?: int,
      *   ContentMD5?: string,
      *   ChecksumAlgorithm?: ChecksumAlgorithm::*,
      *   ChecksumCRC32?: string,

diff --git a/src/ValueObject/AwsObject.php b/src/ValueObject/AwsObject.php
@@ -61,7 +61,7 @@ final class AwsObject
      *   LastModified?: null|\DateTimeImmutable,
      *   ETag?: null|string,
      *   ChecksumAlgorithm?: null|array<ChecksumAlgorithm::*>,
-     *   Size?: null|string,
+     *   Size?: null|int,
      *   StorageClass?: null|ObjectStorageClass::*,
      *   Owner?: null|Owner|array,
      * } $input
@@ -83,7 +83,7 @@ public function __construct(array $input)
      *   LastModified?: null|\DateTimeImmutable,
      *   ETag?: null|string,
      *   ChecksumAlgorithm?: null|array<ChecksumAlgorithm::*>,
-     *   Size?: null|string,
+     *   Size?: null|int,
      *   StorageClass?: null|ObjectStorageClass::*,
      *   Owner?: null|Owner|array,
      * }|AwsObject $input
@@ -121,7 +121,7 @@ public function getOwner(): ?Owner
         return $this->owner;
     }
 
-    public function getSize(): ?string
+    public function getSize(): ?int
     {
         return $this->size;
     }

diff --git a/src/ValueObject/Part.php b/src/ValueObject/Part.php
@@ -68,7 +68,7 @@ final class Part
      *   PartNumber?: null|int,
      *   LastModified?: null|\DateTimeImmutable,
      *   ETag?: null|string,
-     *   Size?: null|string,
+     *   Size?: null|int,
      *   ChecksumCRC32?: null|string,
      *   ChecksumCRC32C?: null|string,
      *   ChecksumSHA1?: null|string,
@@ -92,7 +92,7 @@ public function __construct(array $input)
      *   PartNumber?: null|int,
      *   LastModified?: null|\DateTimeImmutable,
      *   ETag?: null|string,
-     *   Size?: null|string,
+     *   Size?: null|int,
      *   ChecksumCRC32?: null|string,
      *   ChecksumCRC32C?: null|string,
      *   ChecksumSHA1?: null|string,
@@ -139,7 +139,7 @@ public function getPartNumber(): ?int
         return $this->partNumber;
     }
 
-    public function getSize(): ?string
+    public function getSize(): ?int
     {
         return $this->size;
     }

diff --git a/tests/Integration/S3ClientTest.php b/tests/Integration/S3ClientTest.php
@@ -396,7 +396,7 @@ public function testGetObject(): void
         ]);
         self::assertEquals('content', $result->getBody()->getContentAsString());
         self::assertEquals('bytes', $result->getAcceptRanges());
-        self::assertSame('7', $result->getContentLength());
+        self::assertSame(7, $result->getContentLength());
         self::assertEquals('"9a0364b9e99bb480dd25e1f0284c8555"', $result->getETag());
         self::assertEquals('image/jpg', $result->getContentType());
     }
@@ -490,7 +490,7 @@ public function testHeadObject(): void
 
         $result->resolve();
 
-        self::assertSame('7', $result->getContentLength());
+        self::assertSame(7, $result->getContentLength());
         self::assertEquals('"9a0364b9e99bb480dd25e1f0284c8555"', $result->getETag());
     }