public function DynamicPageCacheIntegrationTest::testDynamicPageCache in Zircon Profile 8
Same name and namespace in other branches
- 8.0 core/modules/dynamic_page_cache/src/Tests/DynamicPageCacheIntegrationTest.php \Drupal\dynamic_page_cache\Tests\DynamicPageCacheIntegrationTest::testDynamicPageCache()
Tests that Dynamic Page Cache works correctly, and verifies the edge cases.
File
- core/
modules/ dynamic_page_cache/ src/ Tests/ DynamicPageCacheIntegrationTest.php, line 54 - Contains \Drupal\dynamic_page_cache\Tests\DynamicPageCacheIntegrationTest.
Class
- DynamicPageCacheIntegrationTest
- Enables the Dynamic Page Cache and tests it in various scenarios.
Namespace
Drupal\dynamic_page_cache\TestsCode
public function testDynamicPageCache() {
// Controllers returning plain response objects are ignored by Dynamic Page
// Cache.
$url = Url::fromUri('route:dynamic_page_cache_test.response');
$this
->drupalGet($url);
$this
->assertFalse($this
->drupalGetHeader(DynamicPageCacheSubscriber::HEADER), 'Response object returned: Dynamic Page Cache is ignoring.');
// Controllers returning CacheableResponseInterface (cacheable response)
// objects are handled by Dynamic Page Cache.
$url = Url::fromUri('route:dynamic_page_cache_test.cacheable_response');
$this
->drupalGet($url);
$this
->assertEqual('MISS', $this
->drupalGetHeader(DynamicPageCacheSubscriber::HEADER), 'Cacheable response object returned: Dynamic Page Cache is active, Dynamic Page Cache MISS.');
$this
->drupalGet($url);
$this
->assertEqual('HIT', $this
->drupalGetHeader(DynamicPageCacheSubscriber::HEADER), 'Cacheable response object returned: Dynamic Page Cache is active, Dynamic Page Cache HIT.');
// Controllers returning render arrays, rendered as HTML responses, are
// handled by Dynamic Page Cache.
$url = Url::fromUri('route:dynamic_page_cache_test.html');
$this
->drupalGet($url);
$this
->assertEqual('MISS', $this
->drupalGetHeader(DynamicPageCacheSubscriber::HEADER), 'Render array returned, rendered as HTML response: Dynamic Page Cache is active, Dynamic Page Cache MISS.');
$this
->drupalGet($url);
$this
->assertEqual('HIT', $this
->drupalGetHeader(DynamicPageCacheSubscriber::HEADER), 'Render array returned, rendered as HTML response: Dynamic Page Cache is active, Dynamic Page Cache HIT.');
// The above is the simple case, where the render array returned by the
// response contains no cache contexts. So let's now test a route/controller
// that *does* vary by a cache context whose value we can easily control: it
// varies by the 'animal' query argument.
foreach ([
'llama',
'piggy',
'unicorn',
'kitten',
] as $animal) {
$url = Url::fromUri('route:dynamic_page_cache_test.html.with_cache_contexts', [
'query' => [
'animal' => $animal,
],
]);
$this
->drupalGet($url);
$this
->assertRaw($animal);
$this
->assertEqual('MISS', $this
->drupalGetHeader(DynamicPageCacheSubscriber::HEADER), 'Render array returned, rendered as HTML response: Dynamic Page Cache is active, Dynamic Page Cache MISS.');
$this
->drupalGet($url);
$this
->assertRaw($animal);
$this
->assertEqual('HIT', $this
->drupalGetHeader(DynamicPageCacheSubscriber::HEADER), 'Render array returned, rendered as HTML response: Dynamic Page Cache is active, Dynamic Page Cache HIT.');
// Finally, let's also verify that the 'dynamic_page_cache_test.html'
// route continued to see cache hits if we specify a query argument,
// because it *should* ignore it and continue to provide Dynamic Page
// Cache hits.
$url = Url::fromUri('route:dynamic_page_cache_test.html', [
'query' => [
'animal' => 'piglet',
],
]);
$this
->drupalGet($url);
$this
->assertEqual('HIT', $this
->drupalGetHeader(DynamicPageCacheSubscriber::HEADER), 'Render array returned, rendered as HTML response: Dynamic Page Cache is active, Dynamic Page Cache HIT.');
}
// Controllers returning render arrays, rendered as anything except a HTML
// response, are ignored by Dynamic Page Cache (but only because those
// wrapper formats' responses do not implement CacheableResponseInterface).
$this
->drupalGet('dynamic-page-cache-test/html', array(
'query' => array(
MainContentViewSubscriber::WRAPPER_FORMAT => 'drupal_ajax',
),
));
$this
->assertFalse($this
->drupalGetHeader(DynamicPageCacheSubscriber::HEADER), 'Render array returned, rendered as AJAX response: Dynamic Page Cache is ignoring.');
$this
->drupalGet('dynamic-page-cache-test/html', array(
'query' => array(
MainContentViewSubscriber::WRAPPER_FORMAT => 'drupal_dialog',
),
));
$this
->assertFalse($this
->drupalGetHeader(DynamicPageCacheSubscriber::HEADER), 'Render array returned, rendered as dialog response: Dynamic Page Cache is ignoring.');
$this
->drupalGet('dynamic-page-cache-test/html', array(
'query' => array(
MainContentViewSubscriber::WRAPPER_FORMAT => 'drupal_modal',
),
));
$this
->assertFalse($this
->drupalGetHeader(DynamicPageCacheSubscriber::HEADER), 'Render array returned, rendered as modal response: Dynamic Page Cache is ignoring.');
// Admin routes are ignored by Dynamic Page Cache.
$this
->drupalGet('dynamic-page-cache-test/html/admin');
$this
->assertFalse($this
->drupalGetHeader(DynamicPageCacheSubscriber::HEADER), 'Response returned, rendered as HTML response, admin route: Dynamic Page Cache is ignoring');
$this
->drupalGet('dynamic-page-cache-test/response/admin');
$this
->assertFalse($this
->drupalGetHeader(DynamicPageCacheSubscriber::HEADER), 'Response returned, plain response, admin route: Dynamic Page Cache is ignoring');
$this
->drupalGet('dynamic-page-cache-test/cacheable-response/admin');
$this
->assertFalse($this
->drupalGetHeader(DynamicPageCacheSubscriber::HEADER), 'Response returned, cacheable response, admin route: Dynamic Page Cache is ignoring');
// Max-age = 0 responses are ignored by Dynamic Page Cache.
$this
->drupalGet('dynamic-page-cache-test/html/uncacheable/max-age');
$this
->assertEqual('UNCACHEABLE', $this
->drupalGetHeader(DynamicPageCacheSubscriber::HEADER), 'Render array returned, rendered as HTML response, but uncacheable: Dynamic Page Cache is running, but not caching.');
// 'user' cache context responses are ignored by Dynamic Page Cache.
$this
->drupalGet('dynamic-page-cache-test/html/uncacheable/contexts');
$this
->assertEqual('UNCACHEABLE', $this
->drupalGetHeader(DynamicPageCacheSubscriber::HEADER), 'Render array returned, rendered as HTML response, but uncacheable: Dynamic Page Cache is running, but not caching.');
// 'current-temperature' cache tag responses are ignored by Dynamic Page
// Cache.
$this
->drupalGet('dynamic-page-cache-test/html/uncacheable/tags');
$this
->assertEqual('MISS', $this
->drupalGetHeader(DynamicPageCacheSubscriber::HEADER), 'By default, Drupal has no auto-placeholdering cache tags.');
}