AC-2391: Remove legacy variable resolver from email template processor

xmav · xmav · commit 75c9c849fd1c · 2022-02-23T18:13:19.000-06:00
- cleanup setStrictMode()
diff --git a/app/code/Magento/Email/Block/Adminhtml/Template/Preview.php b/app/code/Magento/Email/Block/Adminhtml/Template/Preview.php
@@ -67,7 +67,7 @@ protected function _toHtml()
             $template->setTemplateType($request->getParam('type'));
             $template->setTemplateText($request->getParam('text'));
             $template->setTemplateStyles($request->getParam('styles'));
-            $template->setData('is_legacy', false);
+
         }
 
         \Magento\Framework\Profiler::start($this->profilerName);
diff --git a/app/code/Magento/Email/Model/AbstractTemplate.php b/app/code/Magento/Email/Model/AbstractTemplate.php
@@ -361,24 +361,11 @@ public function getProcessedTemplate(array $variables = [])
         $variables = $this->addEmailVariables($variables, $storeId);
         $processor->setVariables($variables);
 
-        // Type        legacy  id      strict
-        // db legacy   true    numeric false
-        // db new      false   numeric true
-        // filesystem  false   string  false
-        // preview     false   null    true
-        $isLegacy = $this->getData('is_legacy');
-        $templateId = $this->getTemplateId();
-        $previousStrictMode = $processor->setStrictMode(
-            !$isLegacy && (is_numeric($templateId) || empty($templateId))
-        );
-
         try {
             $result = $processor->filter($this->getTemplateText());
         } catch (\Exception $e) {
             $this->cancelDesignConfig();
             throw new \LogicException(__($e->getMessage()), $e->getCode(), $e);
-        } finally {
-            $processor->setStrictMode($previousStrictMode);
         }
 
         if ($isDesignApplied) {
diff --git a/app/code/Magento/Email/Model/Template.php b/app/code/Magento/Email/Model/Template.php
@@ -248,17 +248,11 @@ public function getProcessedTemplateSubject(array $variables)
         $this->applyDesignConfig();
         $storeId = $this->getDesignConfig()->getStore();
 
-        $previousStrictMode = $processor->setStrictMode(
-            !$this->getData('is_legacy') && is_numeric($this->getTemplateId())
-        );
-
         try {
             $processedResult = $processor->setStoreId($storeId)->filter(__($this->getTemplateSubject())->render());
         } catch (\Exception $e) {
             $this->cancelDesignConfig();
             throw new \Magento\Framework\Exception\MailException(__($e->getMessage()), $e);
-        } finally {
-            $processor->setStrictMode($previousStrictMode);
         }
 
         $this->cancelDesignConfig();
diff --git a/app/code/Magento/Email/Test/Unit/Model/AbstractTemplateTest.php b/app/code/Magento/Email/Test/Unit/Model/AbstractTemplateTest.php
@@ -188,7 +188,6 @@ public function testGetProcessedTemplate($variables, $templateType, $storeId, $e
                     'filter',
                     'getStoreId',
                     'getInlineCssFiles',
-                    'setStrictMode',
                 ]
             )
             ->disableOriginalConstructor()
@@ -209,10 +208,6 @@ public function testGetProcessedTemplate($variables, $templateType, $storeId, $e
         $filterTemplate->expects($this->any())
             ->method('getStoreId')
             ->willReturn($storeId);
-        $filterTemplate->expects($this->exactly(2))
-            ->method('setStrictMode')
-            ->withConsecutive([$this->equalTo(true)], [$this->equalTo(false)])
-            ->willReturnOnConsecutiveCalls(false, true);
 
         $expectedVariables['store'] = $this->store;
 
@@ -271,7 +266,6 @@ public function testGetProcessedTemplateException()
                     'filter',
                     'getStoreId',
                     'getInlineCssFiles',
-                    'setStrictMode',
                 ]
             )
             ->disableOriginalConstructor()
@@ -288,10 +282,6 @@ public function testGetProcessedTemplateException()
         $filterTemplate->expects($this->any())
             ->method('getStoreId')
             ->willReturn(1);
-        $filterTemplate->expects($this->exactly(2))
-            ->method('setStrictMode')
-            ->withConsecutive([$this->equalTo(false)], [$this->equalTo(true)])
-            ->willReturnOnConsecutiveCalls(true, false);
 
         $model = $this->getModelMock(
             [
diff --git a/app/code/Magento/Email/Test/Unit/Model/TemplateTest.php b/app/code/Magento/Email/Test/Unit/Model/TemplateTest.php
@@ -523,16 +523,12 @@ public function testGetProcessedTemplateSubject()
 
         class_exists(Template::class, true);
         $filterTemplate = $this->getMockBuilder(\Magento\Framework\Filter\Template::class)
-            ->setMethods(['setVariables', 'setStoreId', 'filter', 'setStrictMode'])
+            ->setMethods(['setVariables', 'setStoreId', 'filter'])
             ->disableOriginalConstructor()
             ->getMock();
         $model->expects($this->once())
             ->method('getTemplateFilter')
             ->willReturn($filterTemplate);
-        $filterTemplate->expects($this->exactly(2))
-            ->method('setStrictMode')
-            ->withConsecutive([$this->equalTo(true)], [$this->equalTo(false)])
-            ->willReturnOnConsecutiveCalls(false, true);
 
         $model->expects($this->once())
             ->method('applyDesignConfig');
diff --git a/app/code/Magento/Newsletter/Block/Adminhtml/Queue/Preview.php b/app/code/Magento/Newsletter/Block/Adminhtml/Queue/Preview.php
@@ -56,7 +56,6 @@ protected function loadTemplate(\Magento\Newsletter\Model\Template $template, $i
         $template->setTemplateType($queue->getNewsletterType());
         $template->setTemplateText($queue->getNewsletterText());
         $template->setTemplateStyles($queue->getNewsletterStyles());
-        $template->setData('is_legacy', false);
 
         return $this;
     }
diff --git a/app/code/Magento/Newsletter/Block/Adminhtml/Template/Preview.php b/app/code/Magento/Newsletter/Block/Adminhtml/Template/Preview.php
@@ -65,7 +65,6 @@ protected function _toHtml()
             $template->setTemplateType($previewData['type']);
             $template->setTemplateText($previewData['text']);
             $template->setTemplateStyles($previewData['styles']);
-            $template->setData('is_legacy', false);
         }
 
         \Magento\Framework\Profiler::start($this->profilerName);
diff --git a/app/code/Magento/Newsletter/Model/Template.php b/app/code/Magento/Newsletter/Model/Template.php
@@ -203,13 +203,7 @@ public function getProcessedTemplateSubject(array $variables)
         $filter = $this->getTemplateFilter();
         $filter->setVariables($variables);
 
-        $previousStrictMode = $filter->setStrictMode(
-            !$this->getData('is_legacy') && is_numeric($this->getTemplateId())
-        );
-        $result = $filter->filter($this->getTemplateSubject());
-        $filter->setStrictMode($previousStrictMode);
-
-        return $result;
+        return $filter->filter($this->getTemplateSubject());
     }
 
     /**
diff --git a/app/code/Magento/Newsletter/Test/Unit/Model/TemplateTest.php b/app/code/Magento/Newsletter/Test/Unit/Model/TemplateTest.php
@@ -246,11 +246,6 @@ public function testGetProcessedTemplateSubject()
             ->with($templateSubject)
             ->willReturn($expectedResult);
 
-        $filterTemplate->expects($this->exactly(2))
-            ->method('setStrictMode')
-            ->withConsecutive([$this->equalTo(false)], [$this->equalTo(true)])
-            ->willReturnOnConsecutiveCalls(true, false);
-
         $variables = ['key' => 'value'];
         $filterTemplate->expects($this->once())
             ->method('setVariables')
@@ -287,8 +282,7 @@ class_exists(Filter::class, true);
                     'setStoreId',
                     'filter',
                     'getStoreId',
-                    'getInlineCssFiles',
-                    'setStrictMode',
+                    'getInlineCssFiles'
                 ]
             )
             ->disableOriginalConstructor()
@@ -309,11 +303,6 @@ class_exists(Filter::class, true);
             ->method('getStoreId')
             ->willReturn($storeId);
 
-        $filterTemplate->expects($this->exactly(2))
-            ->method('setStrictMode')
-            ->withConsecutive([$this->equalTo(true)], [$this->equalTo(false)])
-            ->willReturnOnConsecutiveCalls(false, true);
-
         // The following block of code tests to ensure that the store id of the subscriber will be used, if the
         // 'subscriber' variable is set.
         $subscriber = $this->getMockBuilder(Subscriber::class)
diff --git a/dev/tests/integration/testsuite/Magento/Email/Model/TemplateTest.php b/dev/tests/integration/testsuite/Magento/Email/Model/TemplateTest.php
@@ -405,7 +405,6 @@ public function testLegacyTemplateLoadedFromDbIsFilteredInLegacyMode()
 
         $template = $this->objectManager->create(\Magento\Email\Model\Template::class);
         $templateData = [
-            'is_legacy' => '1',
             'template_code' => 'some_unique_code',
             'template_type' => TemplateTypesInterface::TYPE_HTML,
             'template_text' => '{{var this.template_code}}'
@@ -439,7 +438,6 @@ public function testPreviewTemplateIsFilteredInStrictMode()
 
         $template = $this->objectManager->create(\Magento\Email\Model\Template::class);
         $templateData = [
-            'is_legacy' => '0',
             'template_code' => 'some_unique_code',
             'template_type' => TemplateTypesInterface::TYPE_HTML,
             'template_text' => '{{var this.template_code}}'
diff --git a/dev/tests/integration/testsuite/Magento/Framework/Filter/TemplateTest.php b/dev/tests/integration/testsuite/Magento/Framework/Filter/TemplateTest.php
@@ -160,7 +160,6 @@ public function testIfDirective()
 
     public function testNonDataObjectVariableParsing()
     {
-        $previous = $this->templateFilter->setStrictMode(false);
         $this->templateFilter->setVariables(
             [
                 'address' => new class {
@@ -174,11 +173,7 @@ public function format($type)
 
         $template = '{{var address.format(\'html\')}}';
         $expected = '<foo>html</foo>';
-        try {
-            self::assertEquals($expected, $this->templateFilter->filter($template));
-        } finally {
-            $this->templateFilter->setStrictMode($previous);
-        }
+        self::assertEquals($expected, $this->templateFilter->filter($template));
     }
 
     public function testStrictModeByDefault()
@@ -200,7 +195,6 @@ public function format()
 
     public function testComplexVariableArguments()
     {
-        $previous = $this->templateFilter->setStrictMode(false);
         $this->templateFilter->setVariables(
             [
                 'address' => new class {
@@ -215,16 +209,12 @@ public function format($a, $b, $c)
 
         $template = '{{var address.format($arg1,\'bar\',[param1:baz])}}';
         $expected = 'foo bar baz';
-        try {
-            self::assertEquals($expected, $this->templateFilter->filter($template));
-        } finally {
-            $this->templateFilter->setStrictMode($previous);
-        }
+
+        self::assertEquals($expected, $this->templateFilter->filter($template));
     }
 
     public function testComplexVariableGetterArguments()
     {
-        $previous = $this->templateFilter->setStrictMode(false);
         $this->templateFilter->setVariables(
             [
                 'address' => new class extends DataObject {
@@ -239,16 +229,11 @@ public function getFoo($a, $b, $c)
 
         $template = '{{var address.getFoo($arg1,\'bar\',[param1:baz])}}';
         $expected = 'foo bar baz';
-        try {
-            self::assertEquals($expected, $this->templateFilter->filter($template));
-        } finally {
-            $this->templateFilter->setStrictMode($previous);
-        }
+        self::assertEquals($expected, $this->templateFilter->filter($template));
     }
 
     public function testNonDataObjectRendersBlankInStrictMode()
     {
-        $this->templateFilter->setStrictMode(true);
         $this->templateFilter->setVariables(
             [
                 'address' => new class {
@@ -267,7 +252,6 @@ public function format($type)
 
     public function testDataObjectCanRenderPropertiesStrictMode()
     {
-        $this->templateFilter->setStrictMode(true);
         $this->templateFilter->setVariables(
             [
                 'customer' => new DataObject(['name' => 'John Doe']),
@@ -279,12 +263,8 @@ public function testDataObjectCanRenderPropertiesStrictMode()
         self::assertEquals($expected, $this->templateFilter->filter($template));
     }
 
-    /**
-     * @dataProvider strictModeTrueFalseProvider
-     */
-    public function testScalarDataKeys($strictMode)
+    public function testScalarDataKeys()
     {
-        $this->templateFilter->setStrictMode($strictMode);
         $this->templateFilter->setVariables(
             [
                 'customer_data' => [
@@ -406,12 +386,4 @@ public function testInvalidMethodCall()
             $this->templateFilter->filter('{{var dateTime.createFromFormat(\'d\',\'1548201468\')}}')
         );
     }
-
-    public function strictModeTrueFalseProvider()
-    {
-        return [
-            'strictMode' => [true],
-            'legacyMode' => [false]
-        ];
-    }
 }
diff --git a/dev/tests/integration/testsuite/Magento/Newsletter/Controller/Adminhtml/NewsletterTemplateTest.php b/dev/tests/integration/testsuite/Magento/Newsletter/Controller/Adminhtml/NewsletterTemplateTest.php
@@ -62,7 +62,6 @@ protected function tearDown(): void
     public function testSaveActionCreateNewTemplateAndVerifySuccessMessage()
     {
         $this->getRequest()->setParam('id', $this->model->getId());
-        $this->getRequest()->setParam('is_legacy', 1);
 
         $this->dispatch('backend/newsletter/template/save');
 
@@ -98,7 +97,6 @@ public function testSaveActionEditTemplateAndVerifySuccessMessage()
         $this->assertEquals('some_unique_code', $this->model->getTemplateCode());
 
         $this->getRequest()->setParam('id', $this->model->getId());
-        $this->getRequest()->setParam('is_legacy', 1);
 
         $this->dispatch('backend/newsletter/template/save');
 
diff --git a/dev/tests/integration/testsuite/Magento/Newsletter/Model/TemplateTest.php b/dev/tests/integration/testsuite/Magento/Newsletter/Model/TemplateTest.php
@@ -151,7 +151,6 @@ public function testLegacyTemplateFromDbLoadsInLegacyMode()
 
         $template = $objectManager->create(\Magento\Email\Model\Template::class);
         $templateData = [
-            'is_legacy' => '1',
             'template_code' => 'some_unique_code',
             'template_type' => TemplateTypesInterface::TYPE_HTML,
             'template_text' => '{{var this.template_code}}'
diff --git a/lib/internal/Magento/Framework/Filter/Template.php b/lib/internal/Magento/Framework/Filter/Template.php
@@ -404,6 +404,7 @@ protected function getStackArgs($stack)
      * @param bool $strictMode Enable strict parsing of directives
      * @return bool The previous mode from before the change
      * @since 102.0.4
+     * @deprecated The method is not in use anymore.
      */
     public function setStrictMode(bool $strictMode): bool
     {

Original file line number	Diff line number	Diff line change
`@@ -67,7 +67,7 @@ protected function _toHtml()`
`67`	`67`	`$template->setTemplateType($request->getParam('type'));`
`68`	`68`	`$template->setTemplateText($request->getParam('text'));`
`69`	`69`	`$template->setTemplateStyles($request->getParam('styles'));`
`70`		`- $template->setData('is_legacy', false);`
	`70`	`+`
`71`	`71`	`}`
`72`	`72`
`73`	`73`	`\Magento\Framework\Profiler::start($this->profilerName);`
Original file line number	Diff line number	Diff line change
`@@ -56,7 +56,6 @@ protected function loadTemplate(\Magento\Newsletter\Model\Template $template, $i`
`56`	`56`	`$template->setTemplateType($queue->getNewsletterType());`
`57`	`57`	`$template->setTemplateText($queue->getNewsletterText());`
`58`	`58`	`$template->setTemplateStyles($queue->getNewsletterStyles());`
`59`		`- $template->setData('is_legacy', false);`
`60`	`59`
`61`	`60`	`return $this;`
`62`	`61`	`}`
Original file line number	Diff line number	Diff line change
`@@ -65,7 +65,6 @@ protected function _toHtml()`
`65`	`65`	`$template->setTemplateType($previewData['type']);`
`66`	`66`	`$template->setTemplateText($previewData['text']);`
`67`	`67`	`$template->setTemplateStyles($previewData['styles']);`
`68`		`- $template->setData('is_legacy', false);`
`69`	`68`	`}`
`70`	`69`
`71`	`70`	`\Magento\Framework\Profiler::start($this->profilerName);`