MC-34483: Moving a store view to a different website resets URLs

tsviklinskyi · tsviklinskyi · commit 7e7eb07c48bd · 2020-05-27T15:09:12.000+03:00
diff --git a/app/code/Magento/CatalogUrlRewrite/Model/Category/Plugin/Store/View.php b/app/code/Magento/CatalogUrlRewrite/Model/Category/Plugin/Store/View.php
@@ -3,14 +3,18 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+declare(strict_types=1);
+
 namespace Magento\CatalogUrlRewrite\Model\Category\Plugin\Store;
 
 use Magento\Catalog\Model\Category;
 use Magento\Catalog\Model\CategoryFactory;
+use Magento\Catalog\Model\Product;
 use Magento\Catalog\Model\ProductFactory;
 use Magento\CatalogUrlRewrite\Model\CategoryUrlRewriteGenerator;
 use Magento\CatalogUrlRewrite\Model\ProductUrlRewriteGenerator;
 use Magento\Framework\Model\AbstractModel;
+use Magento\Store\Model\ResourceModel\Store;
 use Magento\UrlRewrite\Model\UrlPersistInterface;
 use Magento\UrlRewrite\Service\V1\Data\UrlRewrite;
 
@@ -19,32 +23,31 @@
  *
  * @see \Magento\Store\Model\ResourceModel\Store
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
- * @package Magento\CatalogUrlRewrite\Model\Category\Plugin\Store
  */
 class View
 {
     /**
-     * @var \Magento\UrlRewrite\Model\UrlPersistInterface
+     * @var UrlPersistInterface
      */
     protected $urlPersist;
 
     /**
-     * @var \Magento\Catalog\Model\CategoryFactory
+     * @var CategoryFactory
      */
     protected $categoryFactory;
 
     /**
-     * @var \Magento\Catalog\Model\ProductFactory
+     * @var ProductFactory
      */
     protected $productFactory;
 
     /**
-     * @var \Magento\CatalogUrlRewrite\Model\CategoryUrlRewriteGenerator
+     * @var CategoryUrlRewriteGenerator
      */
     protected $categoryUrlRewriteGenerator;
 
     /**
-     * @var \Magento\CatalogUrlRewrite\Model\ProductUrlRewriteGenerator
+     * @var ProductUrlRewriteGenerator
      */
     protected $productUrlRewriteGenerator;
 
@@ -75,114 +78,116 @@ public function __construct(
     }
 
     /**
-     * @param \Magento\Store\Model\ResourceModel\Store $object
+     * Set original store before saving
+     *
+     * @param Store $object
      * @param AbstractModel $store
      * @return void
      * @SuppressWarnings(PHPMD.UnusedFormalParameter)
      */
     public function beforeSave(
-        \Magento\Store\Model\ResourceModel\Store $object,
+        Store $object,
         AbstractModel $store
-    ) {
+    ): void {
         $this->origStore = $store;
     }
 
     /**
      * Regenerate urls on store after save
      *
-     * @param \Magento\Store\Model\ResourceModel\Store $object
-     * @param \Magento\Store\Model\ResourceModel\Store $store
-     * @return \Magento\Store\Model\ResourceModel\Store
+     * @param Store $object
+     * @param Store $store
+     * @return Store
      * @SuppressWarnings(PHPMD.UnusedFormalParameter)
      */
     public function afterSave(
-        \Magento\Store\Model\ResourceModel\Store $object,
-        \Magento\Store\Model\ResourceModel\Store $store
-    ) {
+        Store $object,
+        Store $store
+    ): Store {
         if ($this->origStore->isObjectNew() || $this->origStore->dataHasChangedFor('group_id')) {
             if (!$this->origStore->isObjectNew()) {
-                $this->urlPersist->deleteByData([UrlRewrite::STORE_ID => $this->origStore->getId()]);
+                $this->urlPersist->deleteByData([
+                    UrlRewrite::STORE_ID => $this->origStore->getId(),
+                    UrlRewrite::ENTITY_TYPE => [
+                        CategoryUrlRewriteGenerator::ENTITY_TYPE,
+                        ProductUrlRewriteGenerator::ENTITY_TYPE,
+                    ],
+                ]);
             }
 
             $this->urlPersist->replace(
-                $this->generateCategoryUrls($this->origStore->getRootCategoryId(), $this->origStore->getId())
+                $this->generateCategoryUrls((int)$this->origStore->getRootCategoryId(), (int)$this->origStore->getId())
             );
 
             $this->urlPersist->replace(
-                $this->generateProductUrls(
-                    $this->origStore->getWebsiteId(),
-                    $this->origStore->getOrigData('website_id'),
-                    $this->origStore->getId()
-                )
+                $this->generateProductUrls((int)$this->origStore->getId())
             );
         }
+
         return $store;
     }
 
     /**
-     * Generate url rewrites for products assigned to website
+     * Generate url rewrites for products assigned to store
      *
-     * @param int $websiteId
-     * @param int $originWebsiteId
      * @param int $storeId
      * @return array
      */
-    protected function generateProductUrls($websiteId, $originWebsiteId, $storeId)
+    protected function generateProductUrls(int $storeId): array
     {
         $urls = [];
-        $websiteIds = $websiteId != $originWebsiteId && $originWebsiteId !== null
-            ? [$websiteId, $originWebsiteId]
-            : [$websiteId];
+        $rewrites = [];
         $collection = $this->productFactory->create()
             ->getCollection()
             ->addCategoryIds()
             ->addAttributeToSelect(['name', 'url_path', 'url_key', 'visibility'])
-            ->addWebsiteFilter($websiteIds);
+            ->addStoreFilter($storeId);
         foreach ($collection as $product) {
             $product->setStoreId($storeId);
-            /** @var \Magento\Catalog\Model\Product $product */
-            $urls = array_merge(
-                $urls,
-                $this->productUrlRewriteGenerator->generate($product)
-            );
+            /** @var Product $product */
+            $rewrites[] = $this->productUrlRewriteGenerator->generate($product);
         }
+        $urls = array_merge($urls, ...$rewrites);
+
         return $urls;
     }
 
     /**
+     * Generate url rewrites for categories assigned to store
+     *
      * @param int $rootCategoryId
      * @param int $storeId
      * @return array
      */
-    protected function generateCategoryUrls($rootCategoryId, $storeId)
+    protected function generateCategoryUrls(int $rootCategoryId, int $storeId): array
     {
         $urls = [];
+        $rewrites = [];
         $categories = $this->categoryFactory->create()->getCategories($rootCategoryId, 1, false, true);
         foreach ($categories as $category) {
-            /** @var \Magento\Catalog\Model\Category $category */
+            /** @var Category $category */
             $category->setStoreId($storeId);
-            $urls = array_merge(
-                $urls,
-                $this->categoryUrlRewriteGenerator->generate($category)
-            );
+            $rewrites[] = $this->categoryUrlRewriteGenerator->generate($category);
         }
+        $urls = array_merge($urls, ...$rewrites);
+
         return $urls;
     }
 
     /**
      * Delete unused url rewrites
      *
-     * @param \Magento\Store\Model\ResourceModel\Store $subject
-     * @param \Magento\Store\Model\ResourceModel\Store $result
+     * @param Store $subject
+     * @param Store $result
      * @param AbstractModel $store
-     * @return \Magento\Store\Model\ResourceModel\Store
+     * @return Store
      * @SuppressWarnings(PHPMD.UnusedFormalParameter)
      */
     public function afterDelete(
-        \Magento\Store\Model\ResourceModel\Store $subject,
-        \Magento\Store\Model\ResourceModel\Store $result,
+        Store $subject,
+        Store $result,
         AbstractModel $store
-    ) {
+    ): Store {
         $this->urlPersist->deleteByData([UrlRewrite::STORE_ID => $store->getId()]);
 
         return $result;
diff --git a/app/code/Magento/CatalogUrlRewrite/Test/Unit/Model/Category/Plugin/Store/ViewTest.php b/app/code/Magento/CatalogUrlRewrite/Test/Unit/Model/Category/Plugin/Store/ViewTest.php
@@ -121,7 +121,7 @@ protected function setUp(): void
             ->getMock();
         $this->productCollectionMock = $this->getMockBuilder(ProductCollection::class)
             ->disableOriginalConstructor()
-            ->setMethods(['addCategoryIds', 'addAttributeToSelect', 'addWebsiteFilter', 'getIterator'])
+            ->setMethods(['addCategoryIds', 'addAttributeToSelect', 'getIterator', 'addStoreFilter'])
             ->getMock();
         $this->productMock = $this->getMockBuilder(Product::class)
             ->disableOriginalConstructor()
@@ -174,7 +174,7 @@ public function testAfterSave()
             ->method('addAttributeToSelect')
             ->willReturn($this->productCollectionMock);
         $this->productCollectionMock->expects($this->once())
-            ->method('addWebsiteFilter')
+            ->method('addStoreFilter')
             ->willReturn($this->productCollectionMock);
         $iterator = new \ArrayIterator([$this->productMock]);
         $this->productCollectionMock->expects($this->once())
diff --git a/app/code/Magento/CmsUrlRewrite/Plugin/Cms/Model/Store/View.php b/app/code/Magento/CmsUrlRewrite/Plugin/Cms/Model/Store/View.php
@@ -72,7 +72,7 @@ public function __construct(
      */
     public function afterSave(ResourceStore $object, ResourceStore $result, AbstractModel $store): void
     {
-        if ($store->isObjectNew() || $store->dataHasChangedFor('group_id')) {
+        if ($store->isObjectNew()) {
             $this->urlPersist->replace(
                 $this->generateCmsPagesUrls((int)$store->getId())
             );
diff --git a/dev/tests/integration/testsuite/Magento/CmsUrlRewrite/Plugin/Cms/Model/Store/ViewTest.php b/dev/tests/integration/testsuite/Magento/CmsUrlRewrite/Plugin/Cms/Model/Store/ViewTest.php
@@ -7,19 +7,30 @@
 
 namespace Magento\CmsUrlRewrite\Plugin\Cms\Model\Store;
 
+use Magento\Cms\Api\Data\PageInterface;
+use Magento\Cms\Api\PageRepositoryInterface;
+use Magento\CmsUrlRewrite\Model\CmsPageUrlPathGenerator;
+use Magento\CmsUrlRewrite\Model\CmsPageUrlRewriteGenerator;
+use Magento\Framework\Api\Filter;
+use Magento\Framework\Api\Search\FilterGroup;
+use Magento\Framework\Api\SearchCriteriaInterface;
 use Magento\Framework\ObjectManagerInterface;
 use Magento\Store\Model\Store;
 use Magento\Store\Model\StoreFactory;
 use Magento\TestFramework\Helper\Bootstrap;
 use Magento\UrlRewrite\Model\UrlFinderInterface;
+use Magento\UrlRewrite\Model\UrlPersistInterface;
 use Magento\UrlRewrite\Service\V1\Data\UrlRewrite;
+use Magento\UrlRewrite\Service\V1\Data\UrlRewriteFactory;
+use PHPUnit\Framework\TestCase;
 
 /**
  * Test for plugin which is listening store resource model and on save replace cms page url rewrites
  *
  * @magentoAppArea adminhtml
+ * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
  */
-class ViewTest extends \PHPUnit\Framework\TestCase
+class ViewTest extends TestCase
 {
     /**
      * @var UrlFinderInterface
@@ -36,6 +47,26 @@ class ViewTest extends \PHPUnit\Framework\TestCase
      */
     private $storeFactory;
 
+    /**
+     * @var UrlPersistInterface
+     */
+    private $urlPersist;
+
+    /**
+     * @var UrlRewriteFactory
+     */
+    private $urlRewriteFactory;
+
+    /**
+     * @var PageRepositoryInterface
+     */
+    private $pageRepository;
+
+    /**
+     * @var CmsPageUrlPathGenerator
+     */
+    private $cmsPageUrlPathGenerator;
+
     /**
      * @inheritdoc
      */
@@ -44,6 +75,10 @@ protected function setUp(): void
         $this->objectManager = Bootstrap::getObjectManager();
         $this->urlFinder = $this->objectManager->create(UrlFinderInterface::class);
         $this->storeFactory = $this->objectManager->create(StoreFactory::class);
+        $this->urlPersist = $this->objectManager->create(UrlPersistInterface::class);
+        $this->urlRewriteFactory = $this->objectManager->create(UrlRewriteFactory::class);
+        $this->pageRepository = $this->objectManager->create(PageRepositoryInterface::class);
+        $this->cmsPageUrlPathGenerator = $this->objectManager->create(CmsPageUrlPathGenerator::class);
     }
 
     /**
@@ -54,21 +89,25 @@ protected function setUp(): void
     public function testUrlRewritesChangesAfterStoreSave()
     {
         $storeId = $this->createStore();
-        $this->assertUrlRewritesCount($storeId, 1);
+        $this->assertUrlRewritesCount($storeId, 'page100', 1);
+        $this->editUrlRewrite($storeId, 'page100');
+        $this->saveStore($storeId);
+        $this->assertUrlRewritesCount($storeId, 'page100-test', 1);
         $this->deleteStore($storeId);
-        $this->assertUrlRewritesCount($storeId, 0);
+        $this->assertUrlRewritesCount($storeId, 'page100', 0);
     }
 
     /**
      * Assert url rewrites count by store id
      *
      * @param int $storeId
+     * @param string $pageIdentifier
      * @param int $expectedCount
      */
-    private function assertUrlRewritesCount(int $storeId, int $expectedCount): void
+    private function assertUrlRewritesCount(int $storeId, string $pageIdentifier, int $expectedCount): void
     {
         $data = [
-            UrlRewrite::REQUEST_PATH => 'page100',
+            UrlRewrite::REQUEST_PATH => $pageIdentifier,
             UrlRewrite::STORE_ID => $storeId
         ];
         $urlRewrites = $this->urlFinder->findAllByData($data);
@@ -105,4 +144,49 @@ private function deleteStore(int $storeId): void
             $store->delete();
         }
     }
+
+    /**
+     * Edit url rewrite
+     *
+     * @param int $storeId
+     * @param string $pageIdentifier
+     */
+    private function editUrlRewrite(int $storeId, string $pageIdentifier): void
+    {
+        $filter = $this->objectManager->create(Filter::class);
+        $filter->setField('identifier')->setValue($pageIdentifier);
+        $filterGroup = $this->objectManager->create(FilterGroup::class);
+        $filterGroup->setFilters([$filter]);
+        $searchCriteria = $this->objectManager->create(SearchCriteriaInterface::class);
+        $searchCriteria->setFilterGroups([$filterGroup]);
+        $pageSearchResults = $this->pageRepository->getList($searchCriteria);
+        $pages = $pageSearchResults->getItems();
+        /** @var PageInterface $page */
+        $cmsPage = array_values($pages)[0];
+
+        $urlRewrite = $this->urlRewriteFactory->create()->setStoreId($storeId)
+            ->setEntityType(CmsPageUrlRewriteGenerator::ENTITY_TYPE)
+            ->setEntityId($cmsPage->getId())
+            ->setRequestPath($cmsPage->getIdentifier() . '-test')
+            ->setTargetPath($this->cmsPageUrlPathGenerator->getCanonicalUrlPath($cmsPage))
+            ->setIsAutogenerated(0)
+            ->setRedirectType(0);
+
+        $this->urlPersist->replace([$urlRewrite]);
+    }
+
+    /**
+     * Edit test store
+     *
+     * @param int $storeId
+     * @return void
+     */
+    private function saveStore(int $storeId): void
+    {
+        $store = $this->storeFactory->create();
+        $store->load($storeId);
+        if ($store !== null) {
+            $store->save();
+        }
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -72,7 +72,7 @@ public function __construct(`
`72`	`72`	`*/`
`73`	`73`	`public function afterSave(ResourceStore $object, ResourceStore $result, AbstractModel $store): void`
`74`	`74`	`{`
`75`		`- if ($store->isObjectNew() \|\| $store->dataHasChangedFor('group_id')) {`
	`75`	`+ if ($store->isObjectNew()) {`
`76`	`76`	`$this->urlPersist->replace(`
`77`	`77`	`$this->generateCmsPagesUrls((int)$store->getId())`
`78`	`78`	`);`