Skip to content

[BUGFIX] Restore Context and DI container state #734

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
sbuerk wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[BUGFIX] Restore Context and DI container state #734

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 35 additions & 1 deletion Classes/Core/Functional/Framework/FrameworkState.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,11 @@
* The TYPO3 project - inspiring people to share!
*/

use Psr\Container\ContainerInterface;
use Psr\Http\Message\ServerRequestInterface;
use TYPO3\CMS\Core\Authentication\BackendUserAuthentication;
use TYPO3\CMS\Core\Context\Context;
use TYPO3\CMS\Core\SingletonInterface;
use TYPO3\CMS\Core\Utility\GeneralUtility;

/**
Expand All @@ -29,6 +34,18 @@
*
* This class should not be needed. It is a manifest of technical core debt.
* It should shrink over time and vanish altogether in the end.
*
* @phpstan-type State array{
* globals-server: array<string, mixed>,
* globals-beUser: BackendUserAuthentication|null,
* globals-typo3-conf-vars: array<string, mixed>|null,
* globals-tca: array<string, mixed>,
* request: ServerRequestInterface|null,
* generalUtilityIndpEnvCache?: array<string, string|bool|array<string, string|bool|null>|null>,
* generalUtilitySingletonInstances: array<class-string, SingletonInterface>,
* contextData: Context,
* container: ContainerInterface,
* }
*/
class FrameworkState
{
Expand All @@ -39,6 +56,7 @@ class FrameworkState
*/
public static function push(): void
{
/** @var State $state */
$state = [];
$state['globals-server'] = $GLOBALS['_SERVER'];
$state['globals-beUser'] = $GLOBALS['BE_USER'] ?? null;
Expand All @@ -61,6 +79,8 @@ public static function push(): void
}

$state['generalUtilitySingletonInstances'] = GeneralUtility::getSingletonInstances();
$state['contextData'] = clone GeneralUtility::makeInstance(Context::class);
$state['container'] = GeneralUtility::getContainer();

self::$state[] = $state;
}
Expand All @@ -73,22 +93,28 @@ public static function reset(): void
unset($GLOBALS['BE_USER']);
unset($GLOBALS['TYPO3_REQUEST']);

$generalUtilityReflection = new \ReflectionClass(GeneralUtility::class);
// @todo: Remove when v14 compat is dropped, the property no longer exists in v15.
if (property_exists(GeneralUtility::class, 'indpEnvCache')) {
$generalUtilityReflection = new \ReflectionClass(GeneralUtility::class);
$generalUtilityIndpEnvCache = $generalUtilityReflection->getProperty('indpEnvCache');
$generalUtilityIndpEnvCache->setValue(null, []);
}

GeneralUtility::resetSingletonInstances([]);
self::overrideContextData(GeneralUtility::makeInstance(Context::class), new Context());
$generalUtilityReflection->getProperty('container')->setValue(null, null);
}

/**
* Pop state from stash and apply again to set state back to 'before frontend call'
*/
public static function pop(): void
{
/** @var ?State $state */
$state = array_pop(self::$state);
if ($state === null) {
throw new \RuntimeException('No state item found in stack to pop.', 1784990840);
}

$GLOBALS['_SERVER'] = $state['globals-server'];
if ($state['globals-beUser'] !== null) {
Expand All @@ -109,5 +135,13 @@ public static function pop(): void
}

GeneralUtility::resetSingletonInstances($state['generalUtilitySingletonInstances']);
self::overrideContextData(GeneralUtility::makeInstance(Context::class), $state['contextData']);
GeneralUtility::setContainer($state['container']);
}

private static function overrideContextData(Context $context, Context $overrideContext): void
{
$propertyAccessor = new \ReflectionProperty(Context::class, 'aspects');
$propertyAccessor->setValue($context, $propertyAccessor->getValue($overrideContext));
}
}