[PHPDOC] Fix bad phpdoc for Magento\Framework\Message\ManagerInterface #39153

dimitriBouteille · 2024-09-10T12:39:54Z

Description (*)

This PR fix the bad phpdoc for \Magento\Framework\Message\ManagerInterface and remove all duplicate phpdoc in \Magento\Framework\Message\Manager (use inheritdoc syntaxe).

Actually all add*Message functions (addErrorMessage, addSuccess, addWarningMessage, ...) accept a string value in $message variable.

This PR allows to pass either a \Magento\Framework\Phrase or a string.

Here is an example where the type \Magento\Framework\Phrase is used :

magento2/app/code/Magento/Checkout/Controller/Cart/Delete.php

Line 38 in 0cfe4a3

$this->messageManager->addErrorMessage(__('We can\'t remove the item.'));

For example, with PHPSTAN is very complicated to setup the project with level 5 or higher :(

Related Pull Requests

None

Fixed Issues (if relevant)

None

Manual testing scenarios (*)

Setup PHPSTAN with level 5 or higher and run check.

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)

Resolved issues:

resolves [Issue] [PHPDOC] Fix bad phpdoc for Magento\Framework\Message\ManagerInterface #39593: [PHPDOC] Fix bad phpdoc for Magento\Framework\Message\ManagerInterface

m2-assistant · 2024-09-10T12:39:58Z

Hi @dimitriBouteille. Thank you for your contribution!
Here are some useful tips on 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 Code Contributions documentation.
Join Magento Community Engineering Slack and ask your questions in #github channel.

dimitriBouteille · 2024-09-10T12:40:11Z

@magento run all tests

engcom-Hotel · 2024-12-16T06:50:57Z

@magento run all tests

engcom-Hotel · 2024-12-16T10:17:26Z

@magento run Static Tests

engcom-Hotel · 2024-12-16T12:14:12Z

@magento run Functional Tests B2B, Functional Tests CE, Functional Tests EE, Unit Tests

engcom-Hotel

Hello @dimitriBouteille,

Thanks for the contribution!

The changes look good to us. However, please address the failed tests, particularly the static tests.

Thanks

engcom-Charlie · 2024-12-18T09:45:07Z

@magento run all tests

engcom-Charlie · 2024-12-18T11:37:26Z

@magento run all tests

engcom-Charlie · 2024-12-19T07:36:56Z

@magento run all tests

…triBouteille/magento2 into bad-phpdoc-ManagerInterface

engcom-Charlie · 2024-12-19T09:30:11Z

@magento run all tests

engcom-Charlie · 2024-12-19T12:51:35Z

@magento run all tests

engcom-Charlie · 2024-12-20T08:21:51Z

@engcom-Hotel, I have fixed the static test failures. Requesting for the review.

Thank you!

This reverts commit c8abbb9.

engcom-Charlie · 2025-02-12T10:03:41Z

@magento run all tests

lib/internal/Magento/Framework/Message/Manager.php

engcom-Charlie · 2025-02-13T06:24:49Z

@magento run all tests

engcom-Charlie · 2025-02-13T08:44:29Z

@magento run Integration Tests, Functional Tests CE, Functional Tests EE

engcom-Charlie · 2025-02-14T06:49:35Z

The review changes have been implemented and approved hence moving it to Ready for Testing.

engcom-Charlie · 2025-02-14T06:53:26Z

No manual testing is required here, as only the bad doc blocks are getting updated. Currently moving this PR to Extended Testing as the build is failing.

engcom-Charlie · 2025-02-14T06:55:01Z

@magento run WebAPI Tests

engcom-Charlie · 2025-02-14T07:59:51Z

@magento run all tests

engcom-Charlie · 2025-02-14T14:20:12Z

@magento run Integration Tests

engcom-Charlie · 2025-02-17T07:20:44Z

@magento run all tests

engcom-Charlie · 2025-02-17T10:49:30Z

@magento run Functional Tests B2B, Functional Tests CE, Unit Tests

engcom-Charlie · 2025-02-17T13:25:21Z

Hi @dimitriBouteille,

As I am working on the build stabilization activity of this PR, requesting you to please don't merge latest codebase in this PR. If any input needed from your end will let you know.

Thank you!

engcom-Charlie · 2025-02-17T13:25:33Z

@magento run all tests

engcom-Charlie · 2025-02-18T04:50:10Z

@magento run Functional Tests B2B, Functional Tests CE, Integration Tests

engcom-Charlie · 2025-02-18T08:39:34Z

One of the Functional B2B test failure is inconsistent in the last two builds, it seem to be flaky and the other one is a known issue. They neither part of PR nor failing because of the PR changes.

Run 1:
https://public-results-storage-prod.magento-testing-service.engineering/reports/magento/magento2/pull/39153/6b368458733182aecc9a07f0fcf2b7a6/Functional/allure-report-b2b/index.html#categories/2fc037f47773dd7551f2e766bbf34efa/d01814eab6700437/

Run 2:
https://public-results-storage-prod.magento-testing-service.engineering/reports/magento/magento2/pull/39153/b8a9c797d4d64520188c53b5cfae1e14/Functional/allure-report-b2b/index.html#categories

Known Issue:
StorefrontAssertAsLowAsLabelTest: ACQE-7389

One of the Functional CE test failure is inconsistent in the last two builds, it seem to be flaky . They neither part of PR nor failing because of the PR changes. Hence moving it to Merge In Progress.

Run 1:
https://public-results-storage-prod.magento-testing-service.engineering/reports/magento/magento2/pull/39153/81d5a862903c6903ed35b5ab74dc7190/Functional/allure-report-ce/index.html#categories

Run 2:
https://public-results-storage-prod.magento-testing-service.engineering/reports/magento/magento2/pull/39153/3e5cd018f3060fafd0c32d7d158f7fc2/Functional/allure-report-ce/index.html#categories

Fix bad phpdoc for Magento\Framework\Message\ManagerInterface

0c33ab9

m2-community-project bot added the Progress: pending review label Sep 10, 2024

dimitriBouteille changed the title ~~Fix bad phpdoc for Magento\Framework\Message\ManagerInterface~~ [PHPDOC] Fix bad phpdoc for Magento\Framework\Message\ManagerInterface Sep 11, 2024

engcom-Hotel added the Priority: P3 May be fixed according to the position in the backlog. label Sep 12, 2024

Priyakshic added the Project: Community Picked PRs upvoted by the community label Dec 11, 2024

engcom-Bravo added the Triage: Dev.Experience Issue related to Developer Experience and needs help with Triage to Confirm or Reject it label Dec 11, 2024

Merge branch '2.4-develop' into bad-phpdoc-ManagerInterface

0889a17

engcom-Hotel requested changes Dec 16, 2024

View reviewed changes

m2-community-project bot assigned engcom-Hotel Dec 16, 2024

m2-community-project bot added Progress: needs update and removed Progress: pending review labels Dec 16, 2024

dimitriBouteille mentioned this pull request Dec 16, 2024

[PHPDOC] Fix bad phpdoc Magento\Framework\App\Config\ScopeConfigInterface #39199

Merged

6 tasks

engcom-Charlie self-assigned this Dec 17, 2024

Merge branch '2.4-develop' into bad-phpdoc-ManagerInterface

863bae7

Fixed static test failures

c8abbb9

Merge branch '2.4-develop' into bad-phpdoc-ManagerInterface

7609f8a

engcom-Charlie added 2 commits December 19, 2024 14:49

Fixed static test failures

801efbe

Merge branch 'bad-phpdoc-ManagerInterface' of https://github.com/dimi…

834e8c3

…triBouteille/magento2 into bad-phpdoc-ManagerInterface

Fixed static test failures

875fbfc

engcom-Charlie requested a review from ihor-sviziev February 11, 2025 11:52

Merge branch '2.4-develop' into bad-phpdoc-ManagerInterface

5d7e258

engcom-Charlie force-pushed the bad-phpdoc-ManagerInterface branch from dc6e909 to 5d7e258 Compare February 12, 2025 09:30

engcom-Charlie added 2 commits February 12, 2025 15:07

Revert "Fixed static test failures"

d2c4cdb

This reverts commit c8abbb9.

After revert, fixed some code base to avoid static tests failures

b68d8b7

ihor-sviziev reviewed Feb 12, 2025

View reviewed changes

lib/internal/Magento/Framework/Message/Manager.php Outdated Show resolved Hide resolved

lib/internal/Magento/Framework/Message/Manager.php Outdated Show resolved Hide resolved

Fixed static test fialure

a25d310

ihor-sviziev approved these changes Feb 13, 2025

View reviewed changes

Merge branch '2.4-develop' into bad-phpdoc-ManagerInterface

5f5643f

Merge branch '2.4-develop' into bad-phpdoc-ManagerInterface

ecff80d

dimitriBouteille and others added 2 commits February 17, 2025 12:06

Merge branch '2.4-develop' into bad-phpdoc-ManagerInterface

15cd7ae

Merge branch '2.4-develop' into bad-phpdoc-ManagerInterface

871ba52

Merge branch '2.4-develop' into bad-phpdoc-ManagerInterface

1e7b0ed

magento-devops-reposync-svc merged commit 6614e0a into magento:2.4-develop Apr 2, 2025
1 check passed

engcom-Charlie moved this from Merge in Progress to Recently Merged in Community Dashboard Apr 3, 2025

dimitriBouteille deleted the bad-phpdoc-ManagerInterface branch April 3, 2025 05:50

[PHPDOC] Fix bad phpdoc for Magento\Framework\Message\ManagerInterface #39153

[PHPDOC] Fix bad phpdoc for Magento\Framework\Message\ManagerInterface #39153

Uh oh!

Conversation

dimitriBouteille commented Sep 10, 2024 • edited by m2-assistant bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description (*)

Related Pull Requests

Fixed Issues (if relevant)

Manual testing scenarios (*)

Contribution checklist (*)

Resolved issues:

Uh oh!

m2-assistant bot commented Sep 10, 2024

Uh oh!

dimitriBouteille commented Sep 10, 2024

Uh oh!

engcom-Hotel commented Dec 16, 2024

Uh oh!

engcom-Hotel commented Dec 16, 2024

Uh oh!

engcom-Hotel commented Dec 16, 2024

Uh oh!

engcom-Hotel left a comment

Choose a reason for hiding this comment

Uh oh!

engcom-Charlie commented Dec 18, 2024

Uh oh!

engcom-Charlie commented Dec 18, 2024

Uh oh!

engcom-Charlie commented Dec 19, 2024

Uh oh!

engcom-Charlie commented Dec 19, 2024

Uh oh!

engcom-Charlie commented Dec 19, 2024

Uh oh!

engcom-Charlie commented Dec 20, 2024

Uh oh!

engcom-Charlie commented Feb 12, 2025

Uh oh!

Uh oh!

Uh oh!

engcom-Charlie commented Feb 13, 2025

Uh oh!

engcom-Charlie commented Feb 13, 2025

Uh oh!

engcom-Charlie commented Feb 14, 2025

Uh oh!

engcom-Charlie commented Feb 14, 2025

Uh oh!

engcom-Charlie commented Feb 14, 2025

Uh oh!

engcom-Charlie commented Feb 14, 2025

Uh oh!

engcom-Charlie commented Feb 14, 2025

Uh oh!

engcom-Charlie commented Feb 17, 2025

Uh oh!

engcom-Charlie commented Feb 17, 2025

Uh oh!

engcom-Charlie commented Feb 17, 2025

Uh oh!

engcom-Charlie commented Feb 17, 2025

Uh oh!

engcom-Charlie commented Feb 18, 2025

Uh oh!

engcom-Charlie commented Feb 18, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

dimitriBouteille commented Sep 10, 2024 •

edited by m2-assistant bot

Loading