Skip to content

Fix #26504 - Broken reference errors pilling up logs #28735

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

Conversation

Bartlomiejsz
Copy link
Contributor

@Bartlomiejsz Bartlomiejsz commented Jun 15, 2020

Description (*)

All of other Broken reference logs across Magento are only logged in developer mode. This PR fixes the only place from which it was logged also in production mode, possibly causing pilling up of logs

Related Pull Requests

Fixed Issues (if relevant)

  1. Fixes Broken reference errors piling up logs #26504

Manual testing scenarios (*)

Please check fixed issue for steps to reproduce

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

@m2-assistant
Copy link

m2-assistant bot commented Jun 15, 2020

Hi @Bartlomiejsz. 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.

@Bartlomiejsz
Copy link
Contributor Author

@magento run all tests

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 @Bartlomiejsz,
Could you cover your changes with some type of test?

@ghost ghost assigned ihor-sviziev Jun 16, 2020
@ihor-sviziev ihor-sviziev added Auto-Tests: Not Covered Changes in Pull Request requires coverage by auto-tests Award: bug fix labels Jun 16, 2020
@Bartlomiejsz
Copy link
Contributor Author

Hi @ihor-sviziev, to be honest I'm not sure here. Whole GeneratorPool class is pretty complex, and currently have no unit tests (MFTF are not applicable I believe).
So to cover this one minor change (which is already part of few other classes in core) I would have to write test for process method which, as mentioned is very complex at this point and this has nothing to do with my change.

@ihor-sviziev ihor-sviziev added Auto-Tests: Not Required Changes in Pull Request does not require coverage by auto-tests and removed Auto-Tests: Not Covered Changes in Pull Request requires coverage by auto-tests labels Jun 16, 2020
@ihor-sviziev
Copy link
Contributor

@Bartlomiejsz yeah, make sense. So I changed label to "not required".
Thank you!

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.

✔ Approved.

Failing functional tests looks not related to changes form this PR.

@magento-engcom-team
Copy link
Contributor

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

@ghost ghost added the Severity: S3 Affects non-critical data or functionality and does not force users to employ a workaround. label Jun 17, 2020
@engcom-Alfa engcom-Alfa self-assigned this Jun 17, 2020
@engcom-Alfa
Copy link
Contributor

✔️ QA Passed

Preconditions:

  1. Custom theme extended from Luma;
  2. Enabled Production mode;

Manual testing scenario:

  1. Extend luma theme;
  2. Move the container:
    app/design/frontend/Theme/theme/Magento_Theme/layout/default.xml:
<move element="content.top" destination="category.view.container" />
  1. Go to Storefront and browse different pages;
  2. Check system.log file

Before: ✖️ Logs are full of Broken reference errors

Screenshot from 2020-06-17 11-50-21

After: ✔️ Broken reference errors are only logged in developer mode

@engcom-Echo engcom-Echo self-assigned this Jun 17, 2020
@engcom-Echo engcom-Echo added the QA: Ready to add to Regression Scope Should be analyzed and added to Regression Testing Scope(if applicable) label Jun 17, 2020
@slavvka slavvka added the Priority: P3 May be fixed according to the position in the backlog. label Jun 17, 2020
@slavvka slavvka added this to the 2.4.1 milestone Jun 17, 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 Jun 18, 2020
@magento-engcom-team magento-engcom-team merged commit ec921aa into magento:2.4-develop Jun 18, 2020
@m2-assistant
Copy link

m2-assistant bot commented Jun 18, 2020

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

@Bartlomiejsz Bartlomiejsz deleted the feature/fix_26504_broken_reference_errors_log branch June 18, 2020 21:34
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: View Partner: Fast White Cat partners-contribution Pull Request is created by Magento Partner Priority: P3 May be fixed according to the position in the backlog. 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.

Broken reference errors piling up logs
6 participants