[TASK] Introduce a Proxy for SiteFinder

Author: NamelessCoder

Classes/Proxy/SiteFinderProxy.php

@@ -0,0 +1,46 @@
+<?php
+namespace FluidTYPO3\Vhs\Proxy;
+
+/*
+ * This file is part of the FluidTYPO3/Vhs project under GPLv2 or later.
+ *
+ * For the full copyright and license information, please read the
+ * LICENSE.md file that was distributed with this source code.
+ */
+
+use TYPO3\CMS\Core\Site\Entity\Site;
+use TYPO3\CMS\Core\Site\SiteFinder;
+
+/**
+ * Final/readonly classes are the worst decision in TYPO3 since Neos.
+ *
+ * @codeCoverageIgnore
+ */
+class SiteFinderProxy
+{
+    private SiteFinder $siteFinder;
+
+    public function __construct(SiteFinder $siteFinder)
+    {
+        $this->siteFinder = $siteFinder;
+    }
+    public function getAllSites(bool $useCache = true): array
+    {
+        return $this->siteFinder->getAllSites($useCache);
+    }
+
+    public function getSiteByRootPageId(int $rootPageId): Site
+    {
+        return $this->siteFinder->getSiteByRootPageId($rootPageId);
+    }
+
+    public function getSiteByIdentifier(string $identifier): Site
+    {
+        return $this->siteFinder->getSiteByIdentifier($identifier);
+    }
+
+    public function getSiteByPageId(int $pageId, ?array $rootLine = null, ?string $mountPointParameter = null): Site
+    {
+        return $this->siteFinder->getSiteByPageId($pageId, $rootLine, $mountPointParameter);
+    }
+}

Classes/Utility/FrontendSimulationUtility.php

@@ -8,11 +8,11 @@
  * LICENSE.md file that was distributed with this source code.
  */
 
+use FluidTYPO3\Vhs\Proxy\SiteFinderProxy;
 use TYPO3\CMS\Core\Context\Context;
 use TYPO3\CMS\Core\Domain\Repository\PageRepository;
 use TYPO3\CMS\Core\Routing\PageArguments;
 use TYPO3\CMS\Core\Site\Entity\Site;
-use TYPO3\CMS\Core\Site\SiteFinder;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
 use TYPO3\CMS\Frontend\Authentication\FrontendUserAuthentication;
 use TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController;
@@ -36,8 +36,8 @@ public static function simulateFrontendEnvironment(): ?TypoScriptFrontendControl
 
         $GLOBALS['TYPO3_CONF_VARS']['FE']['cookieName'] = $GLOBALS['TYPO3_CONF_VARS']['FE']['cookieName'] ?? 'fe_user';
 
-        /** @var SiteFinder $siteFinder */
-        $siteFinder = GeneralUtility::makeInstance(SiteFinder::class);
+        /** @var SiteFinderProxy $siteFinder */
+        $siteFinder = GeneralUtility::makeInstance(SiteFinderProxy::class);
         $sites = $siteFinder->getAllSites();
         /** @var Context $context */
         $context = GeneralUtility::makeInstance(Context::class);

Classes/ViewHelpers/Page/LanguageMenuViewHelper.php

@@ -9,6 +9,7 @@
  */
 
 use FluidTYPO3\Vhs\Proxy\DoctrineQueryProxy;
+use FluidTYPO3\Vhs\Proxy\SiteFinderProxy;
 use FluidTYPO3\Vhs\Traits\ArrayConsumingViewHelperTrait;
 use FluidTYPO3\Vhs\Traits\TagViewHelperCompatibility;
 use FluidTYPO3\Vhs\Utility\ContentObjectFetcher;
@@ -19,7 +20,6 @@
 use TYPO3\CMS\Core\Imaging\Icon;
 use TYPO3\CMS\Core\Imaging\IconFactory;
 use TYPO3\CMS\Core\Site\Site;
-use TYPO3\CMS\Core\Site\SiteFinder;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
 use TYPO3\CMS\Core\Utility\VersionNumberUtility;
 use TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface;
@@ -152,12 +152,10 @@ public function render()
         $this->cObj = $contentObject;
         $this->tagName = is_scalar($this->arguments['tagName']) ? (string) $this->arguments['tagName'] : 'ul';
         $this->tag->setTagName($this->tagName);
-
-        if (class_exists(SiteFinder::class)) {
-            $this->site = $this->getSite();
-            $this->defaultLangUid = $this->site->getDefaultLanguage()->getLanguageId();
-        }
+        $this->site = $this->getSite();
+        $this->defaultLangUid = $this->site->getDefaultLanguage()->getLanguageId();
         $this->languageMenu = $this->parseLanguageMenu();
+
         /** @var string $as */
         $as = $this->arguments['as'];
         $this->renderingContext->getVariableProvider()->add($as, $this->languageMenu);
@@ -505,8 +503,8 @@ protected function getPageUid(): int
      */
     protected function getSite()
     {
-        /** @var SiteFinder $siteFinder */
-        $siteFinder = GeneralUtility::makeInstance(SiteFinder::class);
+        /** @var SiteFinderProxy $siteFinder */
+        $siteFinder = GeneralUtility::makeInstance(SiteFinderProxy::class);
         return $siteFinder->getSiteByPageId($this->getPageUid());
     }
 

Configuration/Services.yaml

@@ -11,7 +11,10 @@ services:
   FluidTYPO3\Vhs\:
     resource: '../Classes/*'
 
-  FluidTYPO3\Vhs\Utility\DispatcherProxy:
+  FluidTYPO3\Vhs\Proxy\DispatcherProxy:
+    public: true
+
+  FluidTYPO3\Vhs\Proxy\SiteFinderProxy:
     public: true
 
   FluidTYPO3\Vhs\Service\AssetService:

Tests/Unit/Utility/FrontendSimulationUtilityTest.php

@@ -8,13 +8,13 @@
  * LICENSE.md file that was distributed with this source code.
  */
 
+use FluidTYPO3\Vhs\Proxy\SiteFinderProxy;
 use FluidTYPO3\Vhs\Tests\Unit\AbstractTestCase;
 use FluidTYPO3\Vhs\Utility\FrontendSimulationUtility;
 use TYPO3\CMS\Core\Core\SystemEnvironmentBuilder;
 use TYPO3\CMS\Core\Http\ServerRequest;
 use TYPO3\CMS\Core\Site\Entity\Site;
 use TYPO3\CMS\Core\Site\Entity\SiteLanguage;
-use TYPO3\CMS\Core\Site\SiteFinder;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
 use TYPO3\CMS\Frontend\Authentication\FrontendUserAuthentication;
 use TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController;
@@ -37,7 +37,7 @@ protected function setUp(): void
             ->getMock();
         $site->method('getDefaultLanguage')->willReturn($siteLanguage);
 
-        $siteFinder = $this->getMockBuilder(SiteFinder::class)
+        $siteFinder = $this->getMockBuilder(SiteFinderProxy::class)
             ->setMethods(['getAllSites'])
             ->disableOriginalConstructor()
             ->getMock();
@@ -47,7 +47,7 @@ protected function setUp(): void
             ->disableOriginalConstructor()
             ->getMock();
 
-        GeneralUtility::addInstance(SiteFinder::class, $siteFinder);
+        GeneralUtility::addInstance(SiteFinderProxy::class, $siteFinder);
         GeneralUtility::addInstance(FrontendUserAuthentication::class, $frontendUserAuthentication);
         GeneralUtility::addInstance(
             TypoScriptFrontendController::class,