Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[POC] Implented working config with multiple indexes per document class #917

Open
wants to merge 3 commits into
base: 7.0
Choose a base branch
from
Open

[POC] Implented working config with multiple indexes per document class #917

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7e3354d
[POC] Implemtend working config with multiple indexes per document class
toooni Feb 11, 2020
c56878a
Fixed code for PHP <7.4
toooni Feb 11, 2020
02be3d3
CS Fixes
toooni Feb 11, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
210 changes: 133 additions & 77 deletions DependencyInjection/Compiler/MappingPass.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,13 @@

use ONGR\ElasticsearchBundle\Annotation\Index;
use ONGR\ElasticsearchBundle\DependencyInjection\Configuration;
use ONGR\ElasticsearchBundle\Exception\DocumentIndexParserException;
use ONGR\ElasticsearchBundle\Mapping\Converter;
use ONGR\ElasticsearchBundle\Mapping\DocumentParser;
use ONGR\ElasticsearchBundle\Mapping\IndexSettings;
use ONGR\ElasticsearchBundle\Service\IndexService;
use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
use Symfony\Component\DependencyInjection\Container;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\Definition;

Expand All @@ -36,9 +38,66 @@ class MappingPass implements CompilerPassInterface
public function process(ContainerBuilder $container)
{
$kernelDir = $container->getParameter('kernel.project_dir');
$parser = $container->get(DocumentParser::class);

$indexClasses = [];
$indexSettingsArray = [];
foreach ($container->getParameter(Configuration::ONGR_SOURCE_DIR) as $dir) {
$this->handleDirectoryMapping($container, $kernelDir . $dir);
foreach ($this->getNamespaces($kernelDir . $dir) as $namespace) {
$indexClasses[$namespace] = $namespace;
}
}

$overwrittenClasses = [];
$indexOverrides = $container->getParameter(Configuration::ONGR_INDEXES_OVERRIDE);

foreach ($indexOverrides as $name => $indexOverride) {
$class = isset($indexOverride['class']) ? $indexOverride['class'] : $name;

if (!isset($indexClasses[$class])) {
throw new \RuntimeException(
sprintf(
'Document `%s` defined in ongr_elasticsearch.indexes config could not been found',
$class
)
);
}

$indexSettings = $this->parseIndexSettingsFromClass($parser, $class);

if ($class !== $name) {
$indexSettings->setIndexName('ongr.es.index.'.$name);
}

if (isset($indexOverride['alias'])) {
$indexSettings->setAlias($indexOverride['alias']);
}

if (isset($indexOverride['settings'])) {
$indexSettings->setIndexMetadata($indexOverride['settings']);
}

if (isset($indexOverride['hosts'])) {
$indexSettings->setHosts($indexOverride['hosts']);
}

if (isset($indexOverride['default'])) {
$indexSettings->setDefaultIndex($indexOverride['default']);
}

$indexSettingsArray[$name] = $indexSettings;
$overwrittenClasses[$class] = $class;
}

foreach (array_diff($indexClasses, $overwrittenClasses) as $indexClass) {
try {
$indexSettingsArray[$indexClass] = $this->parseIndexSettingsFromClass($parser, $indexClass);
} catch (DocumentIndexParserException $e) {
}
}

foreach ($indexSettingsArray as $indexSettings) {
$this->createIndex($container, $indexSettings);
}

$container->setParameter(Configuration::ONGR_INDEXES, $this->indexes);
Expand All @@ -48,88 +107,85 @@ public function process(ContainerBuilder $container)
);
}

/**
* @param ContainerBuilder $container
* @param string $dir
*
* @throws \ReflectionException
*/
private function handleDirectoryMapping(ContainerBuilder $container, string $dir): void
private function parseIndexSettingsFromClass(DocumentParser $parser, string $className) : IndexSettings
{
/** @var DocumentParser $parser */
$parser = $container->get(DocumentParser::class);
$indexesOverride = $container->getParameter(Configuration::ONGR_INDEXES_OVERRIDE);
$converterDefinition = $container->getDefinition(Converter::class);
$class = new \ReflectionClass($className);

foreach ($this->getNamespaces($dir) as $namespace) {
$class = new \ReflectionClass($namespace);
/** @var Index $document */
$document = $parser->getIndexAnnotation($class);

if (isset($indexesOverride[$namespace]['alias']) && $indexesOverride[$namespace]['alias']) {
$indexAlias = $indexesOverride[$namespace]['alias'];
} else {
$indexAlias = $parser->getIndexAliasName($class);
}
if ($document === null) {
throw new DocumentIndexParserException();
}

/** @var Index $document */
$document = $parser->getIndexAnnotation($class);
$indexMetadata = $parser->getIndexMetadata($class);

if (!empty($indexMetadata)) {
$indexMetadata['settings'] = array_filter(array_merge_recursive(
$indexMetadata['settings'] ?? [],
[
'number_of_replicas' => $document->numberOfReplicas,
'number_of_shards' => $document->numberOfShards,
],
$indexesOverride[$namespace]['settings'] ?? []
));

$indexSettings = new Definition(
IndexSettings::class,
[
$namespace,
$indexAlias,
$indexAlias,
$indexMetadata,
$indexesOverride[$namespace]['hosts'] ?? $document->hosts,
$indexesOverride[$namespace]['default'] ?? $document->default,
]
);
$indexSettings = new IndexSettings(
$className,
$className,
$parser->getIndexAliasName($class),
$parser->getIndexMetadata($class),
$parser->getPropertyMetadata($class),
$document->hosts,
$parser->isDefaultIndex($class)
);

$indexServiceDefinition = new Definition(IndexService::class, [
$namespace,
$converterDefinition,
$container->getDefinition('event_dispatcher'),
$indexSettings,
$container->getParameter(Configuration::ONGR_PROFILER_CONFIG)
? $container->getDefinition('ongr.esb.tracer') : null
]);
$indexServiceDefinition->setPublic(true);
$converterDefinition->addMethodCall(
'addClassMetadata',
[
$namespace,
$parser->getPropertyMetadata($class)
]
);
$indexSettings->setIndexMetadata(['settings' => [
'number_of_replicas' => $document->numberOfReplicas,
'number_of_shards' => $document->numberOfShards,
]]);

$container->setDefinition($namespace, $indexServiceDefinition);
$this->indexes[$indexAlias] = $namespace;
$isCurrentIndexDefault = $parser->isDefaultIndex($class);
if ($this->defaultIndex && $isCurrentIndexDefault) {
throw new \RuntimeException(
sprintf(
'Only one index can be set as default. We found 2 indexes as default ones `%s` and `%s`',
$this->defaultIndex,
$indexAlias
)
);
}

if ($isCurrentIndexDefault) {
$this->defaultIndex = $indexAlias;
}
}
return $indexSettings;
}

private function createIndex(Container $container, IndexSettings $indexSettings)
{
$converterDefinition = $container->getDefinition(Converter::class);

$indexSettingsDefinition = new Definition(
IndexSettings::class,
[
$indexSettings->getNamespace(),
$indexSettings->getAlias(),
$indexSettings->getAlias(),
$indexSettings->getIndexMetadata(),
$indexSettings->getPropertyMetadata(),
$indexSettings->getHosts(),
$indexSettings->isDefaultIndex(),
]
);

$indexServiceDefinition = new Definition(IndexService::class, [
$indexSettings->getNamespace(),
$converterDefinition,
$container->getDefinition('event_dispatcher'),
$indexSettingsDefinition,
$container->getParameter(Configuration::ONGR_PROFILER_CONFIG)
? $container->getDefinition('ongr.esb.tracer') : null
]);

$indexServiceDefinition->setPublic(true);
$converterDefinition->addMethodCall(
'addClassMetadata',
[
$indexSettings->getNamespace(),
$indexSettings->getPropertyMetadata()
]
);

$container->setDefinition($indexSettings->getIndexName(), $indexServiceDefinition);
$this->indexes[$indexSettings->getAlias()] = $indexSettings->getIndexName();
$isCurrentIndexDefault = $indexSettings->isDefaultIndex();
if ($this->defaultIndex && $isCurrentIndexDefault) {
throw new \RuntimeException(
sprintf(
'Only one index can be set as default. We found 2 indexes as default ones `%s` and `%s`',
$this->defaultIndex,
$indexSettings->getAlias()
)
);
}

if ($isCurrentIndexDefault) {
$this->defaultIndex = $indexSettings->getAlias();
}
}

Expand Down
16 changes: 16 additions & 0 deletions Exception/DocumentIndexParserException.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
<?php

/*
* This file is part of the ONGR package.
*
* (c) NFQ Technologies UAB <[email protected]>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/

namespace ONGR\ElasticsearchBundle\Exception;

class DocumentIndexParserException extends DocumentParserException
{
}
36 changes: 23 additions & 13 deletions Mapping/IndexSettings.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ class IndexSettings
private $indexName;
private $alias;
private $indexMetadata;
private $propertyMetadata;
private $hosts;
private $defaultIndex = false;

Expand All @@ -24,13 +25,15 @@ public function __construct(
string $indexName,
string $alias,
array $indexMetadata = [],
array $propertyMetadata = [],
array $hosts = [],
bool $defaultIndex = false
) {
$this->namespace = $namespace;
$this->indexName = $indexName;
$this->alias = $alias;
$this->indexMetadata = $indexMetadata;
$this->propertyMetadata = $propertyMetadata;
$this->hosts = $hosts;
$this->defaultIndex = $defaultIndex;
}
Expand All @@ -40,64 +43,71 @@ public function getNamespace()
return $this->namespace;
}

public function setNamespace($namespace): self
public function setNamespace($namespace): void
{
$this->namespace = $namespace;
return $this;
}

public function getIndexName()
{
return $this->indexName;
}

public function setIndexName($indexName): self
public function setIndexName($indexName): void
{
$this->indexName = $indexName;
return $this;
}

public function getAlias()
{
return $this->alias;
}

public function setAlias($alias): self
public function setAlias($alias): void
{
$this->alias = $alias;
return $this;
}

public function getIndexMetadata()
{
return $this->indexMetadata;
}

public function setIndexMetadata($indexMetadata): self
public function setIndexMetadata($indexMetadata): void
{
$this->indexMetadata = $indexMetadata;
return $this;
$this->indexMetadata = array_filter(array_merge_recursive(
$this->indexMetadata,
$indexMetadata
));
}

public function getPropertyMetadata(): array
{
return $this->propertyMetadata;
}

public function setPropertyMetadata(array $propertyMetadata): void
{
$this->propertyMetadata = $propertyMetadata;
}

public function getHosts()
{
return $this->hosts;
}

public function setHosts($hosts): self
public function setHosts($hosts): void
{
$this->hosts = $hosts;
return $this;
}

public function isDefaultIndex(): bool
{
return $this->defaultIndex;
}

public function setDefaultIndex(bool $defaultIndex): self
public function setDefaultIndex(bool $defaultIndex): void
{
$this->defaultIndex = $defaultIndex;
return $this;
}
}