MAGETWO-45113: Wrong url rewrites in catalog categories after changing url key for store view and moving category

Author: Michail Slabko

app/code/Magento/Catalog/Model/CategoryRepository.php

@@ -106,7 +106,8 @@ public function save(\Magento\Catalog\Api\Data\CategoryInterface $category)
      */
     public function get($categoryId, $storeId = null)
     {
-        if (!isset($this->instances[$categoryId])) {
+        $cacheKey = null !== $storeId ? $storeId : 'all';
+        if (!isset($this->instances[$categoryId][$cacheKey])) {
             /** @var Category $category */
             $category = $this->categoryFactory->create();
             if (null !== $storeId) {
@@ -116,9 +117,9 @@ public function get($categoryId, $storeId = null)
             if (!$category->getId()) {
                 throw NoSuchEntityException::singleField('id', $categoryId);
             }
-            $this->instances[$categoryId] = $category;
+            $this->instances[$categoryId][$cacheKey] = $category;
         }
-        return $this->instances[$categoryId];
+        return $this->instances[$categoryId][$cacheKey];
     }
 
     /**

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

@@ -11,6 +11,7 @@
 use Magento\CatalogUrlRewrite\Model\Category\CurrentUrlRewritesRegenerator;
 use Magento\CatalogUrlRewrite\Service\V1\StoreViewService;
 use Magento\Store\Model\Store;
+use Magento\Catalog\Api\CategoryRepositoryInterface;
 
 class CategoryUrlRewriteGenerator
 {
@@ -32,30 +33,39 @@ class CategoryUrlRewriteGenerator
     /** @var \Magento\CatalogUrlRewrite\Model\Category\ChildrenUrlRewriteGenerator */
     protected $childrenUrlRewriteGenerator;
 
+    /**
+     * @var bool
+     */
+    protected $overrideStoreUrls;
+
     /**
      * @param \Magento\CatalogUrlRewrite\Model\Category\CanonicalUrlRewriteGenerator $canonicalUrlRewriteGenerator
      * @param \Magento\CatalogUrlRewrite\Model\Category\CurrentUrlRewritesRegenerator $currentUrlRewritesRegenerator
      * @param \Magento\CatalogUrlRewrite\Model\Category\ChildrenUrlRewriteGenerator $childrenUrlRewriteGenerator
      * @param \Magento\CatalogUrlRewrite\Service\V1\StoreViewService $storeViewService
+     * @param \Magento\Catalog\Api\CategoryRepositoryInterface $categoryRepository
      */
     public function __construct(
         CanonicalUrlRewriteGenerator $canonicalUrlRewriteGenerator,
         CurrentUrlRewritesRegenerator $currentUrlRewritesRegenerator,
         ChildrenUrlRewriteGenerator $childrenUrlRewriteGenerator,
-        StoreViewService $storeViewService
+        StoreViewService $storeViewService,
+        CategoryRepositoryInterface $categoryRepository
     ) {
         $this->storeViewService = $storeViewService;
         $this->canonicalUrlRewriteGenerator = $canonicalUrlRewriteGenerator;
         $this->childrenUrlRewriteGenerator = $childrenUrlRewriteGenerator;
         $this->currentUrlRewritesRegenerator = $currentUrlRewritesRegenerator;
+        $this->categoryRepository = $categoryRepository;
     }
 
     /**
      * {@inheritdoc}
      */
-    public function generate($category)
+    public function generate($category, $overrideStoreUrls = false)
     {
         $this->category = $category;
+        $this->overrideStoreUrls = $overrideStoreUrls;
 
         $storeId = $this->category->getStoreId();
         $urls = $this->isGlobalScope($storeId)
@@ -75,16 +85,44 @@ protected function generateForGlobalScope()
     {
         $urls = [];
         $categoryId = $this->category->getId();
-        foreach ($this->category->getStoreIds() as $id) {
-            if (!$this->isGlobalScope($id)
-                && !$this->storeViewService->doesEntityHaveOverriddenUrlKeyForStore($id, $categoryId, Category::ENTITY)
+        foreach ($this->category->getStoreIds() as $storeId) {
+            if (!$this->isGlobalScope($storeId)
+                && $this->isOverrideUrlsForStore($storeId, $categoryId)
             ) {
-                $urls = array_merge($urls, $this->generateForSpecificStoreView($id));
+                $this->updateCategoryUrlForStore($storeId);
+                $urls = array_merge($urls, $this->generateForSpecificStoreView($storeId));
             }
         }
         return $urls;
     }
 
+    /**
+     * @param int $storeId
+     * @param int $categoryId
+     * @return bool
+     */
+    protected function isOverrideUrlsForStore($storeId, $categoryId)
+    {
+        return $this->overrideStoreUrls
+            || !$this->storeViewService->doesEntityHaveOverriddenUrlKeyForStore(
+            $storeId,
+            $categoryId,
+            Category::ENTITY
+        );
+    }
+
+    /**
+     * Override url key and url path for category in specific Store
+     *
+     * @param int $storeId
+     * @return void
+     */
+    protected function updateCategoryUrlForStore($storeId)
+    {
+        $category = $this->categoryRepository->get($this->category->getId(), $storeId);
+        $this->category->addData(['url_key' => $category->getUrlKey(), 'url_path' => $category->getUrlPath()]);
+    }
+
     /**
      * Check is global scope
      *

app/code/Magento/CatalogUrlRewrite/Observer/CategoryProcessUrlRewriteMovingObserver.php

@@ -61,7 +61,7 @@ public function execute(\Magento\Framework\Event\Observer $observer)
             );
             $category->setData('save_rewrites_history', $saveRewritesHistory);
             $urlRewrites = array_merge(
-                $this->categoryUrlRewriteGenerator->generate($category),
+                $this->categoryUrlRewriteGenerator->generate($category, true),
                 $this->urlRewriteHandler->generateProductUrlRewrites($category)
             );
             $this->urlRewriteHandler->deleteCategoryRewritesForChildren($category);

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

@@ -31,6 +31,9 @@ class CategoryUrlRewriteGeneratorTest extends \PHPUnit_Framework_TestCase
     /** @var \Magento\Catalog\Model\Category|\PHPUnit_Framework_MockObject_MockObject */
     protected $category;
 
+    /** @var \Magento\Catalog\Api\CategoryRepositoryInterface|\PHPUnit_Framework_MockObject_MockObject */
+    protected $categoryRepository;
+
     /**
      * Test method
      */
@@ -48,6 +51,7 @@ protected function setUp()
         $this->storeViewService = $this->getMockBuilder('Magento\CatalogUrlRewrite\Service\V1\StoreViewService')
             ->disableOriginalConstructor()->getMock();
         $this->category = $this->getMock('Magento\Catalog\Model\Category', [], [], '', false);
+        $this->categoryRepository = $this->getMock('Magento\Catalog\Api\CategoryRepositoryInterface');
 
         $this->categoryUrlRewriteGenerator = (new ObjectManager($this))->getObject(
             'Magento\CatalogUrlRewrite\Model\CategoryUrlRewriteGenerator',
@@ -56,6 +60,7 @@ protected function setUp()
                 'childrenUrlRewriteGenerator' => $this->childrenUrlRewriteGenerator,
                 'currentUrlRewritesRegenerator' => $this->currentUrlRewritesRegenerator,
                 'storeViewService' => $this->storeViewService,
+                'categoryRepository' => $this->categoryRepository,
             ]
         );
     }
@@ -84,6 +89,14 @@ public function testGenerationForGlobalScope()
             ->setStoreId(3);
         $this->currentUrlRewritesRegenerator->expects($this->any())->method('generate')
             ->will($this->returnValue([$current]));
+        $categoryForSpecificStore = $this->getMock(
+            'Magento\Catalog\Model\Category',
+            ['getUrlKey', 'getUrlPath'],
+            [],
+            '',
+            false
+        );
+        $this->categoryRepository->expects($this->once())->method('get')->willReturn($categoryForSpecificStore);
 
         $this->assertEquals(
             [$canonical, $children, $current],