Merge remote-tracking branch '35156/sitemap/cms-page-exclude' into comm_voted_v3

Author: engcom-Charlie

app/code/Magento/Sitemap/Model/ResourceModel/Cms/Page.php

@@ -1,14 +1,17 @@
 <?php
+
 /**
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+
 namespace Magento\Sitemap\Model\ResourceModel\Cms;
 
 use Magento\Cms\Api\Data\PageInterface;
 use Magento\Cms\Api\GetUtilityPageIdentifiersInterface;
 use Magento\Cms\Model\Page as CmsPage;
 use Magento\Framework\App\ObjectManager;
+use Magento\Framework\DataObject;
 use Magento\Framework\DB\Select;
 use Magento\Framework\EntityManager\EntityManager;
 use Magento\Framework\EntityManager\MetadataPool;
@@ -21,6 +24,8 @@
  *
  * @api
  * @since 100.0.2
+ * @SuppressWarnings(PHPMD.CamelCaseMethodName)
+ * @SuppressWarnings(PHPMD.LongVariable)
  */
 class Page extends AbstractDb
 {
@@ -85,6 +90,7 @@ public function getConnection()
      * Retrieve cms page collection array
      *
      * @param int $storeId
+     *
      * @return array
      */
     public function getCollection($storeId)
@@ -103,7 +109,17 @@ public function getCollection($storeId)
             'main_table.is_active = 1'
         )->where(
             'main_table.identifier NOT IN (?)',
-            $this->getUtilityPageIdentifiers->execute()
+            array_map(
+                // When two CMS pages have the same URL key (in different
+                // stores), the value stored in configuration is 'url-key|ID'.
+                // This function strips the trailing '|ID' so that this where()
+                // matches the url-key configured.
+                // See https://github.com/magento/magento2/issues/35001
+                static function ($urlKey) {
+                    return explode('|', $urlKey, 2)[0];
+                },
+                $this->getUtilityPageIdentifiers->execute()
+            )
         )->where(
             'store_table.store_id IN(?)',
             [0, $storeId]
@@ -123,11 +139,12 @@ public function getCollection($storeId)
      * Prepare page object
      *
      * @param array $data
-     * @return \Magento\Framework\DataObject
+     *
+     * @return DataObject
      */
     protected function _prepareObject(array $data)
     {
-        $object = new \Magento\Framework\DataObject();
+        $object = new DataObject();
         $object->setId($data[$this->getIdFieldName()]);
         $object->setUrl($data['url']);
         $object->setUpdatedAt($data['updated_at']);
@@ -140,7 +157,8 @@ protected function _prepareObject(array $data)
      *
      * @param CmsPage|AbstractModel $object
      * @param mixed $value
-     * @param string $field field to load by (defaults to model id)
+     * @param string $field Field to load by (defaults to model id).
+     *
      * @return $this
      * @since 100.1.0
      */
@@ -168,6 +186,7 @@ public function load(AbstractModel $object, $value, $field = null)
         if ($isId) {
             $this->entityManager->load($object, $value);
         }
+
         return $this;
     }
 
@@ -190,6 +209,7 @@ public function save(AbstractModel $object)
                 $object->setHasDataChanges(false);
                 return $this;
             }
+
             $object->validateBeforeSave();
             $object->beforeSave();
             if ($object->isSaveAllowed()) {
@@ -201,13 +221,15 @@ public function save(AbstractModel $object)
                 $this->unserializeFields($object);
                 $this->processAfterSaves($object);
             }
+
             $this->addCommitCallback([$object, 'afterCommitCallback'])->commit();
             $object->setHasDataChanges(false);
         } catch (\Exception $e) {
             $this->rollBack();
             $object->setHasDataChanges(true);
             throw $e;
         }
+
         return $this;
     }
 

app/code/Magento/Sitemap/Test/Unit/Model/ResourceModel/Cms/PageTest.php

@@ -1,8 +1,10 @@
 <?php
+
 /**
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+
 declare(strict_types=1);
 
 namespace Magento\Sitemap\Test\Unit\Model\ResourceModel\Cms;
@@ -25,6 +27,8 @@
 /**
  * Provide tests for Cms Page resource model.
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
+ * @SuppressWarnings(PHPMD.ExcessiveMethodLength)
+ * @SuppressWarnings(PHPMD.LongVariable)
  */
 class PageTest extends TestCase
 {
@@ -104,7 +108,11 @@ public function testGetCollection()
         $pageId = 'testPageId';
         $url = 'testUrl';
         $updatedAt = 'testUpdatedAt';
-        $pageIdentifiers = ['testCmsHomePage', 'testCmsNoRoute', 'testCmsNoCookies'];
+        $pageIdentifiers = [
+            'testCmsHomePage|ID' => 'testCmsHomePage',
+            'testCmsNoRoute' => 'testCmsNoRoute',
+            'testCmsNoCookies' => 'testCmsNoCookies',
+        ];
         $storeId = 1;
         $linkField = 'testLinkField';
         $expectedPage = new DataObject();
@@ -147,7 +155,10 @@ public function testGetCollection()
             ->method('where')
             ->withConsecutive(
                 [$this->identicalTo('main_table.is_active = 1')],
-                [$this->identicalTo('main_table.identifier NOT IN (?)'), $this->identicalTo($pageIdentifiers)],
+                [
+                    $this->identicalTo('main_table.identifier NOT IN (?)'),
+                    $this->identicalTo(array_values($pageIdentifiers))
+                ],
                 [$this->identicalTo('store_table.store_id IN(?)'), $this->identicalTo([0, $storeId])]
             )->willReturnSelf();
 
@@ -176,7 +187,7 @@ public function testGetCollection()
 
         $this->getUtilityPageIdentifiers->expects($this->once())
             ->method('execute')
-            ->willReturn($pageIdentifiers);
+            ->willReturn(array_keys($pageIdentifiers));
 
         $this->resource->expects($this->exactly(2))
             ->method('getTableName')