MAGETWO-2745: added appEmulation Plugin for the $sitemap->generateXml() for generating the sitemap via cron and backend

[dimaMackert]

Description (*)

I found almost the same issue here: #24605, here you generate the sitemap via backend.
In my case i let generate the sitemap with cron schedule. The problem is i get a wrong cache path, because the \Magento\Sitemap\Model\Observer:scheduledGenerateSitemaps() does not implement the appEmulation->stopEnvironmentEmulation(); like it was fixed in the issue #24605

Manual testing scenarios (*)

1. Just generate a sitemap via backend
2. Generate a sitemap via cron
3. You will see, there are two different cache paths

for example via backend:

/media/catalog/product/cache/cb8ca2a9db68e4f593ce69a9ee07e2b0/p/r/test.png

for example via cron:

/media/catalog/product/cache/9b58a33b64c72152de346a8490e93157/p/r/test.png

with the appEmulation inside the observer, cron and backend generates the same cache path.

Questions or comments

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)
• All automated tests passed successfully (all builds are green)

Resolved issues:

1. resolves [Issue] MAGETWO-2745: added appEmulation Plugin for the $sitemap->generateXml() for generating the sitemap via cron and backend #29605: MAGETWO-2745: added appEmulation Plugin for the $sitemap->generateXml() for generating the sitemap via cron and backend

[m2-assistant]

Hi @dimaMackert. Thank you for your contribution
Here is 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

For more details, please, review the Magento Contributor Guide documentation.

[kandy]

Better to use around plugin here
and write code in the way like

 $this->appEmulation->startEnvironmentEmulation(
                    $sitemap->getStoreId(),
                    Area::AREA_FRONTEND,
                    true
                );
             try {
                retrun $proceed();
             } finally {
                $this->appEmulation->stopEnvironmentEmulation();
             }

[kandy]

And actually why do not put this directly in generateXml method

[Stepa4man]

And actually why do not put this directly in generateXml method

@kandy why do you think Sitemap itself should be responsible for modifying the Application state? I'd say it should be done by the observer.

[kandy]

Suggested change

	$this->appEmulation->stopEnvironmentEmulation();
	} catch (\Exception $e) {
	$errors[] = $e->getMessage();
	}
	} catch (\Exception $e) {
	$errors[] = $e->getMessage();
	} finally {
	$this->appEmulation->stopEnvironmentEmulation();
	}

[Stepa4man]

Hi @dimaMackert
Thanks for your contribution

Please sign CLA and consider suggested changes.

[Stepa4man]

I would suggest moving area emulation outside of the foreach statement

[Stepa4man]

@VladimirZaets, could you please check what's going on with tests right now?
I can see that failed functional tests don't relate to this PR

[sidolov]

@magento create issue

[sidolov]

@dimaMackert , I am closing this PR now due to inactivity.
Please reopen and update if you wish to continue.
Thank you for the collaboration!

[m2-assistant]

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