refactor: add AbstractProvider

assets/components/search/DomainResult.tsx

@@ -43,7 +43,7 @@ export function DomainResult({domain}: { domain: Domain }) {
                                     <Tooltip
                                         placement='bottomLeft'
                                         title={s in rdapStatusCodeDetailTranslated ? rdapStatusCodeDetailTranslated[s as keyof typeof rdapStatusCodeDetailTranslated] : undefined}>
-                                        <Tag color={s === 'active' ? 'green' : 'blue'}>{s}</Tag>
+                                        <Tag color={['active', 'ok'].includes(s) ? 'green' : 'blue'}>{s}</Tag>
                                     </Tooltip>
                                 )
                             }

composer.json

@@ -84,7 +84,8 @@
     "symfony/zulip-notifier": "7.1.*",
     "symfonycasts/verify-email-bundle": "*",
     "twig/extra-bundle": "^2.12|^3.0",
-    "twig/twig": "^2.12|^3.0"
+    "twig/twig": "^2.12|^3.0",
+    "ext-http": "*"
   },
   "config": {
     "allow-plugins": {

src/Config/Connector/ConnectorInterface.php

@@ -1,18 +0,0 @@
-<?php
-
-namespace App\Config\Connector;
-
-use App\Entity\Domain;
-use App\Entity\Tld;
-use Symfony\Contracts\HttpClient\HttpClientInterface;
-
-interface ConnectorInterface
-{
-    public function __construct(array $authData, HttpClientInterface $client);
-
-    public function orderDomain(Domain $domain, bool $dryRun): void;
-
-    public static function verifyAuthData(array $authData, HttpClientInterface $client): array;
-
-    public function isSupported(Tld ...$tld): bool;
-}

src/Config/ConnectorProvider.php

@@ -2,8 +2,8 @@
 
 namespace App\Config;
 
-use App\Config\Connector\GandiConnector;
-use App\Config\Connector\OvhConnector;
+use App\Config\Provider\GandiProvider;
+use App\Config\Provider\OvhProvider;
 
 enum ConnectorProvider: string
 {
@@ -13,8 +13,8 @@ enum ConnectorProvider: string
     public function getConnectorProvider(): string
     {
         return match ($this) {
-            ConnectorProvider::OVH => OvhConnector::class,
-            ConnectorProvider::GANDI => GandiConnector::class
+            ConnectorProvider::OVH => OvhProvider::class,
+            ConnectorProvider::GANDI => GandiProvider::class
         };
     }
 }

src/Config/Provider/AbstractProvider.php

@@ -0,0 +1,52 @@
+<?php
+
+namespace App\Config\Provider;
+
+use App\Entity\Domain;
+use App\Entity\Tld;
+use Psr\Cache\CacheItemInterface;
+use Psr\Cache\CacheItemPoolInterface;
+use Symfony\Component\HttpKernel\KernelInterface;
+use Symfony\Contracts\HttpClient\HttpClientInterface;
+
+abstract class AbstractProvider
+{
+    public function __construct(
+        protected array $authData,
+        protected HttpClientInterface $client,
+        protected CacheItemPoolInterface $cacheItemPool,
+        protected KernelInterface $kernel
+    ) {
+    }
+
+    abstract public static function verifyAuthData(array $authData, HttpClientInterface $client): array;
+
+    abstract public function orderDomain(Domain $domain, bool $dryRun): void;
+
+    public function isSupported(Tld ...$tldList): bool
+    {
+        $item = $this->getCachedTldList();
+        if (!$item->isHit()) {
+            $supportedTldList = $this->getSupportedTldList();
+            $item
+                ->set($supportedTldList)
+                ->expiresAfter(new \DateInterval('P1M'));
+            $this->cacheItemPool->saveDeferred($item);
+        } else {
+            $supportedTldList = $item->get();
+        }
+
+        /** @var string $tldString */
+        foreach (array_unique(array_map(fn (Tld $tld) => $tld->getTld(), $tldList)) as $tldString) {
+            if (!in_array($tldString, $supportedTldList)) {
+                return false;
+            }
+        }
+
+        return true;
+    }
+
+    abstract protected function getCachedTldList(): CacheItemInterface;
+
+    abstract protected function getSupportedTldList(): array;
+}

src/Config/Provider/GandiProvider.php

@@ -1,10 +1,10 @@
 <?php
 
-namespace App\Config\Connector;
+namespace App\Config\Provider;
 
 use App\Entity\Domain;
-use App\Entity\Tld;
 use http\Exception\InvalidArgumentException;
+use Psr\Cache\CacheItemInterface;
 use Symfony\Component\HttpClient\HttpOptions;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
@@ -16,14 +16,10 @@ use Symfony\Contracts\HttpClient\Exception\ServerExceptionInterface;
 use Symfony\Contracts\HttpClient\Exception\TransportExceptionInterface;
 use Symfony\Contracts\HttpClient\HttpClientInterface;
 
-readonly class GandiConnector implements ConnectorInterface
+class GandiProvider extends AbstractProvider
 {
     private const BASE_URL = 'https://api.gandi.net';
 
-    public function __construct(private array $authData, private HttpClientInterface $client)
-    {
-    }
-
     /**
      * Order a domain name with the Gandi API.
      *
@@ -142,7 +138,7 @@ readonly class GandiConnector implements ConnectorInterface
      * @throws DecodingExceptionInterface
      * @throws ClientExceptionInterface
      */
-    public function isSupported(Tld ...$tldList): bool
+    protected function getSupportedTldList(): array
     {
         $authData = self::verifyAuthData($this->authData, $this->client);
 
@@ -152,15 +148,14 @@ readonly class GandiConnector implements ConnectorInterface
             ->setBaseUri(self::BASE_URL)
             ->toArray())->toArray();
 
-        $supportedTldList = array_map(fn ($tld) => $tld['name'], $response);
+        return array_map(fn ($tld) => $tld['name'], $response);
+    }
 
-        /** @var string $tldString */
-        foreach (array_unique(array_map(fn (Tld $tld) => $tld->getTld(), $tldList)) as $tldString) {
-            if (!in_array($tldString, $supportedTldList)) {
-                return false;
-            }
-        }
-
-        return true;
+    /**
+     * @throws \Psr\Cache\InvalidArgumentException
+     */
+    protected function getCachedTldList(): CacheItemInterface
+    {
+        return $this->cacheItemPool->getItem('app.provider.ovh.supported-tld');
     }
 }

src/Config/Provider/OvhProvider.php

@@ -1,17 +1,18 @@
 <?php
 
-namespace App\Config\Connector;
+namespace App\Config\Provider;
 
 use App\Entity\Domain;
-use App\Entity\Tld;
 use GuzzleHttp\Exception\ClientException;
 use Ovh\Api;
 use Ovh\Exceptions\InvalidParameterException;
+use Psr\Cache\CacheItemInterface;
+use Psr\Cache\InvalidArgumentException;
 use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
 use Symfony\Component\HttpKernel\Exception\HttpException;
 use Symfony\Contracts\HttpClient\HttpClientInterface;
 
-readonly class OvhConnector implements ConnectorInterface
+class OvhProvider extends AbstractProvider
 {
     public const REQUIRED_ROUTES = [
         [
@@ -40,10 +41,6 @@ readonly class OvhConnector implements ConnectorInterface
         ],
     ];
 
-    public function __construct(private array $authData, private HttpClientInterface $client)
-    {
-    }
-
     /**
      * Order a domain name with the OVH API.
      *
@@ -219,7 +216,7 @@ readonly class OvhConnector implements ConnectorInterface
      * @throws \JsonException
      * @throws \Exception
      */
-    public function isSupported(Tld ...$tldList): bool
+    protected function getSupportedTldList(): array
     {
         $authData = self::verifyAuthData($this->authData, $this->client);
 
@@ -230,17 +227,16 @@ readonly class OvhConnector implements ConnectorInterface
             $authData['consumerKey']
         );
 
-        $supportedTldList = $conn->get('/domain/extensions', [
+        return $conn->get('/domain/extensions', [
             'ovhSubsidiary' => $authData['ovhSubsidiary'],
         ]);
+    }
 
-        /** @var string $tldString */
-        foreach (array_unique(array_map(fn (Tld $tld) => $tld->getTld(), $tldList)) as $tldString) {
-            if (!in_array($tldString, $supportedTldList)) {
-                return false;
-            }
-        }
-
-        return true;
+    /**
+     * @throws InvalidArgumentException
+     */
+    protected function getCachedTldList(): CacheItemInterface
+    {
+        return $this->cacheItemPool->getItem('app.provider.ovh.supported-tld');
     }
 }

src/Controller/ConnectorController.php

@@ -2,7 +2,7 @@
 
 namespace App\Controller;
 
-use App\Config\Connector\ConnectorInterface;
+use App\Config\Provider\AbstractProvider;
 use App\Entity\Connector;
 use App\Entity\User;
 use Doctrine\Common\Collections\Collection;
@@ -70,7 +70,7 @@ class ConnectorController extends AbstractController
             throw new \Exception('Provider not found');
         }
 
-        /** @var ConnectorInterface $connectorProviderClass */
+        /** @var AbstractProvider $connectorProviderClass */
         $connectorProviderClass = $provider->getConnectorProvider();
 
         $authData = $connectorProviderClass::verifyAuthData($connector->getAuthData(), $client);

src/Controller/WatchListController.php

@@ -2,7 +2,7 @@
 
 namespace App\Controller;
 
-use App\Config\Connector\ConnectorInterface;
+use App\Config\Provider\AbstractProvider;
 use App\Config\WebhookScheme;
 use App\Entity\Connector;
 use App\Entity\Domain;
@@ -27,6 +27,7 @@ use Eluceo\iCal\Domain\ValueObject\Timestamp;
 use Eluceo\iCal\Presentation\Component\Property;
 use Eluceo\iCal\Presentation\Component\Property\Value\TextValue;
 use Eluceo\iCal\Presentation\Factory\CalendarFactory;
+use Psr\Cache\CacheItemPoolInterface;
 use Psr\Log\LoggerInterface;
 use Sabre\VObject\EofException;
 use Sabre\VObject\InvalidDataException;
@@ -37,6 +38,7 @@ use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException;
 use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
+use Symfony\Component\HttpKernel\KernelInterface;
 use Symfony\Component\Notifier\Exception\InvalidArgumentException;
 use Symfony\Component\Notifier\Transport\AbstractTransportFactory;
 use Symfony\Component\Notifier\Transport\Dsn;
@@ -50,7 +52,7 @@ class WatchListController extends AbstractController
         private readonly SerializerInterface $serializer,
         private readonly EntityManagerInterface $em,
         private readonly WatchListRepository $watchListRepository,
-        private readonly LoggerInterface $logger, private readonly HttpClientInterface $httpClient
+        private readonly LoggerInterface $logger, private readonly HttpClientInterface $httpClient, private readonly CacheItemPoolInterface $cacheItemPool, private readonly KernelInterface $kernel
     ) {
     }
 
@@ -198,8 +200,8 @@ class WatchListController extends AbstractController
             }
 
             $connectorProviderClass = $connector->getProvider()->getConnectorProvider();
-            /** @var ConnectorInterface $connectorProvider */
-            $connectorProvider = new $connectorProviderClass($connector->getAuthData(), $this->httpClient);
+            /** @var AbstractProvider $connectorProvider */
+            $connectorProvider = new $connectorProviderClass($connector->getAuthData(), $this->httpClient, $this->cacheItemPool, $this->kernel);
 
             $tldList = [];
             /** @var Domain $domain */

src/MessageHandler/ProcessDomainTriggerHandler.php

@@ -2,7 +2,7 @@
 
 namespace App\MessageHandler;
 
-use App\Config\Connector\ConnectorInterface;
+use App\Config\Provider\AbstractProvider;
 use App\Config\TriggerAction;
 use App\Config\WebhookScheme;
 use App\Entity\Domain;
@@ -76,8 +76,8 @@ final readonly class ProcessDomainTriggerHandler
 
                 $connectorProviderClass = $provider->getConnectorProvider();
 
-                /** @var ConnectorInterface $connectorProvider */
-                $connectorProvider = new $connectorProviderClass($connector->getAuthData(), $this->client);
+                /** @var AbstractProvider $connectorProvider */
+                $connectorProvider = new $connectorProviderClass($connector->getAuthData(), $this->client, $this->cacheItemPool, $this->kernel);
 
                 $connectorProvider->orderDomain($domain, $this->kernel->isDebug());