facets-8.x-1.x-dev/tests/src/Functional/WidgetIntegrationTest.php

<?php

namespace Drupal\Tests\facets\Functional;

/**
 * Tests the overall functionality of the Facets admin UI.
 *
 * @group facets
 */
class WidgetIntegrationTest extends FacetsTestBase {

  /**
   * {@inheritdoc}
   */
  protected static $modules = [
    'views',
    'node',
    'search_api',
    'facets',
    'block',
    'facets_search_api_dependency',
    'facets_query_processor',
    'facets_custom_widget',
  ];

  /**
   * {@inheritdoc}
   */
  public function setUp(): void {
    parent::setUp();

    $this->drupalLogin($this->adminUser);

    $this->setUpExampleStructure();
    $this->insertExampleContent();
    $this->assertEquals($this->indexItems($this->indexId), 5, '5 items were indexed.');
  }

  /**
   * Tests checkbox widget.
   */
  public function testCheckboxWidget() {
    $id = 't';
    $this->createFacet('Facet & checkbox~', $id);
    $this->drupalGet('admin/config/search/facets/' . $id . '/edit');
    $this->submitForm(['widget' => 'checkbox'], 'Save');

    $this->drupalGet('search-api-test-fulltext');
    $this->assertFacetLabel('item');
    $this->assertFacetLabel('article');
  }

  /**
   * Tests links widget's basic functionality.
   */
  public function testLinksWidget() {
    $id = 'links_widget';
    $this->createFacet('>.Facet &* Links', $id);
    $this->drupalGet('admin/config/search/facets/' . $id . '/edit');
    $this->submitForm(['widget' => 'links'], 'Save');

    $this->drupalGet('search-api-test-fulltext');
    $this->assertFacetLabel('item');
    $this->assertFacetLabel('article');

    $this->clickLink('item');
    $this->checkFacetIsActive('item');
  }

  /**
   * Tests dropdown widget's basic functionality.
   */
  public function testDropdownWidget() {
    $id = 'select_widget';
    $this->createFacet('Select', $id);
    $this->drupalGet('admin/config/search/facets/' . $id . '/edit');
    $this->submitForm(
      [
        'widget' => 'dropdown',
      ],
      'Configure widget'
    );
    $this->submitForm(
      [
        'widget' => 'dropdown',
        'facet_settings[show_only_one_result]' => TRUE,
      ],
      'Save'
    );

    $this->drupalGet('search-api-test-fulltext');
    $this->assertSession()->pageTextContains('Displaying 5 search results');
    $this->assertFacetLabel('item');
    $this->assertFacetLabel('article');
  }

  /**
   * Tests the functionality of a widget to hide/show the item-count.
   */
  public function testLinksShowHideCount() {
    $id = 'links_widget';
    $facet_edit_page = 'admin/config/search/facets/' . $id . '/edit';

    $this->createFacet('>.Facet &* Links', $id);

    // Go to the view and check that the facet links are shown with their
    // default settings.
    $this->drupalGet('search-api-test-fulltext');
    $this->assertFacetLabel('item');
    $this->assertFacetLabel('article');

    $this->drupalGet($facet_edit_page);
    $this->submitForm(
      [
        'widget' => 'links',
        'widget_config[show_numbers]' => TRUE,
      ],
      'Save'
    );

    // Go back to the same view and check that links now display the count.
    $this->drupalGet('search-api-test-fulltext');
    $this->assertFacetLabel('item (3)');
    $this->assertFacetLabel('article (2)');

    $edit = [
      'widget' => 'links',
      'widget_config[show_numbers]' => TRUE,
      'facet_settings[query_operator]' => 'or',
    ];
    $this->drupalGet($facet_edit_page);
    $this->submitForm($edit, 'Save');

    $this->drupalGet('search-api-test-fulltext');
    $this->assertFacetLabel('item (3)');
    $this->assertFacetLabel('article (2)');
    $this->clickPartialLink('item');
    $this->assertFacetLabel('item (3)');
    $this->assertFacetLabel('article (2)');

    $this->drupalGet($facet_edit_page);
    $this->submitForm(
      [
        'widget' => 'links',
        'widget_config[show_numbers]' => FALSE,
      ],
      'Save'
    );

    // The count should be hidden again.
    $this->drupalGet('search-api-test-fulltext');
    $this->assertFacetLabel('item');
    $this->assertFacetLabel('article');
  }

  /**
   * Tests custom widget.
   *
   * ::requiredFacetProperties in the custom widget requires the
   * hide_non_narrowing_result_processor processor, so check that it's enabled
   * after the custom widget is selected.
   */
  public function testCustomWidget() {
    $id = 'custom_widget';
    $this->createFacet('Custom widget.', $id);

    $this->drupalGet('admin/config/search/facets/' . $id . '/edit');

    $this->assertSession()->checkboxNotChecked('edit-facet-settings-hide-non-narrowing-result-processor-status');
    $this->assertSession()->checkboxNotChecked('edit-facet-settings-show-only-one-result');

    $this->submitForm(['widget' => 'custom_widget'], 'Configure widget');
    $this->submitForm(['widget' => 'custom_widget'], 'Save');

    $this->assertSession()->checkboxChecked('edit-facet-settings-hide-non-narrowing-result-processor-status');
    $this->assertSession()->checkboxChecked('edit-facet-settings-show-only-one-result');
  }

  /**
   * Tests the facet support for a widget.
   */
  public function testSupportsFacet() {
    $id = 'masked_owl';
    $this->createFacet('Australian masked owl', $id);

    // Go to the facet edit page and check to see if the custom widget shows
    // up.
    $this->drupalGet('admin/config/search/facets/' . $id . '/edit');
    $this->assertSession()->pageTextContains('Custom widget');

    // Make the ::supportsFacet method on the custom widget return false.
    \Drupal::state()->set('facets_test_supports_facet', FALSE);

    // Go to the facet edit page and check to see if the custom widget is now
    // hidden.
    $this->drupalGet('admin/config/search/facets/' . $id . '/edit');
    $this->assertSession()->pageTextNotContains('Custom widget');
  }

  /**
   * Tests the all link.
   */
  public function testAllLink() {
    $id = 'kepler_16b';
    $this->createFacet('Kepler 16b', $id);
    $editUrl = 'admin/config/search/facets/' . $id . '/edit';
    $this->drupalGet($editUrl);
    $this->submitForm(['widget' => 'links'], 'Save');

    $this->drupalGet('search-api-test-fulltext');
    $this->assertFacetLabel('item');
    $this->assertFacetLabel('article');

    $this->clickLink('item');
    $this->checkFacetIsActive('item');

    // Enable the all (reset) link.
    $this->drupalGet($editUrl);
    $this->submitForm(['widget_config[show_reset_link]' => TRUE], 'Save');

    $this->drupalGet('search-api-test-fulltext');
    $this->assertFacetLabel('item');
    $this->assertFacetLabel('article');
    $this->findFacetLink('Show all');

    // Change the text.
    $edit = [
      'widget_config[show_reset_link]' => TRUE,
      'widget_config[reset_text]' => 'Planets',
    ];
    $this->drupalGet($editUrl);
    $this->submitForm($edit, 'Save');

    // Check that the new text appears and no facets are active.
    $this->drupalGet('search-api-test-fulltext');
    $this->assertFacetLabel('item');
    $this->assertFacetLabel('article');
    $this->findFacetLink('Planets (5)');
    $this->checkFacetIsNotActive('item');
    $this->checkFacetIsNotActive('article');

    // Click one of the facets.
    $this->clickLink('item');
    $this->checkFacetIsActive('item');

    // Click the rest link.
    $this->clickLink('Planets');
    $this->checkFacetIsNotActive('item');
    $this->checkFacetIsNotActive('article');
  }

  /**
   * Tests multiple reset links.
   *
   * Tests that, when there are multiple facets, the "Show all" link's
   * `is-active` CSS class doesn't leak into subsequent inactive facet links.
   * https://www.drupal.org/project/facets/issues/3295536
   */
  public function testMultilpleResetLinks() {
    $firstId = 'first_facet';
    $this->createFacet('First Facet', $firstId);
    $firstEditUrl = 'admin/config/search/facets/' . $firstId . '/edit';
    $this->drupalGet($firstEditUrl);
    $this->submitForm(['widget' => 'links', 'widget_config[show_reset_link]' => TRUE], 'Save');

    $secondId = 'second_facet';
    $this->createFacet('Second Facet', $secondId);
    $secondEditUrl = 'admin/config/search/facets/' . $secondId . '/edit';
    $this->drupalGet($secondEditUrl);
    $this->submitForm(['widget' => 'links', 'widget_config[show_reset_link]' => TRUE], 'Save');

    $this->drupalGet('search-api-test-fulltext');

    $showAllLinks = $this->findFacetLink('Show all');
    $this->assertCount(2, $showAllLinks);
    for ($i = 0; $i < 2; ++$i) {
      $this->assertTrue($showAllLinks[$i]->getParent()->hasClass('is-active'), 'The "Show all" link should be active.');
    }

    $itemLinks = $this->findFacetLink('item');
    $this->assertCount(2, $itemLinks);
    for ($i = 0; $i < 2; ++$i) {
      $this->assertTrue(!$itemLinks[$i]->getParent()->hasClass('is-active'), 'The "item" link should not be active.');
    }

    $articleLinks = $this->findFacetLink('article');
    $this->assertCount(2, $articleLinks);
    for ($i = 0; $i < 2; ++$i) {
      $this->assertTrue(!$articleLinks[$i]->getParent()->hasClass('is-active'), 'The "article" link should not be active.');
    }
  }

}