Fix public types (webonyx#702)

* make type private * use getters * add deprecation notices * add tests * stanning * use static * wakey wakey GitHub Actions * add same for InputObjectField
Erindi · Aug 3, 2020 · 5042bed · 5042bed
1 parent d6fe861
commit 5042bed
Show file tree

Hide file tree

Showing 5 changed files with 188 additions and 4 deletions.
diff --git a/src/Type/Definition/FieldDefinition.php b/src/Type/Definition/FieldDefinition.php
@@ -6,6 +6,7 @@
 
 use GraphQL\Error\Error;
 use GraphQL\Error\InvariantViolation;
+use GraphQL\Error\Warning;
 use GraphQL\Language\AST\FieldDefinitionNode;
 use GraphQL\Type\Schema;
 use GraphQL\Utils\Utils;
@@ -60,7 +61,7 @@ class FieldDefinition
     public $config;
 
     /** @var OutputType&Type */
-    public $type;
+    private $type;
 
     /** @var callable|string */
     private $complexityFn;
@@ -194,6 +195,51 @@ public function getType() : Type
         return $this->type;
     }
 
+    public function __isset(string $name) : bool
+    {
+        switch ($name) {
+            case 'type':
+                Warning::warnOnce(
+                    "The public getter for 'type' on FieldDefinition has been deprecated and will be removed" .
+                    " in the next major version. Please update your code to use the 'getType' method.",
+                    Warning::WARNING_CONFIG_DEPRECATION
+                );
+
+                return isset($this->type);
+        }
+
+        return false;
+    }
+
+    public function __get(string $name)
+    {
+        switch ($name) {
+            case 'type':
+                Warning::warnOnce(
+                    "The public getter for 'type' on FieldDefinition has been deprecated and will be removed" .
+                    " in the next major version. Please update your code to use the 'getType' method.",
+                    Warning::WARNING_CONFIG_DEPRECATION
+                );
+
+                return $this->getType();
+        }
+
+        return null;
+    }
+
+    public function __set(string $name, $value)
+    {
+        switch ($name) {
+            case 'type':
+                Warning::warnOnce(
+                    "The public setter for 'type' on FieldDefinition has been deprecated and will be removed" .
+                    ' in the next major version.',
+                    Warning::WARNING_CONFIG_DEPRECATION
+                );
+                $this->type = $value;
+        }
+    }
+
     /**
      * @return bool
      */

diff --git a/src/Type/Definition/InputObjectField.php b/src/Type/Definition/InputObjectField.php
@@ -6,6 +6,7 @@
 
 use GraphQL\Error\Error;
 use GraphQL\Error\InvariantViolation;
+use GraphQL\Error\Warning;
 use GraphQL\Language\AST\InputValueDefinitionNode;
 use GraphQL\Type\Schema;
 use GraphQL\Utils\Utils;
@@ -24,7 +25,7 @@ class InputObjectField
     public $description;
 
     /** @var Type&InputType */
-    public $type;
+    private $type;
 
     /** @var InputValueDefinitionNode|null */
     public $astNode;
@@ -54,6 +55,51 @@ public function __construct(array $opts)
         $this->config = $opts;
     }
 
+    public function __isset(string $name) : bool
+    {
+        switch ($name) {
+            case 'type':
+                Warning::warnOnce(
+                    "The public getter for 'type' on InputObjectField has been deprecated and will be removed" .
+                    " in the next major version. Please update your code to use the 'getType' method.",
+                    Warning::WARNING_CONFIG_DEPRECATION
+                );
+
+                return isset($this->type);
+        }
+
+        return false;
+    }
+
+    public function __get(string $name)
+    {
+        switch ($name) {
+            case 'type':
+                Warning::warnOnce(
+                    "The public getter for 'type' on InputObjectField has been deprecated and will be removed" .
+                    " in the next major version. Please update your code to use the 'getType' method.",
+                    Warning::WARNING_CONFIG_DEPRECATION
+                );
+
+                return $this->getType();
+        }
+
+        return null;
+    }
+
+    public function __set(string $name, $value)
+    {
+        switch ($name) {
+            case 'type':
+                Warning::warnOnce(
+                    "The public setter for 'type' on InputObjectField has been deprecated and will be removed" .
+                    ' in the next major version.',
+                    Warning::WARNING_CONFIG_DEPRECATION
+                );
+                $this->type = $value;
+        }
+    }
+
     /**
      * @return Type&InputType
      */

diff --git a/src/Utils/SchemaExtender.php b/src/Utils/SchemaExtender.php
@@ -184,7 +184,7 @@ protected static function extendInputFieldMap(InputObjectType $type) : array
         foreach ($oldFieldMap as $fieldName => $field) {
             $newFieldMap[$fieldName] = [
                 'description' => $field->description,
-                'type' => static::extendType($field->type),
+                'type' => static::extendType($field->getType()),
                 'astNode' => $field->astNode,
             ];
 

diff --git a/src/Utils/Value.php b/src/Utils/Value.php
@@ -181,7 +181,7 @@ static function ($enumValue) : string {
                             sprintf(
                                 'Field %s of required type %s was not provided',
                                 $fieldPath,
-                                $field->type->toString()
+                                $field->getType()->toString()
                             ),
                             $blameNode
                         )

diff --git a/tests/Type/DefinitionTest.php b/tests/Type/DefinitionTest.php
@@ -5,11 +5,14 @@
 namespace GraphQL\Tests\Type;
 
 use GraphQL\Error\InvariantViolation;
+use GraphQL\Error\Warning;
 use GraphQL\Tests\PHPUnit\ArraySubsetAsserts;
 use GraphQL\Tests\Type\TestClasses\MyCustomType;
 use GraphQL\Tests\Type\TestClasses\OtherCustom;
 use GraphQL\Type\Definition\CustomScalarType;
 use GraphQL\Type\Definition\EnumType;
+use GraphQL\Type\Definition\FieldDefinition;
+use GraphQL\Type\Definition\InputObjectField;
 use GraphQL\Type\Definition\InputObjectType;
 use GraphQL\Type\Definition\InterfaceType;
 use GraphQL\Type\Definition\ListOfType;
@@ -18,6 +21,7 @@
 use GraphQL\Type\Definition\Type;
 use GraphQL\Type\Definition\UnionType;
 use GraphQL\Type\Schema;
+use PHPUnit\Framework\Error\Warning as PhpUnitWarning;
 use PHPUnit\Framework\TestCase;
 use stdClass;
 use function count;
@@ -205,6 +209,94 @@ public function testDefinesAQueryOnlySchema() : void
         self::assertSame($this->blogArticle, $feedFieldType->getWrappedType());
     }
 
+    public function testFieldDefinitionPublicTypeGetDeprecation() : void
+    {
+        $fieldDef = FieldDefinition::create([
+            'type' => Type::string(),
+            'name' => 'GenericField',
+        ]);
+
+        Warning::setWarningHandler(static function ($message) : void {
+            self::assertEquals($message, 'The public getter for \'type\' on FieldDefinition has been deprecated and will be removed in the next major version. Please update your code to use the \'getType\' method.');
+        });
+
+        // @phpstan-ignore-next-line type is private, but we're allowing its access temporarily via a magic method
+        $type = $fieldDef->type;
+    }
+
+    public function testFieldDefinitionPublicTypeSetDeprecation() : void
+    {
+        $fieldDef = FieldDefinition::create([
+            'type' => Type::string(),
+            'name' => 'GenericField',
+        ]);
+
+        Warning::setWarningHandler(static function ($message) : void {
+            self::assertEquals($message, 'The public setter for \'type\' on FieldDefinition has been deprecated and will be removed in the next major version.');
+        });
+
+        // @phpstan-ignore-next-line type is private, but we're allowing its access temporarily via a magic method
+        $fieldDef->type = Type::int();
+    }
+
+    public function testFieldDefinitionPublicTypeIssetDeprecation() : void
+    {
+        $fieldDef = FieldDefinition::create([
+            'type' => Type::string(),
+            'name' => 'GenericField',
+        ]);
+
+        Warning::setWarningHandler(static function ($message) : void {
+            self::assertEquals($message, 'The public getter for \'type\' on FieldDefinition has been deprecated and will be removed in the next major version. Please update your code to use the \'getType\' method.');
+        });
+
+        isset($fieldDef->type);
+    }
+
+    public function testInputObjectFieldPublicTypeGetDeprecation() : void
+    {
+        $fieldDef = new InputObjectField([
+            'type' => Type::string(),
+            'name' => 'GenericField',
+        ]);
+
+        Warning::setWarningHandler(static function ($message) : void {
+            self::assertEquals($message, 'The public getter for \'type\' on InputObjectField has been deprecated and will be removed in the next major version. Please update your code to use the \'getType\' method.');
+        });
+
+        // @phpstan-ignore-next-line type is private, but we're allowing its access temporarily via a magic method
+        $type = $fieldDef->type;
+    }
+
+    public function testInputObjectFieldPublicTypeSetDeprecation() : void
+    {
+        $fieldDef = new InputObjectField([
+            'type' => Type::string(),
+            'name' => 'GenericField',
+        ]);
+
+        Warning::setWarningHandler(static function ($message) : void {
+            self::assertEquals($message, 'The public setter for \'type\' on InputObjectField has been deprecated and will be removed in the next major version.');
+        });
+
+        // @phpstan-ignore-next-line type is private, but we're allowing its access temporarily via a magic method
+        $fieldDef->type = Type::int();
+    }
+
+    public function testInputObjectFieldPublicTypeIssetDeprecation() : void
+    {
+        $fieldDef = new InputObjectField([
+            'type' => Type::string(),
+            'name' => 'GenericField',
+        ]);
+
+        Warning::setWarningHandler(static function ($message) : void {
+            self::assertEquals($message, 'The public getter for \'type\' on InputObjectField has been deprecated and will be removed in the next major version. Please update your code to use the \'getType\' method.');
+        });
+
+        isset($fieldDef->type);
+    }
+
     /**
      * @see it('defines a mutation schema')
      */