class DynamicPageCacheIntegrationTest in Drupal 10

Enables the Dynamic Page Cache and tests it in various scenarios.

This does not test the self-healing of the redirect with conditional cache contexts, because Dynamic Page Cache just reuses \Drupal\Core\Render\RenderCache so that it doesn't have to implement and test all of that again. It is tested in RendererBubblingTest::testConditionalCacheContextBubblingSelfHealing().

@group dynamic_page_cache

Hierarchy

• class \Drupal\Tests\BrowserTestBase extends \PHPUnit\Framework\TestCase uses \Drupal\Tests\PhpUnitCompatibilityTrait, \Symfony\Bridge\PhpUnit\ExpectDeprecationTrait, FunctionalTestSetupTrait, TestSetupTrait, BlockCreationTrait, ConfigTestTrait, ExtensionListTestTrait, ContentTypeCreationTrait, NodeCreationTrait, RandomGeneratorTrait, TestRequirementsTrait, PhpUnitWarnings, UiHelperTrait, UserCreationTrait, XdebugRequestTrait
  • class \Drupal\Tests\dynamic_page_cache\Functional\DynamicPageCacheIntegrationTest

See also

\Drupal\dynamic_page_cache\EventSubscriber\DynamicPageCacheSubscriber

File

core/modules/dynamic_page_cache/tests/src/Functional/DynamicPageCacheIntegrationTest.php, line 23

Namespace

Drupal\Tests\dynamic_page_cache\Functional

class DynamicPageCacheIntegrationTest extends BrowserTestBase {

  /**
   * {@inheritdoc}
   */
  protected static $modules = [
    'dynamic_page_cache_test',
  ];

  /**
   * {@inheritdoc}
   */
  protected $defaultTheme = 'stark';

  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    parent::setUp();

    // Uninstall the page_cache module; we want to test the Dynamic Page Cache
    // alone.
    \Drupal::service('module_installer')
      ->uninstall([
      'page_cache',
    ]);
  }

  /**
   * Tests that Dynamic Page Cache works correctly, and verifies the edge cases.
   */
  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
      ->assertSession()
      ->responseHeaderDoesNotExist(DynamicPageCacheSubscriber::HEADER);

    // 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
      ->assertSession()
      ->responseHeaderEquals(DynamicPageCacheSubscriber::HEADER, 'MISS');
    $this
      ->drupalGet($url);
    $this
      ->assertSession()
      ->responseHeaderEquals(DynamicPageCacheSubscriber::HEADER, '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
      ->assertSession()
      ->responseHeaderEquals(DynamicPageCacheSubscriber::HEADER, 'MISS');
    $this
      ->drupalGet($url);
    $this
      ->assertSession()
      ->responseHeaderEquals(DynamicPageCacheSubscriber::HEADER, '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
        ->assertSession()
        ->pageTextContains($animal);
      $this
        ->assertSession()
        ->responseHeaderEquals(DynamicPageCacheSubscriber::HEADER, 'MISS');
      $this
        ->drupalGet($url);
      $this
        ->assertSession()
        ->pageTextContains($animal);
      $this
        ->assertSession()
        ->responseHeaderEquals(DynamicPageCacheSubscriber::HEADER, '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
        ->assertSession()
        ->responseHeaderEquals(DynamicPageCacheSubscriber::HEADER, 'HIT');
    }

    // Controllers returning render arrays, rendered as anything except an 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', [
      'query' => [
        MainContentViewSubscriber::WRAPPER_FORMAT => 'drupal_ajax',
      ],
    ]);
    $this
      ->assertSession()
      ->responseHeaderDoesNotExist(DynamicPageCacheSubscriber::HEADER);
    $this
      ->drupalGet('dynamic-page-cache-test/html', [
      'query' => [
        MainContentViewSubscriber::WRAPPER_FORMAT => 'drupal_dialog',
      ],
    ]);
    $this
      ->assertSession()
      ->responseHeaderDoesNotExist(DynamicPageCacheSubscriber::HEADER);
    $this
      ->drupalGet('dynamic-page-cache-test/html', [
      'query' => [
        MainContentViewSubscriber::WRAPPER_FORMAT => 'drupal_modal',
      ],
    ]);
    $this
      ->assertSession()
      ->responseHeaderDoesNotExist(DynamicPageCacheSubscriber::HEADER);

    // Admin routes are ignored by Dynamic Page Cache.
    $this
      ->drupalGet('dynamic-page-cache-test/html/admin');
    $this
      ->assertSession()
      ->responseHeaderDoesNotExist(DynamicPageCacheSubscriber::HEADER);
    $this
      ->drupalGet('dynamic-page-cache-test/response/admin');
    $this
      ->assertSession()
      ->responseHeaderDoesNotExist(DynamicPageCacheSubscriber::HEADER);
    $this
      ->drupalGet('dynamic-page-cache-test/cacheable-response/admin');
    $this
      ->assertSession()
      ->responseHeaderDoesNotExist(DynamicPageCacheSubscriber::HEADER);

    // Max-age = 0 responses are ignored by Dynamic Page Cache.
    $this
      ->drupalGet('dynamic-page-cache-test/html/uncacheable/max-age');
    $this
      ->assertSession()
      ->responseHeaderEquals(DynamicPageCacheSubscriber::HEADER, 'UNCACHEABLE');

    // 'user' cache context responses are ignored by Dynamic Page Cache.
    $this
      ->drupalGet('dynamic-page-cache-test/html/uncacheable/contexts');
    $this
      ->assertSession()
      ->responseHeaderEquals(DynamicPageCacheSubscriber::HEADER, 'UNCACHEABLE');

    // 'current-temperature' cache tag responses are ignored by Dynamic Page
    // Cache.
    $this
      ->drupalGet('dynamic-page-cache-test/html/uncacheable/tags');
    $this
      ->assertSession()
      ->responseHeaderEquals(DynamicPageCacheSubscriber::HEADER, 'MISS');
  }

}