Merge pull request #9837 from kkmuffme/dirname-return-type-non-empty-…

…string Dirname return type non empty string
vimeo · May 30, 2023 · 8cdb4b0 · 8cdb4b0
2 parents 2bbfca6 + e3e7373
commit 8cdb4b0
Show file tree

Hide file tree

Showing 5 changed files with 29 additions and 5 deletions.
diff --git a/dictionaries/CallMap.php b/dictionaries/CallMap.php
@@ -1613,7 +1613,7 @@
 'DirectoryIterator::setFileClass' => ['void', 'class='=>'class-string'],
 'DirectoryIterator::setInfoClass' => ['void', 'class='=>'class-string'],
 'DirectoryIterator::valid' => ['bool'],
-'dirname' => ['string', 'path'=>'string', 'levels='=>'int'],
+'dirname' => ['string', 'path'=>'string', 'levels='=>'int<1, max>'],
 'disk_free_space' => ['float|false', 'directory'=>'string'],
 'disk_total_space' => ['float|false', 'directory'=>'string'],
 'diskfreespace' => ['float|false', 'directory'=>'string'],

diff --git a/dictionaries/CallMap_historical.php b/dictionaries/CallMap_historical.php
@@ -9995,7 +9995,7 @@
     'dio_truncate' => ['bool', 'fd'=>'resource', 'offset'=>'int'],
     'dio_write' => ['int', 'fd'=>'resource', 'data'=>'string', 'length='=>'int'],
     'dir' => ['Directory|false', 'directory'=>'string', 'context='=>'resource'],
-    'dirname' => ['string', 'path'=>'string', 'levels='=>'int'],
+    'dirname' => ['string', 'path'=>'string', 'levels='=>'int<1, max>'],
     'disk_free_space' => ['float|false', 'directory'=>'string'],
     'disk_total_space' => ['float|false', 'directory'=>'string'],
     'diskfreespace' => ['float|false', 'directory'=>'string'],

diff --git a/src/Psalm/Internal/Analyzer/Statements/Expression/IncludeAnalyzer.php b/src/Psalm/Internal/Analyzer/Statements/Expression/IncludeAnalyzer.php
@@ -369,6 +369,10 @@ public static function getPathTo(
                     return null;
                 }
 
+                if ($dir_level < 1) {
+                    return null;
+                }
+
                 return dirname($evaled_path, $dir_level);
             }
         } elseif ($stmt instanceof PhpParser\Node\Expr\ConstFetch) {

diff --git a/src/Psalm/Internal/Provider/ReturnTypeProvider/DirnameReturnTypeProvider.php b/src/Psalm/Internal/Provider/ReturnTypeProvider/DirnameReturnTypeProvider.php
@@ -9,6 +9,7 @@
 use Psalm\Plugin\EventHandler\FunctionReturnTypeProviderInterface;
 use Psalm\Type;
 use Psalm\Type\Atomic\TLiteralInt;
+use Psalm\Type\Atomic\TNonEmptyString;
 use Psalm\Type\Union;
 
 use function array_values;
@@ -61,6 +62,16 @@ public static function getFunctionReturnType(FunctionReturnTypeProviderEvent $ev
             $statements_source->getCodebase()->config,
         );
 
+        if ($evaled_path === null) {
+            $type = $node_type_provider->getType($call_args[0]->value);
+            if ($type !== null && $type->isSingle()) {
+                $atomic_type = array_values($type->getAtomicTypes())[0];
+                if ($atomic_type instanceof TNonEmptyString) {
+                    return Type::getNonEmptyString();
+                }
+            }
+        }
+
         if ($evaled_path === null) {
             return Type::getString();
         }

diff --git a/tests/ReturnTypeProvider/DirnameTest.php b/tests/ReturnTypeProvider/DirnameTest.php
@@ -35,12 +35,21 @@ public function providerValidCodeParse(): iterable
             ],
         ];
 
-        yield 'dirnameOfIntLevelReturnsString' => [
+        yield 'dirnameOfIntLevelLiteralReturnsLiteral' => [
             'code' => '<?php
-                $dir = dirname("' . $input . '", 0);
+                $dir = dirname("' . $input . '", 10);
             ',
             'assertions' => [
-                '$dir===' => 'string',
+                '$dir===' => "'.'",
+            ],
+        ];
+
+        yield 'dirnameOfNonEmptyStringIntLevelOneReturnsNonEmptyString' => [
+            'code' => '<?php
+                $dir = dirname(uniqid() . "abc", 2);
+            ',
+            'assertions' => [
+                '$dir===' => 'non-empty-string',
             ],
         ];
     }