Chris@0: <?php
Chris@0: 
Chris@0: namespace Drupal\system\Tests\Common;
Chris@0: 
Chris@0: use Drupal\Core\Url;
Chris@0: use Drupal\simpletest\WebTestBase;
Chris@0: 
Chris@0: /**
Chris@0:  * Verifies that bubbleable metadata of early rendering is not lost.
Chris@0:  *
Chris@0:  * @group Common
Chris@0:  */
Chris@0: class EarlyRenderingControllerTest extends WebTestBase {
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   protected $dumpHeaders = TRUE;
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public static $modules = ['system', 'early_rendering_controller_test'];
Chris@0: 
Chris@0:   /**
Chris@0:    * Tests theme preprocess functions being able to attach assets.
Chris@0:    */
Chris@0:   public function testEarlyRendering() {
Chris@0:     // Render array: non-early & early.
Chris@0:     $this->drupalGet(Url::fromRoute('early_rendering_controller_test.render_array'));
Chris@0:     $this->assertResponse(200);
Chris@0:     $this->assertRaw('Hello world!');
Chris@0:     $this->assertCacheTag('foo');
Chris@0:     $this->drupalGet(Url::fromRoute('early_rendering_controller_test.render_array.early'));
Chris@0:     $this->assertResponse(200);
Chris@0:     $this->assertRaw('Hello world!');
Chris@0:     $this->assertCacheTag('foo');
Chris@0: 
Chris@0:     // AjaxResponse: non-early & early.
Chris@0:     // @todo Add cache tags assertion when AjaxResponse is made cacheable in
Chris@0:     //   https://www.drupal.org/node/956186.
Chris@0:     $this->drupalGet(Url::fromRoute('early_rendering_controller_test.ajax_response'));
Chris@0:     $this->assertResponse(200);
Chris@0:     $this->assertRaw('Hello world!');
Chris@0:     $this->drupalGet(Url::fromRoute('early_rendering_controller_test.ajax_response.early'));
Chris@0:     $this->assertResponse(200);
Chris@0:     $this->assertRaw('Hello world!');
Chris@0: 
Chris@0:     // Basic Response object: non-early & early.
Chris@0:     $this->drupalGet(Url::fromRoute('early_rendering_controller_test.response'));
Chris@0:     $this->assertResponse(200);
Chris@0:     $this->assertRaw('Hello world!');
Chris@0:     $this->assertNoCacheTag('foo');
Chris@0:     $this->drupalGet(Url::fromRoute('early_rendering_controller_test.response.early'));
Chris@0:     $this->assertResponse(200);
Chris@0:     $this->assertRaw('Hello world!');
Chris@0:     $this->assertNoCacheTag('foo');
Chris@0: 
Chris@0:     // Response object with attachments: non-early & early.
Chris@0:     $this->drupalGet(Url::fromRoute('early_rendering_controller_test.response-with-attachments'));
Chris@0:     $this->assertResponse(200);
Chris@0:     $this->assertRaw('Hello world!');
Chris@0:     $this->assertNoCacheTag('foo');
Chris@0:     $this->drupalGet(Url::fromRoute('early_rendering_controller_test.response-with-attachments.early'));
Chris@0:     $this->assertResponse(500);
Chris@0:     $this->assertRaw('The controller result claims to be providing relevant cache metadata, but leaked metadata was detected. Please ensure you are not rendering content too early. Returned object class: Drupal\early_rendering_controller_test\AttachmentsTestResponse.');
Chris@0: 
Chris@0:     // Cacheable Response object: non-early & early.
Chris@0:     $this->drupalGet(Url::fromRoute('early_rendering_controller_test.cacheable-response'));
Chris@0:     $this->assertResponse(200);
Chris@0:     $this->assertRaw('Hello world!');
Chris@0:     $this->assertNoCacheTag('foo');
Chris@0:     $this->drupalGet(Url::fromRoute('early_rendering_controller_test.cacheable-response.early'));
Chris@0:     $this->assertResponse(500);
Chris@0:     $this->assertRaw('The controller result claims to be providing relevant cache metadata, but leaked metadata was detected. Please ensure you are not rendering content too early. Returned object class: Drupal\early_rendering_controller_test\CacheableTestResponse.');
Chris@0: 
Chris@0:     // Basic domain object: non-early & early.
Chris@0:     $this->drupalGet(Url::fromRoute('early_rendering_controller_test.domain-object'));
Chris@0:     $this->assertResponse(200);
Chris@0:     $this->assertRaw('TestDomainObject');
Chris@0:     $this->assertNoCacheTag('foo');
Chris@0:     $this->drupalGet(Url::fromRoute('early_rendering_controller_test.domain-object.early'));
Chris@0:     $this->assertResponse(200);
Chris@0:     $this->assertRaw('TestDomainObject');
Chris@0:     $this->assertNoCacheTag('foo');
Chris@0: 
Chris@0:     // Basic domain object with attachments: non-early & early.
Chris@0:     $this->drupalGet(Url::fromRoute('early_rendering_controller_test.domain-object-with-attachments'));
Chris@0:     $this->assertResponse(200);
Chris@0:     $this->assertRaw('AttachmentsTestDomainObject');
Chris@0:     $this->assertNoCacheTag('foo');
Chris@0:     $this->drupalGet(Url::fromRoute('early_rendering_controller_test.domain-object-with-attachments.early'));
Chris@0:     $this->assertResponse(500);
Chris@0:     $this->assertRaw('The controller result claims to be providing relevant cache metadata, but leaked metadata was detected. Please ensure you are not rendering content too early. Returned object class: Drupal\early_rendering_controller_test\AttachmentsTestDomainObject.');
Chris@0: 
Chris@0:     // Cacheable Response object: non-early & early.
Chris@0:     $this->drupalGet(Url::fromRoute('early_rendering_controller_test.cacheable-domain-object'));
Chris@0:     $this->assertResponse(200);
Chris@0:     $this->assertRaw('CacheableTestDomainObject');
Chris@0:     $this->assertNoCacheTag('foo');
Chris@0:     $this->drupalGet(Url::fromRoute('early_rendering_controller_test.cacheable-domain-object.early'));
Chris@0:     $this->assertResponse(500);
Chris@0:     $this->assertRaw('The controller result claims to be providing relevant cache metadata, but leaked metadata was detected. Please ensure you are not rendering content too early. Returned object class: Drupal\early_rendering_controller_test\CacheableTestDomainObject.');
Chris@0: 
Chris@0:     // The exceptions are expected. Do not interpret them as a test failure.
Chris@0:     // Not using File API; a potential error must trigger a PHP warning.
Chris@0:     unlink(\Drupal::root() . '/' . $this->siteDirectory . '/error.log');
Chris@0:   }
Chris@0: 
Chris@0: }