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

Fix regression - Add previous exception with more details #33419

Merged
merged 1 commit into from
Oct 21, 2021

Conversation

ihor-sviziev
Copy link
Contributor

@ihor-sviziev ihor-sviziev commented Jul 5, 2021

Description (*)

As part of #32730, we got a regression - the 2nd parameter for the previous exception was lost. It was reported in #32730 (comment).

This PR brings back this 2nd parameter, it will be really useful for a clear understanding of what's happened and why, when we catch an exception during email sending.

Related Pull Requests

Fixed Issues (if relevant)

  1. Fixes magento/magento2#<issue_number>

Manual testing scenarios (*)

  1. ...
  2. ...

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)
  • 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] Fix regression - Add previous exception with more details #34166: Fix regression - Add previous exception with more details

@m2-assistant
Copy link

m2-assistant bot commented Jul 5, 2021

Hi @ihor-sviziev. 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

@ihor-sviziev
Copy link
Contributor Author

@magento run all tests

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

@ihor-sviziev ihor-sviziev changed the title Add previous exception with more details Fix regression - Add previous exception with more details Jul 5, 2021
@m2-community-project m2-community-project bot added this to Pending Review in Pull Requests Dashboard Jul 5, 2021
@ihor-sviziev
Copy link
Contributor Author

@magento run Unit Tests

@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 @Den4ik, thank you for the review.
ENGCOM-9149 has been created to process this Pull Request
✳️ @Den4ik, 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: Not Required Changes in Pull Request does not require coverage by auto-tests Release Line: 2.4 and removed Release Line: 2.4 labels Jul 15, 2021
@eduard13 eduard13 added the Priority: P2 A defect with this priority could have functionality issues which are not to expectations. label Jul 16, 2021
@magento-engcom-team
Copy link
Contributor

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

@engcom-Alfa engcom-Alfa self-assigned this Aug 3, 2021
@engcom-Alfa engcom-Alfa moved this from Ready for Testing to Testing in Progress in High Priority Pull Requests Dashboard Aug 3, 2021
Copy link
Contributor

@engcom-Alfa engcom-Alfa left a comment

Choose a reason for hiding this comment

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

Since this PR auto moved to Ready For Testing, pushing it back to Changes Requested!

@engcom-Charlie
Copy link
Contributor

Hi @ihor-sviziev,

Thank you for your contribution!

I will have a look on the comments received in changes requested.

Thank you!

@engcom-Charlie
Copy link
Contributor

Hi @ihor-sviziev, and @engcom-Alfa

I have gone through this issue and #32730 issues and below are the findings.

@engcom-Alfa , I have tried to reproduce the issue on 2.4-develop branch having smtp installed and its reproducible.

To reproduce it, I have the added code base mentioned in comment. As a result, we can see error on store front, and you will not see any exception entry in exception log.

image

In this issue implementation, we have taken care of passing the original exception as a second parameter along with an exception log entry. So as a part of testing of this issue, we should be getting the exception entry in exception log.

Thank you!

@engcom-Alfa
Copy link
Contributor

engcom-Alfa commented Sep 23, 2021

Hi @ihor-sviziev, and @engcom-Alfa

I have gone through this issue and #32730 issues and below are the findings.

@engcom-Alfa , I have tried to reproduce the issue on 2.4-develop branch having smtp installed and its reproducible.

To reproduce it, I have the added code base mentioned in comment. As a result, we can see error on store front, and you will not see any exception entry in exception log.

image

In this issue implementation, we have taken care of passing the original exception as a second parameter along with an exception log entry. So as a part of testing of this issue, we should be getting the exception entry in exception log.

Thank you!

After your updates, I tried again fresh
Installed a new Magento instance without sample data, updated the same line of code, tried to get the error by submitting the Contact us form. But, Magento successfully accepted the form! Strange!

@engcom-Alfa
Copy link
Contributor

@magento create issue

@engcom-Alfa
Copy link
Contributor

✔️ QA Passed

Preconditions:

  1. Have a Magento instance installed

Manual testing scenario:

  1. Update the line of code as defined in the comment.

  2. Note the exception.log file last line content for reference

  3. Navigate to Front end > Contact Us > Fill and submit the form

  4. Validate the exception logs

Before: ✖️ No logs were getting received

Attach screenshot

After: ✔️ Logs generated as shown below

main.ERROR: test localized exception {"exception":"[object] (Magento\\Framework\\Exception\\LocalizedException(code: 0): test localized exception at /Users/project/PR_testing_33419/app/code/Magento/Email/Model/Transport.php:103)"} []

Since the PR has an additional logs update only, there is no impact on anything and no additional regression required.

Thanks @engcom-Charlie for helping me in identifying the logs.

@m2-assistant
Copy link

m2-assistant bot commented Oct 21, 2021

Hi @ihor-sviziev, 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 Oct 21, 2021
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: Email Priority: P2 A defect with this priority could have functionality issues which are not to expectations. Progress: accept Release Line: 2.4
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Issue] Fix regression - Add previous exception with more details
6 participants