feature #217 Rename NullUser to ClientCredentialsUser (ajgarlag)

This PR was squashed before being merged into the 0.9-dev branch.

Discussion
----------

Rename `NullUser` to `ClientCredentialsUser`

This class represents an access token obtained using the client
credentials grant.

It's a BC change.

Commits
-------

980d1f8 Bump branch alias (BC change)
7bf2105 Rename `NullUser` to `ClientCredentialsUser`

Author: chalasr

composer.json

@@ -47,7 +47,7 @@
     },
     "extra": {
         "branch-alias": {
-            "dev-master": "0.9-dev"
+            "dev-master": "0.10-dev"
         }
     },
     "minimum-stability": "dev"

src/Security/Authenticator/OAuth2Authenticator.php

@@ -8,7 +8,7 @@
 use League\Bundle\OAuth2ServerBundle\Security\Exception\OAuth2AuthenticationException;
 use League\Bundle\OAuth2ServerBundle\Security\Exception\OAuth2AuthenticationFailedException;
 use League\Bundle\OAuth2ServerBundle\Security\Passport\Badge\ScopeBadge;
-use League\Bundle\OAuth2ServerBundle\Security\User\NullUser;
+use League\Bundle\OAuth2ServerBundle\Security\User\ClientCredentialsUser;
 use League\OAuth2\Server\Exception\OAuthServerException;
 use League\OAuth2\Server\ResourceServer;
 use Symfony\Bridge\PsrHttpMessage\HttpMessageFactoryInterface;
@@ -89,7 +89,7 @@ public function doAuthenticate(Request $request) /* : Passport */
         /** @psalm-suppress MixedInferredReturnType */
         $userLoader = function (string $userIdentifier) use ($oauthClientId): UserInterface {
             if ('' === $userIdentifier || $oauthClientId === $userIdentifier) {
-                return new NullUser();
+                return new ClientCredentialsUser($oauthClientId);
             }
             if (!method_exists($this->userProvider, 'loadUserByIdentifier')) {
                 /**

src/Security/User/NullUser.php renamed to src/Security/User/ClientCredentialsUser.php

@@ -11,19 +11,29 @@
  *
  * @author Mathias Arlaud <mathias.arlaud@gmail.com>
  */
-final class NullUser implements UserInterface
+final class ClientCredentialsUser implements UserInterface
 {
+    private string $clientId;
+
+    /**
+     * @param non-empty-string $clientId
+     */
+    public function __construct(string $clientId)
+    {
+        $this->clientId = $clientId;
+    }
+
     /**
      * @psalm-mutation-free
      */
     public function getUsername(): string
     {
-        return '';
+        return $this->getUserIdentifier();
     }
 
     public function getUserIdentifier(): string
     {
-        return '';
+        return $this->clientId;
     }
 
     /**

tests/Fixtures/SecurityTestController.php

@@ -4,7 +4,7 @@
 
 namespace League\Bundle\OAuth2ServerBundle\Tests\Fixtures;
 
-use League\Bundle\OAuth2ServerBundle\Security\User\NullUser;
+use League\Bundle\OAuth2ServerBundle\Security\User\ClientCredentialsUser;
 use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface;
@@ -28,7 +28,7 @@ public function helloAction(): Response
         $user = $this->getUser();
 
         return new Response(
-            \sprintf('Hello, %s', null === $user || $user instanceof NullUser ? 'guest' : (method_exists($user, 'getUserIdentifier') ? $user->getUserIdentifier() : $user->getUsername()))
+            \sprintf('Hello, %s', null === $user || $user instanceof ClientCredentialsUser ? 'guest' : (method_exists($user, 'getUserIdentifier') ? $user->getUserIdentifier() : $user->getUsername()))
         );
     }
 

tests/Unit/OAuth2AuthenticatorTest.php

@@ -7,7 +7,7 @@
 use League\Bundle\OAuth2ServerBundle\Security\Authenticator\OAuth2Authenticator;
 use League\Bundle\OAuth2ServerBundle\Security\Exception\OAuth2AuthenticationFailedException;
 use League\Bundle\OAuth2ServerBundle\Security\Passport\Badge\ScopeBadge;
-use League\Bundle\OAuth2ServerBundle\Security\User\NullUser;
+use League\Bundle\OAuth2ServerBundle\Security\User\ClientCredentialsUser;
 use League\OAuth2\Server\Exception\OAuthServerException;
 use League\OAuth2\Server\ResourceServer;
 use Nyholm\Psr7\ServerRequest;
@@ -93,7 +93,7 @@ public function testAuthenticateCreatePassport(): void
         $passport->getUser();
     }
 
-    public function testAuthenticateCreatePassportWithNullUser(): void
+    public function testAuthenticateCreatePassportWithClientCredentialsUser(): void
     {
         $serverRequest = (new ServerRequest('GET', '/foo'))
             ->withAttribute('oauth_access_token_id', 'accessTokenId')
@@ -127,7 +127,7 @@ public function testAuthenticateCreatePassportWithNullUser(): void
         /** @var Passport $passport */
         $passport = $authenticator->authenticate(new Request());
 
-        $this->assertInstanceOf(NullUser::class, $passport->getUser());
+        $this->assertInstanceOf(ClientCredentialsUser::class, $passport->getUser());
     }
 
     /**
@@ -140,10 +140,10 @@ public function testCreateAuthenticatedToken(): void
         }
 
         if (!class_exists(UserBadge::class)) {
-            $userBadge = new NullUser();
+            $userBadge = new ClientCredentialsUser('oauthClientId');
         } else {
-            $userBadge = new UserBadge('userIdentifier', static function (): UserInterface {
-                return new NullUser();
+            $userBadge = new UserBadge('oauthClientId', static function (): UserInterface {
+                return new ClientCredentialsUser('oauthClientId');
             });
         }
 
@@ -164,7 +164,8 @@ public function testCreateAuthenticatedToken(): void
 
         $this->assertSame(['scope_one', 'scope_two'], $token->getScopes());
         $this->assertSame('accessTokenId', $token->getCredentials());
-        $this->assertInstanceOf(NullUser::class, $token->getUser());
+        $this->assertInstanceOf(ClientCredentialsUser::class, $token->getUser());
+        $this->assertSame('oauthClientId', $token->getUser()->getUserIdentifier());
         $this->assertTrue($token->isAuthenticated());
     }
 
@@ -175,7 +176,7 @@ public function testCreateToken(): void
         }
 
         $userBadge = new UserBadge('userIdentifier', static function (): UserInterface {
-            return new NullUser();
+            return new ClientCredentialsUser('client_one');
         });
 
         $passport = new SelfValidatingPassport($userBadge, [
@@ -194,7 +195,8 @@ public function testCreateToken(): void
 
         $this->assertSame(['scope_one', 'scope_two'], $token->getScopes());
         $this->assertSame('accessTokenId', $token->getCredentials());
-        $this->assertInstanceOf(NullUser::class, $token->getUser());
+        $this->assertInstanceOf(ClientCredentialsUser::class, $token->getUser());
+        $this->assertSame('client_one', $token->getUser()->getUserIdentifier());
     }
 }