Skip to content

ObjectSuggestions: Improve column suggestions #769

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

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

ObjectSuggestions: Improve column suggestions #769

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
65 changes: 42 additions & 23 deletions library/Icingadb/Web/Control/SearchBar/ObjectSuggestions.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
use Icinga\Module\Icingadb\Model\CustomvarFlat;
use Icinga\Module\Icingadb\Model\Host;
use Icinga\Module\Icingadb\Model\Service;
use Icinga\Module\Icingadb\Model\State;
use Icinga\Module\Icingadb\Util\ObjectSuggestionsCursor;
use ipl\Html\HtmlElement;
use ipl\Orm\Exception\InvalidColumnException;
Expand Down Expand Up @@ -243,7 +244,7 @@ protected function fetchColumnSuggestions($searchTerm)

protected function matchSuggestion($path, $label, $searchTerm)
{
if (preg_match('/[_.](id|bin|checksum)$/', $path)) {
if (preg_match('/[_.](id|bin|checksum)$/', $path) || substr_count($path, '.') > 2) {
// Only suggest exotic columns if the user knows about them
$trimmedSearch = trim($searchTerm, ' *');
return substr($path, -strlen($trimmedSearch)) === $trimmedSearch;
Expand Down Expand Up @@ -308,19 +309,27 @@ protected function queryCustomvarConfig(string $searchTerm): Select
public static function collectFilterColumns(Model $model, Resolver $resolver): Generator
{
if ($model instanceof UnionModel) {
$models = [];
foreach ($model->getUnions() as $union) {
/** @var Model $unionModel */
$unionModel = new $union[0]();
$models[$unionModel->getTableName()] = $unionModel;
self::collectRelations($resolver, $unionModel, $models, []);
}
$models = function () use ($model, $resolver) {
foreach ($model->getUnions() as $union) {
/** @var Model $unionModel */
$unionModel = new $union[0]();

yield $unionModel->getTableName() => $unionModel;
$knownRelations = [get_class($unionModel) => true];

yield from self::collectRelations($resolver, $unionModel, [], $knownRelations);
}
};
} else {
$models = [$model->getTableName() => $model];
self::collectRelations($resolver, $model, $models, []);
$models = function () use ($model, $resolver) {
yield $model->getTableName() => $model;
$knownRelations = [get_class($model) => true];

yield from self::collectRelations($resolver, $model, [], $knownRelations);
};
}

foreach ($models as $path => $targetModel) {
foreach ($models() as $path => $targetModel) {
/** @var Model $targetModel */
foreach ($resolver->getColumnDefinitions($targetModel) as $columnName => $definition) {
yield $path . '.' . $columnName => $definition->getLabel();
Expand Down Expand Up @@ -377,29 +386,39 @@ public static function collectFilterColumns(Model $model, Resolver $resolver): G
*
* @param Resolver $resolver
* @param Model $subject
* @param array $models
* @param array $path
* @param array $knownRelations
*/
protected static function collectRelations(Resolver $resolver, Model $subject, array &$models, array $path)
{
protected static function collectRelations(
Resolver $resolver,
Model $subject,
array $path,
array &$knownRelations
): Generator {
$relatedRelations = [];
foreach ($resolver->getRelations($subject) as $name => $relation) {
/** @var Relation $relation */
if (
empty($path) || (
$name === 'state'
|| $name === 'last_comment'
|| $name === 'notificationcommand' && $path[0] === 'notification'
)
) {
$isSelfJoin = $relation->getTarget() instanceof $subject; // downtime.triggered_by, downtime.parent
$isKnown = isset($knownRelations[$relation->getTargetClass()]);

if (empty($path) || $relation->isOne() && ! $isKnown && ! $isSelfJoin) {
$relationPath = [$name];
if ($relation instanceof HasOne && empty($path)) {
array_unshift($relationPath, $subject->getTableName());
}

$relationPath = array_merge($path, $relationPath);
$models[join('.', $relationPath)] = $relation->getTarget();
self::collectRelations($resolver, $relation->getTarget(), $models, $relationPath);
yield join('.', $relationPath) => $relation->getTarget();
$knownRelations[$relation->getTargetClass()] = true;

if (! $relation->getTarget() instanceof State) {
$relatedRelations[] = [$relationPath, $relation->getTarget()];
}
}
}

foreach ($relatedRelations as [$path, $target]) {
yield from self::collectRelations($resolver, $target, $path, $knownRelations);
}
}
}