class BigPipeTest

Same name in other branches
  1. 8.9.x core/modules/big_pipe/tests/src/Functional/BigPipeTest.php \Drupal\Tests\big_pipe\Functional\BigPipeTest
  2. 10 core/modules/big_pipe/tests/src/Functional/BigPipeTest.php \Drupal\Tests\big_pipe\Functional\BigPipeTest
  3. 11.x core/modules/big_pipe/tests/src/Functional/BigPipeTest.php \Drupal\Tests\big_pipe\Functional\BigPipeTest

Tests BigPipe's no-JS detection & response delivery (with and without JS).

Covers:

@group big_pipe

Hierarchy

Expanded class hierarchy of BigPipeTest

File

core/modules/big_pipe/tests/src/Functional/BigPipeTest.php, line 28

Namespace

Drupal\Tests\big_pipe\Functional
View source
class BigPipeTest extends BrowserTestBase {
    
    /**
     * Modules to enable.
     *
     * @var array
     */
    protected static $modules = [
        'big_pipe',
        'big_pipe_test',
        'dblog',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        // Ignore the <meta> refresh that big_pipe.module sets. It causes a redirect
        // to a page that sets another cookie, which causes BrowserTestBase 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 <meta> refresh explicitly.
     *
     * This test disables the automatic <meta> 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 = '<script>document.cookie = "' . BigPipeStrategy::NOJS_COOKIE . '=1; path=/; expires=Thu, 01 Jan 1970 00:00:00 GMT"</script>';
        // 1. No session (anonymous).
        $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);
        // 2. Session (authenticated).
        $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();
        // Close the prior connection and remove the collected state.
        $this->getSession()
            ->reset();
        // 3. Session (anonymous).
        $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);
        // Close the prior connection and remove the collected state.
        $this->getSession()
            ->reset();
        // Edge case: route with '_no_big_pipe' option.
        $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);
    }
    
    /**
     * Tests BigPipe-delivered HTML responses when JavaScript is enabled.
     *
     * Covers:
     * - \Drupal\big_pipe\EventSubscriber\HtmlResponseBigPipeSubscriber
     * - \Drupal\big_pipe\Render\BigPipe
     * - \Drupal\big_pipe\Render\BigPipe::sendPlaceholders()
     *
     * @see \Drupal\big_pipe_test\BigPipePlaceholderTestCases
     */
    public function testBigPipe() {
        // Simulate production.
        $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();
        // By not calling performMetaRefresh() here, we simulate JavaScript being
        // enabled, because as far as the BigPipe module is concerned, JavaScript is
        // enabled in the browser as long as the BigPipe no-JS cookie is *not* set.
        // @see setUp()
        // @see performMetaRefresh()
        $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,
            // The 'html' case contains the 'status messages' placeholder, which is
            // always rendered last.
1 => $cases['html']->bigPipePlaceholderId,
        ]);
        $this->assertSession()
            ->responseContains('</body>');
        // Verifying BigPipe assets are present.
        $this->assertNotEmpty($this->getDrupalSettings());
        $this->assertContains('big_pipe/big_pipe', explode(',', $this->getDrupalSettings()['ajaxPageState']['libraries']), 'BigPipe asset library is present.');
        // Verify that the two expected exceptions are logged as errors.
        $this->assertEquals($log_count + 2, (int) $connection->select('watchdog')
            ->countQuery()
            ->execute()
            ->fetchField(), 'Two new watchdog entries.');
        // Using dynamic select queries with the method range() allows contrib
        // database drivers the ability to insert their own limit and offset
        // functionality.
        $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']);
        // Verify that 4xx responses work fine. (4xx responses are handled by
        // subrequests to a route pointing to a controller with the desired output.)
        $this->drupalGet(Url::fromUri('base:non-existing-path'));
        // Simulate development.
        // Verifying BigPipe provides useful error output when an error occurs
        // while rendering a placeholder if verbose error logging is enabled.
        $this->config('system.logging')
            ->set('error_level', ERROR_REPORTING_DISPLAY_VERBOSE)
            ->save();
        $this->drupalGet(Url::fromRoute('big_pipe_test'));
        // The 'edge_case__html_exception' case throws an exception.
        $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!');
        // Check that stop signal and closing body tag are absent.
        $this->assertSession()
            ->responseNotContains(BigPipe::STOP_SIGNAL);
        $this->assertSession()
            ->responseNotContains('</body>');
        // The exception is expected. Do not interpret it as a test failure.
        unlink($this->root . '/' . $this->siteDirectory . '/error.log');
    }
    
    /**
     * Tests BigPipe-delivered HTML responses when JavaScript is disabled.
     *
     * Covers:
     * - \Drupal\big_pipe\EventSubscriber\HtmlResponseBigPipeSubscriber
     * - \Drupal\big_pipe\Render\BigPipe
     * - \Drupal\big_pipe\Render\BigPipe::sendNoJsPlaceholders()
     *
     * @see \Drupal\big_pipe_test\BigPipePlaceholderTestCases
     */
    public function testBigPipeNoJs() {
        // Simulate production.
        $this->config('system.logging')
            ->set('error_level', ERROR_REPORTING_HIDE)
            ->save();
        $this->drupalLogin($this->rootUser);
        $this->assertSessionCookieExists(TRUE);
        $this->assertBigPipeNoJsCookieExists(FALSE);
        // By calling performMetaRefresh() here, we simulate JavaScript being
        // disabled, because as far as the BigPipe module is concerned, it is
        // enabled in the browser when the BigPipe no-JS cookie is set.
        // @see setUp()
        // @see performMetaRefresh()
        $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,
        ]);
        // Verifying there are no BigPipe placeholders & replacements.
        $this->assertSession()
            ->responseHeaderEquals('BigPipe-Test-Placeholders', '<none>');
        // Verifying BigPipe start/stop signals are absent.
        $this->assertSession()
            ->responseNotContains(BigPipe::START_SIGNAL);
        $this->assertSession()
            ->responseNotContains(BigPipe::STOP_SIGNAL);
        // Verifying BigPipe assets are absent.
        $this->assertArrayNotHasKey('bigPipePlaceholderIds', $this->getDrupalSettings());
        $this->assertArrayNotHasKey('ajaxPageState', $this->getDrupalSettings());
        $this->assertSession()
            ->responseContains('</body>');
        // Verify that 4xx responses work fine. (4xx responses are handled by
        // subrequests to a route pointing to a controller with the desired output.)
        $this->drupalGet(Url::fromUri('base:non-existing-path'));
        // Simulate development.
        // Verifying BigPipe provides useful error output when an error occurs
        // while rendering a placeholder if verbose error logging is enabled.
        $this->config('system.logging')
            ->set('error_level', ERROR_REPORTING_DISPLAY_VERBOSE)
            ->save();
        $this->drupalGet(Url::fromRoute('big_pipe_test'));
        // The 'edge_case__html_exception' case throws an exception.
        $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>');
        // The exception is expected. Do not interpret it as a test failure.
        unlink($this->root . '/' . $this->siteDirectory . '/error.log');
    }
    
    /**
     * Tests BigPipe with a multi-occurrence placeholder.
     */
    public function testBigPipeMultiOccurrencePlaceholders() {
        $this->drupalLogin($this->rootUser);
        $this->assertSessionCookieExists(TRUE);
        $this->assertBigPipeNoJsCookieExists(FALSE);
        // By not calling performMetaRefresh() here, we simulate JavaScript being
        // enabled, because as far as the BigPipe module is concerned, JavaScript is
        // enabled in the browser as long as the BigPipe no-JS cookie is *not* set.
        // @see setUp()
        // @see performMetaRefresh()
        $this->drupalGet(Url::fromRoute('big_pipe_test_multi_occurrence'));
        $big_pipe_placeholder_id = 'callback=Drupal%5CCore%5CRender%5CElement%5CStatusMessages%3A%3ArenderMessages&amp;args%5B0%5D&amp;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.');
        // By calling performMetaRefresh() here, we simulate JavaScript being
        // disabled, because as far as the BigPipe module is concerned, it is
        // enabled in the browser when the BigPipe no-JS cookie is set.
        // @see setUp()
        // @see performMetaRefresh()
        $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.');
    }
    
    /**
     * @internal
     */
    protected function assertBigPipeResponseHeadersPresent() : void {
        // Check that Cache-Control header set to "private".
        $this->assertSession()
            ->responseHeaderContains('Cache-Control', 'private');
        $this->assertSession()
            ->responseHeaderEquals('Surrogate-Control', 'no-store, content="BigPipe/1.0"');
        $this->assertSession()
            ->responseHeaderEquals('X-Accel-Buffering', 'no');
    }
    
    /**
     * Asserts expected BigPipe no-JS placeholders are present and replaced.
     *
     * @param array $expected_big_pipe_nojs_placeholders
     *   Keys: BigPipe no-JS placeholder markup. Values: expected replacement
     *   markup.
     *
     * @internal
     */
    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) {
            // Checking whether the replacement for the BigPipe no-JS placeholder
            // $big_pipe_nojs_placeholder is present.
            $this->assertSession()
                ->responseNotContains($big_pipe_nojs_placeholder);
            if ($expected_replacement !== NULL) {
                $this->assertSession()
                    ->responseContains($expected_replacement);
            }
        }
    }
    
    /**
     * Asserts expected BigPipe placeholders are present and replaced.
     *
     * @param array $expected_big_pipe_placeholders
     *   Keys: BigPipe placeholder IDs. Values: expected AJAX response.
     * @param array $expected_big_pipe_placeholder_stream_order
     *   Keys: BigPipe placeholder IDs. Values: expected AJAX response. Keys are
     *   defined in the order that they are expected to be rendered & streamed.
     *
     * @internal
     */
    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) {
            // Verify expected placeholder.
            $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;
            // Verify expected placeholder replacement.
            $expected_placeholder_replacement = '<script type="application/vnd.drupal-ajax" data-big-pipe-replacement-for-placeholder-with-id="' . $big_pipe_placeholder_id . '">';
            $xpath = '//script[@data-big-pipe-replacement-for-placeholder-with-id="' . Html::decodeEntities($big_pipe_placeholder_id) . '"]';
            if ($expected_ajax_response === NULL) {
                $this->assertSession()
                    ->elementNotExists('xpath', $xpath);
                $this->assertSession()
                    ->responseNotContains($expected_placeholder_replacement);
                continue;
            }
            $this->assertSession()
                ->elementTextContains('xpath', $xpath, $expected_ajax_response);
            $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()));
        // Verifying BigPipe start/stop signals.
        $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.');
        // Verifying BigPipe placeholder replacements and start/stop signals were
        // streamed in the correct order.
        $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));
    }
    
    /**
     * 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->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);
    }
    
    /**
     * @return \Drupal\big_pipe_test\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.
     *
     * @todo This method is broken. Fix it in
     *   https://www.drupal.org/project/drupal/issues/3144926
     *
     * @internal
     */
    protected function assertSetsEqual(array $a, array $b) : void {
        $result = count($a) == count($b) && !array_diff_assoc($a, $b);
    }
    
    /**
     * Asserts whether a BigPipe no-JS cookie exists or not.
     *
     * @internal
     */
    protected function assertBigPipeNoJsCookieExists(string $expected) : void {
        $this->assertCookieExists('big_pipe_nojs', $expected, 'BigPipe no-JS');
    }
    
    /**
     * Asserts whether a session cookie exists or not.
     *
     * @internal
     */
    protected function assertSessionCookieExists(string $expected) : void {
        $this->assertCookieExists($this->getSessionName(), $expected, 'Session');
    }
    
    /**
     * Asserts whether a cookie exists on the client or not.
     *
     * @internal
     */
    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.");
    }
    
    /**
     * Calls ::performMetaRefresh() and asserts the responses.
     *
     * @internal
     */
    protected function assertBigPipeNoJsMetaRefreshRedirect() : void {
        $original_url = $this->getSession()
            ->getCurrentUrl();
        // Disable automatic following of redirects by the HTTP client, so that this
        // test can analyze the response headers of each redirect response.
        $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.');
        // First response: redirect.
        $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.');
        // Second response: redirect followed.
        $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.');
        // Check that the <meta> refresh is absent, only one redirect ever happens.
        $this->assertSession()
            ->responseNotContains('<noscript><meta http-equiv="Refresh" content="0; URL=');
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Member alias Overriden Title Overrides
AssertLegacyTrait::assert Deprecated protected function
AssertLegacyTrait::assertCacheTag Deprecated protected function Asserts whether an expected cache tag was present in the last response.
AssertLegacyTrait::assertElementNotPresent Deprecated protected function Asserts that the element with the given CSS selector is not present.
AssertLegacyTrait::assertElementPresent Deprecated protected function Asserts that the element with the given CSS selector is present.
AssertLegacyTrait::assertEqual Deprecated protected function
AssertLegacyTrait::assertEscaped Deprecated protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertLegacyTrait::assertField Deprecated protected function Asserts that a field exists with the given name or ID.
AssertLegacyTrait::assertFieldById Deprecated protected function Asserts that a field exists with the given ID and value.
AssertLegacyTrait::assertFieldByName Deprecated protected function Asserts that a field exists with the given name and value.
AssertLegacyTrait::assertFieldByXPath Deprecated protected function Asserts that a field exists in the current page by the given XPath.
AssertLegacyTrait::assertFieldChecked Deprecated protected function Asserts that a checkbox field in the current page is checked.
AssertLegacyTrait::assertFieldsByValue Deprecated protected function Asserts that a field exists in the current page with a given Xpath result.
AssertLegacyTrait::assertHeader Deprecated protected function Checks that current response header equals value.
AssertLegacyTrait::assertIdentical Deprecated protected function
AssertLegacyTrait::assertIdenticalObject Deprecated protected function
AssertLegacyTrait::assertLink Deprecated protected function Passes if a link with the specified label is found.
AssertLegacyTrait::assertLinkByHref Deprecated protected function Passes if a link containing a given href (part) is found.
AssertLegacyTrait::assertNoCacheTag Deprecated protected function Asserts whether an expected cache tag was absent in the last response.
AssertLegacyTrait::assertNoEscaped Deprecated protected function Passes if the raw text is not found escaped on the loaded page.
AssertLegacyTrait::assertNoField Deprecated protected function Asserts that a field does NOT exist with the given name or ID.
AssertLegacyTrait::assertNoFieldById Deprecated protected function Asserts that a field does not exist with the given ID and value.
AssertLegacyTrait::assertNoFieldByName Deprecated protected function Asserts that a field does not exist with the given name and value.
AssertLegacyTrait::assertNoFieldByXPath Deprecated protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertLegacyTrait::assertNoFieldChecked Deprecated protected function Asserts that a checkbox field in the current page is not checked.
AssertLegacyTrait::assertNoLink Deprecated protected function Passes if a link with the specified label is not found.
AssertLegacyTrait::assertNoLinkByHref Deprecated protected function Passes if a link containing a given href (part) is not found.
AssertLegacyTrait::assertNoOption Deprecated protected function Asserts that a select option does NOT exist in the current page.
AssertLegacyTrait::assertNoPattern Deprecated protected function Triggers a pass if the Perl regex pattern is not found in the raw content.
AssertLegacyTrait::assertNoRaw Deprecated protected function Passes if the raw text IS not found on the loaded page, fail otherwise.
AssertLegacyTrait::assertNotEqual Deprecated protected function
AssertLegacyTrait::assertNoText Deprecated protected function Passes if the page (with HTML stripped) does not contains the text.
AssertLegacyTrait::assertNotIdentical Deprecated protected function
AssertLegacyTrait::assertNoUniqueText Deprecated protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertLegacyTrait::assertOption Deprecated protected function Asserts that a select option in the current page exists.
AssertLegacyTrait::assertOptionByText Deprecated protected function Asserts that a select option with the visible text exists.
AssertLegacyTrait::assertOptionSelected Deprecated protected function Asserts that a select option in the current page is checked.
AssertLegacyTrait::assertPattern Deprecated protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertLegacyTrait::assertRaw Deprecated protected function Passes if the raw text IS found on the loaded page, fail otherwise.
AssertLegacyTrait::assertResponse Deprecated protected function Asserts the page responds with the specified response code.
AssertLegacyTrait::assertText Deprecated protected function Passes if the page (with HTML stripped) contains the text.
AssertLegacyTrait::assertTextHelper Deprecated protected function Helper for assertText and assertNoText.
AssertLegacyTrait::assertTitle Deprecated protected function Pass if the page title is the given string.
AssertLegacyTrait::assertUniqueText Deprecated protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertLegacyTrait::assertUrl Deprecated protected function Passes if the internal browser&#039;s URL matches the given path.
AssertLegacyTrait::buildXPathQuery Deprecated protected function Builds an XPath query.
AssertLegacyTrait::constructFieldXpath Deprecated protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertLegacyTrait::getAllOptions Deprecated protected function Get all option elements, including nested options, in a select.
AssertLegacyTrait::getRawContent Deprecated protected function Gets the current raw content.
AssertLegacyTrait::pass Deprecated protected function
AssertLegacyTrait::verbose Deprecated protected function
BigPipeTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
BigPipeTest::$modules protected static property Modules to enable. Overrides BrowserTestBase::$modules
BigPipeTest::assertBigPipeNoJsCookieExists protected function Asserts whether a BigPipe no-JS cookie exists or not.
BigPipeTest::assertBigPipeNoJsMetaRefreshRedirect protected function Calls ::performMetaRefresh() and asserts the responses.
BigPipeTest::assertBigPipeNoJsPlaceholders protected function Asserts expected BigPipe no-JS placeholders are present and replaced.
BigPipeTest::assertBigPipePlaceholders protected function Asserts expected BigPipe placeholders are present and replaced.
BigPipeTest::assertBigPipeResponseHeadersPresent protected function @internal
BigPipeTest::assertCookieExists protected function Asserts whether a cookie exists on the client or not.
BigPipeTest::assertSessionCookieExists protected function Asserts whether a session cookie exists or not.
BigPipeTest::assertSetsEqual protected function Asserts whether arrays A and B are equal, when treated as sets.
BigPipeTest::getTestCases protected function
BigPipeTest::performMetaRefresh protected function Performs a single &lt;meta&gt; refresh explicitly.
BigPipeTest::setCsrfTokenSeedInTestEnvironment protected function Ensures CSRF tokens can be generated for the current user&#039;s session.
BigPipeTest::setUp protected function Overrides BrowserTestBase::setUp
BigPipeTest::testBigPipe public function Tests BigPipe-delivered HTML responses when JavaScript is enabled.
BigPipeTest::testBigPipeMultiOccurrencePlaceholders public function Tests BigPipe with a multi-occurrence placeholder.
BigPipeTest::testBigPipeNoJs public function Tests BigPipe-delivered HTML responses when JavaScript is disabled.
BigPipeTest::testNoJsDetection public function Tests BigPipe&#039;s no-JS detection.
BlockCreationTrait::placeBlock protected function Creates a block instance based on default settings. Aliased as: drupalPlaceBlock
BrowserHtmlDebugTrait::$htmlOutputBaseUrl protected property The Base URI to use for links to the output files.
BrowserHtmlDebugTrait::$htmlOutputClassName protected property Class name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounter protected property Counter for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounterStorage protected property Counter storage for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputDirectory protected property Directory name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputEnabled protected property HTML output enabled.
BrowserHtmlDebugTrait::$htmlOutputFile protected property The file name to write the list of URLs to.
BrowserHtmlDebugTrait::$htmlOutputTestId protected property HTML output test ID.
BrowserHtmlDebugTrait::formatHtmlOutputHeaders protected function Formats HTTP headers as string for HTML output logging.
BrowserHtmlDebugTrait::getHtmlOutputHeaders protected function Returns headers in HTML output format. 1
BrowserHtmlDebugTrait::getResponseLogHandler protected function Provides a Guzzle middleware handler to log every response received.
BrowserHtmlDebugTrait::htmlOutput protected function Logs a HTML output message in a text file.
BrowserHtmlDebugTrait::initBrowserOutputFile protected function Creates the directory to store browser output.
BrowserTestBase::$baseUrl protected property The base URL.
BrowserTestBase::$configImporter protected property The config importer that can be used in a test.
BrowserTestBase::$customTranslations protected property An array of custom translations suitable for drupal_rewrite_settings().
BrowserTestBase::$mink protected property Mink session manager.
BrowserTestBase::$minkDefaultDriverArgs protected property Mink default driver params.
BrowserTestBase::$minkDefaultDriverClass protected property Mink class for the default driver to use. 1
BrowserTestBase::$originalContainer protected property The original container.
BrowserTestBase::$originalShutdownCallbacks protected property The original array of shutdown function callbacks.
BrowserTestBase::$preserveGlobalState protected property
BrowserTestBase::$profile protected property The profile to install as a basis for testing. 37
BrowserTestBase::$runTestInSeparateProcess protected property Browser tests are run in separate processes to prevent collisions between
code that may be loaded by tests.
BrowserTestBase::$timeLimit protected property Time limit in seconds for the test.
BrowserTestBase::$translationFilesDirectory protected property The translation file directory for the test environment.
BrowserTestBase::cleanupEnvironment protected function Clean up the Simpletest environment.
BrowserTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
BrowserTestBase::drupalGetHeader Deprecated protected function Gets the value of an HTTP response header.
BrowserTestBase::filePreDeleteCallback public static function Ensures test files are deletable.
BrowserTestBase::getDefaultDriverInstance protected function Gets an instance of the default Mink driver.
BrowserTestBase::getDrupalSettings protected function Gets the JavaScript drupalSettings variable for the currently-loaded page. 1
BrowserTestBase::getHttpClient protected function Obtain the HTTP client for the system under test.
BrowserTestBase::getMinkDriverArgs protected function Gets the Mink driver args from an environment variable. 1
BrowserTestBase::getOptions protected function Helper function to get the options of select field.
BrowserTestBase::getSession public function Returns Mink session.
BrowserTestBase::getSessionCookies protected function Get session cookies from current session.
BrowserTestBase::getTestMethodCaller protected function Retrieves the current calling line in the class under test. Overrides BrowserHtmlDebugTrait::getTestMethodCaller
BrowserTestBase::initFrontPage protected function Visits the front page when initializing Mink. 3
BrowserTestBase::initMink protected function Initializes Mink sessions. 1
BrowserTestBase::installDrupal public function Installs Drupal into the Simpletest site. 1
BrowserTestBase::registerSessions protected function Registers additional Mink sessions.
BrowserTestBase::setUpAppRoot protected function Sets up the root application path.
BrowserTestBase::setUpBeforeClass public static function 1
BrowserTestBase::tearDown protected function 3
BrowserTestBase::translatePostValues protected function Transforms a nested array into a flat array suitable for submitForm().
BrowserTestBase::xpath protected function Performs an xpath search on the contents of the internal browser.
BrowserTestBase::__sleep public function Prevents serializing any properties.
ConfigTestTrait::configImporter protected function Returns a ConfigImporter object to import test configuration.
ConfigTestTrait::copyConfig protected function Copies configuration objects from source storage to target storage.
ContentTypeCreationTrait::createContentType protected function Creates a custom content type based on default settings. Aliased as: drupalCreateContentType 1
ExtensionListTestTrait::getModulePath protected function Gets the path for the specified module.
ExtensionListTestTrait::getThemePath protected function Gets the path for the specified theme.
FunctionalTestSetupTrait::$apcuEnsureUniquePrefix protected property The flag to set &#039;apcu_ensure_unique_prefix&#039; setting. 1
FunctionalTestSetupTrait::$classLoader protected property The class loader to use for installation and initialization of setup.
FunctionalTestSetupTrait::$rootUser protected property The &quot;#1&quot; admin user.
FunctionalTestSetupTrait::doInstall protected function Execute the non-interactive installer. 1
FunctionalTestSetupTrait::getDatabaseTypes protected function Returns all supported database driver installer objects.
FunctionalTestSetupTrait::initConfig protected function Initialize various configurations post-installation. 1
FunctionalTestSetupTrait::initKernel protected function Initializes the kernel after installation.
FunctionalTestSetupTrait::initSettings protected function Initialize settings created during install.
FunctionalTestSetupTrait::initUserSession protected function Initializes user 1 for the site to be installed.
FunctionalTestSetupTrait::installDefaultThemeFromClassProperty protected function Installs the default theme defined by `static::$defaultTheme` when needed.
FunctionalTestSetupTrait::installModulesFromClassProperty protected function Install modules defined by `static::$modules`. 1
FunctionalTestSetupTrait::installParameters protected function Returns the parameters that will be used when Simpletest installs Drupal. 8
FunctionalTestSetupTrait::prepareEnvironment protected function Prepares the current environment for running the test. 22
FunctionalTestSetupTrait::prepareRequestForGenerator protected function Creates a mock request and sets it on the generator.
FunctionalTestSetupTrait::prepareSettings protected function Prepares site settings and services before installation. 3
FunctionalTestSetupTrait::rebuildAll protected function Resets and rebuilds the environment after setup.
FunctionalTestSetupTrait::rebuildContainer protected function Rebuilds \Drupal::getContainer().
FunctionalTestSetupTrait::resetAll protected function Resets all data structures after having enabled new modules.
FunctionalTestSetupTrait::setContainerParameter protected function Changes parameters in the services.yml file.
FunctionalTestSetupTrait::setupBaseUrl protected function Sets up the base URL based upon the environment variable.
FunctionalTestSetupTrait::writeSettings protected function Rewrites the settings.php file of the test site. 1
NodeCreationTrait::createNode protected function Creates a node based on default settings. Aliased as: drupalCreateNode
NodeCreationTrait::getNodeByTitle public function Get a node from the database based on its title. Aliased as: drupalGetNodeByTitle
PhpUnitWarnings::$deprecationWarnings private static property Deprecation warnings from PHPUnit to raise with @trigger_error().
PhpUnitWarnings::addWarning public function Converts PHPUnit deprecation warnings to E_USER_DEPRECATED.
RandomGeneratorTrait::$randomGenerator protected property The random generator.
RandomGeneratorTrait::getRandomGenerator protected function Gets the random generator for the utility methods.
RandomGeneratorTrait::randomMachineName protected function Generates a unique random string containing letters and numbers. 1
RandomGeneratorTrait::randomObject public function Generates a random PHP object.
RandomGeneratorTrait::randomString public function Generates a pseudo-random string of ASCII characters of codes 32 to 126.
RandomGeneratorTrait::randomStringValidate public function Callback for random string validation.
RefreshVariablesTrait::refreshVariables protected function Refreshes in-memory configuration and state information. 1
SessionTestTrait::$sessionName protected property The name of the session cookie.
SessionTestTrait::generateSessionName protected function Generates a session cookie name.
SessionTestTrait::getSessionName protected function Returns the session name in use on the child site.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::checkModuleRequirements private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements protected function Check module requirements for the Drupal use case.
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.
TestSetupTrait::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking. 1
TestSetupTrait::$container protected property The dependency injection container used in the test.
TestSetupTrait::$databasePrefix protected property The database prefix of this test run.
TestSetupTrait::$kernel protected property The DrupalKernel instance used in the test.
TestSetupTrait::$originalSite protected property The site directory of the original parent site.
TestSetupTrait::$privateFilesDirectory protected property The private file directory for the test environment.
TestSetupTrait::$publicFilesDirectory protected property The public file directory for the test environment.
TestSetupTrait::$root protected property The app root.
TestSetupTrait::$siteDirectory protected property The site directory of this test run.
TestSetupTrait::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 1
TestSetupTrait::$tempFilesDirectory protected property The temporary file directory for the test environment.
TestSetupTrait::$testId protected property The test run ID.
TestSetupTrait::changeDatabasePrefix protected function Changes the database connection to the prefixed one.
TestSetupTrait::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
TestSetupTrait::getDatabaseConnection public static function Returns the database connection to the site running Simpletest.
TestSetupTrait::prepareDatabasePrefix protected function Generates a database prefix for running tests. 1
UiHelperTrait::$loggedInUser protected property The current user logged in using the Mink controlled browser.
UiHelperTrait::$maximumMetaRefreshCount protected property The number of meta refresh redirects to follow, or NULL if unlimited.
UiHelperTrait::$metaRefreshCount protected property The number of meta refresh redirects followed during ::drupalGet().
UiHelperTrait::assertSession public function Returns WebAssert object. 1
UiHelperTrait::buildUrl protected function Builds an absolute URL from a system path or a URL object.
UiHelperTrait::checkForMetaRefresh protected function Checks for meta refresh tag and if found call drupalGet() recursively.
UiHelperTrait::click protected function Clicks the element with the given CSS selector.
UiHelperTrait::clickLink protected function Follows a link by complete name.
UiHelperTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
UiHelperTrait::cssSelectToXpath protected function Translates a CSS expression to its XPath equivalent.
UiHelperTrait::drupalGet protected function Retrieves a Drupal path or an absolute path. 2
UiHelperTrait::drupalLogin protected function Logs in a user using the Mink controlled browser.
UiHelperTrait::drupalLogout protected function Logs a user out of the Mink controlled browser and confirms.
UiHelperTrait::drupalPostForm Deprecated protected function Executes a form submission.
UiHelperTrait::drupalUserIsLoggedIn protected function Returns whether a given user account is logged in.
UiHelperTrait::getAbsoluteUrl protected function Takes a path and returns an absolute path.
UiHelperTrait::getTextContent protected function Retrieves the plain-text content from the current page.
UiHelperTrait::getUrl protected function Get the current URL from the browser.
UiHelperTrait::isTestUsingGuzzleClient protected function Determines if test is using DrupalTestBrowser.
UiHelperTrait::prepareRequest protected function Prepare for a request to testing site. 1
UiHelperTrait::submitForm protected function Fills and submits a form.
UserCreationTrait::checkPermissions protected function Checks whether a given list of permission names is valid.
UserCreationTrait::createAdminRole protected function Creates an administrative role.
UserCreationTrait::createRole protected function Creates a role with specified permissions. Aliased as: drupalCreateRole
UserCreationTrait::createUser protected function Create a user with a given set of permissions. Aliased as: drupalCreateUser
UserCreationTrait::grantPermissions protected function Grant permissions to a user role.
UserCreationTrait::setCurrentUser protected function Switch the current logged in user.
UserCreationTrait::setUpCurrentUser protected function Creates a random user account and sets it as current user.
XdebugRequestTrait::extractCookiesFromRequest protected function Adds xdebug cookies, from request setup.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.