Commit 8636e729 authored by Ivan Honcharenko's avatar Ivan Honcharenko Committed by Thomas Seiber
Browse files

Issue #3197050 by BAHbKA, drunken monkey: Fixed caching issue for facets on AJAX views.

parent ec46bdc3

CHANGELOG.txt

+2 −0
Original line number Diff line number Diff line 
Search API 1.x, dev (xxxx-xx-xx):

---------------------------------

- #3197050 by BAHbKA, drunken monkey: Fixed caching issue for facets on AJAX

  views.

- #3246615 by drunken monkey: Fixed error when saving an unindexed translation

  of an entity.

- #3258375 by Eugene Bocharov, wells, drunken monkey, joshuami, MrDaleSmith,

src/Plugin/views/cache/SearchApiCachePluginTrait.php

+38 −4
Original line number Diff line number Diff line
@@ -4,6 +4,7 @@ namespace Drupal\search_api\Plugin\views\cache; 


use Drupal\Component\Utility\Crypt;

use Drupal\Core\Cache\Cache;

use Drupal\Core\Cache\CacheableMetadata;

use Drupal\Core\Cache\CacheBackendInterface;

use Drupal\Core\Cache\Context\CacheContextsManager;

use Drupal\search_api\Plugin\views\query\SearchApiQuery;
@@ -115,19 +116,22 @@ trait SearchApiCachePluginTrait { 
    }



    $view = $this->getView();

    $query = $this->getQuery();

    $data = [

      'result' => $view->result,

      'total_rows' => $view->total_rows ?? 0,

      'current_page' => $view->getCurrentPage(),

      'search_api results' => $this->getQuery()->getSearchApiResults(),

      'search_api results' => $query->getSearchApiResults(),

    ];



    $expire = $this->cacheSetMaxAge($type);

    if ($expire !== Cache::PERMANENT) {

      $expire += (int) $view->getRequest()->server->get('REQUEST_TIME');

    }

    $tags = Cache::mergeTags($this->getCacheTags(), $query->getCacheTags());



    $this->getCacheBackend()

      ->set($this->generateResultsKey(), $data, $expire, $this->getCacheTags());

      ->set($this->generateResultsKey(), $data, $expire, $tags);

  }



  /**
@@ -216,18 +220,48 @@ trait SearchApiCachePluginTrait { 
  /**

   * Retrieves the Search API Views query for the current view.

   *

   * @return \Drupal\search_api\Plugin\views\query\SearchApiQuery|null

   * @param bool $reset

   *   (optional) If TRUE, reset the query to its initial/unprocessed state.

   *   Should only be used in the context of a view being saved, never when the

   *   view is actually being executed.

   *

   * @return \Drupal\search_api\Plugin\views\query\SearchApiQuery

   *   The Search API Views query associated with the current view.

   *

   * @throws \Drupal\search_api\SearchApiException

   *   Thrown if there is no current Views query, or it is no Search API query.

   */

  protected function getQuery() {

  protected function getQuery(bool $reset = FALSE): SearchApiQuery {

    if ($reset) {

      $view = $this->getView();

      $view_display = $view->getDisplay();

      $query = $view_display->getPlugin('query');

      $query->init($view, $view_display);

    }

    else {

      $query = $this->getView()->getQuery();

    }



    if ($query instanceof SearchApiQuery) {

      return $query;

    }

    throw new SearchApiException('No matching Search API Views query found in view.');

  }



  /**

   * {@inheritdoc}

   */

  public function alterCacheMetadata(CacheableMetadata $cache_metadata) {

    // A view can have multiple displays, but when information is gathered about

    // all the displays' metadata, it initializes the query plugin only once for

    // the first display. However, we need to collect cacheability metadata for

    // every single cacheable display in the view, thus we are resetting the

    // query to its original unprocessed state.

    $query = $this->getQuery(TRUE)->getSearchApiQuery();

    $query->preExecute();

    // Allow modules that alter the query to add their cache metadata to the

    // view.

    $cache_metadata->addCacheableDependency($query);

  }



}

src/Plugin/views/cache/SearchApiTagCache.php

+0 −12
Original line number Diff line number Diff line
@@ -3,7 +3,6 @@ 
namespace Drupal\search_api\Plugin\views\cache;



use Drupal\Core\Cache\Cache;

use Drupal\Core\Cache\CacheableMetadata;

use Drupal\Core\Entity\EntityInterface;

use Drupal\Core\Entity\EntityTypeManagerInterface;

use Drupal\views\Plugin\views\cache\Tag;
@@ -116,15 +115,4 @@ class SearchApiTagCache extends Tag { 
    return $tags;

  }



  /**

   * {@inheritdoc}

   */

  public function alterCacheMetadata(CacheableMetadata $cache_metadata) {

    // Allow modules that alter the query to add their cache metadata to the

    // view.

    $query = $this->getQuery()->getSearchApiQuery();

    $query->preExecute();

    $cache_metadata->addCacheableDependency($query);

  }



}

tests/modules/search_api_test_node_indexing/config/install/views.view.search_api_test_node_view.yml

+26 −0
Original line number Diff line number Diff line
@@ -105,3 +105,29 @@ display: 
        - 'user.node_grants:view'

      tags:

        - 'config:search_api.index.test_node_index'

  page_2:

    id: page_2

    display_title: Page 2

    display_plugin: page

    position: 2

    display_options:

      cache:

        type: search_api_time

        options:

          results_lifespan: 21600

          results_lifespan_custom: 0

          output_lifespan: 518400

          output_lifespan_custom: 0

      defaults:

        cache: false

      display_extenders: {  }

      path: test-index-content-time

    cache_metadata:

      max-age: -1

      contexts:

        - 'languages:language_content'

        - 'languages:language_interface'

        - url.query_args

        - 'user.node_grants:view'

      tags:

        - 'config:search_api.index.test_node_index'

tests/modules/search_api_test_views/search_api_test_views.info.yml

+1 −0
Original line number Diff line number Diff line
@@ -8,5 +8,6 @@ dependencies: 
  - drupal:node

  - drupal:rest

  - drupal:views

  - drupal:views_test_data

core_version_requirement: ^9.2 || ^10.0

hidden: true