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

EmailTemplateCompilationException wrong description message #1054

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

yaroslavbr
Copy link
Contributor

  • fixed exception message

@yaroslavbr yaroslavbr marked this pull request as ready for review February 24, 2021 15:44
@@ -14,7 +14,10 @@ class EmailTemplateCompilationException extends EmailTemplateException
*/
public function __construct(EmailTemplateCriteria $criteria)
{
$message = sprintf('Could not found one email template with "%s" name', $criteria->getName());
$message = sprintf(
'Compilation error during rendering template "%s". Please look at the log file for more details.',
Copy link
Contributor

Choose a reason for hiding this comment

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

Please look at the log file for more details.

As on a production web server, this message will be already displayed in a log. It's odd to see this recommendation in the exception message. Also, not all applications use files to store logs. And we never recommend the same for any other exception messages, so I propose to remove the second part.

Instead, we can provide more details about an error in the exception itself. For example, now we don't pass the original exception to the parent Exception constructor. While in \Oro\Bundle\EmailBundle\Provider\EmailTemplateContentProvider::getTemplateContent, we do have the original exception, and we can add it to the stack trace, so the developer will not need to check the log file in the dev environment, and the system administrator will see the message in the original trace, that is preferred, instead of having two unrelated log messages, that could even not go in a row, in case of a high load.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging this pull request may close these issues.

3 participants