Skip to content

Use config array instead of object for Blender Backend module #5654

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

Open
rtloftus wants to merge 14 commits into
base: dev
Choose a base branch
from
Open

Use config array instead of object for Blender Backend module #5654

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
05fb535
record collection
rtloftus Sep 9, 2026
c8f8a16
blender backend
rtloftus Sep 9, 2026
3a39bcc
blender backend test
rtloftus Sep 9, 2026
8d15acd
eds backend
rtloftus Sep 9, 2026
b711650
eds backend test
rtloftus Sep 9, 2026
e7f9e8b
backend test reversion
rtloftus Sep 10, 2026
6888b6a
eds backend reversion
rtloftus Sep 10, 2026
8192b11
restore eds part of test
rtloftus Sep 10, 2026
69ed3cf
Update module/VuFindSearch/src/VuFindSearch/Backend/Blender/Response/…
rtloftus Sep 10, 2026
9f57ffb
Update module/VuFindSearch/src/VuFindSearch/Backend/Blender/Response/…
rtloftus Sep 10, 2026
077f5c2
Update module/VuFindSearch/src/VuFindSearch/Backend/Blender/Response/…
rtloftus Sep 10, 2026
784d327
update factory
rtloftus Sep 10, 2026
57607aa
changes to backend
rtloftus Sep 10, 2026
fcffda8
composer
rtloftus Sep 10, 2026
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
6 changes: 3 additions & 3 deletions module/VuFind/src/VuFind/Search/Factory/BlenderBackendFactory.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,9 +107,9 @@ public function __invoke(
) {
$this->container = $container;
$this->configManager = $container->get(ConfigManagerInterface::class);
$blenderConfig = $this->configManager->getConfigObject($this->searchConfig);
$backendConfig = $blenderConfig->Backends
? $blenderConfig->Backends->toArray() : [];
$blenderConfig = $this->configManager->getConfigArray($this->searchConfig);
$backendConfig = $blenderConfig['Backends']
? $blenderConfig['Backends'] : [];
Comment on lines +111 to +112

@demiankatz demiankatz Sep 12, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This can be simplified:

Suggested change
$backendConfig = $blenderConfig['Backends']
? $blenderConfig['Backends'] : [];
$backendConfig = $blenderConfig['Backends'] ?? [];

if (!$backendConfig) {
throw new \Exception("No backends enabled in {$this->searchConfig}.ini");
}
Expand Down
48 changes: 11 additions & 37 deletions module/VuFindSearch/src/VuFindSearch/Backend/Blender/Backend.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,13 +56,6 @@ class Backend extends AbstractBackend
{
use \VuFindSearch\Feature\SearchBackendEventManagerTrait;

/**
* Actual backends.
*
* @var array
*/
protected $backends;

/**
* Limit for number of records to blend.
*
Expand All @@ -84,20 +77,6 @@ class Backend extends AbstractBackend
*/
protected $adaptiveBlockSizes;

/**
* Blender configuration.
*
* @var \VuFind\Config\Config
*/
protected $config;

/**
* Mappings configuration.
*
* @var array
*/
protected $mappings;

/**
* Event manager.
*
Expand All @@ -108,33 +87,28 @@ class Backend extends AbstractBackend
/**
* Constructor.
*
* @param array $backends Actual backends
* @param \VuFind\Config\Config $config Blender configuration
* @param array $mappings Mappings configuration
* @param EventManager $events Event manager
* @param array $backends Actual backends
* @param array $config Blender configuration
* @param array $mappings Mappings configuration
* @param EventManager $events Event manager
*
* @return void
*/
public function __construct(
array $backends,
\VuFind\Config\Config $config,
$mappings,
protected array $backends,
protected array $config,
protected array $mappings,
EventManager $events
) {
$this->backends = $backends;
$this->config = $config;
$this->mappings = $mappings;
$this->setEventManager($events);

$boostMax = isset($this->config->Blending->initialResults)
? count($this->config->Blending->initialResults->toArray())
: 0;
$boostMax = count($this->config['Blending']['initialResults'] ?? []);
$this->blendLimit = max(20, $boostMax);
$this->blockSize = intval($this->config->Blending->blockSize ?? 10);
$this->adaptiveBlockSizes
= isset($this->config->Blending->adaptiveBlockSizes)
? $this->config->Blending->adaptiveBlockSizes->toArray()
: [];
$this->blockSize = intval($this->config['Blending']['blockSize'] ?? 10);
$this->adaptiveBlockSizes = $this->config['Blending']['adaptiveBlockSizes'] ?? [];
}

/**
Expand Down Expand Up @@ -249,7 +223,7 @@ protected function processBackendFailures(
}
// Log the errors and collect a list to display to the user:
$this->logError("Search in $backendId failed: " . (string)$exception);
$failedBackends[] = $this->config->Backends[$backendId];
$failedBackends[] = $this->config['Backends'][$backendId];
}
if ($failedBackends) {
$mergedCollection->addError(
Expand Down
22 changes: 10 additions & 12 deletions module/VuFindSearch/src/VuFindSearch/Backend/Blender/Response/Json/RecordCollection.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ class RecordCollection extends \VuFindSearch\Backend\Solr\Response\Json\RecordCo
/**
* Blender configuration.
*
* @var \VuFind\Config\Config
* @var array
*/
protected $config;

Expand Down Expand Up @@ -80,18 +80,16 @@ class RecordCollection extends \VuFindSearch\Backend\Solr\Response\Json\RecordCo
/**
* Constructor.
*
* @param \VuFind\Config\Config $config Configuration
* @param array $mappings Mappings configuration
* @param ?array $config Configuration

@demiankatz demiankatz Sep 12, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably worth introducing property promotion here while we're changing types...

* @param array $mappings Mappings configuration
*/
public function __construct($config = null, $mappings = [])
{
$this->config = $config;
$this->mappings = $mappings;
$this->response = static::$template;
$this->initialResultsBackends
= isset($this->config->Blending->initialResults)
? $this->config->Blending->initialResults->toArray()
: [];
= $config['Blending']['initialResults'] ?? [];
}

/**
Expand Down Expand Up @@ -199,11 +197,11 @@ public function setSourceIdentifier($identifier)
*/
public function getFacetDelimiter(string $field): string
{
$delimitedFacets = $this->config->Advanced_Settings->delimited_facets ?? [];
$delimitedFacets = $this->config['Advanced_Settings']['delimited_facets'] ?? [];
foreach ($delimitedFacets as $current) {
$parts = explode('|', $current);
if ($parts[0] === $field) {
return $parts[1] ?? $this->config->Advanced_Settings->delimiter
return $parts[1] ?? $this->config['Advanced_Settings']['delimiter']
?? '';
}
}
Expand Down Expand Up @@ -245,7 +243,7 @@ protected function collectBackendRecords(array $collections): array
*/
public function add(RecordInterface $record, $checkExisting = true)
{
$label = $this->config->Backends[$record->getSearchBackendIdentifier()]
$label = $this->config['Backends'][$record->getSearchBackendIdentifier()]
?? '';
if ($label) {
$record->addLabel($label, 'source');
Expand All @@ -264,7 +262,7 @@ protected function addErrorsFromBackends(array $collections): void
{
foreach ($collections as $backendId => $collection) {
foreach ($collection->getErrors() as $error) {
$label = $this->config->Backends[$backendId];
$label = $this->config['Backends'][$backendId] ?? null;
if (is_string($error) && $label) {
$error = [
'msg' => '%%error%% -- %%label%%',
Expand Down Expand Up @@ -446,11 +444,11 @@ protected function getHierarchyParentKeys(string $value): array
protected function getBlenderFacetStats(array $collections): array
{
$delimiter = $this->getFacetDelimiter('blender_backend');
$orFacets = $this->config->Results_Settings->orFacets ?? '';
$orFacets = $this->config['Results_Settings']['orFacets'] ?? '';
$orFacetList = array_map('trim', explode(',', $orFacets));
$isOrFacet = '*' === $orFacets || in_array('blender_backend', $orFacetList);
$result = [];
foreach ($this->config->Backends as $backendId => $name) {
foreach ($this->config['Backends'] ?? [] as $backendId => $name) {
$key = $delimiter ? ($backendId . $delimiter . $name) : $backendId;
if (isset($collections[$backendId])) {
if ($total = $collections[$backendId]->getTotal()) {
Expand Down
4 changes: 2 additions & 2 deletions module/VuFindSearch/tests/unit-tests/src/VuFindTest/Backend/Blender/BackendTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -618,7 +618,7 @@ public function testSearchLimit(): void
$eventManager = new EventManager($this->sharedEventManager);
$backend = new Backend(
$backends,
new Config(static::$config),
static::$config,
$this->mappings,
$eventManager
);
Expand Down Expand Up @@ -1074,7 +1074,7 @@ protected function getBackend(
$eventManager = new EventManager($this->sharedEventManager);
$backend = new Backend(
$backends,
new Config($config ?? static::$config),
$config ?? static::$config,
$mappings ?? $this->mappings,
$eventManager
);
Expand Down