TranslationTest.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\Extbase\Tests\Functional\Persistence;
 
use ‪ExtbaseTeam\BlogExample\Domain\Model\Post;
use ‪ExtbaseTeam\BlogExample\Domain\Repository\PostRepository;
use PHPUnit\Framework\MockObject\MockObject;
use ‪TYPO3\CMS\Core\Context\Context;
use ‪TYPO3\CMS\Core\Context\LanguageAspect;
use ‪TYPO3\CMS\Core\Domain\Repository\PageRepository;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
use ‪TYPO3\CMS\Extbase\Object\ObjectManager;
use ‪TYPO3\CMS\Extbase\Persistence\QueryInterface;
use ‪TYPO3\CMS\Extbase\Service\EnvironmentService;
use ‪TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController;
use TYPO3\TestingFramework\Core\Functional\FunctionalTestCase;
 
class ‪TranslationTest extends FunctionalTestCase
{
    protected ‪$testExtensionsToLoad = ['typo3/sysext/extbase/Tests/Functional/Fixtures/Extensions/blog_example'];
 
    protected ‪$coreExtensionsToLoad = ['extbase', 'fluid'];
 
    protected ‪$objectManager;
 
    protected ‪$postRepository;
 
    protected function ‪setUp(): void
    {
        parent::setUp();
        /*
         * Posts Dataset for the tests:
         *
         * Post1
         *   -> EN: Post1
         *   -> GR: Post1
         * Post2
         *   -> EN: Post2
         * Post3
         * Post10 [hidden]
         *   -> GR: Post10 [hidden]
         */
        $this->importDataSet('PACKAGE:typo3/testing-framework/Resources/Core/Functional/Fixtures/pages.xml');
        $this->importDataSet(ORIGINAL_ROOT . 'typo3/sysext/extbase/Tests/Functional/Persistence/Fixtures/blogs.xml');
        $this->importDataSet(ORIGINAL_ROOT . 'typo3/sysext/extbase/Tests/Functional/Persistence/Fixtures/translated-posts.xml');
        $this->importDataSet(ORIGINAL_ROOT . 'typo3/sysext/extbase/Tests/Functional/Persistence/Fixtures/post-tag-mm.xml');
        $this->importDataSet(ORIGINAL_ROOT . 'typo3/sysext/extbase/Tests/Functional/Persistence/Fixtures/tags.xml');
 
        $this->‪setUpBasicFrontendEnvironment();
 
        $this->objectManager = GeneralUtility::makeInstance(ObjectManager::class);
        $this->postRepository = $this->objectManager->get(PostRepository::class);
    }
 
    protected function ‪setUpBasicFrontendEnvironment()
    {
        // in v9 overlay and language mode has different default values, so we need to set them here explicitly
        // to match v8 behaviour
        $context = GeneralUtility::makeInstance(Context::class);
        $context->setAspect('language', new ‪LanguageAspect(0, 0, ‪LanguageAspect::OVERLAYS_OFF, ['off']));
 
        $environmentServiceMock = $this->createMock(EnvironmentService::class);
        $environmentServiceMock
            ->expects(self::atLeast(1))
            ->method('isEnvironmentInFrontendMode')
            ->willReturn(true);
        GeneralUtility::setSingletonInstance(EnvironmentService::class, $environmentServiceMock);
 
        $pageRepositoryFixture = new ‪PageRepository();
        $frontendControllerMock = $this->createMock(TypoScriptFrontendController::class);
        $frontendControllerMock->sys_page = $pageRepositoryFixture;
        ‪$GLOBALS['TSFE'] = $frontendControllerMock;
    }
 
    public function ‪countReturnsCorrectNumberOfPosts()
    {
        $query = $this->postRepository->createQuery();
 
        $querySettings = $query->getQuerySettings();
        $querySettings->setStoragePageIds([1]);
        $querySettings->setRespectSysLanguage(true);
        $querySettings->setLanguageUid(0);
 
        self::assertFalse($querySettings->getLanguageOverlayMode());
 
        $postCount = $query->execute()->count();
        self::assertSame(4, $postCount);
    }
 
    public function ‪countReturnsCorrectNumberOfPostsInEnglishLanguageForStrictMode()
    {
        $query = $this->postRepository->createQuery();
 
        $querySettings = $query->getQuerySettings();
        $querySettings->setStoragePageIds([1]);
        $querySettings->setRespectSysLanguage(true);
        $querySettings->setLanguageUid(1);
        self::assertFalse($querySettings->getLanguageOverlayMode());
 
        $postCount = $query->execute()->count();
        self::assertSame(2, $postCount);
    }
 
    public function ‪countReturnsCorrectNumberOfPostsInEnglishLanguage()
    {
        $query = $this->postRepository->createQuery();
 
        $querySettings = $query->getQuerySettings();
        $querySettings->setStoragePageIds([1]);
        $querySettings->setRespectSysLanguage(true);
        $querySettings->setLanguageUid(1);
 
        self::assertFalse($querySettings->getLanguageOverlayMode());
 
        $postCount = $query->execute()->count();
        self::assertSame(2, $postCount);
    }
 
    public function ‪countReturnsCorrectNumberOfPostsInGreekLanguage()
    {
        $query = $this->postRepository->createQuery();
 
        $querySettings = $query->getQuerySettings();
        $querySettings->setStoragePageIds([1]);
        $querySettings->setRespectSysLanguage(true);
        $querySettings->setLanguageUid(2);
        self::assertFalse($querySettings->getLanguageOverlayMode());
 
        $postCount = $query->execute()->count();
 
        self::assertSame(2, $postCount);
    }
 
    public function ‪fetchingPostsReturnsEnglishPostsWithFallback()
    {
        $query = $this->postRepository->createQuery();
 
        $querySettings = $query->getQuerySettings();
        $querySettings->setStoragePageIds([1]);
        $querySettings->setRespectSysLanguage(true);
        $querySettings->setLanguageUid(1);
        self::assertFalse($querySettings->getLanguageOverlayMode());
 
        $query->setOrderings(['title' => ‪QueryInterface::ORDER_ASCENDING]);
 
        $posts = $query->execute()->toArray();
 
        self::assertCount(2, $posts);
        self::assertSame('A EN:Post2', $posts[0]->getTitle());
        self::assertSame('B EN:Post1', $posts[1]->getTitle());
    }
 
    public function ‪fetchingPostsByInClauseReturnsDefaultPostsWithFallback(): void
    {
        $query = $this->postRepository->createQuery();
        $querySettings = $query->getQuerySettings();
        $querySettings->setStoragePageIds([1]);
        $querySettings->setRespectSysLanguage(false);
        $querySettings->setLanguageOverlayMode(true);
        $querySettings->setLanguageUid(2);
 
        $query->matching($query->in('uid', [4]));
        $posts = $query->execute()->toArray();
 
        self::assertCount(1, $posts);
        self::assertSame('Post2', $posts[0]->getTitle());
    }
 
    public function ‪fetchingPostsReturnsGreekPostsWithFallback()
    {
        $query = $this->postRepository->createQuery();
 
        $querySettings = $query->getQuerySettings();
        $querySettings->setStoragePageIds([1]);
        $querySettings->setRespectSysLanguage(true);
        $querySettings->setLanguageUid(2);
        self::assertFalse($querySettings->getLanguageOverlayMode());
 
        $query->setOrderings(['title' => ‪QueryInterface::ORDER_ASCENDING]);
 
        $posts = $query->execute()->toArray();
 
        self::assertCount(2, $posts);
        self::assertSame('GR:Post1', $posts[0]->getTitle());
        self::assertSame('GR:Post11', $posts[1]->getTitle());
    }
 
    public function ‪fetchingPostsReturnsGreekPostsWithHideNonTranslated()
    {
        $query = $this->postRepository->createQuery();
 
        $querySettings = $query->getQuerySettings();
        $querySettings->setStoragePageIds([1]);
        $querySettings->setRespectSysLanguage(true);
        $querySettings->setLanguageUid(2);
        $querySettings->setLanguageOverlayMode('hideNonTranslated');
 
        $query->setOrderings(['title' => ‪QueryInterface::ORDER_ASCENDING]);
 
        $posts = $query->execute()->toArray();
 
        self::assertCount(2, $posts);
        self::assertSame('GR:Post1', $posts[0]->getTitle());
        self::assertSame('GR:Post11', $posts[1]->getTitle());
    }
 
    public function ‪fetchingTranslatedPostByUidDataProvider(): array
    {
        return [
            'with one id' => [
                'input' => [12],
                'expectedTitles' => ['GR:Post11'],
            ],
            'with two ids' => [
                'input' => [12, 1],
                'expectedTitles' => ['GR:Post11', 'GR:Post1'],
            ],
        ];
    }
 
    public function ‪fetchingTranslatedPostByInClauseWithStrictLanguageSettings(array $input, array $expectedTitles): void
    {
        $query = $this->postRepository->createQuery();
        $querySettings = $query->getQuerySettings();
        $querySettings->setStoragePageIds([1]);
        $querySettings->setRespectSysLanguage(true);
        $querySettings->setLanguageUid(2);
        $querySettings->setLanguageOverlayMode('hideNonTranslated');
 
        $query->matching($query->in('uid', $input));
        $posts = $query->execute()->toArray();
 
        // @todo: wrong assertion
        // We're simulating a strict language configuration where a blog post (uid=12 or uid=1) has been translated to another
        // language. However, Extbase is not able to find the translated record via ->in() and therefore returns an
        // empty result set. This will be fixed with https://review.typo3.org/c/Packages/TYPO3.CMS/+/67893
        self::assertCount(0, $posts);
        // self::assertCount(count($expectedTitles), $posts);
        // self::assertEqualsCanonicalizing($expectedTitles, array_map(static function(Post $post) { return $post->getTitle(); }, $posts));
    }
 
    public function ‪fetchingTranslatedPostByEqualsUidClauseWithStrictLanguageSettings(array $input, array $expectedTitles): void
    {
        $query = $this->postRepository->createQuery();
        $querySettings = $query->getQuerySettings();
        $querySettings->setStoragePageIds([1]);
        $querySettings->setRespectSysLanguage(true);
        $querySettings->setLanguageUid(2);
        $querySettings->setLanguageOverlayMode('hideNonTranslated');
 
        $constraints = [];
        foreach ($input as $uid) {
            $constraints[] = $query->equals('uid', $uid);
        }
        $query->matching($query->logicalOr(...$constraints));
        $posts = $query->execute()->toArray();
 
        // @todo: wrong assertion
        // We're simulating a strict language configuration where a blog post (uid=12 or uid=1) has been translated to another
        // language. However, Extbase is not able to find the translated record via ->equals(uid=12 OR uid=1 OR ...) and therefore returns an
        // empty result set. This will be fixed with https://review.typo3.org/c/Packages/TYPO3.CMS/+/67893
        self::assertCount(0, $posts);
        // self::assertCount(count($expectedTitles), $posts);
        // self::assertEqualsCanonicalizing($expectedTitles, array_map(static function(Post $post) { return $post->getTitle(); }, $posts));
    }
 
    public function ‪orderingByTitleRespectsEnglishTitles()
    {
        $query = $this->postRepository->createQuery();
 
        $querySettings = $query->getQuerySettings();
        $querySettings->setStoragePageIds([1]);
        $querySettings->setRespectSysLanguage(true);
        $querySettings->setLanguageUid(1);
        self::assertFalse($querySettings->getLanguageOverlayMode());
 
        $query->setOrderings(['title' => ‪QueryInterface::ORDER_ASCENDING]);
 
        $posts = $query->execute()->toArray();
 
        self::assertCount(2, $posts);
        self::assertSame('A EN:Post2', $posts[0]->getTitle());
        self::assertSame('B EN:Post1', $posts[1]->getTitle());
    }
 
    public function ‪orderingByBlogTitle()
    {
        $query = $this->postRepository->createQuery();
 
        $querySettings = $query->getQuerySettings();
        $querySettings->setStoragePageIds([1]);
        $querySettings->setRespectSysLanguage(true);
        $querySettings->setLanguageUid(1);
        self::assertFalse($querySettings->getLanguageOverlayMode());
 
        $query->setOrderings([
            'blog.title' => ‪QueryInterface::ORDER_ASCENDING,
            'uid' => ‪QueryInterface::ORDER_ASCENDING
        ]);
 
        $posts = $query->execute()->toArray();
 
        self::assertCount(2, $posts);
        self::assertSame('B EN:Post1', $posts[0]->getTitle());
        self::assertSame('A EN:Post2', $posts[1]->getTitle());
    }
 
    public function ‪fetchingHiddenPostsWithIgnoreEnableField()
    {
        $query = $this->postRepository->createQuery();
 
        $querySettings = $query->getQuerySettings();
        $querySettings->setStoragePageIds([1]);
        $querySettings->setRespectSysLanguage(true);
        $querySettings->setIgnoreEnableFields(true);
        $querySettings->setLanguageUid(0);
        //we need it to have stable results on pgsql
        $query->setOrderings(['uid' => ‪QueryInterface::ORDER_ASCENDING]);
 
        $posts = $query->execute()->toArray();
 
        self::assertCount(5, $posts);
        self::assertSame('Post10', $posts[3]->getTitle());
    }
 
    public function ‪fetchingHiddenPostsReturnsHiddenOverlay()
    {
        $query = $this->postRepository->createQuery();
 
        $querySettings = $query->getQuerySettings();
        $querySettings->setStoragePageIds([1]);
        $querySettings->setRespectSysLanguage(true);
        $querySettings->setIgnoreEnableFields(true);
        $querySettings->setLanguageUid(2);
        self::assertFalse($querySettings->getLanguageOverlayMode());
        //we need it to have stable results on pgsql
        $query->setOrderings(['uid' => ‪QueryInterface::ORDER_ASCENDING]);
 
        $posts = $query->execute()->toArray();
 
        self::assertCount(3, $posts);
 
        self::assertSame('GR:Post1', $posts[0]->getTitle());
        self::assertSame('GR:Post10', $posts[1]->getTitle());
        self::assertSame('GR:Post11', $posts[2]->getTitle());
    }
 
    public function ‪fetchingHiddenPostsReturnsHiddenOverlayOverlayEnabled()
    {
        $query = $this->postRepository->createQuery();
 
        $querySettings = $query->getQuerySettings();
        $querySettings->setStoragePageIds([1]);
        $querySettings->setRespectSysLanguage(true);
        $querySettings->setIgnoreEnableFields(true);
        $querySettings->setLanguageUid(2);
        $querySettings->setLanguageOverlayMode(true);
        //we need it to have stable results on pgsql
        $query->setOrderings(['uid' => ‪QueryInterface::ORDER_ASCENDING]);
 
        $posts = $query->execute()->toArray();
 
        self::assertCount(5, $posts);
 
        self::assertSame('GR:Post1', $posts[0]->getTitle());
        self::assertSame('Post2', $posts[1]->getTitle());
        self::assertSame('Post3', $posts[2]->getTitle());
        // once the issue is fixed this assertions should be GR:Post10
        self::assertSame('Post10', $posts[3]->getTitle());
        self::assertSame('GR:Post11', $posts[4]->getTitle());
    }
 
    public function ‪fetchingTranslatedPostByTitle()
    {
        $query = $this->postRepository->createQuery();
        $querySettings = $query->getQuerySettings();
        $querySettings->setStoragePageIds([1]);
        $querySettings->setRespectSysLanguage(true);
        $querySettings->setLanguageUid(2);
        self::assertFalse($querySettings->getLanguageOverlayMode());
 
        $query->setOrderings(['title' => ‪QueryInterface::ORDER_ASCENDING]);
        $query->matching($query->equals('title', 'GR:Post1'));
        $posts = $query->execute()->toArray();
        self::assertCount(1, $posts);
        self::assertSame('GR:Post1', $posts[0]->getTitle());
    }
 
    public function ‪fetchingTranslatedPostByBlogTitle()
    {
        $query = $this->postRepository->createQuery();
        $querySettings = $query->getQuerySettings();
        $querySettings->setStoragePageIds([1]);
        $querySettings->setRespectSysLanguage(true);
        $querySettings->setLanguageUid(2);
        self::assertFalse($querySettings->getLanguageOverlayMode());
 
        $query->setOrderings(['title' => ‪QueryInterface::ORDER_ASCENDING]);
        $query->matching($query->equals('blog.title', 'Blog1'));
        $posts = $query->execute()->toArray();
        self::assertCount(2, $posts);
        self::assertSame('GR:Post1', $posts[0]->getTitle());
        self::assertSame('GR:Post11', $posts[1]->getTitle());
    }
 
    public function ‪fetchingPostByTagName()
    {
        $query = $this->postRepository->createQuery();
        $querySettings = $query->getQuerySettings();
        $querySettings->setRespectStoragePage(false);
        $querySettings->setRespectSysLanguage(true);
        $querySettings->setLanguageUid(0);
        self::assertFalse($querySettings->getLanguageOverlayMode());
 
        $query->setOrderings(['title' => ‪QueryInterface::ORDER_ASCENDING]);
        $query->matching($query->equals('tags.name', 'Tag1'));
        $posts = $query->execute()->toArray();
        self::assertCount(3, $posts);
        self::assertSame('Post1', $posts[0]->getTitle());
    }
 
    public function ‪fetchingTranslatedPostByTagName()
    {
        $query = $this->postRepository->createQuery();
        $querySettings = $query->getQuerySettings();
        $querySettings->setRespectStoragePage(false);
        $querySettings->setRespectSysLanguage(true);
        $querySettings->setLanguageUid(1);
        self::assertFalse($querySettings->getLanguageOverlayMode());
 
        $query->setOrderings(['title' => ‪QueryInterface::ORDER_ASCENDING]);
        $query->matching($query->equals('tags.name', 'Tag1'));
        $posts = $query->execute()->toArray();
        self::assertCount(2, $posts);
        self::assertSame('A EN:Post2', $posts[0]->getTitle());
        self::assertSame(1, count($posts[0]->getTags()));
        self::assertSame('B EN:Post1', $posts[1]->getTitle());
        self::assertSame(2, count($posts[1]->getTags()));
    }
}