Skip to content

Report cron error message where possible #34069

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

fredden
Copy link
Member

@fredden fredden commented Sep 13, 2021

Description

This pull request adds the error message to the new exception created in the exception handler for cron jobs. Without this, the real error message is lost.

Related Pull Requests

None

Manual testing scenarios

  1. Throw a generic exception with a helpful error message within a cron job.
  2. Witness the helpful error message is not logged nor available anywhere.
  3. Apply changes in this pull request.
  4. Witness the helpful error message is preserved.

Questions or comments

See also Ethan3600/magento2-CronjobManager#164

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:

  1. resolves [Issue] Report cron error message where possible #34941: Report cron error message where possible

@m2-assistant
Copy link

m2-assistant bot commented Sep 13, 2021

Hi @fredden. Thank you for your contribution
Here are 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
  13. Semantic Version Checker

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

@magento-automated-testing
Copy link

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

@BarnyShergold
Copy link

@magento run Functional Tests B2B,Functional Tests EE

@magento-automated-testing
Copy link

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

Copy link

@BarnyShergold BarnyShergold left a comment

Choose a reason for hiding this comment

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

Just need to check why tests failing - re-running

@magento-engcom-team
Copy link
Contributor

Hi @BarnyShergold, thank you for the review.
ENGCOM-9219 has been created to process this Pull Request
✳️ @BarnyShergold, could you please add one of the following labels to the Pull Request?

Label Description
Auto-Tests: Covered All changes in Pull Request is covered by auto-tests
Auto-Tests: Not Covered Changes in Pull Request requires coverage by auto-tests
Auto-Tests: Not Required Changes in Pull Request does not require coverage by auto-tests

@Den4ik Den4ik added Auto-Tests: Covered All changes in Pull Request is covered by auto-tests Severity: S3 Affects non-critical data or functionality and does not force users to employ a workaround. labels Sep 14, 2021
@magento-engcom-team
Copy link
Contributor

Hi @Den4ik, thank you for the review.
ENGCOM-9219 has been created to process this Pull Request

@magento-automated-testing
Copy link

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

@magento-automated-testing
Copy link

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

@magento-engcom-team
Copy link
Contributor

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

@sidolov sidolov added the Priority: P2 A defect with this priority could have functionality issues which are not to expectations. label Oct 28, 2021
@slavvka
Copy link
Member

slavvka commented Dec 14, 2021

@magento give me test instance

@magento-deployment-service
Copy link

Hi @slavvka. Thank you for your request. I'm working on Magento instance for you.

@magento-deployment-service
Copy link

@engcom-Alfa
Copy link
Contributor

@magento create issue

@engcom-Dash
Copy link
Contributor

engcom-Dash commented Jan 6, 2022

✔️ QA Passed

Manual testing scenario:

  1. I have generated a runtime error manually through code at app/code/Magento/Cron/Observer/ProcessCronQueueObserver.php on method "_runJob".
  2. Hence while running the cron with command 'php bin/magento cron:run' from magento cli it is throwing a runtime error.
  3. In the cron.log I have received an error mentioning "Error when running a cron job" without any real error message

Before: ✖️ We are not getting the real error message point to actual error in cron.log file.

Screenshot 2022-01-06 at 2 03 09 PM

After: ✔️ Along with the message 'Error when running a cron job', we are also getting the error because of which runtime exception happened.

Screenshot 2022-01-06 at 2 07 47 PM

Since this PR is relevant to having an error messages in cron logs and has no functional impact there is no additional testing required as part of regression.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Auto-Tests: Covered All changes in Pull Request is covered by auto-tests Award: bug fix Award: test coverage Component: Cron Partner: Fisheye partners-contribution Pull Request is created by Magento Partner Priority: P2 A defect with this priority could have functionality issues which are not to expectations. Progress: accept Release Line: 2.4 Severity: S3 Affects non-critical data or functionality and does not force users to employ a workaround.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Issue] Report cron error message where possible
10 participants