AC-14557:: False positives in the backward-incompatible changes report (SVC)

Author: glo71317

src/Analyzer/ClassMethodAnalyzer.php

@@ -41,6 +41,7 @@
 use PHPSemVerChecker\Operation\ClassMethodParameterTypingRemoved;
 use PHPSemVerChecker\Operation\ClassMethodRemoved;
 use PHPSemVerChecker\Report\Report;
+use Magento\SemanticVersionChecker\Operation\ClassMethodParameterTypingChangedNullable;
 
 /**
  * Class method analyzer.
@@ -258,12 +259,24 @@ protected function reportChanged($report, $contextBefore, $contextAfter, $method
                     $report->add($this->context, $data);
                     $signatureChanged = true;
                 } elseif ($signatureChanges['parameter_typing_changed']) {
-                    $data = new ClassMethodParameterTypingChanged(
-                        $this->context,
-                        $this->fileAfter,
-                        $contextAfter,
-                        $methodAfter
-                    );
+
+                    if ($signatureChanges['parameter_nullable_type_added'] ||
+                        $signatureChanges['parameter_nullable_type_removed']
+                    ) {
+                        $data = new ClassMethodParameterTypingChangedNullable(
+                            $this->context,
+                            $this->fileAfter,
+                            $contextAfter,
+                            $methodAfter
+                        );
+                    } else {
+                        $data = new ClassMethodParameterTypingChanged(
+                            $this->context,
+                            $this->fileAfter,
+                            $contextAfter,
+                            $methodAfter
+                        );
+                    }
                     $report->add($this->context, $data);
                     $signatureChanged = true;
                 }
@@ -455,8 +468,7 @@ private function isReturnsEqualByNullability(ClassMethod $before, ClassMethod $a
      */
     private function getDocReturnDeclaration(ClassMethod $method)
     {
-        if (
-            ($parsedComment = $method->getAttribute('docCommentParsed'))
+        if (($parsedComment = $method->getAttribute('docCommentParsed'))
             && isset($parsedComment['return'])
         ) {
             if ($parsedComment['return'][0] instanceof NullableType) {

src/Comparator/Signature.php

@@ -130,26 +130,35 @@ public static function analyze(array $parametersA, array $parametersB): array
         $changes = array_merge($changes, [
             'parameter_typing_added'          => false,
             'parameter_typing_removed'        => false,
-            'parameter_typing_changed'        => false
+            'parameter_typing_changed'        => false,
+            'parameter_nullable_type_added'   => false,
+            'parameter_nullable_type_removed' => false
         ]);
         $lengthA = count($parametersA);
         $lengthB = count($parametersB);
 
         $iterations = min($lengthA, $lengthB);
         for ($i = 0; $i < $iterations; ++$i) {
+            $typeBefore = $parametersA[$i]->type;
+            $typeAfter = $parametersB[$i]->type;
             // Re-implement type checking to handle type changes as a single operation instead of both add and remove
             if (Type::get($parametersA[$i]->type) !== Type::get($parametersB[$i]->type)) {
                 // This section changed from parent::analyze() to handle typing changes
                 if ($parametersA[$i]->type !== null && $parametersB[$i]->type !== null) {
                     $changes['parameter_typing_changed'] = true;
+                    // Custom: detect nullable added
+                    if ($typeBefore instanceof \PhpParser\Node\NullableType && !$typeAfter instanceof \PhpParser\Node\NullableType) {
+                        $changes['parameter_nullable_type_removed'] = true;
+                    } elseif (!$typeBefore instanceof \PhpParser\Node\NullableType && $typeAfter instanceof \PhpParser\Node\NullableType) {
+                        $changes['parameter_nullable_type_added'] = true;
+                    }
                 } elseif ($parametersA[$i]->type !== null) {
                     $changes['parameter_typing_removed'] = true;
                 } elseif ($parametersB[$i]->type !== null) {
                     $changes['parameter_typing_added'] = true;
                 }
             }
         }
-
         return $changes;
     }
 }

src/Operation/ClassMethodParameterTypingChangedNullable.php

@@ -0,0 +1,53 @@
+<?php
+
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+declare(strict_types=1);
+
+namespace Magento\SemanticVersionChecker\Operation;
+
+use PHPSemVerChecker\Operation\ClassMethodOperationUnary;
+use PHPSemVerChecker\SemanticVersioning\Level;
+
+class ClassMethodParameterTypingChangedNullable extends ClassMethodOperationUnary
+{
+    /**
+     * @var array
+     */
+    protected $code = [
+        'class'     => ['M113', 'M114', 'M115'],
+        'interface' => ['M116'],
+        'trait'     => ['M117', 'M118', 'M119']
+    ];
+
+    /**
+     * @var array
+     */
+    private $mapping = [
+        'M113' => Level::PATCH,
+        'M114' => Level::MAJOR,
+        'M115' => Level::PATCH,
+        'M116' => Level::MAJOR,
+        'M117' => Level::MAJOR,
+        'M118' => Level::MAJOR,
+        'M119' => Level::MAJOR
+    ];
+
+    /**
+     * @var string
+     */
+    protected $reason = 'Method parameter typing changed.';
+
+    /**
+     * Returns level of error.
+     *
+     * @return mixed
+     */
+    public function getLevel(): int
+    {
+        return $this->mapping[$this->getCode()];
+    }
+}