feat: enforce service configuration to avoid bundle coupling

Author: edumarques

README.md

@@ -30,25 +30,17 @@ configuration.
 
 ## Configuration
 
-**Note: this is an optional step. By default, the bundle assumes _DynamoDBClient_ and _Marshaler_ services are already
-registered in the application DI container.**
-
-After installation, you can configure the bundle by creating a `dynamo_php.yaml` file in your `config/packages/`
+After installation, you must configure the bundle by creating a `dynamo_php.yaml` file in your `config/packages/`
 directory:
 
 ```yaml
 # config/packages/dynamo_php.yaml
 dynamo_php:
-  client:
-    region: 'us-east-1'
-    version: 'latest'
-    # Add DynamoDB client configuration options here
-  marshaler:
-  # Add Marshaler configuration options here
+  client: dynamodb_client # set the service ID of the AWS DynamoDB client registered in your app
+  marshaler: marshaler # set the service ID of the AWS Marshaler registered in your app
+  serializer: serializer # set the service ID of the Symfony serializer registered in your app
 ```
 
-Adjust the client and marshaler settings according to your AWS DynamoDB setup and application requirements.
-
 ## Usage
 
 Once configured, you can inject DynamoPHP services into your Symfony services or controllers. For example, to use the

phpcs.xml

@@ -25,6 +25,7 @@
   <rule ref="SlevomatCodingStandard.Namespaces.AlphabeticallySortedUses"/>
   <rule ref="SlevomatCodingStandard.Namespaces.ReferenceUsedNamesOnly"/>
   <rule ref="SlevomatCodingStandard.Namespaces.UseDoesNotStartWithBackslash"/>
+  <rule ref="SlevomatCodingStandard.Namespaces.UnusedUses"/>
 
   <rule ref="SlevomatCodingStandard.Arrays.TrailingArrayComma"/>
 

sandbox/config/packages/dynamo_php.yaml

@@ -1,3 +1,4 @@
 dynamo_php:
-  client:
-    region: eu-central-1
+  client: Aws\DynamoDb\DynamoDbClient
+  marshaler: Aws\DynamoDb\Marshaler
+  serializer: Symfony\Component\Serializer\SerializerInterface

sandbox/config/services.yaml

@@ -9,3 +9,10 @@ services:
         resource: '../src/'
         exclude:
             - '../src/Kernel.php'
+
+    Aws\DynamoDb\Marshaler:
+
+    Aws\DynamoDb\DynamoDbClient:
+        arguments:
+            $args:
+                region: eu-central-1

src/DynamoPHPBundle.php

@@ -4,8 +4,6 @@
 
 namespace EduardoMarques\DynamoPHPBundle;
 
-use Aws\DynamoDb\DynamoDbClient;
-use Aws\DynamoDb\Marshaler;
 use EduardoMarques\DynamoPHP\Metadata\MetadataLoader;
 use EduardoMarques\DynamoPHP\ODM\EntityManager;
 use EduardoMarques\DynamoPHP\ODM\OpArgsBuilder;
@@ -15,6 +13,7 @@
 use Symfony\Component\Config\Definition\Configurator\DefinitionConfigurator;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
+use Symfony\Component\DependencyInjection\Loader\Configurator\ReferenceConfigurator;
 use Symfony\Component\HttpKernel\Bundle\AbstractBundle;
 
 final class DynamoPHPBundle extends AbstractBundle
@@ -27,8 +26,18 @@ public function configure(DefinitionConfigurator $definition): void
         /** @phpstan-ignore-next-line */
         $definition->rootNode()
             ->children()
-            ->variableNode('client')->end()
-            ->variableNode('marshaler')->end()
+                ->scalarNode('client')->info('Service ID of the AWS DynamoDB client to use')
+                    ->isRequired()
+                    ->cannotBeEmpty()
+                ->end()
+                ->scalarNode('marshaler')->info('Service ID of the AWS Marshaler to use')
+                    ->isRequired()
+                    ->cannotBeEmpty()
+                ->end()
+                ->scalarNode('serializer')->info('Service ID of the Symfony Serializer to use')
+                    ->isRequired()
+                    ->cannotBeEmpty()
+                ->end()
             ->end();
     }
 
@@ -38,53 +47,48 @@ public function configure(DefinitionConfigurator $definition): void
      */
     public function loadExtension(array $config, ContainerConfigurator $container, ContainerBuilder $builder): void
     {
-        $services = $container->services();
-
-        if (
-            false === $builder->hasDefinition(DynamoDbClient::class)
-            && false === $builder->hasAlias(DynamoDbClient::class)
-        ) {
-            $services->set(DynamoDbClient::class)
-                ->factory([DynamoDbClient::class, 'factory'])
-                ->arg(0, $config['client'] ?? [])
-                ->public();
-        }
+        $clientId = $config['client'];
+        $marshalerId = $config['marshaler'];
+        $serializerId = $config['serializer'];
 
-        if (
-            false === $builder->hasDefinition(Marshaler::class)
-            && false === $builder->hasAlias(Marshaler::class)
-        ) {
-            $services->set(Marshaler::class)
-                ->arg(0, $config['marshaler'] ?? [])
-                ->public();
-        }
+        $services = $container->services();
 
-        $services->set(MetadataLoader::class)
-            ->autowire()
-            ->autoconfigure()
-            ->private();
+        $services->set(MetadataLoader::class)->autowire()->autoconfigure()->private();
 
         $services->set(EntityNormalizer::class)
+            ->arg('$metadataLoader', new ReferenceConfigurator(MetadataLoader::class))
+            ->arg('$normalizer', new ReferenceConfigurator($serializerId))
             ->autowire()
             ->autoconfigure()
-            ->public();
+            ->private();
 
         $services->set(EntityDenormalizer::class)
+            ->arg('$metadataLoader', new ReferenceConfigurator(MetadataLoader::class))
+            ->arg('$denormalizer', new ReferenceConfigurator($serializerId))
             ->autowire()
             ->autoconfigure()
-            ->public();
+            ->private();
 
         $services->set(EntitySerializer::class)
+            ->arg('$entityNormalizer', new ReferenceConfigurator(EntityNormalizer::class))
+            ->arg('$entityDenormalizer', new ReferenceConfigurator(EntityDenormalizer::class))
+            ->arg('$marshaler', new ReferenceConfigurator($marshalerId))
             ->autowire()
             ->autoconfigure()
             ->public();
 
         $services->set(OpArgsBuilder::class)
+            ->arg('$normalizer', new ReferenceConfigurator($serializerId))
+            ->arg('$marshaler', new ReferenceConfigurator($marshalerId))
             ->autowire()
             ->autoconfigure()
             ->public();
 
         $services->set(EntityManager::class)
+            ->arg('$dynamoDbClient', new ReferenceConfigurator($clientId))
+            ->arg('$metadataLoader', new ReferenceConfigurator(MetadataLoader::class))
+            ->arg('$entitySerializer', new ReferenceConfigurator(EntitySerializer::class))
+            ->arg('$opArgsBuilder', new ReferenceConfigurator(OpArgsBuilder::class))
             ->autowire()
             ->autoconfigure()
             ->public();