Typo3DatabaseBackendTest.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */
 
namespace ‪TYPO3\CMS\Core\Tests\Functional\Cache\Backend;
 
use PHPUnit\Framework\Attributes\Test;
use ‪TYPO3\CMS\Core\Cache\Backend\Typo3DatabaseBackend;
use ‪TYPO3\CMS\Core\Cache\Frontend\FrontendInterface;
use ‪TYPO3\CMS\Core\Database\Connection;
use ‪TYPO3\CMS\Core\Database\ConnectionPool;
use TYPO3\TestingFramework\Core\Functional\FunctionalTestCase;
 
final class ‪Typo3DatabaseBackendTest extends FunctionalTestCase
{
    protected array ‪$configurationToUseInTestInstance = [
        'SYS' => [
            'caching' => [
                'cacheConfigurations' => [
                    // Set pages cache database backend, testing-framework sets this to NullBackend by default.
                    'pages' => [
                        'backend' => 'TYPO3\\CMS\\Core\\Cache\\Backend\\Typo3DatabaseBackend',
                    ],
                ],
            ],
        ],
    ];
 
    #[Test]
    public function ‪getReturnsPreviouslySetEntry(): void
    {
        $frontendMock = $this->createMock(FrontendInterface::class);
        $frontendMock->method('getIdentifier')->willReturn('pages');
 
        $subject = new ‪Typo3DatabaseBackend('Testing');
        $subject->setCache($frontendMock);
 
        $subject->set('myIdentifier', 'myData');
        self::assertSame('myData', $subject->get('myIdentifier'));
    }
 
    #[Test]
    public function ‪getReturnsPreviouslySetEntryWithNewContentIfSetWasCalledMultipleTimes(): void
    {
        $frontendMock = $this->createMock(FrontendInterface::class);
        $frontendMock->method('getIdentifier')->willReturn('pages');
 
        $subject = new ‪Typo3DatabaseBackend('Testing');
        $subject->setCache($frontendMock);
 
        $subject->set('myIdentifier', 'myData');
        $subject->set('myIdentifier', 'myNewData');
        self::assertSame('myNewData', $subject->get('myIdentifier'));
    }
 
    #[Test]
    public function ‪setInsertsDataWithTagsIntoCacheTable(): void
    {
        $frontendMock = $this->createMock(FrontendInterface::class);
        $frontendMock->method('getIdentifier')->willReturn('pages');
 
        $subject = new ‪Typo3DatabaseBackend('Testing');
        $subject->setCache($frontendMock);
 
        $subject->set('myIdentifier', 'myData', ['aTag', 'anotherTag']);
 
        $cacheTableConnection = (new ‪ConnectionPool())->getConnectionForTable('cache_pages');
        $tagsTableConnection = (new ‪ConnectionPool())->getConnectionForTable('cache_pages_tags');
        self::assertSame(1, $cacheTableConnection->count('*', 'cache_pages', ['identifier' => 'myIdentifier']));
        self::assertSame(1, $tagsTableConnection->count('*', 'cache_pages_tags', ['identifier' => 'myIdentifier', 'tag' => 'aTag']));
        self::assertSame(1, $tagsTableConnection->count('*', 'cache_pages_tags', ['identifier' => 'myIdentifier', 'tag' => 'anotherTag']));
    }
 
    #[Test]
    public function ‪setStoresCompressedContent(): void
    {
        $frontendMock = $this->createMock(FrontendInterface::class);
        $frontendMock->method('getIdentifier')->willReturn('pages');
 
        // Have backend with compression enabled
        $subject = new ‪Typo3DatabaseBackend('Testing', ['compression' => true]);
        $subject->setCache($frontendMock);
 
        $subject->set('myIdentifier', 'myCachedContent');
 
        $row = (new ‪ConnectionPool())
            ->getConnectionForTable('cache_pages')
            ->select(
                ['content'],
                'cache_pages',
                ['identifier' => 'myIdentifier']
            )
            ->fetchAssociative();
 
        // Content comes back uncompressed
        self::assertSame('myCachedContent', gzuncompress($row['content']));
    }
 
    #[Test]
    public function ‪getReturnsFalseIfNoCacheEntryExists(): void
    {
        $frontendMock = $this->createMock(FrontendInterface::class);
        $frontendMock->method('getIdentifier')->willReturn('pages');
 
        $subject = new ‪Typo3DatabaseBackend('Testing');
        $subject->setCache($frontendMock);
 
        self::assertFalse($subject->get('myIdentifier'));
    }
 
    #[Test]
    public function ‪getReturnsFalseForExpiredCacheEntry(): void
    {
        $frontendMock = $this->createMock(FrontendInterface::class);
        $frontendMock->method('getIdentifier')->willReturn('pages');
 
        // Push an expired row into db
        (new ‪ConnectionPool())->getConnectionForTable('cache_pages')->insert(
            'cache_pages',
            [
                'identifier' => 'myIdentifier',
                'expires' => ‪$GLOBALS['EXEC_TIME'] - 60,
                'content' => 'myCachedContent',
            ],
            [
                'content' => ‪Connection::PARAM_LOB,
            ]
        );
 
        $subject = new ‪Typo3DatabaseBackend('Testing');
        $subject->setCache($frontendMock);
 
        self::assertFalse($subject->get('myIdentifier'));
    }
 
    #[Test]
    public function ‪getReturnsNotExpiredCacheEntry(): void
    {
        $frontendMock = $this->createMock(FrontendInterface::class);
        $frontendMock->method('getIdentifier')->willReturn('pages');
 
        // Push a row into db
        (new ‪ConnectionPool())->getConnectionForTable('cache_pages')->insert(
            'cache_pages',
            [
                'identifier' => 'myIdentifier',
                'expires' => ‪$GLOBALS['EXEC_TIME'] + 60,
                'content' => 'myCachedContent',
            ],
            [
                'content' => ‪Connection::PARAM_LOB,
            ]
        );
 
        $subject = new ‪Typo3DatabaseBackend('Testing');
        $subject->setCache($frontendMock);
 
        self::assertSame('myCachedContent', $subject->get('myIdentifier'));
    }
 
    #[Test]
    public function ‪getReturnsUnzipsNotExpiredCacheEntry(): void
    {
        $frontendMock = $this->createMock(FrontendInterface::class);
        $frontendMock->method('getIdentifier')->willReturn('pages');
 
        // Push a compressed row into db
        (new ‪ConnectionPool())->getConnectionForTable('cache_pages')->insert(
            'cache_pages',
            [
                'identifier' => 'myIdentifier',
                'expires' => ‪$GLOBALS['EXEC_TIME'] + 60,
                'content' => gzcompress('myCachedContent'),
            ],
            [
                'content' => ‪Connection::PARAM_LOB,
            ]
        );
 
        // Have backend with compression enabled
        $subject = new ‪Typo3DatabaseBackend('Testing', ['compression' => true]);
        $subject->setCache($frontendMock);
 
        // Content comes back uncompressed
        self::assertSame('myCachedContent', $subject->get('myIdentifier'));
    }
 
    #[Test]
    public function ‪getReturnsEmptyStringUnzipped(): void
    {
        $frontendMock = $this->createMock(FrontendInterface::class);
        $frontendMock->method('getIdentifier')->willReturn('pages');
 
        // Push a compressed row into db
        (new ‪ConnectionPool())->getConnectionForTable('cache_pages')->insert(
            'cache_pages',
            [
                'identifier' => 'myIdentifier',
                'expires' => ‪$GLOBALS['EXEC_TIME'] + 60,
                'content' => gzcompress(''),
            ],
            [
                'content' => ‪Connection::PARAM_LOB,
            ]
        );
 
        // Have backend with compression enabled
        $subject = new ‪Typo3DatabaseBackend('Testing', ['compression' => true]);
        $subject->setCache($frontendMock);
 
        // Content comes back uncompressed
        self::assertSame('', $subject->get('myIdentifier'));
    }
 
    #[Test]
    public function ‪hasReturnsFalseIfNoCacheEntryExists(): void
    {
        $frontendMock = $this->createMock(FrontendInterface::class);
        $frontendMock->method('getIdentifier')->willReturn('pages');
 
        $subject = new ‪Typo3DatabaseBackend('Testing');
        $subject->setCache($frontendMock);
 
        self::assertFalse($subject->has('myIdentifier'));
    }
 
    #[Test]
    public function ‪hasReturnsFalseForExpiredCacheEntry(): void
    {
        $frontendMock = $this->createMock(FrontendInterface::class);
        $frontendMock->method('getIdentifier')->willReturn('pages');
 
        // Push an expired row into db
        (new ‪ConnectionPool())->getConnectionForTable('cache_pages')->insert(
            'cache_pages',
            [
                'identifier' => 'myIdentifier',
                'expires' => ‪$GLOBALS['EXEC_TIME'] - 60,
                'content' => 'myCachedContent',
            ],
            [
                'content' => ‪Connection::PARAM_LOB,
            ]
        );
 
        $subject = new ‪Typo3DatabaseBackend('Testing');
        $subject->setCache($frontendMock);
 
        self::assertFalse($subject->has('myIdentifier'));
    }
 
    #[Test]
    public function ‪hasReturnsNotExpiredCacheEntry(): void
    {
        $frontendMock = $this->createMock(FrontendInterface::class);
        $frontendMock->method('getIdentifier')->willReturn('pages');
 
        // Push a row into db
        (new ‪ConnectionPool())->getConnectionForTable('cache_pages')->insert(
            'cache_pages',
            [
                'identifier' => 'myIdentifier',
                'expires' => ‪$GLOBALS['EXEC_TIME'] + 60,
                'content' => 'myCachedContent',
            ],
            [
                'content' => ‪Connection::PARAM_LOB,
            ]
        );
 
        $subject = new ‪Typo3DatabaseBackend('Testing');
        $subject->setCache($frontendMock);
 
        self::assertTrue($subject->has('myIdentifier'));
    }
 
    #[Test]
    public function ‪removeReturnsFalseIfNoEntryHasBeenRemoved(): void
    {
        $frontendMock = $this->createMock(FrontendInterface::class);
        $frontendMock->method('getIdentifier')->willReturn('pages');
 
        $subject = new ‪Typo3DatabaseBackend('Testing');
        $subject->setCache($frontendMock);
 
        self::assertFalse($subject->remove('myIdentifier'));
    }
 
    #[Test]
    public function ‪removeReturnsTrueIfAnEntryHasBeenRemoved(): void
    {
        $frontendMock = $this->createMock(FrontendInterface::class);
        $frontendMock->method('getIdentifier')->willReturn('pages');
 
        // Push a row into db
        (new ‪ConnectionPool())->getConnectionForTable('cache_pages')->insert(
            'cache_pages',
            [
                'identifier' => 'myIdentifier',
                'expires' => ‪$GLOBALS['EXEC_TIME'] + 60,
                'content' => 'myCachedContent',
            ],
            [
                'content' => ‪Connection::PARAM_LOB,
            ]
        );
 
        $subject = new ‪Typo3DatabaseBackend('Testing');
        $subject->setCache($frontendMock);
 
        self::assertTrue($subject->remove('myIdentifier'));
    }
 
    #[Test]
    public function ‪removeRemovesCorrectEntriesFromDatabase(): void
    {
        $frontendMock = $this->createMock(FrontendInterface::class);
        $frontendMock->method('getIdentifier')->willReturn('pages');
 
        // Add one cache row to remove and another one that shouldn't be removed
        $cacheTableConnection = (new ‪ConnectionPool())->getConnectionForTable('cache_pages');
        $cacheTableConnection->bulkInsert(
            'cache_pages',
            [
                ['myIdentifier', ‪$GLOBALS['EXEC_TIME'] + 60, 'myCachedContent'],
                ['otherIdentifier', ‪$GLOBALS['EXEC_TIME'] + 60, 'otherCachedContent'],
            ],
            ['identifier', 'expires', 'content'],
            [
                'identifier' => ‪Connection::PARAM_STR,
                'expires' => ‪Connection::PARAM_INT,
                'content' => ‪Connection::PARAM_LOB,
            ]
        );
        $subject = new ‪Typo3DatabaseBackend('Testing');
        $subject->setCache($frontendMock);
 
        // Add a couple of tags
        $tagsTableConnection = (new ‪ConnectionPool())->getConnectionForTable('cache_pages_tags');
        $tagsTableConnection->bulkInsert(
            'cache_pages_tags',
            [
                ['myIdentifier', 'aTag'],
                ['myIdentifier', 'otherTag'],
                ['otherIdentifier', 'aTag'],
                ['otherIdentifier', 'otherTag'],
            ],
            ['identifier', 'tag'],
            [
                'identifier' => ‪Connection::PARAM_STR,
                'tag' => ‪Connection::PARAM_STR,
            ]
        );
 
        $subject->remove('myIdentifier');
 
        // cache row with removed identifier has been removed, other one exists
        self::assertSame(0, $cacheTableConnection->count('*', 'cache_pages', ['identifier' => 'myIdentifier']));
        self::assertSame(1, $cacheTableConnection->count('*', 'cache_pages', ['identifier' => 'otherIdentifier']));
 
        // tags of myIdentifier should have been removed, others exist
        self::assertSame(0, $tagsTableConnection->count('*', 'cache_pages_tags', ['identifier' => 'myIdentifier']));
        self::assertSame(2, $tagsTableConnection->count('*', 'cache_pages_tags', ['identifier' => 'otherIdentifier']));
    }
 
    #[Test]
    public function ‪findIdentifiersByTagReturnsIdentifierTaggedWithGivenTag(): void
    {
        $subject = $this->‪getSubjectObject();
 
        self::assertEquals(['idA' => 'idA'], $subject->findIdentifiersByTag('tagA'));
        self::assertEquals(['idA' => 'idA', 'idB' => 'idB'], $subject->findIdentifiersByTag('tagB'));
        self::assertEquals(['idB' => 'idB', 'idC' => 'idC'], $subject->findIdentifiersByTag('tagC'));
    }
 
    #[Test]
    public function ‪flushByTagWorksWithEmptyCacheTables(): void
    {
        $subject = $this->‪getSubjectObject();
        $subject->flushByTag('tagB');
    }
 
    #[Test]
    public function ‪flushByTagsWorksWithEmptyCacheTables(): void
    {
        $subject = $this->‪getSubjectObject();
        $subject->flushByTags(['tagB']);
    }
 
    #[Test]
    public function ‪flushByTagRemovesCorrectRowsFromDatabase(): void
    {
        $subject = $this->‪getSubjectObject();
        $subject->flushByTag('tagB');
 
        $cacheTableConnection = (new ‪ConnectionPool())->getConnectionForTable('cache_pages');
        self::assertSame(0, $cacheTableConnection->count('*', 'cache_pages', ['identifier' => 'idA']));
        self::assertSame(0, $cacheTableConnection->count('*', 'cache_pages', ['identifier' => 'idB']));
        self::assertSame(1, $cacheTableConnection->count('*', 'cache_pages', ['identifier' => 'idC']));
        $tagsTableConnection = (new ‪ConnectionPool())->getConnectionForTable('cache_pages_tags');
        self::assertSame(0, $tagsTableConnection->count('*', 'cache_pages_tags', ['identifier' => 'idA']));
        self::assertSame(0, $tagsTableConnection->count('*', 'cache_pages_tags', ['identifier' => 'idB']));
        self::assertSame(2, $tagsTableConnection->count('*', 'cache_pages_tags', ['identifier' => 'idC']));
    }
 
    #[Test]
    public function ‪flushByTagsRemovesCorrectRowsFromDatabase(): void
    {
        $subject = $this->‪getSubjectObject();
        $subject->flushByTags(['tagC', 'tagD']);
 
        $cacheTableConnection = (new ‪ConnectionPool())->getConnectionForTable('cache_pages');
        self::assertSame(1, $cacheTableConnection->count('*', 'cache_pages', ['identifier' => 'idA']));
        self::assertSame(0, $cacheTableConnection->count('*', 'cache_pages', ['identifier' => 'idB']));
        self::assertSame(0, $cacheTableConnection->count('*', 'cache_pages', ['identifier' => 'idC']));
        $tagsTableConnection = (new ‪ConnectionPool())->getConnectionForTable('cache_pages_tags');
        self::assertSame(2, $tagsTableConnection->count('*', 'cache_pages_tags', ['identifier' => 'idA']));
        self::assertSame(0, $tagsTableConnection->count('*', 'cache_pages_tags', ['identifier' => 'idB']));
        self::assertSame(0, $tagsTableConnection->count('*', 'cache_pages_tags', ['identifier' => 'idC']));
    }
 
    #[Test]
    public function ‪collectGarbageWorksWithEmptyTable(): void
    {
        $subject = $this->‪getSubjectObject();
        $subject->collectGarbage();
    }
 
    #[Test]
    public function ‪collectGarbageRemovesCacheEntryWithExpiredLifetime(): void
    {
        $frontendMock = $this->createMock(FrontendInterface::class);
        $frontendMock->method('getIdentifier')->willReturn('pages');
 
        $subject = new ‪Typo3DatabaseBackend('Testing');
        $subject->setCache($frontendMock);
 
        // idA should be expired after EXEC_TIME manipulation, idB should stay
        $subject->set('idA', 'dataA', [], 60);
        $subject->set('idB', 'dataB', [], 240);
 
        ‪$GLOBALS['EXEC_TIME'] = ‪$GLOBALS['EXEC_TIME'] + 120;
 
        $subject->collectGarbage();
 
        $cacheTableConnection = (new ‪ConnectionPool())->getConnectionForTable('cache_pages');
        self::assertSame(0, $cacheTableConnection->count('*', 'cache_pages', ['identifier' => 'idA']));
        self::assertSame(1, $cacheTableConnection->count('*', 'cache_pages', ['identifier' => 'idB']));
    }
 
    #[Test]
    public function ‪collectGarbageRemovesTagEntriesForCacheEntriesWithExpiredLifetime(): void
    {
        $frontendMock = $this->createMock(FrontendInterface::class);
        $frontendMock->method('getIdentifier')->willReturn('pages');
 
        $subject = new ‪Typo3DatabaseBackend('Testing');
        $subject->setCache($frontendMock);
 
        // tag rows tagA and tagB should be removed by garbage collector after EXEC_TIME manipulation
        $subject->set('idA', 'dataA', ['tagA', 'tagB'], 60);
        $subject->set('idB', 'dataB', ['tagB', 'tagC'], 240);
 
        ‪$GLOBALS['EXEC_TIME'] = ‪$GLOBALS['EXEC_TIME'] + 120;
 
        $subject->collectGarbage();
 
        $tagsTableConnection = (new ‪ConnectionPool())->getConnectionForTable('cache_pages_tags');
        self::assertSame(0, $tagsTableConnection->count('*', 'cache_pages_tags', ['identifier' => 'idA']));
        self::assertSame(2, $tagsTableConnection->count('*', 'cache_pages_tags', ['identifier' => 'idB']));
    }
 
    #[Test]
    public function ‪collectGarbageRemovesOrphanedTagEntriesFromTagsTable(): void
    {
        $frontendMock = $this->createMock(FrontendInterface::class);
        $frontendMock->method('getIdentifier')->willReturn('pages');
 
        $subject = new ‪Typo3DatabaseBackend('Testing');
        $subject->setCache($frontendMock);
 
        // tag rows tagA and tagB should be removed by garbage collector after EXEC_TIME manipulation
        $subject->set('idA', 'dataA', ['tagA', 'tagB'], 60);
        $subject->set('idB', 'dataB', ['tagB', 'tagC'], 240);
 
        $tagsTableConnection = (new ‪ConnectionPool())->getConnectionForTable('cache_pages_tags');
 
        // Push two orphaned tag row into db - tags that have no related cache record anymore for whatever reason
        $tagsTableConnection->insert(
            'cache_pages_tags',
            [
                'identifier' => 'idC',
                'tag' => 'tagC',
            ]
        );
        $tagsTableConnection->insert(
            'cache_pages_tags',
            [
                'identifier' => 'idC',
                'tag' => 'tagD',
            ]
        );
 
        ‪$GLOBALS['EXEC_TIME'] = ‪$GLOBALS['EXEC_TIME'] + 120;
 
        $subject->collectGarbage();
 
        self::assertSame(0, $tagsTableConnection->count('*', 'cache_pages_tags', ['identifier' => 'idA']));
        self::assertSame(2, $tagsTableConnection->count('*', 'cache_pages_tags', ['identifier' => 'idB']));
        self::assertSame(0, $tagsTableConnection->count('*', 'cache_pages_tags', ['identifier' => 'idC']));
    }
 
    #[Test]
    public function ‪flushLeavesCacheAndTagsTableEmpty(): void
    {
        $frontendMock = $this->createMock(FrontendInterface::class);
        $frontendMock->method('getIdentifier')->willReturn('pages');
 
        $subject = new ‪Typo3DatabaseBackend('Testing');
        $subject->setCache($frontendMock);
 
        $subject->set('idA', 'dataA', ['tagA', 'tagB']);
 
        $subject->flush();
 
        $cacheTableConnection = (new ‪ConnectionPool())->getConnectionForTable('cache_pages');
        $tagsTableConnection = (new ‪ConnectionPool())->getConnectionForTable('cache_pages_tags');
        self::assertSame(0, $cacheTableConnection->count('*', 'cache_pages', []));
        self::assertSame(0, $tagsTableConnection->count('*', 'cache_pages_tags', []));
    }
 
    protected function ‪getSubjectObject(): ‪Typo3DatabaseBackend
    {
        $frontendMock = $this->createMock(FrontendInterface::class);
        $frontendMock->method('getIdentifier')->willReturn('pages');
 
        $subject = new ‪Typo3DatabaseBackend('Testing');
        $subject->setCache($frontendMock);
 
        $subject->set('idA', 'dataA', ['tagA', 'tagB']);
        $subject->set('idB', 'dataB', ['tagB', 'tagC']);
        $subject->set('idC', 'dataC', ['tagC', 'tagD']);
 
        return $subject;
    }
}