You are here

Home » API reference » Search API 8 » ViewsCacheabilityMetadataExportTest.php

class ViewsCacheabilityMetadataExportTest in Search API 8

Tests that cacheability metadata is included when Views config is exported.

@group search_api

Hierarchy

Expanded class hierarchy of ViewsCacheabilityMetadataExportTest

File

tests/src/Kernel/Views/ViewsCacheabilityMetadataExportTest.php, line 17

Namespace

Drupal\Tests\search_api\Kernel\Views
View source 
class ViewsCacheabilityMetadataExportTest extends KernelTestBase {

  /**
   * The ID of the view used in the test.
   */
  const TEST_VIEW_ID = 'search_api_test_node_view';

  /**
   * The display IDs used in the test.
   *
   * @var string[]
   */
  protected static $testViewDisplayIds = [
    'default',
    'page_1',
  ];

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * The service that is responsible for creating Views executable objects.
   *
   * @var \Drupal\views\ViewExecutableFactory
   */
  protected $viewExecutableFactory;

  /**
   * The state service.
   *
   * @var \Drupal\Core\State\StateInterface
   */
  protected $state;

  /**
   * {@inheritdoc}
   */
  protected static $modules = [
    'field',
    'node',
    'search_api',
    'search_api_db',
    'search_api_test_node_indexing',
    'search_api_test_views',
    'system',
    'text',
    'user',
    'views',
  ];

  /**
   * {@inheritdoc}
   */
  public function register(ContainerBuilder $container) {
    parent::register($container);

    // Use a mocked version of the cache contexts manager so we can use a mocked
    // cache context "search_api_test_context" without triggering a validation
    // error.
    $cache_contexts_manager = $this
      ->createMock(CacheContextsManager::class);
    $cache_contexts_manager
      ->method('assertValidTokens')
      ->willReturn(TRUE);
    $cache_contexts_manager
      ->method('convertTokensToKeys')
      ->willReturn(new ContextCacheKeys([]));
    $container
      ->set('cache_contexts_manager', $cache_contexts_manager);
  }

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();
    $this
      ->installEntitySchema('node');
    $this
      ->installEntitySchema('search_api_task');
    $this
      ->installConfig([
      'search_api',
      'search_api_test_node_indexing',
    ]);
    $this->entityTypeManager = $this->container
      ->get('entity_type.manager');
    $this->viewExecutableFactory = $this->container
      ->get('views.executable');
    $this->state = $this->container
      ->get('state');
  }

  /**
   * Tests that an exported view contains the right cacheability metadata.
   */
  public function testViewExport() {
    $expected_cacheability_metadata = [
      'contexts' => [
        // Search API uses the core EntityFieldRenderer for rendering content.
        // This has support for translatable content, so the result varies by
        // content language.
        // @see \Drupal\views\Entity\Render\EntityFieldRenderer::getCacheContexts()
        'languages:language_content',
        // By default, Views always adds the interface language cache context
        // since it is very likely that there will be translatable strings in
        // the result.
        // @see \Drupal\views\Entity\View::addCacheMetadata()
        'languages:language_interface',
        // Our test view has a pager so we expect it to vary by query arguments.
        // @see \Drupal\views\Plugin\views\pager\SqlBase::getCacheContexts()
        'url.query_args',
        // The test view is a listing of nodes returned as a search result. It
        // is expected to have the list cache contexts of the node entity type.
        // This is defined in the "list_cache_contexts" key of the node entity
        // annotation.
        'user.node_grants:view',
      ],
      'tags' => [
        // Our test view depends on the search index, so whenever the index
        // configuration changes the cached results should be invalidated.
        // @see \Drupal\search_api\Query\Query::getCacheTags()
        'config:search_api.index.test_node_index',
      ],
      // By default the result is permanently cached.
      'max-age' => -1,
    ];

    // Check that our test view has the expected cacheability metadata.
    $view = $this
      ->getView();
    $this
      ->assertViewCacheabilityMetadata($expected_cacheability_metadata, $view);

    // For efficiency Views calculates the cacheability metadata whenever a view
    // is saved, and includes it in the exported configuration.
    // @see \Drupal\views\Entity\View::addCacheMetadata()
    // Check that the exported configuration contains the expected metadata.
    $view_config = $this
      ->config('views.view.' . self::TEST_VIEW_ID);
    $this
      ->assertViewConfigCacheabilityMetadata($expected_cacheability_metadata, $view_config);

    // Test that modules are able to alter the cacheability metadata. Our test
    // hook implementation will alter all 3 types of metadata.
    // @see search_api_test_views_search_api_query_alter()
    $expected_cacheability_metadata['contexts'][] = 'search_api_test_context';
    $expected_cacheability_metadata['tags'][] = 'search_api:test_tag';
    $expected_cacheability_metadata['max-age'] = 100;

    // Activate the alter hook and resave the view so it will recalculate the
    // cacheability metadata.
    $this->state
      ->set('search_api_test_views.alter_query_cacheability_metadata', TRUE);
    $view = $this
      ->getView();
    $view
      ->save();

    // Check that the altered metadata is now present in the view and the
    // configuration.
    $view = $this
      ->getView();
    $this
      ->assertViewCacheabilityMetadata($expected_cacheability_metadata, $view);
    $view_config = $this
      ->config('views.view.' . self::TEST_VIEW_ID);
    $this
      ->assertViewConfigCacheabilityMetadata($expected_cacheability_metadata, $view_config);
  }

  /**
   * Checks that the given view has the expected cacheability metadata.
   *
   * @param array $expected_cacheability_metadata
   *   An array of cacheability metadata that is expected to be present on the
   *   view.
   * @param \Drupal\views\ViewExecutable $view
   *   The view.
   */
  protected function assertViewCacheabilityMetadata(array $expected_cacheability_metadata, ViewExecutable $view) {

    // Cacheability metadata is stored separately for each Views display since
    // depending on how the display is configured it might have different
    // caching needs. Ensure to check all displays.
    foreach (self::$testViewDisplayIds as $display_id) {
      $view
        ->setDisplay($display_id);
      $display = $view
        ->getDisplay();
      $actual_cacheability_metadata = $display
        ->getCacheMetadata();
      $this
        ->assertArrayEquals($expected_cacheability_metadata['contexts'], $actual_cacheability_metadata
        ->getCacheContexts());
      $this
        ->assertArrayEquals($expected_cacheability_metadata['tags'], $actual_cacheability_metadata
        ->getCacheTags());
      $this
        ->assertEquals($expected_cacheability_metadata['max-age'], $actual_cacheability_metadata
        ->getCacheMaxAge());
    }
  }

  /**
   * Checks that the given view config has the expected cacheability metadata.
   *
   * @param array $expected_cacheability_metadata
   *   An array of cacheability metadata that is expected to be present on the
   *   view configuration.
   * @param \Drupal\Core\Config\Config $config
   *   The configuration to check.
   */
  protected function assertViewConfigCacheabilityMetadata(array $expected_cacheability_metadata, Config $config) {

    // Cacheability metadata is stored separately for each Views display since
    // depending on how the display is configured it might have different
    // caching needs. Ensure to check all displays.
    foreach (self::$testViewDisplayIds as $display_id) {
      $view_config_display = $config
        ->get("display.{$display_id}");
      foreach ($expected_cacheability_metadata as $cache_key => $value) {
        if (is_array($value)) {
          $this
            ->assertArrayEquals($value, $view_config_display['cache_metadata'][$cache_key]);
        }
        else {
          $this
            ->assertEquals($value, $view_config_display['cache_metadata'][$cache_key]);
        }
      }
    }
  }

  /**
   * Checks that the given arrays have the same values.
   *
   * @param array $array1
   *   One of the arrays to compare.
   * @param array $array2
   *   One of the arrays to compare.
   */
  protected function assertArrayEquals(array $array1, array $array2) {
    sort($array1);
    sort($array2);
    $this
      ->assertEquals($array1, $array2);
  }

  /**
   * Returns the test view.
   *
   * @return \Drupal\views\ViewExecutable
   *   The view.
   */
  protected function getView() {

    /** @var \Drupal\views\ViewEntityInterface $view */
    $view = $this->entityTypeManager
      ->getStorage('view')
      ->load(self::TEST_VIEW_ID);
    $executable = $this->viewExecutableFactory
      ->get($view);
    return $executable;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AssertContentTrait::$content protected property The current raw content.
AssertContentTrait::$drupalSettings protected property The drupalSettings value from the current raw $content.
AssertContentTrait::$elements protected property The XML structure parsed from the current raw $content. 1
AssertContentTrait::$plainTextContent protected property The plain-text content of raw $content (text nodes).
AssertContentTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertContentTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
AssertContentTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertContentTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertContentTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
AssertContentTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertContentTrait::assertLink protected function Passes if a link with the specified label is found.
AssertContentTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertContentTrait::assertNoDuplicateIds protected function Asserts that each HTML ID is used for just a single element.
AssertContentTrait::assertNoEscaped protected function Passes if the raw text IS NOT found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertNoField protected function Asserts that a field does not exist with the given name or ID.
AssertContentTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertContentTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertContentTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertContentTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
AssertContentTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertContentTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
AssertContentTrait::assertNoLinkByHrefInMainRegion protected function Passes if a link containing a given href is not found in the main region.
AssertContentTrait::assertNoOption protected function Asserts that a select option in the current page does not exist.
AssertContentTrait::assertNoOptionSelected protected function Asserts that a select option in the current page is not checked.
AssertContentTrait::assertNoPattern protected function Triggers a pass if the perl regex pattern is not found in raw content.
AssertContentTrait::assertNoRaw protected function Passes if the raw text is NOT found on the loaded page, fail otherwise.
AssertContentTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text.
AssertContentTrait::assertNoTitle protected function Pass if the page title is not the given string.
AssertContentTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertContentTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertOptionByText protected function Asserts that a select option with the visible text exists.
AssertContentTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionSelectedWithDrupalSelector protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionWithDrupalSelector protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertContentTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise.
AssertContentTrait::assertText protected function Passes if the page (with HTML stripped) contains the text.
AssertContentTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertContentTrait::assertTextPattern protected function Asserts that a Perl regex pattern is found in the plain-text content.
AssertContentTrait::assertThemeOutput protected function Asserts themed output.
AssertContentTrait::assertTitle protected function Pass if the page title is the given string.
AssertContentTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertContentTrait::assertUniqueTextHelper protected function Helper for assertUniqueText and assertNoUniqueText.
AssertContentTrait::buildXPathQuery protected function Builds an XPath query.
AssertContentTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertContentTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
AssertContentTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertContentTrait::getDrupalSettings protected function Gets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::getRawContent protected function Gets the current raw content.
AssertContentTrait::getSelectedItem protected function Get the selected value from a select field.
AssertContentTrait::getTextContent protected function Retrieves the plain-text content from the current raw content.
AssertContentTrait::getUrl protected function Get the current URL from the cURL handler. 1
AssertContentTrait::parse protected function Parse content returned from curlExec using DOM and SimpleXML.
AssertContentTrait::removeWhiteSpace protected function Removes all white-space between HTML tags from the raw content.
AssertContentTrait::setDrupalSettings protected function Sets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::setRawContent protected function Sets the raw content (e.g. HTML).
AssertContentTrait::xpath protected function Performs an xpath search on the contents of the internal browser.
AssertHelperTrait::castSafeStrings protected static function Casts MarkupInterface objects into strings.
AssertLegacyTrait::assert protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::assertEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertSame() instead.
AssertLegacyTrait::assertIdenticalObject protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertNotEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotEquals() instead.
AssertLegacyTrait::assertNotIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotSame() instead.
AssertLegacyTrait::pass protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::verbose protected function
ConfigTestTrait::configImporter protected function Returns a ConfigImporter object to import test configuration.
ConfigTestTrait::copyConfig protected function Copies configuration objects from source storage to target storage.
KernelTestBase::$backupGlobals protected property Back up and restore any global variables that may be changed by tests.
KernelTestBase::$backupStaticAttributes protected property Back up and restore static class properties that may be changed by tests.
KernelTestBase::$backupStaticAttributesBlacklist protected property Contains a few static class properties for performance.
KernelTestBase::$classLoader protected property
KernelTestBase::$configImporter protected property @todo Move into Config test base class. 7
KernelTestBase::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking.
KernelTestBase::$container protected property
KernelTestBase::$databasePrefix protected property
KernelTestBase::$preserveGlobalState protected property Do not forward any global state from the parent process to the processes that run the actual tests.
KernelTestBase::$root protected property The app root.
KernelTestBase::$runTestInSeparateProcess protected property Kernel tests are run in separate processes because they allow autoloading of code from extensions. Running the test in a separate process isolates this behavior from other tests. Subclasses should not override this property.
KernelTestBase::$siteDirectory protected property
KernelTestBase::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 6
KernelTestBase::$vfsRoot protected property The virtual filesystem root directory.
KernelTestBase::assertPostConditions protected function 1
KernelTestBase::bootEnvironment protected function Bootstraps a basic test environment.
KernelTestBase::bootKernel private function Bootstraps a kernel for a test.
KernelTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
KernelTestBase::disableModules protected function Disables modules for this test.
KernelTestBase::enableModules protected function Enables modules for this test.
KernelTestBase::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
KernelTestBase::getDatabaseConnectionInfo protected function Returns the Database connection info to be used for this test. 1
KernelTestBase::getDatabasePrefix public function
KernelTestBase::getExtensionsForModules private function Returns Extension objects for $modules to enable.
KernelTestBase::getModulesToEnable private static function Returns the modules to enable for this test.
KernelTestBase::initFileCache protected function Initializes the FileCache component.
KernelTestBase::installConfig protected function Installs default configuration for a given list of modules.
KernelTestBase::installEntitySchema protected function Installs the storage schema for a specific entity type.
KernelTestBase::installSchema protected function Installs database tables from a module schema definition.
KernelTestBase::isTestInIsolation Deprecated protected function Returns whether the current test method is running in a separate process.
KernelTestBase::prepareTemplate protected function
KernelTestBase::render protected function Renders a render array. 1
KernelTestBase::setInstallProfile protected function Sets the install profile and rebuilds the container to update it.
KernelTestBase::setSetting protected function Sets an in-memory Settings variable.
KernelTestBase::setUpBeforeClass public static function 1
KernelTestBase::setUpFilesystem protected function Sets up the filesystem, so things like the file directory. 2
KernelTestBase::stop protected function Stops test execution.
KernelTestBase::tearDown protected function 6
KernelTestBase::tearDownCloseDatabaseConnection public function @after
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__get Deprecated public function BC: Automatically resolve former KernelTestBase class properties.
KernelTestBase::__sleep public function Prevents serializing any properties.
PhpunitCompatibilityTrait::getMock Deprecated public function Returns a mock object for the specified class using the available method.
PhpunitCompatibilityTrait::setExpectedException Deprecated public function Compatibility layer for PHPUnit 6 to support PHPUnit 4 code.
RandomGeneratorTrait::$randomGenerator protected property The random generator.
RandomGeneratorTrait::getRandomGenerator protected function Gets the random generator for the utility methods.
RandomGeneratorTrait::randomMachineName protected function Generates a unique random string containing letters and numbers. 1
RandomGeneratorTrait::randomObject public function Generates a random PHP object.
RandomGeneratorTrait::randomString public function Generates a pseudo-random string of ASCII characters of codes 32 to 126.
RandomGeneratorTrait::randomStringValidate public function Callback for random string validation.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::checkModuleRequirements private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements protected function Check module requirements for the Drupal use case. 1
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.
ViewsCacheabilityMetadataExportTest::$entityTypeManager protected property The entity type manager.
ViewsCacheabilityMetadataExportTest::$modules protected static property Modules to enable. Overrides KernelTestBase::$modules
ViewsCacheabilityMetadataExportTest::$state protected property The state service.
ViewsCacheabilityMetadataExportTest::$testViewDisplayIds protected static property The display IDs used in the test.
ViewsCacheabilityMetadataExportTest::$viewExecutableFactory protected property The service that is responsible for creating Views executable objects.
ViewsCacheabilityMetadataExportTest::assertArrayEquals protected function Checks that the given arrays have the same values.
ViewsCacheabilityMetadataExportTest::assertViewCacheabilityMetadata protected function Checks that the given view has the expected cacheability metadata.
ViewsCacheabilityMetadataExportTest::assertViewConfigCacheabilityMetadata protected function Checks that the given view config has the expected cacheability metadata.
ViewsCacheabilityMetadataExportTest::getView protected function Returns the test view.
ViewsCacheabilityMetadataExportTest::register public function Registers test-specific services. Overrides KernelTestBase::register
ViewsCacheabilityMetadataExportTest::setUp protected function Overrides KernelTestBase::setUp
ViewsCacheabilityMetadataExportTest::testViewExport public function Tests that an exported view contains the right cacheability metadata.
ViewsCacheabilityMetadataExportTest::TEST_VIEW_ID constant The ID of the view used in the test.