Upgraded phpstan dependency to 1.1 #34555

hostep · 2021-11-06T13:19:25Z

Description (*)

PHPstan version 1.0 got released earlier this week: https://phpstan.org/blog/phpstan-1-0-released
This PR changes the dependency constraints for phpstan.
This also changes the deprecated excludes_analyse config to excludePaths.

Related Pull Requests

https://github.com/magento/partners-magento2ee/pull/650

Fixed Issues (if relevant)

Update phpstan/phpstan composer dependency to v1.x #34604

Manual testing scenarios (*)

Run phpstan on various php files to see if it still works without issues, for example:

./vendor/bin/phpstan analyse --level 1 --no-progress --memory-limit=4G --configuration ./dev/tests/static/testsuite/Magento/Test/Php/_files/phpstan/phpstan.neon setup/src/Magento/Setup/Test/Unit/Console/Style/MagentoStyleTest.php

(this command comes from #30581 (comment), and also see: https://github.com/magento/magento2/blob/2.4-develop/dev/tests/static/framework/Magento/TestFramework/CodingStandard/Tool/PhpStan.php#L81-L92)

Questions or comments

Should we still allow version 0.12.x of phpstan to get installed as well, or is that not necessary?

Contribution checklist (*)

Pull request has a meaningful description of its purpose
All commits are accompanied by meaningful commit messages
All new or changed code is covered with unit/integration tests (if applicable)
README.md files for modified modules are updated and included in the pull request if any README.md predefined sections require an update
All automated tests passed successfully (all builds are green)

m2-assistant · 2021-11-06T13:19:27Z

Hi @hostep. Thank you for your contribution
Here are some useful tips how you can test your changes using Magento test environment.
Add the comment under your pull request to deploy test or vanilla Magento instance:

@magento give me test instance - deploy test instance based on PR changes
@magento give me 2.4-develop instance - deploy vanilla Magento instance

❗ Automated tests can be triggered manually with an appropriate comment:

@magento run all tests - run or re-run all required tests against the PR changes
@magento run <test-build(s)> - run or re-run specific test build(s)
For example: @magento run Unit Tests

<test-build(s)> is a comma-separated list of build names. Allowed build names are:

Database Compare
Functional Tests CE
Functional Tests EE,
Functional Tests B2B
Integration Tests
Magento Health Index
Sample Data Tests CE
Sample Data Tests EE
Sample Data Tests B2B
Static Tests
Unit Tests
WebAPI Tests
Semantic Version Checker

You can find more information about the builds here

ℹ️ Run only required test builds during development. Run all test builds before sending your pull request for review.

For more details, review the Magento Contributor Guide documentation.

⚠️ According to the Magento Contribution requirements, all Pull Requests must go through the Community Contributions Triage process. Community Contributions Triage is a public meeting.

🕙 You can find the schedule on the Magento Community Calendar page.

📞 The triage of Pull Requests happens in the queue order. If you want to speed up the delivery of your contribution, join the Community Contributions Triage session to discuss the appropriate ticket.

🎥 You can find the recording of the previous Community Contributions Triage on the Magento Youtube Channel

✏️ Feel free to post questions/proposals/feedback related to the Community Contributions Triage process to the corresponding Slack Channel

hostep · 2021-11-06T13:19:42Z

@magento run all tests

magento-automated-testing · 2021-11-06T13:19:50Z

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

ihor-sviziev · 2021-11-06T14:43:17Z

@xmav can we add it to the platform health?

magento-automated-testing · 2021-11-06T15:08:49Z

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

magento-automated-testing · 2021-11-06T19:09:29Z

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

magento-automated-testing · 2021-11-06T19:09:32Z

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

magento-automated-testing · 2021-11-07T18:33:40Z

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

magento-engcom-team · 2021-11-07T18:38:35Z

Hi @ihor-sviziev, thank you for the review.
ENGCOM-9331 has been created to process this Pull Request
✳️ @ihor-sviziev, could you please add one of the following labels to the Pull Request?

Label	Description
`Auto-Tests: Covered`	All changes in Pull Request is covered by auto-tests
`Auto-Tests: Not Covered`	Changes in Pull Request requires coverage by auto-tests
`Auto-Tests: Not Required`	Changes in Pull Request does not require coverage by auto-tests

xmav · 2021-11-08T04:16:59Z

Hi @ihor-sviziev
Yes this could be part of Platform Health. I saw version 1.1.1 - https://github.com/phpstan/phpstan/releases
Could we try it ?

xmav · 2021-11-08T04:20:19Z

(please keep target branch to 2.4-develop)

ihor-sviziev

Hi @hostep,
Could you update phpstan to latest available version (1.1.1 now)?

hostep · 2021-11-08T07:06:34Z

Done!

On my local machine, I do get this error after running that command mentioned above twice, the first time it works fine though, which is a bit weird?

➜ ./vendor/bin/phpstan analyse --level 1 --no-progress --memory-limit=4G --configuration ./dev/tests/static/testsuite/Magento/Test/Php/_files/phpstan/phpstan.neon setup/src/Magento/Setup/Test/Unit/Console/Style/MagentoStyleTest.php

In File.php line 208:

  Failed to open stream hoa://Library/Regex/Grammar.pp.

Entire stacktrace:

Exception trace:
  at vendor/hoa/file/File.php:208
 Hoa\File\File->_open() at vendor/hoa/file/Read.php:105
 Hoa\File\Read->_open() at vendor/hoa/stream/Stream.php:219
 Hoa\Stream\Stream::_getStream() at vendor/hoa/stream/Stream.php:297
 Hoa\Stream\Stream->open() at vendor/hoa/stream/Stream.php:178
 Hoa\Stream\Stream->__construct() at vendor/hoa/file/File.php:181
 Hoa\File\File->__construct() at vendor/hoa/file/Read.php:66
 Hoa\File\Read->__construct() at /private/var/folders/wr/w5n5bdgn1pb3wxws02x83qch0000gn/T/phpstan/cache/nette.configurator/Container_e87f1fc81a.php:5285
 Container_e87f1fc81a->createServiceRegexGrammarStream() at phar://vendor/phpstan/phpstan/phpstan.phar/vendor/nette/di/src/DI/Container.php:157
 _PHPStan_9b5387833\Nette\DI\Container->createService() at phar://vendor/phpstan/phpstan/phpstan.phar/vendor/nette/di/src/DI/Container.php:90
 _PHPStan_9b5387833\Nette\DI\Container->getService() at /private/var/folders/wr/w5n5bdgn1pb3wxws02x83qch0000gn/T/phpstan/cache/nette.configurator/Container_e87f1fc81a.php:5291
 Container_e87f1fc81a->createServiceRegexParser() at phar://vendor/phpstan/phpstan/phpstan.phar/vendor/nette/di/src/DI/Container.php:157
 _PHPStan_9b5387833\Nette\DI\Container->createService() at phar://vendor/phpstan/phpstan/phpstan.phar/vendor/nette/di/src/DI/Container.php:90
 _PHPStan_9b5387833\Nette\DI\Container->getService() at /private/var/folders/wr/w5n5bdgn1pb3wxws02x83qch0000gn/T/phpstan/cache/nette.configurator/Container_e87f1fc81a.php:3209
 Container_e87f1fc81a->createService033() at phar://vendor/phpstan/phpstan/phpstan.phar/vendor/nette/di/src/DI/Container.php:157
 _PHPStan_9b5387833\Nette\DI\Container->createService() at phar://vendor/phpstan/phpstan/phpstan.phar/vendor/nette/di/src/DI/Container.php:90
 _PHPStan_9b5387833\Nette\DI\Container->getService() at /private/var/folders/wr/w5n5bdgn1pb3wxws02x83qch0000gn/T/phpstan/cache/nette.configurator/Container_e87f1fc81a.php:3028
 Container_e87f1fc81a->createService024() at phar://vendor/phpstan/phpstan/phpstan.phar/vendor/nette/di/src/DI/Container.php:157
 _PHPStan_9b5387833\Nette\DI\Container->createService() at phar://vendor/phpstan/phpstan/phpstan.phar/vendor/nette/di/src/DI/Container.php:90
 _PHPStan_9b5387833\Nette\DI\Container->getService() at /private/var/folders/wr/w5n5bdgn1pb3wxws02x83qch0000gn/T/phpstan/cache/nette.configurator/Container_e87f1fc81a.php:3172
 Container_e87f1fc81a->createService030() at phar://vendor/phpstan/phpstan/phpstan.phar/vendor/nette/di/src/DI/Container.php:157
 _PHPStan_9b5387833\Nette\DI\Container->createService() at phar://vendor/phpstan/phpstan/phpstan.phar/vendor/nette/di/src/DI/Container.php:90
 _PHPStan_9b5387833\Nette\DI\Container->getService() at phar://vendor/phpstan/phpstan/phpstan.phar/vendor/nette/di/src/DI/Container.php:177
 _PHPStan_9b5387833\Nette\DI\Container->getByType() at phar://vendor/phpstan/phpstan/phpstan.phar/src/DependencyInjection/Nette/NetteContainer.php:36
 PHPStan\DependencyInjection\Nette\NetteContainer->getByType() at phar://vendor/phpstan/phpstan/phpstan.phar/src/DependencyInjection/MemoizingContainer.php:37
 PHPStan\DependencyInjection\MemoizingContainer->getByType() at phar://vendor/phpstan/phpstan/phpstan.phar/src/Command/AnalyseCommand.php:138
 PHPStan\Command\AnalyseCommand->execute() at phar://vendor/phpstan/phpstan/phpstan.phar/vendor/symfony/console/Command/Command.php:228
 _PHPStan_9b5387833\Symfony\Component\Console\Command\Command->run() at phar://vendor/phpstan/phpstan/phpstan.phar/vendor/symfony/console/Application.php:856
 _PHPStan_9b5387833\Symfony\Component\Console\Application->doRunCommand() at phar://vendor/phpstan/phpstan/phpstan.phar/vendor/symfony/console/Application.php:237
 _PHPStan_9b5387833\Symfony\Component\Console\Application->doRun() at phar://vendor/phpstan/phpstan/phpstan.phar/vendor/symfony/console/Application.php:138
 _PHPStan_9b5387833\Symfony\Component\Console\Application->run() at phar://vendor/phpstan/phpstan/phpstan.phar/bin/phpstan:82
 _PHPStan_9b5387833\{closure}() at phar://vendor/phpstan/phpstan/phpstan.phar/bin/phpstan:83
 require() at vendor/phpstan/phpstan/phpstan:8

ihor-sviziev · 2021-11-08T07:24:39Z

@magento run all tests

andrewbess · 2021-11-10T12:24:24Z

I have fixed the merge-conflicts here

andrewbess · 2021-11-10T12:24:36Z

@magento run all tests

magento-automated-testing · 2021-11-10T12:24:44Z

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

andrewbess · 2021-11-10T12:25:58Z

@magento run all tests

magento-automated-testing · 2021-11-10T12:26:04Z

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

andrewbess · 2021-11-10T15:12:59Z

@magento run Unit Tests with env PHP 8.1 with edition CE without extensions magento-commerce/inventory, magento-commerce/adobe-stock-integration, magento-commerce/security-package, magento-commerce/magento2-page-builder, magento-commerce/adobe-ims

magento-automated-testing · 2021-11-10T15:13:06Z

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

xmav · 2021-11-10T15:29:32Z

works fine with a big change set. Tested on 2.4(2.4.3)<=>2.4-develop (2.4...2.4-develop)

xmav · 2021-11-10T22:57:11Z

@magento import code to Magento-trigger/magento2ce

m2-github-services · 2021-11-10T22:58:55Z

@xmav an error occurred during the Pull Request import.

xmav · 2021-11-10T23:55:10Z

@magento import code to Magento-trigger/magento2ce

m2-github-services · 2021-11-10T23:56:57Z

@xmav the branch with the code is successfully imported into the Magento-trigger/magento2ce repository. Branch name: imported-hostep-magento2-34555.

xmav · 2021-11-11T01:19:30Z

Hi @hostep @andrewbess
I would ask for one more change: change version constrain to ~1.1.0.
Other than that it looks good

Thanks!

andrewbess · 2021-11-11T20:36:08Z

@magento run all tests

magento-automated-testing · 2021-11-11T20:36:13Z

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

andrewbess · 2021-11-11T20:37:15Z

@magento run all tests

magento-automated-testing · 2021-11-11T20:37:21Z

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

xmav · 2021-11-11T23:42:44Z

Functional Tests issue unrelated to changes in this PR.

xmav · 2021-11-11T23:42:50Z

@magento import code to Magento-trigger/magento2ce

m2-github-services · 2021-11-11T23:44:01Z

@xmav the branch with the code is successfully imported into the Magento-trigger/magento2ce repository. Branch name: imported-hostep-magento2-34555.

hostep · 2021-11-12T06:58:28Z

@xmav:

I would ask for one more change: change version constrain to ~1.1.0.

Why? Have you read the backwards compatibility promise for developers and for users?

This article talks about classes, interfaces, and methods that can be safely used by extension developers without the risk of breaking in minor versions.

xmav · 2021-11-12T07:36:52Z

Hi @hostep
Thank you for pointing to that article. Main background under that is to have builds stable. We may change constraints to be more loose over time.

hostep · 2021-11-12T08:19:59Z

Ok thanks, but the problem is that I'll have to send in yet another PR within a week or 2 when version 1.2.0 gets released, so this will be a maintenance nightmare if we want to stay close to the latest version of phpstan I'm afraid.
I can see why you want those constraints set like this for packages where it's not clear how they deal with semantic versioning or backwards compatibilities, but in this case it's pretty clear.

xmav · 2021-11-12T17:01:43Z

even if we will use loose constraint someone should do composer update and push updated composer.lock file to use new version.

hostep · 2021-11-13T09:22:32Z

@xmav: Exactly, and that's a good thing!

So this would allow core Magento to only update phpstan when you want to, but will allow the users of the Magento software to still update phpstan to newer versions, because the users might want to stay closer to the latest version to benefit from new features and bugfixes.

hostep · 2021-11-18T16:11:16Z

@xmav, As predicted, phpstan 1.2.0 was released today: https://github.com/phpstan/phpstan/releases/tag/1.2.0

Since it contains support for new PHP 8.1 features, I believe we should probably upgrade it again over here ... (and maybe this time use ^ instead of ~ notation in the constraints ... 😉 )
If somebody is willing to do so, please do, I'm leaving in holiday for the next 3 weeks, so I won't have time to look into this myself.

Thanks!

magento-engcom-team added the Release Line: 2.4 label Nov 6, 2021

m2-community-project bot added the Progress: pending review label Nov 6, 2021

andrewbess self-assigned this Nov 6, 2021

m2-community-project bot added Progress: review and removed Progress: pending review labels Nov 6, 2021

ihor-sviziev approved these changes Nov 7, 2021

View reviewed changes

m2-community-project bot assigned ihor-sviziev Nov 7, 2021

m2-community-project bot added Progress: ready for testing and removed Progress: review labels Nov 7, 2021

ihor-sviziev requested changes Nov 8, 2021

View reviewed changes

m2-community-project bot added Progress: needs update and removed Progress: ready for testing labels Nov 8, 2021

hostep force-pushed the upgrade-phpstan-to-first-stable-version branch from a8c0133 to b2e0b1f Compare November 8, 2021 07:05

Fixed constraint for phpstan/phpstan according to reviewer request

e7c8809

Merge branch '2.4-develop' into upgrade-phpstan-to-first-stable-version

1675c5b

magento-engcom-team merged commit a67c012 into magento:2.4-develop Nov 12, 2021

This pull request was closed.

Upgraded phpstan dependency to 1.1 #34555

Upgraded phpstan dependency to 1.1 #34555

Conversation

hostep commented Nov 6, 2021 • edited by andrewbess Loading

Description (*)

Related Pull Requests

Fixed Issues (if relevant)

Manual testing scenarios (*)

Questions or comments

Contribution checklist (*)

m2-assistant bot commented Nov 6, 2021

hostep commented Nov 6, 2021

magento-automated-testing bot commented Nov 6, 2021

ihor-sviziev commented Nov 6, 2021

magento-automated-testing bot commented Nov 6, 2021

magento-automated-testing bot commented Nov 6, 2021

magento-automated-testing bot commented Nov 6, 2021

magento-automated-testing bot commented Nov 7, 2021

magento-engcom-team commented Nov 7, 2021

xmav commented Nov 8, 2021

xmav commented Nov 8, 2021

ihor-sviziev left a comment

Choose a reason for hiding this comment

hostep commented Nov 8, 2021 • edited Loading

ihor-sviziev commented Nov 8, 2021

andrewbess commented Nov 10, 2021

andrewbess commented Nov 10, 2021

magento-automated-testing bot commented Nov 10, 2021

andrewbess commented Nov 10, 2021

magento-automated-testing bot commented Nov 10, 2021

andrewbess commented Nov 10, 2021

magento-automated-testing bot commented Nov 10, 2021

xmav commented Nov 10, 2021

xmav commented Nov 10, 2021

m2-github-services commented Nov 10, 2021

xmav commented Nov 10, 2021

m2-github-services commented Nov 10, 2021

xmav commented Nov 11, 2021

andrewbess commented Nov 11, 2021

magento-automated-testing bot commented Nov 11, 2021

andrewbess commented Nov 11, 2021

magento-automated-testing bot commented Nov 11, 2021

xmav commented Nov 11, 2021

xmav commented Nov 11, 2021

m2-github-services commented Nov 11, 2021

hostep commented Nov 12, 2021 • edited Loading

xmav commented Nov 12, 2021

hostep commented Nov 12, 2021

xmav commented Nov 12, 2021 • edited Loading

hostep commented Nov 13, 2021

hostep commented Nov 18, 2021

hostep commented Nov 6, 2021 •

edited by andrewbess

Loading

hostep commented Nov 8, 2021 •

edited

Loading

hostep commented Nov 12, 2021 •

edited

Loading

xmav commented Nov 12, 2021 •

edited

Loading