PHP 7 format with only placeholders isn't falsable if valid

limit tests to PHP 8 to avoid having to create them twice and add specific test for Issue 9941
vimeo · Jun 24, 2023 · 0535c6b · 0535c6b
1 parent c5fee53
commit 0535c6b
Show file tree

Hide file tree

Showing 2 changed files with 43 additions and 1 deletion.
diff --git a/src/Psalm/Internal/Provider/ReturnTypeProvider/SprintfReturnTypeProvider.php b/src/Psalm/Internal/Provider/ReturnTypeProvider/SprintfReturnTypeProvider.php
@@ -78,6 +78,8 @@ public static function getFunctionReturnType(FunctionReturnTypeProviderEvent $ev
             }
         }
 
+        // PHP 7 handling for formats that do not contain anything but placeholders
+        $is_falsable = true;
         foreach ($call_args as $index => $call_arg) {
             $type = $node_type_provider->getType($call_arg->value);
             if ($type === null && $index === 0 && $event->getFunctionId() === 'printf') {
@@ -259,11 +261,15 @@ public static function getFunctionReturnType(FunctionReturnTypeProviderEvent $ev
                     return Type::getNonEmptyString();
                 }
 
-                // if we didn't have a valid result
+                // if we didn't have any valid result
                 // the pattern is invalid or not yet supported by the return type provider
                 if ($initial_result === null || $initial_result === false) {
                     return null;
                 }
+
+                // the initial result is an empty string
+                // which means the format is valid and it depends on the args, whether it is non-empty-string or not
+                $is_falsable = false;
             }
 
             if ($index === 0 && $event->getFunctionId() === 'printf') {
@@ -307,6 +313,10 @@ public static function getFunctionReturnType(FunctionReturnTypeProviderEvent $ev
             return Type::getNonEmptyString();
         }
 
+        if ( $is_falsable === false ) {
+            return Type::getString();
+        }
+
         return null;
     }
 }
diff --git a/tests/ReturnTypeProvider/SprintfTest.php b/tests/ReturnTypeProvider/SprintfTest.php
@@ -130,6 +130,8 @@ public function providerValidCodeParse(): iterable
             'assertions' => [
                 '$val===' => 'int<0, max>',
             ],
+            'ignored_issues' => [],
+            'php_version' => '8.0',
         ];
 
         yield 'sprintfEmptyStringFormat' => [
@@ -163,6 +165,8 @@ public function providerValidCodeParse(): iterable
             'assertions' => [
                 '$val===' => 'string',
             ],
+            'ignored_issues' => [],
+            'php_version' => '8.0',
         ];
 
         yield 'sprintfComplexPlaceholderNotYetSupported2' => [
@@ -172,6 +176,8 @@ public function providerValidCodeParse(): iterable
             'assertions' => [
                 '$val===' => 'string',
             ],
+            'ignored_issues' => [],
+            'php_version' => '8.0',
         ];
 
         yield 'sprintfComplexPlaceholderNotYetSupported3' => [
@@ -181,6 +187,8 @@ public function providerValidCodeParse(): iterable
             'assertions' => [
                 '$val===' => 'string',
             ],
+            'ignored_issues' => [],
+            'php_version' => '8.0',
         ];
 
         yield 'sprintfSplatUnpackingArray' => [
@@ -191,6 +199,8 @@ public function providerValidCodeParse(): iterable
             'assertions' => [
                 '$val===' => 'string',
             ],
+            'ignored_issues' => [],
+            'php_version' => '8.0',
         ];
 
         yield 'sprintfSplatUnpackingArrayNonEmpty' => [
@@ -202,6 +212,28 @@ public function providerValidCodeParse(): iterable
                 '$val===' => 'non-empty-string',
             ],
         ];
+
+        yield 'sprintfMultiplePlaceholdersNoErrorsIssue9941PHP7' => [
+            'code' => '<?php
+                $val = sprintf("Handling product %d => %d (%d)", 123, 456, 789);
+            ',
+            'assertions' => [
+                '$val===' => 'non-empty-string',
+            ],
+            'ignored_issues' => [],
+            'php_version' => '7.4',
+        ];
+
+        yield 'sprintfMultiplePlaceholdersNoErrorsIssue9941PHP8' => [
+            'code' => '<?php
+                $val = sprintf("Handling product %d => %d (%d)", 123, 456, 789);
+            ',
+            'assertions' => [
+                '$val===' => 'non-empty-string',
+            ],
+            'ignored_issues' => [],
+            'php_version' => '8.0',
+        ];
     }
 
     public function providerInvalidCodeParse(): iterable