silverstripe-fulltextsearch/tests/SearchUpdaterTest.php

<?php

use SilverStripe\ORM\DataObject;
use SilverStripe\FullTextSearch\Search\Indexes\SearchIndex_Recording;
use SilverStripe\Dev\SapphireTest;
use SilverStripe\FullTextSearch\Search\Updaters\SearchUpdater;

class SearchUpdaterTest_Container extends DataObject
{
    private static $db = array(
        'Field1' => 'Varchar',
        'Field2' => 'Varchar',
        'MyDate' => 'Date',
    );

    private static $has_one = array(
        'HasOneObject' => 'SearchUpdaterTest_HasOne'
    );

    private static $has_many = array(
        'HasManyObjects' => 'SearchUpdaterTest_HasMany'
    );

    private static $many_many = array(
        'ManyManyObjects' => 'SearchUpdaterTest_ManyMany'
    );
}

class SearchUpdaterTest_HasOne extends DataObject
{
    private static $db = array(
        'Field1' => 'Varchar',
        'Field2' => 'Varchar'
    );

    private static $has_many = array(
        'HasManyContainers' => 'SearchUpdaterTest_Container'
    );
}

class SearchUpdaterTest_HasMany extends DataObject
{
    private static $db = array(
        'Field1' => 'Varchar',
        'Field2' => 'Varchar'
    );

    private static $has_one = array(
        'HasManyContainer' => 'SearchUpdaterTest_Container'
    );
}

class SearchUpdaterTest_ManyMany extends DataObject
{
    private static $db = array(
        'Field1' => 'Varchar',
        'Field2' => 'Varchar'
    );

    private static $belongs_many_many = array(
        'ManyManyContainer' => 'SearchUpdaterTest_Container'
    );
}

class SearchUpdaterTest_Index extends SearchIndex_Recording
{
    public function init()
    {
        $this->addClass('SearchUpdaterTest_Container');

        $this->addFilterField('Field1');
        $this->addFilterField('HasOneObject.Field1');
        $this->addFilterField('HasManyObjects.Field1');
    }
}

class SearchUpdaterTest extends SapphireTest
{
    protected $usesDatabase = true;

    private static $index = null;

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

        if (self::$index === null) {
            self::$index = singleton(get_class($this).'_Index');
        } else {
            self::$index->reset();
        }

        SearchUpdater::bind_manipulation_capture();

        Config::inst()->update('Injector', 'SearchUpdateProcessor', array(
            'class' => 'SearchUpdateImmediateProcessor'
        ));

        FullTextSearch::force_index_list(self::$index);
        SearchUpdater::clear_dirty_indexes();
    }

    public function testBasic()
    {
        $item = new SearchUpdaterTest_Container();
        $item->write();

        // TODO: Make sure changing field1 updates item.
        // TODO: Get updating just field2 to not update item (maybe not possible - variants complicate)
    }

    public function testHasOneHook()
    {
        $hasOne = new SearchUpdaterTest_HasOne();
        $hasOne->write();

        $alternateHasOne = new SearchUpdaterTest_HasOne();
        $alternateHasOne->write();

        $container1 = new SearchUpdaterTest_Container();
        $container1->HasOneObjectID = $hasOne->ID;
        $container1->write();

        $container2 = new SearchUpdaterTest_Container();
        $container2->HasOneObjectID = $hasOne->ID;
        $container2->write();

        $container3 = new SearchUpdaterTest_Container();
        $container3->HasOneObjectID = $alternateHasOne->ID;
        $container3->write();

        // Check the default "writing a document updates the document"
        SearchUpdater::flush_dirty_indexes();


        $added = self::$index->getAdded(array('ID'));
        // Some databases don't output $added in a consistent order; that's okay
        usort($added, function ($a, $b) {return $a['ID']-$b['ID']; });

        $this->assertEquals($added, array(
            array('ID' => $container1->ID),
            array('ID' => $container2->ID),
            array('ID' => $container3->ID)
        ));

        // Check writing a has_one tracks back to the origin documents

        self::$index->reset();

        $hasOne->Field1 = "Updated";
        $hasOne->write();

        SearchUpdater::flush_dirty_indexes();
        $added = self::$index->getAdded(array('ID'));
        // Some databases don't output $added in a consistent order; that's okay
        usort($added, function ($a, $b) {return $a['ID']-$b['ID']; });

        $this->assertEquals($added, array(
            array('ID' => $container1->ID),
            array('ID' => $container2->ID)
        ));

        // Check updating an unrelated field doesn't track back

        self::$index->reset();

        $hasOne->Field2 = "Updated";
        $hasOne->write();

        SearchUpdater::flush_dirty_indexes();
        $this->assertEquals(self::$index->getAdded(array('ID')), array());

        // Check writing a has_one tracks back to the origin documents

        self::$index->reset();

        $alternateHasOne->Field1= "Updated";
        $alternateHasOne->write();

        SearchUpdater::flush_dirty_indexes();
        $this->assertEquals(self::$index->getAdded(array('ID')), array(
            array('ID' => $container3->ID)
        ));
    }

    public function testHasManyHook()
    {
        $container1 = new SearchUpdaterTest_Container();
        $container1->write();

        $container2 = new SearchUpdaterTest_Container();
        $container2->write();

        //self::$index->reset();
        //SearchUpdater::clear_dirty_indexes();

        $hasMany1 = new SearchUpdaterTest_HasMany();
        $hasMany1->HasManyContainerID = $container1->ID;
        $hasMany1->write();

        $hasMany2 = new SearchUpdaterTest_HasMany();
        $hasMany2->HasManyContainerID = $container1->ID;
        $hasMany2->write();

        SearchUpdater::flush_dirty_indexes();

        $this->assertEquals(self::$index->getAdded(array('ID')), array(
            array('ID' => $container1->ID),
            array('ID' => $container2->ID)
        ));

        self::$index->reset();

        $hasMany1->Field1 = 'Updated';
        $hasMany1->write();

        $hasMany2->Field1 = 'Updated';
        $hasMany2->write();

        SearchUpdater::flush_dirty_indexes();
        $this->assertEquals(self::$index->getAdded(array('ID')), array(
            array('ID' => $container1->ID)
        ));
    }
}