Fix "area code is not set" in all commands that depend on Payment/Helper/Data #33726

marvinhinz · 2021-08-09T12:59:44Z

Description (*)

The Helper Magento\Payment\Helper\Data creates a new layout in the constructor. This is unneccessary and creates issues when the helper is used without specifying the area code previously (eg in commands).

Edit: Also there is no real workaround to fix this. You would need to set the area in the constructor, which in turn is called every time the command list is generated, triggering "area code is already set".

Fixed Issues (if relevant)

Fixes Magento 2.4.2 composer upgrade broke after 2.4.3 released #33760

Manual testing scenarios (*)

Create a custom Command, inject Magento\Sales\Model\Service\InvoiceService or the mentioned helper directly, or some class that depends on it
Dont specify an area, because its not always needed, or you dont actually intend to use the layout
Scratch your head why it fails with error "area code is not set"

Questions or comments

I dont think a test case is neccessary for this change, because the only place $this->_layout is used, is in one single method as a fallback when no layout has been passed to getInfoBlock().

Maybe using the layoutfactory inside a constructor method should be prohibited at all, or at least trigger/log a warning message. It is troublesome to detect where the root issue comes from.

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)
README.md files for modified modules are updated and included in the pull request if any README.md predefined sections require an update
All automated tests passed successfully (all builds are green)

Resolved issues:

resolves [Issue] Fix "area code is not set" in all commands that depend on Payment/Helper/Data #33908: Fix "area code is not set" in all commands that depend on Payment/Helper/Data

…per/Data

m2-assistant · 2021-08-09T12:59:46Z

Hi @marvinhinz. 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:

Database Compare
Functional Tests CE
Functional Tests EE,
Functional Tests B2B
Integration Tests
Magento Health Index
Sample Data Tests CE
Sample Data Tests EE
Sample Data Tests B2B
Static Tests
Unit Tests
WebAPI Tests
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

marvinhinz · 2021-08-09T13:00:08Z

@magento run all tests

magento-automated-testing · 2021-08-09T13:00:20Z

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

hostep · 2021-08-09T13:04:16Z

app/code/Magento/Payment/Helper/Data.php

@@ -183,7 +176,7 @@ public function getMethodFormBlock(MethodInterface $method, LayoutInterface $lay
     */
    public function getInfoBlock(InfoInterface $info, LayoutInterface $layout = null)
    {
-        $layout = $layout ?: $this->_layout;
+        $layout = $layout ?: $layoutFactory->create();


The $layoutFactory variable won't exist here, you'll need to store it in a private member in the constructor to be able to use it, right?

Nevermind, I'm too slow 😆

Just realized after clicking on create pr :D

i dont know how to squash commits :(

marvinhinz · 2021-08-11T10:20:54Z

@magento run all tests

magento-automated-testing · 2021-08-11T10:21:00Z

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

Den4ik

@marvinhinz Thanks for your contribution.
Please look at my comment

Den4ik · 2021-08-13T11:00:12Z

app/code/Magento/Payment/Helper/Data.php

     */
-    protected $_layout;
+    protected $_layoutFactory;


Please don't rename exist properties in @api class. It's backward incompatible.
Just add another one private property and deprecate current

done 👍🏼

Den4ik · 2021-08-13T14:03:43Z

@magento run all tests

engcom-Alfa · 2021-10-18T10:09:16Z

@magento run Static Tests

magento-automated-testing · 2021-10-18T10:09:21Z

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

engcom-Alfa · 2021-10-18T12:28:23Z

@magento run Static Tests

magento-automated-testing · 2021-10-18T12:28:27Z

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

engcom-Alfa · 2021-10-18T14:15:39Z

@magento run Static Tests

magento-automated-testing · 2021-10-18T14:15:43Z

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

ihor-sviziev · 2021-10-18T16:31:05Z

@andrewbess any thoughts on why static tests are failing?

Signed-off-by: Denis Kopylov <dkopylov@magenius.team>

Den4ik · 2021-10-18T19:27:33Z

@magento run all tests

magento-automated-testing · 2021-10-18T19:27:41Z

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

Den4ik · 2021-10-18T19:28:38Z

@andrewbess any thoughts on why static tests are failing?

@ihor-sviziev I have fixed static tests and now it should be passed. I hope this PR will be proceed faster

engcom-Alfa · 2021-10-19T05:31:54Z

@magento run Functional Tests B2B, Functional Tests EE, Integration Tests, Magento Health Index, Sample Data Tests B2B, Static Tests, Unit Tests, WebAPI Tests

magento-automated-testing · 2021-10-19T05:31:58Z

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

engcom-Alfa · 2021-10-19T10:59:21Z

@magento run Functional Tests B2B, Functional Tests EE, Integration Tests, Magento Health Index, Sample Data Tests B2B, Static Tests, Unit Tests, WebAPI Tests

magento-automated-testing · 2021-10-19T10:59:26Z

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

engcom-Alfa · 2021-10-20T05:06:45Z

@magento run Functional Tests B2B, Functional Tests EE, Integration Tests, Magento Health Index, Sample Data Tests B2B, Static Tests, Unit Tests, WebAPI Tests

magento-automated-testing · 2021-10-20T05:06:48Z

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

magento-automated-testing · 2021-10-20T07:07:51Z

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

engcom-Alfa · 2021-10-20T07:21:24Z

@magento run Functional Tests B2B

magento-automated-testing · 2021-10-20T07:21:29Z

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

engcom-Alfa · 2021-10-20T09:53:49Z

✔️ QA Passed

After testing as per previous-comment, it was QA passed. But due to merge conflicts re-verified the issue again after resolving conflicts. PR is working absolutely fine. Hence forwarding the PR to Merge In Progress.

…n Payment/Helper/Data #33726

m2-assistant · 2021-10-28T02:10:32Z

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

Fix "area code is not set" in all commands that depend on Payment/Hel…

d0f2201

…per/Data

magento-engcom-team added Component: Payment Release Line: 2.4 labels Aug 9, 2021

Fix

b4a7f92

hostep reviewed Aug 9, 2021

View reviewed changes

m2-community-project bot assigned hostep Aug 9, 2021

m2-community-project bot added this to Review in Progress in Pull Requests Dashboard Aug 9, 2021

m2-community-project bot added the Progress: review label Aug 9, 2021

hostep removed their assignment Aug 9, 2021

m2-community-project bot moved this from Review in Progress to Pending Review in Pull Requests Dashboard Aug 9, 2021

m2-community-project bot added Progress: pending review and removed Progress: review labels Aug 9, 2021

Fix magento#2

ee828bc

i dont know how to squash commits :(

hostep mentioned this pull request Aug 12, 2021

Magento 2.4.2 composer upgrade broke after 2.4.3 released #33760

Closed

Den4ik requested changes Aug 13, 2021

View reviewed changes

m2-community-project bot assigned Den4ik Aug 13, 2021

m2-community-project bot moved this from Pending Review to Changes Requested in Pull Requests Dashboard Aug 13, 2021

m2-community-project bot added Progress: needs update and removed Progress: pending review labels Aug 13, 2021

marvinhinz added 2 commits August 13, 2021 13:28

restore $layout property and make it deprecated

1a3a59f

Change new property visibility to private

63e87da

m2-community-project bot moved this from Changes Requested to Review in Progress in Pull Requests Dashboard Aug 13, 2021

m2-community-project bot added Progress: review and removed Progress: needs update labels Aug 13, 2021

Den4ik added 2 commits October 18, 2021 22:24

Fix static tests

c8777f0

Signed-off-by: Denis Kopylov <dkopylov@magenius.team>

Move declare stric type after copyright

aaf035d

Signed-off-by: Denis Kopylov <dkopylov@magenius.team>

engcom-Alfa moved this from Testing in Progress to Merge in Progress in High Priority Pull Requests Dashboard Oct 20, 2021

m2-community-project bot added Progress: accept and removed Progress: testing in progress labels Oct 20, 2021

magento-engcom-team pushed a commit that referenced this pull request Oct 28, 2021

ENGCOM-9199: Fix "area code is not set" in all commands that depend o…

afaf86f

…n Payment/Helper/Data #33726

magento-engcom-team merged commit f9a78dd into magento:2.4-develop Oct 28, 2021

sidolov moved this from Merge in Progress to Recently Merged in High Priority Pull Requests Dashboard Oct 28, 2021

hostep mentioned this pull request Nov 10, 2021

AppState emulateAreaCode was not respected by file collector #28917

Merged

5 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix "area code is not set" in all commands that depend on Payment/Helper/Data #33726

Fix "area code is not set" in all commands that depend on Payment/Helper/Data #33726

marvinhinz commented Aug 9, 2021 •

edited by ihor-sviziev

Loading

m2-assistant bot commented Aug 9, 2021

marvinhinz commented Aug 9, 2021

magento-automated-testing bot commented Aug 9, 2021

hostep Aug 9, 2021

hostep Aug 9, 2021

marvinhinz Aug 9, 2021

marvinhinz commented Aug 11, 2021

magento-automated-testing bot commented Aug 11, 2021

Den4ik left a comment

Den4ik Aug 13, 2021

marvinhinz Aug 13, 2021

Den4ik commented Aug 13, 2021

engcom-Alfa commented Oct 18, 2021

magento-automated-testing bot commented Oct 18, 2021

engcom-Alfa commented Oct 18, 2021

magento-automated-testing bot commented Oct 18, 2021

engcom-Alfa commented Oct 18, 2021

magento-automated-testing bot commented Oct 18, 2021

ihor-sviziev commented Oct 18, 2021

Den4ik commented Oct 18, 2021

magento-automated-testing bot commented Oct 18, 2021

Den4ik commented Oct 18, 2021

engcom-Alfa commented Oct 19, 2021

magento-automated-testing bot commented Oct 19, 2021

engcom-Alfa commented Oct 19, 2021

magento-automated-testing bot commented Oct 19, 2021

engcom-Alfa commented Oct 20, 2021

magento-automated-testing bot commented Oct 20, 2021

magento-automated-testing bot commented Oct 20, 2021

engcom-Alfa commented Oct 20, 2021

magento-automated-testing bot commented Oct 20, 2021

engcom-Alfa commented Oct 20, 2021

m2-assistant bot commented Oct 28, 2021

Fix "area code is not set" in all commands that depend on Payment/Helper/Data #33726

Fix "area code is not set" in all commands that depend on Payment/Helper/Data #33726

Conversation

marvinhinz commented Aug 9, 2021 • edited by ihor-sviziev Loading

Description (*)

Fixed Issues (if relevant)

Manual testing scenarios (*)

Questions or comments

Contribution checklist (*)

Resolved issues:

m2-assistant bot commented Aug 9, 2021

marvinhinz commented Aug 9, 2021

magento-automated-testing bot commented Aug 9, 2021

hostep Aug 9, 2021

Choose a reason for hiding this comment

hostep Aug 9, 2021

Choose a reason for hiding this comment

marvinhinz Aug 9, 2021

Choose a reason for hiding this comment

marvinhinz commented Aug 11, 2021

magento-automated-testing bot commented Aug 11, 2021

Den4ik left a comment

Choose a reason for hiding this comment

Den4ik Aug 13, 2021

Choose a reason for hiding this comment

marvinhinz Aug 13, 2021

Choose a reason for hiding this comment

Den4ik commented Aug 13, 2021

engcom-Alfa commented Oct 18, 2021

magento-automated-testing bot commented Oct 18, 2021

engcom-Alfa commented Oct 18, 2021

magento-automated-testing bot commented Oct 18, 2021

engcom-Alfa commented Oct 18, 2021

magento-automated-testing bot commented Oct 18, 2021

ihor-sviziev commented Oct 18, 2021

Den4ik commented Oct 18, 2021

magento-automated-testing bot commented Oct 18, 2021

Den4ik commented Oct 18, 2021

engcom-Alfa commented Oct 19, 2021

magento-automated-testing bot commented Oct 19, 2021

engcom-Alfa commented Oct 19, 2021

magento-automated-testing bot commented Oct 19, 2021

engcom-Alfa commented Oct 20, 2021

magento-automated-testing bot commented Oct 20, 2021

magento-automated-testing bot commented Oct 20, 2021

engcom-Alfa commented Oct 20, 2021

magento-automated-testing bot commented Oct 20, 2021

engcom-Alfa commented Oct 20, 2021

m2-assistant bot commented Oct 28, 2021

marvinhinz commented Aug 9, 2021 •

edited by ihor-sviziev

Loading