Entities mapping per keyspace (#11)

* Manage group of entities per connection for schema creation process (= multi keyspaces)

* Remove useless isRequired property for new paramater entity_group_prefix_folder

* Fix unit tests for cassandra extension

* Fix unit test

* Add entity_managers configuration parameter under orm

* Add entity_managers orm config parameter to define mapping of entity directories per entityManager which uses a connection (keyspace)

* Replace slash with backslash slash for regexp of entity directory mappings

* Review regexp directory for schema creation process

* Add README section for entityManager

* Fix Checkstyles

* Review checkstyles

* Fix based on reviews

* Fix checkstyle

Author: rminchella-deezer

Cassandra/ORM/EntityManager.php

@@ -23,17 +23,31 @@ class EntityManager implements Session, EntityManagerInterface
     private $repositoryFactory;
     private $schemaManager;
 
+    /** @var array */
+    private $config;
+
     const STATEMENT = 'statement';
     const ARGUMENTS = 'arguments';
 
-    public function __construct(Connection $connection, ClassMetadataFactoryInterface $metadataFactory, LoggerInterface $logger)
-    {
+    /**
+     * @param Connection                    $connection
+     * @param ClassMetadataFactoryInterface $metadataFactory
+     * @param LoggerInterface               $logger
+     * @param array                         $config
+     */
+    public function __construct(
+        Connection $connection,
+        ClassMetadataFactoryInterface $metadataFactory,
+        LoggerInterface $logger,
+        $config = []
+    ) {
         $this->connection = $connection;
         $this->logger = $logger;
         $this->metadataFactory = $metadataFactory;
         $this->schemaManager = new SchemaManager($connection);
         $this->repositoryFactory = new DefaultRepositoryFactory();
         $this->statements = [];
+        $this->config = $config;
     }
 
     public function getConnection()
@@ -56,6 +70,16 @@ public function getLogger()
         return $this->logger;
     }
 
+    public function getTargetedEntityDirectories()
+    {
+        $entityDirectories = [];
+        foreach ($this->config['mappings'] as $type => $mapping) {
+            $entityDirectories[$type] = isset($mapping['dir']) ? $mapping['dir'] : false;
+        }
+
+        return $entityDirectories;
+    }
+
     /**
      * Gets the metadata factory used to gather the metadata of classes.
      *

Cassandra/ORM/EntityManagerInterface.php

@@ -5,4 +5,9 @@
 interface EntityManagerInterface
 {
     public function getConnection();
+
+    /**
+     * @return string
+     */
+    public function getTargetedEntityDirectories();
 }

Cassandra/ORM/Tools/SchemaCreate.php

@@ -16,6 +16,15 @@ public function execute($connection = 'default')
         $em = $this->container->get(sprintf('cassandra.%s_entity_manager', $connection));
         $schemaManager = $em->getSchemaManager();
 
+        $entityDirectoriesRegexp = '/src\/.*Entity\//';
+        $entityDirectories = $em->getTargetedEntityDirectories();
+        if (!empty($entityDirectories)) {
+            $entityDirectories = array_map(function ($entityDirectory) {
+                return str_replace('/', '\/', $entityDirectory);
+            }, $entityDirectories);
+            $entityDirectoriesRegexp = sprintf('/((%s))/', implode(')|(', $entityDirectories));
+        }
+
         // Get all files in src/*/Entity directories
         $path = $this->container->getParameter('kernel.root_dir').'/../src';
         $iterator = new \RegexIterator(
@@ -31,7 +40,7 @@ public function execute($connection = 'default')
             if (!preg_match('(^phar:)i', $sourceFile)) {
                 $sourceFile = realpath($sourceFile);
             }
-            if (preg_match('/src\/.*Entity\//', $sourceFile)) {
+            if (preg_match($entityDirectoriesRegexp, $sourceFile)) {
                 $className = str_replace('/', '\\', preg_replace('/(.*src\/)(.*).php/', '$2', $sourceFile));
                 $metadata = $em->getClassMetadata($className);
                 $tableName = $metadata->table['name'];

DependencyInjection/CassandraExtension.php

@@ -33,12 +33,47 @@ public function load(array $configs, ContainerBuilder $container)
         }
         $this->metadataFactoryLoad($container, $ormConfig);
 
+        $this->validateEntityManagerConfiguration($ormConfig['default_entity_manager'], $ormConfig['entity_managers']);
         foreach ($config['connections'] as $connectionId => $connectionConfig) {
+            $emConfig = $this->getEntityManagerConfiguration(
+                $connectionId,
+                $ormConfig['default_entity_manager'],
+                $ormConfig['entity_managers']
+            );
             $connectionConfig['dispatch_events'] = $config['dispatch_events'];
-            $this->ormLoad($container, $connectionId, $connectionConfig);
+            $this->ormLoad($container, $connectionId, $connectionConfig, $emConfig);
         }
     }
 
+    /**
+     * @param  $defaultEmName
+     * @param  $emConfigs
+     *
+     * @throws \InvalidArgumentException
+     */
+    private function validateEntityManagerConfiguration($defaultEmName, $emConfigs)
+    {
+        if (!isset($emConfigs[$defaultEmName])) {
+            throw new \InvalidArgumentException('Undefined default entity manager in config "orm.entity_managers"');
+        }
+    }
+
+    /**
+     * @param string $connectionId
+     * @param string $defaultEmName
+     * @param array  $emConfigs
+     *
+     * @return array
+     */
+    private function getEntityManagerConfiguration($connectionId, $defaultEmName, $emConfigs)
+    {
+        if (isset($emConfigs[$connectionId])) {
+            return $emConfigs[$connectionId];
+        }
+
+        return $emConfigs[$defaultEmName];
+    }
+
     protected function metadataFactoryLoad(ContainerBuilder $container, array $config)
     {
         $classMetadataFactoryDefinition = $container
@@ -53,7 +88,7 @@ protected function metadataFactoryLoad(ContainerBuilder $container, array $confi
         }
     }
 
-    protected function ormLoad(ContainerBuilder $container, $connectionId, array $config)
+    protected function ormLoad(ContainerBuilder $container, $connectionId, array $config, array $emConfig)
     {
         $class = 'CassandraBundle\\Cassandra\\Connection';
         $definition = new Definition($class);
@@ -72,6 +107,7 @@ protected function ormLoad(ContainerBuilder $container, $connectionId, array $co
             ->addArgument(new Reference(sprintf('cassandra.connection.%s', $connectionId)))
             ->addArgument(new Reference('cassandra.factory.metadata'))
             ->addArgument(new Reference('logger'))
+            ->addArgument($emConfig)
             ->setPublic(true);
     }
 

DependencyInjection/Configuration.php

@@ -2,9 +2,11 @@
 
 namespace CassandraBundle\DependencyInjection;
 
+use CassandraBundle\Cassandra\ORM\EntityManager;
 use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
 use Symfony\Component\Config\Definition\Builder\TreeBuilder;
 use Symfony\Component\Config\Definition\ConfigurationInterface;
+use Symfony\Component\DependencyInjection\Exception\LogicException;
 
 /**
  * This is the class that validates and merges configuration from your app/config files.
@@ -104,6 +106,36 @@ private function addOrmSection(ArrayNodeDefinition $rootNode)
         $rootNode
             ->children()
                 ->arrayNode('orm')
+                    ->beforeNormalization()
+                    ->ifTrue(static function ($v) {
+                        if (!empty($v) && !class_exists(EntityManager::class)) {
+                            throw new LogicException('The cassandra/orm package is required when the cassandra.orm config is set.');
+                        }
+
+                        return null === $v || (\is_array($v) && !\array_key_exists('entity_managers', $v) && !\array_key_exists('entity_manager', $v));
+                    })
+                    ->then(static function ($v) {
+                        $v = (array) $v;
+                        // Key that should not be rewritten to the connection config
+                        $excludedKeys = [
+                            'default_entity_manager' => true,
+                            'mappings' => true,
+                            'metadata_cache_driver' => true,
+                        ];
+                        $entityManager = [];
+                        foreach ($v as $key => $value) {
+                            if (isset($excludedKeys[$key])) {
+                                continue;
+                            }
+                            $entityManager[$key] = $v[$key];
+                            unset($v[$key]);
+                        }
+                        $v['default_entity_manager'] = isset($v['default_entity_manager']) ? (string) $v['default_entity_manager'] : 'default';
+                        $v['entity_managers'] = [$v['default_entity_manager'] => $entityManager];
+
+                        return $v;
+                    })
+                    ->end()
                     ->children()
                         ->arrayNode('mappings')
                             ->requiresAtLeastOneElement()
@@ -117,6 +149,39 @@ private function addOrmSection(ArrayNodeDefinition $rootNode)
                             ->end()
                         ->end()
                         ->scalarNode('metadata_cache_driver')->defaultNull()->end()
+                        ->scalarNode('default_entity_manager')->end()
+                        ->arrayNode('entity_managers')
+                            ->requiresAtLeastOneElement()
+                            ->useAttributeAsKey('name')
+                            ->prototype('array')
+                                ->treatNullLike([])
+                                ->performNoDeepMerging()
+                                ->children()
+                                    ->scalarNode('connection')->isRequired()->end()
+                                ->end()
+                                ->fixXmlConfig('mapping')
+                                ->children()
+                                    ->arrayNode('mappings')
+                                        ->useAttributeAsKey('name')
+                                        ->prototype('array')
+                                            ->beforeNormalization()
+                                                ->ifString()
+                                                ->then(static function ($v) {
+                                                    return ['type' => $v];
+                                                })
+                                            ->end()
+                                            ->treatNullLike([])
+                                            ->treatFalseLike(['mapping' => false])
+                                            ->performNoDeepMerging()
+                                            ->children()
+                                                ->scalarNode('mapping')->defaultValue(true)->end()
+                                                ->scalarNode('dir')->end()
+                                            ->end()
+                                        ->end()
+                                    ->end()
+                                ->end()
+                            ->end()
+                        ->end()
                     ->end()
                 ->end()
             ->end();

README.md

@@ -182,6 +182,15 @@ Datacollector is available when the symfony profiler is enabled. The collector a
 
 **NOTE :** The time reported in the data collector may not be the real execution time in case you use the async calls : `executeAsync` and `prepareAsync`
 
+## EntityManager
+
+EntityManager is linked to one connection, so one keyspace in Cassandra.
+In the bundle, you can map some Entity folders to an entityManager to then create some tables (via the SchemaManager) a specific keyspace.
+There is a configuration parameter under ``orm`` called ``entity_managers`` where you can describe each ``entity_manager``.
+The entityManager config contains the linked connection and the entity mapping directories.
+
+If the linked connection can't be found, will fallback to default connection
+
 ## Configuration reference
 
 ```yaml
@@ -214,6 +223,23 @@ cassandra:
 
         client_name:
             ...
+    orm:
+        default_entity_manager: default
+        entity_managers:
+            default:
+                connection: default
+                mappings:
+                    User:
+                        dir: "src/UserEntity"
+                    Preference:
+                        dir: "src/PreferenceEntity"
+            
+            client_name:
+                connection: client_name
+                mappings:
+                    EntityGroupOne:
+                        dir: "src/GroupOneEntity"
+            ...
 ```
 
 ## Running the test

Tests/Fixtures/default-config.yml

@@ -9,3 +9,8 @@ cassandra:
       protocol_version: 3
       user: ''
       password: ''
+  orm:
+    default_entity_manager: client_test
+    entity_managers:
+      client_test:
+        connection: client_test

Tests/Fixtures/em-config.yml

@@ -0,0 +1,30 @@
+cassandra:
+  connections:
+    client_one:
+      keyspace: 'test1'
+      hosts:
+        - '127.0.0.1'
+        - '127.0.0.2'
+        - '127.0.0.3'
+      protocol_version: 3
+      user: ''
+      password: ''
+    client_two:
+      keyspace: 'test2'
+      hosts:
+        - '127.0.0.1'
+        - '127.0.0.2'
+        - '127.0.0.3'
+      protocol_version: 3
+      user: ''
+      password: ''
+  orm:
+    default_entity_manager: client_one
+    entity_managers:
+      client_one:
+        connection: client_one
+        mappings:
+          TestOne:
+            dir: 'src/Entity/TestOne'
+          TestTwo:
+            dir: 'src/Entity/TestTwo'

Tests/Fixtures/multiclients.yml

@@ -20,3 +20,8 @@ cassandra:
         - 127.0.0.5
       user: 'usertest'
       password: 'passwdtest'
+  orm:
+    default_entity_manager: client_test
+    entity_managers:
+      client_test:
+        connection: client_test

Tests/Fixtures/override-config.yml

@@ -26,3 +26,8 @@ cassandra:
         request: 15
       retries:
         sync_requests: 1
+  orm:
+    default_entity_manager: client_test
+    entity_managers:
+      client_test:
+        connection: client_test