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

Ensure string is returned when applying filter to email template #32298

Conversation

Skullsneeze
Copy link
Contributor

@Skullsneeze Skullsneeze commented Feb 26, 2021

Description (*)

Added string casting within the email template filter method to ensure the return value is a string.
Currently if an exception is caught while not in developer mode a Phrase object is returned. This in turn triggers a fatal Uncaught TypeError in magento/framework/Filter/DirectiveProcessor/TemplateDirective.php:68.

Related Pull Requests

N/A

Fixed Issues (if relevant)

N/A

Manual testing scenarios (*)

  1. Install module
    template_error.zip
  2. Switch to Production mode.
  3. Go to Marketing -> Newsletter Templates and create a new one.
  4. Insert {{template config_path="design/email/header_template"}} into Template Content filed.
  5. Preview Template.
  6. We're sorry, an error has occurred while generating this content. message displayed.

Questions or comments

N/A

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] Ensure string is returned when applying filter to email template #32671: Ensure string is returned when applying filter to email template

@m2-assistant
Copy link

m2-assistant bot commented Feb 26, 2021

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

@m2-assistant
Copy link

m2-assistant bot commented Feb 26, 2021

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

@Skullsneeze
Copy link
Contributor Author

@magento run all tests

Martijn Swinkels added 2 commits February 26, 2021 11:30
…ithub.com:Skullsneeze/magento2 into bugfix/email-tempalte-filter-not-returning-string
@Skullsneeze
Copy link
Contributor Author

@magento run all tests

@ihor-sviziev ihor-sviziev self-requested a review February 26, 2021 11:55
@ihor-sviziev ihor-sviziev self-assigned this Feb 26, 2021
@ihor-sviziev ihor-sviziev added Auto-Tests: Covered All changes in Pull Request is covered by auto-tests Award: bug fix Award: test coverage Severity: S3 Affects non-critical data or functionality and does not force users to employ a workaround. and removed Progress: review labels Feb 26, 2021
@m2-assistant
Copy link

m2-assistant bot commented Apr 11, 2021

Hi @Skullsneeze, 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: Covered All changes in Pull Request is covered by auto-tests Award: bug fix Award: test coverage Component: Email Priority: P2 A defect with this priority could have functionality issues which are not to expectations. 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. Type: Bug Fix
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Issue] Ensure string is returned when applying filter to email template
8 participants