Magento 2 Layered Navigation – Does It Always Use Configured Search Engine?

catalogsearchlayered-navigationmagento-2.1magento2search

In Magento 2.1 custom search engines were introduced, so that MySQL could be replaced with ElasticSearch in EE.

My own search adapter works well in the search but now I realized that it is also used to fetch filters in layered navigation on category pages.

This leads to an error if my search result does not contain "buckets" for filterable attributes, like this:

Exception #0 (Magento\Framework\Exception\StateException): Bucket does not exist
#0 [...]/var/generation/Magento/CatalogSearch/Model/ResourceModel/Fulltext/Collection/Interceptor.php(115): Magento\CatalogSearch\Model\ResourceModel\Fulltext\Collection->getFacetedData('style_bags')

While it makes sense to use the search adapter here, my problem is that it does it with the exact same method in Magento\CatalogSearch\Model\ResourceModel\Fulltext\Collection that is also used to fetch search results.

This does not work because I distinguish between attributes configured as filterable in search and as filterable in categories, so the normal search result does not contain the buckets that are needed on the category page.

I'll probably implement a switch based on the current controller, although that's not the cleanest solution.

But my question for now is: Is it really necessary to use the search engine in layered navigation or is there a way to fall back to the old method?

Update

It turns out that I get enough information in the $request parameter passed to the query method of my adapter implementation to figure out the context:

This makes at least a cleaner solution for my switch.

But when I try to fall back to the default MySQL adapter like this (with adapter injected as \Magento\Framework\Search\Adapter\Mysql\Adapter\Proxy):

if ($request->getName() === 'catalog_view_container') {
    return $this->mysqlAdapter->query($request);
}

there are errors in other places like Magento\Framework\Search\Dynamic\IntervalFactory where my adapter is still used based on di.xml and the system configuration.

Best Answer

Magento 2 have layered navigation on search result page too. If you do not cover filtering and aggregation in your adapter this functionality will brocken, so you still need it not only for category page

Related Solutions

Magento 2 Advanced Searching – SmartSearch

To perform full text search Magento\Framework\Api\Search\SearchInterface should be used. Please note that Service Contracts concept was introduced in Magento 2, even though Service API is available not for all core functionality yet, it should be used whenever possible by 3-rd party modules instead of direct access to models and collections. To avoid breaking changes in the future (after 2.1, 2.2 etc releases), only classes/interfaces and methods marked with @api annotation should be used.

Below is fully working example which will display up to 5 matching products in suggest (title and price). To test just replace original \Magento\CatalogSearch\Model\Autocomplete\DataProvider content with this one:

<?php
namespace Magento\CatalogSearch\Model\Autocomplete;

use Magento\Search\Model\QueryFactory;
use Magento\Search\Model\Autocomplete\DataProviderInterface;
use Magento\Search\Model\Autocomplete\ItemFactory;
use Magento\Framework\Api\Search\SearchCriteriaFactory as FullTextSearchCriteriaFactory;
use Magento\Framework\Api\Search\SearchInterface as FullTextSearchApi;
use Magento\Framework\Api\Search\FilterGroupBuilder;
use Magento\Framework\Api\FilterBuilder;
use Magento\Framework\Api\SearchCriteriaBuilder;
use Magento\Catalog\Api\ProductRepositoryInterface;

/**
 * Full text search implementation of autocomplete.
 */
class DataProvider implements DataProviderInterface
{
    const PRODUCTS_NUMBER_IN_SUGGEST = 5;

    /** @var QueryFactory */
    protected $queryFactory;

    /** @var ItemFactory */
    protected $itemFactory;

    /** @var \Magento\Framework\Api\Search\SearchInterface */
    protected $fullTextSearchApi;

    /** @var FullTextSearchCriteriaFactory */
    protected $fullTextSearchCriteriaFactory;

    /** @var FilterGroupBuilder */
    protected $searchFilterGroupBuilder;

    /** @var FilterBuilder */
    protected $filterBuilder;

    /** @var ProductRepositoryInterface */
    protected $productRepository;

    /** @var SearchCriteriaBuilder */
    protected $searchCriteriaBuilder;

    /**
     * Initialize dependencies.
     *
     * @param QueryFactory $queryFactory
     * @param ItemFactory $itemFactory
     * @param FullTextSearchApi $search
     * @param FullTextSearchCriteriaFactory $searchCriteriaFactory
     * @param FilterGroupBuilder $searchFilterGroupBuilder
     * @param FilterBuilder $filterBuilder
     * @param ProductRepositoryInterface $productRepository
     * @param SearchCriteriaBuilder $searchCriteriaBuilder
     */
    public function __construct(
        QueryFactory $queryFactory,
        ItemFactory $itemFactory,
        FullTextSearchApi $search,
        FullTextSearchCriteriaFactory $searchCriteriaFactory,
        FilterGroupBuilder $searchFilterGroupBuilder,
        FilterBuilder $filterBuilder,
        ProductRepositoryInterface $productRepository,
        SearchCriteriaBuilder $searchCriteriaBuilder
    ) {
        $this->queryFactory = $queryFactory;
        $this->itemFactory = $itemFactory;
        $this->fullTextSearchApi = $search;
        $this->fullTextSearchCriteriaFactory = $searchCriteriaFactory;
        $this->filterBuilder = $filterBuilder;
        $this->searchFilterGroupBuilder = $searchFilterGroupBuilder;
        $this->productRepository = $productRepository;
        $this->searchCriteriaBuilder = $searchCriteriaBuilder;
    }

    /**
     * {@inheritdoc}
     */
    public function getItems()
    {
        $result = [];
        $query = $this->queryFactory->get()->getQueryText();
        $productIds = $this->searchProductsFullText($query);
        if ($productIds) {
            $searchCriteria = $this->searchCriteriaBuilder->addFilter('entity_id', $productIds, 'in')->create();
            $products = $this->productRepository->getList($searchCriteria);
            foreach ($products->getItems() as $product) {
                $resultItem = $this->itemFactory->create([
                    /** Feel free to add here necessary product data and then render in template */
                    'title' => $product->getName() . " " . $product->getPrice()
                ]);
                $result[] = $resultItem;
            }
        }
        return $result;
    }

    /**
     * Perform full text search and find IDs of matching products.
     *
     * @param string
     * @return int[]
     */
    private function searchProductsFullText($query)
    {
        $searchCriteria = $this->fullTextSearchCriteriaFactory->create();
        /** To get list of available request names see Magento/CatalogSearch/etc/search_request.xml */
        $searchCriteria->setRequestName('quick_search_container');
        $filter = $this->filterBuilder->setField('search_term')->setValue($query)->setConditionType('like')->create();
        $filterGroup = $this->searchFilterGroupBuilder->addFilter($filter)->create();
        $currentPage = 1;
        $searchCriteria->setFilterGroups([$filterGroup])
            ->setCurrentPage($currentPage)
            ->setPageSize(self::PRODUCTS_NUMBER_IN_SUGGEST);
        $searchResults = $this->fullTextSearchApi->search($searchCriteria);
        $productIds = [];
        /**
         * Full text search returns document IDs (in this case product IDs),
         * so to get products information we need to load them using filtration by these IDs
         */
        foreach ($searchResults->getItems() as $searchDocument) {
            $productIds[] = $searchDocument->getId();
        }
        return $productIds;
    }
}

Magento – Magento2.3 : Layered Navigation issue

By removing throw exception, you can solve the issue.
Override file if it works in your case

Go to vendor\magento\module-catalog-search\Model\ResourceModel\Fulltext\Collection->addFieldToFilter() function and remove

    if ($this->searchResult !== null) {
    throw new \RuntimeException('Illegal state');
}

Update

Best Answer

Related Solutions

Magento 2 Advanced Searching – SmartSearch

Magento – Magento2.3 : Layered Navigation issue

Related Topic