feat(core): introduce interfaces for the main services

None of the main services of the library was final and none of them had an
interface: they could neither be relied upon as closed, nor be decorated. They
were left open only because the bundle extends them to dispatch events, which is
also why the state of the JWS and JWE builders is protected instead of private.

Every service now implements an interface - JWSBuilderInterface,
JWSVerifierInterface, JWSLoaderInterface, JWEBuilderInterface,
JWEDecrypterInterface, JWELoaderInterface, NestedTokenBuilderInterface,
NestedTokenLoaderInterface, ClaimCheckerManagerInterface and
HeaderCheckerManagerInterface - and the library type-hints those interfaces
internally, so that a decorator can be injected anywhere a service is expected.
Extending the concrete classes is deprecated: they carry the @Final annotation
and their constructor raises a deprecation notice.

The bundle gains a decorator for every event dispatching service and deprecates
the inheritance based ones, which keep their class names, their service ids and
their behaviour. Each service is now also aliased with its interface, so that
"MyInterface $fooJwsBuilder" can be autowired the same way the concrete class
already was.

The event dispatching verifier and decrypter of the bundle used to drop the
callable the loaders pass as a sixth argument to observe the discarded keys, so
the reason of a failure was lost as soon as the bundle services were used. They
forward it now, as the new decorators do.

Author: Florent Morselli

.ci-tools/phpstan-baseline.neon

@@ -7,6 +7,7 @@
 use Jose\Bundle\JoseFramework\DependencyInjection\Source\Source;
 use Jose\Bundle\JoseFramework\Services\ClaimCheckerManager;
 use Jose\Bundle\JoseFramework\Services\ClaimCheckerManagerFactory;
+use Jose\Component\Checker\ClaimCheckerManagerInterface;
 use Override;
 use Symfony\Component\Config\Definition\Builder\NodeDefinition;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
@@ -42,6 +43,11 @@ public function load(array $configs, ContainerBuilder $container): void
                 ClaimCheckerManager::class,
                 $name . 'ClaimCheckerManager'
             );
+            $container->registerAliasForArgument(
+                $service_id,
+                ClaimCheckerManagerInterface::class,
+                $name . 'ClaimCheckerManager'
+            );
         }
     }
 

src/Bundle/DependencyInjection/Source/Checker/ClaimChecker.php

@@ -7,6 +7,7 @@
 use Jose\Bundle\JoseFramework\DependencyInjection\Source\Source;
 use Jose\Bundle\JoseFramework\Services\HeaderCheckerManager;
 use Jose\Bundle\JoseFramework\Services\HeaderCheckerManagerFactory;
+use Jose\Component\Checker\HeaderCheckerManagerInterface;
 use Override;
 use Symfony\Component\Config\Definition\Builder\NodeDefinition;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
@@ -42,6 +43,11 @@ public function load(array $configs, ContainerBuilder $container): void
                 HeaderCheckerManager::class,
                 $name . 'HeaderCheckerManager'
             );
+            $container->registerAliasForArgument(
+                $service_id,
+                HeaderCheckerManagerInterface::class,
+                $name . 'HeaderCheckerManager'
+            );
         }
     }
 

src/Bundle/DependencyInjection/Source/Checker/HeaderChecker.php

@@ -6,6 +6,7 @@
 
 use Jose\Bundle\JoseFramework\Services\JWEBuilderFactory;
 use Jose\Component\Encryption\JWEBuilder as JWEBuilderService;
+use Jose\Component\Encryption\JWEBuilderInterface;
 use Override;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Definition;
@@ -36,6 +37,7 @@ public function load(array $configs, ContainerBuilder $container): void
             }
             $container->setDefinition($service_id, $definition);
             $container->registerAliasForArgument($service_id, JWEBuilderService::class, $name . 'JweBuilder');
+            $container->registerAliasForArgument($service_id, JWEBuilderInterface::class, $name . 'JweBuilder');
         }
     }
 }

src/Bundle/DependencyInjection/Source/Encryption/JWEBuilder.php

@@ -6,6 +6,7 @@
 
 use Jose\Bundle\JoseFramework\Services\JWEDecrypterFactory;
 use Jose\Component\Encryption\JWEDecrypter as JWEDecrypterService;
+use Jose\Component\Encryption\JWEDecrypterInterface;
 use Override;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Definition;
@@ -36,6 +37,7 @@ public function load(array $configs, ContainerBuilder $container): void
             }
             $container->setDefinition($service_id, $definition);
             $container->registerAliasForArgument($service_id, JWEDecrypterService::class, $name . 'JweDecrypter');
+            $container->registerAliasForArgument($service_id, JWEDecrypterInterface::class, $name . 'JweDecrypter');
         }
     }
 }

src/Bundle/DependencyInjection/Source/Encryption/JWEDecrypter.php

@@ -7,6 +7,7 @@
 use Jose\Bundle\JoseFramework\DependencyInjection\Source\Source;
 use Jose\Bundle\JoseFramework\Services\JWELoaderFactory;
 use Jose\Component\Encryption\JWELoader as JWELoaderService;
+use Jose\Component\Encryption\JWELoaderInterface;
 use Override;
 use Symfony\Component\Config\Definition\Builder\NodeDefinition;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
@@ -43,6 +44,7 @@ public function load(array $configs, ContainerBuilder $container): void
 
             $container->setDefinition($service_id, $definition);
             $container->registerAliasForArgument($service_id, JWELoaderService::class, $name . 'JweLoader');
+            $container->registerAliasForArgument($service_id, JWELoaderInterface::class, $name . 'JweLoader');
         }
     }
 

src/Bundle/DependencyInjection/Source/Encryption/JWELoader.php

@@ -7,6 +7,7 @@
 use Jose\Bundle\JoseFramework\DependencyInjection\Source\Source;
 use Jose\Bundle\JoseFramework\Services\NestedTokenBuilderFactory;
 use Jose\Component\NestedToken\NestedTokenBuilder as NestedTokenBuilderService;
+use Jose\Component\NestedToken\NestedTokenBuilderInterface;
 use Override;
 use Symfony\Component\Config\Definition\Builder\NodeDefinition;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
@@ -47,6 +48,11 @@ public function load(array $configs, ContainerBuilder $container): void
                 NestedTokenBuilderService::class,
                 $name . 'NestedTokenBuilder'
             );
+            $container->registerAliasForArgument(
+                $service_id,
+                NestedTokenBuilderInterface::class,
+                $name . 'NestedTokenBuilder'
+            );
         }
     }
 

src/Bundle/DependencyInjection/Source/NestedToken/NestedTokenBuilder.php

@@ -7,6 +7,7 @@
 use Jose\Bundle\JoseFramework\DependencyInjection\Source\Source;
 use Jose\Bundle\JoseFramework\Services\NestedTokenLoaderFactory;
 use Jose\Component\NestedToken\NestedTokenLoader as NestedTokenLoaderService;
+use Jose\Component\NestedToken\NestedTokenLoaderInterface;
 use Override;
 use Symfony\Component\Config\Definition\Builder\NodeDefinition;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
@@ -49,6 +50,11 @@ public function load(array $configs, ContainerBuilder $container): void
                 NestedTokenLoaderService::class,
                 $name . 'NestedTokenLoader'
             );
+            $container->registerAliasForArgument(
+                $service_id,
+                NestedTokenLoaderInterface::class,
+                $name . 'NestedTokenLoader'
+            );
         }
     }
 

src/Bundle/DependencyInjection/Source/NestedToken/NestedTokenLoader.php

@@ -6,6 +6,7 @@
 
 use Jose\Bundle\JoseFramework\Services\JWSBuilderFactory;
 use Jose\Component\Signature\JWSBuilder as JWSBuilderService;
+use Jose\Component\Signature\JWSBuilderInterface;
 use Override;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Definition;
@@ -36,6 +37,7 @@ public function load(array $configs, ContainerBuilder $container): void
             }
             $container->setDefinition($service_id, $definition);
             $container->registerAliasForArgument($service_id, JWSBuilderService::class, $name . 'JwsBuilder');
+            $container->registerAliasForArgument($service_id, JWSBuilderInterface::class, $name . 'JwsBuilder');
         }
     }
 }

src/Bundle/DependencyInjection/Source/Signature/JWSBuilder.php

@@ -7,6 +7,7 @@
 use Jose\Bundle\JoseFramework\DependencyInjection\Source\Source;
 use Jose\Bundle\JoseFramework\Services\JWSLoaderFactory;
 use Jose\Component\Signature\JWSLoader as JWSLoaderService;
+use Jose\Component\Signature\JWSLoaderInterface;
 use Override;
 use Symfony\Component\Config\Definition\Builder\NodeDefinition;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
@@ -43,6 +44,7 @@ public function load(array $configs, ContainerBuilder $container): void
 
             $container->setDefinition($service_id, $definition);
             $container->registerAliasForArgument($service_id, JWSLoaderService::class, $name . 'JwsLoader');
+            $container->registerAliasForArgument($service_id, JWSLoaderInterface::class, $name . 'JwsLoader');
         }
     }