Warn if @method annotation contradicts concrete function

Fixes vimeo#5990

Author: robchett

src/Psalm/Internal/Analyzer/MethodComparator.php

@@ -23,6 +23,8 @@
 use Psalm\Issue\LessSpecificImplementedReturnType;
 use Psalm\Issue\MethodSignatureMismatch;
 use Psalm\Issue\MethodSignatureMustProvideReturnType;
+use Psalm\Issue\MismatchingDocblockParamType;
+use Psalm\Issue\MismatchingDocblockReturnType;
 use Psalm\Issue\MissingImmutableAnnotation;
 use Psalm\Issue\MoreSpecificImplementedParamType;
 use Psalm\Issue\OverriddenMethodAccess;
@@ -254,6 +256,9 @@ public static function comparePseudoMethods(
             );
 
             $overridden_method_ids = $codebase->methods->getOverriddenMethodIds($pseudo_method_id);
+            if (isset($class_storage->methods[$pseudo_method_id->method_name])) {
+                $overridden_method_ids[$class_storage->name] = $pseudo_method_id;
+            }
 
             if ($overridden_method_ids
                 && $pseudo_method_name !== '__construct'
@@ -871,6 +876,18 @@ private static function compareMethodDocblockParams(
                         ),
                         $suppressed_issues + $implementer_classlike_storage->suppressed_issues,
                     );
+                } elseif ($guide_class_name == $implementer_called_class_name) {
+                    IssueBuffer::maybeAdd(
+                        new MismatchingDocblockParamType(
+                            'Argument ' . ($i + 1) . ' of ' . $cased_implementer_method_id
+                            . ' has wrong type \'' .
+                            $implementer_method_storage_param_type->getId() . '\' in @method annotation, expecting \'' .
+                            $guide_method_storage_param_type->getId() . '\'',
+                            $implementer_method_storage->params[$i]->location
+                                ?: $code_location,
+                        ),
+                        $suppressed_issues + $implementer_classlike_storage->suppressed_issues,
+                    );
                 } else {
                     IssueBuffer::maybeAdd(
                         new ImplementedParamTypeMismatch(
@@ -1092,6 +1109,17 @@ private static function compareMethodDocblockReturnTypes(
                     ),
                     $suppressed_issues + $implementer_classlike_storage->suppressed_issues,
                 );
+            } elseif ($guide_class_name == $implementer_called_class_name) {
+                IssueBuffer::maybeAdd(
+                    new MismatchingDocblockReturnType(
+                        'The inherited return type \'' . $guide_method_storage_return_type->getId()
+                        . '\' for ' . $cased_guide_method_id . ' is different to the corresponding '
+                        . '@method annotation \'' . $implementer_method_storage_return_type->getId() . '\'',
+                        $implementer_method_storage->return_type_location
+                            ?: $code_location,
+                    ),
+                    $suppressed_issues + $implementer_classlike_storage->suppressed_issues,
+                );
             } else {
                 IssueBuffer::maybeAdd(
                     new ImplementedReturnTypeMismatch(

tests/MethodSignatureTest.php

@@ -1639,6 +1639,28 @@ public function foo(): int {
                 ',
                 'error_message' => 'MethodSignatureMismatch',
             ],
+            'methodAnnotationReturnMismatch' => [
+                'code' => '<?php
+                /**
+                * @method array bar()
+                */
+                interface Foo
+                {
+                    public function bar(): string;
+                }',
+                'error_message' => 'MismatchingDocblockReturnType',
+            ],
+            'methodAnnotationParamMismatch' => [
+                'code' => '<?php
+                /**
+                * @method string bar(string $i)
+                */
+                interface Foo
+                {
+                    public function bar(int $i): string;
+                }',
+                'error_message' => 'MismatchingDocblockParamType',
+            ],
         ];
     }
 }