[11.x] Update PHPStan to 2.x by tamiroh · Pull Request #53716 · laravel/framework

tamiroh · 2024-11-30T11:47:40Z

PHPStan 2.0 has been released so this pull request updates PHPStan version to 2.x.

Most of the fixes are under types/.

github-actions · 2024-11-30T11:47:56Z

Thanks for submitting a PR!

Note that draft PR's are not reviewed. If you would like a review, please mark your pull request as ready for review in the GitHub user interface.

Pull requests that are abandoned in draft may be closed due to inactivity.

taylorotwell · 2024-11-30T22:33:11Z

All those hard-coded integers seem kinda weird?

sydgren · 2024-12-19T23:54:31Z


            return new ProcessResult(tap($process)->run($output));
        } catch (SymfonyTimeoutException $e) {
+            /** @phpstan-ignore variable.undefined */


Ignoring errors doesn't seem right.

Maybe move $process = $this->toSymfonyProcess($command); out of the try section instead?

Indeed. Fixed in 7ce889a.

sydgren · 2024-12-19T23:56:15Z

 use function PHPStan\Testing\assertType;

-new class implements ValidationRule
+$class = new class implements ValidationRule


Suggested change

$class = new class implements ValidationRule

new class implements ValidationRule

The instance must be assigned to some variable to avoid the following error...

------ ----------------------------------------------------------------------------------------------------------------------------- Line ValidationRule.php ------ ----------------------------------------------------------------------------------------------------------------------------- 7 Expression "new class implements \Illuminate\Contracts\Validation\ValidationRule…" on a separate line does not do anything. 🪪 expr.resultUnused ------ -----------------------------------------------------------------------------------------------------------------------------

The error is valid, but the real problem is something else

Looking at the entire file, it doesn't seem like it's testing anything. The class is being instantiated, but the assertion call is inside a method that isn't being called.

I'd rather see the test being reworked so there's a point in even having it.

Certainly this assertion is not called when this code is executed, but when it is analyzed by PHPStan the assertion is performed. If the assertion results in an error, PHPStan reports it :).

sydgren · 2024-12-19T23:57:33Z

+assertType('36', $cache->remember('cache', now(), function (): int {
    return 36;
 }));


I would assume that a callback with int return type would result in a type called int and not 36. There seems to be a problem elsewhere.

All these type assertions should remain unchanged.

I think that since PHPStan 2.0, types are inferred more narrowly, in this case as 36 literal type.

https://phpstan.org/writing-php-code/phpdoc-types#literals-and-constants

I hope that's something that can be configured somewhere, since the returned type is a string with the number, so the "literal" part is misleading.

This points at a problem with the method signature which has to be fixed first. PHPStan really does no longer generalizes scalar values (going from 42 to int) because it causes problems with how people use generics.

When we look at the signature in question, it realy doesn't make much sense:

framework/src/Illuminate/Cache/Repository.php

Lines 406 to 416 in 4a74d20

/**

* Get an item from the cache, or execute the given Closure and store the result.

*

* @template TCacheValue

*

* @param string $key

* @param \Closure|\DateTimeInterface|\DateInterval|int|null $ttl

* @param \Closure(): TCacheValue $callback

* @return TCacheValue

*/

public function remember($key, $ttl, Closure $callback)

You have no guarantee the value type in the cache will be the same as the type returned by the callback. This method should just return mixed because we don't know what's going to be in the cache.

I recommend stopping using generics for cases like these, TDefault etc.

Also it occured to me this behaviour and this signature might be fine. If the closure returns "int" (for example it calls a function that has "int" return type), the infered TCacheValue will be "int".

If the Closure always returns "42" then it might actually be correct for TCacheValue to be "42", because nothing else will ever be written to the cache by the code, right?

Definitely some food for thought here :)

ondrejmirtes

Would be great to get this over the finish line, as PHPStan needs Laravel repository for its own integration tests, to make sure it doesn't break anything :)

ondrejmirtes · 2025-01-30T08:49:41Z

+assertType('36', $cache->remember('cache', now(), function (): int {
    return 36;
 }));


This points at a problem with the method signature which has to be fixed first. PHPStan really does no longer generalizes scalar values (going from 42 to int) because it causes problems with how people use generics.

When we look at the signature in question, it realy doesn't make much sense:

framework/src/Illuminate/Cache/Repository.php

Lines 406 to 416 in 4a74d20

/**

* Get an item from the cache, or execute the given Closure and store the result.

*

* @template TCacheValue

*

* @param string $key

* @param \Closure|\DateTimeInterface|\DateInterval|int|null $ttl

* @param \Closure(): TCacheValue $callback

* @return TCacheValue

*/

public function remember($key, $ttl, Closure $callback)

You have no guarantee the value type in the cache will be the same as the type returned by the callback. This method should just return mixed because we don't know what's going to be in the cache.

I recommend stopping using generics for cases like these, TDefault etc.

tamiroh · 2025-02-02T08:36:02Z

There may be room for improvement, but the type tests under types/ and PHPDoc can be improved after the merge, and I think it is better to merge this pull request once for now 👀.

tamiroh changed the title ~~[11.x] Use PHPStan 2.0~~ [11.x] Update PHPStan to 2.x Nov 30, 2024

tamiroh marked this pull request as ready for review November 30, 2024 13:15

taylorotwell marked this pull request as draft November 30, 2024 22:33

crynobone requested a review from nunomaduro December 10, 2024 08:18

sydgren reviewed Dec 19, 2024

View reviewed changes

tamiroh added 5 commits December 22, 2024 19:29

Update phpstan/phpstan to 2.0 👍

3b89c49

Update many types in types/

4905a79

Fix type errors in types/

f207f71

Update return type of HasAttributes::getAttributes()

07b8b0d

Add @phpstan-ignore comment on src/

f5a7a9c

tamiroh force-pushed the phpstan-2.0 branch from 05647e8 to f5a7a9c Compare December 22, 2024 10:29

Fix variable.undefined error

7ce889a

tamiroh requested a review from sydgren December 22, 2024 10:41

ondrejmirtes reviewed Jan 30, 2025

View reviewed changes

Merge branch '11.x' into phpstan-2.0

e49f344

tamiroh marked this pull request as ready for review February 2, 2025 08:39

taylorotwell merged commit 136a231 into laravel:11.x Feb 5, 2025

	$class = new class implements ValidationRule
	new class implements ValidationRule

	/**
	* Get an item from the cache, or execute the given Closure and store the result.
	*
	* @template TCacheValue
	*
	* @param string $key
	* @param \Closure\|\DateTimeInterface\|\DateInterval\|int\|null $ttl
	* @param \Closure(): TCacheValue $callback
	* @return TCacheValue
	*/
	public function remember($key, $ttl, Closure $callback)

Uh oh!

Conversation

tamiroh commented Nov 30, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Nov 30, 2024

Uh oh!

taylorotwell commented Nov 30, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tamiroh Dec 22, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tamiroh Dec 22, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ondrejmirtes left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tamiroh commented Feb 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

tamiroh commented Nov 30, 2024 •

edited

Loading

tamiroh Dec 22, 2024 •

edited

Loading

tamiroh Dec 22, 2024 •

edited

Loading

tamiroh commented Feb 2, 2025 •

edited

Loading