Fix URL generation for new store when it created with setup:config:import

[ihor-sviziev]

Description (*)

Emulate adminhtml area where url rewrites are created

Related Pull Requests

Fixed Issues (if relevant)

1. N/A

Manual testing scenarios (*)

1. On Dev. env setup only one store view with few categories and products
2. dump stores info to config.php with php bin/magento app:config:dump and commit it
3. Deploy to production (run php bin/magento setup:upgrade --keep-generated on production env)
4. On dev. env create second store view in the same Store Group and Website
5. dump stores info to config.php with php bin/magento app:config:dump and commit it
6. Deploy to production (run php bin/magento setup:upgrade --keep-generated on production env)

Expected result:
On second store view on dev and production environments were generated URL rewrites for categories and products.

Actual result:
On second store view URL rewrites were generated only on dev env (it was created via admin), but they weren't generated on production env (it was created during setup:upgrade command)

Questions or comments

My investigation shown that only in adminhtml area URL rewrites are generated when store view is created:

magento2/app/code/Magento/CatalogUrlRewrite/etc/adminhtml/di.xml

Lines 9 to 14 in a31f4a3

	<type name="Magento\Store\Model\ResourceModel\Store">
	<plugin name="store_plugin" type="Magento\CatalogUrlRewrite\Model\Category\Plugin\Store\View"/>
	</type>
	<type name="Magento\Store\Model\ResourceModel\Group">
	<plugin name="group_plugin" type="Magento\CatalogUrlRewrite\Model\Category\Plugin\Store\Group"/>
	</type>

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] Fix URL generation for new store when it created with setup:config:import #30025: Fix URL generation for new store when it created with setup:config:import

[m2-assistant]

Hi @ihor-sviziev. 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

❗ 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:

1. Database Compare
2. Functional Tests CE
3. Functional Tests EE,
4. Functional Tests B2B
5. Integration Tests
6. Magento Health Index
7. Sample Data Tests CE
8. Sample Data Tests EE
9. Sample Data Tests B2B
10. Static Tests
11. Unit Tests
12. WebAPI Tests

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

[ihor-sviziev]

@magento run all tests

[ihor-sviziev]

@magento create issue

[ihor-sviziev]

@magento run all tests

[ihor-sviziev]

@magento run Static Tests

[ihor-sviziev]

There some failures during setup:instal... need to fix it.

[ihor-sviziev]

@magento run all tests

[ihor-sviziev]

@sidolov is there any instructions how to run & debug setup-integration tests?
I found the only instruction for running integration tests https://devdocs.magento.com/guides/v2.4/test/integration/integration_test_execution.html.

Also I checked - installing magento via php bin/magento setup:install works fine:

[ihor-sviziev]

Ok... For now just updated test with some debug code in order to see what exact message error was there.

@magento run Integration Tests

[ihor-sviziev]

@magento run Integration Tests

[ihor-sviziev]

@magento run Integration Tests

[sidolov]

@ihor-sviziev do not forget about the extensions like MSI and ASI since the tests build contains them.

[ihor-sviziev]

@sidolov as we discussed - it's not clear why this test fails, it fails for me even on 2.4-develop, also no instructions how to build them.

I'll keep this PR open only for internal investigation, I don't want to spend more time on fixing it, till we'll have some working instruction. Waiting for 2 hours for integration test results on CI is time wasting.

[Stepa4man]

Hey, @ihor-sviziev. Nice that you decided to fix it. Thanks.
I have a question why did you decide to emulate adminhtml instead of fixing exact reason, why it's not generated from cli. No blaming or something, just curious what blockers are there?

[ihor-sviziev]

@Stepa4man basically right now in the admin area declared plugins for generating url rewrites, so we have 2 options:

1. emulating admin area (that I saw few times in other Cli commands, for instance config:set)
2. moving these plugins to global level

magento2/app/code/Magento/CatalogUrlRewrite/etc/adminhtml/di.xml

Lines 9 to 14 in a31f4a3

	<type name="Magento\Store\Model\ResourceModel\Store">
	<plugin name="store_plugin" type="Magento\CatalogUrlRewrite\Model\Category\Plugin\Store\View"/>
	</type>
	<type name="Magento\Store\Model\ResourceModel\Group">
	<plugin name="group_plugin" type="Magento\CatalogUrlRewrite\Model\Category\Plugin\Store\Group"/>
	</type>

I went with 1st option because it was already used in some other cli commands and it seemed to me easier, also adding not needed plugin to the front end, web api, etc will just a bit slow down them due to additional inheritance and running additional code for managing plugins, etc.

If you have any other idea - let me know.

TBH I first time see that setup integration tests are failing at al. I found that we don’t have any instruction how to run them locally, tried to do similar to integration - they’re failing for me even on 2.4-develop branch. Running these tests on magento CI takes almost 2 hours (last run 1 h 55m), it’s crazy long time and not suitable for fixing the reason why it fails

[ihor-sviziev]

@magento run Integration Tests

[ihor-sviziev]

@magento run Integration Tests

[ihor-sviziev]

Failing functional looks not related to changes from my PR. All other failures I already fixed

[ihor-sviziev]

@magento run all tests
Just rebased my changes, hope functional tests will not fail anymore

[magento-engcom-team]

Hi @Stepa4man, thank you for the review.
ENGCOM-8243 has been created to process this Pull Request
✳️ @Stepa4man, could you please add one of the following labels to the Pull Request?

Label	Description
Auto-Tests: Covered	All changes in Pull Request is covered by auto-tests
Auto-Tests: Not Covered	Changes in Pull Request requires coverage by auto-tests
Auto-Tests: Not Required	Changes in Pull Request does not require coverage by auto-tests

[magento-engcom-team]

Hi @lbajsarowicz, thank you for the review.
ENGCOM-8243 has been created to process this Pull Request

[engcom-Alfa]

✔️ QA Passed

Manual testing scenario:

1. On Dev. env setup only one store view with few categories and products
2. dump stores info to config.php with php bin/magento app:config:dump and commit it

3. Deploy to production (run php bin/magento setup:upgrade --keep-generated on production env)
4. On dev. env create second store view in the same Store Group and Website in config.php file

5. Deploy to production (run php bin/magento setup:upgrade --keep-generated on production env)
6. Go to Admin- > Marketing -> URL Rewrites;

Before: ✖️ On second store view URL rewrites were generated only on dev env (it was created via admin), but they weren't generated on production env.

After: ✔️ On second store view on dev and production environments were generated URL rewrites for categories and products.

[m2-assistant]

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