View source
<?php
namespace Drupal\Tests\big_pipe\Functional;
use Behat\Mink\Element\NodeElement;
use Drupal\big_pipe\Render\Placeholder\BigPipeStrategy;
use Drupal\big_pipe\Render\BigPipe;
use Drupal\big_pipe_test\BigPipePlaceholderTestCases;
use Drupal\Component\Serialization\Json;
use Drupal\Component\Utility\Html;
use Drupal\Component\Utility\UrlHelper;
use Drupal\Core\Database\Database;
use Drupal\Core\Logger\RfcLogLevel;
use Drupal\Core\Url;
use Drupal\Tests\BrowserTestBase;
class BigPipeTest extends BrowserTestBase {
protected static $modules = [
'big_pipe',
'big_pipe_test',
'dblog',
];
protected $defaultTheme = 'stark';
protected function setUp() : void {
parent::setUp();
$this->maximumMetaRefreshCount = 0;
}
protected function performMetaRefresh() {
$this->maximumMetaRefreshCount = 1;
$this
->checkForMetaRefresh();
$this->maximumMetaRefreshCount = 0;
$this->metaRefreshCount = 0;
}
public function testNoJsDetection() {
$no_js_to_js_markup = '<script>document.cookie = "' . BigPipeStrategy::NOJS_COOKIE . '=1; path=/; expires=Thu, 01 Jan 1970 00:00:00 GMT"</script>';
$this
->drupalGet(Url::fromRoute('<front>'));
$this
->assertSessionCookieExists(FALSE);
$this
->assertBigPipeNoJsCookieExists(FALSE);
$this
->assertSession()
->responseNotContains('<noscript><meta http-equiv="Refresh" content="0; URL=');
$this
->assertSession()
->responseNotContains($no_js_to_js_markup);
$this
->drupalLogin($this->rootUser);
$this
->assertSessionCookieExists(TRUE);
$this
->assertBigPipeNoJsCookieExists(FALSE);
$this
->assertSession()
->responseContains('<noscript><meta http-equiv="Refresh" content="0; URL=' . base_path() . 'big_pipe/no-js?destination=' . UrlHelper::encodePath(base_path() . 'user/1?check_logged_in=1') . '" />' . "\n" . '</noscript>');
$this
->assertSession()
->responseNotContains($no_js_to_js_markup);
$this
->assertBigPipeNoJsMetaRefreshRedirect();
$this
->assertBigPipeNoJsCookieExists(TRUE);
$this
->assertSession()
->responseNotContains('<noscript><meta http-equiv="Refresh" content="0; URL=');
$this
->assertSession()
->responseContains($no_js_to_js_markup);
$this
->drupalLogout();
$this
->getSession()
->reset();
$this
->drupalGet(Url::fromRoute('user.login', [], [
'query' => [
'trigger_session' => 1,
],
]));
$this
->drupalGet(Url::fromRoute('user.login'));
$this
->assertSessionCookieExists(TRUE);
$this
->assertBigPipeNoJsCookieExists(FALSE);
$this
->assertSession()
->responseContains('<noscript><meta http-equiv="Refresh" content="0; URL=' . base_path() . 'big_pipe/no-js?destination=' . base_path() . 'user/login" />' . "\n" . '</noscript>');
$this
->assertSession()
->responseNotContains($no_js_to_js_markup);
$this
->assertBigPipeNoJsMetaRefreshRedirect();
$this
->assertBigPipeNoJsCookieExists(TRUE);
$this
->assertSession()
->responseNotContains('<noscript><meta http-equiv="Refresh" content="0; URL=');
$this
->assertSession()
->responseContains($no_js_to_js_markup);
$this
->getSession()
->reset();
$this
->drupalGet(Url::fromRoute('no_big_pipe'));
$this
->assertSessionCookieExists(FALSE);
$this
->assertBigPipeNoJsCookieExists(FALSE);
$this
->assertSession()
->responseNotContains('<noscript><meta http-equiv="Refresh" content="0; URL=');
$this
->assertSession()
->responseNotContains($no_js_to_js_markup);
$this
->drupalLogin($this->rootUser);
$this
->drupalGet(Url::fromRoute('no_big_pipe'));
$this
->assertSessionCookieExists(TRUE);
$this
->assertBigPipeNoJsCookieExists(FALSE);
$this
->assertSession()
->responseNotContains('<noscript><meta http-equiv="Refresh" content="0; URL=');
$this
->assertSession()
->responseNotContains($no_js_to_js_markup);
}
public function testBigPipe() {
$this
->config('system.logging')
->set('error_level', ERROR_REPORTING_HIDE)
->save();
$this
->drupalLogin($this->rootUser);
$this
->assertSessionCookieExists(TRUE);
$this
->assertBigPipeNoJsCookieExists(FALSE);
$connection = Database::getConnection();
$log_count = $connection
->select('watchdog')
->countQuery()
->execute()
->fetchField();
$this
->drupalGet(Url::fromRoute('big_pipe_test'));
$this
->assertBigPipeResponseHeadersPresent();
$this
->assertSession()
->responseHeaderNotContains('X-Drupal-Cache-Tags', 'cache_tag_set_in_lazy_builder');
$this
->setCsrfTokenSeedInTestEnvironment();
$cases = $this
->getTestCases();
$this
->assertBigPipeNoJsPlaceholders([
$cases['edge_case__invalid_html']->bigPipeNoJsPlaceholder => $cases['edge_case__invalid_html']->embeddedHtmlResponse,
$cases['html_attribute_value']->bigPipeNoJsPlaceholder => $cases['html_attribute_value']->embeddedHtmlResponse,
$cases['html_attribute_value_subset']->bigPipeNoJsPlaceholder => $cases['html_attribute_value_subset']->embeddedHtmlResponse,
]);
$this
->assertBigPipePlaceholders([
$cases['html']->bigPipePlaceholderId => Json::encode($cases['html']->embeddedAjaxResponseCommands),
$cases['edge_case__html_non_lazy_builder']->bigPipePlaceholderId => Json::encode($cases['edge_case__html_non_lazy_builder']->embeddedAjaxResponseCommands),
$cases['exception__lazy_builder']->bigPipePlaceholderId => NULL,
$cases['exception__embedded_response']->bigPipePlaceholderId => NULL,
], [
0 => $cases['edge_case__html_non_lazy_builder']->bigPipePlaceholderId,
1 => $cases['html']->bigPipePlaceholderId,
]);
$this
->assertSession()
->responseContains('</body>');
$this
->assertNotEmpty($this
->getDrupalSettings());
$this
->assertContains('big_pipe/big_pipe', explode(',', $this
->getDrupalSettings()['ajaxPageState']['libraries']), 'BigPipe asset library is present.');
$this
->assertEquals($log_count + 2, (int) $connection
->select('watchdog')
->countQuery()
->execute()
->fetchField(), 'Two new watchdog entries.');
$records = $connection
->select('watchdog', 'w')
->fields('w')
->orderBy('wid', 'DESC')
->range(0, 2)
->execute()
->fetchAll();
$this
->assertEquals(RfcLogLevel::ERROR, $records[0]->severity);
$this
->assertStringContainsString('Oh noes!', (string) unserialize($records[0]->variables)['@message']);
$this
->assertEquals(RfcLogLevel::ERROR, $records[1]->severity);
$this
->assertStringContainsString('You are not allowed to say llamas are not cool!', (string) unserialize($records[1]->variables)['@message']);
$this
->drupalGet(Url::fromUri('base:non-existing-path'));
$this
->config('system.logging')
->set('error_level', ERROR_REPORTING_DISPLAY_VERBOSE)
->save();
$this
->drupalGet(Url::fromRoute('big_pipe_test'));
$this
->assertSession()
->pageTextContains('The website encountered an unexpected error. Please try again later');
$this
->assertSession()
->pageTextContains('You are not allowed to say llamas are not cool!');
$this
->assertSession()
->responseNotContains(BigPipe::STOP_SIGNAL);
$this
->assertSession()
->responseNotContains('</body>');
unlink($this->root . '/' . $this->siteDirectory . '/error.log');
}
public function testBigPipeNoJs() {
$this
->config('system.logging')
->set('error_level', ERROR_REPORTING_HIDE)
->save();
$this
->drupalLogin($this->rootUser);
$this
->assertSessionCookieExists(TRUE);
$this
->assertBigPipeNoJsCookieExists(FALSE);
$this
->performMetaRefresh();
$this
->assertBigPipeNoJsCookieExists(TRUE);
$this
->drupalGet(Url::fromRoute('big_pipe_test'));
$this
->assertBigPipeResponseHeadersPresent();
$this
->assertSession()
->responseHeaderNotContains('X-Drupal-Cache-Tags', 'cache_tag_set_in_lazy_builder');
$this
->setCsrfTokenSeedInTestEnvironment();
$cases = $this
->getTestCases();
$this
->assertBigPipeNoJsPlaceholders([
$cases['edge_case__invalid_html']->bigPipeNoJsPlaceholder => $cases['edge_case__invalid_html']->embeddedHtmlResponse,
$cases['html_attribute_value']->bigPipeNoJsPlaceholder => $cases['html_attribute_value']->embeddedHtmlResponse,
$cases['html_attribute_value_subset']->bigPipeNoJsPlaceholder => $cases['html_attribute_value_subset']->embeddedHtmlResponse,
$cases['html']->bigPipeNoJsPlaceholder => $cases['html']->embeddedHtmlResponse,
$cases['edge_case__html_non_lazy_builder']->bigPipeNoJsPlaceholder => $cases['edge_case__html_non_lazy_builder']->embeddedHtmlResponse,
$cases['exception__lazy_builder']->bigPipePlaceholderId => NULL,
$cases['exception__embedded_response']->bigPipePlaceholderId => NULL,
]);
$this
->assertSession()
->responseHeaderEquals('BigPipe-Test-Placeholders', '<none>');
$this
->assertSession()
->responseNotContains(BigPipe::START_SIGNAL);
$this
->assertSession()
->responseNotContains(BigPipe::STOP_SIGNAL);
$this
->assertArrayNotHasKey('bigPipePlaceholderIds', $this
->getDrupalSettings());
$this
->assertArrayNotHasKey('ajaxPageState', $this
->getDrupalSettings());
$this
->assertSession()
->responseContains('</body>');
$this
->drupalGet(Url::fromUri('base:non-existing-path'));
$this
->config('system.logging')
->set('error_level', ERROR_REPORTING_DISPLAY_VERBOSE)
->save();
$this
->drupalGet(Url::fromRoute('big_pipe_test'));
$this
->assertSession()
->pageTextContains('The website encountered an unexpected error. Please try again later');
$this
->assertSession()
->pageTextContains('You are not allowed to say llamas are not cool!');
$this
->assertSession()
->responseNotContains('</body>');
unlink($this->root . '/' . $this->siteDirectory . '/error.log');
}
public function testBigPipeMultiOccurrencePlaceholders() {
$this
->drupalLogin($this->rootUser);
$this
->assertSessionCookieExists(TRUE);
$this
->assertBigPipeNoJsCookieExists(FALSE);
$this
->drupalGet(Url::fromRoute('big_pipe_test_multi_occurrence'));
$big_pipe_placeholder_id = 'callback=Drupal%5CCore%5CRender%5CElement%5CStatusMessages%3A%3ArenderMessages&args%5B0%5D&token=_HAdUpwWmet0TOTe2PSiJuMntExoshbm1kh2wQzzzAA';
$expected_placeholder_replacement = '<script type="application/vnd.drupal-ajax" data-big-pipe-replacement-for-placeholder-with-id="' . $big_pipe_placeholder_id . '">';
$this
->assertSession()
->pageTextContains('The count is 1.');
$this
->assertSession()
->responseNotContains('The count is 2.');
$this
->assertSession()
->responseNotContains('The count is 3.');
$raw_content = $this
->getSession()
->getPage()
->getContent();
$this
->assertSame(1, substr_count($raw_content, $expected_placeholder_replacement), 'Only one placeholder replacement was found for the duplicate #lazy_builder arrays.');
$this
->performMetaRefresh();
$this
->assertBigPipeNoJsCookieExists(TRUE);
$this
->drupalGet(Url::fromRoute('big_pipe_test_multi_occurrence'));
$this
->assertSession()
->pageTextContains('The count is 1.');
$this
->assertSession()
->responseNotContains('The count is 2.');
$this
->assertSession()
->responseNotContains('The count is 3.');
}
protected function assertBigPipeResponseHeadersPresent() : void {
$this
->assertSession()
->responseHeaderContains('Cache-Control', 'private');
$this
->assertSession()
->responseHeaderEquals('Surrogate-Control', 'no-store, content="BigPipe/1.0"');
$this
->assertSession()
->responseHeaderEquals('X-Accel-Buffering', 'no');
}
protected function assertBigPipeNoJsPlaceholders(array $expected_big_pipe_nojs_placeholders) : void {
$this
->assertSetsEqual(array_keys($expected_big_pipe_nojs_placeholders), array_map('rawurldecode', explode(' ', $this
->getSession()
->getResponseHeader('BigPipe-Test-No-Js-Placeholders'))));
foreach ($expected_big_pipe_nojs_placeholders as $big_pipe_nojs_placeholder => $expected_replacement) {
$this
->assertSession()
->responseNotContains($big_pipe_nojs_placeholder);
if ($expected_replacement !== NULL) {
$this
->assertSession()
->responseContains($expected_replacement);
}
}
}
protected function assertBigPipePlaceholders(array $expected_big_pipe_placeholders, array $expected_big_pipe_placeholder_stream_order) : void {
$this
->assertSetsEqual(array_keys($expected_big_pipe_placeholders), explode(' ', $this
->getSession()
->getResponseHeader('BigPipe-Test-Placeholders')));
$placeholder_positions = [];
$placeholder_replacement_positions = [];
foreach ($expected_big_pipe_placeholders as $big_pipe_placeholder_id => $expected_ajax_response) {
$expected_placeholder_html = '<span data-big-pipe-placeholder-id="' . $big_pipe_placeholder_id . '"></span>';
$this
->assertSession()
->responseContains($expected_placeholder_html);
$pos = strpos($this
->getSession()
->getPage()
->getContent(), $expected_placeholder_html);
$placeholder_positions[$pos] = $big_pipe_placeholder_id;
$expected_placeholder_replacement = '<script type="application/vnd.drupal-ajax" data-big-pipe-replacement-for-placeholder-with-id="' . $big_pipe_placeholder_id . '">';
$result = $this
->xpath('//script[@data-big-pipe-replacement-for-placeholder-with-id=:id]', [
':id' => Html::decodeEntities($big_pipe_placeholder_id),
]);
if ($expected_ajax_response === NULL) {
$this
->assertCount(0, $result);
$this
->assertSession()
->responseNotContains($expected_placeholder_replacement);
continue;
}
$this
->assertEquals($expected_ajax_response, trim($result[0]
->getText()));
$this
->assertSession()
->responseContains($expected_placeholder_replacement);
$pos = strpos($this
->getSession()
->getPage()
->getContent(), $expected_placeholder_replacement);
$placeholder_replacement_positions[$pos] = $big_pipe_placeholder_id;
}
ksort($placeholder_positions, SORT_NUMERIC);
$this
->assertEquals(array_keys($expected_big_pipe_placeholders), array_values($placeholder_positions));
$placeholders = array_map(function (NodeElement $element) {
return $element
->getAttribute('data-big-pipe-placeholder-id');
}, $this
->cssSelect('[data-big-pipe-placeholder-id]'));
$this
->assertSameSize($expected_big_pipe_placeholders, array_unique($placeholders));
$expected_big_pipe_placeholders_with_replacements = [];
foreach ($expected_big_pipe_placeholder_stream_order as $big_pipe_placeholder_id) {
$expected_big_pipe_placeholders_with_replacements[$big_pipe_placeholder_id] = $expected_big_pipe_placeholders[$big_pipe_placeholder_id];
}
$this
->assertEquals($expected_big_pipe_placeholders_with_replacements, array_filter($expected_big_pipe_placeholders));
$this
->assertSetsEqual(array_keys($expected_big_pipe_placeholders_with_replacements), array_values($placeholder_replacement_positions));
$this
->assertSame(count($expected_big_pipe_placeholders_with_replacements), preg_match_all('/' . preg_quote('<script type="application/vnd.drupal-ajax" data-big-pipe-replacement-for-placeholder-with-id="', '/') . '/', $this
->getSession()
->getPage()
->getContent()));
$this
->assertSession()
->responseContains(BigPipe::START_SIGNAL);
$this
->assertSession()
->responseContains(BigPipe::STOP_SIGNAL);
$start_signal_position = strpos($this
->getSession()
->getPage()
->getContent(), BigPipe::START_SIGNAL);
$stop_signal_position = strpos($this
->getSession()
->getPage()
->getContent(), BigPipe::STOP_SIGNAL);
$this
->assertTrue($start_signal_position < $stop_signal_position, 'BigPipe start signal appears before stop signal.');
$expected_stream_order = array_keys($expected_big_pipe_placeholders_with_replacements);
array_unshift($expected_stream_order, BigPipe::START_SIGNAL);
array_push($expected_stream_order, BigPipe::STOP_SIGNAL);
$actual_stream_order = $placeholder_replacement_positions + [
$start_signal_position => BigPipe::START_SIGNAL,
$stop_signal_position => BigPipe::STOP_SIGNAL,
];
ksort($actual_stream_order, SORT_NUMERIC);
$this
->assertEquals($expected_stream_order, array_values($actual_stream_order));
}
protected function setCsrfTokenSeedInTestEnvironment() {
$session_data = $this->container
->get('session_handler.write_safe')
->read($this
->getSession()
->getCookie($this
->getSessionName()));
$csrf_token_seed = unserialize(explode('_sf2_meta|', $session_data)[1])['s'];
$this->container
->get('session_manager.metadata_bag')
->setCsrfTokenSeed($csrf_token_seed);
}
protected function getTestCases($has_session = TRUE) {
return BigPipePlaceholderTestCases::cases($this->container, $this->rootUser);
}
protected function assertSetsEqual(array $a, array $b) : void {
$result = count($a) == count($b) && !array_diff_assoc($a, $b);
}
protected function assertBigPipeNoJsCookieExists(string $expected) : void {
$this
->assertCookieExists('big_pipe_nojs', $expected, 'BigPipe no-JS');
}
protected function assertSessionCookieExists(string $expected) : void {
$this
->assertCookieExists($this
->getSessionName(), $expected, 'Session');
}
protected function assertCookieExists(string $cookie_name, string $expected, string $cookie_label) : void {
$this
->assertEquals($expected, !empty($this
->getSession()
->getCookie($cookie_name)), $expected ? "{$cookie_label} cookie exists." : "{$cookie_label} cookie does not exist.");
}
protected function assertBigPipeNoJsMetaRefreshRedirect() : void {
$original_url = $this
->getSession()
->getCurrentUrl();
$this
->getSession()
->getDriver()
->getClient()
->followRedirects(FALSE);
$this
->performMetaRefresh();
$headers[0] = $this
->getSession()
->getResponseHeaders();
$statuses[0] = $this
->getSession()
->getStatusCode();
$this
->performMetaRefresh();
$headers[1] = $this
->getSession()
->getResponseHeaders();
$statuses[1] = $this
->getSession()
->getStatusCode();
$this
->getSession()
->getDriver()
->getClient()
->followRedirects(TRUE);
$this
->assertEquals($original_url, $this
->getSession()
->getCurrentUrl(), 'Redirected back to the original location.');
$this
->assertEquals(302, $statuses[0], 'The first response was a 302 (redirect).');
$this
->assertStringStartsWith('big_pipe_nojs=1', $headers[0]['Set-Cookie'][0], 'The first response sets the big_pipe_nojs cookie.');
$this
->assertEquals($original_url, $headers[0]['Location'][0], 'The first response redirected back to the original page.');
$this
->assertEmpty(array_diff([
'cookies:big_pipe_nojs',
'session.exists',
], explode(' ', $headers[0]['X-Drupal-Cache-Contexts'][0])), 'The first response varies by the "cookies:big_pipe_nojs" and "session.exists" cache contexts.');
$this
->assertFalse(isset($headers[0]['Surrogate-Control']), 'The first response has no "Surrogate-Control" header.');
$this
->assertEquals(200, $statuses[1], 'The second response was a 200.');
$this
->assertEmpty(array_diff([
'cookies:big_pipe_nojs',
'session.exists',
], explode(' ', $headers[0]['X-Drupal-Cache-Contexts'][0])), 'The second response varies by the "cookies:big_pipe_nojs" and "session.exists" cache contexts.');
$this
->assertEquals('no-store, content="BigPipe/1.0"', $headers[1]['Surrogate-Control'][0], 'The second response has a "Surrogate-Control" header.');
$this
->assertSession()
->responseNotContains('<noscript><meta http-equiv="Refresh" content="0; URL=');
}
}