BREAKING upgrade to webonyx/graphql-php 15 #9900

Ecodev · Nov 2, 2023 · 8b5bbab · 8b5bbab
1 parent c5c7e6b
commit 8b5bbab
Show file tree

Hide file tree

Showing 32 changed files with 95 additions and 134 deletions.
diff --git a/composer.json b/composer.json
@@ -46,7 +46,7 @@
         "cakephp/chronos": "^2.4",
         "doctrine/dbal": "^3.6",
         "doctrine/migrations": "^3.6",
-        "ecodev/graphql-doctrine": "^8.1",
+        "ecodev/graphql-doctrine": "^9.0",
         "imagine/imagine": "^1.3",
         "laminas/laminas-diactoros": "^3.1",
         "laminas/laminas-log": "^2.16",

diff --git a/composer.lock b/composer.lock
diff --git a/phpstan.neon.dist b/phpstan.neon.dist
@@ -6,15 +6,14 @@ parameters:
     checkMissingIterableValueType: false
     checkGenericClassInNonGenericObjectType: false
     ignoreErrors:
-        - '~^Method Ecodev\\Felix\\Api\\Server\:\:execute\(\) should return array\<GraphQL\\Executor\\ExecutionResult\>\|GraphQL\\Executor\\ExecutionResult but returns array\<GraphQL\\Executor\\ExecutionResult\>\|GraphQL\\Executor\\ExecutionResult\|GraphQL\\Executor\\Promise\\Promise\.$~'
+        - '~^Method Ecodev\\Felix\\Api\\Server\:\:execute\(\) should return array\<GraphQL\\Executor\\ExecutionResult\>\|GraphQL\\Executor\\ExecutionResult but returns array\<int, GraphQL\\Executor\\ExecutionResult\>\|GraphQL\\Executor\\ExecutionResult\|GraphQL\\Executor\\Promise\\Promise\.$~'
         - '~^Cannot call method getInstance\(\) on Laminas\\Permissions\\Acl\\Resource\\ResourceInterface\|null\.$~'
         - '~^Parameter \#1 \$object of static method Ecodev\\Felix\\Utility\:\:getShortClassName\(\) expects class\-string\|object, string given\.$~'
-        - '~^Parameter #1 \$wrappedType of static method GraphQL\\Type\\Definition\\Type\:\:nonNull\(\) expects \(callable\(\)\: mixed\)\|GraphQL\\Type\\Definition\\NullableType, GraphQL\\Type\\Definition\\LeafType given\.$~'
         - '~^Property EcodevTests\\Felix\\Blog\\Model\\.*\:\:\$.* is never read, only written\.$~'
         - '~^Property EcodevTests\\Felix\\Blog\\Model\\.*\:\:\$.* is unused\.$~'
         - '~^Cannot cast mixed to int\.$~'
         - '~^Cannot cast mixed to string\.$~'
-        - '~^Parameter \#1 \$wrappedType of static method GraphQL\\Type\\Definition\\Type\:\:nonNull\(\) expects \(callable\(\)\: mixed\)\|GraphQL\\Type\\Definition\\NullableType, GraphQL\\Type\\Definition\\Type given\.$~'
+        - '~^Parameter \#1 \$type of static method GraphQL\\Type\\Definition\\Type\:\:nonNull\(\) expects~'
 
 includes:
     - phpstan-baseline.neon

diff --git a/src/Api/Exception.php b/src/Api/Exception.php
@@ -11,11 +11,6 @@
  */
 class Exception extends \Exception implements ClientAware
 {
-    public function getCategory(): string
-    {
-        return 'Permissions';
-    }
-
     public function isClientSafe(): bool
     {
         return true;

diff --git a/src/Api/Scalar/CHFType.php b/src/Api/Scalar/CHFType.php
@@ -8,10 +8,7 @@
 
 final class CHFType extends AbstractMoneyType
 {
-    /**
-     * @var string
-     */
-    public $description = 'A CHF money amount.';
+    public ?string $description = 'A CHF money amount.';
 
     /**
      * @param numeric-string $value

diff --git a/src/Api/Scalar/ChronosType.php b/src/Api/Scalar/ChronosType.php
@@ -15,10 +15,7 @@
 
 final class ChronosType extends ScalarType
 {
-    /**
-     * @var string
-     */
-    public $description = 'A date with time and timezone.';
+    public ?string $description = 'A date with time and timezone.';
 
     /**
      * Serializes an internal value to include in a response.

diff --git a/src/Api/Scalar/ColorType.php b/src/Api/Scalar/ColorType.php
@@ -6,10 +6,7 @@
 
 final class ColorType extends AbstractStringBasedType
 {
-    /**
-     * @var string
-     */
-    public $description = 'A color expressed in hexadecimal CSS notation (eg: `#AA00FF`) or an empty string `""`.';
+    public ?string $description = 'A color expressed in hexadecimal CSS notation (eg: `#AA00FF`) or an empty string `""`.';
 
     /**
      * Validate a color in hexadecimal CSS notation.

diff --git a/src/Api/Scalar/DateType.php b/src/Api/Scalar/DateType.php
@@ -14,10 +14,7 @@
 
 final class DateType extends ScalarType
 {
-    /**
-     * @var string
-     */
-    public $description = 'A date without time, nor timezone.';
+    public ?string $description = 'A date without time, nor timezone.';
 
     /**
      * Serializes an internal value to include in a response.

diff --git a/src/Api/Scalar/EURType.php b/src/Api/Scalar/EURType.php
@@ -8,10 +8,7 @@
 
 final class EURType extends AbstractMoneyType
 {
-    /**
-     * @var string
-     */
-    public $description = 'An EUR money amount.';
+    public ?string $description = 'An EUR money amount.';
 
     /**
      * @param numeric-string $value

diff --git a/src/Api/Scalar/LoginType.php b/src/Api/Scalar/LoginType.php
@@ -6,10 +6,7 @@
 
 class LoginType extends AbstractStringBasedType
 {
-    /**
-     * @var string
-     */
-    public $description = 'A user login is a non-empty string containing only letters, digits, `.`, `_` and `-`.';
+    public ?string $description = 'A user login is a non-empty string containing only letters, digits, `.`, `_` and `-`.';
 
     /**
      * Validate a login.

diff --git a/src/Api/Scalar/OtpType.php b/src/Api/Scalar/OtpType.php
@@ -6,10 +6,7 @@
 
 class OtpType extends AbstractStringBasedType
 {
-    /**
-     * @var string
-     */
-    public $description = 'One time passcode composed of only digits';
+    public ?string $description = 'One time passcode composed of only digits';
 
     /**
      * Validate an OTP.

diff --git a/src/Api/Scalar/PasswordType.php b/src/Api/Scalar/PasswordType.php
@@ -6,10 +6,7 @@
 
 final class PasswordType extends AbstractStringBasedType
 {
-    /**
-     * @var string
-     */
-    public $description = 'A password is a string of at least 12 characters';
+    public ?string $description = 'A password is a string of at least 12 characters';
 
     /**
      * Validate a password.

diff --git a/src/Api/Scalar/SiteIDType.php b/src/Api/Scalar/SiteIDType.php
@@ -9,7 +9,7 @@
 // Mock a SiteID GraphQL type without the need of a Site model
 class SiteIDType extends IDType
 {
-    public $name = 'SiteID';
+    public string $name = 'SiteID';
 
-    public $description = 'The ID of a site where a door is located';
+    public ?string $description = 'The ID of a site where a door is located';
 }
diff --git a/src/Api/Scalar/TokenType.php b/src/Api/Scalar/TokenType.php
@@ -6,10 +6,7 @@
 
 final class TokenType extends AbstractStringBasedType
 {
-    /**
-     * @var string
-     */
-    public $description = 'A user token is a lowercase hexadecimal string of 32 characters or 6 digits.';
+    public ?string $description = 'A user token is a lowercase hexadecimal string of 32 characters or 6 digits.';
 
     /**
      * Validate a token.

diff --git a/src/Api/Scalar/UrlType.php b/src/Api/Scalar/UrlType.php
@@ -6,10 +6,7 @@
 
 final class UrlType extends AbstractStringBasedType
 {
-    /**
-     * @var string
-     */
-    public $description = 'An absolute web URL that must start with `http` or `https` or be an empty string.';
+    public ?string $description = 'An absolute web URL that must start with `http` or `https` or be an empty string.';
 
     /**
      * Validate an URL.

diff --git a/src/Api/Server.php b/src/Api/Server.php
@@ -5,6 +5,7 @@
 namespace Ecodev\Felix\Api;
 
 use Doctrine\DBAL\Exception\DriverException;
+use GraphQL\Error\ClientAware;
 use GraphQL\Error\DebugFlag;
 use GraphQL\Executor\ExecutionResult;
 use GraphQL\GraphQL;
@@ -99,6 +100,13 @@ private function handleError(Throwable $exception, callable $formatter): array
             }
         }
 
-        return $formatter($exception);
+        $result = $formatter($exception);
+
+        if (!$exception instanceof ClientAware || !$exception->isClientSafe()) {
+            $result['extensions'] ??= [];
+            $result['extensions']['category'] = 'internal';
+        }
+
+        return $result;
     }
 }