class PageCacheTagsIntegrationTest

Same name and namespace in other branches
  1. 9 core/modules/page_cache/tests/src/Functional/PageCacheTagsIntegrationTest.php \Drupal\Tests\page_cache\Functional\PageCacheTagsIntegrationTest
  2. 8.9.x core/modules/page_cache/tests/src/Functional/PageCacheTagsIntegrationTest.php \Drupal\Tests\page_cache\Functional\PageCacheTagsIntegrationTest
  3. 10 core/modules/page_cache/tests/src/Functional/PageCacheTagsIntegrationTest.php \Drupal\Tests\page_cache\Functional\PageCacheTagsIntegrationTest

Enables the page cache and tests its cache tags in various scenarios.

@group Cache

Hierarchy

Expanded class hierarchy of PageCacheTagsIntegrationTest

See also

\Drupal\Tests\page_cache\Functional\PageCacheTest

File

core/modules/page_cache/tests/src/Functional/PageCacheTagsIntegrationTest.php, line 26

Namespace

Drupal\Tests\page_cache\Functional
View source
class PageCacheTagsIntegrationTest extends BrowserTestBase {
    use AssertPageCacheContextsAndTagsTrait;
    use CommentTestTrait;
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'olivero';
    
    /**
     * Modules to enable.
     * @var array
     */
    protected static $modules = [
        'big_pipe',
        'block',
        'comment',
        'editor',
        'filter',
        'language',
        'help',
        'node',
        'search',
        'views',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $this->enablePageCaching();
    }
    
    /**
     * Tests that cache tags are properly bubbled up to the page level.
     */
    public function testPageCacheTags() : void {
        $config = $this->config('language.types');
        $config->set('configurable', [
            LanguageInterface::TYPE_INTERFACE,
            LanguageInterface::TYPE_CONTENT,
        ]);
        $config->set('negotiation.language_content.enabled', [
            LanguageNegotiationUrl::METHOD_ID => 0,
            LanguageNegotiationContentEntity::METHOD_ID => 1,
        ]);
        $config->save();
        // Create two filters.
        FilterFormat::create(Yaml::parseFile('core/profiles/standard/config/install/filter.format.basic_html.yml'))->save();
        FilterFormat::create(Yaml::parseFile('core/profiles/standard/config/install/filter.format.full_html.yml'))->save();
        $this->drupalCreateContentType([
            'type' => 'page',
            'title' => 'Basic page',
        ]);
        $this->addDefaultCommentField('node', 'page');
        // To generate search and comment tags.
        $anonymous = Role::load(RoleInterface::ANONYMOUS_ID);
        $anonymous->grantPermission('search content')
            ->grantPermission('access comments');
        $anonymous->save();
        // Create two nodes.
        $author_1 = $this->drupalCreateUser();
        $node_1 = $this->drupalCreateNode([
            'uid' => $author_1->id(),
            'title' => 'Node 1',
            'body' => [
                0 => [
                    'value' => 'Body 1',
                    'format' => 'basic_html',
                ],
            ],
            'promote' => NodeInterface::PROMOTED,
        ]);
        $author_2 = $this->drupalCreateUser();
        $node_2 = $this->drupalCreateNode([
            'uid' => $author_2->id(),
            'title' => 'Node 2',
            'body' => [
                0 => [
                    'value' => 'Body 2',
                    'format' => 'full_html',
                ],
            ],
            'promote' => NodeInterface::PROMOTED,
        ]);
        // Place a block, but only make it visible on full node page 2.
        $block = $this->drupalPlaceBlock('views_block:comments_recent-block_1', [
            'visibility' => [
                'request_path' => [
                    'pages' => '/node/' . $node_2->id(),
                ],
            ],
        ]);
        $cache_contexts = [
            'languages:' . LanguageInterface::TYPE_INTERFACE,
            'route',
            'theme',
            'timezone',
            // The placed block is only visible on certain URLs through a visibility
            // condition.
'url.path',
            'url.query_args:' . MainContentViewSubscriber::WRAPPER_FORMAT,
            // rel=canonical links and friends have absolute URLs as their values.
'url.site',
            // These two cache contexts are added by BigPipe.
'cookies:big_pipe_nojs',
            'session.exists',
            'user.permissions',
            'user.roles',
        ];
        // Full node page 1.
        $this->assertPageCacheContextsAndTags($node_1->toUrl(), $cache_contexts, [
            'http_response',
            'rendered',
            'block_view',
            'local_task',
            'config:block_list',
            'config:block.block.olivero_site_branding',
            'config:block.block.olivero_breadcrumbs',
            'config:block.block.olivero_content',
            'config:block.block.olivero_help',
            'config:block.block.olivero_search_form_narrow',
            'config:block.block.olivero_search_form_wide',
            'config:block.block.' . $block->id(),
            'config:block.block.olivero_powered',
            'config:block.block.olivero_main_menu',
            'config:block.block.olivero_account_menu',
            'config:block.block.olivero_messages',
            'config:block.block.olivero_primary_local_tasks',
            'config:block.block.olivero_secondary_local_tasks',
            'config:block.block.olivero_syndicate',
            'config:block.block.olivero_primary_admin_actions',
            'config:block.block.olivero_page_title',
            'node_view',
            'CACHE_MISS_IF_UNCACHEABLE_HTTP_METHOD:form',
            'node:' . $node_1->id(),
            'user:' . $author_1->id(),
            'config:filter.format.basic_html',
            'config:search.settings',
            'config:system.menu.account',
            'config:system.menu.main',
            'config:system.site',
            // FinishResponseSubscriber adds this cache tag to responses that have the
            // 'user.permissions' cache context for anonymous users.
'config:user.role.anonymous',
        ]);
        // Render the view block adds the languages cache context.
        $cache_contexts[] = 'languages:' . LanguageInterface::TYPE_CONTENT;
        // Full node page 2.
        $this->assertPageCacheContextsAndTags($node_2->toUrl(), $cache_contexts, [
            'http_response',
            'rendered',
            'block_view',
            'local_task',
            'config:block_list',
            'config:block.block.olivero_site_branding',
            'config:block.block.olivero_breadcrumbs',
            'config:block.block.olivero_content',
            'config:block.block.olivero_help',
            'config:block.block.olivero_search_form_narrow',
            'config:block.block.olivero_search_form_wide',
            'config:block.block.' . $block->id(),
            'config:block.block.olivero_powered',
            'config:block.block.olivero_main_menu',
            'config:block.block.olivero_account_menu',
            'config:block.block.olivero_messages',
            'config:block.block.olivero_primary_local_tasks',
            'config:block.block.olivero_secondary_local_tasks',
            'config:block.block.olivero_syndicate',
            'config:block.block.olivero_primary_admin_actions',
            'config:block.block.olivero_page_title',
            'node_view',
            'CACHE_MISS_IF_UNCACHEABLE_HTTP_METHOD:form',
            'node:' . $node_2->id(),
            'user:' . $author_2->id(),
            'config:filter.format.full_html',
            'config:search.settings',
            'config:system.menu.account',
            'config:system.menu.main',
            'config:system.site',
            'comment_list',
            'node_list',
            'config:views.view.comments_recent',
            // FinishResponseSubscriber adds this cache tag to responses that have the
            // 'user.permissions' cache context for anonymous users.
'config:user.role.anonymous',
        ]);
    }

}

Members

Title Sort descending Modifiers Object type Summary Member alias Overriden Title Overrides
AssertPageCacheContextsAndTagsTrait::assertCacheContext protected function Asserts whether an expected cache context was present in the last response.
AssertPageCacheContextsAndTagsTrait::assertCacheContexts protected function Ensures that some cache contexts are present in the current response.
AssertPageCacheContextsAndTagsTrait::assertCacheMaxAge protected function Asserts the max age header.
AssertPageCacheContextsAndTagsTrait::assertCacheTags protected function Ensures that some cache tags are present in the current response.
AssertPageCacheContextsAndTagsTrait::assertNoCacheContext protected function Asserts that a cache context was not present in the last response.
AssertPageCacheContextsAndTagsTrait::assertPageCacheContextsAndTags protected function Asserts page cache miss, then hit for the given URL; checks cache headers.
AssertPageCacheContextsAndTagsTrait::enablePageCaching protected function Enables page caching.
AssertPageCacheContextsAndTagsTrait::getCacheHeaderValues protected function Gets a specific header value as array.
BlockCreationTrait::placeBlock protected function Creates a block instance based on default settings. Aliased as: drupalPlaceBlock
BrowserHtmlDebugTrait::$htmlOutputBaseUrl protected property The Base URI to use for links to the output files.
BrowserHtmlDebugTrait::$htmlOutputClassName protected property Class name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounter protected property Counter for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounterStorage protected property Counter storage for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputDirectory protected property Directory name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputEnabled protected property HTML output enabled.
BrowserHtmlDebugTrait::$htmlOutputTestId protected property HTML output test ID.
BrowserHtmlDebugTrait::formatHtmlOutputHeaders protected function Formats HTTP headers as string for HTML output logging.
BrowserHtmlDebugTrait::getHtmlOutputHeaders protected function Returns headers in HTML output format. 1
BrowserHtmlDebugTrait::getResponseLogHandler protected function Provides a Guzzle middleware handler to log every response received.
BrowserHtmlDebugTrait::htmlOutput protected function Logs a HTML output message in a text file.
BrowserHtmlDebugTrait::initBrowserOutputFile protected function Creates the directory to store browser output.
BrowserTestBase::$baseUrl protected property The base URL.
BrowserTestBase::$configImporter protected property The config importer that can be used in a test.
BrowserTestBase::$customTranslations protected property An array of custom translations suitable for SettingsEditor::rewrite().
BrowserTestBase::$mink protected property Mink session manager.
BrowserTestBase::$minkDefaultDriverArgs protected property Mink default driver params.
BrowserTestBase::$minkDefaultDriverClass protected property Mink class for the default driver to use. 1
BrowserTestBase::$originalContainer protected property The original container.
BrowserTestBase::$originalShutdownCallbacks protected property The original array of shutdown function callbacks.
BrowserTestBase::$profile protected property The profile to install as a basis for testing. 40
BrowserTestBase::$timeLimit protected property Time limit in seconds for the test.
BrowserTestBase::$translationFilesDirectory protected property The translation file directory for the test environment.
BrowserTestBase::cleanupEnvironment protected function Clean up the test environment.
BrowserTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
BrowserTestBase::filePreDeleteCallback public static function Ensures test files are deletable.
BrowserTestBase::getDefaultDriverInstance protected function Gets an instance of the default Mink driver.
BrowserTestBase::getDrupalSettings protected function Gets the JavaScript drupalSettings variable for the currently-loaded page. 1
BrowserTestBase::getHttpClient protected function Obtain the HTTP client for the system under test.
BrowserTestBase::getMinkDriverArgs protected function Gets the Mink driver args from an environment variable. 1
BrowserTestBase::getOptions protected function Helper function to get the options of select field.
BrowserTestBase::getSession public function Returns Mink session.
BrowserTestBase::getSessionCookies protected function Get session cookies from current session.
BrowserTestBase::getTestMethodCaller protected function Retrieves the current calling line in the class under test. Overrides BrowserHtmlDebugTrait::getTestMethodCaller
BrowserTestBase::initFrontPage protected function Visits the front page when initializing Mink. 3
BrowserTestBase::initMink protected function Initializes Mink sessions. 1
BrowserTestBase::installDrupal public function Installs Drupal into the test site. 2
BrowserTestBase::registerSessions protected function Registers additional Mink sessions.
BrowserTestBase::setUpAppRoot protected function Sets up the root application path.
BrowserTestBase::setUpBeforeClass public static function 1
BrowserTestBase::tearDown protected function 3
BrowserTestBase::translatePostValues protected function Transforms a nested array into a flat array suitable for submitForm().
BrowserTestBase::xpath protected function Performs an xpath search on the contents of the internal browser.
BrowserTestBase::__construct public function
BrowserTestBase::__sleep public function Prevents serializing any properties.
CommentTestTrait::addDefaultCommentField public function Adds the default comment field to an entity.
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.
ContentTypeCreationTrait::createContentType protected function Creates a custom content type based on default settings. Aliased as: drupalCreateContentType 1
ExpectDeprecationTrait::expectDeprecation public function Adds an expected deprecation.
ExpectDeprecationTrait::getCallableName private static function Returns a callable as a string suitable for inclusion in a message.
ExpectDeprecationTrait::setUpErrorHandler public function Sets up the test error handler.
ExpectDeprecationTrait::tearDownErrorHandler public function Tears down the test error handler.
ExtensionListTestTrait::getModulePath protected function Gets the path for the specified module.
ExtensionListTestTrait::getThemePath protected function Gets the path for the specified theme.
FunctionalTestSetupTrait::$apcuEnsureUniquePrefix protected property The flag to set 'apcu_ensure_unique_prefix' setting. 1
FunctionalTestSetupTrait::$classLoader protected property The class loader to use for installation and initialization of setup.
FunctionalTestSetupTrait::$rootUser protected property The "#1" admin user.
FunctionalTestSetupTrait::$usesSuperUserAccessPolicy protected property Set to TRUE to make user 1 a super user. 19
FunctionalTestSetupTrait::doInstall protected function Execute the non-interactive installer. 1
FunctionalTestSetupTrait::getDatabaseTypes protected function Returns all supported database driver installer objects.
FunctionalTestSetupTrait::initConfig protected function Initialize various configurations post-installation. 1
FunctionalTestSetupTrait::initKernel protected function Initializes the kernel after installation.
FunctionalTestSetupTrait::initSettings protected function Initialize settings created during install.
FunctionalTestSetupTrait::initUserSession protected function Initializes user 1 for the site to be installed.
FunctionalTestSetupTrait::installDefaultThemeFromClassProperty protected function Installs the default theme defined by `static::$defaultTheme` when needed. 1
FunctionalTestSetupTrait::installModulesFromClassProperty protected function Install modules defined by `static::$modules`. 1
FunctionalTestSetupTrait::installParameters protected function Returns the parameters that will be used when the test installs Drupal. 8
FunctionalTestSetupTrait::prepareEnvironment protected function Prepares the current environment for running the test. 28
FunctionalTestSetupTrait::prepareRequestForGenerator protected function Creates a mock request and sets it on the generator.
FunctionalTestSetupTrait::prepareSettings protected function Prepares site settings and services before installation. 4
FunctionalTestSetupTrait::rebuildAll protected function Resets and rebuilds the environment after setup.
FunctionalTestSetupTrait::rebuildContainer protected function Rebuilds \Drupal::getContainer().
FunctionalTestSetupTrait::resetAll protected function Resets all data structures after having enabled new modules.
FunctionalTestSetupTrait::setContainerParameter protected function Changes parameters in the services.yml file.
FunctionalTestSetupTrait::setupBaseUrl protected function Sets up the base URL based upon the environment variable.
FunctionalTestSetupTrait::writeSettings protected function Rewrites the settings.php file of the test site. 1
NodeCreationTrait::createNode protected function Creates a node based on default settings. Aliased as: drupalCreateNode
NodeCreationTrait::getNodeByTitle public function Get a node from the database based on its title. Aliased as: drupalGetNodeByTitle
PageCacheTagsIntegrationTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
PageCacheTagsIntegrationTest::$modules protected static property Modules to enable. Overrides BrowserTestBase::$modules
PageCacheTagsIntegrationTest::setUp protected function Overrides BrowserTestBase::setUp
PageCacheTagsIntegrationTest::testPageCacheTags public function Tests that cache tags are properly bubbled up to the page level.
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.
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.
RefreshVariablesTrait::refreshVariables protected function Refreshes in-memory configuration and state information. 2
SessionTestTrait::$sessionName protected property The name of the session cookie.
SessionTestTrait::generateSessionName protected function Generates a session cookie name.
SessionTestTrait::getSessionName protected function Returns the session name in use on the child site.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.
TestSetupTrait::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking. 2
TestSetupTrait::$container protected property The dependency injection container used in the test.
TestSetupTrait::$databasePrefix protected property The database prefix of this test run.
TestSetupTrait::$kernel protected property The DrupalKernel instance used in the test.
TestSetupTrait::$originalSite protected property The site directory of the original parent site.
TestSetupTrait::$privateFilesDirectory protected property The private file directory for the test environment.
TestSetupTrait::$publicFilesDirectory protected property The public file directory for the test environment.
TestSetupTrait::$root protected property The app root.
TestSetupTrait::$siteDirectory protected property The site directory of this test run.
TestSetupTrait::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 4
TestSetupTrait::$tempFilesDirectory protected property The temporary file directory for the test environment.
TestSetupTrait::$testId protected property The test run ID.
TestSetupTrait::changeDatabasePrefix protected function Changes the database connection to the prefixed one.
TestSetupTrait::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
TestSetupTrait::prepareDatabasePrefix protected function Generates a database prefix for running tests. 1
UiHelperTrait::$loggedInUser protected property The current user logged in using the Mink controlled browser.
UiHelperTrait::$maximumMetaRefreshCount protected property The number of meta refresh redirects to follow, or NULL if unlimited.
UiHelperTrait::$metaRefreshCount protected property The number of meta refresh redirects followed during ::drupalGet().
UiHelperTrait::assertSession public function Returns WebAssert object. 1
UiHelperTrait::buildUrl protected function Builds an absolute URL from a system path or a URL object.
UiHelperTrait::checkForMetaRefresh protected function Checks for meta refresh tag and if found call drupalGet() recursively.
UiHelperTrait::click protected function Clicks the element with the given CSS selector.
UiHelperTrait::clickLink protected function Follows a link by complete name.
UiHelperTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
UiHelperTrait::cssSelectToXpath protected function Translates a CSS expression to its XPath equivalent.
UiHelperTrait::drupalGet protected function Retrieves a Drupal path or an absolute path. 3
UiHelperTrait::drupalLogin protected function Logs in a user using the Mink controlled browser.
UiHelperTrait::drupalLogout protected function Logs a user out of the Mink controlled browser and confirms.
UiHelperTrait::drupalResetSession protected function Resets the current active session back to Anonymous session.
UiHelperTrait::drupalUserIsLoggedIn protected function Returns whether a given user account is logged in.
UiHelperTrait::getAbsoluteUrl protected function Takes a path and returns an absolute path.
UiHelperTrait::getTextContent protected function Retrieves the plain-text content from the current page.
UiHelperTrait::getUrl protected function Get the current URL from the browser.
UiHelperTrait::isTestUsingGuzzleClient protected function Determines if test is using DrupalTestBrowser.
UiHelperTrait::prepareRequest protected function Prepare for a request to testing site. 1
UiHelperTrait::submitForm protected function Fills and submits a form.
UserCreationTrait::checkPermissions protected function Checks whether a given list of permission names is valid.
UserCreationTrait::createAdminRole protected function Creates an administrative role.
UserCreationTrait::createRole protected function Creates a role with specified permissions. Aliased as: drupalCreateRole
UserCreationTrait::createUser protected function Create a user with a given set of permissions. Aliased as: drupalCreateUser
UserCreationTrait::grantPermissions protected function Grant permissions to a user role.
UserCreationTrait::setCurrentUser protected function Switch the current logged in user.
UserCreationTrait::setUpCurrentUser protected function Creates a random user account and sets it as current user.
XdebugRequestTrait::extractCookiesFromRequest protected function Adds xdebug cookies, from request setup.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.