TypoScriptFrontendControllerTest.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\Frontend\Tests\Functional\Controller;
 
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\Attributes\Test;
use ‪TYPO3\CMS\Core\Cache\Backend\Typo3DatabaseBackend;
use ‪TYPO3\CMS\Core\Tests\Functional\SiteHandling\SiteBasedTestTrait;
use ‪TYPO3\CMS\Frontend\Cache\CacheInstruction;
use TYPO3\TestingFramework\Core\Functional\Framework\Frontend\Internal\TypoScriptInstruction;
use TYPO3\TestingFramework\Core\Functional\Framework\Frontend\InternalRequest;
use TYPO3\TestingFramework\Core\Functional\FunctionalTestCase;
 
final class ‪TypoScriptFrontendControllerTest extends FunctionalTestCase
{
    use ‪SiteBasedTestTrait;
 
    protected const ‪LANGUAGE_PRESETS = [
        'EN' => ['id' => 0, 'title' => 'English', 'locale' => 'en_US.UTF8'],
    ];
 
    protected array ‪$configurationToUseInTestInstance = [
        'SYS' => [
            'caching' => [
                'cacheConfigurations' => [
                    'pages' => [
                        // Test headerAndFooterMarkersAreReplacedDuringIntProcessing() relies on persisted page cache:
                        // It calls FE rendering twice to verify USER_INT stuff is called for page-cache-exists-but-has-INT.
                        // testing-framework usually sets these to NullBackend which would defeat this case.
                        'backend' => Typo3DatabaseBackend::class,
                    ],
                ],
            ],
        ],
    ];
 
    #[Test]
    public function ‪headerAndFooterMarkersAreReplacedDuringIntProcessing(): void
    {
        $this->importCSVDataSet(__DIR__ . '/DataSet/LiveDefaultPages.csv');
        $this->setUpFrontendRootPage(
            2,
            ['EXT:frontend/Tests/Functional/Controller/Fixtures/PageWithUserInt.typoscript']
        );
        $this->‪writeSiteConfiguration(
            'test',
            $this->‪buildSiteConfiguration(2, 'https://website.local/'),
            [$this->‪buildDefaultLanguageConfiguration('EN', '/en/')]
        );
 
        // Call page first time to trigger page cache with result
        $response = $this->executeFrontendSubRequest((new InternalRequest('https://website.local/en/'))->withPageId(88));
        $body = (string)$response->getBody();
        self::assertStringContainsString('userIntContent', $body);
        self::assertStringContainsString('headerDataFromUserInt', $body);
        self::assertStringContainsString('footerDataFromUserInt', $body);
 
        // Call page second time to see if it works with page cache and user_int is still executed.
        $response = $this->executeFrontendSubRequest((new InternalRequest('https://website.local/en/'))->withPageId(88));
        $body = (string)$response->getBody();
        self::assertStringContainsString('userIntContent', $body);
        self::assertStringContainsString('headerDataFromUserInt', $body);
        self::assertStringContainsString('footerDataFromUserInt', $body);
    }
 
    #[Test]
    public function ‪jsIncludesWithUserIntIsRendered(): void
    {
        $this->importCSVDataSet(__DIR__ . '/DataSet/LiveDefaultPages.csv');
        $this->setUpFrontendRootPage(2);
        $this->‪writeSiteConfiguration(
            'test',
            $this->‪buildSiteConfiguration(2, 'https://website.local/'),
            [$this->‪buildDefaultLanguageConfiguration('EN', '/en/')]
        );
 
        $response = $this->executeFrontendSubRequest(
            (new InternalRequest('https://website.local/en/'))
                ->withPageId(2)
                ->withInstructions([
                    (new TypoScriptInstruction())
                        ->withTypoScript([
                            'page' => 'PAGE',
                            'page.' => [
                                'jsInline.' => [
                                    '10' => 'COA_INT',
                                    '10.' => [
                                        '10' => 'TEXT',
                                        '10.' => [
                                            'value' => 'alert(yes);',
                                        ],
                                    ],
                                ],
                            ],
                        ]),
                ]),
        );
 
        $body = (string)$response->getBody();
        self::assertStringContainsString('/*TS_inlineJSint*/
alert(yes);', $body);
    }
 
    #[Test]
    public function ‪localizationReturnsUnchangedStringIfNotLocallangLabel(): void
    {
        $this->importCSVDataSet(__DIR__ . '/DataSet/LiveDefaultPages.csv');
        $this->setUpFrontendRootPage(
            2,
            ['EXT:frontend/Tests/Functional/Controller/Fixtures/PageWithUserObjectUsingSlWithoutLLL.typoscript']
        );
        $this->‪writeSiteConfiguration(
            'test',
            $this->‪buildSiteConfiguration(2, 'https://website.local/'),
            [$this->‪buildDefaultLanguageConfiguration('EN', '/en/')]
        );
 
        $response = $this->executeFrontendSubRequest((new InternalRequest('https://website.local/en/'))->withPageId(88));
        $body = (string)$response->getBody();
        self::assertStringContainsString('notprefixedWithLLL', $body);
    }
 
    #[Test]
    public function ‪localizationReturnsLocalizedStringWithLocallangLabel(): void
    {
        $this->importCSVDataSet(__DIR__ . '/DataSet/LiveDefaultPages.csv');
        $this->setUpFrontendRootPage(
            2,
            ['EXT:frontend/Tests/Functional/Controller/Fixtures/PageWithUserObjectUsingSlWithLLL.typoscript']
        );
        $this->‪writeSiteConfiguration(
            'test',
            $this->‪buildSiteConfiguration(2, 'https://website.local/'),
            [$this->‪buildDefaultLanguageConfiguration('EN', '/en/')]
        );
 
        $response = $this->executeFrontendSubRequest((new InternalRequest('https://website.local/en/'))->withPageId(88));
        $body = (string)$response->getBody();
        self::assertStringContainsString('Pagetree Overview', $body);
    }
 
    public static function ‪getFromCacheSetsConfigRootlineToLocalRootlineDataProvider(): array
    {
        $page1 = [
            'pid' => 0,
            'uid' => 1,
            't3ver_oid' => 0,
            't3ver_wsid' => 0,
            't3ver_state' => 0,
            'title' => 'Pre page without template',
            'nav_title' => '',
            'media' => '',
            'layout' => 0,
            'hidden' => 0,
            'starttime' => 0,
            'endtime' => 0,
            'fe_group' => '0',
            'extendToSubpages' => 0,
            'doktype' => 1,
            'TSconfig' => null,
            'tsconfig_includes' => '',
            'is_siteroot' => 0,
            'mount_pid' => 0,
            'mount_pid_ol' => 0,
            'backend_layout_next_level' => '',
        ];
        $page2 = [
            'pid' => 1,
            'uid' => 2,
            't3ver_oid' => 0,
            't3ver_wsid' => 0,
            't3ver_state' => 0,
            'title' => 'Root page having template with root flag set by tests',
            'nav_title' => '',
            'media' => '',
            'layout' => 0,
            'hidden' => 0,
            'starttime' => 0,
            'endtime' => 0,
            'fe_group' => '0',
            'extendToSubpages' => 0,
            'doktype' => 1,
            'TSconfig' => null,
            'tsconfig_includes' => '',
            'is_siteroot' => 1,
            'mount_pid' => 0,
            'mount_pid_ol' => 0,
            'backend_layout_next_level' => '',
        ];
        $page88 = [
            'pid' => 2,
            'uid' => 88,
            't3ver_oid' => 0,
            't3ver_wsid' => 0,
            't3ver_state' => 0,
            'title' => 'Sub page 1',
            'nav_title' => '',
            'media' => '',
            'layout' => 0,
            'hidden' => 0,
            'starttime' => 0,
            'endtime' => 0,
            'fe_group' => '0',
            'extendToSubpages' => 0,
            'doktype' => 1,
            'TSconfig' => null,
            'tsconfig_includes' => '',
            'is_siteroot' => 0,
            'mount_pid' => 0,
            'mount_pid_ol' => 0,
            'backend_layout_next_level' => '',
        ];
        $page89 = [
            'pid' => 88,
            'uid' => 89,
            't3ver_oid' => 0,
            't3ver_wsid' => 0,
            't3ver_state' => 0,
            'title' => 'Sub sub page 1',
            'nav_title' => '',
            'media' => '',
            'layout' => 0,
            'hidden' => 0,
            'starttime' => 0,
            'endtime' => 0,
            'fe_group' => '0',
            'extendToSubpages' => 0,
            'doktype' => 1,
            'TSconfig' => null,
            'tsconfig_includes' => '',
            'is_siteroot' => 0,
            'mount_pid' => 0,
            'mount_pid_ol' => 0,
            'backend_layout_next_level' => '',
        ];
        $page98 = [
            'pid' => 2,
            'uid' => 98,
            't3ver_oid' => 0,
            't3ver_wsid' => 0,
            't3ver_state' => 0,
            'title' => 'Sub page 2 having template with root flag',
            'nav_title' => '',
            'media' => '',
            'layout' => 0,
            'hidden' => 0,
            'starttime' => 0,
            'endtime' => 0,
            'fe_group' => '0',
            'extendToSubpages' => 0,
            'doktype' => 1,
            'TSconfig' => null,
            'tsconfig_includes' => '',
            'is_siteroot' => 0,
            'mount_pid' => 0,
            'mount_pid_ol' => 0,
            'backend_layout_next_level' => '',
        ];
        $page99 = [
            'pid' => 98,
            'uid' => 99,
            't3ver_oid' => 0,
            't3ver_wsid' => 0,
            't3ver_state' => 0,
            'title' => 'Sub sub page 2',
            'nav_title' => '',
            'media' => '',
            'layout' => 0,
            'hidden' => 0,
            'starttime' => 0,
            'endtime' => 0,
            'fe_group' => '0',
            'extendToSubpages' => 0,
            'doktype' => 1,
            'TSconfig' => null,
            'tsconfig_includes' => '',
            'is_siteroot' => 0,
            'mount_pid' => 0,
            'mount_pid_ol' => 0,
            'backend_layout_next_level' => '',
        ];
        return [
            'page with one root template on pid 2' => [
                89,
                [ 3 => $page89, 2 => $page88, 1 => $page2, 0 => $page1 ],
                [ 0 => $page2, 1 => $page88, 2 => $page89 ],
                false,
            ],
            'page with one root template on pid 2 no cache' => [
                89,
                [ 3 => $page89, 2 => $page88, 1 => $page2, 0 => $page1 ],
                [ 0 => $page2, 1 => $page88, 2 => $page89 ],
                true,
            ],
            'page with one root template on pid 2 and one on pid 98' => [
                99,
                [ 3 => $page99, 2 => $page98, 1 => $page2, 0 => $page1 ],
                [ 0 => $page98, 1 => $page99 ],
                false,
            ],
            'page with one root template on pid 2 and one on pid 98 no cache' => [
                99,
                [ 3 => $page99, 2 => $page98, 1 => $page2, 0 => $page1 ],
                [ 0 => $page98, 1 => $page99 ],
                true,
            ],
        ];
    }
 
    #[DataProvider('getFromCacheSetsConfigRootlineToLocalRootlineDataProvider')]
    #[Test]
    public function ‪getFromCacheSetsConfigRootlineToLocalRootline(int $pid, array $expectedRootLine, array $expectedConfigRootLine, bool $nocache): void
    {
        $this->importCSVDataSet(__DIR__ . '/DataSet/LiveDefaultPages.csv');
        $this->setUpFrontendRootPage(
            2,
            ['EXT:frontend/Tests/Functional/Controller/Fixtures/PageHelloWorld.typoscript']
        );
        $this->‪writeSiteConfiguration(
            'test',
            $this->‪buildSiteConfiguration(2, 'https://website.local/'),
            [$this->‪buildDefaultLanguageConfiguration('EN', '/en/')]
        );
 
        $request = (new InternalRequest('https://website.local/en/'))->withPageId($pid);
        if ($nocache) {
            $cacheInstruction = new ‪CacheInstruction();
            $cacheInstruction->disableCache('EXT:frontend: Testing disables caching.');
            $request = $request->withAttribute('frontend.cache.instruction', $cacheInstruction);
        }
        $this->executeFrontendSubRequest($request);
        self::assertSame($expectedRootLine, ‪$GLOBALS['TSFE']->rootLine);
        self::assertSame($expectedConfigRootLine, ‪$GLOBALS['TSFE']->config['rootLine']);
    }
 
    #[Test]
    public function ‪applicationConsidersTrueConditionVerdict(): void
    {
        $this->importCSVDataSet(__DIR__ . '/DataSet/LiveDefaultPages.csv');
        $this->setUpFrontendRootPage(
            2,
            ['EXT:frontend/Tests/Functional/Controller/Fixtures/PageHttpsConditionHelloWorld.typoscript']
        );
        $this->‪writeSiteConfiguration(
            'test',
            $this->‪buildSiteConfiguration(2, 'https://website.local/'),
            [$this->‪buildDefaultLanguageConfiguration('EN', '/en/')]
        );
        $request = (new InternalRequest('https://website.local/en/'))->withPageId(2);
        $response = $this->executeFrontendSubRequest($request);
        self::assertStringContainsString('https-condition-on', (string)$response->getBody());
    }
 
    #[Test]
    public function ‪applicationConsidersFalseConditionVerdictToElseBranch(): void
    {
        $this->importCSVDataSet(__DIR__ . '/DataSet/LiveDefaultPages.csv');
        $this->setUpFrontendRootPage(
            2,
            ['EXT:frontend/Tests/Functional/Controller/Fixtures/PageHttpsConditionHelloWorld.typoscript']
        );
        $this->‪writeSiteConfiguration(
            'test',
            $this->‪buildSiteConfiguration(2, 'http://website.local/'),
            [$this->‪buildDefaultLanguageConfiguration('EN', '/en/')]
        );
        $request = (new InternalRequest('http://website.local/en/'))->withPageId(2);
        $response = $this->executeFrontendSubRequest($request);
        self::assertStringContainsString('https-condition-off', (string)$response->getBody());
    }
}