Skip to content

fix: do not forcefully set area in template if it is already set, fixes #14968, fixes #13530 #15137

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.

Sign up for GitHub

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

Merged
merged 4 commits into from May 16, 2018
Merged

fix: do not forcefully set area in template if it is already set, fixes #14968, fixes #13530 #15137

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0ae1230
fix: do not set forced area in template, fixes #14968
DanielRuf May 10, 2018
3df51d4
fix: do not expect setForcedArea in unit tests for Magento\Theme\Test…
DanielRuf May 10, 2018
0dec988
fix: just set the area if it is not set
DanielRuf May 10, 2018
d92b679
fix: change unit test back to test for the setForcedArea method
DanielRuf May 10, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions app/code/Magento/Email/Model/AbstractTemplate.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -534,10 +534,9 @@ protected function cancelDesignConfig()
*/
public function setForcedArea($templateId)
{
if ($this->area) {
throw new \LogicException(__('Area is already set'));
Copy link
Contributor

Choose a reason for hiding this comment

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

Was there any logic in this exception before? Any idea why it was introduced?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This was still the original code from 3 years ago which was untouched. The annotations and exception class are not correct imo but should be solved in another PR.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Check the blame view of the file in the original repo and you see that the code was never really touched ;-)

Copy link
Contributor

Choose a reason for hiding this comment

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

@DanielRuf Is there any patch available for temporary. I need to fix this in my Magento v.2.2.4.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@hitesh-wagento simply add .patch to the pull/number URL and you get https://patch-diff.githubusercontent.com/raw/magento/magento2/pull/15137.patch

if (!isset($this->area)) {
Copy link
Contributor

Choose a reason for hiding this comment

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

Can $this->area be empty and not null? Looks like simple if (!$this->area) is sufficient here.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Not that I knew, it is either set or null according to the class where it is set in the constructor.

Copy link
Contributor

Choose a reason for hiding this comment

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

Ok, then simplify condition please. Commit amend is preferable.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

empty and isset check are different, what should I change here? It can just be null or set and isset checks for it already.

Copy link
Contributor

Choose a reason for hiding this comment

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

@DanielRuf I meant that there is no reason to change if ($this->area) {

Copy link
Contributor Author

Choose a reason for hiding this comment

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

isset is more strict and still correct so I think we can keep it like this.

$this->area = $this->emailConfig->getTemplateArea($templateId);
}
$this->area = $this->emailConfig->getTemplateArea($templateId);
return $this;
}

Expand Down