NEXT-37588 - Exclude folder categories from sitemap

fixes shopware#3830
pweyck · Aug 8, 2024 · 6c1b530 · 6c1b530
1 parent d5e6c4f
commit 6c1b530
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 2 deletions.
diff --git a/changelog/_unreleased/2024-08-05-exclude-folder-categories-from-sitemap.md b/changelog/_unreleased/2024-08-05-exclude-folder-categories-from-sitemap.md
@@ -0,0 +1,9 @@
+---
+title: Exclude folder categories from sitemap
+issue: NEXT-00000
+author: Elias Lackner
+author_email: [email protected]
+author_github: @lacknere
+---
+# Core
+* Changed `CategoryUrlProvider::getCategories` to exclude categories of type `folder`.
diff --git a/src/Core/Content/Sitemap/Provider/CategoryUrlProvider.php b/src/Core/Content/Sitemap/Provider/CategoryUrlProvider.php
@@ -129,6 +129,7 @@ private function getCategories(SalesChannelContext $context, int $limit, ?int $o
         $query->andWhere('`category`.version_id = :versionId');
         $query->andWhere('`category`.active = 1');
         $query->andWhere('`category`.type != :linkType');
+        $query->andWhere('`category`.type != :folderType');
 
         $excludedCategoryIds = $this->getExcludedCategoryIds($context);
         if (!empty($excludedCategoryIds)) {
@@ -138,6 +139,7 @@ private function getCategories(SalesChannelContext $context, int $limit, ?int $o
 
         $query->setParameter('versionId', Uuid::fromHexToBytes(Defaults::LIVE_VERSION));
         $query->setParameter('linkType', CategoryDefinition::TYPE_LINK);
+        $query->setParameter('folderType', CategoryDefinition::TYPE_FOLDER);
 
         /** @var list<array{id: string, created_at: string, updated_at: string}> $result */
         $result = $query->executeQuery()->fetchAllAssociative();

diff --git a/src/Core/Content/Test/Sitemap/Provider/CategoryUrlProviderTest.php b/src/Core/Content/Test/Sitemap/Provider/CategoryUrlProviderTest.php
@@ -87,10 +87,16 @@ public function testReturnedOffsetIsValid(): void
         static::assertNull($urlResult->getNextOffset());
     }
 
-    public function testExcludeCategoryLink(): void
+    public function testExcludeCategoryLinkAndFolder(): void
     {
         $urlResult = $this->getCategoryUrlProvider()->getUrls($this->salesChannelContext, 10);
-        static::assertCount(4, $urlResult->getUrls());
+        $ids = array_map(fn ($url) => $url->getIdentifier(), $urlResult->getUrls());
+
+        // link
+        static::assertNotContains('0191233394c57345a56e1b4df4db81c3', $ids);
+
+        // folder
+        static::assertNotContains('0191233394c57345a56e1b4df521dca6', $ids);
     }
 
     private function getCategoryUrlProvider(): CategoryUrlProvider
@@ -142,10 +148,17 @@ private function createCategoryTree(string $rootId): void
                         'active' => true,
                     ],
                     [
+                        'id' => '0191233394c57345a56e1b4df4db81c3',
                         'name' => 'Sub 5',
                         'active' => true,
                         'type' => CategoryDefinition::TYPE_LINK,
                     ],
+                    [
+                        'id' => '0191233394c57345a56e1b4df521dca6',
+                        'name' => 'Sub 6',
+                        'active' => true,
+                        'type' => CategoryDefinition::TYPE_FOLDER,
+                    ],
                 ],
             ],
         ], Context::createDefaultContext());