SearchApiSolrMultilingualTest.php in Search API Solr 8.2

Namespace

Drupal\Tests\search_api_solr\Kernel

File

tests/src/Kernel/SearchApiSolrMultilingualTest.php

<?php

namespace Drupal\Tests\search_api_solr\Kernel;

use Drupal\Core\Language\LanguageInterface;
use Drupal\language\Entity\ConfigurableLanguage;
use Drupal\search_api\Entity\Server;
use Drupal\search_api\Utility\Utility;

/**
 * Tests index and search capabilities using the Solr search backend.
 *
 * @group search_api_solr
 */
class SearchApiSolrMultilingualTest extends SearchApiSolrTest {
  protected $language_ids = [
    'en',
    'de',
    'de-at',
  ];

  /**
   * Modules to enable for this test.
   *
   * @var string[]
   */
  public static $modules = [
    'language',
    'search_api_solr_multilingual_test',
  ];

  /**
   * A Search API server ID.
   *
   * @var string
   */
  protected $serverId = 'solr_multilingual_search_server';

  /**
   * A Search API index ID.
   *
   * @var string
   */
  protected $indexId = 'solr_multilingual_search_index';

  /**
   * {@inheritdoc}
   */
  public function setUp() {
    SolrBackendTestBase::setUp();
    $this
      ->installEntitySchema('user');
  }

  /**
   * {@inheritdoc}
   */
  protected function installConfigs() {
    foreach ($this->language_ids as $language_id) {
      ConfigurableLanguage::createFromLangcode($language_id)
        ->save();
    }
    $this
      ->installConfig([
      'search_api_solr_multilingual_test',
    ]);
    parent::installConfigs();
  }

  /**
   * {@inheritdoc}
   */
  public function testAutocomplete() {

    // @todo
  }

  /**
   * Tests the conversion of language aware queries into Solr queries.
   */
  public function testQueryConditionsAndLanguageFilter() {

    /** @var \Drupal\search_api_solr\SolrBackendInterface $backend */
    $backend = Server::load($this->serverId)
      ->getBackend();
    list($fields, $mapping) = $this
      ->getFieldsAndMapping($backend);
    $options = [];
    $query = $this
      ->buildSearch();
    $query
      ->setLanguages([
      'en',
    ]);
    $query
      ->addCondition('x', 5, '=');
    $fq = $this
      ->invokeMethod($backend, 'getFilterQueries', [
      $query,
      $mapping,
      $fields,
      &$options,
    ]);
    $this
      ->assertEquals('(+ss_search_api_language:"en" +solr_x:"5")', $fq[0]['query']);
    $this
      ->assertFalse(isset($fq[1]));
    $query = $this
      ->buildSearch();
    $query
      ->setLanguages([
      'en',
      'de',
    ]);
    $condition_group = $query
      ->createConditionGroup();
    $condition_group
      ->addCondition('x', 5);
    $inner_condition_group = $query
      ->createConditionGroup();
    $inner_condition_group
      ->addCondition('y', [
      1,
      2,
      3,
    ], 'NOT IN');
    $condition_group
      ->addConditionGroup($inner_condition_group);
    $query
      ->addConditionGroup($condition_group);
    $fq = $this
      ->invokeMethod($backend, 'getFilterQueries', [
      $query,
      $mapping,
      $fields,
      &$options,
    ]);
    $this
      ->assertEquals('(+ss_search_api_language:"en" +(+solr_x:"5" +(*:* -solr_y:"1" -solr_y:"2" -solr_y:"3"))) (+ss_search_api_language:"de" +(+solr_x:"5" +(*:* -solr_y:"1" -solr_y:"2" -solr_y:"3")))', $fq[0]['query']);
    $this
      ->assertFalse(isset($fq[1]));
  }

  /**
   * Tests language fallback.
   */
  public function testLanguageFallback() {
    $server = $this
      ->getIndex()
      ->getServerInstance();
    $config = $server
      ->getBackendConfig();
    $config['sasm_language_unspecific_fallback_on_schema_issues'] = FALSE;
    $server
      ->setBackendConfig($config)
      ->save();
    $this
      ->assertFalse($this
      ->getIndex()
      ->getServerInstance()
      ->getBackendConfig()['sasm_language_unspecific_fallback_on_schema_issues']);
    $this
      ->insertMultilingualExampleContent();
    $this
      ->indexItems($this->indexId);
    $this
      ->assertLogMessage(LOG_ERR, '%type while trying to index items on index %index: @message in %function (line %line of %file)');
    $this
      ->clearIndex();
    $config['sasm_language_unspecific_fallback_on_schema_issues'] = TRUE;
    $server
      ->setBackendConfig($config)
      ->save();
    $this
      ->assertTrue($this
      ->getIndex()
      ->getServerInstance()
      ->getBackendConfig()['sasm_language_unspecific_fallback_on_schema_issues']);
    $this
      ->indexItems($this->indexId);
    $results = $this
      ->buildSearch()
      ->execute();
    $this
      ->assertEquals(6, $results
      ->getResultCount(), 'Number of indexed entities is correct.');

    // Stemming "en":
    // gene => gene
    // genes => gene
    //
    // Stemming "de":
    // Gen => gen
    // Gene => gen.
    $query = $this
      ->buildSearch('Gen');
    $query
      ->setLanguages([
      'en',
      'de',
    ]);
    $results = $query
      ->execute();
    $this
      ->assertEquals(2, $results
      ->getResultCount(), 'Two results for "Gen" in German entities. No results for "Gen" in English entities.');
    $query = $this
      ->buildSearch('Gene');
    $query
      ->setLanguages([
      'en',
      'de',
    ]);
    $results = $query
      ->execute();
    $this
      ->assertEquals(4, $results
      ->getResultCount(), 'Two results for "Gene" in German entities. Two results for "Gene" in English entities.');

    // Stemming of "de-at" should fall back to "de".
    $query = $this
      ->buildSearch('Gen');
    $query
      ->setLanguages([
      'de-at',
    ]);
    $results = $query
      ->execute();
    $this
      ->assertEquals(2, $results
      ->getResultCount(), 'Two results for "Gen" in Austrian entities.');
    $query = $this
      ->buildSearch('Gene');
    $query
      ->setLanguages([
      'de-at',
    ]);
    $results = $query
      ->execute();
    $this
      ->assertEquals(2, $results
      ->getResultCount(), 'Two results for "Gene" in Austrian entities.');
  }

  /**
   * Tests language limiting via options.
   */
  public function testLanguageLimitedByOptions() {
    $this
      ->insertMultilingualExampleContent();
    $this
      ->indexItems($this->indexId);
    $server = $this
      ->getIndex()
      ->getServerInstance();
    $config = $server
      ->getBackendConfig();
    $config['sasm_limit_search_page_to_content_language'] = FALSE;
    $server
      ->setBackendConfig($config)
      ->save();
    $this
      ->assertFalse($this
      ->getIndex()
      ->getServerInstance()
      ->getBackendConfig()['sasm_limit_search_page_to_content_language']);
    $config['sasm_search_page_include_language_independent'] = FALSE;
    $server
      ->setBackendConfig($config)
      ->save();
    $this
      ->assertFalse($this
      ->getIndex()
      ->getServerInstance()
      ->getBackendConfig()['sasm_search_page_include_language_independent']);

    // Stemming "en":
    // gene => gene
    // genes => gene
    //
    // Stemming "de":
    // Gen => gen
    // Gene => gen.
    $results = $this
      ->buildSearch('gene', [], [
      'body',
    ])
      ->execute();
    $this
      ->assertResults([
      1 => 'en',
      2 => 'en',
      3 => 'de',
      4 => 'de',
      5 => 'de-at',
      6 => 'de-at',
    ], $results, 'Search all languages for "gene".');
    $config['sasm_limit_search_page_to_content_language'] = TRUE;
    $server
      ->setBackendConfig($config)
      ->save();
    $this
      ->assertTrue($this
      ->getIndex()
      ->getServerInstance()
      ->getBackendConfig()['sasm_limit_search_page_to_content_language']);

    // Current content language is "en".
    $results = $this
      ->buildSearch('gene', [], [
      'body',
    ])
      ->execute();
    $this
      ->assertResults([
      1 => 'en',
      2 => 'en',
    ], $results, 'Search content language for "gene".');

    // A query created by Views must not be overruled.
    $results = $this
      ->buildSearch('gene', [], [
      'body',
    ])
      ->addTag('views')
      ->execute();
    $this
      ->assertResults([
      1 => 'en',
      2 => 'en',
      3 => 'de',
      4 => 'de',
      5 => 'de-at',
      6 => 'de-at',
    ], $results, 'Search all languages for "gene".');
    $config['sasm_search_page_include_language_independent'] = TRUE;
    $server
      ->setBackendConfig($config)
      ->save();
    $this
      ->assertTrue($this
      ->getIndex()
      ->getServerInstance()
      ->getBackendConfig()['sasm_search_page_include_language_independent']);
    $results = $this
      ->buildSearch('gene', [], [
      'body',
    ])
      ->execute();
    $this
      ->assertResults([
      1 => 'en',
      2 => 'en',
      7 => LanguageInterface::LANGCODE_NOT_SPECIFIED,
      8 => LanguageInterface::LANGCODE_NOT_APPLICABLE,
    ], $results, 'Search content and unspecified language for "gene".');
    $config['sasm_limit_search_page_to_content_language'] = FALSE;
    $server
      ->setBackendConfig($config)
      ->save();
    $this
      ->assertFalse($this
      ->getIndex()
      ->getServerInstance()
      ->getBackendConfig()['sasm_limit_search_page_to_content_language']);
    $results = $this
      ->buildSearch('gene', [], [
      'body',
    ])
      ->execute();
    $this
      ->assertResults([
      1 => 'en',
      2 => 'en',
      3 => 'de',
      4 => 'de',
      5 => 'de-at',
      6 => 'de-at',
      7 => LanguageInterface::LANGCODE_NOT_SPECIFIED,
      8 => LanguageInterface::LANGCODE_NOT_APPLICABLE,
    ], $results, 'Search all and unspecified languages for "gene".');
  }

  /**
   * Creates several test entities.
   */
  protected function insertMultilingualExampleContent() {
    $this
      ->addTestEntity(1, [
      'name' => 'en 1',
      'body' => 'gene',
      'type' => 'item',
      'langcode' => 'en',
    ]);
    $this
      ->addTestEntity(2, [
      'name' => 'en 2',
      'body' => 'genes',
      'type' => 'item',
      'langcode' => 'en',
    ]);
    $this
      ->addTestEntity(3, [
      'name' => 'de 3',
      'body' => 'Gen',
      'type' => 'item',
      'langcode' => 'de',
    ]);
    $this
      ->addTestEntity(4, [
      'name' => 'de 4',
      'body' => 'Gen',
      'type' => 'item',
      'langcode' => 'de',
    ]);
    $this
      ->addTestEntity(5, [
      'name' => 'de-at 5',
      'body' => 'Gen',
      'type' => 'item',
      'langcode' => 'de-at',
    ]);
    $this
      ->addTestEntity(6, [
      'name' => 'de-at 6',
      'body' => 'Gen',
      'type' => 'item',
      'langcode' => 'de-at',
    ]);
    $this
      ->addTestEntity(7, [
      'name' => 'und 7',
      'body' => 'gene',
      'type' => 'item',
      'langcode' => LanguageInterface::LANGCODE_NOT_SPECIFIED,
    ]);
    $this
      ->addTestEntity(8, [
      'name' => 'zxx 8',
      'body' => 'gene',
      'type' => 'item',
      'langcode' => LanguageInterface::LANGCODE_NOT_APPLICABLE,
    ]);
    $count = \Drupal::entityQuery('entity_test_mulrev_changed')
      ->count()
      ->execute();
    $this
      ->assertEquals(8, $count, "{$count} items inserted.");
  }

  /**
   * {@inheritdoc}
   *
   * If the list of entity ids contains language codes it will be handled here,
   * otherwise it will be handed over to the parent implementation.
   *
   * @param array $entity_ids
   *   An array of entity IDs or an array keyed by entity IDs and langcodes as
   *   values.
   *
   * @return string[]
   *   An array of item IDs.
   */
  protected function getItemIds(array $entity_ids) {
    $item_ids = [];
    if (!empty($entity_ids)) {
      $keys = array_keys($entity_ids);
      $first_key = reset($keys);
      if (0 === $first_key) {
        return parent::getItemIds($entity_ids);
      }
      else {
        foreach ($entity_ids as $id => $langcode) {
          $item_ids[] = Utility::createCombinedId('entity:entity_test_mulrev_changed', $id . ':' . $langcode);
        }
      }
    }
    return $item_ids;
  }

  /**
   * Data provider for testConfigGeneration method.
   *
   * @return array
   */
  public function configGenerationDataProvider() {
    return [
      'en' => [
        'en',
        [
          'schema_extra_types.xml' => [
            # phonetic is currently not available vor Solr 6.x.

            #'fieldType name="text_phonetic_en" class="solr.TextField"',
            'fieldType name="text_en" class="solr.TextField"',
          ],
          'schema_extra_fields.xml' => [
            # phonetic is currently not available vor Solr 6.x.

            #'<dynamicField name="tcphonetics_X3b_en_*" type="text_phonetic_en" stored="true" indexed="true" multiValued="false" termVectors="true" omitNorms="false" />',

            #'<dynamicField name="tcphoneticm_X3b_en_*" type="text_phonetic_en" stored="true" indexed="true" multiValued="true" termVectors="true" omitNorms="false" />',

            #'<dynamicField name="tocphonetics_X3b_en_*" type="text_phonetic_en" stored="true" indexed="true" multiValued="false" termVectors="true" omitNorms="true" />',

            #'<dynamicField name="tocphoneticm_X3b_en_*" type="text_phonetic_en" stored="true" indexed="true" multiValued="true" termVectors="true" omitNorms="true" />',
            '<dynamicField name="ts_X3b_en_*" type="text_en" stored="true" indexed="true" multiValued="false" termVectors="true" omitNorms="false" />',
            '<dynamicField name="tm_X3b_en_*" type="text_en" stored="true" indexed="true" multiValued="true" termVectors="true" omitNorms="false" />',
            '<dynamicField name="tos_X3b_en_*" type="text_en" stored="true" indexed="true" multiValued="false" termVectors="true" omitNorms="true" />',
            '<dynamicField name="tom_X3b_en_*" type="text_en" stored="true" indexed="true" multiValued="true" termVectors="true" omitNorms="true" />',
          ],
          'solrconfig_extra.xml' => [
            '<str name="name">en</str>',
          ],
          # phonetic is currently not available vor Solr 6.x.

          #'stopwords_phonetic_en.txt' => [],

          #'protwords_phonetic_en.txt' => [],
          'stopwords_en.txt' => [],
          'synonyms_en.txt' => [
            'drupal, durpal',
          ],
          'protwords_en.txt' => [],
          'accents_en.txt' => [
            '"\\u00C4" => "A"',
          ],
          'mapping-ISOLatin1Accent.txt' => [
            '"\\u00c4" => "A"',
          ],
          'solrcore.properties' => [],
          'elevate.xml' => [],
          'schema.xml' => [],
          'solrconfig.xml' => [],
          'test.txt' => [
            'hook_search_api_solr_config_files_alter() works',
          ],
        ],
      ],
      'de' => [
        'de',
        [
          'schema_extra_types.xml' => [
            # phonetic is currently not available vor Solr 6.x.

            #'fieldType name="text_phonetic_de" class="solr.TextField"',
            'fieldType name="text_de" class="solr.TextField"',
          ],
          'schema_extra_fields.xml' => [
            # phonetic is currently not available vor Solr 6.x.

            #'<dynamicField name="tcphonetics_X3b_de_*" type="text_phonetic_de" stored="true" indexed="true" multiValued="false" termVectors="true" omitNorms="false" />',

            #'<dynamicField name="tcphoneticm_X3b_de_*" type="text_phonetic_de" stored="true" indexed="true" multiValued="true" termVectors="true" omitNorms="false" />',

            #'<dynamicField name="tocphonetics_X3b_de_*" type="text_phonetic_de" stored="true" indexed="true" multiValued="false" termVectors="true" omitNorms="true" />',

            #'<dynamicField name="tocphoneticm_X3b_de_*" type="text_phonetic_de" stored="true" indexed="true" multiValued="true" termVectors="true" omitNorms="true" />',
            '<dynamicField name="ts_X3b_de_*" type="text_de" stored="true" indexed="true" multiValued="false" termVectors="true" omitNorms="false" />',
            '<dynamicField name="tm_X3b_de_*" type="text_de" stored="true" indexed="true" multiValued="true" termVectors="true" omitNorms="false" />',
            '<dynamicField name="tos_X3b_de_*" type="text_de" stored="true" indexed="true" multiValued="false" termVectors="true" omitNorms="true" />',
            '<dynamicField name="tom_X3b_de_*" type="text_de" stored="true" indexed="true" multiValued="true" termVectors="true" omitNorms="true" />',
          ],
          'solrconfig_extra.xml' => [
            '<str name="name">de</str>',
          ],
          # phonetic is currently not available vor Solr 6.x.

          #'stopwords_phonetic_de.txt' => [],

          #'protwords_phonetic_de.txt' => [],
          'stopwords_de.txt' => [],
          'synonyms_de.txt' => [
            'drupal, durpal',
          ],
          'protwords_de.txt' => [],
          'accents_de.txt' => [
            ' Not needed if German2 Porter stemmer is used.',
          ],
          'mapping-ISOLatin1Accent.txt' => [
            '"\\u00c4" => "A"',
          ],
          'solrcore.properties' => [],
          'elevate.xml' => [],
          'schema.xml' => [],
          'solrconfig.xml' => [],
          'test.txt' => [
            'hook_search_api_solr_config_files_alter() works',
          ],
        ],
      ],
    ];
  }

}

Classes

Name	Description
SearchApiSolrMultilingualTest	Tests index and search capabilities using the Solr search backend.