Fix #3419 - don’t add null to return type when template/conditional r…

…eturn is used
vimeo · May 22, 2020 · 1b84fc2 · 1b84fc2
1 parent 8632cdb
commit 1b84fc2
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 0 deletions.
diff --git a/src/Psalm/Internal/PhpVisitor/ReflectorVisitor.php b/src/Psalm/Internal/PhpVisitor/ReflectorVisitor.php
@@ -2689,6 +2689,8 @@ function (FunctionLikeParameter $p) {
 
                     if ($storage->signature_return_type->isNullable()
                         && !$storage->return_type->isNullable()
+                        && !$storage->return_type->hasTemplate()
+                        && !$storage->return_type->hasConditional()
                     ) {
                         $storage->return_type->addType(new Type\Atomic\TNull());
                     }

diff --git a/src/Psalm/Type/Union.php b/src/Psalm/Type/Union.php
@@ -956,6 +956,19 @@ function ($t) {
         );
     }
 
+    /**
+     * @return bool
+     */
+    public function hasConditional()
+    {
+        return (bool) array_filter(
+            $this->types,
+            function (Atomic $type) : bool {
+                return $type instanceof Type\Atomic\TConditional;
+            }
+        );
+    }
+
     /**
      * @return bool
      */

diff --git a/tests/Template/ConditionalReturnTypeTest.php b/tests/Template/ConditionalReturnTypeTest.php
@@ -476,6 +476,18 @@ function zeroArgsFalseOneArgString(string $s = "") {
                         return $s;
                     }',
             ],
+            'nullableReturnType' => [
+                '<?php
+                    /**
+                     * @psalm-return ($name is "foo" ? string : null)
+                     */
+                    function get(string $name) {
+                        if ($name === "foo") {
+                            return "hello";
+                        }
+                        return null;
+                    }'
+            ],
         ];
     }
 }