The data type of a field determines how it can be used for searching and filtering. The boost is used to give additional weight to certain fields, e.g. titles or tags.
Whether detailed field types are supported depends on the type of server this index resides on. In any case, fields of type "Fulltext" will always be fulltext-searchable.
'); if ($index->hasValidServer()) { $form['description']['#markup'] .= '' . $this->t('Check the ' . "server's backend class description for details.", - array(':server-url' => $index->getServer()->toUrl('canonical')->toString())) . '
'; + array(':server-url' => $index->getServerInstance()->toUrl('canonical')->toString())) . ''; } if ($fields = $index->getFieldsByDatasource(NULL)) { diff --git a/src/Form/IndexForm.php b/src/Form/IndexForm.php index 2bfca64..accb9b0 100644 --- a/src/Form/IndexForm.php +++ b/src/Form/IndexForm.php @@ -262,7 +262,7 @@ class IndexForm extends EntityForm { '#title' => $this->t('Tracker'), '#description' => $this->t('Select the type of tracker which should be used for keeping track of item changes.'), '#options' => $this->getTrackerPluginManager()->getOptionsList(), - '#default_value' => $index->hasValidTracker() ? $index->getTracker()->getPluginId() : key($tracker_options), + '#default_value' => $index->hasValidTracker() ? $index->getTrackerId() : key($tracker_options), '#required' => TRUE, '#disabled' => !$index->isNew(), '#ajax' => array( @@ -313,7 +313,7 @@ class IndexForm extends EntityForm { '#description' => $this->t('Only enabled indexes can be used for indexing and searching. This setting will only take effect if the selected server is also enabled.'), '#default_value' => $index->status(), // Can't enable an index lying on a disabled server or no server at all. - '#disabled' => !$index->status() && (!$index->hasValidServer() || !$index->getServer()->status()), + '#disabled' => !$index->status() && (!$index->hasValidServer() || !$index->getServerInstance()->status()), // @todo This doesn't seem to work and should also hide for disabled // servers. If that works, we can probably remove the last sentence of // the description. @@ -391,8 +391,8 @@ class IndexForm extends EntityForm { * The index being created or edited. */ public function buildTrackerConfigForm(array &$form, FormStateInterface $form_state, IndexInterface $index) { - if ($index->hasValidTracker()) { - $tracker = $index->getTracker(); + if (!$index->isNew() && $index->hasValidTracker()) { + $tracker = $index->getTrackerInstance(); // @todo Create, use and save SubFormState already here, not only in // validate(). Also, use proper subset of $form for first parameter? if ($config_form = $tracker->buildConfigurationForm(array(), $form_state)) { @@ -484,7 +484,7 @@ class IndexForm extends EntityForm { // form structure). $tracker_id = $form_state->getValue('tracker', NULL); if ($this->originalEntity->getTrackerId() == $tracker_id) { - $tracker = $this->originalEntity->getTracker(); + $tracker = $this->originalEntity->getTrackerInstance(); } else { $tracker = $this->trackerPluginManager->createInstance($tracker_id, array('index' => $this->originalEntity)); @@ -532,9 +532,12 @@ class IndexForm extends EntityForm { $datasource_form = (!empty($form['datasource_configs'][$datasource_id])) ? $form['datasource_configs'][$datasource_id] : array(); $datasource_form_state = new SubFormState($form_state, array('datasource_configs', $datasource_id)); $datasource->submitConfigurationForm($datasource_form, $datasource_form_state); - $datasource_configuration[$datasource_id] = $datasource->getConfiguration(); + $datasource_configuration[$datasource_id] = array( + 'plugin_id' => $datasource_id, + 'settings' => $datasource->getConfiguration() + ); } - $index->set('datasource_configs', $datasource_configuration); + $index->set('datasource_settings', $datasource_configuration); // Call submitConfigurationForm() for the (possibly new) tracker. // @todo It seems if we change the tracker, we would validate/submit the old @@ -543,8 +546,8 @@ class IndexForm extends EntityForm { // just always be empty (because datasources have their plugin ID in the // form structure). $tracker_id = $form_state->getValue('tracker', NULL); - if ($this->originalEntity->getTrackerId() == $tracker_id) { - $tracker = $this->originalEntity->getTracker(); + if (!$index->isNew() && $this->originalEntity->getTrackerId() == $tracker_id) { + $tracker = $this->originalEntity->getTrackerInstance(); } else { $tracker = $this->trackerPluginManager->createInstance($tracker_id, array('index' => $this->originalEntity)); @@ -552,7 +555,13 @@ class IndexForm extends EntityForm { $tracker_form_state = new SubFormState($form_state, array('tracker_config')); $tracker->submitConfigurationForm($form['tracker_config'], $tracker_form_state); - $index->set('tracker_config', $tracker->getConfiguration()); + $tracker_settings = array( + $tracker_id => array( + 'plugin_id' => $tracker_id, + 'settings' => $tracker->getConfiguration() + ) + ); + $index->set('tracker_settings', $tracker_settings); } /** diff --git a/src/Form/IndexProcessorsForm.php b/src/Form/IndexProcessorsForm.php index d32e5ac..f481df1 100644 --- a/src/Form/IndexProcessorsForm.php +++ b/src/Form/IndexProcessorsForm.php @@ -96,8 +96,9 @@ class IndexProcessorsForm extends EntityForm { $processors_by_stage[$stage] = $this->entity->getProcessorsByStage($stage, FALSE); } - if ($this->entity->getServer()) { - $backend_discouraged_processors = $this->entity->getServer() + if ($this->entity->getServerInstance()) { + $backend_discouraged_processors = $this->entity + ->getServerInstance() ->getBackend() ->getDiscouragedProcessors(); @@ -112,7 +113,7 @@ class IndexProcessorsForm extends EntityForm { } } - $processor_settings = $this->entity->getProcessorSettings(); + $processor_settings = $this->entity->getProcessors(TRUE); $form['#tree'] = TRUE; $form['#attached']['library'][] = 'search_api/drupal.search_api.index-active-formatters'; @@ -171,9 +172,10 @@ class IndexProcessorsForm extends EntityForm { foreach ($processors_by_stage as $stage => $processors) { /** @var \Drupal\search_api\Processor\ProcessorInterface $processor */ foreach ($processors as $processor_id => $processor) { - $weight = isset($processor_settings[$processor_id]['weights'][$stage]) - ? $processor_settings[$processor_id]['weights'][$stage] + $weight = isset($processor_settings[$processor_id]) + ? $processor_settings[$processor_id]->getPluginDefinition()['stages'][$stage] : $processor->getDefaultWeight($stage); + if ($processor->isHidden()) { $form['processors'][$processor_id]['weights'][$stage] = array( '#type' => 'value', @@ -262,7 +264,7 @@ class IndexProcessorsForm extends EntityForm { continue; } $new_settings[$processor_id] = array( - 'processor_id' => $processor_id, + 'plugin_id' => $processor_id, 'weights' => array(), 'settings' => array(), ); @@ -279,10 +281,10 @@ class IndexProcessorsForm extends EntityForm { // Sort the processors so we won't have unnecessary changes. ksort($new_settings); - $settings_changed = $new_settings != $this->entity->getProcessorSettings(); + $settings_changed = $new_settings != $this->entity->get('processor_settings'); $form_state->set('processors_changed', $settings_changed); if ($settings_changed) { - $this->entity->setProcessorSettings($new_settings); + $this->entity->set('processor_settings', $new_settings); } } diff --git a/src/Form/IndexStatusForm.php b/src/Form/IndexStatusForm.php index 640e795..ad42155 100644 --- a/src/Form/IndexStatusForm.php +++ b/src/Form/IndexStatusForm.php @@ -65,7 +65,7 @@ class IndexStatusForm extends FormBase { 'class' => array('container-inline'), ), ); - $has_remaining_items = ($index->getTracker()->getRemainingItemsCount() > 0); + $has_remaining_items = ($index->getTrackerInstance()->getRemainingItemsCount() > 0); $all_value = $this->t('all', array(), array('context' => 'items to index')); $limit = array( '#type' => 'textfield', diff --git a/src/IndexBatchHelper.php b/src/IndexBatchHelper.php index 9da6463..379a9e8 100644 --- a/src/IndexBatchHelper.php +++ b/src/IndexBatchHelper.php @@ -137,7 +137,7 @@ class IndexBatchHelper { // Get the remaining item count. When no valid tracker is available then // the value will be set to zero which will cause the batch process to // stop. - $remaining_item_count = ($index->hasValidTracker() ? $index->getTracker()->getRemainingItemsCount() : 0); + $remaining_item_count = ($index->hasValidTracker() ? $index->getTrackerInstance()->getRemainingItemsCount() : 0); // Check if an explicit limit needs to be used. if ($context['sandbox']['limit'] > -1) { diff --git a/src/IndexInterface.php b/src/IndexInterface.php index a435f35..da84764 100644 --- a/src/IndexInterface.php +++ b/src/IndexInterface.php @@ -200,7 +200,7 @@ interface IndexInterface extends ConfigEntityInterface { * @throws \Drupal\search_api\SearchApiException * Thrown if the tracker couldn't be instantiated. */ - public function getTracker(); + public function getTrackerInstance(); /** * Determines whether this index is lying on a valid server. @@ -236,10 +236,13 @@ interface IndexInterface extends ConfigEntityInterface { * @throws \Drupal\search_api\SearchApiException * Thrown if the server couldn't be loaded. */ - public function getServer(); + public function getServerInstance(); /** - * Sets the server the index is attached to + * Sets the server the index is attached to. + * + * When setting this to NULL, the configured server will be removed from the + * index. * * @param \Drupal\search_api\ServerInterface|null $server * The server to move this index to, or NULL. @@ -277,24 +280,6 @@ interface IndexInterface extends ConfigEntityInterface { public function getProcessorsByStage($stage, $only_enabled = TRUE); /** - * Retrieves this index's processor settings. - * - * @return array - * An array of processors and their settings. - */ - public function getProcessorSettings(); - - /** - * Sets this index's processor settings. - * - * @param array $processors - * An array of processors and their settings. - * - * @return $this - */ - public function setProcessorSettings(array $processors); - - /** * Preprocesses data items for indexing. * * Lets all enabled processors for this index preprocess the indexed data. @@ -420,24 +405,6 @@ interface IndexInterface extends ConfigEntityInterface { public function getFulltextFields(); /** - * Retrieves this index's field settings. - * - * @return array - * An array of field settings. - */ - public function getFieldSettings(); - - /** - * Sets this index's field settings. - * - * @param array $fields - * An array of field settings. - * - * @return $this - */ - public function setFieldSettings(array $fields); - - /** * Retrieves the properties of one of this index's datasources. * * @param string|null $datasource_id diff --git a/src/Item/Field.php b/src/Item/Field.php index 97637ad..abbe268 100644 --- a/src/Item/Field.php +++ b/src/Item/Field.php @@ -439,8 +439,7 @@ class Field implements \IteratorAggregate, FieldInterface { */ public function getBoost() { if (!isset($this->boost)) { - $fields = $this->index->getFieldSettings(); - $this->boost = isset($fields[$this->fieldIdentifier]['boost']) ? (float) $fields[$this->fieldIdentifier]['boost'] : 1.0; + $this->boost = 1.0; } return $this->boost; } diff --git a/src/Plugin/search_api/processor/RenderedItem.php b/src/Plugin/search_api/processor/RenderedItem.php index a277fc3..032be42 100644 --- a/src/Plugin/search_api/processor/RenderedItem.php +++ b/src/Plugin/search_api/processor/RenderedItem.php @@ -284,7 +284,8 @@ class RenderedItem extends ProcessorPluginBase { '%processor' => $this->label(), '@count' => $unset_view_modes, ); - $this->getLogger()->warning('Warning: While indexing items on search index %index, @count item(s) did not have a view mode configured for the %processor processor.', $context); + $this->getLogger() + ->warning('Warning: While indexing items on search index %index, @count item(s) did not have a view mode configured for the %processor processor.', $context); } // Restore the original user. diff --git a/src/Plugin/views/argument/SearchApiMoreLikeThis.php b/src/Plugin/views/argument/SearchApiMoreLikeThis.php index f39c8b0..bfe03e3 100644 --- a/src/Plugin/views/argument/SearchApiMoreLikeThis.php +++ b/src/Plugin/views/argument/SearchApiMoreLikeThis.php @@ -69,7 +69,7 @@ class SearchApiMoreLikeThis extends SearchApiArgument { */ public function query($group_by = FALSE) { try { - $server = $this->query->getIndex()->getServer(); + $server = $this->query->getIndex()->getServerInstance(); if (!$server->supportsFeature('search_api_mlt')) { $backend_id = $server->getBackendId(); \Drupal::logger('search_api')->error('The search backend "@backend_id" does not offer "More like this" functionality.', diff --git a/src/Query/Query.php b/src/Query/Query.php index eb22371..53bbe60 100644 --- a/src/Query/Query.php +++ b/src/Query/Query.php @@ -318,7 +318,7 @@ class Query implements QueryInterface { $this->preExecute(); // Execute query. - $response = $this->index->getServer()->search($this); + $response = $this->index->getServerInstance()->search($this); // Postprocess the search results. $this->postExecute($response); diff --git a/src/Task/IndexTaskManager.php b/src/Task/IndexTaskManager.php index db1b5b8..4cfafcb 100644 --- a/src/Task/IndexTaskManager.php +++ b/src/Task/IndexTaskManager.php @@ -99,7 +99,7 @@ class IndexTaskManager implements IndexTaskManagerInterface { $item_ids[] = Utility::createCombinedId($datasource_id, $raw_id); } $added = count($item_ids); - $index->getTracker()->trackItemsInserted($item_ids); + $index->getTrackerInstance()->trackItemsInserted($item_ids); } } } @@ -195,7 +195,7 @@ class IndexTaskManager implements IndexTaskManagerInterface { if (!isset($datasource_ids)) { $this->state->delete($this->getIndexStateKey($index)); if ($valid_tracker) { - $index->getTracker()->trackAllItemsDeleted(); + $index->getTrackerInstance()->trackAllItemsDeleted(); } return; } @@ -211,7 +211,7 @@ class IndexTaskManager implements IndexTaskManagerInterface { foreach ($datasource_ids as $datasource_id) { unset($index_state['pages'][$datasource_id]); if ($valid_tracker) { - $index->getTracker()->trackAllItemsDeleted($datasource_id); + $index->getTrackerInstance()->trackAllItemsDeleted($datasource_id); } } diff --git a/src/Task/ServerTaskManager.php b/src/Task/ServerTaskManager.php index d1f7e01..f0a7e22 100644 --- a/src/Task/ServerTaskManager.php +++ b/src/Task/ServerTaskManager.php @@ -50,9 +50,17 @@ class ServerTaskManager implements ServerTaskManagerInterface { */ public function execute(ServerInterface $server = NULL) { $select = $this->database->select('search_api_task', 't'); + // Only retrieve tasks we can handle. + $allowed_tasks = array( + 'addIndex', + 'updateIndex', + 'removeIndex', + 'deleteItems', + 'deleteAllIndexItems' + ); $select->fields('t') - // Only retrieve tasks we can handle. - ->condition('t.type', array('addIndex', 'updateIndex', 'removeIndex', 'deleteItems', 'deleteAllIndexItems'), 'IN'); + ->condition('t.type', $allowed_tasks, 'IN'); + if ($server) { if (!$server->status()) { return FALSE; diff --git a/src/Tests/IntegrationTest.php b/src/Tests/IntegrationTest.php index a14f24d..bf81971 100644 --- a/src/Tests/IntegrationTest.php +++ b/src/Tests/IntegrationTest.php @@ -98,6 +98,53 @@ class IntegrationTest extends WebTestBase { } /** + * Test what happens when an index has an integer as id/label. + * + * This needs to be in a seperate index because we also want to see what + * happens with the content and we don't want to mess with the content entity + * tracking of the other index. + */ + public function testIntegerIndex() { + $this->drupalLogin($this->adminUser); + $this->getTestServer(); + + $this->drupalCreateNode(array('type' => 'article')); + $this->drupalCreateNode(array('type' => 'article')); + + $this->drupalGet('admin/config/search/search-api/add-index'); + + $this->indexId = 123; + $edit = array( + 'name' => $this->indexId, + 'id' => $this->indexId, + 'status' => 1, + 'description' => 'test Index:: 123~', + 'server' => 'webtest_server', + 'datasources[]' => array('entity:node'), + ); + $this->drupalPostForm(NULL, $edit, $this->t('Save')); + $this->assertText($this->t('The index was successfully saved.')); + $this->assertText($this->t('Successfully tracked @count items for this index.', array('@count' => 2))); + $this->assertEqual(2, $this->countTrackedItems()); + + $this->enableAllProcessors(); + $this->checkFieldLabels(); + + $this->addFieldsToIndex(); + $this->removeFieldsFromIndex(); + + $this->configureFilter(); + $this->configureFilterPage(); + $this->checkProcessorChanges(); + $this->changeProcessorFieldBoost(); + + $this->setReadOnly(); + $this->disableEnableIndex(); + $this->changeIndexDatasource(); + $this->changeIndexServer(); + } + + /** * Tests creating a search server via the UI. */ protected function createServer($server_id = '_test_server') { @@ -169,7 +216,6 @@ class IntegrationTest extends WebTestBase { $this->assertText($this->t('@name field is required.', array('@name' => $this->t('Machine-readable name')))); $this->assertText($this->t('@name field is required.', array('@name' => $this->t('Data sources')))); - $edit = array( 'name' => $index_name, 'id' => $this->indexId, @@ -382,7 +428,9 @@ class IntegrationTest extends WebTestBase { * The number of tracked items in the test index. */ protected function countTrackedItems() { - return $this->getIndex()->getTracker()->getTotalItemsCount(); + return $this->getIndex() + ->getTrackerInstance() + ->getTotalItemsCount(); } /** @@ -392,7 +440,9 @@ class IntegrationTest extends WebTestBase { * The number of unindexed items in the test index. */ protected function countRemainingItems() { - return $this->getIndex()->getTracker()->getRemainingItemsCount(); + return $this->getIndex() + ->getTrackerInstance() + ->getRemainingItemsCount(); } /** @@ -723,7 +773,7 @@ class IntegrationTest extends WebTestBase { $this->drupalPostForm($index_path, array(), $this->t('Index now')); - $remaining_after = $index->getTracker()->getRemainingItemsCount(); + $remaining_after = $index->getTrackerInstance()->getRemainingItemsCount(); $this->assertEqual(0, $remaining_after, 'Items were indexed after removing the "read only" flag.'); } diff --git a/src/Tests/LanguageIntegrationTest.php b/src/Tests/LanguageIntegrationTest.php index 5dfec22..0dc654e 100644 --- a/src/Tests/LanguageIntegrationTest.php +++ b/src/Tests/LanguageIntegrationTest.php @@ -128,7 +128,7 @@ class LanguageIntegrationTest extends WebTestBase { protected function countTrackedItems() { /** @var \Drupal\search_api\IndexInterface $index */ $index = Index::load($this->indexId); - return $index->getTracker()->getTotalItemsCount(); + return $index->getTrackerInstance()->getTotalItemsCount(); } /** diff --git a/src/Tests/Processor/ContentAccessTest.php b/src/Tests/Processor/ContentAccessTest.php index b301cd4..1b443c5 100644 --- a/src/Tests/Processor/ContentAccessTest.php +++ b/src/Tests/Processor/ContentAccessTest.php @@ -109,7 +109,23 @@ class ContentAccessTest extends ProcessorTestBase { $this->nodes[2]->save(); // Also index users, to verify that they are unaffected by the processor. - $this->index->set('datasources', array('entity:comment', 'entity:node', 'entity:user')); + $this->index->set( + 'datasource_settings', + array( + 'entity:comment' => array( + 'plugin_id' => 'entity:comment', + 'settings' => array(), + ), + 'entity:node' => array( + 'plugin_id' => 'entity:node', + 'settings' => array(), + ), + 'entity:user' => array( + 'plugin_id' => 'entity:user', + 'settings' => array(), + ) + ) + ); $this->index->save(); \Drupal::getContainer()->get('search_api.index_task_manager')->addItemsAll($this->index); @@ -128,6 +144,7 @@ class ContentAccessTest extends ProcessorTestBase { $query = Utility::createQuery($this->index); $result = $query->execute(); + $this->assertEqual($result->getResultCount(), 4); $this->assertResults($result, array('user' => array(0), 'comment' => array(0), 'node' => array(0, 1))); } diff --git a/src/Tests/Processor/ProcessorIntegrationTest.php b/src/Tests/Processor/ProcessorIntegrationTest.php index ad617c8..2d6bf7a 100644 --- a/src/Tests/Processor/ProcessorIntegrationTest.php +++ b/src/Tests/Processor/ProcessorIntegrationTest.php @@ -32,7 +32,12 @@ class ProcessorIntegrationTest extends WebTestBase { 'name' => 'Test index', 'id' => $this->indexId, 'status' => 1, - 'datasources' => array('entity:node'), + 'datasource_settings' => array( + 'entity:node' => array( + 'plugin_id' => 'entity:node', + 'settings' => array(), + ) + ), ))->save(); } @@ -129,7 +134,6 @@ class ProcessorIntegrationTest extends WebTestBase { // testing environment regarding the YAML in the "tags" setting. $edit = array( 'status[html_filter]' => 1, - 'processors[html_filter][settings][fields][search_api_language]' => FALSE, 'processors[html_filter][settings][title]' => FALSE, 'processors[html_filter][settings][alt]' => FALSE, 'processors[html_filter][settings][tags]' => 'h1: 10' @@ -142,11 +146,6 @@ class ProcessorIntegrationTest extends WebTestBase { */ public function checkIgnoreCaseIntegration() { $this->enableProcessor('ignorecase'); - - $edit = array( - 'processors[ignorecase][settings][fields][search_api_language]' => FALSE, - ); - $this->editSettingsForm($edit, 'ignorecase'); } /** @@ -156,7 +155,6 @@ class ProcessorIntegrationTest extends WebTestBase { $this->enableProcessor('ignore_character'); $edit = array( - 'processors[ignore_character][settings][fields][search_api_language]' => FALSE, 'processors[ignore_character][settings][ignorable]' => '[¿¡!?,.]', 'processors[ignore_character][settings][strip][character_sets][Cc]' => TRUE, ); @@ -168,10 +166,9 @@ class ProcessorIntegrationTest extends WebTestBase { */ public function checkLanguageIntegration() { $index = $this->loadIndex(); - $processors = $index->getProcessorSettings(); + $processors = $index->getProcessors(); $this->assertTrue(!empty($processors['language']), 'The "language" processor is enabled by default.'); - unset($processors['language']); - $index->setProcessorSettings($processors)->save(); + $index->removeProcessor('language'); $processors = $this->loadIndex()->getProcessors(); $this->assertTrue(!empty($processors['language']), 'The "language" processor cannot be disabled.'); } @@ -228,11 +225,6 @@ class ProcessorIntegrationTest extends WebTestBase { */ public function checkTransliterationIntegration() { $this->enableProcessor('transliteration'); - - $edit = array( - 'processors[transliteration][settings][fields][search_api_language]' => FALSE, - ); - $this->editSettingsForm($edit, 'transliteration'); } /** @@ -240,10 +232,9 @@ class ProcessorIntegrationTest extends WebTestBase { */ public function checkUrlFieldIntegration() { $index = $this->loadIndex(); - $processors = $index->getProcessorSettings(); + $processors = $index->getProcessors(); $this->assertTrue(!empty($processors['add_url']), 'The "Add URL" processor is enabled by default.'); - unset($processors['add_url']); - $index->setProcessorSettings($processors)->save(); + $index->removeProcessor('add_url'); $processors = $this->loadIndex()->getProcessors(); $this->assertTrue(!empty($processors['add_url']), 'The "Add URL" processor cannot be disabled.'); } diff --git a/src/Tests/Processor/ProcessorTestBase.php b/src/Tests/Processor/ProcessorTestBase.php index 2809c31..cc93553 100644 --- a/src/Tests/Processor/ProcessorTestBase.php +++ b/src/Tests/Processor/ProcessorTestBase.php @@ -9,6 +9,7 @@ namespace Drupal\search_api\Tests\Processor; use Drupal\search_api\Entity\Index; use Drupal\search_api\Entity\Server; +use Drupal\search_api\Item\Field; use Drupal\search_api\Utility; use Drupal\system\Tests\Entity\EntityUnitTestBase; @@ -87,29 +88,44 @@ abstract class ProcessorTestBase extends EntityUnitTestBase { 'id' => 'index', 'name' => 'Index name', 'status' => TRUE, - 'datasources' => array('entity:comment', 'entity:node'), - 'server' => 'server', - 'tracker' => 'default', - )); - $this->index->setServer($this->server); - $this->index->setFieldSettings(array( - 'subject' => array( - 'label' => 'Subject', - 'type' => 'text', - 'datasource_id' => 'entity:comment', - 'property_path' => 'subject', + 'datasource_settings' => array( + 'entity:comment' => array( + 'plugin_id' => 'entity:comment', + 'settings' => array(), + ), + 'entity:node' => array( + 'plugin_id' => 'entity:node', + 'settings' => array(), + ), ), - 'title' => array( - 'label' => 'Title', - 'type' => 'text', - 'datasource_id' => 'entity:node', - 'property_path' => 'title', + 'server' => 'server', + 'tracker_settings' => array( + 'default' => array( + 'plugin_id' => 'default', + 'settings' => array() + ) ), )); + $this->index->setServer($this->server); + + $subject_field = new Field($this->index, 'subject'); + $subject_field->setType('text'); + $subject_field->setLabel('Subject'); + $subject_field->setDatasourceId('entity:comment'); + $subject_field->setPropertyPath('subject'); + $this->index->addField($subject_field); + + $title_field = new Field($this->index, 'title'); + $title_field->setType('text'); + $title_field->setLabel('Title'); + $title_field->setDatasourceId('entity:node'); + $title_field->setPropertyPath('title'); + $this->index->addField($title_field); + if ($processor) { - $this->index->setProcessorSettings(array( + $this->index->set('processor_settings', array( $processor => array( - 'processor_id' => $processor, + 'plugin_id' => $processor, 'weights' => array(), 'settings' => array(), ), diff --git a/src/Tests/Processor/RenderedItemTest.php b/src/Tests/Processor/RenderedItemTest.php index 8a920e4..6ff3751 100644 --- a/src/Tests/Processor/RenderedItemTest.php +++ b/src/Tests/Processor/RenderedItemTest.php @@ -10,6 +10,8 @@ namespace Drupal\search_api\Tests\Processor; use Drupal\Core\TypedData\DataDefinition; use Drupal\node\Entity\Node; use Drupal\node\Entity\NodeType; +use Drupal\search_api\Item\Field; +use Drupal\search_api\Item\FieldInterface; use Drupal\search_api\Utility; use Drupal\user\Entity\Role; use Drupal\user\Entity\User; @@ -49,6 +51,11 @@ class RenderedItemTest extends ProcessorTestBase { $this->installSchema('system', array('router')); \Drupal::service('router.builder')->rebuild(); + $rendered_item_field = new Field($this->index, 'rendered_item'); + $rendered_item_field->setPropertyPath('rendered_item'); + $rendered_item_field->setType('text'); + $this->index->addField($rendered_item_field); + // Create a node type for testing. $type = NodeType::create(array( 'type' => 'page', @@ -115,6 +122,29 @@ class RenderedItemTest extends ProcessorTestBase { } /** + * Tests that the processor is added correctly. + */ + public function testAddProcessor() { + $processors = $this->index->getProcessors(); + $this->assertTrue(array_key_exists('rendered_item', $processors), 'Processor successfully added.'); + + $items = array(); + foreach ($this->nodes as $node) { + $items[] = array( + 'datasource' => 'entity:node', + 'item' => $node->getTypedData(), + 'item_id' => $node->id(), + 'text' => 'node text' . $node->id(), + ); + } + $items = $this->generateItems($items); + + foreach ($items as $item) { + $this->assertTrue(array_key_exists('rendered_item', $item->getFields()), 'Field successfully added.'); + } + } + + /** * Tests whether the rendered_item field is correctly filled by the processor. */ public function testPreprocessIndexItems() { diff --git a/src/Tests/WebTestBase.php b/src/Tests/WebTestBase.php index 8b85ea6..72bb5e2 100644 --- a/src/Tests/WebTestBase.php +++ b/src/Tests/WebTestBase.php @@ -169,7 +169,18 @@ abstract class WebTestBase extends SimpletestWebTestBase { 'name' => $name, 'description' => $name . ' description', 'server' => $server_id, - 'datasources' => array($datasource_id), + 'datasource_settings' => array( + $datasource_id => array( + 'plugin_id' => $datasource_id, + 'settings' => array(), + ) + ), + 'tracker_settings' => array( + 'default' => array( + 'plugin_id' => 'default', + 'settings' => array(), + ) + ), )); $index->save(); $this->indexId = $index->id(); diff --git a/src/UnsavedIndexConfiguration.php b/src/UnsavedIndexConfiguration.php index 8fe07be..bb93c57 100644 --- a/src/UnsavedIndexConfiguration.php +++ b/src/UnsavedIndexConfiguration.php @@ -249,8 +249,8 @@ class UnsavedIndexConfiguration implements IndexInterface, UnsavedConfigurationI /** * {@inheritdoc} */ - public function getTracker() { - return $this->entity->getTracker(); + public function getTrackerInstance() { + return $this->entity->getTrackerInstance(); } /** @@ -277,8 +277,8 @@ class UnsavedIndexConfiguration implements IndexInterface, UnsavedConfigurationI /** * {@inheritdoc} */ - public function getServer() { - return $this->entity->getServer(); + public function getServerInstance() { + return $this->entity->getServerInstance(); } /** diff --git a/src/Utility.php b/src/Utility.php index 15dccc4..34a4717 100644 --- a/src/Utility.php +++ b/src/Utility.php @@ -153,7 +153,7 @@ class Utility { if (empty(static::$dataTypeFallbackMapping[$index_id])) { $server = NULL; try { - $server = $index->getServer(); + $server = $index->getServerInstance(); } catch (SearchApiException $e) { // If the server isn't available, just ignore it here and return all diff --git a/tests/search_api_test_backend/src/Plugin/search_api/backend/TestBackend.php b/tests/search_api_test_backend/src/Plugin/search_api/backend/TestBackend.php index 5032989..57ced24 100644 --- a/tests/search_api_test_backend/src/Plugin/search_api/backend/TestBackend.php +++ b/tests/search_api_test_backend/src/Plugin/search_api/backend/TestBackend.php @@ -128,6 +128,18 @@ class TestBackend extends BackendPluginBase { $results = Utility::createSearchResultSet($query); $result_items = array(); $datasources = $query->getIndex()->getDatasources(); + + // Searching on an index without datasources is useless, return an empty + // result set and log this so the admin knows what's going on. + if ($datasources === array()) { + $logger = \Drupal::getContainer() + ->get('logger.factory') + ->get('search_api'); + $logger->notice($this->t('Tried searching on an index with no datasources.')); + + $results->setResultCount(0); + return $results; + } /** @var \Drupal\search_api\Datasource\DatasourceInterface $datasource */ $datasource = reset($datasources); $datasource_id = $datasource->getPluginId(); diff --git a/tests/search_api_test_db/config/install/search_api.index.database_search_index.yml b/tests/search_api_test_db/config/install/search_api.index.database_search_index.yml index 4f42d29..72e1971 100644 --- a/tests/search_api_test_db/config/install/search_api.index.database_search_index.yml +++ b/tests/search_api_test_db/config/install/search_api.index.database_search_index.yml @@ -2,7 +2,7 @@ id: database_search_index name: 'Test index' description: 'An index used for testing' read_only: false -fields: +field_settings: id: label: ID type: integer @@ -38,27 +38,30 @@ fields: label: 'Item language' type: string property_path: search_api_language - index_locked: true + indexed_locked: true type_locked: true -processors: +processor_settings: add_url: - processor_id: add_url + plugin_id: add_url weights: preprocess_index: -30 settings: { } language: - processor_id: language + plugin_id: language weights: preprocess_index: -50 settings: { } options: cron_limit: -1 index_directly: false -datasources: - - 'entity:entity_test' -datasource_configs: { } -tracker: default -tracker_config: { } +datasource_settings: + 'entity:entity_test': + plugin_id: 'entity:entity_test' + settings: {} +tracker_settings: + default: + plugin_id: default + settings: {} server: database_search_server status: true langcode: en diff --git a/tests/search_api_test_dependencies/src/Plugin/search_api/datasource/TestDatasource.php b/tests/search_api_test_dependencies/src/Plugin/search_api/datasource/TestDatasource.php index 800f18f..58056ac 100644 --- a/tests/search_api_test_dependencies/src/Plugin/search_api/datasource/TestDatasource.php +++ b/tests/search_api_test_dependencies/src/Plugin/search_api/datasource/TestDatasource.php @@ -29,7 +29,10 @@ class TestDatasource extends DatasourcePluginBase { * {@inheritdoc} */ public function calculateDependencies() { - return $this->configuration; + if (isset($this->configuration['settings'])) { + return $this->configuration['settings']; + } + return array(); } /** diff --git a/tests/search_api_test_dependencies/src/Plugin/search_api/processor/TestProcessor.php b/tests/search_api_test_dependencies/src/Plugin/search_api/processor/TestProcessor.php index 5ce230c..01136fa 100644 --- a/tests/search_api_test_dependencies/src/Plugin/search_api/processor/TestProcessor.php +++ b/tests/search_api_test_dependencies/src/Plugin/search_api/processor/TestProcessor.php @@ -21,7 +21,10 @@ class TestProcessor extends ProcessorPluginBase { * {@inheritdoc} */ public function calculateDependencies() { - return $this->configuration; + if (isset($this->configuration)) { + return $this->configuration; + } + return array(); } /** diff --git a/tests/search_api_test_dependencies/src/Plugin/search_api/tracker/TestTracker.php b/tests/search_api_test_dependencies/src/Plugin/search_api/tracker/TestTracker.php index 6ac77d4..dd43a65 100644 --- a/tests/search_api_test_dependencies/src/Plugin/search_api/tracker/TestTracker.php +++ b/tests/search_api_test_dependencies/src/Plugin/search_api/tracker/TestTracker.php @@ -21,7 +21,10 @@ class TestTracker extends BasicTracker { * {@inheritdoc} */ public function calculateDependencies() { - return $this->configuration; + if (isset($this->configuration)) { + return $this->configuration; + } + return array(); } /** diff --git a/tests/src/Kernel/CliTest.php b/tests/src/Kernel/CliTest.php index 70fd5cc..96109ad 100644 --- a/tests/src/Kernel/CliTest.php +++ b/tests/src/Kernel/CliTest.php @@ -94,15 +94,25 @@ class CliTest extends KernelTestBase { 'name' => 'Test index', 'id' => 'index', 'status' => 1, - 'datasources' => array('entity:entity_test'), - 'tracker' => 'default', + 'datasource_settings' => array( + 'entity:entity_test' => array( + 'plugin_id' => 'entity:entity_test', + 'settings' => array() + ) + ), + 'tracker_settings' => array( + 'default' => array( + 'plugin_id' => 'default', + 'settings' => array() + ) + ), 'server' => $this->server->id(), 'options' => array('index_directly' => TRUE), )); $index->save(); - $total_items = $index->getTracker()->getTotalItemsCount(); - $indexed_items = $index->getTracker()->getIndexedItemsCount(); + $total_items = $index->getTrackerInstance()->getTotalItemsCount(); + $indexed_items = $index->getTrackerInstance()->getIndexedItemsCount(); $this->assertEquals($total_items, 2, 'The 2 items are tracked.'); $this->assertEquals($indexed_items, 0, 'No items are indexed'); @@ -122,8 +132,8 @@ class CliTest extends KernelTestBase { 'category' => 'item_category' ))->save(); - $total_items = $index->getTracker()->getTotalItemsCount(); - $indexed_items = $index->getTracker()->getIndexedItemsCount(); + $total_items = $index->getTrackerInstance()->getTotalItemsCount(); + $indexed_items = $index->getTrackerInstance()->getIndexedItemsCount(); $this->assertEquals($total_items, 4, 'All 4 items are tracked.'); $this->assertEquals($indexed_items, 2, '2 items are indexed'); diff --git a/tests/src/Kernel/DependencyRemovalTest.php b/tests/src/Kernel/DependencyRemovalTest.php index 61a7da3..2c23e62 100644 --- a/tests/src/Kernel/DependencyRemovalTest.php +++ b/tests/src/Kernel/DependencyRemovalTest.php @@ -48,6 +48,9 @@ class DependencyRemovalTest extends KernelTestBase { public function setUp() { parent::setUp(); + $this->installSchema('user', array('users_data')); + $this->installEntitySchema('user'); + // The server tasks manager is needed when removing a server. $mock = $this->getMock('Drupal\search_api\Task\ServerTaskManagerInterface'); $this->container->set('search_api.server_task_manager', $mock); @@ -57,9 +60,17 @@ class DependencyRemovalTest extends KernelTestBase { $this->index = Index::create(array( 'id' => 'test_index', 'name' => 'Test index', - 'tracker' => 'default', - 'datasources' => array( - 'entity:user', + 'tracker_settings' => array( + 'default' => array( + 'plugin_id' => 'default', + 'settings' => array(), + ) + ), + 'datasource_settings' => array( + 'entity:user' => array( + 'plugin_id' => 'entity:user', + 'settings' => array(), + ) ), )); @@ -173,17 +184,21 @@ class DependencyRemovalTest extends KernelTestBase { // server. $dependency_key = $this->dependency->getConfigDependencyKey(); $dependency_name = $this->dependency->getConfigDependencyName(); - $this->index->set('datasources', array( - 'entity:user', - 'search_api_test_dependencies', - )); - $this->index->set('datasource_configs', array( + $datasource_settings = array( + 'entity:user' => array( + 'plugin_id' => 'entity:user', + 'settings' => array(), + ), 'search_api_test_dependencies' => array( - $dependency_key => array( - $dependency_name, + 'plugin_id' => 'search_api_test_dependencies', + 'settings' => array( + $dependency_key => array( + $dependency_name, + ), ), - ), - )); + ) + ); + $this->index->set('datasource_settings', $datasource_settings); $this->index->save(); // Check the dependencies were calculated correctly. @@ -210,15 +225,14 @@ class DependencyRemovalTest extends KernelTestBase { // Depending on whether the plugin should have removed the dependency or // not, make sure the right action was taken. - $datasources = $this->index->get('datasources'); - $datasource_configs = $this->index->get('datasource_configs'); + $datasource_settings = $this->index->get('datasource_settings'); + if ($remove_dependency) { - $this->assertContains('search_api_test_dependencies', $datasources, 'Datasource not removed'); - $this->assertEmpty($datasource_configs['search_api_test_dependencies'], 'Datasource settings adapted'); + $this->assertArrayHasKey('search_api_test_dependencies', $datasource_settings, 'Datasource not removed'); + $this->assertEmpty($datasource_settings['search_api_test_dependencies'], 'Datasource settings adapted'); } else { - $this->assertNotContains('search_api_test_dependencies', $datasources, 'Datasource removed'); - $this->assertArrayNotHasKey('search_api_test_dependencies', $datasource_configs, 'Datasource config removed'); + $this->assertArrayNotHasKey('search_api_test_dependencies', $datasource_settings, 'Datasource config removed'); } } @@ -231,15 +245,15 @@ class DependencyRemovalTest extends KernelTestBase { // server. $dependency_key = $this->dependency->getConfigDependencyKey(); $dependency_name = $this->dependency->getConfigDependencyName(); - $this->index->set('datasources', array( - 'search_api_test_dependencies', - )); - $this->index->set('datasource_configs', array( + $this->index->set('datasource_settings', array( 'search_api_test_dependencies' => array( - $dependency_key => array( - $dependency_name, + 'plugin_id' => 'search_api_test_dependencies', + 'settings' => array( + $dependency_key => array( + $dependency_name, + ), ), - ), + ) )); $this->index->save(); @@ -275,9 +289,9 @@ class DependencyRemovalTest extends KernelTestBase { // server. $dependency_key = $this->dependency->getConfigDependencyKey(); $dependency_name = $this->dependency->getConfigDependencyName(); - $this->index->set('processors', array( + $this->index->set('processor_settings', array( 'search_api_test_dependencies' => array( - 'processor_id' => 'search_api_test_dependencies', + 'plugin_id' => 'search_api_test_dependencies', 'settings' => array( $dependency_key => array( $dependency_name, @@ -311,13 +325,13 @@ class DependencyRemovalTest extends KernelTestBase { // Depending on whether the plugin should have removed the dependency or // not, make sure the right action was taken. - $processors = $this->index->get('processors'); + $processor_settings = $this->index->get('processor_settings'); if ($remove_dependency) { - $this->assertArrayHasKey('search_api_test_dependencies', $processors, 'Processor not removed'); - $this->assertEmpty($processors['search_api_test_dependencies']['settings'], 'Processor settings adapted'); + $this->assertArrayHasKey('search_api_test_dependencies', $processor_settings, 'Processor not removed'); + $this->assertEmpty($processor_settings['search_api_test_dependencies']['settings'], 'Processor settings adapted'); } else { - $this->assertArrayNotHasKey('search_api_test_dependencies', $processors, 'Processor removed'); + $this->assertArrayNotHasKey('search_api_test_dependencies', $processor_settings, 'Processor removed'); } } @@ -331,17 +345,23 @@ class DependencyRemovalTest extends KernelTestBase { * @dataProvider dependencyTestDataProvider */ public function testTrackerDependency($remove_dependency) { + // Set the server on the index and save that, too. + $this->index->set('server', $this->dependency->id()); + // Set the tracker for the index and save it. The tracker configuration // contains the dependencies it will return – in our case, we use the test // server. $dependency_key = $this->dependency->getConfigDependencyKey(); $dependency_name = $this->dependency->getConfigDependencyName(); - $this->index->set('tracker', 'search_api_test_dependencies'); - $this->index->set('tracker_config', array( - $dependency_key => array( - $dependency_name, - ), + $tracker_settings = array('search_api_test_dependencies' => array( + 'plugin_id' => 'search_api_test_dependencies', + 'settings' => array( + $dependency_key => array( + $dependency_name, + ), + ) )); + $this->index->set('tracker_settings', $tracker_settings); $this->index->save(); // Check the dependencies were calculated correctly. @@ -353,13 +373,12 @@ class DependencyRemovalTest extends KernelTestBase { // \Drupal\search_api_test_dependencies\Plugin\search_api\tracker\TestTracker::onDependencyRemoval(). $key = 'search_api_test_dependencies.tracker.remove'; \Drupal::state()->set($key, $remove_dependency); + // If the index resets the tracker, it needs to know the ID of the default // tracker. - if (!$remove_dependency) { - \Drupal::configFactory()->getEditable('search_api.settings') - ->set('default_tracker', 'default') - ->save(); - } + \Drupal::configFactory()->getEditable('search_api.settings') + ->set('default_tracker', 'default') + ->save(); // Delete the tracker's dependency. $this->dependency->delete(); @@ -375,9 +394,14 @@ class DependencyRemovalTest extends KernelTestBase { // Depending on whether the plugin should have removed the dependency or // not, make sure the right action was taken. - $tracker = $this->index->get('tracker'); - $tracker_config = $this->index->get('tracker_config'); - if ($remove_dependency) { + $tracker_settings = $this->index->get('tracker_settings'); + + // Get first tracker in the list if there is a list. There should always + // be a tracker so there is no issue in taking the first key. + $tracker = array_keys($tracker_settings)[0]; + $tracker_config = $tracker_settings[$tracker]['settings']; + + if (!$remove_dependency) { $this->assertEquals('search_api_test_dependencies', $tracker, 'Tracker not reset'); $this->assertEmpty($tracker_config, 'Tracker settings adapted'); } diff --git a/tests/src/Kernel/LanguageKernelTest.php b/tests/src/Kernel/LanguageKernelTest.php index 671a957..dacdc3e 100644 --- a/tests/src/Kernel/LanguageKernelTest.php +++ b/tests/src/Kernel/LanguageKernelTest.php @@ -104,12 +104,23 @@ class LanguageKernelTest extends KernelTestBase { $this->server->save(); // Create a test index. + $datasource_id = 'entity:' . $this->testEntityTypeId; $this->index = Index::create(array( 'name' => 'Test Index', 'id' => 'test_index', 'status' => 1, - 'datasources' => array('entity:' . $this->testEntityTypeId), - 'tracker' => 'default', + 'datasource_settings' => array( + $datasource_id => array( + 'plugin_id' => $datasource_id, + 'settings' => array(), + ), + ), + 'tracker_settings' => array( + 'default'=> array( + 'plugin_id' => 'default', + 'settings' => array(), + ), + ), 'server' => $this->server->id(), 'options' => array('index_directly' => FALSE), )); @@ -153,10 +164,10 @@ class LanguageKernelTest extends KernelTestBase { $this->assertEquals($expected, $datasource_item_ids, 'Datasource returns correct item ids.'); // Test indexing the new entity. - $this->assertEquals(0, $this->index->getTracker()->getIndexedItemsCount(), 'The index is empty.'); - $this->assertEquals(2, $this->index->getTracker()->getTotalItemsCount(), 'There are two items to be indexed.'); + $this->assertEquals(0, $this->index->getTrackerInstance()->getIndexedItemsCount(), 'The index is empty.'); + $this->assertEquals(2, $this->index->getTrackerInstance()->getTotalItemsCount(), 'There are two items to be indexed.'); $this->index->indexItems(); - $this->assertEquals(2, $this->index->getTracker()->getIndexedItemsCount(), 'Two items have been indexed.'); + $this->assertEquals(2, $this->index->getTrackerInstance()->getIndexedItemsCount(), 'Two items have been indexed.'); // Now, make the first entity language-specific by assigning a language. $default_langcode = $this->langcodes[0]; @@ -175,8 +186,8 @@ class LanguageKernelTest extends KernelTestBase { $this->assertEquals($expected, $datasource_item_ids, 'Datasource returns correct item ids.'); // Test that the index needs to be updated. - $this->assertEquals(1, $this->index->getTracker()->getIndexedItemsCount(), 'The updated item needs to be reindexed.'); - $this->assertEquals(2, $this->index->getTracker()->getTotalItemsCount(), 'There are two items in total.'); + $this->assertEquals(1, $this->index->getTrackerInstance()->getIndexedItemsCount(), 'The updated item needs to be reindexed.'); + $this->assertEquals(2, $this->index->getTrackerInstance()->getTotalItemsCount(), 'There are two items in total.'); // Set two translations for the first entity and test that the datasource // returns three separate item IDs, one for each translation. @@ -197,8 +208,8 @@ class LanguageKernelTest extends KernelTestBase { $this->assertEquals($expected, $datasource_item_ids, 'Datasource returns correct item ids for a translated entity.'); // Test that the index needs to be updated. - $this->assertEquals(1, $this->index->getTracker()->getIndexedItemsCount(), 'The updated items needs to be reindexed.'); - $this->assertEquals(4, $this->index->getTracker()->getTotalItemsCount(), 'There are four items in total.'); + $this->assertEquals(1, $this->index->getTrackerInstance()->getIndexedItemsCount(), 'The updated items needs to be reindexed.'); + $this->assertEquals(4, $this->index->getTrackerInstance()->getTotalItemsCount(), 'There are four items in total.'); // Delete one translation and test that the datasource returns only three // items. @@ -215,10 +226,10 @@ class LanguageKernelTest extends KernelTestBase { $this->assertEquals($expected, $datasource_item_ids, 'Datasource returns correct item ids for a translated entity.'); // Test reindexing. - $this->assertEquals(3, $this->index->getTracker()->getTotalItemsCount(), 'There are three items in total.'); - $this->assertEquals(1, $this->index->getTracker()->getIndexedItemsCount(), 'The updated items needs to be reindexed.'); + $this->assertEquals(3, $this->index->getTrackerInstance()->getTotalItemsCount(), 'There are three items in total.'); + $this->assertEquals(1, $this->index->getTrackerInstance()->getIndexedItemsCount(), 'The updated items needs to be reindexed.'); $this->index->indexItems(); - $this->assertEquals(3, $this->index->getTracker()->getIndexedItemsCount(), 'Three items are indexed.'); + $this->assertEquals(3, $this->index->getTrackerInstance()->getIndexedItemsCount(), 'Three items are indexed.'); } }