refresh that big_pipe.module sets. It causes a redirect // to a page that sets another cookie, which causes WebTestBase to lose the // session cookie. To avoid this problem, tests should first call // drupalGet() and then call checkForMetaRefresh() manually, and then reset // $this->maximumMetaRefreshCount and $this->metaRefreshCount. // @see doMetaRefresh() $this->maximumMetaRefreshCount = 0; } /** * Performs a single refresh explicitly. * * This test disables the automatic refresh checking, each time it is * desired that this runs, a test case must explicitly call this. * * @see setUp() */ protected function performMetaRefresh() { $this->maximumMetaRefreshCount = 1; $this->checkForMetaRefresh(); $this->maximumMetaRefreshCount = 0; $this->metaRefreshCount = 0; } /** * Tests BigPipe's no-JS detection. * * Covers: * - big_pipe_page_attachments() * - \Drupal\big_pipe\Controller\BigPipeController */ public function testNoJsDetection() { $no_js_to_js_markup = ''; // 1. No session (anonymous). $this->drupalGet(Url::fromRoute('')); $this->assertSessionCookieExists(FALSE); $this->assertBigPipeNoJsCookieExists(FALSE); $this->assertNoRaw('

'); $this->assertNoRaw($no_js_to_js_markup); $this->assertBigPipeNoJsMetaRefreshRedirect(); $this->assertBigPipeNoJsCookieExists(TRUE); $this->assertNoRaw('

'; $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->assertEqual(0, count($result)); $this->assertNoRaw($expected_placeholder_replacement); continue; } $this->assertEqual($expected_ajax_response, trim((string) $result[0])); $this->assertRaw($expected_placeholder_replacement); $pos = strpos($this->getRawContent(), $expected_placeholder_replacement); $placeholder_replacement_positions[$pos] = $big_pipe_placeholder_id; } ksort($placeholder_positions, SORT_NUMERIC); $this->assertEqual(array_keys($expected_big_pipe_placeholders), array_values($placeholder_positions)); $placeholders = array_map(function(\SimpleXMLElement $element) { return (string) $element['data-big-pipe-placeholder-id']; }, $this->cssSelect('[data-big-pipe-placeholder-id]')); $this->assertEqual(count($expected_big_pipe_placeholders), count(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->assertEqual($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->assertEqual(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->getRawContent())); $this->pass('Verifying BigPipe start/stop signals…', 'Debug'); $this->assertRaw(BigPipe::START_SIGNAL, 'BigPipe start signal present.'); $this->assertRaw(BigPipe::STOP_SIGNAL, 'BigPipe stop signal present.'); $start_signal_position = strpos($this->getRawContent(), BigPipe::START_SIGNAL); $stop_signal_position = strpos($this->getRawContent(), BigPipe::STOP_SIGNAL); $this->assertTrue($start_signal_position < $stop_signal_position, 'BigPipe start signal appears before stop signal.'); $this->pass('Verifying BigPipe placeholder replacements and start/stop signals were streamed in the correct order…', 'Debug'); $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->assertEqual($expected_stream_order, array_values($actual_stream_order)); } /** * Ensures CSRF tokens can be generated for the current user's session. */ protected function setCsrfTokenSeedInTestEnvironment() { $session_data = $this->container->get('session_handler.write_safe')->read($this->cookies[$this->getSessionName()]['value']); $csrf_token_seed = unserialize(explode('_sf2_meta|', $session_data)[1])['s']; $this->container->get('session_manager.metadata_bag')->setCsrfTokenSeed($csrf_token_seed); } /** * @return \Drupal\big_pipe\Tests\BigPipePlaceholderTestCase[] */ protected function getTestCases($has_session = TRUE) { return BigPipePlaceholderTestCases::cases($this->container, $this->rootUser); } /** * Asserts whether arrays A and B are equal, when treated as sets. */ protected function assertSetsEqual(array $a, array $b) { return count($a) == count($b) && !array_diff_assoc($a, $b); } /** * Asserts whether a BigPipe no-JS cookie exists or not. */ protected function assertBigPipeNoJsCookieExists($expected) { $this->assertCookieExists('big_pipe_nojs', $expected, 'BigPipe no-JS'); } /** * Asserts whether a session cookie exists or not. */ protected function assertSessionCookieExists($expected) { $this->assertCookieExists($this->getSessionName(), $expected, 'Session'); } /** * Asserts whether a cookie exists on the client or not. */ protected function assertCookieExists($cookie_name, $expected, $cookie_label) { $non_deleted_cookies = array_filter($this->cookies, function ($item) { return $item['value'] !== 'deleted'; }); $this->assertEqual($expected, isset($non_deleted_cookies[$cookie_name]), $expected ? "$cookie_label cookie exists." : "$cookie_label cookie does not exist."); } /** * Calls ::performMetaRefresh() and asserts the responses. */ protected function assertBigPipeNoJsMetaRefreshRedirect() { $original_url = $this->url; $this->performMetaRefresh(); $this->assertEqual($original_url, $this->url, 'Redirected back to the original location.'); $headers = $this->drupalGetHeaders(TRUE); $this->assertEqual(2, count($headers), 'Two requests were made upon following the <meta> refresh, there are headers for two responses.'); // First response: redirect. $this->assertEqual('HTTP/1.1 302 Found', $headers[0][':status'], 'The first response was a 302 (redirect).'); $this->assertIdentical(0, strpos($headers[0]['set-cookie'], 'big_pipe_nojs=1'), 'The first response sets the big_pipe_nojs cookie.'); $this->assertEqual($original_url, $headers[0]['location'], 'The first response redirected back to the original page.'); $this->assertTrue(empty(array_diff(['cookies:big_pipe_nojs', 'session.exists'], explode(' ', $headers[0]['x-drupal-cache-contexts']))), '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.'); // Second response: redirect followed. $this->assertEqual('HTTP/1.1 200 OK', $headers[1][':status'], 'The second response was a 200.'); $this->assertTrue(empty(array_diff(['cookies:big_pipe_nojs', 'session.exists'], explode(' ', $headers[0]['x-drupal-cache-contexts']))), 'The first response varies by the "cookies:big_pipe_nojs" and "session.exists" cache contexts.'); $this->assertEqual('no-store, content="BigPipe/1.0"', $headers[1]['surrogate-control'], 'The second response has a "Surrogate-Control" header.'); $this->assertNoRaw('<noscript><meta http-equiv="Refresh" content="0; URL=', 'Once the BigPipe no-JS cookie is set, the <meta> refresh is absent: only one redirect ever happens.'); } }