xref: /dokuwiki/_test/tests/Search/IndexerTest.php (revision 846f53c19679a507af769cd0087abf10115ab902)

<?php

namespace dokuwiki\test\Search;

use dokuwiki\Search\Indexer;
use dokuwiki\Search\Exception\IndexLockException;
use dokuwiki\Search\Index\FileIndex;
use dokuwiki\Search\Index\Lock;
use dokuwiki\Search\MetadataSearch;

/**
 * Tests the Indexer class
 */
class IndexerTest extends \DokuWikiTest
{
    /**
     * Test basic page indexing via addPage
     */
    public function testAddPage()
    {
        $indexer = new Indexer();

        saveWikiText('testpage', 'Foo bar baz.', 'Test initialization');
        $indexer->addPage('testpage');

        // page should be in the entity index
        $pageIndex = new FileIndex('page');
        $result = $pageIndex->search('/^testpage$/');
        $this->assertNotEmpty($result, 'testpage not found in page.idx');
    }

    /**
     * Test that deletePage clears data
     */
    public function testDeletePage()
    {
        $indexer = new Indexer();

        saveWikiText('delpage', 'Delete me content.', 'Test initialization');
        $indexer->addPage('delpage');
        $indexer->deletePage('delpage', true);

        // page entity persists in page.idx but data is cleared
        $pageIndex = new FileIndex('page');
        $result = $pageIndex->search('/^delpage$/');
        $this->assertNotEmpty($result, 'delpage should persist in page.idx');
    }

    /**
     * Test renamePage clears old and indexes new
     */
    public function testRenamePage()
    {
        $indexer = new Indexer();

        saveWikiText('old_name', 'Old page content words.', 'Test initialization');
        $indexer->addPage('old_name');

        $indexer->renamePage('old_name', 'new_name');

        // the entity is renamed in place: new name present, old name gone
        $pageIndex = new FileIndex('page');
        $this->assertNotEmpty($pageIndex->search('/^new_name$/'), 'new_name not found in page.idx after rename');
        $this->assertEmpty($pageIndex->search('/^old_name$/'), 'old_name should be gone from page.idx after rename');
    }

    /**
     * renamePage must preserve the renamed page's outgoing references
     *
     * The rename only changes the page's name in the index, not its content, so all of
     * its index associations - including the pages it links to (relation_references) -
     * must survive under the new name. This is what allows a page renamed early during a
     * namespace move to still be found as a backlink source for pages moved afterwards.
     * It must work even though the destination page is not on disk yet at rename time
     * (the move operation writes it only later), so re-indexing from disk cannot be relied
     * upon here.
     *
     * @see https://github.com/dokuwiki/dokuwiki - regression after the indexer rewrite
     */
    public function testRenamePagePreservesOutgoingReferences()
    {
        $indexer = new Indexer();

        saveWikiText('refsource', '[[target:page]]', 'Test initialization');
        $indexer->addPage('refsource');

        $search = new MetadataSearch();

        // sanity: the source page references target:page
        $value = 'target:page';
        $this->assertEquals(['refsource'], $search->lookupKey('relation_references', $value));

        // rename the source page WITHOUT writing the destination to disk first,
        // mimicking how the move plugin calls renamePage before saving the new page
        $indexer->renamePage('refsource', 'moved:newsource');

        // the outgoing reference must now belong to the renamed page
        $value = 'target:page';
        $this->assertEquals(
            ['moved:newsource'],
            $search->lookupKey('relation_references', $value),
            'rename lost the outgoing reference of the renamed page'
        );
    }

    /**
     * renamePage onto a name that already has its own index entry
     *
     * The renamed page must take over the destination name (keeping its own data) while the
     * destination's previous data is dropped. The stale destination row must be vacated so the
     * name resolves only to the renamed entity and does not leak as a phantom page.
     */
    public function testRenamePageOntoExistingPage()
    {
        $indexer = new Indexer();

        saveWikiText('src', '[[target:fromsrc]]', 'Test initialization');
        $indexer->addPage('src');
        saveWikiText('dst', '[[target:fromdst]]', 'Test initialization');
        $indexer->addPage('dst');

        $indexer->renamePage('src', 'dst');

        $search = new MetadataSearch();

        // dst now carries src's outgoing reference ...
        $value = 'target:fromsrc';
        $this->assertEquals(['dst'], $search->lookupKey('relation_references', $value));
        // ... and the destination's previous reference is gone
        $value = 'target:fromdst';
        $this->assertEquals([], $search->lookupKey('relation_references', $value));

        // exactly one entity named 'dst', the old name and any phantom entry are gone
        $allPages = $indexer->getAllPages();
        $this->assertSame(['dst'], array_values(array_filter($allPages, fn($p) => $p === 'dst' || $p === 'src')));
    }

    /**
     * Test that clear removes all index files
     */
    public function testClear()
    {
        global $conf;
        $indexer = new Indexer();

        saveWikiText('clearpage', 'Some words to index.', 'Test initialization');
        $indexer->addPage('clearpage');

        $this->assertFileExists($conf['indexdir'] . '/page.idx');

        $indexer->clear();

        $this->assertFileDoesNotExist($conf['indexdir'] . '/page.idx');
    }

    /**
     * Test that getVersion returns a version string
     */
    public function testGetVersion()
    {
        $indexer = new Indexer();
        // with no version-modifying plugins active the raw INDEXER_VERSION is returned
        $this->assertSame(\dokuwiki\Search\INDEXER_VERSION, $indexer->getVersion());
    }

    /**
     * Test needsIndexing returns true for new pages
     */
    public function testNeedsIndexing()
    {
        $indexer = new Indexer();

        saveWikiText('needsidx', 'Some content.', 'Test initialization');
        // a brand-new page has no .indexed tag yet, so it always needs indexing
        $this->assertTrue($indexer->needsIndexing('needsidx'));

        // once indexed it is up to date, even when saved and indexed in the same second
        $indexer->addPage('needsidx');
        $this->assertFalse($indexer->needsIndexing('needsidx'));
        $this->assertTrue($indexer->needsIndexing('needsidx', true)); // force
    }

    /**
     * addPage returns true when it indexed the page and false when there was nothing to do
     */
    public function testAddPageReturn()
    {
        $indexer = new Indexer();

        saveWikiText('retadd', 'Some content to index.', 'Test initialization');
        $this->assertTrue($indexer->addPage('retadd'), 'addPage should report work done');

        // already up to date: nothing to do
        $this->assertFalse($indexer->addPage('retadd'), 'addPage should report nothing to do when up to date');

        // forcing reindexing always reports work done
        $this->assertTrue($indexer->addPage('retadd', true), 'forced addPage should report work done');
    }

    /**
     * deletePage returns true when it removed the page and false when there was nothing to do
     */
    public function testDeletePageReturn()
    {
        $indexer = new Indexer();

        // never indexed and not forced: nothing to do
        $this->assertFalse($indexer->deletePage('retdel'), 'deletePage should report nothing to do for an unknown page');

        saveWikiText('retdel', 'Delete me content.', 'Test initialization');
        $indexer->addPage('retdel');
        $this->assertTrue($indexer->deletePage('retdel'), 'deletePage should report work done');

        // the delete removed the .indexed tag, so a second unforced call has nothing to do
        $this->assertFalse($indexer->deletePage('retdel'), 'deletePage should report nothing to do once removed');
    }

    /**
     * renamePage returns true when it renamed the page and false for the no-op cases
     */
    public function testRenamePageReturn()
    {
        $indexer = new Indexer();

        // identical names: nothing to do
        $this->assertFalse($indexer->renamePage('retrename', 'retrename'), 'renamePage should report nothing to do for identical names');

        // old page not in the index: nothing to do
        $this->assertFalse($indexer->renamePage('retrename', 'retrenamed'), 'renamePage should report nothing to do for an unindexed page');

        saveWikiText('retrename', 'Rename me content.', 'Test initialization');
        $indexer->addPage('retrename');
        $this->assertTrue($indexer->renamePage('retrename', 'retrenamed'), 'renamePage should report work done');
    }

    /**
     * Test the logger callback
     */
    public function testLogger()
    {
        $messages = [];
        $indexer = (new Indexer())->setLogger(function ($msg) use (&$messages) {
            $messages[] = $msg;
        });

        saveWikiText('logpage', 'Log test content.', 'Test initialization');
        $indexer->addPage('logpage');

        // second call detects the page is already up to date
        $indexer->addPage('logpage');
        $this->assertNotEmpty($messages);
        $this->assertStringContainsString('up to date', end($messages));
    }

    /**
     * updateMetadataRegistry merges new keys into the existing registry rather
     * than overwriting it, and leaves no lock behind
     */
    public function testUpdateMetadataRegistryMergesKeys()
    {
        global $conf;
        $fn = $conf['indexdir'] . '/metadata.idx';
        $indexer = new Indexer();

        $indexer->updateMetadataRegistry(['alpha']);
        $indexer->updateMetadataRegistry(['beta']);

        $keys = file($fn, FILE_IGNORE_NEW_LINES);
        $this->assertContains('alpha', $keys, 'first key lost when second was added');
        $this->assertContains('beta', $keys);

        // the registry lock must not be held once the call returns
        Lock::acquire('metadata');
        Lock::release('metadata');
        $this->assertFalse(is_dir($conf['lockdir'] . '/metadata.index'));
    }

    /**
     * The registry read-modify-write is guarded by the 'metadata' lock, so a
     * lock held by another process blocks the update instead of letting it
     * clobber a concurrent writer's key
     */
    public function testUpdateMetadataRegistryIsGuardedByLock()
    {
        global $conf;
        $dir = $conf['lockdir'] . '/metadata.index';

        // simulate a foreign lock and don't wait for it in the test
        mkdir($dir);
        touch($dir);
        self::setInaccessibleProperty(new Lock(), 'waitTimeout', 0);

        try {
            $this->expectException(IndexLockException::class);
            (new Indexer())->updateMetadataRegistry(['newkey']);
        } finally {
            self::setInaccessibleProperty(new Lock(), 'waitTimeout', 3);
            @rmdir($dir);
        }
    }
}