gordonbanderson / freetextsearch

tests/BulkIndex/BulkIndexerTest.php

<?php declare(strict_types = 1);

namespace Suilven\FreeTextSearch\Tests\Factory;

use League\CLImate\CLImate;
use SilverStripe\CMS\Model\SiteTree;
use SilverStripe\Core\Injector\Injector;
use SilverStripe\Dev\SapphireTest;
use SilverStripe\ORM\DataObject;
use SilverStripe\ORM\DB;
use SilverStripe\SiteConfig\SiteConfig;
use Suilven\FreeTextSearch\Helper\BulkIndexingHelper;
use Suilven\FreeTextSearch\Tests\Mock\BulkIndexer;
use Symbiote\QueuedJobs\DataObjects\QueuedJobDescriptor;
use Symbiote\QueuedJobs\Services\QueuedJob;

class BulkIndexerTest extends SapphireTest
{
    protected static $fixture_file = ['tests/fixtures/sitetree.yml'];

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

        $config = SiteConfig::current_site_config();
        $config->FreeTextSearchIndexingModeInBulk = 1;
        $config->write();
    }


    public function testSingleDocumentBeingQueuedForBulkIndexing(): void
    {
        BulkIndexer::resetIndexedPayload();

        // only one job is created per index when there are dirty objects to index.  This is dealt with within the
        // queued jobs module, in that the job parameters are identical.  One job will already be present from
        // loading of the fixtures.  As such, clear the queue
        DB::query('DELETE FROM "QueuedJobDescriptor"');

        $before = QueuedJobDescriptor::get()->count();

        $page = $this->objFromFixture(SiteTree::class, 'sitetree_10');
        $page->Title = 'This is a new title';
        $page->write();

        $after = QueuedJobDescriptor::get()->count();

        // assert that 1 job has been created, then inspect the contents
        $this->assertEquals(1, $after - $before);

        // check the contents of the job queue
        $jobDescriptor = QueuedJobDescriptor::get()->first();
        $this->assertEquals('Bulk Index Dirty DataObjects', $jobDescriptor->JobTitle);
        $this->assertEquals(
            'O:8:"stdClass":1:{s:9:"indexName";s:8:"sitetree";}',
            $jobDescriptor->SavedJobData
        );

        // create the job class
        $impl = $jobDescriptor->Implementation;
        /** @var \Suilven\FreeTextSearch\Tests\Factory\BulkIndexDirtyJob $job */
        $job = Injector::inst()->create($impl);

        // populate data - taken from QueuedJobService
        $jobData = null;

The assignment to $jobData is dead and can be removed.

        $messages = null;

The assignment to $messages is dead and can be removed.

        // switching to php's serialize methods... not sure why this wasn't done from the start!
        $jobData = @\unserialize($jobDescriptor->SavedJobData);

It seems like $jobDescriptor->SavedJobData can also be of type null; however, parameter $data of unserialize() does only seem to accept string, maybe add an additional type check?

        $messages = @\unserialize($jobDescriptor->SavedJobMessages);

        // try decoding as json if null
        $jobData = $jobData
            ? $jobData
            : \json_decode($jobDescriptor->SavedJobData);

It seems like $jobDescriptor->SavedJobData can also be of type null; however, parameter $json of json_decode() does only seem to accept string, maybe add an additional type check?

        $messages = $messages
            ? $messages
            : \json_decode($jobDescriptor->SavedJobMessages);

        $job->setJobData(
            $jobDescriptor->TotalSteps,
            $jobDescriptor->StepsProcessed,
            $jobDescriptor->JobStatus === QueuedJob::STATUS_COMPLETE,
            $jobData,
            $messages
        );

        $job->setup();
        $job->process();

        $this->checkBulkIndexedPayload();
    }


    public function testBulkIndexAll(): void
    {
        BulkIndexer::resetIndexedPayload();
        $helper = new BulkIndexingHelper();
        $helper->bulkIndex('sitetree', false, new CLImate());

        $this->assertEquals('sitetree', BulkIndexer::getIndexName());

        $this->checkBulkIndexedPayload();
    }


    public function tearDown(): void
    {
        parent::tearDown();

        $config = SiteConfig::current_site_config();
        $config->FreeTextSearchIndexingModeInBulk = 0;
        $config->write();
    }


    private function checkBulkIndexedPayload(): void
    {
        foreach (BulkIndexer::getIndexedPayload() as $documentPayload) {
            $id = $documentPayload['ID'];
            $page = DataObject::get_by_id(SiteTree::class, $id);
            $this->assertEquals($page->Title, $documentPayload['sitetree']['Title']);
            $this->assertEquals($page->Content, $documentPayload['sitetree']['Content']);
        }
    }
}