Skip to content

Return correct type #30160

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 30, 2020
Merged

Return correct type #30160

merged 2 commits into from
Sep 30, 2020

Conversation

kassner
Copy link
Contributor

@kassner kassner commented Sep 23, 2020

Description

Boolean and bool aren't the same thing for static analysis tools.

Manual testing scenarios

  1. Overwrite \Magento\Framework\Logger\Monolog with a class that you own;
  2. Run psalm against your class;
ERROR: UndefinedDocblockClass - app/code/Vendor/Module/Model/Logger.php:15:16 - Docblock-defined class or interface Magento\Framework\Logger\Boolean does not exist (see https://psalm.dev/200)
        return parent::addRecord($level, $message, $context);

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)
  • All automated tests passed successfully (all builds are green)

@m2-assistant
Copy link

m2-assistant bot commented Sep 23, 2020

Hi @kassner. Thank you for your contribution
Here is 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:

  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

You can find more information about the builds here

ℹ️ Please run only needed test builds instead of all when developing. Please run all test builds before sending your PR for review.

For more details, please, 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, please 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

@ihor-sviziev ihor-sviziev self-assigned this Sep 23, 2020
@ihor-sviziev ihor-sviziev added Auto-Tests: Not Required Changes in Pull Request does not require coverage by auto-tests Cleanup Severity: S4 Affects aesthetics, professional look and feel, “quality” or “usability”. labels Sep 23, 2020
@ihor-sviziev
Copy link
Contributor

@magento run all tests

@sidolov sidolov added the Priority: P4 No current plan to fix. Fixing can be deferred as a logical part of more important work. label Sep 23, 2020
Copy link
Contributor

@ihor-sviziev ihor-sviziev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @kassner ,
Could you also fixe the static test for changed file? Thank you!

@engcom-Echo engcom-Echo self-assigned this Sep 24, 2020
@kassner
Copy link
Contributor Author

kassner commented Sep 25, 2020

Error seems to be unrelated to my change, so I am not sure which approach is desired.

Fix failing static test
@ihor-sviziev
Copy link
Contributor

@magento run Static Tests

@ihor-sviziev
Copy link
Contributor

@magento run all tests

@magento-engcom-team
Copy link
Contributor

Hi @ihor-sviziev, thank you for the review.
ENGCOM-8271 has been created to process this Pull Request

@ghost ghost added the Progress: accept label Sep 25, 2020
magento-engcom-team pushed a commit that referenced this pull request Sep 30, 2020
@magento-engcom-team magento-engcom-team merged commit 444fd3a into magento:2.4-develop Sep 30, 2020
@m2-assistant
Copy link

m2-assistant bot commented Sep 30, 2020

Hi @kassner, thank you for your contribution!
Please, complete Contribution Survey, it will take less than a minute.
Your feedback will help us to improve contribution process.

@kassner kassner deleted the patch-25 branch June 1, 2023 15:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Auto-Tests: Not Required Changes in Pull Request does not require coverage by auto-tests Cleanup Component: Logger Priority: P4 No current plan to fix. Fixing can be deferred as a logical part of more important work. Progress: accept Release Line: 2.4 Severity: S4 Affects aesthetics, professional look and feel, “quality” or “usability”.
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

5 participants