silverstripe-fulltextsearch/tests/SolrReindexQueuedTest.php

<?php

namespace SilverStripe\FullTextSearch\Tests;

use SilverStripe\Core\Config\Config;
use SilverStripe\Core\Injector\Injector;
use SilverStripe\Dev\SapphireTest;
use SilverStripe\FullTextSearch\Search\FullTextSearch;
use SilverStripe\FullTextSearch\Search\Services\SearchableService;
use SilverStripe\FullTextSearch\Solr\Reindex\Handlers\SolrReindexHandler;
use SilverStripe\FullTextSearch\Solr\Reindex\Handlers\SolrReindexQueuedHandler;
use SilverStripe\FullTextSearch\Solr\Reindex\Jobs\SolrReindexGroupQueuedJob;
use SilverStripe\FullTextSearch\Solr\Reindex\Jobs\SolrReindexQueuedJob;
use SilverStripe\FullTextSearch\Solr\Services\Solr4Service;
use SilverStripe\FullTextSearch\Solr\Services\SolrService;
use SilverStripe\FullTextSearch\Tests\SearchVariantVersionedTest\SearchVariantVersionedTest_Item;
use SilverStripe\FullTextSearch\Tests\SolrReindexQueuedTest\SolrReindexQueuedTest_Service;
use SilverStripe\FullTextSearch\Tests\SolrReindexTest\SolrReindexTest_Index;
use SilverStripe\FullTextSearch\Tests\SolrReindexTest\SolrReindexTest_Item;
use SilverStripe\FullTextSearch\Tests\SolrReindexTest\SolrReindexTest_RecordingLogger;
use SilverStripe\FullTextSearch\Tests\SolrReindexTest\SolrReindexTest_Variant;
use Symbiote\QueuedJobs\Services\QueuedJob;

/**
 * Additional tests of solr reindexing processes when run with queuedjobs
 */
class SolrReindexQueuedTest extends SapphireTest
{
    protected $usesDatabase = true;

    protected static $extra_dataobjects = array(
        SolrReindexTest_Item::class
    );

    /**
     * Forced index for testing
     *
     * @var SolrReindexTest_Index
     */
    protected $index = null;

    /**
     * Mock service
     *
     * @var SolrService
     */
    protected $service = null;

    protected function setUp(): void
    {
        parent::setUp();

        if (!interface_exists(QueuedJob::class)) {
            $this->skipTest = true;
            $this->markTestSkipped("These tests need the QueuedJobs module installed to run");
        }

        // Set queued handler for reindex
        Config::modify()->set(Injector::class, SolrReindexHandler::class, array(
            'class' => SolrReindexQueuedHandler::class
        ));
        Injector::inst()->registerService(new SolrReindexQueuedHandler(), SolrReindexHandler::class);

        // Set test variant
        SolrReindexTest_Variant::enable();

        // Set index list
        $this->service = $this->serviceMock();
        $this->index = singleton(SolrReindexTest_Index::class);
        $this->index->setService($this->service);
        FullTextSearch::force_index_list($this->index);
    }

    /**
     * Populate database with dummy dataset
     *
     * @param int $number Number of records to create in each variant
     */
    protected function createDummyData($number)
    {
        // Note that we don't create any records in variant = 2, to represent a variant
        // that should be cleared without any re-indexes performed
        foreach ([0, 1] as $variant) {
            for ($i = 1; $i <= $number; $i++) {
                $item = new SolrReindexTest_Item();
                $item->Variant = $variant;
                $item->Title = "Item $variant / $i";
                $item->write();
            }
        }
    }

    /**
     * Mock service
     *
     * @return SolrService
     */
    protected function serviceMock()
    {
        // Setup mock
        /** @var Solr4Service $serviceMock */
        $serviceMock = $this->getMockBuilder(Solr4Service::class)
            ->setMethods(['deleteByQuery', 'addDocument'])
            ->getMock();

        return $serviceMock;
    }

    protected function tearDown(): void
    {
        FullTextSearch::force_index_list();
        SolrReindexTest_Variant::disable();
        parent::tearDown();
    }

    /**
     * Get the reindex handler
     *
     * @return SolrReindexHandler
     */
    protected function getHandler()
    {
        return Injector::inst()->get(SolrReindexHandler::class);
    }

    /**
     * @return SolrReindexQueuedTest_Service
     */
    protected function getQueuedJobService()
    {
        return Injector::inst()->get(SolrReindexQueuedTest_Service::class);
    }

    /**
     * Test that reindex will generate a top top level queued job, and executing this will perform
     * the necessary initialisation of the grouped queued jobs
     */
    public function testReindexSegmentsGroups()
    {
        $classesToSkip = [SolrReindexTest_Item::class];
        Config::modify()->set(SearchableService::class, 'indexing_canview_exclude_classes', $classesToSkip);

        $this->createDummyData(18);

        // Deletes are performed in the main task prior to individual groups being processed
        // 18 records means 3 groups of 6 in each variant (6 total)
        // Ensure correct call is made to Solr
        $this->service->expects($this->exactly(2))
            ->method('deleteByQuery')
            ->withConsecutive(
                [
                    $this->equalTo('-(ClassHierarchy:' . SolrReindexTest_Item::class . ')')
                ],
                [
                    $this->equalTo('+(ClassHierarchy:' . SolrReindexTest_Item::class . ') +(_testvariant:"2")')
                ]
            );

        // Create pre-existing jobs
        $this->getQueuedJobService()->queueJob(new SolrReindexQueuedJob());
        $this->getQueuedJobService()->queueJob(new SolrReindexGroupQueuedJob());
        $this->getQueuedJobService()->queueJob(new SolrReindexGroupQueuedJob());

        // Initiate re-index
        $logger = new SolrReindexTest_RecordingLogger();
        $this->getHandler()->triggerReindex($logger, 6, 'Solr_Reindex');

        // Old jobs should be cancelled
        $this->assertEquals(1, $logger->countMessages('Cancelled 1 re-index tasks and 2 re-index groups'));
        $this->assertEquals(1, $logger->countMessages('Queued Solr Reindex Job'));

        // Next job should be queue job
        $job = $this->getQueuedJobService()->getNextJob();
        $this->assertInstanceOf(SolrReindexQueuedJob::class, $job);
        $this->assertEquals(6, $job->getBatchSize());

        // Test that necessary items are created
        $logger->clear();
        $job->setLogger($logger);
        $job->process();

        $this->assertEquals(1, $logger->countMessages('Beginning init of reindex'));
        $this->assertEquals(6, $logger->countMessages('Queued Solr Reindex Group '));
        $this->assertEquals(3, $logger->countMessages(' of ' . SolrReindexTest_Item::class . ' in {' . json_encode(SolrReindexTest_Variant::class) . ':"0"}'));
        $this->assertEquals(3, $logger->countMessages(' of ' . SolrReindexTest_Item::class . ' in {' . json_encode(SolrReindexTest_Variant::class) . ':"1"}'));
        $this->assertEquals(1, $logger->countMessages('Completed init of reindex'));

        // Test that invalid classes are removed
        $this->assertNotEmpty($logger->getMessages('Clearing obsolete classes from ' . SolrReindexTest_Index::class));

        // Test that valid classes in invalid variants are removed
        $this->assertNotEmpty($logger->getMessages(
            'Clearing all records of type ' . SolrReindexTest_Item::class . ' in the current state: {"' . SolrReindexTest_Variant::class . '":"2"}'
        ));
    }

    /**
     * Test index processing on individual groups
     */
    public function testRunGroup()
    {
        $classesToSkip = [SolrReindexTest_Item::class];
        Config::modify()->set(SearchableService::class, 'indexing_canview_exclude_classes', $classesToSkip);

        $this->createDummyData(18);

        // Just do what the SolrReindexQueuedJob would do to create each sub
        $logger = new SolrReindexTest_RecordingLogger();
        $this->getHandler()->runReindex($logger, 6, 'Solr_Reindex');

        // Assert jobs are created
        $this->assertEquals(6, $logger->countMessages('Queued Solr Reindex Group'));

        // Check next job is a group queued job
        /** @var SolrReindexGroupQueuedJob $job */
        $job = $this->getQueuedJobService()->getNextJob();
        $this->assertInstanceOf(SolrReindexGroupQueuedJob::class, $job);
        $this->assertEquals(
            'Solr Reindex Group (1/3) of ' . SolrReindexTest_Item::class . ' in {' . json_encode(SolrReindexTest_Variant::class) . ':"0"}',
            $job->getTitle()
        );

        // Running this job performs the necessary reindex
        $logger->clear();
        $job->setLogger($logger);
        $job->process();

        // Check tasks completed (as per non-queuedjob version)
        $this->assertEquals(1, $logger->countMessages('Beginning reindex group'));
        $this->assertEquals(1, $logger->countMessages('Adding ' . SolrReindexTest_Item::class . ''));
        $this->assertEquals(1, $logger->countMessages('Queuing commit on all changes'));
        $this->assertEquals(1, $logger->countMessages('Completed reindex group'));

        // Check IDs
        $idMessage = $logger->filterMessages('Updated ');
        $this->assertNotEmpty(preg_match('/^Updated (?<ids>[,\d]+)/i', $idMessage[0], $matches));
        $ids = array_unique(explode(',', $matches['ids']));
        $this->assertEquals(6, count($ids));
        foreach ($ids as $id) {
            // Each id should be % 3 == 0
            $this->assertEquals(0, $id % 3, "ID $id Should match pattern ID % 3 = 0");
        }
    }
}