2.0 Proposal

.github/workflows/run-tests.yml

@@ -9,40 +9,18 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        php: ['7.4', '8.0', '8.1', '8.2']
-        symfony: ['4.4.*', '5.4.*', '6.0.*', '6.1.*', '6.2.*', '6.3.*', '6.4.*', '7.0.*']
+        php: ['8.1', '8.2']
+        symfony: ['5.4.*', '6.4.*', '7.0.*']
         composer-flags: ['--prefer-stable']
         can-fail: [false]
         extensions: ['curl, iconv, mbstring, mongodb, pdo, pdo_sqlite, sqlite, zip']
         include:
-          - php: '7.4'
-            symfony: '4.4.*'
+          - php: '8.1'
+            symfony: '5.4.*'
             composer-flags: '--prefer-stable --prefer-lowest'
             can-fail: false
             extensions: 'curl, iconv, mbstring, mongodb, pdo, pdo_sqlite, sqlite, zip'
         exclude:
-          - php: '7.4'
-            symfony: '6.0.*'
-          - php: '7.4'
-            symfony: '6.1.*'
-          - php: '7.4'
-            symfony: '6.2.*'
-          - php: '7.4'
-            symfony: '6.3.*'
-          - php: '7.4'
-            symfony: '6.4.*'
-          - php: '7.4'
-            symfony: '7.0.*'
-          - php: '8.0'
-            symfony: '6.1.*'
-          - php: '8.0'
-            symfony: '6.2.*'
-          - php: '8.0'
-            symfony: '6.3.*'
-          - php: '8.0'
-            symfony: '6.4.*'
-          - php: '8.0'
-            symfony: '7.0.*'
           - php: '8.1'
             symfony: '7.0.*'
 
@@ -73,10 +51,6 @@ jobs:
           version: '5.0'
           topology: server
 
-      - name: Remove Guard (Symfony >=6.0)
-        if: contains(fromJSON('["6.0.*", "6.1.*", "6.2.*", "6.3.*", "6.4.*", "7.0.*"]'), matrix.symfony)
-        run: composer remove --dev --no-update symfony/security-guard
-
       - name: Install dependencies
         run: composer update ${{ matrix.composer-flags }} --prefer-dist --no-suggest
         env:

Command/ClearInvalidRefreshTokensCommand.php

@@ -21,13 +21,8 @@
 use Symfony\Component\Console\Style\SymfonyStyle;
 
 #[AsCommand(name: 'gesdinet:jwt:clear', description: 'Clear invalid refresh tokens.')]
-class ClearInvalidRefreshTokensCommand extends Command
+final class ClearInvalidRefreshTokensCommand extends Command
 {
-    /**
-     * @deprecated
-     */
-    protected static $defaultName = 'gesdinet:jwt:clear';
-
     private RefreshTokenManagerInterface $refreshTokenManager;
 
     public function __construct(RefreshTokenManagerInterface $refreshTokenManager)
@@ -39,23 +34,14 @@ public function __construct(RefreshTokenManagerInterface $refreshTokenManager)
 
     protected function configure(): void
     {
-        $this
-            ->setDescription('Clear invalid refresh tokens.')
-            ->addArgument('datetime', InputArgument::OPTIONAL, 'An optional date, all tokens before this date will be removed; the value should be able to be parsed by DateTime.');
+        $this->addArgument('datetime', InputArgument::OPTIONAL, 'An optional date, all tokens before this date will be removed; the value should be able to be parsed by DateTime.', 'now');
     }
 
     protected function execute(InputInterface $input, OutputInterface $output): int
     {
         $io = new SymfonyStyle($input, $output);
 
-        /** @var string|null $datetime */
-        $datetime = $input->getArgument('datetime');
-
-        if (null === $datetime) {
-            $datetime = new \DateTime();
-        } else {
-            $datetime = new \DateTime($datetime);
-        }
+        $datetime = new \DateTime($input->getArgument('datetime'));
 
         $revokedTokens = $this->refreshTokenManager->revokeAllInvalid($datetime);
 

Command/RevokeRefreshTokenCommand.php

@@ -19,14 +19,9 @@
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\Console\Style\SymfonyStyle;
 
-#[AsCommand(name: 'gesdinet:jwt:revoke', description: 'Revoke a refresh token')]
-class RevokeRefreshTokenCommand extends Command
+#[AsCommand(name: 'gesdinet:jwt:revoke', description: 'Revoke a refresh token.')]
+final class RevokeRefreshTokenCommand extends Command
 {
-    /**
-     * @deprecated
-     */
-    protected static $defaultName = 'gesdinet:jwt:revoke';
-
     private RefreshTokenManagerInterface $refreshTokenManager;
 
     public function __construct(RefreshTokenManagerInterface $refreshTokenManager)
@@ -38,9 +33,7 @@ public function __construct(RefreshTokenManagerInterface $refreshTokenManager)
 
     protected function configure(): void
     {
-        $this
-            ->setDescription('Revoke a refresh token')
-            ->addArgument('refresh_token', InputArgument::REQUIRED, 'The refresh token to revoke');
+        $this->addArgument('refresh_token', InputArgument::REQUIRED, 'The refresh token to revoke');
     }
 
     protected function execute(InputInterface $input, OutputInterface $output): int

DependencyInjection/Compiler/AddExtractorsToChainCompilerPass.php

@@ -12,11 +12,11 @@ final class AddExtractorsToChainCompilerPass implements CompilerPassInterface
 
     public function process(ContainerBuilder $container): void
     {
-        if (!$container->hasDefinition('gesdinet.jwtrefreshtoken.request.extractor.chain')) {
+        if (!$container->hasDefinition('gesdinet_jwt_refresh_token.request.extractor.chain')) {
             return;
         }
 
-        $definition = $container->getDefinition('gesdinet.jwtrefreshtoken.request.extractor.chain');
+        $definition = $container->getDefinition('gesdinet_jwt_refresh_token.request.extractor.chain');
 
         foreach ($this->findAndSortTaggedServices('gesdinet_jwt_refresh_token.request_extractor', $container) as $extractorService) {
             $definition->addMethodCall('addExtractor', [$extractorService]);

DependencyInjection/Configuration.php

@@ -11,12 +11,11 @@
 
 namespace Gesdinet\JWTRefreshTokenBundle\DependencyInjection;
 
-use Gesdinet\JWTRefreshTokenBundle\Entity\RefreshToken;
-use Symfony\Component\Config\Definition\BaseNode;
+use Gesdinet\JWTRefreshTokenBundle\Model\RefreshTokenInterface;
 use Symfony\Component\Config\Definition\Builder\TreeBuilder;
 use Symfony\Component\Config\Definition\ConfigurationInterface;
 
-class Configuration implements ConfigurationInterface
+final class Configuration implements ConfigurationInterface
 {
     public function getConfigTreeBuilder(): TreeBuilder
     {
@@ -33,54 +32,23 @@ public function getConfigTreeBuilder(): TreeBuilder
                     ->defaultFalse()
                     ->info('The default update TTL flag for all authenticators.')
                 ->end()
-                ->scalarNode('firewall')
-                    ->setDeprecated(...$this->getDeprecationParameters('The "%node%" node is deprecated without replacement.', '1.0'))
-                    ->defaultValue('api')
-                ->end()
-                ->scalarNode('user_provider')
-                    ->setDeprecated(...$this->getDeprecationParameters('The "%node%" node is deprecated without replacement.', '1.0'))
-                    ->defaultNull()
-                ->end()
-                ->scalarNode('user_identity_field')
-                    ->setDeprecated(...$this->getDeprecationParameters('The "%node%" node is deprecated without replacement.', '1.0'))
-                    ->defaultValue('username')
-                ->end()
                 ->scalarNode('manager_type')
                     ->defaultValue('orm')
                     ->info('Set the type of object manager to use (default: orm)')
                 ->end()
                 ->scalarNode('refresh_token_class')
-                    ->defaultNull()
-                    ->info(sprintf('Set the refresh token class to use (default: %s)', RefreshToken::class))
+                    ->isRequired()
+                    ->cannotBeEmpty()
+                    ->info('Set the refresh token class to use')
                     ->validate()
-                        ->ifTrue(static fn ($v): bool => null === $v)
-                        ->then(static function () {
-                            trigger_deprecation(
-                                'gesdinet/jwt-refresh-token-bundle',
-                                '1.1',
-                                'Not setting the "refresh_token_class" option is deprecated, as of 2.0 a class must be set.'
-                            );
-                        })
+                        ->ifTrue(static fn ($v): bool => null === $v || !\in_array(RefreshTokenInterface::class, class_implements($v), true))
+                        ->thenInvalid(sprintf('The "refresh_token_class" class must implement "%s".', RefreshTokenInterface::class))
                     ->end()
                 ->end()
                 ->scalarNode('object_manager')
                     ->defaultNull()
                     ->info('Set the object manager to use (default: doctrine.orm.entity_manager)')
                 ->end()
-                ->scalarNode('user_checker')
-                    ->setDeprecated(...$this->getDeprecationParameters('The "%node%" node is deprecated without replacement.', '1.0'))
-                    ->defaultValue('security.user_checker')
-                ->end()
-                ->scalarNode('refresh_token_entity')
-                    ->setDeprecated(...$this->getDeprecationParameters('The "%node%" node is deprecated, use the "refresh_token_class" node instead.', '0.5'))
-                    ->defaultNull()
-                    ->info(sprintf('Set the refresh token class to use (default: %s)', RefreshToken::class))
-                ->end()
-                ->scalarNode('entity_manager')
-                    ->setDeprecated(...$this->getDeprecationParameters('The "%node%" node is deprecated, use the "object_manager" node instead.', '0.5'))
-                    ->defaultNull()
-                    ->info('Set the entity manager to use')
-                ->end()
                 ->scalarNode('single_use')
                     ->defaultFalse()
                     ->info('When true, generate a new refresh token on consumption (deleting the old one)')
@@ -89,11 +57,6 @@ public function getConfigTreeBuilder(): TreeBuilder
                     ->defaultValue('refresh_token')
                     ->info('The default request parameter name containing the refresh token for all authenticators.')
                 ->end()
-                ->booleanNode('doctrine_mappings')
-                    ->setDeprecated(...$this->getDeprecationParameters('The "%node%" node is deprecated without replacement.', '1.0'))
-                    ->info('When true, resolving of Doctrine mapping is done automatically to use either ORM or ODM object manager')
-                    ->defaultTrue()
-                ->end()
                 ->arrayNode('cookie')
                     ->canBeEnabled()
                     ->children()
@@ -109,10 +72,6 @@ public function getConfigTreeBuilder(): TreeBuilder
                         ->scalarNode('remove_token_from_body')->defaultTrue()->end()
                     ->end()
                 ->end()
-                ->scalarNode('logout_firewall')
-                    ->defaultValue('api')
-                    ->info('Name of the firewall that triggers the logout event to hook into (default: api)')
-                ->end()
                 ->scalarNode('return_expiration')
                     ->defaultFalse()
                     ->info('When true, the response will include the token expiration timestamp')
@@ -125,13 +84,4 @@ public function getConfigTreeBuilder(): TreeBuilder
 
         return $treeBuilder;
     }
-
-    private function getDeprecationParameters(string $message, string $version): array
-    {
-        if (method_exists(BaseNode::class, 'getDeprecation')) {
-            return ['gesdinet/jwt-refresh-token-bundle', $version, $message];
-        }
-
-        return [$message];
-    }
 }