Skip to content
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

Declare optional argument after required. #31275

Conversation

vovayatsyuk
Copy link
Member

@vovayatsyuk vovayatsyuk commented Dec 14, 2020

Description

This prevents PHP fatal error when a plugin is added to the one of parent classes.

Manual testing scenarios

  1. Create a plugin for \Magento\Framework\View\Element\BlockInterface.
  2. Navigate to Content > Pages.
  3. A fatal error will be rendered: 'Error: Cannot instantiate interface Magento\Framework\Data\OptionSourceInterface'

Plugin example

Open Magento/Cms/etc/di.xml and add the following code:

<type name="Magento\Framework\View\Element\BlockInterface">
    <plugin name="cms_plugin" type="Magento\Cms\Plugin\Block" />
</type>

Create Magento\Cms\Plugin\Block class:

<?php

namespace Magento\Cms\Plugin;

class Block
{
    /**
     * @param mixed $subject
     * @param mixed $result
     * @return mixed
     */
    public function afterToHtml(
        $subject,
        $result
    ) {
        return $result;
    }
}

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)

Resolved issues:

  1. resolves [Issue] Declare optional argument after required. #31291: Declare optional argument after required.

This prevents PHP fatal error when plugin is added to the one of parent classes.
Error example: 'Error: Cannot instantiate interface Magento\Framework\Data\OptionSourceInterface'
@m2-assistant
Copy link

m2-assistant bot commented Dec 14, 2020

Hi @vovayatsyuk. 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 Dec 15, 2020
@m2-community-project m2-community-project bot added this to Review in Progress in Pull Requests Dashboard Dec 15, 2020
@ihor-sviziev ihor-sviziev added Severity: S2 Major restrictions or short-term circumventions are required until a fix is available. and removed Progress: review labels Dec 15, 2020
@m2-community-project m2-community-project bot moved this from Review in Progress to On Hold in Pull Requests Dashboard Dec 15, 2020
@m2-community-project m2-community-project bot moved this from On Hold to Review in Progress in Pull Requests Dashboard Dec 15, 2020
@ihor-sviziev ihor-sviziev added Auto-Tests: Not Required Changes in Pull Request does not require coverage by auto-tests Award: bug fix and removed Progress: on hold labels Dec 15, 2020
@ihor-sviziev
Copy link
Contributor

@magento run all tests

@sidolov sidolov added the Priority: P1 Once P0 defects have been fixed, a defect having this priority is the next candidate for fixing. label Dec 15, 2020
@sidolov
Copy link
Contributor

sidolov commented Dec 15, 2020

@magento create issue

@magento-engcom-team
Copy link
Contributor

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

@engcom-Alfa engcom-Alfa self-assigned this Dec 16, 2020
@engcom-Alfa engcom-Alfa moved this from Ready for Testing to Testing in Progress in High Priority Pull Requests Dashboard Dec 16, 2020
@m2-community-project m2-community-project bot moved this from Testing in Progress to Ready for Testing in High Priority Pull Requests Dashboard Dec 16, 2020
@engcom-Alfa
Copy link
Contributor

✔️ QA Passed

Manual testing scenario:

  1. Create a plugin for `Magento\Framework\View\Element\BlockInterface`;

Plugin example

Open Magento/Cms/etc/di.xml and add the following code:

<type name="Magento\Framework\View\Element\BlockInterface">
    <plugin name="cms_plugin" type="Magento\Cms\Plugin\Block" />
</type>

Create Magento\Cms\Plugin\Block class:

<?php

namespace Magento\Cms\Plugin;

class Block
{
    /**
     * @param mixed $subject
     * @param mixed $result
     * @return mixed
     */
    public function afterToHtml(
        $subject,
        $result
    ) {
        return $result;
    }
}
  1. Navigate to Content > Pages;

Before: ✖️ A fatal error rendered: 'Error: Cannot instantiate interface Magento\Framework\Data\OptionSourceInterface

Screenshot from 2020-12-16 09-52-15

After: ✔️ The page was successfully loaded

Screenshot from 2020-12-16 10-36-58

Was checked Media Gallery functionality, and everything works as expected.

@engcom-Alfa engcom-Alfa added the QA: Ready to add to Regression Scope Should be analyzed and added to Regression Testing Scope(if applicable) label Dec 16, 2020
@m2-community-project m2-community-project bot moved this from Testing in Progress to Ready for Testing in High Priority Pull Requests Dashboard Dec 16, 2020
@engcom-Alfa engcom-Alfa added QA: Added to Regression Scope Scenario was analysed and added to Regression Testing Scope and removed QA: Ready to add to Regression Scope Should be analyzed and added to Regression Testing Scope(if applicable) labels Dec 16, 2020
@engcom-Alfa engcom-Alfa moved this from Ready for Testing to Testing in Progress in High Priority Pull Requests Dashboard Dec 16, 2020
@engcom-Alfa engcom-Alfa moved this from Testing in Progress to Extended Testing (optional) in High Priority Pull Requests Dashboard Dec 16, 2020
@engcom-Alfa engcom-Alfa moved this from Extended Testing (optional) to Merge in Progress in High Priority Pull Requests Dashboard Dec 16, 2020
@magento-engcom-team magento-engcom-team merged commit e486a6b into magento:2.4-develop Dec 21, 2020
@m2-assistant
Copy link

m2-assistant bot commented Dec 21, 2020

Hi @vovayatsyuk, 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.

@sidolov sidolov moved this from Merge in Progress to Recently Merged in High Priority Pull Requests Dashboard Dec 21, 2020
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 Award: bug fix Component: MediaGalleryUi Priority: P1 Once P0 defects have been fixed, a defect having this priority is the next candidate for fixing. Progress: accept QA: Added to Regression Scope Scenario was analysed and added to Regression Testing Scope Release Line: 2.4 Severity: S2 Major restrictions or short-term circumventions are required until a fix is available.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Issue] Declare optional argument after required.
5 participants