fix: lint and static analysis

SimonVanacco · SimonVanacco · commit ba183bf36178 · 2025-03-25T21:25:01.000+01:00
diff --git a/src/Controller/DeviceCodeController.php b/src/Controller/DeviceCodeController.php
@@ -4,19 +4,13 @@
 
 namespace League\Bundle\OAuth2ServerBundle\Controller;
 
-use League\Bundle\OAuth2ServerBundle\Converter\UserConverterInterface;
-use League\Bundle\OAuth2ServerBundle\Event\AuthorizationRequestResolveEventFactory;
-use League\Bundle\OAuth2ServerBundle\Manager\ClientManagerInterface;
-use League\Bundle\OAuth2ServerBundle\Model\AbstractClient;
-use League\Bundle\OAuth2ServerBundle\OAuth2Events;
 use League\OAuth2\Server\AuthorizationServer;
 use League\OAuth2\Server\Exception\OAuthServerException;
 use Psr\Http\Message\ResponseFactoryInterface;
 use Symfony\Bridge\PsrHttpMessage\HttpFoundationFactoryInterface;
 use Symfony\Bridge\PsrHttpMessage\HttpMessageFactoryInterface;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
-use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
 
 final class DeviceCodeController
 {
@@ -25,26 +19,6 @@ final class DeviceCodeController
      */
     private $server;
 
-    /**
-     * @var EventDispatcherInterface
-     */
-    private $eventDispatcher;
-
-    /**
-     * @var AuthorizationRequestResolveEventFactory
-     */
-    private $eventFactory;
-
-    /**
-     * @var UserConverterInterface
-     */
-    private $userConverter;
-
-    /**
-     * @var ClientManagerInterface
-     */
-    private $clientManager;
-
     /**
      * @var HttpMessageFactoryInterface
      */
@@ -62,19 +36,11 @@ final class DeviceCodeController
 
     public function __construct(
         AuthorizationServer $server,
-        EventDispatcherInterface $eventDispatcher,
-        AuthorizationRequestResolveEventFactory $eventFactory,
-        UserConverterInterface $userConverter,
-        ClientManagerInterface $clientManager,
         HttpMessageFactoryInterface $httpMessageFactory,
         HttpFoundationFactoryInterface $httpFoundationFactory,
         ResponseFactoryInterface $responseFactory,
     ) {
         $this->server = $server;
-        $this->eventDispatcher = $eventDispatcher;
-        $this->eventFactory = $eventFactory;
-        $this->userConverter = $userConverter;
-        $this->clientManager = $clientManager;
         $this->httpMessageFactory = $httpMessageFactory;
         $this->httpFoundationFactory = $httpFoundationFactory;
         $this->responseFactory = $responseFactory;
diff --git a/src/Entity/DeviceCode.php b/src/Entity/DeviceCode.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace League\Bundle\OAuth2ServerBundle\Entity;
 
 use League\OAuth2\Server\Entities\DeviceCodeEntityInterface;
diff --git a/src/Manager/Doctrine/DeviceCodeManager.php b/src/Manager/Doctrine/DeviceCodeManager.php
@@ -28,7 +28,7 @@ public function find(string $identifier): ?DeviceCodeInterface
 
     public function findByUserCode(string $code): ?DeviceCodeInterface
     {
-        /** @var DeviceCodeInterface */
+        /** @var ?DeviceCodeInterface */
         return $this->entityManager->createQueryBuilder()
                                    ->select('dc')
                                    ->from(DeviceCode::class, 'dc')
@@ -43,6 +43,7 @@ public function save(DeviceCodeInterface $deviceCode, bool $persist = true): voi
         if ($persist) {
             $this->entityManager->persist($deviceCode);
         }
+
         $this->entityManager->flush();
     }
 
@@ -56,5 +57,4 @@ public function clearExpired(): int
             ->getQuery()
             ->execute();
     }
-
 }
diff --git a/src/Manager/InMemory/DeviceCodeManager.php b/src/Manager/InMemory/DeviceCodeManager.php
@@ -46,5 +46,4 @@ public function clearExpired(): int
 
         return $count - \count($this->deviceCodes);
     }
-
 }
diff --git a/src/Model/DeviceCode.php b/src/Model/DeviceCode.php
@@ -9,12 +9,12 @@
 class DeviceCode implements DeviceCodeInterface
 {
     /**
-     * @var string
+     * @var non-empty-string
      */
     private $identifier;
 
     /**
-     * @var \DateTimeInterface
+     * @var \DateTimeImmutable
      */
     private $expiry;
 
@@ -51,15 +51,15 @@ class DeviceCode implements DeviceCodeInterface
     /**
      * @var bool
      */
-    private $includeVerificationUriComplete;
+    private $includeVerificationUriComplete = false;
 
     /**
      * @var string
      */
     private $verificationUri;
 
     /**
-     * @var \DateTimeInterface|null
+     * @var \DateTimeImmutable|null
      */
     private $lastPolledAt;
 
@@ -69,6 +69,7 @@ class DeviceCode implements DeviceCodeInterface
     private $interval;
 
     /**
+     * @param non-empty-string $identifier
      * @param list<Scope> $scopes
      */
     public function __construct(
@@ -79,10 +80,9 @@ public function __construct(
         array $scopes,
         string $userCode,
         bool $userApproved,
-        bool $includeVerificationUriComplete,
         string $verificationUri,
         ?\DateTimeImmutable $lastPolledAt,
-        int $interval
+        int $interval,
     ) {
         $this->identifier = $identifier;
         $this->expiry = $expiry;
@@ -91,7 +91,6 @@ public function __construct(
         $this->scopes = $scopes;
         $this->userCode = $userCode;
         $this->userApproved = $userApproved;
-        $this->includeVerificationUriComplete = $includeVerificationUriComplete;
         $this->verificationUri = $verificationUri;
         $this->lastPolledAt = $lastPolledAt;
         $this->interval = $interval;
@@ -117,7 +116,7 @@ public function getUserIdentifier(): ?string
         return $this->userIdentifier;
     }
 
-    public function setUserIdentifier($userIdentifier): DeviceCodeInterface
+    public function setUserIdentifier(?string $userIdentifier): DeviceCodeInterface
     {
         $this->userIdentifier = $userIdentifier;
 
@@ -189,5 +188,4 @@ public function getInterval(): int
     {
         return $this->interval;
     }
-
 }
diff --git a/src/Model/DeviceCodeInterface.php b/src/Model/DeviceCodeInterface.php
@@ -10,6 +10,9 @@ interface DeviceCodeInterface
 {
     public function __toString(): string;
 
+    /**
+     * @return non-empty-string
+     */
     public function getIdentifier(): string;
 
     public function getExpiry(): \DateTimeImmutable;
@@ -44,5 +47,4 @@ public function getLastPolledAt(): ?\DateTimeImmutable;
     public function setLastPolledAt(\DateTimeImmutable $lastPolledAt): self;
 
     public function getInterval(): int;
-
 }
diff --git a/src/Repository/DeviceCodeRepository.php b/src/Repository/DeviceCodeRepository.php
@@ -42,12 +42,12 @@ public function __construct(
         DeviceCodeManagerInterface $deviceCodeManager,
         ClientManagerInterface $clientManager,
         ScopeConverterInterface $scopeConverter,
-        ClientRepositoryInterface $clientRepository
+        ClientRepositoryInterface $clientRepository,
     ) {
         $this->deviceCodeManager = $deviceCodeManager;
-        $this->clientManager     = $clientManager;
-        $this->scopeConverter    = $scopeConverter;
-        $this->clientRepository  = $clientRepository;
+        $this->clientManager = $clientManager;
+        $this->scopeConverter = $scopeConverter;
+        $this->clientRepository = $clientRepository;
     }
 
     public function getNewDeviceCode(): DeviceCodeEntityInterface
@@ -76,15 +76,15 @@ public function approveDeviceCode(string $userCode, string $userId): void
     {
         $deviceCode = $this->deviceCodeManager->findByUserCode($userCode);
 
-        if ($deviceCode instanceof DeviceCodeInterface === false) {
+        if (false === $deviceCode instanceof DeviceCodeInterface) {
             throw OAuthServerException::invalidRequest('device_code', 'Device code does not exist');
         }
 
         if ($deviceCode->isRevoked()) {
             throw OAuthServerException::invalidRequest('device_code', 'Device code has been revoked');
         }
 
-        if ($userId === '') {
+        if ('' === $userId) {
             throw OAuthServerException::invalidRequest('user_id', 'User ID is required');
         }
 
@@ -134,9 +134,10 @@ private function buildDeviceCodeEntity(DeviceCodeInterface $deviceCode): DeviceC
         $deviceCodeEntity = new DeviceCodeEntity();
         $deviceCodeEntity->setIdentifier($deviceCode->getIdentifier());
         $deviceCodeEntity->setExpiryDateTime($deviceCode->getExpiry());
-        $deviceCodeEntity->setClient(
-            $this->clientRepository->buildClientEntity($deviceCode->getClient())
-        );
+        $client = $this->clientRepository->getClientEntity($deviceCode->getClient()->getIdentifier());
+        if ($client) {
+            $deviceCodeEntity->setClient($client);
+        }
         if ($deviceCode->getUserIdentifier()) {
             $deviceCodeEntity->setUserIdentifier($deviceCode->getUserIdentifier());
         }
@@ -156,7 +157,6 @@ private function buildDeviceCodeEntity(DeviceCodeInterface $deviceCode): DeviceC
         return $deviceCodeEntity;
     }
 
-
     private function buildDeviceCodeModel(DeviceCodeEntityInterface $deviceCodeEntity): DeviceCodeModel
     {
         /** @var AbstractClient $client */
@@ -172,11 +172,9 @@ private function buildDeviceCodeModel(DeviceCodeEntityInterface $deviceCodeEntit
             $this->scopeConverter->toDomainArray(array_values($deviceCodeEntity->getScopes())),
             $deviceCodeEntity->getUserCode(),
             $deviceCodeEntity->getUserApproved(),
-            $deviceCodeEntity->getVerificationUriCompleteInAuthResponse(),
             $deviceCodeEntity->getVerificationUri(),
             $deviceCodeEntity->getLastPolledAt(),
             $deviceCodeEntity->getInterval()
         );
     }
-
 }
diff --git a/src/Resources/config/services.php b/src/Resources/config/services.php
@@ -2,11 +2,6 @@
 
 declare(strict_types=1);
 
-use League\Bundle\OAuth2ServerBundle\Controller\DeviceCodeController;
-use League\Bundle\OAuth2ServerBundle\Manager\DeviceCodeManagerInterface;
-use League\Bundle\OAuth2ServerBundle\Repository\DeviceCodeRepository;
-use League\OAuth2\Server\Grant\DeviceCodeGrant;
-use League\OAuth2\Server\Repositories\DeviceCodeRepositoryInterface;
 use function Symfony\Component\DependencyInjection\Loader\Configurator\abstract_arg;
 use function Symfony\Component\DependencyInjection\Loader\Configurator\param;
 use function Symfony\Component\DependencyInjection\Loader\Configurator\service;
@@ -20,6 +15,7 @@
 use League\Bundle\OAuth2ServerBundle\Command\ListClientsCommand;
 use League\Bundle\OAuth2ServerBundle\Command\UpdateClientCommand;
 use League\Bundle\OAuth2ServerBundle\Controller\AuthorizationController;
+use League\Bundle\OAuth2ServerBundle\Controller\DeviceCodeController;
 use League\Bundle\OAuth2ServerBundle\Controller\TokenController;
 use League\Bundle\OAuth2ServerBundle\Converter\ScopeConverter;
 use League\Bundle\OAuth2ServerBundle\Converter\ScopeConverterInterface;
@@ -30,12 +26,14 @@
 use League\Bundle\OAuth2ServerBundle\Manager\AccessTokenManagerInterface;
 use League\Bundle\OAuth2ServerBundle\Manager\AuthorizationCodeManagerInterface;
 use League\Bundle\OAuth2ServerBundle\Manager\ClientManagerInterface;
+use League\Bundle\OAuth2ServerBundle\Manager\DeviceCodeManagerInterface;
 use League\Bundle\OAuth2ServerBundle\Manager\InMemory\ScopeManager;
 use League\Bundle\OAuth2ServerBundle\Manager\RefreshTokenManagerInterface;
 use League\Bundle\OAuth2ServerBundle\Manager\ScopeManagerInterface;
 use League\Bundle\OAuth2ServerBundle\OAuth2Events;
 use League\Bundle\OAuth2ServerBundle\Repository\AuthCodeRepository;
 use League\Bundle\OAuth2ServerBundle\Repository\ClientRepository;
+use League\Bundle\OAuth2ServerBundle\Repository\DeviceCodeRepository;
 use League\Bundle\OAuth2ServerBundle\Repository\RefreshTokenRepository;
 use League\Bundle\OAuth2ServerBundle\Repository\ScopeRepository;
 use League\Bundle\OAuth2ServerBundle\Repository\UserRepository;
@@ -47,12 +45,14 @@
 use League\OAuth2\Server\EventEmitting\EventEmitter;
 use League\OAuth2\Server\Grant\AuthCodeGrant;
 use League\OAuth2\Server\Grant\ClientCredentialsGrant;
+use League\OAuth2\Server\Grant\DeviceCodeGrant;
 use League\OAuth2\Server\Grant\ImplicitGrant;
 use League\OAuth2\Server\Grant\PasswordGrant;
 use League\OAuth2\Server\Grant\RefreshTokenGrant;
 use League\OAuth2\Server\Repositories\AccessTokenRepositoryInterface;
 use League\OAuth2\Server\Repositories\AuthCodeRepositoryInterface;
 use League\OAuth2\Server\Repositories\ClientRepositoryInterface;
+use League\OAuth2\Server\Repositories\DeviceCodeRepositoryInterface;
 use League\OAuth2\Server\Repositories\RefreshTokenRepositoryInterface;
 use League\OAuth2\Server\Repositories\ScopeRepositoryInterface;
 use League\OAuth2\Server\Repositories\UserRepositoryInterface;
@@ -216,7 +216,7 @@
                 service(RefreshTokenRepositoryInterface::class),
                 null,
                 null,
-                null
+                null,
             ])
         ->alias(DeviceCodeGrant::class, 'league.oauth2_server.grant.device_code')
 
@@ -244,10 +244,6 @@
         ->set('league.oauth2_server.controller.device_code', DeviceCodeController::class)
             ->args([
                 service(AuthorizationServer::class),
-                service(EventDispatcherInterface::class),
-                service(AuthorizationRequestResolveEventFactory::class),
-                service(UserConverterInterface::class),
-                service(ClientManagerInterface::class),
                 service('league.oauth2_server.factory.psr_http'),
                 service('league.oauth2_server.factory.http_foundation'),
                 service('league.oauth2_server.factory.psr17'),
diff --git a/src/Resources/config/storage/doctrine.php b/src/Resources/config/storage/doctrine.php
@@ -2,16 +2,16 @@
 
 declare(strict_types=1);
 
-use League\Bundle\OAuth2ServerBundle\Manager\DeviceCodeManagerInterface;
-use League\Bundle\OAuth2ServerBundle\Manager\Doctrine\DeviceCodeManager;
 use function Symfony\Component\DependencyInjection\Loader\Configurator\service;
 
 use League\Bundle\OAuth2ServerBundle\Manager\AccessTokenManagerInterface;
 use League\Bundle\OAuth2ServerBundle\Manager\AuthorizationCodeManagerInterface;
 use League\Bundle\OAuth2ServerBundle\Manager\ClientManagerInterface;
+use League\Bundle\OAuth2ServerBundle\Manager\DeviceCodeManagerInterface;
 use League\Bundle\OAuth2ServerBundle\Manager\Doctrine\AccessTokenManager;
 use League\Bundle\OAuth2ServerBundle\Manager\Doctrine\AuthorizationCodeManager;
 use League\Bundle\OAuth2ServerBundle\Manager\Doctrine\ClientManager;
+use League\Bundle\OAuth2ServerBundle\Manager\Doctrine\DeviceCodeManager;
 use League\Bundle\OAuth2ServerBundle\Manager\Doctrine\RefreshTokenManager;
 use League\Bundle\OAuth2ServerBundle\Manager\RefreshTokenManagerInterface;
 use League\Bundle\OAuth2ServerBundle\Persistence\Mapping\Driver;
diff --git a/src/Resources/config/storage/in_memory.php b/src/Resources/config/storage/in_memory.php
@@ -2,16 +2,16 @@
 
 declare(strict_types=1);
 
-use League\Bundle\OAuth2ServerBundle\Manager\DeviceCodeManagerInterface;
-use League\Bundle\OAuth2ServerBundle\Manager\InMemory\DeviceCodeManager;
 use function Symfony\Component\DependencyInjection\Loader\Configurator\service;
 
 use League\Bundle\OAuth2ServerBundle\Manager\AccessTokenManagerInterface;
 use League\Bundle\OAuth2ServerBundle\Manager\AuthorizationCodeManagerInterface;
 use League\Bundle\OAuth2ServerBundle\Manager\ClientManagerInterface;
+use League\Bundle\OAuth2ServerBundle\Manager\DeviceCodeManagerInterface;
 use League\Bundle\OAuth2ServerBundle\Manager\InMemory\AccessTokenManager;
 use League\Bundle\OAuth2ServerBundle\Manager\InMemory\AuthorizationCodeManager;
 use League\Bundle\OAuth2ServerBundle\Manager\InMemory\ClientManager;
+use League\Bundle\OAuth2ServerBundle\Manager\InMemory\DeviceCodeManager;
 use League\Bundle\OAuth2ServerBundle\Manager\InMemory\RefreshTokenManager;
 use League\Bundle\OAuth2ServerBundle\Manager\RefreshTokenManagerInterface;
 use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
diff --git a/tests/Acceptance/DeviceCodeEndpointTest.php b/tests/Acceptance/DeviceCodeEndpointTest.php
@@ -64,5 +64,4 @@ public function testFailedWithUnkownClientRequest(): void
         $this->assertNotEmpty($jsonResponse['error_description']);
         $this->assertSame('invalid_client', $jsonResponse['error']);
     }
-
 }
diff --git a/tests/Acceptance/DoctrineCredentialsRevokerTest.php b/tests/Acceptance/DoctrineCredentialsRevokerTest.php
@@ -131,7 +131,6 @@ private function buildDeviceCode(string $identifier, string $modify, Client $cli
             [],
             '',
             false,
-            false,
             '',
             null,
             5
diff --git a/tests/Acceptance/DoctrineDeviceCodeManagerTest.php b/tests/Acceptance/DoctrineDeviceCodeManagerTest.php
diff --git a/tests/Acceptance/TokenEndpointTest.php b/tests/Acceptance/TokenEndpointTest.php
diff --git a/tests/Fixtures/FixtureFactory.php b/tests/Fixtures/FixtureFactory.php
diff --git a/tests/Integration/AbstractIntegrationTest.php b/tests/Integration/AbstractIntegrationTest.php
diff --git a/tests/Integration/DeviceCodeRepositoryTest.php b/tests/Integration/DeviceCodeRepositoryTest.php
diff --git a/tests/Unit/InMemoryDeviceCodeManagerTest.php b/tests/Unit/InMemoryDeviceCodeManagerTest.php

Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,7 @@ public function find(string $identifier): ?DeviceCodeInterface`
`28`	`28`
`29`	`29`	`public function findByUserCode(string $code): ?DeviceCodeInterface`
`30`	`30`	`{`
`31`		`- /** @var DeviceCodeInterface */`
	`31`	`+ /** @var ?DeviceCodeInterface */`
`32`	`32`	`return $this->entityManager->createQueryBuilder()`
`33`	`33`	`->select('dc')`
`34`	`34`	`->from(DeviceCode::class, 'dc')`
`@@ -43,6 +43,7 @@ public function save(DeviceCodeInterface $deviceCode, bool $persist = true): voi`
`43`	`43`	`if ($persist) {`
`44`	`44`	`$this->entityManager->persist($deviceCode);`
`45`	`45`	`}`
	`46`	`+`
`46`	`47`	`$this->entityManager->flush();`
`47`	`48`	`}`
`48`	`49`
`@@ -56,5 +57,4 @@ public function clearExpired(): int`
`56`	`57`	`->getQuery()`
`57`	`58`	`->execute();`
`58`	`59`	`}`
`59`		`-`
`60`	`60`	`}`
Original file line number	Diff line number	Diff line change
`@@ -46,5 +46,4 @@ public function clearExpired(): int`
`46`	`46`
`47`	`47`	`return $count - \count($this->deviceCodes);`
`48`	`48`	`}`
`49`		`-`
`50`	`49`	`}`
Original file line number	Diff line number	Diff line change
`@@ -10,6 +10,9 @@ interface DeviceCodeInterface`
`10`	`10`	`{`
`11`	`11`	`public function __toString(): string;`
`12`	`12`
	`13`	`+ /**`
	`14`	`+ * @return non-empty-string`
	`15`	`+ */`
`13`	`16`	`public function getIdentifier(): string;`
`14`	`17`
`15`	`18`	`public function getExpiry(): \DateTimeImmutable;`
`@@ -44,5 +47,4 @@ public function getLastPolledAt(): ?\DateTimeImmutable;`
`44`	`47`	`public function setLastPolledAt(\DateTimeImmutable $lastPolledAt): self;`
`45`	`48`
`46`	`49`	`public function getInterval(): int;`
`47`		`-`
`48`	`50`	`}`