Increase phpstan from level 6 to level 8 #251

phil-davis · 2023-06-29T09:36:59Z

This seems to be possible without breaking the code ;)

codecov · 2023-06-29T09:38:11Z

Codecov Report

Merging #251 (fe75c5e) into master (d7cad5f) will decrease coverage by 0.16%.
Report is 2 commits behind head on master.
The diff coverage is 92.85%.

@@             Coverage Diff              @@
##             master     #251      +/-   ##
============================================
- Coverage     96.90%   96.75%   -0.16%     
+ Complexity      116      115       -1     
============================================
  Files            13       13              
  Lines           485      493       +8     
============================================
+ Hits            470      477       +7     
- Misses           15       16       +1

Files Changed	Coverage Δ
lib/Element/Base.php	`100.00% <ø> (ø)`
lib/Deserializer/functions.php	`89.21% <85.71%> (-0.48%)`	⬇️
lib/Element/Uri.php	`100.00% <100.00%> (ø)`
lib/Reader.php	`97.50% <100.00%> (ø)`
lib/Service.php	`98.61% <100.00%> (+0.01%)`	⬆️
lib/Writer.php	`100.00% <100.00%> (ø)`

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

lib/Deserializer/functions.php

phil-davis · 2023-06-29T09:40:06Z

lib/Element/Base.php

@@ -73,7 +73,7 @@ public function xmlSerialize(Xml\Writer $writer): void
     * $reader->parseInnerTree() will parse the entire sub-tree, and advance to
     * the next element.
     *
-     * @return array<string, mixed>|string|null
+     * @return array<int,array<string, mixed>>|string|null


This was an existing error in the PHPdoc. This thing returns an array of arrays.

phil-davis · 2023-06-29T09:40:24Z

lib/Reader.php

@@ -105,7 +105,7 @@ public function parse(): array
     *
     * @param array<string, mixed>|null $elementMap
     *
-     * @return array<string, mixed>
+     * @return array<int,array<string, mixed>>


This was an existing error in the PHPdoc. This thing returns an array of arrays.

phil-davis · 2023-06-29T09:40:32Z

lib/Reader.php

@@ -130,7 +130,7 @@ public function parseGetElements(array $elementMap = null): array
     *
     * @param array<string, mixed>|null $elementMap
     *
-     * @return array<string, mixed>|string|null
+     * @return array<int,array<string, mixed>>|string|null


This was an existing error in the PHPdoc. This thing returns an array of arrays.

phil-davis · 2023-06-29T09:42:03Z

lib/Element/Uri.php

@@ -59,7 +59,7 @@ public function xmlSerialize(Xml\Writer $writer): void
    {
        $writer->text(
            resolve(
-                $writer->contextUri,
+                $writer->contextUri ?? '',


contextUri starts life set to null.
phpstan can't be sure that it is no longer null
The safest thing here is to pass the empty string if it is currently null

phil-davis · 2023-06-29T09:44:31Z

lib/Reader.php

        if (is_callable($deserializer)) {
            return $deserializer;
        }

+        if (is_subclass_of($deserializer, 'Sabre\\Xml\\XmlDeserializable')) {


is_subclass_of takes a class name or object in parameter 1.
But $deserializer can be a callable function.
phpstan is happy if the check for is_callable comes first.

phil-davis · 2023-06-29T09:46:56Z

lib/Service.php

@@ -241,6 +241,7 @@ public function write(string $rootElementName, $value, string $contextUri = null
    public function mapValueObject(string $elementName, string $className): void
    {
        list($namespace) = self::parseClarkNotation($elementName);
+        $namespace = $namespace ?? '';


parseClarkNotation says that it can return string|null in the first element of the returned array.
later uses of $namespace expect a string. So just convert null to the empty string here.

Same for a few place in Writer.php below.

tests/Sabre/Xml/ServiceTest.php

phil-davis · 2023-06-29T11:30:15Z

I will also try to add some unit tests that pass non-existent functions/methods to functionCaller and see if I can cover the exceptions that should be thrown.

lib/Deserializer/functions.php

phil-davis · 2023-06-30T09:26:05Z

lib/Deserializer/functions.php

+            throw new \InvalidArgumentException(__METHOD__.' func parameter is not a callable array, string or closure.');
+        }
+    } else {
+        throw new \InvalidArgumentException(__METHOD__.' func parameter is not callable.');


I can't see a way to get to this code.
When I try to make a unit test that passes a function reference like "SomeValidClass::unknownMethod", then PHP notices that during the call to functionCaller. Even though the string passed looks like a reasonable format for a callable thing, at run-time PHP checks if the method exists in the class. And the test fails with:

TypeError: Argument 2 passed to Sabre\Xml\Deserializer\functionCaller() must be callable, string given, called in /home/phil/git/sabre-io/xml/tests/Sabre/Xml/Deserializer/FunctionCallerTest.php on line 154

So PHP really verifies that the thing passed in as parameter $func not only looks like it could be callable, but that it is actually callable.

So in real-life we don't need all this double-checking.

I will see if there is a simpler way of coding this and keeping phpstan happy at the same time.

phil-davis · 2023-07-27T09:30:01Z

lib/Deserializer/functions.php

+        // ReflectionFunction can take either of those
+        $ref = new \ReflectionFunction($func);
+    } else {
+        throw new \InvalidArgumentException(__METHOD__.' unable to use func parameter with ReflectionMethod or ReflectionFunction.');


I can't cover this line with a unit test.
My analysis is:
PHP always checks that $func is an actual callable that will work (it doesn't just check that $func has a format that looks like it should be callable, does actual check that something like "MyClass::someMethod" really is a function that exists in a class that exists.

So when we get to this "if" block, we know that $func is a working callable.

If it is in array form, then we call ReflectionMethod
If it is in string form with a "::" in it, then we also call ReflectionMethod
If it is a real Closure, or a string without "::" in it then we call ReflectionFunction (because it is an ordinary function)

And those are all the ways that a "callable" can be passed.

But if I do not have an "else" to catch Unicorns, then phpstan complains that $ref might not be defined.

I think that it is a computable task for phpstan to analyze that $ref must be defined. phpstan has to understand what are all the things whose union is a "callable". Then it can deduce that the if-elseif-... covers them all.

phil-davis · 2023-07-27T09:33:46Z

@staabm I reorganized the if-else... block in functionCaller so that it does not need to explode strings like "MyClass::someMethod". That avoids phpstan getting confused about what the exploded array is (it is still callable, but phpstan can't guess that).

I thin kthis is enough on this! Please review and I will merge if OK.

staabm

thank you

phil-davis added 4 commits June 29, 2023 14:24

increase phpstan to level 7

25373c4

adjust test code to pass phpstan level 7

c8795a0

Fix code for phpstan level 7

ade9d87

Fix code for phpstan level 8

0f54dcf

phil-davis commented Jun 29, 2023

View reviewed changes

lib/Deserializer/functions.php Outdated Show resolved Hide resolved

phil-davis commented Jun 29, 2023

View reviewed changes

tests/Sabre/Xml/ServiceTest.php Outdated Show resolved Hide resolved

phil-davis requested a review from staabm June 29, 2023 09:49

Check that callable exists in functionCaller

924cd8b

staabm reviewed Jun 29, 2023

View reviewed changes

lib/Deserializer/functions.php Outdated Show resolved Hide resolved

Use is_callable to check the func parameter to functionCaller

afdfb31

phil-davis requested a review from staabm June 30, 2023 08:53

phil-davis commented Jun 30, 2023

View reviewed changes

Remove unneeded explode of func parameter to functionCaller

fe75c5e

phil-davis commented Jul 27, 2023

View reviewed changes

staabm approved these changes Jul 27, 2023

View reviewed changes

phil-davis merged commit 531f161 into sabre-io:master Jul 27, 2023
4 of 6 checks passed

phil-davis deleted the increase-phpstan-level branch July 27, 2023 10:01

phil-davis mentioned this pull request Apr 18, 2024

More precise parseClarkNotation return type (v3) #277

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Increase phpstan from level 6 to level 8 #251

Increase phpstan from level 6 to level 8 #251

phil-davis commented Jun 29, 2023

codecov bot commented Jun 29, 2023 •

edited

Loading

phil-davis Jun 29, 2023

phil-davis Jun 29, 2023

phil-davis Jun 29, 2023

phil-davis Jun 29, 2023

phil-davis Jun 29, 2023

phil-davis Jun 29, 2023

phil-davis commented Jun 29, 2023

phil-davis Jun 30, 2023

phil-davis Jul 27, 2023

phil-davis commented Jul 27, 2023

staabm left a comment

Increase phpstan from level 6 to level 8 #251

Increase phpstan from level 6 to level 8 #251

Conversation

phil-davis commented Jun 29, 2023

codecov bot commented Jun 29, 2023 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

phil-davis commented Jun 29, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

phil-davis commented Jul 27, 2023

staabm left a comment

Choose a reason for hiding this comment

codecov bot commented Jun 29, 2023 •

edited

Loading