MAGETWO-95539: [2.3] Moving Category generate duplicate url_rewrite when 4th level category exist and is translated

- Fixed url rewrites regeneration after category moving

Author: viktym

app/code/Magento/CatalogUrlRewrite/Model/Category/Plugin/Category/Move.php

@@ -6,9 +6,14 @@
 namespace Magento\CatalogUrlRewrite\Model\Category\Plugin\Category;
 
 use Magento\Catalog\Model\Category;
+use Magento\Catalog\Model\CategoryFactory;
 use Magento\CatalogUrlRewrite\Model\CategoryUrlPathGenerator;
 use Magento\CatalogUrlRewrite\Model\Category\ChildrenCategoriesProvider;
+use Magento\Store\Model\Store;
 
+/**
+ * Perform url updating for children categories.
+ */
 class Move
 {
     /**
@@ -21,16 +26,24 @@ class Move
      */
     private $childrenCategoriesProvider;
 
+    /**
+     * @var CategoryFactory
+     */
+    private $categoryFactory;
+
     /**
      * @param CategoryUrlPathGenerator $categoryUrlPathGenerator
      * @param ChildrenCategoriesProvider $childrenCategoriesProvider
+     * @param CategoryFactory $categoryFactory
      */
     public function __construct(
         CategoryUrlPathGenerator $categoryUrlPathGenerator,
-        ChildrenCategoriesProvider $childrenCategoriesProvider
+        ChildrenCategoriesProvider $childrenCategoriesProvider,
+        CategoryFactory $categoryFactory
     ) {
         $this->categoryUrlPathGenerator = $categoryUrlPathGenerator;
         $this->childrenCategoriesProvider = $childrenCategoriesProvider;
+        $this->categoryFactory = $categoryFactory;
     }
 
     /**
@@ -51,20 +64,54 @@ public function afterChangeParent(
         Category $newParent,
         $afterCategoryId
     ) {
-        $category->setUrlPath($this->categoryUrlPathGenerator->getUrlPath($category));
-        $category->getResource()->saveAttribute($category, 'url_path');
-        $this->updateUrlPathForChildren($category);
+        foreach ($category->getStoreIds() as $storeId) {
+            $category->setStoreId($storeId);
+            if (!$this->isGlobalScope($storeId)) {
+                $this->updateCategoryUrlKeyForStore($category);
+                $category->setUrlPath($this->categoryUrlPathGenerator->getUrlPath($category));
+                $category->getResource()->saveAttribute($category, 'url_path');
+                $this->updateUrlPathForChildren($category);
+            }
+        }
 
         return $result;
     }
 
     /**
+     * Set category url_key according to current category store id.
+     *
+     * @param Category $category
+     * @return void
+     */
+    private function updateCategoryUrlKeyForStore(Category $category)
+    {
+        $item = $this->categoryFactory->create();
+        $item->setStoreId($category->getStoreId());
+        $item->load($category->getId());
+        $category->setUrlKey($item->getUrlKey());
+    }
+
+    /**
+     * Check is global scope.
+     *
+     * @param int|null $storeId
+     * @return bool
+     */
+    private function isGlobalScope($storeId)
+    {
+        return null === $storeId || $storeId == Store::DEFAULT_STORE_ID;
+    }
+
+    /**
+     * Updates url_path for child categories.
+     *
      * @param Category $category
      * @return void
      */
-    protected function updateUrlPathForChildren($category)
+    private function updateUrlPathForChildren($category)
     {
         foreach ($this->childrenCategoriesProvider->getChildren($category, true) as $childCategory) {
+            $childCategory->setStoreId($category->getStoreId());
             $childCategory->unsUrlPath();
             $childCategory->setUrlPath($this->categoryUrlPathGenerator->getUrlPath($childCategory));
             $childCategory->getResource()->saveAttribute($childCategory, 'url_path');

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

@@ -15,6 +15,9 @@
 use Magento\Framework\App\ObjectManager;
 use Magento\UrlRewrite\Model\MergeDataProviderFactory;
 
+/**
+ * Generate list of urls.
+ */
 class CategoryUrlRewriteGenerator
 {
     /** Entity type code */
@@ -84,6 +87,8 @@ public function __construct(
     }
 
     /**
+     * Generate list of urls.
+     *
      * @param \Magento\Catalog\Model\Category $category
      * @param bool $overrideStoreUrls
      * @param int|null $rootCategoryId
@@ -119,6 +124,7 @@ protected function generateForGlobalScope(
         $mergeDataProvider = clone $this->mergeDataProviderPrototype;
         $categoryId = $category->getId();
         foreach ($category->getStoreIds() as $storeId) {
+            $category->setStoreId($storeId);
             if (!$this->isGlobalScope($storeId)
                 && $this->isOverrideUrlsForStore($storeId, $categoryId, $overrideStoreUrls)
             ) {
@@ -131,6 +137,8 @@ protected function generateForGlobalScope(
     }
 
     /**
+     * Checks if urls should be overridden for store.
+     *
      * @param int $storeId
      * @param int $categoryId
      * @param bool $overrideStoreUrls

app/code/Magento/CatalogUrlRewrite/Test/Unit/Model/Category/Plugin/Category/MoveTest.php

@@ -5,6 +5,7 @@
  */
 namespace Magento\CatalogUrlRewrite\Test\Unit\Model\Category\Plugin\Category;
 
+use Magento\Catalog\Model\CategoryFactory;
 use Magento\CatalogUrlRewrite\Model\Category\Plugin\Category\Move as CategoryMovePlugin;
 use Magento\Framework\TestFramework\Unit\Helper\ObjectManager;
 use Magento\CatalogUrlRewrite\Model\CategoryUrlPathGenerator;
@@ -39,6 +40,11 @@ class MoveTest extends \PHPUnit\Framework\TestCase
      */
     private $categoryMock;
 
+    /**
+     * @var CategoryFactory|\PHPUnit_Framework_MockObject_MockObject
+     */
+    private $categoryFactory;
+
     /**
      * @var CategoryMovePlugin
      */
@@ -55,28 +61,44 @@ protected function setUp()
             ->disableOriginalConstructor()
             ->setMethods(['getChildren'])
             ->getMock();
+        $this->categoryFactory = $this->getMockBuilder(CategoryFactory::class)
+            ->disableOriginalConstructor()
+            ->getMock();
         $this->subjectMock = $this->getMockBuilder(CategoryResourceModel::class)
             ->disableOriginalConstructor()
             ->getMock();
         $this->categoryMock = $this->getMockBuilder(Category::class)
             ->disableOriginalConstructor()
-            ->setMethods(['getResource', 'setUrlPath'])
+            ->setMethods(['getResource', 'setUrlPath', 'getStoreIds'])
             ->getMock();
         $this->plugin = $this->objectManager->getObject(
             CategoryMovePlugin::class,
             [
                 'categoryUrlPathGenerator' => $this->categoryUrlPathGeneratorMock,
-                'childrenCategoriesProvider' => $this->childrenCategoriesProviderMock
+                'childrenCategoriesProvider' => $this->childrenCategoriesProviderMock,
+                'categoryFactory' => $this->categoryFactory
             ]
         );
     }
 
+    /**
+     * Tests url updating for children categories.
+     */
     public function testAfterChangeParent()
     {
         $urlPath = 'test/path';
-        $this->categoryMock->expects($this->once())
-            ->method('getResource')
+        $storeIds = [1];
+        $originalCategory = $this->getMockBuilder(Category::class)
+            ->disableOriginalConstructor()
+            ->getMock();
+        $this->categoryFactory->method('create')
+            ->willReturn($originalCategory);
+
+        $this->categoryMock->method('getResource')
             ->willReturn($this->subjectMock);
+        $this->categoryMock->expects($this->once())
+            ->method('getStoreIds')
+            ->willReturn($storeIds);
         $this->childrenCategoriesProviderMock->expects($this->once())
             ->method('getChildren')
             ->with($this->categoryMock, true)
@@ -85,9 +107,6 @@ public function testAfterChangeParent()
             ->method('getUrlPath')
             ->with($this->categoryMock)
             ->willReturn($urlPath);
-        $this->categoryMock->expects($this->once())
-            ->method('getResource')
-            ->willReturn($this->subjectMock);
         $this->categoryMock->expects($this->once())
             ->method('setUrlPath')
             ->with($urlPath);