Prepare for PHPStan 1.0 #6744

ondrejmirtes · 2021-10-14T09:05:42Z

Hello everyone 👋

I announced today that PHPStan 1.0 is going to be released on November 1st 2021.

I'm approaching you as one of the most popular projects using PHPStan internally. I'd love if you could prepare your code for PHPStan 1.0 in advance so that it's ready to release on the same day.

Here's a brief guide how to approach the upgrade:

Create a branch 🌴
Update your composer.json to "phpstan/phpstan": "^1.0", add "minimum-stability": "dev" and "prefer-stable": true if necessary.
Update your code with the BC breaks below in mind. 🔧
Fix the code so that it passes PHPStan's analysis 🤓
Wait for PHPStan 1.0 release on November 1st, merge your branch and tag the next major version 👍

Thank you!

Here are the BC breaks. The list is huge but most of those have very little impact.

There are new rules around using PHPStan internals in regard to backward compatibility promise: https://phpstan.org/developing-extensions/backward-compatibility-promise

It's possible that not everything you use is covered by it - so I'm here to help you to transition to correct usage, or add some @api annotations in PHPStan itself so that more is covered by the promise. Let me know!

BC breaks for end-users

Level max is now level 9. Feel free to update max to 8 if your code isn't ready.
Description of some types was updated to match the syntax in PHPDocs. This includes numeric-string (it was previously described as string&numeric), and also array shapes.
Removed baselineNeon error formatter, use --generate-baseline CLI option instead (phpstan/phpstan-src@492cfbc)
Removed polluteCatchScopeWithTryAssignments config parameter (phpstan/phpstan-src@8933c7e)
Removed deprecated autoload_files parameter - use Discovering Symbols instead (phpstan/phpstan-src@7a21246)
Removed deprecated autoload_directories parameter - use Discovering Symbols instead (phpstan/phpstan-src@f67b48a)
Removed bootstrap parameter - use bootstrapFiles instead (phpstan/phpstan-src@1baa294)
Moved implicitThrows configuration parameter to exceptions.implicitThrows (phpstan/phpstan-src@96b7c48)
Removed --paths-file CLI option (phpstan/phpstan-src@5670cf2)
Removed dump-deps command (phpstan/phpstan-src@9c7017c)
Deprecated excludes_analyse option, use excludePaths instead (phpstan/phpstan-src@d25c5e5)

The following are interesting only if you create a custom ruleset in your configuration file:

Removed DeadCatchRule, replaced by CatchWithUnthrownExceptionRule (phpstan/phpstan-src@4dba60b)
Removed VariableCertaintyInIssetRule, replaced by IssetRule (phpstan/phpstan-src@2e858de)
Removed MissingClosureNativeReturnTypehintRule, no longer needed thanks to type inference (phpstan/phpstan-src@1c34d8d)
Rename rules with typos (phpstan/phpstan-src@003ab1a)

BC breaks for extension developers

Extensions are checked with rules for correct usage of PHPStan internals according to backward compatibility promise.
Removed CompoundTypeHelper (phpstan/phpstan-src@145c4e3)
Removed CommentHelper (phpstan/phpstan-src@ebad6f6)
Removed DependencyDumper (phpstan/phpstan-src@9c7017c)
Removed PHPStan\Reflection\Generic\ResolvedFunctionVariant, replaced by PHPStan\Reflection\ResolvedFunctionVariant (phpstan/phpstan-src@1cc6c81)
Removed ClassReflection::getNativeMethods(), use getNativeReflection() instead (phpstan/phpstan-src@d2c1446)
Removed PhpPropertyReflection::hasPhpDoc(), replaced by hasPhpDocType() (phpstan/phpstan-src@bedd5be)
NodeDependencies no longer iterable (phpstan/phpstan-src@f76875a)
Renamed TestCase to PHPStanTestCase (#634), thanks @frankdejonge!
StaticType and ThisType - require ClassReflection in constructor (phpstan/phpstan-src@7aabc84)
PHPStanTestCase - extensions can no longer be provided by overriding methods from PHPStanTestCase. Use getAdditionalConfigFiles() instead. (phpstan/phpstan-src@65efd93, phpstan/phpstan-src@239291a)
Removed some unused internal helper methods from Broker (phpstan/phpstan-src@d578151)
Changed return types of various methods that had |false to |null (phpstan/phpstan-src@629ccf6)
Type generalization precision is now a required argument (phpstan/phpstan-src@6568103)
Some constructor parameters are now required (phpstan/phpstan-src@1f4062f)
Deprecated BrokerAwareExtension (phpstan/phpstan-src@db2f7fb)
Deprecated PHPStanTestCase::createBroker(). Use createReflectionProvider() instead. (phpstan/phpstan-src@1e5cf58)
Deprecated PHPStan\Broker\Broker. Use PHPStan\Reflection\ReflectionProvider instead. (phpstan/phpstan-src@c775594)
Deprecated PHPStan\Broker\Broker::getInstance(). Use PHPStan\Reflection\ReflectionProviderStaticAccessor instead. (phpstan/phpstan-src@4e7d60d)

The text was updated successfully, but these errors were encountered:

TomasVotruba · 2021-10-14T09:09:35Z

Thanks Ondra, mainly for the list of changes and commit references 👍

Is there Rector set I can run to upgrade all the BC breaks? 😆

ondrejmirtes · 2021-10-14T09:14:04Z

Is there Rector set I can run to upgrade all the BC breaks?

There isn't, and I don't know if it's possible to write one because of the circular dependency nature with PHPStan. People would have to stay on an old version of Rector that requires PHPStan 0.12.x in order to run it.

TomasVotruba · 2021-10-14T09:33:30Z

That can be done, as first you run upgrade code, then composer update.

I'll see how many changes are needed in Rector + Symplify + custom rules in projects I workh with. If it will be more than 50, I'll put a set together 👍

TomasVotruba · 2021-10-23T23:34:11Z

Additional Changes

PHPStan\Parser\Parser and PhpParser\Parser are not autowired anymore
- solution: using symplify/astral use Symplify\Astral\PhpParser\SmartPhpParser type instead, see [Astral] Add ReflectionParser + SmartPhpParser deprecated-packages/symplify#3703
PHPStan\Reflection\ClassReflection::getFileName() and getParentClass() returned false|*, now it returns null|* - commit phpstan/phpstan-src@629ccf6
- 🔨 TODO - create generic Rector rule?
the PHPStan\Reflection\BetterReflection\SourceLocator\OptimizedDirectorySourceLocator had 2 arguments, now has 3 - requires 2nd argument of PhpVersion object - commit phpstan/phpstan-src@b7bd0a9

ondrejmirtes · 2021-10-24T08:25:27Z

Hi, yeah, if you need PHPStan\Parser\Parser, you should create exactly the instance you need and register it as your own service.

Some implementations you can choose from are:

SimpleParser - thin wrapper around PhpParser\Parser
RichParser - adds some useful attributes to nodes but is more memory hungry
CleaningParser - removes function bodies so if you're interested only in function signatures and PHPDocs, and want to cache the AST, this is the one you want. This is the one that PHPStan uses for parsing vendor.
PathRoutingParser - wrapper of three different parsers, chooses the right one based on the path of the parsed file. phpstorm-stubs always need to be analysed with PHP 8 parser (using Emulative lexer), analysed files need to be analysed with RichParser, vendor dependencies are analysed with SimpleParser (wrapped in CleaningParser). You probably don't want this one in Rector.
CachedParser - caching wrapper around another PHPStan\Parser\Parser instance

In your case, I'd probably create SimpleParser instance with PHP 8 PhpParser inside (created with Emulative lexer) and wrapped it in CachedParser for faster performance.

To see what instances are used in PHPStan, refer to the DI config: https://github.com/phpstan/phpstan-src/blob/99e4ae0dced58fe0be7a7aec3168a5e9d639240a/conf/config.neon#L1517-L1557 and https://github.com/phpstan/phpstan-src/blob/99e4ae0dced58fe0be7a7aec3168a5e9d639240a/conf/config.neon#L1669-L1691

TomasVotruba · 2021-10-24T11:49:07Z

@ondrejmirtes Awesome, thanks for details and links! It's very helpful

In your case, I'd probably create SimpleParser instance with PHP 8 PhpParser inside (created with Emulative lexer) and wrapped it in CachedParser for faster performance.

I'll give it a try 👍

To see what instances are used in PHPStan, refer to the DI config

👏 🥇

TomasVotruba · 2021-10-25T15:50:30Z

@ondrejmirtes Hi Ondra, I'm almost finished, thank to your specific commit list. Thank you for that.

Last issue I have is that in ~10 cases the PropertyFetch type analyzer broke. It returned specific type before, but now it returns MixedType. Any idea what could have changed?

ondrejmirtes · 2021-10-25T15:51:41Z

@TomasVotruba Can you show me the code that works with PHPStan and is now broken? Also can it be reproduced on phpstan.org with \PHPStan\dumpType($this->property)?

ondrejmirtes · 2021-10-25T15:52:41Z

Also please show me example of analysed code that now fails and example of code that still passes, so I can get some ideas what changed.

TomasVotruba · 2021-10-25T16:05:08Z

It can be seen in any failing test case in this PR: rectorphp/rector-src#1052

E.g. the most isolated error is property fetch in https://github.com/rectorphp/rector-symfony

This line:
https://github.com/rectorphp/rector-symfony/blob/8020e46c0ea9d7769b896f392ad96ff11bcbb745/tests/Rector/MethodCall/SwiftCreateMessageToNewEmailRector/Fixture/fixture.php.inc#L18

The $this->swift was resolved as ObjectType of Swift_Mailer. Now its MixedType.
The Swift_Mailer exists as a stub an is loaded by composer.json

I'm gonna try to reproduce in demo now.

TomasVotruba · 2021-10-25T16:07:10Z

Demo seems ok: https://phpstan.org/r/c2dc2a85-d931-4fbf-a639-00dcf6149f17

ondrejmirtes · 2021-10-25T16:09:30Z

So which parser did you choose? :) Looks like the analysed code is passed through the CleaningParser mentioned above and https://phpstan.org/config-reference#inferprivatepropertytypefromconstructor doesn't work (because it doesn't see the constructor body).

TomasVotruba · 2021-10-25T16:09:39Z

This will be the problematic class in Rector: https://github.com/rectorphp/rector-src/blob/48cb8a256db8cabbf00d7a125fb838d843d9415e/packages/NodeTypeResolver/NodeTypeResolver/PropertyTypeResolver.php#L43-L47

I'm trying to analyse type of property based on fake property fetch.

TomasVotruba · 2021-10-25T16:25:04Z

There was no change in parser, we use native php-parser here.

The inferPrivatePropertyTypeFromConstructor is always enabled for PHPStan we use.

I've found 2 commits in PHPStan that might have affected it:

I would try to invert the code manually to verify if thats the place, but due to PHAR I can't change the code.

ondrejmirtes · 2021-10-25T16:36:18Z

There was no change in parser, we use native php-parser here.

That's not true. The code in PHPStan that infers property types from constructor uses some PHPStan's Parser instance. So you need to examine that.

TomasVotruba · 2021-10-25T16:38:30Z

I mean in our code, I didn't do any change.

TomasVotruba · 2021-10-25T16:39:20Z

So to make inference work, now the PHPStan parser has to be used?
Could you link the commit where this change? Maybe that would help me to understand what should be changed in here.

ondrejmirtes · 2021-10-25T16:40:38Z

You need to do some changes based on this comment #6744 (comment)

Because PHPStan internally still uses its own parser. You might have to override defaultAnalysisParser service with a different implementation so that it works for you.

ondrejmirtes · 2021-10-25T16:43:28Z

We can schedule a call for Wednesday morning if you're struggling with this. 👍

TomasVotruba · 2021-10-25T18:44:35Z

I'm trying to resolve it last 5 hours without much success :D

Call would be very helpful, thank you 👍 At 8/9/10 hrs?

ondrejmirtes · 2021-10-25T19:02:33Z

10:00 would be ideal - we can use Google Meet, or plain old phone call.

RobinHoutevelts · 2021-11-01T14:02:03Z

Happy to see such teamwork! 🚀 🤩

@TomasVotruba Is there a timeframe for a next release?

Rector has support for phpstan ^1.0 but hasn't made a release yet. Please follow rectorphp/rector#6744

bitgandtter · 2021-11-02T13:24:32Z

there is any ETA for this one?

TomasVotruba · 2021-11-02T13:38:01Z

Hi, we're currently testing Symplify 10 that is using PHPStan 1.0 and NEON traversing.
There is couple bugs to catch before releasing Rector :)

I think this or start of next week is doable.

samsonasik · 2021-11-05T13:35:28Z

@TomasVotruba another known issue on PHP 7.x

RichParser error on dev-main on PHP 7.4 #6779

The CI github action show the error at e2e/define-constant https://github.com/rectorphp/rector/runs/4117180235?check_suite_focus=true

alexander-schranz · 2021-11-12T15:00:31Z

Looks like this can be closed now 🎉

TomasVotruba · 2021-11-12T19:12:59Z

Indeed, thanks for reminder 🤗

Kocal · 2021-11-12T20:57:39Z

Yay! Nice work! :)

ondrejmirtes added the feature label Oct 14, 2021

ondrejmirtes mentioned this issue Oct 24, 2021

Prepare for PHPStan 1.0 larastan/larastan#964

Closed

This was referenced Oct 24, 2021

[Astral] Add ReflectionParser + SmartPhpParser deprecated-packages/symplify#3703

Merged

[PHPStan 1.0] Manual updates to new syntax rectorphp/rector-src#1052

Closed

ondrejmirtes mentioned this issue Oct 29, 2021

nikic/php-parser updated, and it broke either custom PHPStan's extension placed in a project's code or PHPStan itself phpstan/phpstan#5851

Closed

RobinHoutevelts added a commit to RobinHoutevelts/wmcodestyle that referenced this issue Nov 1, 2021

Update phpstan to 1.0

6d96510

Rector has support for phpstan ^1.0 but hasn't made a release yet. Please follow rectorphp/rector#6744

RobinHoutevelts mentioned this issue Nov 1, 2021

Update PHPStan to 1.0 wieni/wmcodestyle#19

Closed

This was referenced Nov 5, 2021

RichParser error on dev-main on PHP 7.4 #6779

Closed

Sets don't include implied sets from prior versions rectorphp/rector-symfony#39

Closed

sasezaki mentioned this issue Nov 9, 2021

Support phpstan 1 Slamdunk/phpstan-extensions#37

Closed

TomasVotruba closed this as completed Nov 12, 2021

TomasVotruba mentioned this issue Nov 18, 2021

conflict with phpstan 0.x #6810

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Prepare for PHPStan 1.0 #6744

Prepare for PHPStan 1.0 #6744

ondrejmirtes commented Oct 14, 2021

TomasVotruba commented Oct 14, 2021 •

edited

Loading

ondrejmirtes commented Oct 14, 2021

TomasVotruba commented Oct 14, 2021 •

edited

Loading

TomasVotruba commented Oct 23, 2021 •

edited

Loading

ondrejmirtes commented Oct 24, 2021

TomasVotruba commented Oct 24, 2021 •

edited

Loading

TomasVotruba commented Oct 25, 2021

ondrejmirtes commented Oct 25, 2021

ondrejmirtes commented Oct 25, 2021

TomasVotruba commented Oct 25, 2021 •

edited

Loading

TomasVotruba commented Oct 25, 2021

ondrejmirtes commented Oct 25, 2021

TomasVotruba commented Oct 25, 2021

TomasVotruba commented Oct 25, 2021

ondrejmirtes commented Oct 25, 2021

TomasVotruba commented Oct 25, 2021

TomasVotruba commented Oct 25, 2021

ondrejmirtes commented Oct 25, 2021

ondrejmirtes commented Oct 25, 2021

TomasVotruba commented Oct 25, 2021 •

edited

Loading

ondrejmirtes commented Oct 25, 2021

RobinHoutevelts commented Nov 1, 2021

bitgandtter commented Nov 2, 2021

TomasVotruba commented Nov 2, 2021

samsonasik commented Nov 5, 2021 •

edited

Loading

alexander-schranz commented Nov 12, 2021

TomasVotruba commented Nov 12, 2021 •

edited

Loading

Kocal commented Nov 12, 2021 •

edited

Loading

Prepare for PHPStan 1.0 #6744

Prepare for PHPStan 1.0 #6744

Comments

ondrejmirtes commented Oct 14, 2021

BC breaks for end-users

BC breaks for extension developers

TomasVotruba commented Oct 14, 2021 • edited Loading

ondrejmirtes commented Oct 14, 2021

TomasVotruba commented Oct 14, 2021 • edited Loading

TomasVotruba commented Oct 23, 2021 • edited Loading

Additional Changes

ondrejmirtes commented Oct 24, 2021

TomasVotruba commented Oct 24, 2021 • edited Loading

TomasVotruba commented Oct 25, 2021

ondrejmirtes commented Oct 25, 2021

ondrejmirtes commented Oct 25, 2021

TomasVotruba commented Oct 25, 2021 • edited Loading

TomasVotruba commented Oct 25, 2021

ondrejmirtes commented Oct 25, 2021

TomasVotruba commented Oct 25, 2021

TomasVotruba commented Oct 25, 2021

ondrejmirtes commented Oct 25, 2021

TomasVotruba commented Oct 25, 2021

TomasVotruba commented Oct 25, 2021

ondrejmirtes commented Oct 25, 2021

ondrejmirtes commented Oct 25, 2021

TomasVotruba commented Oct 25, 2021 • edited Loading

ondrejmirtes commented Oct 25, 2021

RobinHoutevelts commented Nov 1, 2021

bitgandtter commented Nov 2, 2021

TomasVotruba commented Nov 2, 2021

samsonasik commented Nov 5, 2021 • edited Loading

alexander-schranz commented Nov 12, 2021

TomasVotruba commented Nov 12, 2021 • edited Loading

Kocal commented Nov 12, 2021 • edited Loading

TomasVotruba commented Oct 14, 2021 •

edited

Loading

TomasVotruba commented Oct 14, 2021 •

edited

Loading

TomasVotruba commented Oct 23, 2021 •

edited

Loading

TomasVotruba commented Oct 24, 2021 •

edited

Loading

TomasVotruba commented Oct 25, 2021 •

edited

Loading

TomasVotruba commented Oct 25, 2021 •

edited

Loading

samsonasik commented Nov 5, 2021 •

edited

Loading

TomasVotruba commented Nov 12, 2021 •

edited

Loading

Kocal commented Nov 12, 2021 •

edited

Loading