MAGE-1058: add multistores Pages tests (#1629)

Author: damcou

Helper/Entity/PageHelper.php

@@ -59,7 +59,7 @@ public function getPages($storeId, array $pageIds = null)
             $magentoPages->addFieldToFilter('page_id', ['in' => $pageIds]);
         }
 
-        $excludedPages = $this->getExcludedPageIds();
+        $excludedPages = $this->getExcludedPageIds($storeId);
         if (count($excludedPages)) {
             $magentoPages->addFieldToFilter('identifier', ['nin' => $excludedPages]);
         }
@@ -116,9 +116,9 @@ public function getPages($storeId, array $pageIds = null)
         return $pages;
     }
 
-    public function getExcludedPageIds()
+    public function getExcludedPageIds($storeId = null)
     {
-        $excludedPages = array_values($this->configHelper->getExcludedPages());
+        $excludedPages = array_values($this->configHelper->getExcludedPages($storeId));
         foreach ($excludedPages as &$excludedPage) {
             $excludedPage = $excludedPage['attribute'];
         }

Test/Integration/Page/MultiStorePagesTest.php

@@ -0,0 +1,148 @@
+<?php
+
+namespace Algolia\AlgoliaSearch\Test\Integration\Page;
+
+use Algolia\AlgoliaSearch\Exceptions\AlgoliaException;
+use Algolia\AlgoliaSearch\Exceptions\ExceededRetriesException;
+use Algolia\AlgoliaSearch\Helper\ConfigHelper;
+use Algolia\AlgoliaSearch\Test\Integration\MultiStoreTestCase;
+use Algolia\AlgoliaSearch\Model\Indexer\Page;
+use Magento\Cms\Api\PageRepositoryInterface;
+use Magento\Cms\Api\Data\PageInterface;
+use Magento\Cms\Model\ResourceModel\Page\CollectionFactory;
+use Magento\Framework\Exception\CouldNotSaveException;
+use Magento\Framework\Exception\LocalizedException;
+use Magento\Framework\Exception\NoSuchEntityException;
+use Magento\Store\Api\Data\StoreInterface;
+
+/**
+ * @magentoDataFixture Magento/Store/_files/second_website_with_two_stores.php
+ * @magentoDbIsolation disabled
+ * @magentoAppIsolation enabled
+ */
+class MultiStorePagesTest extends MultiStoreTestCase
+{
+    /** @var Page */
+    protected $pagesIndexer;
+
+    /** @var PageRepositoryInterface */
+    protected $pageRepository;
+
+    /**  @var CollectionFactory */
+    private $pageCollectionFactory;
+
+    const ABOUT_US_PAGE_ID = 7;
+
+    public function setUp():void
+    {
+        parent::setUp();
+
+        $this->pagesIndexer = $this->objectManager->get(Page::class);
+        $this->pageRepository = $this->objectManager->get(PageRepositoryInterface::class);
+        $this->pageCollectionFactory = $this->objectManager->get(CollectionFactory::class);
+
+        $this->pagesIndexer->executeFull();
+        $this->algoliaHelper->waitLastTask();
+    }
+
+    /***
+     * @magentoDbIsolation disabled
+     *
+     * @throws ExceededRetriesException
+     * @throws AlgoliaException
+     */
+    public function testMultiStorePageIndices()
+    {
+        // Check that every store has the right number of pages
+        foreach ($this->storeManager->getStores() as $store) {
+            $this->assertNbOfRecordsPerStore(
+                $store->getCode(),
+                'pages',
+                $store->getCode() === 'fixture_second_store' ? // we excluded 2 pages on setupStore()
+                    $this->assertValues->expectedExcludePages :
+                    $this->assertValues->expectedPages
+            );
+        }
+
+        $defaultStore = $this->storeRepository->get('default');
+        $fixtureSecondStore = $this->storeRepository->get('fixture_second_store');
+
+        try {
+            $aboutUsPage = $this->loadPage(self::ABOUT_US_PAGE_ID);
+        } catch (\Exception $e) {
+            $this->markTestIncomplete('Page could not be found.');
+        }
+
+        // Setting the page only for default store
+        $aboutUsPage->setStores([$defaultStore->getId()]);
+        $this->pageRepository->save($aboutUsPage);
+
+        $this->pagesIndexer->execute([self::ABOUT_US_PAGE_ID]);
+        $this->algoliaHelper->waitLastTask();
+
+        $this->assertNbOfRecordsPerStore(
+            $defaultStore->getCode(),
+            'pages',
+            $this->assertValues->expectedPages
+        );
+
+        $this->assertNbOfRecordsPerStore(
+            $fixtureSecondStore->getCode(),
+            'pages',
+            $this->assertValues->expectedExcludePages - 1
+        );
+    }
+
+    /**
+     * Loads page by id.
+     *
+     * @param int $pageId
+     *
+     * @return PageInterface
+     * @throws LocalizedException
+     */
+    private function loadPage(int $pageId): PageInterface
+    {
+        return $this->pageRepository->getById($pageId);
+    }
+
+    protected function resetPage(PageInterface $page): void
+    {
+        $page->setStores([0]);
+        $this->pageRepository->save($page);
+    }
+
+    /**
+     * @param StoreInterface $store
+     * @param bool $enableInstantSearch
+     *
+     * @return void
+     * @throws AlgoliaException
+     * @throws LocalizedException
+     * @throws NoSuchEntityException
+     */
+    protected function setupStore(StoreInterface $store, bool $enableInstantSearch = false): void
+    {
+        // Exclude 2 pages on second store
+        $excludedPages = $store->getCode() === 'fixture_second_store' ?
+            [['attribute' => 'no-route'], ['attribute' => 'home']]:
+            [];
+
+        $this->setConfig(
+            ConfigHelper::EXCLUDED_PAGES,
+            $this->getSerializer()->serialize($excludedPages),
+            $store->getCode()
+        );
+
+        parent::setupStore($store, $enableInstantSearch);
+    }
+
+    public function tearDown(): void
+    {
+        // Restore page in case DB is not cleaned up
+        $aboutUsPage = $this->loadPage(self::ABOUT_US_PAGE_ID);
+        $this->resetPage($aboutUsPage);
+
+        parent::tearDown();
+    }
+}