Skip to content

ObjectSuggestions: Prioritze Column suggestions and best suggestions #1215

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

Merged
merged 3 commits into from
Jun 13, 2025
Merged

ObjectSuggestions: Prioritze Column suggestions and best suggestions #1215

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c7083ec
ObjectSuggestions: Prioritze Column suggestions and best suggestions
raviks789 Jun 11, 2025
cd25882
Separate exact match and wild card match custom variable retrieval
raviks789 Jun 12, 2025
52f9537
fix: Reolve review comments
raviks789 Jun 13, 2025
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
122 changes: 69 additions & 53 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 @@ -221,16 +221,23 @@ protected function fetchColumnSuggestions($searchTerm)
$model = $this->getModel();
$query = $model::on($this->getDb());

// Collect custom variables first and check for exact matches
$parsedArrayVars = [];
$varSuggestions = [];
$exactVarMatches = [];
$halfLimit = (int) (static::DEFAULT_LIMIT / 2);

$exactSearchTerm = trim($searchTerm, ' *');
$exactVarSearches = [];
$titleAdded = false;

// Suggest exact custom variable matches first
if ($exactSearchTerm !== '') {
foreach ($this->getDb()->select($this->queryCustomvarConfig($searchTerm)) as $customVar) {
foreach (
$this->getDb()->select($this->queryCustomvarConfig(
Filter::any(
Filter::equal('flatname', $exactSearchTerm),
Filter::like('flatname', $exactSearchTerm . '[*]') // Filter for array type custom variables
)
)) as $customVar
) {
$search = $name = $customVar->flatname;
$exactVarSearches[] = $search;
if (preg_match('/\w+(?:\[(\d*)])+$/', $search, $matches)) {
$name = substr($search, 0, -(strlen($matches[1]) + 2));
if (isset($parsedArrayVars[$name])) {
Expand All @@ -243,71 +250,79 @@ protected function fetchColumnSuggestions($searchTerm)

foreach ($this->customVarSources as $relation => $label) {
if (isset($customVar->$relation)) {
$varRelation = $relation . '.vars.' . $search;
$varLabel = sprintf($label, $name);
if ($name === $exactSearchTerm) {
$exactVarMatches[$varRelation] = $varLabel;
} elseif ($this->matchSuggestion($varRelation, $varLabel, $searchTerm)) {
$varSuggestions[$varRelation] = $varLabel;
if ($titleAdded === false) {
$this->addHtml(HtmlElement::create(
'li',
['class' => static::SUGGESTION_TITLE_CLASS],
t('Best Suggestions')
));

$titleAdded = true;
}

yield $relation . '.vars.' . $search => sprintf($label, $name);
}
}
}
}

// Adjust the number of columns to be suggested based on custom variable count
$varCount = count($exactVarMatches) + count($varSuggestions);
$colLimit = $halfLimit;
if ($varCount < $halfLimit) {
$colLimit = $halfLimit + ($halfLimit - $varCount);
}

// Exact custom variable matches first
if (! empty($exactVarMatches)) {
$this->addHtml(HtmlElement::create(
'li',
['class' => static::SUGGESTION_TITLE_CLASS],
t('Best Suggestions')
));

foreach ($exactVarMatches as $relation => $label) {
yield $relation => $label;
}
}

// Ordinary columns comes after exact matches,
// or if there ar no exact matches they come first
$colCount = 0;
$titleAdded = false;
foreach (self::collectFilterColumns($model, $query->getResolver()) as $columnName => $columnMeta) {
if ($colCount > $colLimit) {
break;
}

if ($this->matchSuggestion($columnName, $columnMeta, $searchTerm)) {
if ($colCount === 0) {
if ($titleAdded === false) {
$this->addHtml(HtmlElement::create(
'li',
['class' => static::SUGGESTION_TITLE_CLASS],
t('Columns')
));
}

$colCount++;
$titleAdded = true;
}

yield $columnName => $columnMeta;
}
}

// Finally, the other custom variable suggestions
if (! empty($varSuggestions)) {
$this->addHtml(HtmlElement::create(
'li',
['class' => static::SUGGESTION_TITLE_CLASS],
t('Custom Variables')
));

foreach ($varSuggestions as $relation => $label) {
yield $relation => $label;
$titleAdded = false;
if (! empty($exactVarSearches)) {
$varFilter = Filter::all(
Filter::like('flatname', $searchTerm),
Filter::unequal('flatname', $exactVarSearches)
);
} else {
$varFilter = Filter::like('flatname', $searchTerm);
}

foreach ($this->getDb()->select($this->queryCustomvarConfig($varFilter)) as $customVar) {
$search = $name = $customVar->flatname;
if (preg_match('/\w+(?:\[(\d*)])+$/', $search, $matches)) {
$name = substr($search, 0, -(strlen($matches[1]) + 2));
if (isset($parsedArrayVars[$name])) {
continue;
}

$parsedArrayVars[$name] = true;
$search = $name . '[*]';
}

foreach ($this->customVarSources as $relation => $label) {
if (isset($customVar->$relation)) {
// Suggest exact custom variable matches first
if ($titleAdded === false) {
$this->addHtml(HtmlElement::create(
'li',
['class' => static::SUGGESTION_TITLE_CLASS],
t('Custom Variables')
));

$titleAdded = true;
}

yield $relation . '.vars.' . $search => sprintf($label, $name);
}
}
}
}
Expand All @@ -324,13 +339,13 @@ protected function matchSuggestion($path, $label, $searchTerm)
}

/**
* Create a query to fetch all available custom variables matching the given term
* Create a query to fetch all available custom variables matching the given filter
*
* @param string $searchTerm
* @param Filter\Rule $filter
*
* @return Select
*/
protected function queryCustomvarConfig(string $searchTerm): Select
protected function queryCustomvarConfig(Filter\Rule $filter): Select
{
$customVars = CustomvarFlat::on($this->getDb());
$tableName = $customVars->getModel()->getTableName();
Expand All @@ -356,7 +371,8 @@ protected function queryCustomvarConfig(string $searchTerm): Select

$customVars->columns('flatname');
$this->applyRestrictions($customVars);
$customVars->filter(Filter::like('flatname', $searchTerm));
$customVars->filter($filter);

$idColumn = $resolver->qualifyColumn('id', $resolver->getAlias($customVars->getModel()));
$customVars = $customVars->assembleSelect();

Expand Down
Loading