function SearchRankingTest::testHTMLRankings

Tests rankings of HTML tags.

File

core/modules/search/tests/src/Functional/SearchRankingTest.php, line 214

Class

SearchRankingTest

Indexes content and tests ranking factors.

Namespace

Code

public function testHTMLRankings() : void {
    $full_html_format = FilterFormat::create([
        'format' => 'full_html',
        'name' => 'Full HTML',
    ]);
    $full_html_format->save();
    // Test HTML tags with different weights.
    $sorted_tags = [
        'h1',
        'h2',
        'h3',
        'h4',
        'a',
        'h5',
        'h6',
        'NoTag',
    ];
    $shuffled_tags = $sorted_tags;
    // Shuffle tags to ensure HTML tags are ranked properly.
    shuffle($shuffled_tags);
    $settings = [
        'type' => 'page',
        'title' => 'Simple node',
    ];
    $nodes = [];
    foreach ($shuffled_tags as $tag) {
        switch ($tag) {
            case 'a':
                $settings['body'] = [
                    [
                        'value' => Link::fromTextAndUrl('Drupal Rocks', Url::fromRoute('<front>'))->toString(),
                        'format' => 'full_html',
                    ],
                ];
                break;
            case 'NoTag':
                $settings['body'] = [
                    [
                        'value' => 'Drupal Rocks',
                    ],
                ];
                break;
            default:
                $settings['body'] = [
                    [
                        'value' => "<{$tag}>Drupal Rocks</{$tag}>",
                        'format' => 'full_html',
                    ],
                ];
                break;
        }
        $nodes[$tag] = $this->drupalCreateNode($settings);
    }
    // Update the search index.
    $this->nodeSearch
        ->getPlugin()
        ->updateIndex();
    $search_index = \Drupal::service('search.index');
    assert($search_index instanceof SearchIndexInterface);
    $this->nodeSearch
        ->getPlugin()
        ->setSearch('rocks', [], []);
    // Do the search and assert the results.
    $set = $this->nodeSearch
        ->getPlugin()
        ->execute();
    // Test the ranking of each tag.
    foreach ($sorted_tags as $tag_rank => $tag) {
        // Assert the results.
        if ($tag == 'NoTag') {
            $this->assertEquals($nodes[$tag]->id(), $set[$tag_rank]['node']->id(), 'Search tag ranking for plain text order.');
        }
        else {
            $this->assertEquals($nodes[$tag]->id(), $set[$tag_rank]['node']->id(), 'Search tag ranking for "&lt;' . $sorted_tags[$tag_rank] . '&gt;" order.');
        }
    }
    // Test tags with the same weight against the sorted tags.
    $unsorted_tags = [
        'u',
        'b',
        'i',
        'strong',
        'em',
    ];
    foreach ($unsorted_tags as $tag) {
        $settings['body'] = [
            [
                'value' => "<{$tag}>Drupal Rocks</{$tag}>",
                'format' => 'full_html',
            ],
        ];
        $node = $this->drupalCreateNode($settings);
        // Update the search index.
        $this->nodeSearch
            ->getPlugin()
            ->updateIndex();
        $this->nodeSearch
            ->getPlugin()
            ->setSearch('rocks', [], []);
        // Do the search and assert the results.
        $set = $this->nodeSearch
            ->getPlugin()
            ->execute();
        // Ranking should always be second to last.
        $set = array_slice($set, -2, 1);
        // Assert the results.
        $this->assertEquals($node->id(), $set[0]['node']->id(), 'Search tag ranking for "&lt;' . $tag . '&gt;" order.');
        // Delete node so it doesn't show up in subsequent search results.
        $node->delete();
    }
}