MC-25111: SVC false-positive: method return typing changed

Author: zakdma

src/Analyzer/ClassMethodAnalyzer.php

@@ -430,10 +430,10 @@ private function getDocReturnDeclaration(ClassMethod $method)
             if ($methodClass) {
                 $ancestors = [];
                 if (!empty($methodClass->extends)) {
-                    $ancestors[] = $methodClass->extends;
+                    $ancestors = $this->addAncestorsToArray($ancestors, $methodClass->extends);
                 }
                 if (!empty($methodClass->implements)) {
-                    $ancestors = array_merge($ancestors, $methodClass->implements);
+                    $ancestors = $this->addAncestorsToArray($ancestors, $methodClass->implements);
                 }
                 /** @var Name $ancestor */
                 foreach ($ancestors as $ancestor) {
@@ -455,6 +455,26 @@ private function getDocReturnDeclaration(ClassMethod $method)
         return ' ';
     }
 
+    /**
+     * Add ancestors to array
+     *
+     * @param array $ancestors
+     * @param array|Name $toAdd
+     * @return array
+     */
+    private function addAncestorsToArray(array $ancestors, $toAdd)
+    {
+        if (!empty($toAdd)) {
+            if (is_array($toAdd)) {
+                $ancestors = array_merge($ancestors, $toAdd);
+            } else {
+                $ancestors[] = $toAdd;
+            }
+        }
+
+        return $ancestors;
+    }
+
     /**
      * Checks changed constructor parameters.
      *

src/Analyzer/Factory/AnalyzerFactory.php

@@ -30,7 +30,7 @@ public function create(DependencyGraph $dependencyGraph = null): AnalyzerInterfa
     {
         $analyzers = [
             new ClassAnalyzer(null, null, null, $dependencyGraph),
-            new InterfaceAnalyzer(),
+            new InterfaceAnalyzer(null, null, null, $dependencyGraph),
             new TraitAnalyzer(),
         ];
 

src/Analyzer/Factory/NonApiAnalyzerFactory.php

@@ -29,7 +29,7 @@ public function create(DependencyGraph $dependencyGraph = null): AnalyzerInterfa
     {
         $analyzers = [
             new ClassAnalyzer(null, null, null, $dependencyGraph),
-            new InterfaceAnalyzer(),
+            new InterfaceAnalyzer(null, null, null, $dependencyGraph),
             new TraitAnalyzer(),
         ];
 

src/Analyzer/InterfaceAnalyzer.php

@@ -139,7 +139,7 @@ protected function reportChanged($report, $registryBefore, $registryAfter, $toVe
     protected function getContentAnalyzers($context, $fileBefore, $fileAfter)
     {
         return [
-            new ClassMethodAnalyzer($context, $fileBefore, $fileAfter),
+            new ClassMethodAnalyzer($context, $fileBefore, $fileAfter, $this->dependencyGraph),
             new ClassConstantAnalyzer($context, $fileBefore, $fileAfter),
             new ClassMethodExceptionAnalyzer($context, $fileBefore, $fileAfter),
             new InterfaceExtendsAnalyzer($context, $fileBefore, $fileAfter)

tests/Unit/Console/Command/CompareSourceCommandNonApiInterfacesTest.php

@@ -153,6 +153,14 @@ public function changesDataProvider()
                 ],
                 'Patch change is detected.'
             ],
+            'docblock-return-type-not-changed' => [
+                $pathToFixtures . '/docblock-return-type-not-changed/source-code-before',
+                $pathToFixtures . '/docblock-return-type-not-changed/source-code-after',
+                [
+                    'Suggested semantic versioning change: NONE'
+                ],
+                'Patch change is detected.'
+            ],
         ];
     }
 }

tests/Unit/Console/Command/CompareSourceCommandTest/_files/non-api-interface/docblock-return-type-not-changed/source-code-after/Parent/ParentTestInterface.php

@@ -0,0 +1,19 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Test\Vcs\Parent;
+
+interface ParentTestInterface
+{
+    /**
+     * @return null|int|\Test\Vcs\Path\TestClass2
+     */
+    public function testMethodInherited();
+
+    /**
+     * @return null|int|\Test\Vcs\Path\TestClass2
+     */
+    public function testMethodInherited2();
+}

tests/Unit/Console/Command/CompareSourceCommandTest/_files/non-api-interface/docblock-return-type-not-changed/source-code-after/Path/TestClass2.php

@@ -0,0 +1,11 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Test\Vcs\Path;
+
+class TestClass2
+{
+
+}

tests/Unit/Console/Command/CompareSourceCommandTest/_files/non-api-interface/docblock-return-type-not-changed/source-code-after/TestInterface.php

@@ -0,0 +1,26 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Test\Vcs;
+
+use Test\Vcs\Path\TestClass2;
+
+interface TestInterface extends \Test\Vcs\Parent\ParentTestInterface
+{
+    /**
+     * @return $this
+     */
+    public function testMethod();
+
+    /**
+     * @return TestClass2
+     */
+    public function testMethod2();
+
+    /**
+     * @inheritDoc
+     */
+    public function testMethodInherited();
+}

tests/Unit/Console/Command/CompareSourceCommandTest/_files/non-api-interface/docblock-return-type-not-changed/source-code-before/Parent/ParentTestInterface.php

@@ -0,0 +1,19 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Test\Vcs\Parent;
+
+interface ParentTestInterface
+{
+    /**
+     * @return null|int|\Test\Vcs\Path\TestClass2
+     */
+    public function testMethodInherited();
+
+    /**
+     * @return null|int|\Test\Vcs\Path\TestClass2
+     */
+    public function testMethodInherited2();
+}

tests/Unit/Console/Command/CompareSourceCommandTest/_files/non-api-interface/docblock-return-type-not-changed/source-code-before/Path/TestClass2.php

@@ -0,0 +1,11 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Test\Vcs\Path;
+
+class TestClass2
+{
+    
+}