search_api-8.x-1.15/tests/src/Kernel/Processor/AddHierarchyTest.php
tests/src/Kernel/Processor/AddHierarchyTest.php
<?php namespace Drupal\Tests\search_api\Kernel\Processor; use Drupal\Core\Field\FieldStorageDefinitionInterface; use Drupal\field\Tests\EntityReference\EntityReferenceTestTrait; use Drupal\node\Entity\NodeType; use Drupal\search_api\Item\Field; use Drupal\search_api\Query\Query; use Drupal\Tests\node\Traits\NodeCreationTrait; use Drupal\Tests\search_api\Kernel\ResultsTrait; use Drupal\Tests\taxonomy\Functional\TaxonomyTestTrait; /** * Tests the "Hierarchy" processor. * * @see \Drupal\search_api\Plugin\search_api\processor\AddHierarchy * * @group search_api * * @coversDefaultClass \Drupal\search_api\Plugin\search_api\processor\AddHierarchy */ class AddHierarchyTest extends ProcessorTestBase { use NodeCreationTrait; use EntityReferenceTestTrait; use ResultsTrait; use TaxonomyTestTrait; /** * {@inheritdoc} */ public static $modules = [ 'filter', 'taxonomy', ]; /** * A hierarchy to test. * * @var string[][] */ protected static $hierarchy = [ 'fruit' => [ 'apple', 'pear', ], 'vegetable' => [ 'radish', 'turnip', ], ]; /** * The nodes created for testing. * * @var \Drupal\node\NodeInterface[] */ protected $nodes = []; /** * Hierarchical taxonomy terms. * * This is keyed by "type.item", for example: "fruit.pear". * * @var \Drupal\taxonomy\TermInterface[] */ protected $terms = []; /** * Vocabulary to test with when using taxonomy for the hierarchy. * * @var \Drupal\taxonomy\Entity\Vocabulary */ protected $vocabulary; /** * {@inheritdoc} */ public function setUp($processor = NULL) { parent::setUp(); $this->installConfig(['filter']); $this->installEntitySchema('taxonomy_term'); $this->createTaxonomyHierarchy(); // Create a node type for testing. $type = NodeType::create([ 'type' => 'page', 'name' => 'page', ]); $type->save(); // Add the taxonomy field to page type. $this->createEntityReferenceField( 'node', 'page', 'term_field', NULL, 'taxonomy_term', 'default', [], FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED ); // Add a generic entity reference field. $this->createEntityReferenceField( 'node', 'page', 'parent_reference', NULL, 'node', 'default', [] ); // Index the taxonomy field. $term_field = new Field($this->index, 'term_field'); $term_field->setType('integer'); $term_field->setPropertyPath('term_field'); $term_field->setDatasourceId('entity:node'); $term_field->setLabel('Terms'); $this->index->addField($term_field); // Index the entity reference field. $reference_field = new Field($this->index, 'parent_reference'); $reference_field->setType('integer'); $reference_field->setPropertyPath('parent_reference'); $reference_field->setDatasourceId('entity:node'); $reference_field->setLabel('Parent page'); $this->index->addField($reference_field); // Add the "Index hierarchy" processor only now (not in parent method) since // it can only be enabled once there are actually hierarchical fields. $this->processor = \Drupal::getContainer() ->get('search_api.plugin_helper') ->createProcessorPlugin($this->index, 'hierarchy'); $this->index->addProcessor($this->processor); // Add the node datasource to the index. $datasources = \Drupal::getContainer() ->get('search_api.plugin_helper') ->createDatasourcePlugins($this->index, ['entity:node']); $this->index->setDatasources($datasources); $this->index->save(); $this->container ->get('search_api.index_task_manager') ->addItemsAll($this->index); $index_storage = $this->container ->get('entity_type.manager') ->getStorage('search_api_index'); $index_storage->resetCache([$this->index->id()]); $this->index = $index_storage->load($this->index->id()); } /** * Helper function to create the hierarchy with taxonomy terms. */ protected function createTaxonomyHierarchy() { $this->vocabulary = $this->createVocabulary(); foreach (static::$hierarchy as $type => $items) { // Add the 'type' item, and nest items underneath. $this->terms[$type] = $type_term = $this->createTerm($this->vocabulary, [ 'name' => $type, ]); foreach ($items as $item) { $this->terms["$type.$item"] = $this->createTerm($this->vocabulary, [ 'name' => $item, 'parent' => $type_term, ]); } } } /** * Tests taxonomy-based hierarchy indexing. * * @covers ::preprocessIndexItems */ public function testPreprocessIndexItemsTaxonomy() { // Add hierarchical terms to 3 nodes. foreach (['vegetable.turnip', 'vegetable', 'fruit.pear'] as $i => $term) { $this->nodes[$i] = $this->createNode([ 'type' => 'page', 'term_field' => [ 'target_id' => $this->terms[$term]->id(), ], ]); } $this->index->reindex(); $this->indexItems(); // By default, hierarchy is not indexed, so a search for 'vegetable' should // only return node 2. $query = new Query($this->index); $query->addCondition('term_field', $this->terms['vegetable']->id()); $result = $query->execute(); $expected = ['node' => [1]]; $this->assertResults($result, $expected); // Enable hierarchical indexing. $processor = $this->index->getProcessor('hierarchy'); $processor->setConfiguration([ 'fields' => [ 'term_field' => 'taxonomy_term-parent', ], ]); $this->index->save(); $this->indexItems(); // Query for "vegetable" should return 2 items: // Node 1 is "vegetable.turnip" and node 2 is just "vegetable". $query = new Query($this->index); $query->addCondition('term_field', $this->terms['vegetable']->id()); $result = $query->execute(); $expected = ['node' => [0, 1]]; $this->assertResults($result, $expected); // A search for just turnips should return node 1 only. $query = new Query($this->index); $query->addCondition('term_field', $this->terms['vegetable.turnip']->id()); $result = $query->execute(); $expected = ['node' => [0]]; $this->assertResults($result, $expected); // Also add a term with multiple parents. $this->terms['avocado'] = $this->createTerm($this->vocabulary, [ 'name' => 'Avocado', 'parent' => [$this->terms['fruit']->id(), $this->terms['vegetable']->id()], ]); $this->nodes[3] = $this->createNode([ 'type' => 'page', 'term_field' => [ 'target_id' => $this->terms['avocado']->id(), ], ]); $this->index->reindex(); $this->indexItems(); // Searching for 'fruit' or 'vegetable' should return this new node. $query = new Query($this->index); $query->addCondition('term_field', $this->terms['fruit']->id()); $result = $query->execute(); $expected = ['node' => [2, 3]]; $this->assertResults($result, $expected); $query = new Query($this->index); $query->addCondition('term_field', $this->terms['vegetable']->id()); $result = $query->execute(); $expected = ['node' => [0, 1, 3]]; $this->assertResults($result, $expected); } /** * Tests adding values to Fulltext fields. * * @see https://www.drupal.org/node/3059312 * * @covers ::preprocessIndexItems */ public function testRegression3059312() { // Add hierarchical terms to 3 nodes. foreach (['vegetable.turnip', 'vegetable', 'fruit.pear'] as $i => $term) { $this->nodes[$i] = $this->createNode([ 'type' => 'page', 'term_field' => [ 'target_id' => $this->terms[$term]->id(), ], ]); } // Also add a term with multiple parents. $this->terms['avocado'] = $this->createTerm($this->vocabulary, [ 'name' => 'Avocado', 'parent' => [$this->terms['fruit']->id(), $this->terms['vegetable']->id()], ]); $this->nodes[3] = $this->createNode([ 'type' => 'page', 'term_field' => [ 'target_id' => $this->terms['avocado']->id(), ], ]); // Enable hierarchical indexing. $processor = $this->index->getProcessor('hierarchy'); $processor->setConfiguration([ 'fields' => [ 'term_field' => 'taxonomy_term-parent', ], ]); // Set the field type to "Fulltext". $this->index->getField('term_field')->setType('text'); $this->index->save(); $this->indexItems(); $query = new Query($this->index); $query->addCondition('term_field', $this->terms['fruit']->id()); $result = $query->execute(); $expected = ['node' => [2, 3]]; $this->assertResults($result, $expected); } /** * Tests non-taxonomy-based hierarchy. * * @covers ::preprocessIndexItems * @covers ::addHierarchyValues */ public function testPreprocessIndexItems() { // Setup the nodes to follow the hierarchy. foreach (static::$hierarchy as $type => $items) { $this->nodes[] = $type_node = $this->createNode([ 'title' => $type, ]); foreach ($items as $item) { $this->nodes[] = $this->createNode([ 'title' => $item, 'parent_reference' => ['target_id' => $type_node->id()], ]); } } // Add a third tier of hierarchy for specific types of radishes. foreach (['Cherry Belle', 'Snow Belle', 'Daikon'] as $item) { $this->nodes[] = $this->createNode([ 'title' => $item, 'parent_reference' => ['target_id' => $this->nodes[5]->id()], ]); } $this->index->reindex(); $this->indexItems(); // Initially hierarchy is excluded, so "vegetable" should only return nodes // 5 and 6. $query = new Query($this->index); $query->addCondition('parent_reference', $this->nodes[3]->id()); $result = $query->execute(); $expected = ['node' => [4, 5]]; $this->assertResults($result, $expected); // Enable hierarchical indexing. $processor = $this->index->getProcessor('hierarchy'); $processor->setConfiguration([ 'fields' => [ 'parent_reference' => 'node-parent_reference', ], ]); $this->index->save(); $this->indexItems(); // A search for "vegetable" should now include the hierarchy. $query = new Query($this->index); $query->addCondition('parent_reference', $this->nodes[3]->id()); $result = $query->execute(); $expected = ['node' => [4, 5, 6, 7, 8]]; $this->assertResults($result, $expected); } }