EidRequestTest.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\SiteHandling;
 
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\Attributes\Test;
use ‪TYPO3\CMS\Core\Localization\LanguageServiceFactory;
use TYPO3\TestingFramework\Core\Functional\Framework\DataHandling\Scenario\DataHandlerFactory;
use TYPO3\TestingFramework\Core\Functional\Framework\DataHandling\Scenario\DataHandlerWriter;
use TYPO3\TestingFramework\Core\Functional\Framework\Frontend\InternalRequest;
 
final class ‪EidRequestTest extends ‪AbstractTestCase
{
    protected array ‪$testExtensionsToLoad = [
        'typo3/sysext/core/Tests/Functional/Fixtures/Extensions/test_eid',
    ];
 
    protected function ‪setUp(): void
    {
        parent::setUp();
        $this->withDatabaseSnapshot(function () {
            $this->importCSVDataSet(__DIR__ . '/../Fixtures/be_users.csv');
            $backendUser = $this->setUpBackendUser(1);
            ‪$GLOBALS['LANG'] = $this->get(LanguageServiceFactory::class)->createFromUserPreferences($backendUser);
            $scenarioFile = __DIR__ . '/Fixtures/PlainScenario.yaml';
            $factory = DataHandlerFactory::fromYamlFile($scenarioFile);
            $writer = DataHandlerWriter::withBackendUser($backendUser);
            $writer->invokeFactory($factory);
            static::failIfArrayIsNotEmpty(
                $writer->getErrors()
            );
        });
    }
 
    public static function ‪ensureEidRequestsWorkDataProvider(): array
    {
        return [
            'eid without index.php' => [
                'https://website.local/?eID=test_eid&id=123&some_parameter=1',
                200,
                [
                    'content-type' => [
                        'application/json',
                    ],
                    'eid_responder' => [
                        'responded',
                    ],
                ],
                [
                    'eid_responder' => true,
                    'uri' => 'https://website.local/?eID=test_eid&id=123&some_parameter=1',
                    'method' => 'GET',
                    'queryParams' => [
                        'eID' => 'test_eid',
                        'id' => '123',
                        'some_parameter' => '1',
                    ],
                ],
            ],
            'eid with index.php' => [
                'https://website.local/index.php?eID=test_eid&id=123&some_parameter=1',
                200,
                [
                    'content-type' => [
                        'application/json',
                    ],
                    'eid_responder' => [
                        'responded',
                    ],
                ],
                [
                    'eid_responder' => true,
                    'uri' => 'https://website.local/index.php?eID=test_eid&id=123&some_parameter=1',
                    'method' => 'GET',
                    'queryParams' => [
                        'eID' => 'test_eid',
                        'id' => '123',
                        'some_parameter' => '1',
                    ],
                ],
            ],
            'eid on slug page' => [
                'https://website.local/en-welcome/?eID=test_eid&id=123&some_parameter=1',
                200,
                [
                    'content-type' => [
                        'application/json',
                    ],
                    'eid_responder' => [
                        'responded',
                    ],
                ],
                [
                    'eid_responder' => true,
                    'uri' => 'https://website.local/en-welcome/?eID=test_eid&id=123&some_parameter=1',
                    'method' => 'GET',
                    'queryParams' => [
                        'eID' => 'test_eid',
                        'id' => '123',
                        'some_parameter' => '1',
                    ],
                ],
            ],
            'eid without index.php with type' => [
                'https://website.local/?eID=test_eid&id=123&some_parameter=1&type=0',
                200,
                [
                    'content-type' => [
                        'application/json',
                    ],
                    'eid_responder' => [
                        'responded',
                    ],
                ],
                [
                    'eid_responder' => true,
                    'uri' => 'https://website.local/?eID=test_eid&id=123&some_parameter=1&type=0',
                    'method' => 'GET',
                    'queryParams' => [
                        'eID' => 'test_eid',
                        'id' => '123',
                        'some_parameter' => '1',
                        'type' => '0',
                    ],
                ],
            ],
            'eid with index.php with type' => [
                'https://website.local/index.php?eID=test_eid&id=123&some_parameter=1&type=0',
                200,
                [
                    'content-type' => [
                        'application/json',
                    ],
                    'eid_responder' => [
                        'responded',
                    ],
                ],
                [
                    'eid_responder' => true,
                    'uri' => 'https://website.local/index.php?eID=test_eid&id=123&some_parameter=1&type=0',
                    'method' => 'GET',
                    'queryParams' => [
                        'eID' => 'test_eid',
                        'id' => '123',
                        'some_parameter' => '1',
                        'type' => '0',
                    ],
                ],
            ],
            'eid on slug page with type' => [
                'https://website.local/en-welcome/?eID=test_eid&id=123&some_parameter=1&type=0',
                200,
                [
                    'content-type' => [
                        'application/json',
                    ],
                    'eid_responder' => [
                        'responded',
                    ],
                ],
                [
                    'eid_responder' => true,
                    'uri' => 'https://website.local/en-welcome/?eID=test_eid&id=123&some_parameter=1&type=0',
                    'method' => 'GET',
                    'queryParams' => [
                        'eID' => 'test_eid',
                        'id' => '123',
                        'some_parameter' => '1',
                        'type' => '0',
                    ],
                ],
            ],
            'eid with empty array as eID identifier' => [
                'https://website.local/en-welcome/?eID[]=',
                400,
                [],
                null,
            ],
            // without id/type parameters
            'eid with index.php without id parameter' => [
                'https://website.local/index.php?eID=test_eid&some_parameter=1',
                200,
                [
                    'content-type' => [
                        'application/json',
                    ],
                    'eid_responder' => [
                        'responded',
                    ],
                ],
                [
                    'eid_responder' => true,
                    'uri' => 'https://website.local/index.php?eID=test_eid&some_parameter=1',
                    'method' => 'GET',
                    'queryParams' => [
                        'eID' => 'test_eid',
                        'some_parameter' => '1',
                    ],
                ],
            ],
            'eid on slug page without id parameter' => [
                'https://website.local/en-welcome/?eID=test_eid&some_parameter=1',
                200,
                [
                    'content-type' => [
                        'application/json',
                    ],
                    'eid_responder' => [
                        'responded',
                    ],
                ],
                [
                    'eid_responder' => true,
                    'uri' => 'https://website.local/en-welcome/?eID=test_eid&some_parameter=1',
                    'method' => 'GET',
                    'queryParams' => [
                        'eID' => 'test_eid',
                        'some_parameter' => '1',
                    ],
                ],
            ],
            'eid without index.php with type without id parameter' => [
                'https://website.local/?eID=test_eid&some_parameter=1&type=0',
                200,
                [
                    'content-type' => [
                        'application/json',
                    ],
                    'eid_responder' => [
                        'responded',
                    ],
                ],
                [
                    'eid_responder' => true,
                    'uri' => 'https://website.local/?eID=test_eid&some_parameter=1&type=0',
                    'method' => 'GET',
                    'queryParams' => [
                        'eID' => 'test_eid',
                        'some_parameter' => '1',
                        'type' => '0',
                    ],
                ],
            ],
            'eid with index.php with type without id parameter' => [
                'https://website.local/index.php?eID=test_eid&some_parameter=1&type=0',
                200,
                [
                    'content-type' => [
                        'application/json',
                    ],
                    'eid_responder' => [
                        'responded',
                    ],
                ],
                [
                    'eid_responder' => true,
                    'uri' => 'https://website.local/index.php?eID=test_eid&some_parameter=1&type=0',
                    'method' => 'GET',
                    'queryParams' => [
                        'eID' => 'test_eid',
                        'some_parameter' => '1',
                        'type' => '0',
                    ],
                ],
            ],
            'eid on slug page with type without id parameter' => [
                'https://website.local/en-welcome/?eID=test_eid&some_parameter=1&type=0',
                200,
                [
                    'content-type' => [
                        'application/json',
                    ],
                    'eid_responder' => [
                        'responded',
                    ],
                ],
                [
                    'eid_responder' => true,
                    'uri' => 'https://website.local/en-welcome/?eID=test_eid&some_parameter=1&type=0',
                    'method' => 'GET',
                    'queryParams' => [
                        'eID' => 'test_eid',
                        'some_parameter' => '1',
                        'type' => '0',
                    ],
                ],
            ],
        ];
    }
 
    #[DataProvider('ensureEidRequestsWorkDataProvider')]
    #[Test]
    public function ‪ensureEidRequestsWork(
        string $uri,
        int $expectedStatusCode,
        array $expectedHeaders,
        ?array $expectedResponseData
    ): void {
        $this->setUpFrontendRootPage(
            1000,
            [
                'EXT:core/Tests/Functional/Fixtures/Frontend/JsonRenderer.typoscript',
                'EXT:frontend/Tests/Functional/SiteHandling/Fixtures/JsonRenderer.typoscript',
            ],
            [
                'title' => 'ACME Root',
            ]
        );
        $this->‪writeSiteConfiguration(
            'website-local',
            $this->‪buildSiteConfiguration(1000, 'https://website.local/')
        );
 
        $response = $this->executeFrontendSubRequest(new InternalRequest($uri));
        self::assertSame($expectedStatusCode, $response->getStatusCode());
        self::assertSame($expectedHeaders, $response->getHeaders());
        if ($expectedResponseData !== null) {
            self::assertSame($expectedResponseData, json_decode((string)$response->getBody(), true, 512, JSON_THROW_ON_ERROR));
        }
    }
 
    #[DataProvider('ensureEidRequestsWorkDataProvider')]
    #[Test]
    public function ‪ensureEidRequestsWorkWithDotPhpPageTypeSuffixRoutingConfiguration(
        string $uri,
        int $expectedStatusCode,
        array $expectedHeaders,
        ?array $expectedResponseData
    ): void {
        $this->setUpFrontendRootPage(
            1000,
            [
                'EXT:core/Tests/Functional/Fixtures/Frontend/JsonRenderer.typoscript',
                'EXT:frontend/Tests/Functional/SiteHandling/Fixtures/JsonRenderer.typoscript',
            ],
            [
                'title' => 'ACME Root',
            ]
        );
        $this->‪writeSiteConfiguration(
            'website-local',
            array_replace(
                $this->‪buildSiteConfiguration(1000, 'https://website.local/'),
                [
                    'routeEnhancers' => [
                        'PageTypeSuffix' => [
                            'type' => 'PageType',
                            'default' => '.php',
                            'index' => 'index',
                            'map' => [],
                        ],
                    ],
                ]
            )
        );
 
        $response = $this->executeFrontendSubRequest(new InternalRequest($uri));
        self::assertSame($expectedStatusCode, $response->getStatusCode());
        self::assertSame($expectedHeaders, $response->getHeaders());
        if ($expectedResponseData !== null) {
            self::assertSame($expectedResponseData, json_decode((string)$response->getBody(), true, 512, JSON_THROW_ON_ERROR));
        }
    }
}