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

Fixed 'Undefined class constant' error when interceptor is generated. #28797

Conversation

vovayatsyuk
Copy link
Member

@vovayatsyuk vovayatsyuk commented Jun 18, 2020

Description (*)

  1. Since constant is declared as private it's not accessible from parent classes.
  2. Since it used with static keyword, PHP will search it within class instance.
  3. Class instance will be an instance of generated Interceptor without access to private variables of child classes.
  4. This will lead to an 'Undefined class constant' error.

Manual testing scenarios (*)

  1. Create a plugin for Magento\Theme\Block\Html\Title class:

    <type name="Magento\Theme\Block\Html\Title">
        <plugin name="titlePlugin" type="Magento\Theme\Plugin\TitlePlugin" />
    </type>
    <?php
    
    namespace Magento\Theme\Plugin;
    
    class TitlePlugin
    {
        /**
         * @param mixed $subject
         * @param mixed $result
         * @return mixed
         */
        public function afterGetPageHeading(
            $subject,
            $result
        ) {
            return $result;
        }
    }
  2. Open frontend.

  3. You'll see an error:

    Error: Undefined class constant 'XML_PATH_HEADER_TRANSLATE_TITLE' in app/code/Magento/Theme/Block/Html/Title.php:104 
    Stack trace: 
    #0 app/code/Magento/Theme/Block/Html/Title.php(82): Magento\Theme\Block\Html\Title->shouldTranslateTitle() 
    #1 generated/code/Magento/Theme/Block/Html/Title/Interceptor.php(32): Magento\Theme\Block\Html\Title->getPageHeading() 
    #2 app/code/Magento/Theme/view/frontend/templates/html/title.phtml(12): Magento\Theme\Block\Html\Title\Interceptor->getPageHeading()
    ...
    

Questions or comments

Another way to solve this bug - is to declare constant as public instead of private.
If you think it should be public - I'll update PR.

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] Fixed 'Undefined class constant' error when interceptor is generated. #28981: Fixed 'Undefined class constant' error when interceptor is generated.

@m2-assistant
Copy link

m2-assistant bot commented Jun 18, 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.

@ihor-sviziev ihor-sviziev added the Auto-Tests: Not Required Changes in Pull Request does not require coverage by auto-tests label Jun 18, 2020
@ihor-sviziev ihor-sviziev self-assigned this Jun 18, 2020
@ihor-sviziev
Copy link
Contributor

@magento run all tests

@ihor-sviziev ihor-sviziev added the Severity: S3 Affects non-critical data or functionality and does not force users to employ a workaround. label Jun 19, 2020
@magento-engcom-team
Copy link
Contributor

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

@engcom-Delta
Copy link
Contributor

✔️ QA passed
Was checked case from Manual testing scenario
Before:
❌ Error "Undefined class constant 'XML_PATH_HEADER_TRANSLATE_TITLE' " is shown
#28797Main

After:
✔️ No errors when plugin is loaded
#28797PR

@engcom-Kilo
Copy link
Contributor

@magento run all tests

@engcom-Kilo engcom-Kilo added the QA: Ready to add to Regression Scope Should be analyzed and added to Regression Testing Scope(if applicable) label Jul 3, 2020
@engcom-Delta
Copy link
Contributor

@magento create issue

@engcom-Delta engcom-Delta removed the QA: Ready to add to Regression Scope Should be analyzed and added to Regression Testing Scope(if applicable) label Jul 3, 2020
@engcom-Delta engcom-Delta added the QA: Added to Regression Scope Scenario was analysed and added to Regression Testing Scope label Jul 3, 2020
@slavvka slavvka added the Priority: P4 No current plan to fix. Fixing can be deferred as a logical part of more important work. label Jul 6, 2020
@slavvka slavvka added this to the 2.4.1 milestone Jul 6, 2020
@slavvka
Copy link
Member

slavvka commented Jul 7, 2020

@magento run WebAPI tests

@slavvka
Copy link
Member

slavvka commented Jul 7, 2020

@magento run WebAPI Tests

@slavvka
Copy link
Member

slavvka commented Jul 13, 2020

@magento run Integration Tests

@magento-engcom-team magento-engcom-team merged commit fc9d96f into magento:2.4-develop Jul 16, 2020
@m2-assistant
Copy link

m2-assistant bot commented Jul 16, 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.

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 Component: Theme Priority: P4 No current plan to fix. Fixing can be deferred as a logical part of more important work. Progress: accept QA: Added to Regression Scope Scenario was analysed and added to Regression Testing Scope Release Line: 2.4 Severity: S3 Affects non-critical data or functionality and does not force users to employ a workaround.
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

[Issue] Fixed 'Undefined class constant' error when interceptor is generated.
6 participants