Merge pull request #912 from eliashaeussler/task/user-agent

[TASK] Move access to `User-Agent` header to a `RequestOptions` class

Author: eliashaeussler

Classes/Command/ShowUserAgentCommand.php

@@ -23,7 +23,7 @@
 
 namespace EliasHaeussler\Typo3Warming\Command;
 
-use EliasHaeussler\Typo3Warming\Configuration;
+use EliasHaeussler\Typo3Warming\Http;
 use Symfony\Component\Console;
 
 /**
@@ -34,10 +34,13 @@
  */
 final class ShowUserAgentCommand extends Console\Command\Command
 {
-    public function __construct(
-        private readonly Configuration\Configuration $configuration,
-    ) {
+    private readonly string $userAgent;
+
+    public function __construct(Http\Message\Request\RequestOptions $requestOptions)
+    {
         parent::__construct();
+
+        $this->userAgent = $requestOptions->getUserAgent();
     }
 
     protected function configure(): void
@@ -47,7 +50,7 @@ protected function configure(): void
 
     protected function execute(Console\Input\InputInterface $input, Console\Output\OutputInterface $output): int
     {
-        $output->write($this->configuration->getUserAgent());
+        $output->write($this->userAgent);
 
         return self::SUCCESS;
     }

Classes/Command/WarmupCommand.php

@@ -56,6 +56,7 @@ public function __construct(
         private readonly EventDispatcher\EventDispatcherInterface $eventDispatcher,
         private readonly Core\Package\PackageManager $packageManager,
         private readonly Http\Message\PageUriBuilder $pageUriBuilder,
+        private readonly Http\Message\Request\RequestOptions $requestOptions,
     ) {
         parent::__construct();
     }
@@ -173,7 +174,7 @@ protected function configure(): void
   ├─ When the default crawler is used, each warmup request is executed with a special User-Agent header.
   │  This header is generated from the encryption key of the TYPO3 installation.
   │  It can be used, for example, to exclude warmup requests from your search statistics.
-  └─ Current User-Agent: <info>{$v($this->configuration->getUserAgent())}</info>
+  └─ Current User-Agent: <info>{$v($this->requestOptions->getUserAgent())}</info>
 HELP
         );
 

Classes/Configuration/Configuration.php

@@ -26,9 +26,9 @@
 use EliasHaeussler\CacheWarmup;
 use EliasHaeussler\Typo3Warming\Crawler;
 use EliasHaeussler\Typo3Warming\Extension;
+use EliasHaeussler\Typo3Warming\Http;
 use mteu\TypedExtConf;
 use TYPO3\CMS\Core;
-use TYPO3\CMS\Extbase;
 
 /**
  * Configuration
@@ -40,7 +40,6 @@
 final class Configuration
 {
     private ?CacheWarmup\Crawler\CrawlerFactory $crawlerFactory = null;
-    private readonly string $userAgent;
 
     /**
      * @param class-string<CacheWarmup\Crawler\Crawler> $crawlerClass
@@ -78,9 +77,7 @@ public function __construct(
         public readonly array $supportedDoktypes = [Core\Domain\Repository\PageRepository::DOKTYPE_DEFAULT],
         #[TypedExtConf\Attribute\ExtConfProperty(path: 'enableToolbar')]
         public readonly bool $enabledInToolbar = true,
-    ) {
-        $this->userAgent = $this->generateUserAgent();
-    }
+    ) {}
 
     /**
      * @param array{} $arguments
@@ -138,32 +135,26 @@ public function getVerboseCrawler(): CacheWarmup\Crawler\VerboseCrawler
         return $this->getCrawlerFactory()->get($this->verboseCrawlerClass, $this->verboseCrawlerOptions);
     }
 
+    /**
+     * @deprecated Use {@see RequestOptions::getUserAgent()} instead. Will be removed in v5.0.
+     */
     public function getUserAgent(): string
     {
-        return $this->userAgent;
-    }
-
-    private function generateUserAgent(): string
-    {
-        $string = 'TYPO3/tx_warming_crawler';
-
-        if (class_exists(Core\Crypto\HashService::class)) {
-            return Core\Utility\GeneralUtility::makeInstance(Core\Crypto\HashService::class)->appendHmac(
-                $string,
-                self::class,
-            );
-        }
-
-        // @todo Remove once support for TYPO3 v12 is dropped
-        /* @phpstan-ignore classConstant.deprecatedClass, method.deprecatedClass */
-        return Core\Utility\GeneralUtility::makeInstance(Extbase\Security\Cryptography\HashService::class)->appendHmac(
-            $string,
+        trigger_error(
+            \sprintf(
+                'Method "%s()" is deprecated and will be removed in v5.0. ' .
+                'Access User-Agent header via "%s::getUserAgent()" method instead.',
+                __METHOD__,
+                Http\Message\Request\RequestOptions::class,
+            ),
+            E_USER_DEPRECATED,
         );
+
+        return (new Http\Message\Request\RequestOptions())->getUserAgent();
     }
 
     private function getCrawlerFactory(): CacheWarmup\Crawler\CrawlerFactory
     {
-        // Cannot be instantiated with DI, would lead to circular dependencies
         return $this->crawlerFactory ??= Core\Utility\GeneralUtility::makeInstance(
             CacheWarmup\Crawler\CrawlerFactory::class,
         );

Classes/Controller/FetchSitesController.php

@@ -48,6 +48,7 @@ public function __construct(
         private Configuration\Configuration $configuration,
         private CacheWarmup\Crawler\Strategy\CrawlingStrategyFactory $crawlingStrategyFactory,
         private Core\Imaging\IconFactory $iconFactory,
+        private Http\Message\Request\RequestOptions $requestOptions,
         private Http\Message\ResponseFactory $responseFactory,
         private Domain\Repository\SiteRepository $siteRepository,
         private Domain\Repository\SiteLanguageRepository $siteLanguageRepository,
@@ -92,7 +93,7 @@ public function __invoke(Message\ServerRequestInterface $request): Message\Respo
 
         return $this->responseFactory->htmlTemplate('Modal/SitesModal', [
             'siteGroups' => $siteGroups,
-            'userAgent' => $this->configuration->getUserAgent(),
+            'userAgent' => $this->requestOptions->getUserAgent(),
             'configuration' => [
                 'limit' => $this->configuration->limit,
                 'strategy' => $crawlingStrategy !== null ? $crawlingStrategy::getName() : null,

Classes/Crawler/ConcurrentUserAgentCrawler.php

@@ -25,7 +25,6 @@
 
 use EliasHaeussler\CacheWarmup;
 use EliasHaeussler\SSE;
-use EliasHaeussler\Typo3Warming\Configuration;
 use EliasHaeussler\Typo3Warming\Http;
 use GuzzleHttp\Client;
 use GuzzleHttp\ClientInterface;
@@ -57,8 +56,8 @@ final class ConcurrentUserAgentCrawler extends CacheWarmup\Crawler\AbstractConfi
     }
     use LoggingCrawlerTrait;
 
-    private readonly Configuration\Configuration $configuration;
     private readonly Http\Client\Handler\HandlerStackBuilder $handlerStackBuilder;
+    private readonly Http\Message\Request\RequestOptions $requestOptions;
     private readonly Http\Client\Handler\SubRequestHandler $subRequestHandler;
     private ?SSE\Stream\EventStream $stream = null;
 
@@ -68,8 +67,8 @@ public function __construct(
         private readonly ClientInterface $client = new Client(),
         private readonly ?EventDispatcher\EventDispatcherInterface $eventDispatcher = null,
     ) {
-        $this->configuration = Core\Utility\GeneralUtility::makeInstance(Configuration\Configuration::class);
         $this->handlerStackBuilder = new Http\Client\Handler\HandlerStackBuilder();
+        $this->requestOptions = Core\Utility\GeneralUtility::makeInstance(Http\Message\Request\RequestOptions::class);
         $this->subRequestHandler = Core\Utility\GeneralUtility::makeInstance(Http\Client\Handler\SubRequestHandler::class);
         $this->logger = $logger;
 
@@ -132,7 +131,7 @@ protected function configureOptions(OptionsResolver\OptionsResolver $optionsReso
     protected function createRequestFactory(): CacheWarmup\Http\Message\RequestFactory
     {
         $headers = $this->options['request_headers'];
-        $headers['User-Agent'] = $this->configuration->getUserAgent();
+        $headers['User-Agent'] = $this->requestOptions->getUserAgent();
 
         return $this->createBaseRequestFactory()->withHeaders($headers);
     }

Classes/Crawler/OutputtingUserAgentCrawler.php

@@ -24,7 +24,6 @@
 namespace EliasHaeussler\Typo3Warming\Crawler;
 
 use EliasHaeussler\CacheWarmup;
-use EliasHaeussler\Typo3Warming\Configuration;
 use EliasHaeussler\Typo3Warming\Http;
 use GuzzleHttp\Client;
 use GuzzleHttp\ClientInterface;
@@ -57,8 +56,8 @@ final class OutputtingUserAgentCrawler extends CacheWarmup\Crawler\AbstractConfi
     }
     use LoggingCrawlerTrait;
 
-    private readonly Configuration\Configuration $configuration;
     private Http\Client\Handler\HandlerStackBuilder $handlerStackBuilder;
+    private readonly Http\Message\Request\RequestOptions $requestOptions;
     private readonly Http\Client\Handler\SubRequestHandler $subRequestHandler;
     private Console\Output\OutputInterface $output;
 
@@ -68,8 +67,8 @@ public function __construct(
         private readonly ClientInterface $client = new Client(),
         private readonly ?EventDispatcher\EventDispatcherInterface $eventDispatcher = null,
     ) {
-        $this->configuration = Core\Utility\GeneralUtility::makeInstance(Configuration\Configuration::class);
         $this->handlerStackBuilder = new Http\Client\Handler\HandlerStackBuilder();
+        $this->requestOptions = Core\Utility\GeneralUtility::makeInstance(Http\Message\Request\RequestOptions::class);
         $this->subRequestHandler = Core\Utility\GeneralUtility::makeInstance(Http\Client\Handler\SubRequestHandler::class);
         $this->logger = $logger;
 
@@ -133,7 +132,7 @@ protected function configureOptions(OptionsResolver\OptionsResolver $optionsReso
     protected function createRequestFactory(): CacheWarmup\Http\Message\RequestFactory
     {
         $headers = $this->options['request_headers'];
-        $headers['User-Agent'] = $this->configuration->getUserAgent();
+        $headers['User-Agent'] = $this->requestOptions->getUserAgent();
 
         return $this->createBaseRequestFactory()->withHeaders($headers);
     }

Classes/Http/Message/Request/RequestOptions.php

@@ -0,0 +1,58 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the TYPO3 CMS extension "warming".
+ *
+ * Copyright (C) 2021-2025 Elias Häußler <elias@haeussler.dev>
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ */
+
+namespace EliasHaeussler\Typo3Warming\Http\Message\Request;
+
+use EliasHaeussler\Typo3Warming\Configuration;
+use Symfony\Component\DependencyInjection;
+use TYPO3\CMS\Core;
+use TYPO3\CMS\Extbase;
+
+/**
+ * RequestOptions
+ *
+ * @author Elias Häußler <elias@haeussler.dev>
+ * @license GPL-2.0-or-later
+ */
+#[DependencyInjection\Attribute\Autoconfigure(public: true)]
+final readonly class RequestOptions
+{
+    public function getUserAgent(): string
+    {
+        $string = 'TYPO3/tx_warming_crawler';
+
+        if (class_exists(Core\Crypto\HashService::class)) {
+            return Core\Utility\GeneralUtility::makeInstance(Core\Crypto\HashService::class)->appendHmac(
+                $string,
+                // @todo Change to self::class in v5.0
+                Configuration\Configuration::class,
+            );
+        }
+
+        // @todo Remove once support for TYPO3 v12 is dropped
+        /* @phpstan-ignore classConstant.deprecatedClass, method.deprecatedClass */
+        return Core\Utility\GeneralUtility::makeInstance(Extbase\Security\Cryptography\HashService::class)->appendHmac(
+            $string,
+        );
+    }
+}

Documentation/DeveloperCorner/ConfigurationAPI.rst

@@ -8,7 +8,7 @@ Configuration API
 
 In order to access the :ref:`extension configuration <extension-configuration>`,
 a slim PHP API exists. Each configuration option is accessible by
-an appropriate class method.
+an appropriate class property.
 
 ..  versionchanged:: 4.2.0
 
@@ -89,6 +89,11 @@ an appropriate class method.
 
         Get the calculated user-agent.
 
+        ..  deprecated:: 4.2.0
+
+            Call :php:`\EliasHaeussler\Typo3Warming\Http\Message\Request\RequestOptions::getUserAgent`
+            instead. See :ref:`migration guide <version-4.2.0>` for more information.
+
         :returntype: :php:`string`
 
 ..  seealso::

Documentation/Migration/Index.rst

@@ -29,6 +29,16 @@ Use of properties in :ref:`Configuration API <configuration-api>`
 -   Calling the legacy class methods is deprecated and won't be possible anymore with version
     5.0 of the extension.
 
+Deprecation of :php:`getUserAgent()` method in :ref:`Configuration API <configuration-api>`
+-------------------------------------------------------------------------------------------
+
+-   Access to the generated `User-Agent` header is moved from the :ref:`Configuration API <configuration-api>`
+    to a dedicated :php:`\EliasHaeussler\Typo3Warming\Http\Message\Request\RequestOptions` class.
+-   Migrate calls from :php:`\EliasHaeussler\Typo3Warming\Configuration\Configuration::getUserAgent`
+    to :php:`\EliasHaeussler\Typo3Warming\Http\Message\Request\RequestOptions::getUserAgent`.
+-   Calling the legacy method is deprecated and won't be possible anymore with version 5.0
+    of the extension.
+
 ..  _version-4.0.0:
 
 Version 4.0.0

Tests/CGL/rector.php

@@ -76,13 +76,13 @@
         ])
         // @todo Remove once support for TYPO3 v12 is dropped
         ->skip(MigrateExtbaseHashServiceToUseCoreHashServiceRector::class, [
-            $rootPath . '/Classes/Configuration/Configuration.php',
+            $rootPath . '/Classes/Http/Message/Request/RequestOptions.php',
             $rootPath . '/Classes/Http/Message/UrlMetadataFactory.php',
             $rootPath . '/Tests/Functional/Http/Message/UrlMetadataFactoryTest.php',
         ])
         // @todo Remove once support for TYPO3 v12 is dropped
         ->skip(RenameClassRector::class, [
-            $rootPath . '/Classes/Configuration/Configuration.php',
+            $rootPath . '/Classes/Http/Message/Request/RequestOptions.php',
             $rootPath . '/Classes/Http/Message/UrlMetadataFactory.php',
             $rootPath . '/Tests/Functional/Http/Message/UrlMetadataFactoryTest.php',
         ])