Fixed URL Rewrite generation and removal on product/website change.

Moved scope of ProductToWebsiteChangeObserver to base instead of adminhtml
as this functionality has been moved to a consumer. With the observer set
to adminhtml, this observer was not being called properly on changing
the websites for a particular product in the consumer.

Corrected ProductProcessUrlRewriteSavingObserver to correctly add and remove
rewrite URLs when products are added and removed from websites using the
Product Edit Admin Page.

Corrected ProductToWebsiteChangeObserver to correctly add and remove
rewrite URLs when products are added and removed using the Products
Grid Mass Action function.

Extended unit tests to cover both Observers.

Fixed MFTF test for Product URL Rewrite generation.

Author: Graham Wharton

app/code/Magento/Catalog/Model/Product/Action.php

@@ -169,6 +169,14 @@ public function updateWebsites($productIds, $websiteIds, $type)
             $categoryIndexer->reindexList(array_unique($productIds));
         }
 
-        $this->_eventManager->dispatch('catalog_product_to_website_change', ['products' => $productIds]);
+        //Dispatch event to update Rewrite URLs for new/removed websites
+        $this->_eventManager->dispatch(
+            'catalog_product_to_website_change',
+            [
+                'products' => $productIds,
+                'website_ids' => $websiteIds,
+                'action_type' => $type
+            ]
+        );
     }
 }

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

@@ -11,9 +11,17 @@
 use Magento\Framework\App\ObjectManager;
 use Magento\UrlRewrite\Model\UrlPersistInterface;
 use Magento\Framework\Event\ObserverInterface;
+use Magento\Catalog\Model\Product\Visibility;
+use Magento\Store\Model\StoreManagerInterface;
+use Magento\UrlRewrite\Service\V1\Data\UrlRewrite;
+use Magento\Store\Api\StoreWebsiteRelationInterface;
 
 /**
  * Class ProductProcessUrlRewriteSavingObserver
+ *
+ * Observer to update the Rewrite URLs for a product.
+ * This observer is triggered on the save function when making changes
+ * to the products website on the Product Edit page.
  */
 class ProductProcessUrlRewriteSavingObserver implements ObserverInterface
 {
@@ -32,20 +40,38 @@ class ProductProcessUrlRewriteSavingObserver implements ObserverInterface
      */
     private $productUrlPathGenerator;
 
+    /**
+     * @var StoreManagerInterface $storeManager
+     */
+    private $storeManager;
+
+    /**
+     * @var StoreWebsiteRelationInterface
+     */
+    private $storeWebsiteRelation;
+
     /**
      * @param ProductUrlRewriteGenerator $productUrlRewriteGenerator
      * @param UrlPersistInterface $urlPersist
      * @param ProductUrlPathGenerator|null $productUrlPathGenerator
+     * @param StoreManagerInterface|null $storeManager
+     * @param StoreWebsiteRelationInterface|null $storeWebsiteRelation
      */
     public function __construct(
         ProductUrlRewriteGenerator $productUrlRewriteGenerator,
         UrlPersistInterface $urlPersist,
-        ProductUrlPathGenerator $productUrlPathGenerator = null
+        ProductUrlPathGenerator $productUrlPathGenerator = null,
+        StoreManagerInterface $storeManager = null,
+        StoreWebsiteRelationInterface $storeWebsiteRelation = null
     ) {
         $this->productUrlRewriteGenerator = $productUrlRewriteGenerator;
         $this->urlPersist = $urlPersist;
         $this->productUrlPathGenerator = $productUrlPathGenerator ?: ObjectManager::getInstance()
             ->get(ProductUrlPathGenerator::class);
+        $this->storeManager = $storeManager ?: ObjectManager::getInstance()
+            ->get(StoreManagerInterface::class);
+        $this->storeWebsiteRelation = $storeWebsiteRelation ?: ObjectManager::getInstance()
+            ->get(StoreWebsiteRelationInterface::class);
     }
 
     /**
@@ -65,10 +91,24 @@ public function execute(\Magento\Framework\Event\Observer $observer)
             || $product->getIsChangedWebsites()
             || $product->dataHasChangedFor('visibility')
         ) {
-            if ($product->isVisibleInSiteVisibility()) {
+            if ($product->getVisibility() != Visibility::VISIBILITY_NOT_VISIBLE) {
                 $product->unsUrlPath();
                 $product->setUrlPath($this->productUrlPathGenerator->getUrlPath($product));
                 $this->urlPersist->replace($this->productUrlRewriteGenerator->generate($product));
+
+                //Remove any rewrite URLs for websites the product is not in
+                foreach ($this->storeManager->getWebsites() as $website) {
+                    $websiteId = $website->getWebsiteId();
+                    if (!in_array($websiteId, $product->getWebsiteIds())) {
+                        foreach ($this->storeWebsiteRelation->getStoreByWebsiteId($websiteId) as $storeId) {
+                            $this->urlPersist->deleteByData([
+                                UrlRewrite::ENTITY_ID => $product->getId(),
+                                UrlRewrite::ENTITY_TYPE => ProductUrlRewriteGenerator::ENTITY_TYPE,
+                                UrlRewrite::STORE_ID => $storeId
+                            ]);
+                        }
+                    }
+                }
             }
         }
     }

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

@@ -17,7 +17,11 @@
 use Magento\Framework\App\ObjectManager;
 
 /**
- * Observer to assign the products to website
+ * Class ProductToWebsiteChangeObserver
+ *
+ * Observer to update the Rewrite URLs for a product.
+ * This observer is triggered by the product_action_attribute.website.update
+ * consumer in response to Mass Action changes in the Admin Product Grid.
  */
 class ProductToWebsiteChangeObserver implements ObserverInterface
 {
@@ -36,11 +40,6 @@ class ProductToWebsiteChangeObserver implements ObserverInterface
      */
     protected $productRepository;
 
-    /**
-     * @var RequestInterface
-     */
-    protected $request;
-
     /**
      * @var StoreWebsiteRelationInterface
      */
@@ -52,6 +51,8 @@ class ProductToWebsiteChangeObserver implements ObserverInterface
      * @param ProductRepositoryInterface $productRepository
      * @param RequestInterface $request
      * @param StoreWebsiteRelationInterface $storeWebsiteRelation
+     *
+     *  * @SuppressWarnings(PHPMD.UnusedFormalParameter)
      */
     public function __construct(
         ProductUrlRewriteGenerator $productUrlRewriteGenerator,
@@ -63,7 +64,6 @@ public function __construct(
         $this->productUrlRewriteGenerator = $productUrlRewriteGenerator;
         $this->urlPersist = $urlPersist;
         $this->productRepository = $productRepository;
-        $this->request = $request;
         $this->storeWebsiteRelation = $storeWebsiteRelation ?:
             ObjectManager::getInstance()->get(StoreWebsiteRelationInterface::class);
     }
@@ -77,24 +77,29 @@ public function __construct(
     public function execute(\Magento\Framework\Event\Observer $observer)
     {
         foreach ($observer->getEvent()->getProducts() as $productId) {
+            /* @var \Magento\Catalog\Model\Product $product */
             $product = $this->productRepository->getById(
                 $productId,
                 false,
-                $this->request->getParam('store_id', Store::DEFAULT_STORE_ID)
+                Store::DEFAULT_STORE_ID,
+                true
             );
 
-            if (!empty($this->productUrlRewriteGenerator->generate($product))) {
-                if ($this->request->getParam('remove_website_ids')) {
-                    foreach ($this->request->getParam('remove_website_ids') as $webId) {
-                        foreach ($this->storeWebsiteRelation->getStoreByWebsiteId($webId) as $storeId) {
-                            $this->urlPersist->deleteByData([
-                                UrlRewrite::ENTITY_ID => $product->getId(),
-                                UrlRewrite::ENTITY_TYPE => ProductUrlRewriteGenerator::ENTITY_TYPE,
-                                UrlRewrite::STORE_ID => $storeId
-                            ]);
-                        }
+            // Remove the URLs from websites this product no longer belongs to
+            if ($observer->getEvent()->getActionType() == "remove" && $observer->getEvent()->getWebsiteIds()) {
+                foreach ($observer->getEvent()->getWebsiteIds() as $webId) {
+                    foreach ($this->storeWebsiteRelation->getStoreByWebsiteId($webId) as $storeId) {
+                        $this->urlPersist->deleteByData([
+                            UrlRewrite::ENTITY_ID => $product->getId(),
+                            UrlRewrite::ENTITY_TYPE => ProductUrlRewriteGenerator::ENTITY_TYPE,
+                            UrlRewrite::STORE_ID => $storeId
+                        ]);
                     }
                 }
+            }
+
+            // Refresh all existing URLs for the product
+            if (!empty($this->productUrlRewriteGenerator->generate($product))) {
                 if ($product->getVisibility() != Visibility::VISIBILITY_NOT_VISIBLE) {
                     $this->urlPersist->replace($this->productUrlRewriteGenerator->generate($product));
                 }