Allow deprecating input fields and arguments

webonyx · May 9, 2023 · c77dd83 · c77dd83
1 parent dbc3ef0
commit c77dd83
Show file tree

Hide file tree

Showing 15 changed files with 533 additions and 27 deletions.
diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -26,7 +26,7 @@ parameters:
 			path: src/Language/Visitor.php
 
 		-
-			message: "#^Parameter \\#1 \\$config of class GraphQL\\\\Type\\\\Definition\\\\Argument constructor expects array\\{name\\: string, type\\: \\(callable\\(\\)\\: GraphQL\\\\Type\\\\Definition\\\\InputType&GraphQL\\\\Type\\\\Definition\\\\Type\\)\\|\\(GraphQL\\\\Type\\\\Definition\\\\InputType&GraphQL\\\\Type\\\\Definition\\\\Type\\), defaultValue\\?\\: mixed, description\\?\\: string\\|null, astNode\\?\\: GraphQL\\\\Language\\\\AST\\\\InputValueDefinitionNode\\|null\\}, non\\-empty\\-array given\\.$#"
+			message: "#^Parameter \\#1 \\$config of class GraphQL\\\\Type\\\\Definition\\\\Argument constructor expects array\\{name\\: string, type\\: \\(callable\\(\\)\\: GraphQL\\\\Type\\\\Definition\\\\InputType&GraphQL\\\\Type\\\\Definition\\\\Type\\)\\|\\(GraphQL\\\\Type\\\\Definition\\\\InputType&GraphQL\\\\Type\\\\Definition\\\\Type\\), defaultValue\\?\\: mixed, description\\?\\: string\\|null, deprecationReason\\?\\: string\\|null, astNode\\?\\: GraphQL\\\\Language\\\\AST\\\\InputValueDefinitionNode\\|null\\}, non\\-empty\\-array given\\.$#"
 			count: 1
 			path: src/Type/Definition/Argument.php
 

diff --git a/src/Type/Definition/Argument.php b/src/Type/Definition/Argument.php
@@ -14,13 +14,15 @@
  *     type: ArgumentType,
  *     defaultValue?: mixed,
  *     description?: string|null,
+ *     deprecationReason?: string|null,
  *     astNode?: InputValueDefinitionNode|null
  * }
  * @phpstan-type ArgumentConfig array{
  *     name: string,
  *     type: ArgumentType,
  *     defaultValue?: mixed,
  *     description?: string|null,
+ *     deprecationReason?: string|null,
  *     astNode?: InputValueDefinitionNode|null
  * }
  * @phpstan-type ArgumentListConfig iterable<ArgumentConfig|ArgumentType>|iterable<UnnamedArgumentConfig>
@@ -34,6 +36,8 @@ class Argument
 
     public ?string $description;
 
+    public ?string $deprecationReason;
+
     /** @var Type&InputType */
     private Type $type;
 
@@ -48,6 +52,7 @@ public function __construct(array $config)
         $this->name = $config['name'];
         $this->defaultValue = $config['defaultValue'] ?? null;
         $this->description = $config['description'] ?? null;
+        $this->deprecationReason = $config['deprecationReason'] ?? null;
         // Do nothing for type, it is lazy loaded in getType()
         $this->astNode = $config['astNode'] ?? null;
 
@@ -95,6 +100,11 @@ public function isRequired(): bool
             && ! $this->defaultValueExists();
     }
 
+    public function isDeprecated(): bool
+    {
+        return (bool) $this->deprecationReason;
+    }
+
     /**
      * @param Type&NamedType $parentType
      *
@@ -113,5 +123,9 @@ public function assertValid(FieldDefinition $parentField, Type $parentType): voi
             $notInputType = Utils::printSafe($this->type);
             throw new InvariantViolation("{$parentType->name}.{$parentField->name}({$this->name}): argument type must be Input Type but got: {$notInputType}");
         }
+
+        if ($this->isRequired() && $this->isDeprecated()) {
+            throw new InvariantViolation("Required argument {$parentType->name}.{$parentField->name}({$this->name}:) cannot be deprecated.");
+        }
     }
 }
diff --git a/src/Type/Definition/Directive.php b/src/Type/Definition/Directive.php
@@ -127,6 +127,8 @@ public static function getInternalDirectives(): array
                 'locations' => [
                     DirectiveLocation::FIELD_DEFINITION,
                     DirectiveLocation::ENUM_VALUE,
+                    DirectiveLocation::ARGUMENT_DEFINITION,
+                    DirectiveLocation::INPUT_FIELD_DEFINITION,
                 ],
                 'args' => [
                     self::REASON_ARGUMENT_NAME => [

diff --git a/src/Type/Definition/InputObjectField.php b/src/Type/Definition/InputObjectField.php
@@ -14,13 +14,15 @@
  *   type: ArgumentType,
  *   defaultValue?: mixed,
  *   description?: string|null,
+ *   deprecationReason?: string|null,
  *   astNode?: InputValueDefinitionNode|null
  * }
  * @phpstan-type UnnamedInputObjectFieldConfig array{
  *   name?: string,
  *   type: ArgumentType,
  *   defaultValue?: mixed,
  *   description?: string|null,
+ *   deprecationReason?: string|null,
  *   astNode?: InputValueDefinitionNode|null
  * }
  */
@@ -33,6 +35,8 @@ class InputObjectField
 
     public ?string $description;
 
+    public ?string $deprecationReason;
+
     /** @var Type&InputType */
     private Type $type;
 
@@ -47,6 +51,7 @@ public function __construct(array $config)
         $this->name = $config['name'];
         $this->defaultValue = $config['defaultValue'] ?? null;
         $this->description = $config['description'] ?? null;
+        $this->deprecationReason = $config['deprecationReason'] ?? null;
         // Do nothing for type, it is lazy loaded in getType()
         $this->astNode = $config['astNode'] ?? null;
 
@@ -74,6 +79,11 @@ public function isRequired(): bool
             && ! $this->defaultValueExists();
     }
 
+    public function isDeprecated(): bool
+    {
+        return (bool) $this->deprecationReason;
+    }
+
     /**
      * @param Type&NamedType $parentType
      *
@@ -97,5 +107,9 @@ public function assertValid(Type $parentType): void
         if (\array_key_exists('resolve', $this->config)) {
             throw new InvariantViolation("{$parentType->name}.{$this->name} field has a resolve property, but Input Types cannot define resolvers.");
         }
+
+        if ($this->isRequired() && $this->isDeprecated()) {
+            throw new InvariantViolation("Required input field {$parentType->name}.{$this->name} cannot be deprecated.");
+        }
     }
 }
diff --git a/src/Type/Introspection.php b/src/Type/Introspection.php
@@ -96,7 +96,7 @@ public static function getIntrospectionQuery(array $options = []): string
     fields(includeDeprecated: true) {
       name
       {$descriptions}
-      args {
+      args(includeDeprecated: true) {
         ...InputValue
       }
       type {
@@ -105,7 +105,7 @@ public static function getIntrospectionQuery(array $options = []): string
       isDeprecated
       deprecationReason
     }
-    inputFields {
+    inputFields(includeDeprecated: true) {
       ...InputValue
     }
     interfaces {
@@ -127,6 +127,8 @@ enumValues(includeDeprecated: true) {
     {$descriptions}
     type { ...TypeRef }
     defaultValue
+    isDeprecated
+    deprecationReason
   }
 
   fragment TypeRef on __Type {
@@ -392,9 +394,31 @@ static function (EnumValueDefinition $value): bool {
                 ],
                 'inputFields' => [
                     'type' => Type::listOf(Type::nonNull(self::_inputValue())),
-                    'resolve' => static fn ($type): ?array => $type instanceof InputObjectType
-                        ? $type->getFields()
-                        : null,
+                    'args' => [
+                        'includeDeprecated' => [
+                            'type' => Type::boolean(),
+                            'defaultValue' => false,
+                        ],
+                    ],
+                    'resolve' => static function ($type, $args): ?array {
+                        if ($type instanceof InputObjectType) {
+                            $fields = $type->getFields();
+
+                            if (! ($args['includeDeprecated'] ?? false)) {
+                                return \array_filter(
+                                    $fields,
+                                    static function (InputObjectField $field): bool {
+                                        return $field->deprecationReason === null
+                                            || $field->deprecationReason === '';
+                                    }
+                                );
+                            }
+
+                            return $fields;
+                        }
+
+                        return null;
+                    },
                 ],
                 'ofType' => [
                     'type' => self::_type(),
@@ -469,7 +493,27 @@ public static function _field(): ObjectType
                 ],
                 'args' => [
                     'type' => Type::nonNull(Type::listOf(Type::nonNull(self::_inputValue()))),
-                    'resolve' => static fn (FieldDefinition $field): array => $field->args,
+                    'args' => [
+                        'includeDeprecated' => [
+                            'type' => Type::boolean(),
+                            'defaultValue' => false,
+                        ],
+                    ],
+                    'resolve' => static function (FieldDefinition $field, $args): array {
+                        $values = $field->args;
+
+                        if (! ($args['includeDeprecated'] ?? false)) {
+                            return \array_filter(
+                                $values,
+                                static function (Argument $value): bool {
+                                    return $value->deprecationReason === null
+                                        || $value->deprecationReason === '';
+                                }
+                            );
+                        }
+
+                        return $values;
+                    },
                 ],
                 'type' => [
                     'type' => Type::nonNull(self::_type()),
@@ -532,6 +576,17 @@ public static function _inputValue(): ObjectType
                         return null;
                     },
                 ],
+                'isDeprecated' => [
+                    'type' => Type::nonNull(Type::boolean()),
+                    /** @param Argument|InputObjectField $inputValue */
+                    'resolve' => static fn ($inputValue): bool => $inputValue->deprecationReason !== null
+                        && $inputValue->deprecationReason !== '',
+                ],
+                'deprecationReason' => [
+                    'type' => Type::string(),
+                    /** @param Argument|InputObjectField $inputValue */
+                    'resolve' => static fn ($inputValue): ?string => $inputValue->deprecationReason,
+                ],
             ],
         ]);
     }

diff --git a/src/Utils/ASTDefinitionBuilder.php b/src/Utils/ASTDefinitionBuilder.php
@@ -141,6 +141,7 @@ private function makeInputValues(NodeList $values): array
                 'name' => $value->name->value,
                 'type' => $type,
                 'description' => $value->description->value ?? null,
+                'deprecationReason' => $this->getDeprecationReason($value),
                 'astNode' => $value,
             ];
 
@@ -388,7 +389,7 @@ public function buildField(FieldDefinitionNode $field): array
      * Given a collection of directives, returns the string value for the
      * deprecation reason.
      *
-     * @param EnumValueDefinitionNode|FieldDefinitionNode $node
+     * @param EnumValueDefinitionNode|FieldDefinitionNode|InputValueDefinitionNode $node
      *
      * @throws \Exception
      * @throws \ReflectionException

diff --git a/src/Utils/SchemaExtender.php b/src/Utils/SchemaExtender.php
@@ -300,6 +300,7 @@ protected function extendInputFieldMap(InputObjectType $type): array
             $newFieldConfig = [
                 'description' => $field->description,
                 'type' => $extendedType,
+                'deprecationReason' => $field->deprecationReason,
                 'astNode' => $field->astNode,
             ];
 
@@ -459,6 +460,7 @@ protected function extendArgs(array $args): array
             $def = [
                 'type' => $extendedType,
                 'description' => $arg->description,
+                'deprecationReason' => $arg->deprecationReason,
                 'astNode' => $arg->astNode,
             ];
 

diff --git a/src/Utils/SchemaPrinter.php b/src/Utils/SchemaPrinter.php
@@ -336,7 +336,7 @@ protected static function printArgs(array $options, array $args, string $indenta
      */
     protected static function printInputValue($arg): string
     {
-        $argDecl = "{$arg->name}: {$arg->getType()->toString()}";
+        $argDecl = "{$arg->name}: {$arg->getType()->toString()}" . static::printDeprecated($arg);
 
         if ($arg->defaultValueExists()) {
             $defaultValueAST = AST::astFromValue($arg->defaultValue, $arg->getType());
@@ -424,15 +424,15 @@ protected static function printFields(array $options, $type): string
     }
 
     /**
-     * @param FieldDefinition|EnumValueDefinition $fieldOrEnumVal
+     * @param FieldDefinition|EnumValueDefinition|InputObjectField|Argument $deprecation
      *
      * @throws \JsonException
      * @throws InvariantViolation
      * @throws SerializationError
      */
-    protected static function printDeprecated($fieldOrEnumVal): string
+    protected static function printDeprecated($deprecation): string
     {
-        $reason = $fieldOrEnumVal->deprecationReason;
+        $reason = $deprecation->deprecationReason;
         if ($reason === null) {
             return '';
         }

diff --git a/tests/Type/DefinitionTest.php b/tests/Type/DefinitionTest.php
@@ -920,13 +920,19 @@ public function testAcceptsAnObjectTypeWithFieldArgs(): void
                 'goodField' => [
                     'type' => Type::string(),
                     'args' => [
-                        'goodArg' => ['type' => Type::string()],
+                        'goodArg' => [
+                            'type' => Type::string(),
+                            'deprecationReason' => 'Just because',
+                        ],
                     ],
                 ],
             ],
         ]);
         $objType->assertValid();
-        self::assertDidNotCrash();
+        $argument = $objType->getField('goodField')->getArg('goodArg');
+        self::assertInstanceOf(Argument::class, $argument);
+        self::assertEquals(true, $argument->isDeprecated());
+        self::assertSame('Just because', $argument->deprecationReason);
     }
 
     // Object interfaces must be array
@@ -1436,12 +1442,16 @@ public function testAcceptsAnInputObjectTypeWithFields(): void
             'fields' => [
                 $fieldName => [
                     'type' => Type::string(),
+                    'deprecationReason' => 'Just because',
                 ],
             ],
         ]);
 
         $inputObjType->assertValid();
-        self::assertSame(Type::string(), $inputObjType->getField($fieldName)->getType());
+        $field = $inputObjType->getField($fieldName);
+        self::assertSame(Type::string(), $field->getType());
+        self::assertEquals(true, $field->isDeprecated());
+        self::assertSame('Just because', $field->deprecationReason);
     }
 
     /** @see it('accepts an Input Object type with a field function') */
@@ -1453,12 +1463,16 @@ public function testAcceptsAnInputObjectTypeWithAFieldFunction(): void
             'fields' => static fn (): array => [
                 $fieldName => [
                     'type' => Type::string(),
+                    'deprecationReason' => 'Just because',
                 ],
             ],
         ]);
 
         $inputObjType->assertValid();
+        $field = $inputObjType->getField($fieldName);
         self::assertSame(Type::string(), $inputObjType->getField($fieldName)->getType());
+        self::assertEquals(true, $field->isDeprecated());
+        self::assertSame('Just because', $field->deprecationReason);
     }
 
     /** @see it('accepts an Input Object type with a field type function') */