#62 - Mark the classes not meant to be extended @final and the infrastructure classes @internal

CHANGELOG.md

@@ -2,6 +2,7 @@ Latest
 ------
 
 ### Changes
+* [#62](https://github.com/cleverage/rest-process-bundle/issues/62) Define the public API (Symfony BC promise, as [cleverage/process-bundle#279](https://github.com/cleverage/process-bundle/issues/279)): `RequestTask`, `ClientRegistry` and `CleverAgeRestProcessBundle` are marked `@final since 3.3`, they will be `final` in 4.0: extending them triggers a deprecation with the Symfony `DebugClassLoader`. `Client` (extended by the applications) and the exceptions stay open. `CleverAgeRestProcessExtension` and `RegisterClientsPass` are marked `@internal`.
 * [#61](https://github.com/cleverage/rest-process-bundle/issues/61) `CleverAgeRestProcessExtension::findServices()` loads the service definition files with a glob pattern instead of a `Finder` (same files, as [cleverage/process-bundle#271](https://github.com/cleverage/process-bundle/issues/271)), `symfony/finder` is no longer required. Add tests.
 * [#58](https://github.com/cleverage/rest-process-bundle/issues/58) ClientRegistry: the clients are loaded lazily from a service locator indexed by code: a client is only instantiated when a task uses it (an error in a client that a process does not use no longer makes it fail). The code is given by the new `code` attribute of the `cleverage.rest.client` tag, or by the new `#[AsRestClient(code: '...')]` attribute (autoconfiguration); it must be the one returned by `getCode()`. Duplicate or empty codes fail the container compilation. A client tagged without `code` is still registered eagerly, with `ClientRegistry::addClient()`, which is deprecated (the `code` will be required in 4.0). New optional `ClientRegistry` constructor argument (the locator); `ClientRegistry` is autowirable by its class name. Require `symfony/service-contracts`. Update documentation, add tests.
 * [#56](https://github.com/cleverage/rest-process-bundle/issues/56) Require `symfony/polyfill-php83`, `symfony/polyfill-php84` and `symfony/polyfill-php85` ([cleverage/process-bundle#299](https://github.com/cleverage/process-bundle/issues/299)): the functions of PHP 8.3 to 8.5 can be used while supporting PHP 8.2. Rector targets PHP 8.2 (`withPhpVersion()`, `withPhpSets()` read from `composer.json`) and applies the rules using a newer function when its polyfill is required (no change needed in the current code).

src/CleverAgeRestProcessBundle.php

@@ -17,6 +17,9 @@
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\HttpKernel\Bundle\Bundle;
 
+/**
+ * @final since 3.3
+ */
 class CleverAgeRestProcessBundle extends Bundle
 {
     /**

src/DependencyInjection/CleverAgeRestProcessExtension.php

@@ -20,6 +20,9 @@
 use Symfony\Component\DependencyInjection\Extension\Extension;
 use Symfony\Component\DependencyInjection\Loader\YamlFileLoader;
 
+/**
+ * @internal
+ */
 class CleverAgeRestProcessExtension extends Extension
 {
     public function load(array $configs, ContainerBuilder $container): void

src/DependencyInjection/Compiler/RegisterClientsPass.php

@@ -22,6 +22,8 @@
 /**
  * Registers the `cleverage.rest.client` tagged services in the client registry: in a service locator indexed by the
  * `code` attribute of the tag (lazy), or, without `code` (deprecated), with an addClient() call (eager).
+ *
+ * @internal
  */
 class RegisterClientsPass implements CompilerPassInterface
 {

src/Registry/ClientRegistry.php

@@ -23,6 +23,8 @@
  * The client services are fetched lazily from a service locator indexed by code (`code` attribute of the
  * `cleverage.rest.client` tag, or `#[AsRestClient]`, see RegisterClientsPass): a client is only instantiated when it
  * is used.
+ *
+ * @final since 3.3
  */
 class ClientRegistry
 {

src/Task/RequestTask.php

@@ -50,6 +50,8 @@
  *      'expects': string,
  *      'data': array<mixed>|string|null
  * }
+ *
+ * @final since 3.3
  */
 class RequestTask extends AbstractConfigurableTask
 {