AC-12397: Email template exception message

Author: mrprabhu92

app/code/Magento/Email/Model/Template/Config.php

@@ -5,6 +5,8 @@
  */
 namespace Magento\Email\Model\Template;
 
+use Magento\Email\Model\Template\Config\UnexpectedTemplateFieldNameValueException;
+use Magento\Email\Model\Template\Config\UnexpectedTemplateIdValueException;
 use Magento\Framework\Filesystem\Directory\ReadFactory;
 use Magento\Framework\View\Design\Theme\ThemePackageList;
 
@@ -218,17 +220,17 @@ public function getTemplateFilename($templateId, $designParams = [])
      * @param string $templateId Name of an email template
      * @param string $fieldName Name of a field value of which to return
      * @return string
-     * @throws \UnexpectedValueException
+     * @throws UnexpectedTemplateIdValueException|UnexpectedTemplateFieldNameValueException
      */
     protected function _getInfo($templateId, $fieldName)
     {
         $data = $this->_dataStorage->get();
         if (!isset($data[$templateId])) {
-            throw new \UnexpectedValueException("Email template '{$templateId}' is not defined.");
+            throw new UnexpectedTemplateIdValueException(__("Email template is not defined."));
         }
         if (!isset($data[$templateId][$fieldName])) {
-            throw new \UnexpectedValueException(
-                "Field '{$fieldName}' is not defined for email template '{$templateId}'."
+            throw new UnexpectedTemplateFieldNameValueException(
+                "Field '{$fieldName}' is not defined for email template."
             );
         }
         return $data[$templateId][$fieldName];

app/code/Magento/Email/Model/Template/Config/UnexpectedTemplateFieldNameValueException.php

@@ -0,0 +1,28 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\Email\Model\Template\Config;
+
+/**
+ * Throw exception if email template has unexpected field name value
+ */
+class UnexpectedTemplateFieldNameValueException extends \UnexpectedValueException
+{
+    /**
+     * Exception trace
+     *
+     * @return string
+     */
+    public function __toString(): string
+    {
+        return preg_replace(
+            "/(Stack trace:).*$/s",
+            "$1" . PHP_EOL . "#0 {main}",
+            parent::__toString()
+        );
+    }
+}

app/code/Magento/Email/Model/Template/Config/UnexpectedTemplateIdValueException.php

@@ -0,0 +1,28 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\Email\Model\Template\Config;
+
+/**
+ * Throw exception if email template has unexpected template id value
+ */
+class UnexpectedTemplateIdValueException extends \UnexpectedValueException
+{
+    /**
+     * Exception trace
+     *
+     * @return string
+     */
+    public function __toString(): string
+    {
+        return preg_replace(
+            "/(Stack trace:).*$/s",
+            "$1" . PHP_EOL . "#0 {main}",
+            parent::__toString()
+        );
+    }
+}

app/code/Magento/Email/Test/Unit/Model/Template/ConfigTest.php

@@ -22,6 +22,9 @@
 
 class ConfigTest extends TestCase
 {
+    /**
+     * @var array
+     */
     private $designParams = [
         'area' => Area::AREA_FRONTEND,
         'theme' => 'Magento/blank',
@@ -310,7 +313,7 @@ public function testGetTemplateFilenameWrongFileName(): void
     public function testGetterMethodUnknownTemplate($getterMethod, $argument = null)
     {
         $this->expectException('UnexpectedValueException');
-        $this->expectExceptionMessage('Email template \'unknown\' is not defined');
+        $this->expectExceptionMessage('Email template is not defined');
         if (!$argument) {
             $this->model->{$getterMethod}('unknown');
         } else {
@@ -374,21 +377,21 @@ public function testGetterMethodUnknownField(
     public function getterMethodUnknownFieldDataProvider()
     {
         return [
-            'label getter' => ['getTemplateLabel', "Field 'label' is not defined for email template 'fixture'."],
-            'type getter' => ['getTemplateType', "Field 'type' is not defined for email template 'fixture'."],
+            'label getter' => ['getTemplateLabel', "Field 'label' is not defined for email template."],
+            'type getter' => ['getTemplateType', "Field 'type' is not defined for email template."],
             'module getter' => [
                 'getTemplateModule',
-                "Field 'module' is not defined for email template 'fixture'.",
+                "Field 'module' is not defined for email template.",
             ],
             'file getter, unknown module' => [
                 'getTemplateFilename',
-                "Field 'module' is not defined for email template 'fixture'.",
+                "Field 'module' is not defined for email template.",
                 [],
                 $this->designParams,
             ],
             'file getter, unknown file' => [
                 'getTemplateFilename',
-                "Field 'file' is not defined for email template 'fixture'.",
+                "Field 'file' is not defined for email template.",
                 ['module' => 'Fixture_Module'],
                 $this->designParams,
             ],

app/code/Magento/Email/i18n/en_US.csv

@@ -99,3 +99,4 @@ Action,Action
 "Header Template","Header Template"
 "Footer Template","Footer Template"
 "Unable to send mail. Please try again later.","Unable to send mail. Please try again later."
+"Email template is not defined.","Email template is not defined."

dev/tests/integration/testsuite/Magento/Email/Model/TemplateTest.php

@@ -757,7 +757,7 @@ public function testIsValidForSend()
     public function testGetTypeNonExistentType()
     {
         $this->expectException(\UnexpectedValueException::class);
-        $this->expectExceptionMessage('Email template \'foo\' is not defined.');
+        $this->expectExceptionMessage('Email template is not defined.');
 
         $this->mockModel();
         $this->model->setId('foo');