Introducing dynamic generic type definitions in php docblocks, to imp…

[hostep]

…rove static analysis

Description (*)

When doing static analysis, the types defined as return type in certain methods in core Magento that have to do with creating or fetching blocks are not specific enough.
We can use generic type definitions to improve this significantly by having it interpreted as the exact class a method call returns.

More detailed information can be found in #40017

Related Pull Requests

Fixed Issues (if relevant)

1. Fixes Add generic types in certain php classes, for improved static analysis support #40017

Manual testing scenarios (*)

1. Temporarily change the file app/design/frontend/Magento/luma/Magento_LayeredNavigation/templates/layer/state.phtml and fully remove its contents and replace it with the following:

<?php

/** @var \Magento\Framework\View\TemplateEngine\Php $this */
/** @var \Magento\LayeredNavigation\Block\Navigation\State $block */
/** @var \Magento\Framework\View\Element\BlockFactory $blockFactory */
/** @var \Magento\Framework\View\Layout\Generator\Block $blockGenerator */

// demo of changes in \Magento\Framework\View\TemplateEngine\Php::helper
$productAlertHelper = $this->helper(\Magento\ProductAlert\Helper\Data::class);

// demo of changes in \Magento\ProductAlert\Helper\Data::createBlock
$productView = $productAlertHelper->createBlock(\Magento\ProductAlert\Block\Product\View::class);
$productView->getPostAction();

// demo of changes in \Magento\Framework\View\Element\BlockFactory::createBlock
$defaultCaptchaBlock = $blockFactory->createBlock(Magento\Captcha\Block\Captcha\DefaultCaptcha::class);
$defaultCaptchaBlock->getCaptchaModel();

// demo of changes in \Magento\Framework\View\Layout::createBlock
$rssCategoryBlock = $block->getLayout()->createBlock(\Magento\Catalog\Block\Rss\Category::class);
$rssCategoryBlock->getRssData();

// demo of changes in \Magento\Framework\View\Layout::addBlock
$rssNewProductsBlock = $block->getLayout()->addBlock(\Magento\Catalog\Block\Rss\Product\NewProducts::class);
$rssNewProductsBlock->getRssData();

// demo of changes in \Magento\Framework\View\Layout::getBlockSingleton
$rssProductSpecialBlock = $block->getLayout()->getBlockSingleton(\Magento\Catalog\Block\Rss\Product\Special::class);
$rssProductSpecialBlock->getRssData();

// demo of changes in \Magento\Framework\View\Layout\Generator\Block::createBlock
$cmsPageBlock = $blockGenerator->createBlock(\Magento\Customer\Block\Address\Renderer\DefaultRenderer::class, 'test');
$cmsPageBlock->renderArray([]);

2. Now run phpstan with level 2 on this file: ./vendor/bin/phpstan analyse --level=2 -c dev/tests/static/testsuite/Magento/Test/Php/_files/phpstan/phpstan.neon app/design/frontend/Magento/luma/Magento_LayeredNavigation/templates/layer/state.phtml

Before:

 ------ -----------------------------------------------------------------------------------------------
  Line
 ------ -----------------------------------------------------------------------------------------------
  12     Call to an undefined method Magento\Framework\App\Helper\AbstractHelper::createBlock().
  17     Call to an undefined method Magento\Framework\View\Element\BlockInterface::getCaptchaModel().
  21     Call to an undefined method Magento\Framework\View\Element\BlockInterface::getRssData().
  25     Call to an undefined method Magento\Framework\View\Element\BlockInterface::getRssData().
  29     Call to an undefined method Magento\Framework\View\Element\BlockInterface::getRssData().
  33     Call to an undefined method Magento\Framework\View\Element\AbstractBlock::renderArray().
 ------ -----------------------------------------------------------------------------------------------

 [ERROR] Found 6 errors

After:

 [OK] No errors

Questions or comments

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]

Hi @hostep. Thank you for your contribution!
Here are some useful tips on how you can test your changes using Magento test environment.
❗ 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:

1. Database Compare
2. Functional Tests CE
3. Functional Tests EE
4. Functional Tests B2B
5. Integration Tests
6. Magento Health Index
7. Sample Data Tests CE
8. Sample Data Tests EE
9. Sample Data Tests B2B
10. Static Tests
11. Unit Tests
12. WebAPI Tests
13. 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 Code Contributions documentation.
Join Magento Community Engineering Slack and ask your questions in #github channel.

[ct-prd-pr-scan]

The security team has been informed about this pull request due to the presence of risky security keywords. For security vulnerability reports, please visit Adobe's vulnerability disclosure program on HackerOne or email [email protected].

[ct-prd-pr-scan]

The security team has been informed about this pull request due to the presence of risky security keywords. For security vulnerability reports, please visit Adobe's vulnerability disclosure program on HackerOne or email [email protected].

[ct-prd-pr-scan]

The security team has been informed about this pull request due to the presence of risky security keywords. For security vulnerability reports, please visit Adobe's vulnerability disclosure program on HackerOne or email [email protected].

[hostep]

@magento run all tests

[hostep]

@magento run Static Tests

[ct-prd-pr-scan]

The security team has been informed about this pull request due to the presence of risky security keywords. For security vulnerability reports, please visit Adobe's vulnerability disclosure program on HackerOne or email [email protected].

[engcom-Hotel]

@magento run all tests

[engcom-Hotel]

Hello @hostep,

Thanks for the contribution!

The changes looks good to me, but please fix the failed static tests. Functional test failures seems flaky to me, and for SVC failure, we will create a JIRA.

Thanks

[hostep]

@magento run all tests

The static test failures are false positives, but I just rebase and force pushed, so let's see if they keep failing with false positive result or not ...

[hostep]

@engcom-Hotel, the 3 static test failures (one, two, three) all complain about missing copyright headers, but the headers are there and in the correct format, so I'm confused. Why do these test failures trigger?

Also the Database Compare test fails, even though they are all green, why is that happening?

[engcom-Hotel]

Hello @hostep,

I think it is due to case sensitive check. Let me check once.

Thanks

[engcom-Hotel]

@magento run Static Tests