n.kolosnaj/DrupalTutorial
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

first commit

Browse Source
This commit is contained in:
nkolosnjaj
2024-07-15 12:33:27 +02:00
commit ce50ae282b
22084 changed files with 2623791 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
core/modules/page_cache/tests/modules/page_cache_form_test.info.yml Executable file
View File

@@ -0,0 +1,10 @@
name: 'Page Cache Form Test'
type: module
description: 'Support module for the Page Cache module tests.'
package: Testing
# version: VERSION
# Information added by Drupal.org packaging script on 2024-07-04
version: '10.3.1'
project: 'drupal'
datestamp: 1720094222

15
core/modules/page_cache/tests/modules/page_cache_form_test.install Executable file
View File

@@ -0,0 +1,15 @@
<?php
/**
* @file
* Install hooks for page_cache_form_test.
*/
/**
* Implements hook_install().
*/
function page_cache_form_test_install() {
// Set an explicit module weight, to ensure that the form alter hook is
// always called after page_cache_form_alter().
module_set_weight('page_cache_form_test', 10);
}

40
core/modules/page_cache/tests/modules/page_cache_form_test.module Executable file
View File

@@ -0,0 +1,40 @@
<?php
/**
* @file
* Provides functionality for testing form caching.
*/
use Drupal\Core\Form\FormStateInterface;
/**
* Implements hook_form_FORM_ID_alter().
*/
function page_cache_form_test_form_page_cache_form_test_alter(&$form, FormStateInterface $form_state, $form_id) {
// This runs earlier than system_form_alter() so we fore-go the immutability
// check to the process callback, by which time system_form_alter() has run.
$form['#process'][] = 'page_cache_form_test_form_page_cache_form_test_process';
}
/**
* Process callback to check immutability.
*/
function page_cache_form_test_form_page_cache_form_test_process($form, FormStateInterface $form_state) {
if (isset($form_state->getBuildInfo()['immutable']) && $form_state->getBuildInfo()['immutable']) {
$form['#suffix'] = 'Immutable: TRUE';
}
else {
$form['#suffix'] = 'Immutable: FALSE';
}
return $form;
}
/**
* Implements hook_module_implements_alter().
*/
function page_cache_form_test_module_implements_alter(&$implementations, $hook) {
if ($hook === 'form_alter' && \Drupal::state()->get('page_cache_bypass_form_immutability', FALSE)) {
// Disable system_form_alter
unset($implementations['system']);
}
}

6
core/modules/page_cache/tests/modules/page_cache_form_test.routing.yml Executable file
View File

@@ -0,0 +1,6 @@
page_cache_form_test.test_immutability:
path: '/page_cache_form_test_immutability'
defaults:
_form: '\Drupal\page_cache_form_test\Form\TestForm'
requirements:
_access: 'TRUE'

35
core/modules/page_cache/tests/modules/src/Form/TestForm.php Executable file
View File

@@ -0,0 +1,35 @@
<?php
namespace Drupal\page_cache_form_test\Form;
use Drupal\Core\Form\FormBase;
use Drupal\Core\Form\FormStateInterface;
/**
* A form to test page cache.
*
* @internal
*/
class TestForm extends FormBase {
/**
* {@inheritdoc}
*/
public function getFormId() {
return 'page_cache_form_test';
}
/**
* {@inheritdoc}
*/
public function buildForm(array $form, FormStateInterface $form_state) {
$form['#prefix'] = '<p>Llamas are awesome, but kittens are pretty cool too!</p>';
return $form;
}
/**
* {@inheritdoc}
*/
public function submitForm(array &$form, FormStateInterface $form_state) {}
}

14
core/modules/page_cache/tests/src/Functional/GenericTest.php Executable file
View File

@@ -0,0 +1,14 @@
<?php
declare(strict_types=1);
namespace Drupal\Tests\page_cache\Functional;
use Drupal\Tests\system\Functional\Module\GenericModuleTestBase;
/**
* Generic module test for page_cache.
*
* @group page_cache
*/
class GenericTest extends GenericModuleTestBase {}

220
core/modules/page_cache/tests/src/Functional/PageCacheTagsIntegrationTest.php Executable file
View File

@@ -0,0 +1,220 @@
<?php
declare(strict_types=1);
namespace Drupal\Tests\page_cache\Functional;
use Drupal\comment\Tests\CommentTestTrait;
use Drupal\Core\EventSubscriber\MainContentViewSubscriber;
use Drupal\Core\Language\LanguageInterface;
use Drupal\filter\Entity\FilterFormat;
use Drupal\language\Plugin\LanguageNegotiation\LanguageNegotiationContentEntity;
use Drupal\language\Plugin\LanguageNegotiation\LanguageNegotiationUrl;
use Drupal\node\NodeInterface;
use Drupal\Tests\system\Functional\Cache\AssertPageCacheContextsAndTagsTrait;
use Drupal\Tests\BrowserTestBase;
use Drupal\user\Entity\Role;
use Drupal\user\RoleInterface;
use Symfony\Component\Yaml\Yaml;
/**
* Enables the page cache and tests its cache tags in various scenarios.
*
* @group Cache
* @see \Drupal\Tests\page_cache\Functional\PageCacheTest
*/
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',
]);
}
}

635
core/modules/page_cache/tests/src/Functional/PageCacheTest.php Executable file
View File

@@ -0,0 +1,635 @@
<?php
declare(strict_types=1);
namespace Drupal\Tests\page_cache\Functional;
use Drupal\Component\Datetime\DateTimePlus;
use Drupal\Core\Site\Settings;
use Drupal\Core\Url;
use Drupal\entity_test\Entity\EntityTest;
use Drupal\Core\Cache\Cache;
use Drupal\Tests\BrowserTestBase;
use Drupal\Tests\system\Functional\Cache\AssertPageCacheContextsAndTagsTrait;
use Drupal\user\RoleInterface;
/**
* Enables the page cache and tests it with various HTTP requests.
*
* @group page_cache
* @group #slow
*/
class PageCacheTest extends BrowserTestBase {
use AssertPageCacheContextsAndTagsTrait;
/**
* Modules to enable.
*
* @var array
*/
protected static $modules = ['test_page_test', 'system_test', 'entity_test'];
/**
* {@inheritdoc}
*/
protected $defaultTheme = 'stark';
/**
* {@inheritdoc}
*/
protected function setUp(): void {
parent::setUp();
$this->config('system.site')
->set('name', 'Drupal')
->set('page.front', '/test-page')
->save();
}
/**
* Tests that cache tags are properly persisted.
*
* Since tag based invalidation works, we know that our tag properly
* persisted.
*/
public function testPageCacheTags(): void {
$this->enablePageCaching();
$path = 'system-test/cache_tags_page';
$tags = ['system_test_cache_tags_page'];
$this->drupalGet($path);
$this->assertSession()->responseHeaderEquals('X-Drupal-Cache', 'MISS');
// Verify a cache hit, but also the presence of the correct cache tags.
$this->drupalGet($path);
$this->assertSession()->responseHeaderEquals('X-Drupal-Cache', 'HIT');
$cid_parts = [Url::fromRoute('system_test.cache_tags_page', [], ['absolute' => TRUE])->toString(), ''];
$cid = implode(':', $cid_parts);
$cache_entry = \Drupal::cache('page')->get($cid);
sort($cache_entry->tags);
$expected_tags = [
'config:user.role.anonymous',
'http_response',
'pre_render',
'rendered',
'system_test_cache_tags_page',
];
$this->assertSame($expected_tags, $cache_entry->tags);
Cache::invalidateTags($tags);
$this->drupalGet($path);
$this->assertSession()->responseHeaderEquals('X-Drupal-Cache', 'MISS');
}
/**
* Tests that the page cache doesn't depend on cacheability headers.
*/
public function testPageCacheTagsIndependentFromCacheabilityHeaders(): void {
// Disable the cacheability headers.
$this->setContainerParameter('http.response.debug_cacheability_headers', FALSE);
$this->rebuildContainer();
$this->resetAll();
$path = 'system-test/cache_tags_page';
$tags = ['system_test_cache_tags_page'];
$this->drupalGet($path);
$this->assertSession()->responseHeaderEquals('X-Drupal-Cache', 'MISS');
// Verify a cache hit, but also the presence of the correct cache tags.
$this->drupalGet($path);
$this->assertSession()->responseHeaderEquals('X-Drupal-Cache', 'HIT');
$cid_parts = [Url::fromRoute('system_test.cache_tags_page', [], ['absolute' => TRUE])->toString(), ''];
$cid = implode(':', $cid_parts);
$cache_entry = \Drupal::cache('page')->get($cid);
sort($cache_entry->tags);
$expected_tags = [
'config:user.role.anonymous',
'http_response',
'pre_render',
'rendered',
'system_test_cache_tags_page',
];
$this->assertSame($expected_tags, $cache_entry->tags);
Cache::invalidateTags($tags);
$this->drupalGet($path);
$this->assertSession()->responseHeaderEquals('X-Drupal-Cache', 'MISS');
}
/**
* Tests support for different cache items with different request formats.
*
* The request formats are specified via a query parameter.
*/
public function testQueryParameterFormatRequests(): void {
$this->enablePageCaching();
$accept_header_cache_url = Url::fromRoute('system_test.page_cache_accept_header');
$accept_header_cache_url_with_json = Url::fromRoute('system_test.page_cache_accept_header', ['_format' => 'json']);
$accept_header_cache_url_with_ajax = Url::fromRoute('system_test.page_cache_accept_header', ['_format' => 'json'], ['query' => ['_wrapper_format' => 'drupal_ajax']]);
$this->drupalGet($accept_header_cache_url);
// Verify that HTML page was not yet cached.
$this->assertSession()->responseHeaderEquals('X-Drupal-Cache', 'MISS');
$this->drupalGet($accept_header_cache_url);
// Verify that HTML page was cached.
$this->assertSession()->responseHeaderEquals('X-Drupal-Cache', 'HIT');
// Verify that the correct HTML response was returned.
$this->assertSession()->responseContains('<p>oh hai this is html.</p>');
$this->drupalGet($accept_header_cache_url_with_json);
// Verify that JSON response was not yet cached.
$this->assertSession()->responseHeaderEquals('X-Drupal-Cache', 'MISS');
$this->drupalGet($accept_header_cache_url_with_json);
// Verify that JSON response was cached.
$this->assertSession()->responseHeaderEquals('X-Drupal-Cache', 'HIT');
// Verify that the correct JSON response was returned.
$this->assertSession()->responseContains('{"content":"oh hai this is json"}');
$this->drupalGet($accept_header_cache_url_with_ajax);
// Verify that AJAX response was not yet cached.
$this->assertSession()->responseHeaderEquals('X-Drupal-Cache', 'MISS');
$this->drupalGet($accept_header_cache_url_with_ajax);
// Verify that AJAX response was cached.
$this->assertSession()->responseHeaderEquals('X-Drupal-Cache', 'HIT');
// Verify that the correct AJAX response was returned.
$this->assertSession()->responseContains('{"content":"oh hai this is ajax"}');
}
/**
* Tests support of requests with If-Modified-Since and If-None-Match headers.
*/
public function testConditionalRequests(): void {
$this->enablePageCaching();
// Fill the cache.
$this->drupalGet('');
// Verify the page is not printed twice when the cache is cold.
$this->assertSession()->responseNotMatches('#<html.*<html#');
$this->drupalGet('');
$this->assertSession()->responseHeaderEquals('X-Drupal-Cache', 'HIT');
$etag = $this->getSession()->getResponseHeader('ETag');
$last_modified = $this->getSession()->getResponseHeader('Last-Modified');
// Ensure a conditional request returns 304 Not Modified.
$this->drupalGet('', [], ['If-Modified-Since' => $last_modified, 'If-None-Match' => $etag]);
$this->assertSession()->statusCodeEquals(304);
// Ensure a conditional request with obsolete If-Modified-Since date
// returns 304 Not Modified.
$this->drupalGet('', [], [
'If-Modified-Since' => gmdate(DATE_RFC822, strtotime($last_modified)),
'If-None-Match' => $etag,
]);
$this->assertSession()->statusCodeEquals(304);
// Ensure a conditional request with obsolete If-Modified-Since date
// returns 304 Not Modified.
$this->drupalGet('', [], [
'If-Modified-Since' => gmdate(DATE_RFC850, strtotime($last_modified)),
'If-None-Match' => $etag,
]);
$this->assertSession()->statusCodeEquals(304);
// Ensure a conditional request without If-None-Match returns 200 OK.
$this->drupalGet('', [], ['If-Modified-Since' => $last_modified, 'If-None-Match' => '']);
// Verify the page is not printed twice when the cache is warm.
$this->assertSession()->responseNotMatches('#<html.*<html#');
$this->assertSession()->statusCodeEquals(200);
$this->assertSession()->responseHeaderEquals('X-Drupal-Cache', 'HIT');
// Ensure a conditional request with If-Modified-Since newer than
// Last-Modified returns 200 OK.
$this->drupalGet('', [], [
'If-Modified-Since' => gmdate(DateTimePlus::RFC7231, strtotime($last_modified) + 1),
'If-None-Match' => $etag,
]);
$this->assertSession()->statusCodeEquals(200);
$this->assertSession()->responseHeaderEquals('X-Drupal-Cache', 'HIT');
// Ensure a conditional request by an authenticated user returns 200 OK.
$user = $this->drupalCreateUser();
$this->drupalLogin($user);
$this->drupalGet('', [], ['If-Modified-Since' => $last_modified, 'If-None-Match' => $etag]);
$this->assertSession()->statusCodeEquals(200);
// Verify that absence of Page was not cached.
$this->assertSession()->responseHeaderDoesNotExist('X-Drupal-Cache');
}
/**
* Tests cache headers.
*/
public function testPageCache(): void {
$this->enablePageCaching();
// Fill the cache.
$this->drupalGet('system-test/set-header', ['query' => ['name' => 'Foo', 'value' => 'bar']]);
$this->assertSession()->responseHeaderEquals('X-Drupal-Cache', 'MISS');
$this->assertSession()->responseHeaderContains('Vary', 'cookie');
// Symfony's Response logic determines a specific order for the subvalues
// of the Cache-Control header, even if they are explicitly passed in to
// the response header bag in a different order.
$this->assertCacheMaxAge(300);
$this->assertSession()->responseHeaderEquals('Expires', 'Sun, 19 Nov 1978 05:00:00 GMT');
$this->assertSession()->responseHeaderEquals('Foo', 'bar');
// Check cache.
$this->drupalGet('system-test/set-header', ['query' => ['name' => 'Foo', 'value' => 'bar']]);
$this->assertSession()->responseHeaderEquals('X-Drupal-Cache', 'HIT');
$this->assertSession()->responseHeaderContains('Vary', 'cookie');
$this->assertCacheMaxAge(300);
$this->assertSession()->responseHeaderEquals('Expires', 'Sun, 19 Nov 1978 05:00:00 GMT');
$this->assertSession()->responseHeaderEquals('Foo', 'bar');
// Check replacing default headers.
$this->drupalGet('system-test/set-header', ['query' => ['name' => 'Expires', 'value' => 'Fri, 19 Nov 2008 05:00:00 GMT']]);
$this->assertSession()->responseHeaderEquals('Expires', 'Fri, 19 Nov 2008 05:00:00 GMT');
$this->drupalGet('system-test/set-header', ['query' => ['name' => 'Vary', 'value' => 'User-Agent']]);
$this->assertSession()->responseHeaderContains('Vary', 'user-agent');
// Check that authenticated users bypass the cache.
$user = $this->drupalCreateUser();
$this->drupalLogin($user);
$this->drupalGet('system-test/set-header', ['query' => ['name' => 'Foo', 'value' => 'bar']]);
$this->assertSession()->responseHeaderDoesNotExist('X-Drupal-Cache');
$this->assertSession()->responseHeaderNotContains('Vary', 'cookie');
$this->assertSession()->responseHeaderEquals('Cache-Control', 'must-revalidate, no-cache, private');
$this->assertSession()->responseHeaderEquals('Expires', 'Sun, 19 Nov 1978 05:00:00 GMT');
$this->assertSession()->responseHeaderEquals('Foo', 'bar');
// Until bubbling of max-age up to the response is supported, verify that
// a custom #cache max-age set on an element does not affect page max-age.
$this->drupalLogout();
$this->drupalGet('system-test/cache_max_age_page');
$this->assertCacheMaxAge(300);
}
/**
* Tests the automatic presence of the anonymous role's cache tag.
*
* The 'user.permissions' cache context ensures that if the permissions for a
* role are modified, users are not served stale render cache content. But,
* when entire responses are cached in reverse proxies, the value for the
* cache context is never calculated, causing the stale response to not be
* invalidated. Therefore, when varying by permissions and the current user is
* the anonymous user, the cache tag for the 'anonymous' role must be added.
*
* This test verifies that, and it verifies that it does not happen for other
* roles.
*/
public function testPageCacheAnonymousRolePermissions(): void {
$this->enablePageCaching();
$content_url = Url::fromRoute('system_test.permission_dependent_content');
$route_access_url = Url::fromRoute('system_test.permission_dependent_route_access');
// 1. anonymous user, without permission.
$this->drupalGet($content_url);
$this->assertSession()->pageTextContains('Permission to pet llamas: no!');
$this->assertCacheContext('user.permissions');
$this->assertSession()->responseHeaderContains('X-Drupal-Cache-Tags', 'config:user.role.anonymous');
$this->drupalGet($route_access_url);
$this->assertCacheContext('user.permissions');
$this->assertSession()->responseHeaderContains('X-Drupal-Cache-Tags', 'config:user.role.anonymous');
// 2. anonymous user, with permission.
user_role_grant_permissions(RoleInterface::ANONYMOUS_ID, ['pet llamas']);
$this->drupalGet($content_url);
$this->assertSession()->pageTextContains('Permission to pet llamas: yes!');
$this->assertCacheContext('user.permissions');
$this->assertSession()->responseHeaderContains('X-Drupal-Cache-Tags', 'config:user.role.anonymous');
$this->drupalGet($route_access_url);
$this->assertCacheContext('user.permissions');
$this->assertSession()->responseHeaderContains('X-Drupal-Cache-Tags', 'config:user.role.anonymous');
// 3. authenticated user, without permission.
$auth_user = $this->drupalCreateUser();
$this->drupalLogin($auth_user);
$this->drupalGet($content_url);
$this->assertSession()->pageTextContains('Permission to pet llamas: no!');
$this->assertCacheContext('user.permissions');
$this->assertSession()->responseHeaderNotContains('X-Drupal-Cache-Tags', 'config:user.role.authenticated');
$this->drupalGet($route_access_url);
$this->assertCacheContext('user.permissions');
$this->assertSession()->responseHeaderNotContains('X-Drupal-Cache-Tags', 'config:user.role.authenticated');
// 4. authenticated user, with permission.
user_role_grant_permissions(RoleInterface::AUTHENTICATED_ID, ['pet llamas']);
$this->drupalGet($content_url);
$this->assertSession()->pageTextContains('Permission to pet llamas: yes!');
$this->assertCacheContext('user.permissions');
$this->assertSession()->responseHeaderNotContains('X-Drupal-Cache-Tags', 'config:user.role.authenticated');
$this->drupalGet($route_access_url);
$this->assertCacheContext('user.permissions');
$this->assertSession()->responseHeaderNotContains('X-Drupal-Cache-Tags', 'config:user.role.authenticated');
}
/**
* Tests the 4xx-response cache tag is added and invalidated.
*/
public function testPageCacheAnonymous403404(): void {
$admin_url = Url::fromRoute('system.admin');
$invalid_url = 'foo/does_not_exist';
$tests = [
403 => $admin_url,
404 => $invalid_url,
];
$cache_ttl_4xx = Settings::get('cache_ttl_4xx', 3600);
foreach ($tests as $code => $content_url) {
// Anonymous user, without permissions.
$this->drupalGet($content_url);
$this->assertSession()->statusCodeEquals($code);
$this->assertSession()->responseHeaderEquals('X-Drupal-Cache', 'MISS');
$this->assertSession()->responseHeaderContains('X-Drupal-Cache-Tags', '4xx-response');
$this->drupalGet($content_url);
$this->assertSession()->statusCodeEquals($code);
$this->assertSession()->responseHeaderEquals('X-Drupal-Cache', 'HIT');
$entity_values = [
'name' => $this->randomMachineName(),
'user_id' => 1,
'field_test_text' => [
0 => [
'value' => $this->randomString(),
'format' => 'plain_text',
],
],
];
$entity = EntityTest::create($entity_values);
$entity->save();
// Saving an entity clears 4xx cache tag.
$this->drupalGet($content_url);
$this->assertSession()->statusCodeEquals($code);
$this->assertSession()->responseHeaderEquals('X-Drupal-Cache', 'MISS');
$this->drupalGet($content_url);
$this->assertSession()->statusCodeEquals($code);
$this->assertSession()->responseHeaderEquals('X-Drupal-Cache', 'HIT');
// Rebuilding the router should invalidate the 4xx cache tag.
$this->container->get('router.builder')->rebuild();
$this->drupalGet($content_url);
$this->assertSession()->statusCodeEquals($code);
$this->assertSession()->responseHeaderEquals('X-Drupal-Cache', 'MISS');
// Ensure the 'expire' field on the cache entry uses cache_ttl_4xx.
$cache_item = \Drupal::service('cache.page')->get($this->getUrl() . ':');
$difference = $cache_item->expire - (int) $cache_item->created;
// Given that a second might have passed we cannot be sure that
// $difference will exactly equal the default cache_ttl_4xx setting.
// Account for any timing difference or rounding errors by ensuring the
// value is within 10 seconds.
$this->assertTrue(
$difference > $cache_ttl_4xx - 10 &&
$difference < $cache_ttl_4xx + 10,
"The cache entry expiry time uses the cache_ttl_4xx setting. Expire: {$cache_item->expire} Created: {$cache_item->created}"
);
}
// Disable 403 and 404 caching.
$settings['settings']['cache_ttl_4xx'] = (object) [
'value' => 0,
'required' => TRUE,
];
$this->writeSettings($settings);
\Drupal::service('cache.page')->deleteAll();
foreach ($tests as $code => $content_url) {
// Getting the 404 page twice should still result in a cache miss.
$this->drupalGet($content_url);
$this->drupalGet($content_url);
$this->assertSession()->statusCodeEquals($code);
$this->assertSession()->responseHeaderEquals('X-Drupal-Cache', 'MISS');
}
}
/**
* Tests the omit_vary_cookie setting.
*/
public function testPageCacheWithoutVaryCookie(): void {
$this->enablePageCaching();
$settings['settings']['omit_vary_cookie'] = (object) [
'value' => TRUE,
'required' => TRUE,
];
$this->writeSettings($settings);
// Fill the cache.
$this->drupalGet('');
$this->assertSession()->responseHeaderEquals('X-Drupal-Cache', 'MISS');
$this->assertSession()->responseHeaderNotContains('Vary', 'cookie');
$this->assertCacheMaxAge(300);
// Check cache.
$this->drupalGet('');
$this->assertSession()->responseHeaderEquals('X-Drupal-Cache', 'HIT');
$this->assertSession()->responseHeaderNotContains('Vary', 'cookie');
$this->assertCacheMaxAge(300);
}
/**
* Tests the setting of forms to be immutable.
*/
public function testFormImmutability(): void {
// Install the module that provides the test form.
$this->container->get('module_installer')
->install(['page_cache_form_test']);
// Uninstall the page_cache module to verify that form is immutable
// regardless of the internal page cache module.
$this->container->get('module_installer')->uninstall(['page_cache']);
$this->drupalGet('page_cache_form_test_immutability');
$this->assertSession()->pageTextContains("Immutable: TRUE");
// The immutable flag is set unconditionally by system_form_alter(), set
// a flag to tell page_cache_form_test_module_implements_alter() to disable
// that implementation.
\Drupal::state()->set('page_cache_bypass_form_immutability', TRUE);
\Drupal::moduleHandler()->resetImplementations();
Cache::invalidateTags(['rendered']);
$this->drupalGet('page_cache_form_test_immutability');
$this->assertSession()->pageTextContains("Immutable: FALSE");
}
/**
* Tests cacheability of a CacheableResponse.
*
* Tests the difference between having a controller return a plain Symfony
* Response object versus returning a Response object that implements the
* CacheableResponseInterface.
*/
public function testCacheableResponseResponses(): void {
$this->enablePageCaching();
// GET a URL, which would be marked as a cache miss if it were cacheable.
$this->drupalGet('/system-test/respond-response');
$this->assertSession()->responseHeaderDoesNotExist('X-Drupal-Cache');
$this->assertSession()->responseHeaderEquals('Cache-Control', 'must-revalidate, no-cache, private');
// GET it again, verify it's still not cached.
$this->drupalGet('/system-test/respond-response');
$this->assertSession()->responseHeaderDoesNotExist('X-Drupal-Cache');
$this->assertSession()->responseHeaderEquals('Cache-Control', 'must-revalidate, no-cache, private');
// GET a URL, which would be marked as a cache miss if it were cacheable.
$this->drupalGet('/system-test/respond-public-response');
$this->assertSession()->responseHeaderDoesNotExist('X-Drupal-Cache');
$this->assertSession()->responseHeaderEquals('Cache-Control', 'max-age=60, public');
// GET it again, verify it's still not cached.
$this->drupalGet('/system-test/respond-public-response');
$this->assertSession()->responseHeaderDoesNotExist('X-Drupal-Cache');
$this->assertSession()->responseHeaderEquals('Cache-Control', 'max-age=60, public');
// GET a URL, which should be marked as a cache miss.
$this->drupalGet('/system-test/respond-cacheable-response');
$this->assertSession()->responseHeaderEquals('X-Drupal-Cache', 'MISS');
$this->assertCacheMaxAge(300);
// GET it again, it should now be a cache hit.
$this->drupalGet('/system-test/respond-cacheable-response');
$this->assertSession()->responseHeaderEquals('X-Drupal-Cache', 'HIT');
$this->assertCacheMaxAge(300);
// Uninstall page cache. This should flush all caches so the next call to a
// previously cached page should be a miss now.
$this->container->get('module_installer')
->uninstall(['page_cache']);
// GET a URL that was cached by Page Cache before, it should not be now.
$this->drupalGet('/respond-cacheable-response');
$this->assertSession()->responseHeaderDoesNotExist('X-Drupal-Cache');
}
/**
* Tests that HEAD requests are treated the same as GET requests.
*/
public function testHead(): void {
/** @var \GuzzleHttp\ClientInterface $client */
$client = $this->getSession()->getDriver()->getClient()->getClient();
// GET, then HEAD.
$url_a = $this->buildUrl('system-test/set-header', ['query' => ['name' => 'Foo', 'value' => 'bar']]);
$response_body = $this->drupalGet($url_a);
$this->assertSession()->responseHeaderEquals('X-Drupal-Cache', 'MISS');
$this->assertSession()->responseHeaderEquals('Foo', 'bar');
$this->assertEquals('The following header was set: <em class="placeholder">Foo</em>: <em class="placeholder">bar</em>', $response_body);
$response = $client->request('HEAD', $url_a);
$this->assertEquals('HIT', $response->getHeaderLine('X-Drupal-Cache'), 'Page was cached.');
$this->assertEquals('bar', $response->getHeaderLine('Foo'), 'Custom header was sent.');
$this->assertEquals('', $response->getBody()->getContents());
// HEAD, then GET.
$url_b = $this->buildUrl('system-test/set-header', ['query' => ['name' => 'Foo', 'value' => 'baz']]);
$response = $client->request('HEAD', $url_b);
$this->assertEquals('MISS', $response->getHeaderLine('X-Drupal-Cache'), 'Page was not cached.');
$this->assertEquals('baz', $response->getHeaderLine('Foo'), 'Custom header was sent.');
$this->assertEquals('', $response->getBody()->getContents());
$response_body = $this->drupalGet($url_b);
$this->assertSession()->responseHeaderEquals('X-Drupal-Cache', 'HIT');
$this->assertSession()->responseHeaderEquals('Foo', 'baz');
$this->assertEquals('The following header was set: <em class="placeholder">Foo</em>: <em class="placeholder">baz</em>', $response_body);
}
/**
* Tests a cacheable response with custom cache control.
*/
public function testCacheableWithCustomCacheControl(): void {
$this->enablePageCaching();
$this->drupalGet('/system-test/custom-cache-control');
$this->assertSession()->statusCodeEquals(200);
$this->assertSession()->responseHeaderEquals('Cache-Control', 'bar, private');
}
/**
* Tests that the Cache-Control header is added by FinishResponseSubscriber.
*/
public function testCacheabilityOfRedirectResponses(): void {
$this->enablePageCaching();
$this->getSession()->getDriver()->getClient()->followRedirects(FALSE);
$this->maximumMetaRefreshCount = 0;
foreach ([301, 302, 303, 307, 308] as $status_code) {
foreach (['local', 'cacheable', 'trusted'] as $type) {
$this->drupalGet("/system-test/redirect/{$type}/{$status_code}");
$this->assertSession()->statusCodeEquals($status_code);
$this->assertCacheMaxAge(300);
}
}
}
/**
* Tests that URLs are cached in a not normalized form.
*/
public function testNoUrlNormalization(): void {
// Use absolute URLs to avoid any processing.
$url = Url::fromRoute('<front>')->setAbsolute()->toString();
// In each test, the first array value is raw URL, the second one is the
// possible normalized URL.
$tests = [
[
$url . '?z=z&a=a',
$url . '?a=a&z=z',
],
[
$url . '?a=b+c',
$url . '?a=b%20c',
],
];
foreach ($tests as [$url_raw, $url_normalized]) {
// Initialize cache on raw URL.
$headers = $this->getHeaders($url_raw);
$this->assertEquals('MISS', $headers['X-Drupal-Cache']);
// Ensure cache was set.
$headers = $this->getHeaders($url_raw);
$this->assertEquals('HIT', $headers['X-Drupal-Cache'], "Cache was set for {$url_raw} URL.");
// Check if the normalized URL is not cached.
$headers = $this->getHeaders($url_normalized);
$this->assertEquals('MISS', $headers['X-Drupal-Cache'], "Cache is missing for {$url_normalized} URL.");
}
}
/**
* Retrieves only the headers for an absolute path.
*
* Executes a cURL request without any modifications to the given URL.
* Note that Guzzle always normalizes URLs which prevents testing all
* possible edge cases.
*
* @param string $url
* URL to request.
*
* @return array
* Array of headers.
*/
protected function getHeaders($url) {
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_HEADER, TRUE);
curl_setopt($ch, CURLOPT_NOBODY, TRUE);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt($ch, CURLOPT_USERAGENT, drupal_generate_test_ua($this->databasePrefix));
$output = curl_exec($ch);
curl_close($ch);
$headers = [];
foreach (explode("\n", $output) as $header) {
if (strpos($header, ':')) {
[$key, $value] = explode(':', $header, 2);
$headers[trim($key)] = trim($value);
}
}
return $headers;
}
}