class BigPipeStrategyTest

Same name and namespace in other branches
  1. 9 core/modules/big_pipe/tests/src/Unit/Render/Placeholder/BigPipeStrategyTest.php \Drupal\Tests\big_pipe\Unit\Render\Placeholder\BigPipeStrategyTest
  2. 8.9.x core/modules/big_pipe/tests/src/Unit/Render/Placeholder/BigPipeStrategyTest.php \Drupal\Tests\big_pipe\Unit\Render\Placeholder\BigPipeStrategyTest
  3. 10 core/modules/big_pipe/tests/src/Unit/Render/Placeholder/BigPipeStrategyTest.php \Drupal\Tests\big_pipe\Unit\Render\Placeholder\BigPipeStrategyTest

@coversDefaultClass \Drupal\big_pipe\Render\Placeholder\BigPipeStrategy @group big_pipe

Hierarchy

Expanded class hierarchy of BigPipeStrategyTest

File

core/modules/big_pipe/tests/src/Unit/Render/Placeholder/BigPipeStrategyTest.php, line 21

Namespace

Drupal\Tests\big_pipe\Unit\Render\Placeholder
View source 
class BigPipeStrategyTest extends UnitTestCase {
    
    /**
     * @covers ::processPlaceholders
     *
     * @dataProvider placeholdersProvider
     */
    public function testProcessPlaceholders(array $placeholders, $method, $route_match_has_no_big_pipe_option, $request_has_session, $request_has_big_pipe_nojs_cookie, array $expected_big_pipe_placeholders) : void {
        $request = new Request();
        $request->setMethod($method);
        if ($request_has_big_pipe_nojs_cookie) {
            $request->cookies
                ->set(BigPipeStrategy::NOJS_COOKIE, 1);
        }
        $request_stack = $this->prophesize(RequestStack::class);
        $request_stack->getCurrentRequest()
            ->willReturn($request);
        $session_configuration = $this->prophesize(SessionConfigurationInterface::class);
        $session_configuration->hasSession(Argument::type(Request::class))
            ->willReturn($request_has_session);
        $route = $this->prophesize(Route::class);
        $route->getOption('_no_big_pipe')
            ->willReturn($route_match_has_no_big_pipe_option);
        $route_match = $this->prophesize(RouteMatchInterface::class);
        $route_match->getRouteObject()
            ->willReturn($route);
        $big_pipe_strategy = new BigPipeStrategy($session_configuration->reveal(), $request_stack->reveal(), $route_match->reveal());
        $processed_placeholders = $big_pipe_strategy->processPlaceholders($placeholders);
        if ($request->isMethodCacheable() && !$route_match_has_no_big_pipe_option && $request_has_session) {
            $this->assertSameSize($expected_big_pipe_placeholders, $processed_placeholders, 'BigPipe is able to deliver all placeholders.');
            foreach (array_keys($placeholders) as $placeholder) {
                $this->assertSame($expected_big_pipe_placeholders[$placeholder], $processed_placeholders[$placeholder], "Verifying how BigPipeStrategy handles the placeholder '{$placeholder}'");
            }
        }
        else {
            $this->assertCount(0, $processed_placeholders);
        }
    }
    
    /**
     * @see \Drupal\big_pipe_test\BigPipePlaceholderTestCases
     */
    public static function placeholdersProvider() {
        $cases = BigPipePlaceholderTestCases::cases();
        // Generate $placeholders variable as expected by
        // \Drupal\Core\Render\Placeholder\PlaceholderStrategyInterface::processPlaceholders().
        $placeholders = [
            $cases['html']->placeholder => $cases['html']->placeholderRenderArray,
            $cases['html_attribute_value']->placeholder => $cases['html_attribute_value']->placeholderRenderArray,
            $cases['html_attribute_value_subset']->placeholder => $cases['html_attribute_value_subset']->placeholderRenderArray,
            $cases['edge_case__invalid_html']->placeholder => $cases['edge_case__invalid_html']->placeholderRenderArray,
            $cases['edge_case__html_non_lazy_builder']->placeholder => $cases['edge_case__html_non_lazy_builder']->placeholderRenderArray,
            $cases['exception__lazy_builder']->placeholder => $cases['exception__lazy_builder']->placeholderRenderArray,
            $cases['exception__embedded_response']->placeholder => $cases['exception__embedded_response']->placeholderRenderArray,
        ];
        return [
            '_no_big_pipe absent, no session, no-JS cookie absent' => [
                $placeholders,
                'GET',
                FALSE,
                FALSE,
                FALSE,
                [],
            ],
            '_no_big_pipe absent, no session, no-JS cookie present' => [
                $placeholders,
                'GET',
                FALSE,
                FALSE,
                TRUE,
                [],
            ],
            '_no_big_pipe present, no session, no-JS cookie absent' => [
                $placeholders,
                'GET',
                TRUE,
                FALSE,
                FALSE,
                [],
            ],
            '_no_big_pipe present, no session, no-JS cookie present' => [
                $placeholders,
                'GET',
                TRUE,
                FALSE,
                TRUE,
                [],
            ],
            '_no_big_pipe present, session, no-JS cookie absent' => [
                $placeholders,
                'GET',
                TRUE,
                TRUE,
                FALSE,
                [],
            ],
            '_no_big_pipe present, session, no-JS cookie present' => [
                $placeholders,
                'GET',
                TRUE,
                TRUE,
                TRUE,
                [],
            ],
            '_no_big_pipe absent, session, no-JS cookie absent: (JS-powered) BigPipe placeholder used for HTML placeholders' => [
                $placeholders,
                'GET',
                FALSE,
                TRUE,
                FALSE,
                [
                    $cases['html']->placeholder => $cases['html']->bigPipePlaceholderRenderArray,
                    $cases['html_attribute_value']->placeholder => $cases['html_attribute_value']->bigPipeNoJsPlaceholderRenderArray,
                    $cases['html_attribute_value_subset']->placeholder => $cases['html_attribute_value_subset']->bigPipeNoJsPlaceholderRenderArray,
                    $cases['edge_case__invalid_html']->placeholder => $cases['edge_case__invalid_html']->bigPipeNoJsPlaceholderRenderArray,
                    $cases['edge_case__html_non_lazy_builder']->placeholder => $cases['edge_case__html_non_lazy_builder']->bigPipePlaceholderRenderArray,
                    $cases['exception__lazy_builder']->placeholder => $cases['exception__lazy_builder']->bigPipePlaceholderRenderArray,
                    $cases['exception__embedded_response']->placeholder => $cases['exception__embedded_response']->bigPipePlaceholderRenderArray,
                ],
            ],
            '_no_big_pipe absent, session, no-JS cookie absent: (JS-powered) BigPipe placeholder used for HTML placeholders — but unsafe method' => [
                $placeholders,
                'POST',
                FALSE,
                TRUE,
                FALSE,
                [],
            ],
            '_no_big_pipe absent, session, no-JS cookie present: no-JS BigPipe placeholder used for HTML placeholders' => [
                $placeholders,
                'GET',
                FALSE,
                TRUE,
                TRUE,
                [
                    $cases['html']->placeholder => $cases['html']->bigPipeNoJsPlaceholderRenderArray,
                    $cases['html_attribute_value']->placeholder => $cases['html_attribute_value']->bigPipeNoJsPlaceholderRenderArray,
                    $cases['html_attribute_value_subset']->placeholder => $cases['html_attribute_value_subset']->bigPipeNoJsPlaceholderRenderArray,
                    $cases['edge_case__invalid_html']->placeholder => $cases['edge_case__invalid_html']->bigPipeNoJsPlaceholderRenderArray,
                    $cases['edge_case__html_non_lazy_builder']->placeholder => $cases['edge_case__html_non_lazy_builder']->bigPipeNoJsPlaceholderRenderArray,
                    $cases['exception__lazy_builder']->placeholder => $cases['exception__lazy_builder']->bigPipeNoJsPlaceholderRenderArray,
                    $cases['exception__embedded_response']->placeholder => $cases['exception__embedded_response']->bigPipeNoJsPlaceholderRenderArray,
                ],
            ],
            '_no_big_pipe absent, session, no-JS cookie present: no-JS BigPipe placeholder used for HTML placeholders — but unsafe method' => [
                $placeholders,
                'POST',
                FALSE,
                TRUE,
                TRUE,
                [],
            ],
        ];
    }

}

Members

Title Modifiers Object type Summary Overrides
BigPipeStrategyTest::placeholdersProvider public static function
BigPipeStrategyTest::testProcessPlaceholders public function @covers ::processPlaceholders
ExpectDeprecationTrait::expectDeprecation public function Adds an expected deprecation.
ExpectDeprecationTrait::getCallableName private static function Returns a callable as a string suitable for inclusion in a message.
ExpectDeprecationTrait::setUpErrorHandler public function Sets up the test error handler.
ExpectDeprecationTrait::tearDownErrorHandler public function Tears down the test error handler.
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.
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.
UnitTestCase::$root protected property The app root.
UnitTestCase::getClassResolverStub protected function Returns a stub class resolver.
UnitTestCase::getConfigFactoryStub public function Returns a stub config factory that behaves according to the passed array.
UnitTestCase::getConfigStorageStub public function Returns a stub config storage that returns the supplied configuration.
UnitTestCase::getContainerWithCacheTagsInvalidator protected function Sets up a container with a cache tags invalidator.
UnitTestCase::getStringTranslationStub public function Returns a stub translation manager that just returns the passed string.
UnitTestCase::setUp protected function 354
UnitTestCase::setUpBeforeClass public static function

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