[spiral/auth-http] Adding TokenStorageScope (#931)

CHANGELOG.md

@@ -1,11 +1,15 @@
 # CHANGELOG
 
 ## Unreleased
+- **Medium Impact Changes**
+  - [spiral/scaffolder] Method `baseDirectory` of `Spiral\Scaffolder\Config\ScaffolderConfig` class is deprecated.
 - **Other Features**
+  - Added `Spiral\Auth\TokenStorageScope`, this class can be used to get the concrete implementation of
+    the token storage in a current container scope.
+  - [spiral/auth-http] Added a `Spiral\Auth\TokenStorageInterface` binding in the `Spiral\Auth\Middleware\AuthMiddleware` 
+    with the used TokenStorage.
   - [spiral/scaffolder] Added new public method `declarationDirectory` to the `Spiral\Scaffolder\Config\ScaffolderConfig` 
     class that returns the directory path of the specified declaration, or default directory path if not specified.
-- **Medium Impact Changes**
-  - [spiral/scaffolder] Method `baseDirectory` of `Spiral\Scaffolder\Config\ScaffolderConfig` class is deprecated.
 
 ## 3.7.1 - 2023-04-21
 - **Bug Fixes**

src/Auth/src/TokenStorageInterface.php

@@ -14,7 +14,6 @@ interface TokenStorageInterface
     /**
      * Load token by id, must return null if token not found.
      *
-     *
      * @throws TokenStorageException
      */
     public function load(string $id): ?TokenInterface;
@@ -31,7 +30,6 @@ public function create(array $payload, \DateTimeInterface $expiresAt = null): To
     /**
      * Delete token from the persistent storage.
      *
-     *
      * @throws TokenStorageException
      */
     public function delete(TokenInterface $token): void;

src/AuthHttp/src/Middleware/AuthMiddleware.php

@@ -40,7 +40,10 @@ public function process(Request $request, RequestHandlerInterface $handler): Res
         $authContext = $this->initContext($request, new AuthContext($this->actorProvider, $this->eventDispatcher));
 
         $response = $this->scope->runScope(
-            [AuthContextInterface::class => $authContext],
+            [
+                AuthContextInterface::class => $authContext,
+                TokenStorageInterface::class => $this->tokenStorage,
+            ],
             static fn () => $handler->handle($request->withAttribute(self::ATTRIBUTE, $authContext))
         );
 

src/Framework/Auth/TokenStorageScope.php

@@ -0,0 +1,61 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Spiral\Auth;
+
+use Psr\Container\ContainerInterface;
+use Psr\Container\NotFoundExceptionInterface;
+use Spiral\Auth\Exception\TokenStorageException;
+use Spiral\Core\Container\SingletonInterface;
+use Spiral\Core\Exception\ScopeException;
+
+final class TokenStorageScope implements TokenStorageInterface, SingletonInterface
+{
+    public function __construct(
+        private readonly ContainerInterface $container
+    ) {
+    }
+
+    /**
+     * Load token by id, must return null if token not found.
+     *
+     * @throws TokenStorageException
+     */
+    public function load(string $id): ?TokenInterface
+    {
+        return $this->getTokenStorage()->load($id);
+    }
+
+    /**
+     * Create token based on the payload provided by actor provider.
+     *
+     * @throws TokenStorageException
+     */
+    public function create(array $payload, \DateTimeInterface $expiresAt = null): TokenInterface
+    {
+        return $this->getTokenStorage()->create($payload, $expiresAt);
+    }
+
+    /**
+     * Delete token from the persistent storage.
+     *
+     * @throws TokenStorageException
+     */
+    public function delete(TokenInterface $token): void
+    {
+        $this->getTokenStorage()->delete($token);
+    }
+
+    /**
+     * @throws ScopeException
+     */
+    private function getTokenStorage(): TokenStorageInterface
+    {
+        try {
+            return $this->container->get(TokenStorageInterface::class);
+        } catch (NotFoundExceptionInterface $e) {
+            throw new ScopeException('Unable to resolve token storage, invalid scope', $e->getCode(), $e);
+        }
+    }
+}

tests/Framework/Auth/AuthConfigTest.php → tests/Framework/Auth/Config/AuthConfigTest.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Framework\Auth;
+namespace Framework\Auth\Config;
 
 use Spiral\Auth\Config\AuthConfig;
 use Spiral\Auth\TokenStorageInterface as SessionTokenStorageInterface;

tests/Framework/Auth/TokenStorageScopeTest.php

@@ -0,0 +1,68 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Spiral\Tests\Auth;
+
+use PHPUnit\Framework\TestCase;
+use Spiral\Auth\TokenInterface;
+use Spiral\Auth\TokenStorageInterface;
+use Spiral\Auth\TokenStorageScope;
+use Spiral\Core\Container;
+
+final class TokenStorageScopeTest extends TestCase
+{
+    public function testLoad(): void
+    {
+        $storage = $this->createMock(TokenStorageInterface::class);
+        $storage
+            ->expects($this->once())
+            ->method('load')
+            ->with('foo')
+            ->willReturn($token = $this->createMock(TokenInterface::class));
+
+        $container = new Container();
+        $container->bind(TokenStorageInterface::class, $storage);
+
+        $scope = new TokenStorageScope($container);
+
+        $this->assertSame($token, $scope->load('foo'));
+    }
+
+    public function testCreate(): void
+    {
+        $expiresAt = new \DateTimeImmutable();
+
+        $storage = $this->createMock(TokenStorageInterface::class);
+        $storage
+            ->expects($this->once())
+            ->method('create')
+            ->with(['foo' => 'bar'], $expiresAt)
+            ->willReturn($token = $this->createMock(TokenInterface::class));
+
+        $container = new Container();
+        $container->bind(TokenStorageInterface::class, $storage);
+
+        $scope = new TokenStorageScope($container);
+
+        $this->assertSame($token, $scope->create(['foo' => 'bar'], $expiresAt));
+    }
+
+    public function testDelete(): void
+    {
+        $token = $this->createMock(TokenInterface::class);
+
+        $storage = $this->createMock(TokenStorageInterface::class);
+        $storage
+            ->expects($this->once())
+            ->method('delete')
+            ->with($token);
+
+        $container = new Container();
+        $container->bind(TokenStorageInterface::class, $storage);
+
+        $scope = new TokenStorageScope($container);
+
+        $scope->delete($token);
+    }
+}

tests/Framework/AuthHttp/Middleware/AuthMiddlewareTest.php

@@ -0,0 +1,47 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Spiral\Tests\AuthHttp\Middleware;
+
+use Spiral\Auth\Middleware\AuthMiddleware;
+use Spiral\Auth\TokenStorageInterface;
+use Spiral\Auth\TokenStorageScope;
+use Spiral\Core\Container\Autowire;
+use Spiral\Tests\Framework\HttpTestCase;
+
+final class AuthMiddlewareTest extends HttpTestCase
+{
+    public function setUp(): void
+    {
+        parent::setUp();
+
+        $this->enableMiddlewares();
+    }
+
+    public function testTokenStorageInterfaceShouldBeBound(): void
+    {
+        $storage = $this->createMock(TokenStorageInterface::class);
+        $this->getContainer()->bind(
+            AuthMiddleware::class,
+            new Autowire(AuthMiddleware::class, ['tokenStorage' => $storage])
+        );
+        $this->setHttpHandler(function () use ($storage): void {
+            $scope = $this->getContainer()->get(TokenStorageScope::class);
+            $ref = new \ReflectionMethod($scope, 'getTokenStorage');
+
+            $this->assertInstanceOf($storage::class, $ref->invoke($scope));
+            $this->assertSame($storage, $ref->invoke($scope));
+        });
+
+        $scope = $this->getContainer()->get(TokenStorageScope::class);
+        $ref = new \ReflectionMethod($scope, 'getTokenStorage');
+        $this->assertNotInstanceOf($storage::class, $ref->invoke($scope));
+
+        $this->getHttp()->get('/');
+
+        $scope = $this->getContainer()->get(TokenStorageScope::class);
+        $ref = new \ReflectionMethod($scope, 'getTokenStorage');
+        $this->assertNotInstanceOf($storage::class, $ref->invoke($scope));
+    }
+}