Change URL Key behaviour to allow the same key to be used more then once

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

@@ -37,9 +37,10 @@ public function __construct(
      * @param \Magento\Catalog\Model\Product $product
      * @param \Magento\Catalog\Model\Category $category
      * @param int|null $rootCategoryId
+     * @param \Magento\UrlRewrite\Model\MergeDataProvider|null $urlRewrites
      * @return \Magento\UrlRewrite\Service\V1\Data\UrlRewrite[]
      */
-    public function generate(Product $product, Category $category, $rootCategoryId = null)
+    public function generate(Product $product, Category $category, $rootCategoryId = null, $urlRewrites = null)
     {
         if ($product->getVisibility() == Visibility::VISIBILITY_NOT_VISIBLE) {
             return [];
@@ -48,12 +49,17 @@ public function generate(Product $product, Category $category, $rootCategoryId =
         $storeId = $product->getStoreId();
 
         $urls = $this->productScopeRewriteGenerator->isGlobalScope($storeId)
-            ? $this->productScopeRewriteGenerator->generateForGlobalScope([$category], $product, $rootCategoryId)
-            : $this->productScopeRewriteGenerator->generateForSpecificStoreView(
+            ? $this->productScopeRewriteGenerator->generateForGlobalScope(
+                [$category],
+                $product,
+                $rootCategoryId,
+                $urlRewrites
+            ) : $this->productScopeRewriteGenerator->generateForSpecificStoreView(
                 $storeId,
                 [$category],
                 $product,
-                $rootCategoryId
+                $rootCategoryId,
+                $urlRewrites
             );
 
         return $urls;

app/code/Magento/CatalogUrlRewrite/Model/Product/AnchorUrlRewriteGenerator.php

@@ -6,15 +6,17 @@
 namespace Magento\CatalogUrlRewrite\Model\Product;
 
 use Magento\Catalog\Api\CategoryRepositoryInterface;
+use Magento\Catalog\Model\Category;
 use Magento\Catalog\Model\Product;
 use Magento\CatalogUrlRewrite\Model\ObjectRegistry;
 use Magento\CatalogUrlRewrite\Model\ProductUrlPathGenerator;
 use Magento\CatalogUrlRewrite\Model\ProductUrlRewriteGenerator;
-use Magento\Framework\Exception\NoSuchEntityException;
+use Magento\UrlRewrite\Model\MergeDataProvider;
+use Magento\UrlRewrite\Model\UrlFinderInterface;
 use Magento\UrlRewrite\Service\V1\Data\UrlRewrite;
 use Magento\UrlRewrite\Service\V1\Data\UrlRewriteFactory;
 
-class AnchorUrlRewriteGenerator
+class AnchorUrlRewriteGenerator extends BaseUrlRewriteGenerator
 {
     /** @var ProductUrlPathGenerator */
     protected $urlPathGenerator;
@@ -29,15 +31,18 @@ class AnchorUrlRewriteGenerator
      * @param ProductUrlPathGenerator $urlPathGenerator
      * @param UrlRewriteFactory $urlRewriteFactory
      * @param CategoryRepositoryInterface $categoryRepository
+     * @param UrlFinderInterface $urlFinder
      */
     public function __construct(
         ProductUrlPathGenerator $urlPathGenerator,
         UrlRewriteFactory $urlRewriteFactory,
-        CategoryRepositoryInterface $categoryRepository
+        CategoryRepositoryInterface $categoryRepository,
+        UrlFinderInterface $urlFinder
     ) {
         $this->urlPathGenerator = $urlPathGenerator;
         $this->urlRewriteFactory = $urlRewriteFactory;
         $this->categoryRepository = $categoryRepository;
+        $this->urlFinder = $urlFinder;
     }
 
     /**
@@ -46,34 +51,48 @@ public function __construct(
      * @param int $storeId
      * @param Product $product
      * @param ObjectRegistry $productCategories
+     * @param MergeDataProvider $urlRewrites
      * @return UrlRewrite[]
      */
-    public function generate($storeId, Product $product, ObjectRegistry $productCategories)
-    {
+    public function generate(
+        $storeId,
+        Product $product,
+        ObjectRegistry $productCategories,
+        $urlRewrites = null
+    ) {
+        $this->urlRewrites = $urlRewrites;
+
         $urls = [];
         foreach ($productCategories->getList() as $category) {
             $anchorCategoryIds = $category->getAnchorsAbove();
             if ($anchorCategoryIds) {
                 foreach ($anchorCategoryIds as $anchorCategoryId) {
                     $anchorCategory = $this->categoryRepository->get($anchorCategoryId);
-                    $urls[] = $this->urlRewriteFactory->create()
-                        ->setEntityType(ProductUrlRewriteGenerator::ENTITY_TYPE)
-                        ->setEntityId($product->getId())
-                        ->setRequestPath(
-                            $this->urlPathGenerator->getUrlPathWithSuffix(
-                                $product,
-                                $storeId,
-                                $anchorCategory
-                            )
-                        )
-                        ->setTargetPath(
-                            $this->urlPathGenerator->getCanonicalUrlPath(
-                                $product,
-                                $anchorCategory
+
+                    if (!in_array(
+                        $anchorCategory->getParentId(),
+                        [Category::ROOT_CATEGORY_ID, Category::TREE_ROOT_ID]
+                    )) {
+                        $paths = [
+                            $this->urlPathGenerator->getUrlPathWithSuffix($product, $storeId, $anchorCategory),
+                            $this->urlPathGenerator->getUrlPathWithIdAndSuffix($product, $storeId, $anchorCategory)
+                        ];
+
+                        $requestPath = $this->checkRequestPaths($paths, $product->getId(), $storeId);
+
+                        $urls[] = $this->urlRewriteFactory->create()
+                            ->setEntityType(ProductUrlRewriteGenerator::ENTITY_TYPE)
+                            ->setEntityId($product->getId())
+                            ->setRequestPath($requestPath)
+                            ->setTargetPath(
+                                $this->urlPathGenerator->getCanonicalUrlPath(
+                                    $product,
+                                    $anchorCategory
+                                )
                             )
-                        )
-                        ->setStoreId($storeId)
-                        ->setMetadata(['category_id' => $anchorCategory->getId()]);
+                            ->setStoreId($storeId)
+                            ->setMetadata(['category_id' => $anchorCategory->getId()]);
+                    }
                 }
             }
         }

app/code/Magento/CatalogUrlRewrite/Model/Product/BaseUrlRewriteGenerator.php

@@ -0,0 +1,61 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Magento\CatalogUrlRewrite\Model\Product;
+
+use Magento\UrlRewrite\Model\MergeDataProvider;
+use Magento\UrlRewrite\Model\UrlFinderInterface;
+use Magento\UrlRewrite\Service\V1\Data\UrlRewrite;
+
+class BaseUrlRewriteGenerator
+{
+    /** @var UrlFinderInterface */
+    protected $urlFinder;
+
+    /** @var MergeDataProvider|null */
+    protected $urlRewrites = null;
+
+    /**
+     * @param array $paths
+     * @param integer $entityId
+     * @param integer $storeId
+     * @return bool|mixed
+     */
+    protected function checkRequestPaths($paths, $entityId, $storeId)
+    {
+        $data = [];
+
+        if ($this->urlRewrites) {
+            foreach ($this->urlRewrites->getData() as $urlRewrite) {
+                if ($urlRewrite->getEntityId() != $entityId && $urlRewrite->getStoreId() == $storeId) {
+                    $data[] = $urlRewrite->getRequestPath();
+                }
+            }
+        }
+
+        $urlRewrites = $this->urlFinder->findAllByData(
+            [
+                UrlRewrite::STORE_ID => $storeId,
+                UrlRewrite::REQUEST_PATH => $paths
+            ]
+        );
+
+        if ($urlRewrites) {
+            foreach ($urlRewrites as $urlRewrite) {
+                if ($urlRewrite->getEntityId() != $entityId) {
+                    $data[] = $urlRewrite->getRequestPath();
+                }
+            }
+        }
+
+        $paths = array_diff($paths, $data);
+        if (empty($paths)) {
+            return false;
+        }
+        reset($paths);
+
+        return current($paths);
+    }
+}

app/code/Magento/CatalogUrlRewrite/Model/Product/CanonicalUrlRewriteGenerator.php

@@ -8,10 +8,12 @@
 use Magento\Catalog\Model\Product;
 use Magento\CatalogUrlRewrite\Model\ProductUrlPathGenerator;
 use Magento\CatalogUrlRewrite\Model\ProductUrlRewriteGenerator;
+use Magento\UrlRewrite\Model\MergeDataProvider;
+use Magento\UrlRewrite\Model\UrlFinderInterface;
 use Magento\UrlRewrite\Service\V1\Data\UrlRewrite;
 use Magento\UrlRewrite\Service\V1\Data\UrlRewriteFactory;
 
-class CanonicalUrlRewriteGenerator
+class CanonicalUrlRewriteGenerator extends BaseUrlRewriteGenerator
 {
     /** @var ProductUrlPathGenerator */
     protected $productUrlPathGenerator;
@@ -22,27 +24,42 @@ class CanonicalUrlRewriteGenerator
     /**
      * @param ProductUrlPathGenerator $productUrlPathGenerator
      * @param UrlRewriteFactory $urlRewriteFactory
+     * @param UrlFinderInterface $urlFinder
      */
-    public function __construct(ProductUrlPathGenerator $productUrlPathGenerator, UrlRewriteFactory $urlRewriteFactory)
-    {
+    public function __construct(
+        ProductUrlPathGenerator $productUrlPathGenerator,
+        UrlRewriteFactory $urlRewriteFactory,
+        UrlFinderInterface $urlFinder
+    ) {
         $this->productUrlPathGenerator = $productUrlPathGenerator;
         $this->urlRewriteFactory = $urlRewriteFactory;
+        $this->urlFinder = $urlFinder;
     }
 
     /**
      * Generate product rewrites without categories
      *
      * @param int $storeId
      * @param Product $product
+     * @param MergeDataProvider|null $urlRewrites
      * @return UrlRewrite[]
      */
-    public function generate($storeId, Product $product)
+    public function generate($storeId, Product $product, $urlRewrites = null)
     {
+        $this->urlRewrites = $urlRewrites;
+
+        $paths = [
+            $this->productUrlPathGenerator->getUrlPathWithSuffix($product, $storeId),
+            $this->productUrlPathGenerator->getUrlPathWithIdAndSuffix($product, $storeId)
+        ];
+
+        $requestPath = $this->checkRequestPaths($paths, $product->getId(), $storeId);
+
         return [
             $this->urlRewriteFactory->create()
                 ->setEntityType(ProductUrlRewriteGenerator::ENTITY_TYPE)
                 ->setEntityId($product->getId())
-                ->setRequestPath($this->productUrlPathGenerator->getUrlPathWithSuffix($product, $storeId))
+                ->setRequestPath($requestPath)
                 ->setTargetPath($this->productUrlPathGenerator->getCanonicalUrlPath($product))
                 ->setStoreId($storeId)
         ];

app/code/Magento/CatalogUrlRewrite/Model/Product/CategoriesUrlRewriteGenerator.php

@@ -9,10 +9,12 @@
 use Magento\CatalogUrlRewrite\Model\ObjectRegistry;
 use Magento\CatalogUrlRewrite\Model\ProductUrlPathGenerator;
 use Magento\CatalogUrlRewrite\Model\ProductUrlRewriteGenerator;
+use Magento\UrlRewrite\Model\MergeDataProvider;
+use Magento\UrlRewrite\Model\UrlFinderInterface;
 use Magento\UrlRewrite\Service\V1\Data\UrlRewrite;
 use Magento\UrlRewrite\Service\V1\Data\UrlRewriteFactory;
 
-class CategoriesUrlRewriteGenerator
+class CategoriesUrlRewriteGenerator extends BaseUrlRewriteGenerator
 {
     /** @var ProductUrlPathGenerator */
     protected $productUrlPathGenerator;
@@ -23,11 +25,16 @@ class CategoriesUrlRewriteGenerator
     /**
      * @param ProductUrlPathGenerator $productUrlPathGenerator
      * @param UrlRewriteFactory $urlRewriteFactory
+     * @param UrlFinderInterface $urlFinder
      */
-    public function __construct(ProductUrlPathGenerator $productUrlPathGenerator, UrlRewriteFactory $urlRewriteFactory)
-    {
+    public function __construct(
+        ProductUrlPathGenerator $productUrlPathGenerator,
+        UrlRewriteFactory $urlRewriteFactory,
+        UrlFinderInterface $urlFinder
+    ) {
         $this->productUrlPathGenerator = $productUrlPathGenerator;
         $this->urlRewriteFactory = $urlRewriteFactory;
+        $this->urlFinder = $urlFinder;
     }
 
     /**
@@ -36,16 +43,30 @@ public function __construct(ProductUrlPathGenerator $productUrlPathGenerator, Ur
      * @param int $storeId
      * @param Product $product
      * @param ObjectRegistry $productCategories
+     * @param MergeDataProvider|null $urlRewrites
      * @return UrlRewrite[]
      */
-    public function generate($storeId, Product $product, ObjectRegistry $productCategories)
-    {
+    public function generate(
+        $storeId,
+        Product $product,
+        ObjectRegistry $productCategories,
+        $urlRewrites = null
+    ) {
+        $this->urlRewrites = $urlRewrites;
         $urls = [];
         foreach ($productCategories->getList() as $category) {
+
+            $paths = [
+                $this->productUrlPathGenerator->getUrlPathWithSuffix($product, $storeId, $category),
+                $this->productUrlPathGenerator->getUrlPathWithIdAndSuffix($product, $storeId, $category)
+            ];
+
+            $requestPath = $this->checkRequestPaths($paths, $product->getId(), $storeId);
+
             $urls[] = $this->urlRewriteFactory->create()
                 ->setEntityType(ProductUrlRewriteGenerator::ENTITY_TYPE)
                 ->setEntityId($product->getId())
-                ->setRequestPath($this->productUrlPathGenerator->getUrlPathWithSuffix($product, $storeId, $category))
+                ->setRequestPath($requestPath)
                 ->setTargetPath($this->productUrlPathGenerator->getCanonicalUrlPath($product, $category))
                 ->setStoreId($storeId)
                 ->setMetadata(['category_id' => $category->getId()]);