Ensure that a #[GQL\Arg] on method has a matching parameter

Author: Vincz

src/Config/Parser/MetadataParser/MetadataParser.php

@@ -19,6 +19,7 @@
 use ReflectionClassConstant;
 use ReflectionException;
 use ReflectionMethod;
+use ReflectionParameter;
 use ReflectionProperty;
 use Reflector;
 use RuntimeException;
@@ -565,6 +566,8 @@ private static function getTypeFieldConfigurationFromReflector(ReflectionClass $
         $accessMetadata = self::getFirstMetadataMatching($metadatas, Metadata\Access::class);
         $publicMetadata = self::getFirstMetadataMatching($metadatas, Metadata\IsPublic::class);
 
+        $isMethod = $reflector instanceof ReflectionMethod;
+
         if (null === $fieldMetadata) {
             if (null !== $accessMetadata || null !== $publicMetadata) {
                 throw new InvalidArgumentException(sprintf('The metadatas %s and/or %s defined on "%s" are only usable in addition of metadata %s', self::formatMetadata('Access'), self::formatMetadata('Visible'), $reflector->getName(), self::formatMetadata('Field')));
@@ -573,7 +576,7 @@ private static function getTypeFieldConfigurationFromReflector(ReflectionClass $
             return [];
         }
 
-        if ($reflector instanceof ReflectionMethod && !$reflector->isPublic()) {
+        if ($isMethod && !$reflector->isPublic()) {
             throw new InvalidArgumentException(sprintf('The metadata %s can only be applied to public method. The method "%s" is not public.', self::formatMetadata('Field'), $reflector->getName()));
         }
 
@@ -591,7 +594,13 @@ private static function getTypeFieldConfigurationFromReflector(ReflectionClass $
         /** @var Metadata\Arg[] $argAnnotations */
         $argAnnotations = self::getMetadataMatching($metadatas, Metadata\Arg::class);
 
+        $validArgNames = array_map(fn (ReflectionParameter $parameter) => $parameter->getName(), $isMethod ? $reflector->getParameters() : []);
+
         foreach ($argAnnotations as $arg) {
+            if ($isMethod && !in_array($arg->name, $validArgNames, true)) {
+                throw new InvalidArgumentException(sprintf('The argument "%s" defined with #[GQL\Arg] attribute/annotation on method "%s" does not match any parameter name in the method.', $arg->name, $reflector->getName()));
+            }
+
             $args[$arg->name] = ['type' => $arg->type];
 
             if (isset($arg->description)) {
@@ -606,7 +615,7 @@ private static function getTypeFieldConfigurationFromReflector(ReflectionClass $
             }
         }
 
-        if ($reflector instanceof ReflectionMethod) {
+        if ($isMethod) {
             $args = self::guessArgs($reflectionClass, $reflector, $args);
         }
 

tests/Config/Parser/MetadataParserTest.php

@@ -524,6 +524,18 @@ public function testInvalidParamGuessing(): void
         }
     }
 
+    public function testInvalidArgumentMatching(): void
+    {
+        try {
+            $file = __DIR__.'/fixtures/annotations/Invalid/InvalidArgumentNaming.php';
+            $this->parser('parse', new SplFileInfo($file), $this->containerBuilder, $this->parserConfig);
+            $this->fail('Missing matching argument should have raise an exception');
+        } catch (Exception $e) {
+            $this->assertInstanceOf(InvalidArgumentException::class, $e);
+            $this->assertMatchesRegularExpression('/The argument "missingParameter" defined/', $e->getPrevious()->getMessage());
+        }
+    }
+
     public function testInvalidReturnGuessing(): void
     {
         try {

tests/Config/Parser/fixtures/annotations/Invalid/InvalidArgumentNaming.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Overblog\GraphQLBundle\Tests\Config\Parser\fixtures\annotations\Invalid;
+
+use Overblog\GraphQLBundle\Annotation as GQL;
+
+/**
+ * @GQL\Type
+ */
+#[GQL\Type]
+final class InvalidArgumentNaming
+{
+    /**
+     * @GQL\Field(name="guessFailed")
+     *
+     * @GQL\Arg(name="missingParameter", type="String")
+     *
+     * @param mixed $test
+     */
+    #[GQL\Field(name: 'guessFailed')]
+    #[GQL\Arg(name: 'missingParameter', type: 'String')]
+    public function guessFail(int $test): int
+    {
+        return 12;
+    }
+}