Failed upload will throw the new UploadError #11708

Previously it was up to the application to validate that the received
`UploadedFileInterface` was `$file->getError() === UPLOAD_ERR_OK`. This
is now included in `UploadType` and all `UploadedFileInterface` received
by the application are guaranteed to be successful uploads.

Author: PowerKiKi

src/UploadError.php

@@ -0,0 +1,30 @@
+<?php
+
+declare(strict_types=1);
+
+namespace GraphQL\Upload;
+
+use Exception;
+use GraphQL\Error\Error;
+
+final class UploadError extends Error
+{
+    public function __construct(int $uploadError)
+    {
+        parent::__construct('File upload: ' . $this->getMessageFromUploadError($uploadError));
+    }
+
+    private function getMessageFromUploadError(int $uploadError): string
+    {
+        return match ($uploadError) {
+            UPLOAD_ERR_CANT_WRITE => 'Failed to write file to disk',
+            UPLOAD_ERR_EXTENSION => 'A PHP extension stopped the upload',
+            UPLOAD_ERR_FORM_SIZE => 'The file exceeds the `MAX_FILE_SIZE` directive that was specified in the HTML form',
+            UPLOAD_ERR_INI_SIZE => 'The file exceeds the `upload_max_filesize` of ' . Utility::toMebibyte(Utility::getUploadMaxFilesize()),
+            UPLOAD_ERR_NO_FILE => 'No file was uploaded',
+            UPLOAD_ERR_NO_TMP_DIR => 'Missing a temporary folder',
+            UPLOAD_ERR_PARTIAL => 'The file was only partially uploaded',
+            default => throw new Exception('Unsupported UPLOAD_ERR_* constant value: ' . $uploadError),
+        };
+    }
+}

src/UploadType.php

@@ -37,6 +37,11 @@ public function parseValue(mixed $value): UploadedFileInterface
             throw new UnexpectedValueException('Could not get uploaded file, be sure to conform to GraphQL multipart request specification. Instead got: ' . Utils::printSafe($value));
         }
 
+        $error = $value->getError();
+        if ($error !== UPLOAD_ERR_OK) {
+            throw new UploadError($error);
+        }
+
         return $value;
     }
 

src/Utility.php

@@ -11,7 +11,17 @@ final class Utility
 {
     public static function getPostMaxSize(): int
     {
-        return ini_parse_quantity(ini_get('post_max_size') ?: '0');
+        return self::fromIni('post_max_size');
+    }
+
+    public static function getUploadMaxFilesize(): int
+    {
+        return self::fromIni('upload_max_filesize');
+    }
+
+    private static function fromIni(string $key): int
+    {
+        return ini_parse_quantity(ini_get($key) ?: '0');
     }
 
     /**

tests/Psr7/PsrUploadedFileStub.php

@@ -8,8 +8,8 @@
 
 final class PsrUploadedFileStub extends UploadedFile
 {
-    public function __construct(string $clientFilename, string $clientMediaType)
+    public function __construct(string $clientFilename, string $clientMediaType, int $errorStatus = UPLOAD_ERR_OK)
     {
-        parent::__construct('foo', 123, UPLOAD_ERR_OK, $clientFilename, $clientMediaType);
+        parent::__construct('foo', 123, $errorStatus, $clientFilename, $clientMediaType);
     }
 }

tests/UploadTypeTest.php

@@ -4,12 +4,16 @@
 
 namespace GraphQLTests\Upload;
 
+use Exception;
 use GraphQL\Error\Error;
 use GraphQL\Error\InvariantViolation;
 use GraphQL\Language\AST\StringValueNode;
+use GraphQL\Upload\UploadError;
 use GraphQL\Upload\UploadType;
+use GraphQL\Upload\Utility;
 use GraphQLTests\Upload\Psr7\PsrUploadedFileStub;
 use PHPUnit\Framework\TestCase;
+use Throwable;
 use UnexpectedValueException;
 
 final class UploadTypeTest extends TestCase
@@ -49,4 +53,35 @@ public function testCanNeverParseLiteral(): void
         $this->expectExceptionMessage('`Upload` cannot be hardcoded in query, be sure to conform to GraphQL multipart request specification. Instead got: StringValue');
         $type->parseLiteral($node);
     }
+
+    /**
+     * @param class-string<Throwable> $e
+     *
+     * @dataProvider providerUploadErrorWillThrow
+     */
+    public function testUploadErrorWillThrow(int $errorStatus, string $expectedMessage, string $e = UploadError::class): void
+    {
+        $type = new UploadType();
+        $file = new PsrUploadedFileStub('image.jpg', 'image/jpeg', $errorStatus);
+
+        $this->expectException($e);
+        $this->expectExceptionMessage($expectedMessage);
+
+        $type->parseValue($file);
+    }
+
+    /**
+     * @return iterable<array{0: int, 1: string, 2?: class-string<Throwable>}>
+     */
+    public static function providerUploadErrorWillThrow(): iterable
+    {
+        yield [UPLOAD_ERR_CANT_WRITE, 'Failed to write file to disk'];
+        yield [UPLOAD_ERR_EXTENSION, 'A PHP extension stopped the upload'];
+        yield [UPLOAD_ERR_FORM_SIZE, 'The file exceeds the `MAX_FILE_SIZE` directive that was specified in the HTML form'];
+        yield [UPLOAD_ERR_INI_SIZE, 'The file exceeds the `upload_max_filesize` of ' . Utility::toMebibyte(Utility::getUploadMaxFilesize())];
+        yield [UPLOAD_ERR_NO_FILE, 'No file was uploaded'];
+        yield [UPLOAD_ERR_NO_TMP_DIR, 'Missing a temporary folder'];
+        yield [UPLOAD_ERR_PARTIAL, 'The file was only partially uploaded'];
+        yield [5, 'Unsupported UPLOAD_ERR_* constant value: 5', Exception::class];
+    }
 }