Refactor and fix multi-facet selection. (#4081)

- Simplifies the code
- Fixes filter value handling when the value in URL is not enclosed in quotes
- Uses more CSS to hide and show elements
- Reduces JS manipulation of DOM
- Fixes display of selected facets in facet lightbox
- Improves the visuals of facet lightbox
- Doesn't cause errors if sidebar is not found
- Adds multiselection to standalone facet list page
- Fixes multi-selection after loading more facets in lightbox
- Fixes hiding of Set buttons loaded after activating multi-facet selection
- Adds more tests

module/VuFind/src/VuFind/Controller/AbstractSearch.php

@@ -927,6 +927,7 @@ public function facetListAction()
             'key' => $sort,
             'urlBase' => $urlBase,
             'searchAction' => $searchAction,
+            'multiFacetsSelection' => (bool)($config->Results_Settings->multiFacetsSelection ?? false),
         ];
         $viewParams['delegateParams'] = $viewParams;
         $view = $this->createViewModel($viewParams);

module/VuFind/src/VuFindTest/Feature/SearchFacetFilterTrait.php

@@ -32,6 +32,7 @@
 namespace VuFindTest\Feature;
 
 use Behat\Mink\Element\Element;
+use Behat\Mink\Element\NodeElement;
 
 /**
  * Trait for working with faceting and filtering of search results.
@@ -58,6 +59,13 @@ trait SearchFacetFilterTrait
      */
     protected $activeFilterLabelSelector = '.active-filters.hidden-xs .filters .filters-title';
 
+    /**
+     * CSS selector for finding the active filter list
+     *
+     * @var string
+     */
+    protected $activeFilterListSelector = '.active-filters.hidden-xs .filters .title-value-pair';
+
     /**
      * CSS selector for finding the first hierarchical facet expand button
      *
@@ -84,7 +92,7 @@ trait SearchFacetFilterTrait
      *
      * @var string
      */
-    protected $facetSecondLevelActiveLinkSelector = '.facet-tree button[aria-expanded=true] ~ ul a.active';
+    protected $facetSecondLevelActiveLinkSelector = '.facet-tree button[aria-expanded=true] ~ ul .active a';
 
     /**
      * CSS selector for finding the first second level hierarchical facet
@@ -108,4 +116,71 @@ protected function assertAppliedFilter(Element $page, string $expectedFilter): v
         $this->assertEquals('hierarchy:', $label->getText());
         $this->assertEquals("Remove Filter $expectedFilter", $filter->getText());
     }
+
+    /**
+     * Get textual content of a facet element by facet link CSS selector
+     *
+     * @param Element $page     Page
+     * @param string  $selector CSS selector for facet link
+     *
+     * @return string
+     */
+    protected function getFacetTextByLinkSelector(Element $page, string $selector): string
+    {
+        return $this->findCssAndCallMethod(
+            $page,
+            $selector,
+            function (NodeElement $node): string {
+                return $node->getParent()->getText();
+            }
+        );
+    }
+
+    /**
+     * Assert that no filters are applied.
+     *
+     * @param Element $page Mink page object
+     *
+     * @return void
+     */
+    protected function assertNoFilters(Element $page): void
+    {
+        $this->assertFilterCount($page, 0);
+    }
+
+    /**
+     * Assert that the given number of filters are applied.
+     *
+     * @param Element $page     Mink page object
+     * @param int     $expected Expected filter count
+     *
+     * @return void
+     */
+    protected function assertFilterCount(Element $page, int $expected): void
+    {
+        $items = $page->findAll('css', $this->activeFilterSelector);
+        $this->assertCount($expected, $items);
+    }
+
+    /**
+     * Assert that the given number of facets are present in the full facet list
+     *
+     * @param Element $page            Mink page object
+     * @param string  $list            List type ('count' or 'index')
+     * @param int     $expected        Expected filter count
+     * @param bool    $exclusionActive Should exclude links be present?
+     *
+     * @return void
+     */
+    protected function assertFullListFacetCount(
+        Element $page,
+        string $list,
+        int $expected,
+        bool $exclusionActive
+    ): void {
+        $items = $page->findAll('css', "#modal #facet-list-$list .js-facet-item");
+        $this->assertCount($expected, $items);
+        $excludes = $page->findAll('css', "#modal #facet-list-$list .exclude");
+        $this->assertCount($exclusionActive ? $expected : 0, $excludes);
+    }
 }

module/VuFind/src/VuFindTest/Integration/MinkTestCase.php

@@ -41,6 +41,7 @@
 use function floatval;
 use function in_array;
 use function intval;
+use function is_string;
 use function strlen;
 
 /**
@@ -758,12 +759,12 @@ protected function findCssAndGetHtml(
     /**
      * Return value of a method of an element selected via CSS; retry if it fails due to DOM change.
      *
-     * @param Element $page     Page element
-     * @param string  $selector CSS selector
-     * @param string  $method   Method to call
-     * @param int     $timeout  Wait timeout for CSS selection (in ms)
-     * @param int     $index    Index of the element (0-based)
-     * @param int     $retries  Retry count for set loop
+     * @param Element         $page     Page element
+     * @param string          $selector CSS selector
+     * @param string|callable $method   Node's method to call (string) or callable that gets the node as parameter
+     * @param int             $timeout  Wait timeout for CSS selection (in ms)
+     * @param int             $index    Index of the element (0-based)
+     * @param int             $retries  Retry count for set loop
      *
      * @return string
      */
@@ -780,7 +781,7 @@ protected function findCssAndCallMethod(
         for ($i = 1; $i <= $retries; $i++) {
             try {
                 $element = $this->findCss($page, $selector, $timeout, $index);
-                return call_user_func([$element, $method]);
+                return is_string($method) ? call_user_func([$element, $method]) : $method($element);
             } catch (\Exception $e) {
                 $this->logWarning(
                     'RETRY findCssAndGetText after exception in ' . $this->getTestName()

module/VuFind/tests/integration-tests/src/VuFindTest/Mink/AuthorSearchTest.php

@@ -29,6 +29,8 @@
 
 namespace VuFindTest\Mink;
 
+use VuFindTest\Feature\SearchFacetFilterTrait;
+
 /**
  * Mink author search test class.
  *
@@ -40,6 +42,8 @@
  */
 class AuthorSearchTest extends \VuFindTest\Integration\MinkTestCase
 {
+    use SearchFacetFilterTrait;
+
     /**
      * Test searching for a known corporate author
      *
@@ -48,7 +52,7 @@ class AuthorSearchTest extends \VuFindTest\Integration\MinkTestCase
     public function testCorporateAuthorSearch(): void
     {
         $page = $this->performSearch('corporate', 'Author');
-        $facets = $this->findCssAndGetText($page, '#side-collapse-building a');
+        $facets = $this->getFacetTextByLinkSelector($page, '#side-collapse-building a');
         // We'll check for a known count from a known MARC file to confirm that
         // results came back.
         $this->assertStringContainsString('author_relators.mrc 10', $facets);
@@ -62,7 +66,7 @@ public function testCorporateAuthorSearch(): void
     public function testPrimaryAuthorSearch(): void
     {
         $page = $this->performSearch('primary', 'Author');
-        $facets = $this->findCssAndGetText($page, '#side-collapse-building a');
+        $facets = $this->getFacetTextByLinkSelector($page, '#side-collapse-building a');
         // We'll check for a known count from a known MARC file to confirm that
         // results came back.
         $this->assertStringContainsString('author_relators.mrc 11', $facets);