BUG - Prevent Magento from Creating incorrect URLs for category/products when Store View has modified URL keys #28676

BarnyShergold · 2020-06-10T23:04:15Z

Description (*)

If a Store View has a category tree where url_keys have been modified - eg different language - then if there is a category that has does not have a modified key (eg its the same in different languages) BUT has parents that DO, then the original code would use the DEFAULT Store View of the Category for creating URLS.

When scripts to regenerate URLs are used (as described in 28633) then they will end up creating incorrect URLs.

There is also a CORE issue. If an Admin changes the URL key of a category then Magento rebuilds all the URLs for the underlying categories and all the category/product URLs. However, if this is done where a category falls into the description above, then Magento sets the URL for that catalog/product combination for the store view it is done on but does it for ALL store views.

EG Given that the Default is English and there is a 3-level category :
Men > Collections > Premium
(men) (collections) (premium)

A product in Premium would have the url key : men/collections/premium/

Now there are two other Store Views : Italian & German
They have the names of the Men & Collections categories translated but not Premium as that is a brand.

So in the Italian Store the category should be -
(uomo) (collezioni) (premium)

German -
(herren) (kollektionen) (premium)

IF an Admin went into the Italian store view and decided to change the URL key of 'uomo' to 'uomo-italiano' then Magento would rebuild all the keys for the view. If then you checked the url_redirect table for all the URLs for a single product for the "Premium" category then you would expect to see -
men/collections/premium/
herren/kollektionen/premium/
uomo/collezioni/premium/

BUT the bug causes all storeviews to be set to the Italian URL -
uomo/collezioni/premium/
uomo/collezioni/premium/
uomo/collezioni/premium/

Categories where URL keys have been modified are okay.

Related Pull Requests

Fixed Issues (if relevant)

Fixes URL Regeneration Fails on Store-Level URL Keys - Products #28633

Manual testing scenarios (*)

Set up categories as above
Change top level url key of a store view
Check URLs of a category without a changed key for all store views - problem above shows.
Apply fix
Go to top level category in every store view and change key and revert
Once all stores have been forced to update - check URLs for the category in 3 and all URLs for all stores will be correct.

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)

…URLs

m2-assistant · 2020-06-10T23:04:18Z

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

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

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.

BarnyShergold · 2020-06-10T23:50:41Z

@magento give me 2.4-develop instance
@magento run all tests

magento-engcom-team · 2020-06-10T23:50:43Z

Hi @BarnyShergold. Thank you for your request. I'm working on Magento 2.4-develop instance for you

BarnyShergold · 2020-06-11T13:22:46Z

@magento run all tests

…s tested

BarnyShergold · 2020-06-22T12:58:30Z

@magento run all tests

BarnyShergold · 2020-06-22T15:49:57Z

@magento run all tests

lbajsarowicz

Please review the comments

lbajsarowicz · 2020-07-01T18:44:22Z

app/code/Magento/CatalogUrlRewrite/Model/ProductScopeRewriteGenerator.php

@@ -21,6 +21,9 @@

 /**
 * Class ProductScopeRewriteGenerator


Remove this line

This was the original code but I've removed it anyway.

lbajsarowicz · 2020-07-01T18:44:40Z

app/code/Magento/CatalogUrlRewrite/Model/ProductScopeRewriteGenerator.php

@@ -252,9 +254,14 @@ private function getCategoryWithOverriddenUrlKey($storeId, Category $category)
            Category::ENTITY
        );

-        if (!$isUrlKeyOverridden) {
+        // Category should be loaded per appropriate store at all times. This is because whilst the URL key on the


Use PHP Doc

lbajsarowicz · 2020-07-01T18:45:05Z

app/code/Magento/CatalogUrlRewrite/Model/ProductScopeRewriteGenerator.php

+        // category in focus might be unchanged, parent category URL keys might be. If the category store ID
+        // and passed store ID are the same then return current category as it is correct but may have changed in memory
+
+        if (!$isUrlKeyOverridden && $storeId == $category->getStoreId()) {


lbajsarowicz · 2020-07-01T18:45:34Z

app/code/Magento/CatalogUrlRewrite/Test/Unit/Model/ProductScopeRewriteGeneratorTest.php

@@ -69,6 +70,9 @@ class ProductScopeRewriteGeneratorTest extends TestCase
    /** @var ScopeConfigInterface|MockObject */
    private $configMock;

+    /** @var CategoryRepositoryInterface|MockObject */
+    private $categoryRepository;


Suffix with 'Mock'

BarnyShergold · 2020-07-07T21:34:24Z

@magento run all tests

lbajsarowicz

✔️ Great work, thank you!

magento-engcom-team · 2020-09-29T09:13:37Z

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

engcom-Echo · 2020-09-29T09:40:58Z

@magento run all tests

engcom-Echo · 2020-09-29T12:47:42Z

@magento run Functional Tests CE, Functional Tests B2B

BarnyShergold · 2020-09-29T18:25:24Z

@engcom-Echo - Any idea why these seemingly unrelated tests keep failing?

swnsma · 2020-09-29T20:34:29Z

@BarnyShergold there is a migration to new chrome driver.
So tests are unstable until migration finished.

BarnyShergold · 2020-09-30T08:38:22Z

@engcom-Echo @swnsma - All tests finally passed! They take such a long time.... maybe more hamsters are needed?

BarnyShergold · 2020-09-30T13:07:11Z

@engcom-Echo - So what's left to be done before merging? Out of interest how long before that happens?

…ategory/products when Store View has modified URL keys #28676

m2-assistant · 2020-09-30T19:38:43Z

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

Changed so that store view category is always used to create product …

3409af0

…URLs

ghost added the Progress: pending review label Jun 10, 2020

magento-engcom-team added Component: CatalogUrlRewrite Release Line: 2.4 Partner: Vaimo Pull Request is created by partner Vaimo partners-contribution Pull Request is created by Magento Partner labels Jun 10, 2020

Correction from Code Sniffer

a6d1976

Corrected issue causing integration test to fail when category move i…

ac1ac06

…s tested

Reversed change

e100822

BarnyShergold requested a review from YevSent June 22, 2020 21:21

BarnyShergold self-assigned this Jun 22, 2020

BarnyShergold requested review from BaDos and shiftedreality June 23, 2020 18:14

lbajsarowicz suggested changes Jul 1, 2020

View reviewed changes

ghost assigned lbajsarowicz Jul 1, 2020

ghost added Progress: needs update and removed Progress: pending review labels Jul 1, 2020

pocallaghan mentioned this pull request Jul 3, 2020

URL Regeneration Fails on Store-Level URL Keys - Products #28633

Closed

5 tasks

Updated code as per reviewer

d59d740

BarnyShergold requested a review from lbajsarowicz July 7, 2020 21:33

Updated code as per failed test

0097625

ghost added Progress: accept and removed Progress: extended testing labels Sep 29, 2020

ghost added Progress: extended testing and removed Progress: accept labels Sep 29, 2020

lbajsarowicz approved these changes Sep 29, 2020

View reviewed changes

ghost added Progress: ready for testing and removed Progress: extended testing labels Sep 29, 2020

ghost added Progress: testing in progress and removed Progress: ready for testing labels Sep 29, 2020

ghost added Progress: extended testing and removed Progress: testing in progress labels Sep 29, 2020

update severity, added testCaseId

4b9f004

ghost added Progress: accept and removed Progress: extended testing labels Sep 30, 2020

magento-engcom-team pushed a commit that referenced this pull request Sep 30, 2020

ENGCOM-8274: BUG - Prevent Magento from Creating incorrect URLs for c…

8da57e4

…ategory/products when Store View has modified URL keys #28676

magento-engcom-team merged commit abddda7 into magento:2.4-develop Sep 30, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

BUG - Prevent Magento from Creating incorrect URLs for category/products when Store View has modified URL keys #28676

BUG - Prevent Magento from Creating incorrect URLs for category/products when Store View has modified URL keys #28676

BarnyShergold commented Jun 10, 2020

m2-assistant bot commented Jun 10, 2020

BarnyShergold commented Jun 10, 2020

magento-engcom-team commented Jun 10, 2020

BarnyShergold commented Jun 11, 2020

BarnyShergold commented Jun 22, 2020

BarnyShergold commented Jun 22, 2020

lbajsarowicz left a comment

lbajsarowicz Jul 1, 2020

BarnyShergold Jul 7, 2020

lbajsarowicz Jul 1, 2020

BarnyShergold Jul 7, 2020

lbajsarowicz Jul 1, 2020

BarnyShergold Jul 7, 2020

lbajsarowicz Jul 1, 2020

BarnyShergold Jul 7, 2020

BarnyShergold commented Jul 7, 2020

lbajsarowicz left a comment

magento-engcom-team commented Sep 29, 2020

engcom-Echo commented Sep 29, 2020

engcom-Echo commented Sep 29, 2020

BarnyShergold commented Sep 29, 2020

swnsma commented Sep 29, 2020

BarnyShergold commented Sep 30, 2020

BarnyShergold commented Sep 30, 2020

m2-assistant bot commented Sep 30, 2020

BUG - Prevent Magento from Creating incorrect URLs for category/products when Store View has modified URL keys #28676

BUG - Prevent Magento from Creating incorrect URLs for category/products when Store View has modified URL keys #28676

Conversation

BarnyShergold commented Jun 10, 2020

Description (*)

Related Pull Requests

Fixed Issues (if relevant)

Manual testing scenarios (*)

Questions or comments

Contribution checklist (*)

m2-assistant bot commented Jun 10, 2020

BarnyShergold commented Jun 10, 2020

magento-engcom-team commented Jun 10, 2020

BarnyShergold commented Jun 11, 2020

BarnyShergold commented Jun 22, 2020

BarnyShergold commented Jun 22, 2020

lbajsarowicz left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

BarnyShergold commented Jul 7, 2020

lbajsarowicz left a comment

Choose a reason for hiding this comment

magento-engcom-team commented Sep 29, 2020

engcom-Echo commented Sep 29, 2020

engcom-Echo commented Sep 29, 2020

BarnyShergold commented Sep 29, 2020

swnsma commented Sep 29, 2020

BarnyShergold commented Sep 30, 2020

BarnyShergold commented Sep 30, 2020

m2-assistant bot commented Sep 30, 2020