www.aleph1.co.uk Git - yaffs-website/blob - web/core/modules/big_pipe/tests/src/Unit/Render/Placeholder/BigPipeStrategyTest.php

   1 <?php
   2
   3 namespace Drupal\Tests\big_pipe\Unit\Render\Placeholder;
   4
   5 use Drupal\big_pipe\Render\Placeholder\BigPipeStrategy;
   6 use Drupal\big_pipe_test\BigPipePlaceholderTestCases;
   7 use Drupal\Core\Routing\RouteMatchInterface;
   8 use Drupal\Core\Session\SessionConfigurationInterface;
   9 use Drupal\Tests\UnitTestCase;
  10 use Prophecy\Argument;
  11 use Symfony\Component\HttpFoundation\Request;
  12 use Symfony\Component\HttpFoundation\RequestStack;
  13 use Symfony\Component\Routing\Route;
  14
  15 /**
  16  * @coversDefaultClass \Drupal\big_pipe\Render\Placeholder\BigPipeStrategy
  17  * @group big_pipe
  18  */
  19 class BigPipeStrategyTest extends UnitTestCase {
  20
  21   /**
  22    * @covers ::processPlaceholders
  23    *
  24    * @dataProvider placeholdersProvider
  25    */
  26   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) {
  27     $request = new Request();
  28     $request->setMethod($method);
  29     if ($request_has_big_pipe_nojs_cookie) {
  30       $request->cookies->set(BigPipeStrategy::NOJS_COOKIE, 1);
  31     }
  32     $request_stack = $this->prophesize(RequestStack::class);
  33     $request_stack->getCurrentRequest()
  34       ->willReturn($request);
  35
  36     $session_configuration = $this->prophesize(SessionConfigurationInterface::class);
  37     $session_configuration->hasSession(Argument::type(Request::class))
  38       ->willReturn($request_has_session);
  39
  40     $route = $this->prophesize(Route::class);
  41     $route->getOption('_no_big_pipe')
  42       ->willReturn($route_match_has_no_big_pipe_option);
  43     $route_match = $this->prophesize(RouteMatchInterface::class);
  44     $route_match->getRouteObject()
  45       ->willReturn($route);
  46
  47     $big_pipe_strategy = new BigPipeStrategy($session_configuration->reveal(), $request_stack->reveal(), $route_match->reveal());
  48     $processed_placeholders = $big_pipe_strategy->processPlaceholders($placeholders);
  49
  50     if ($request->isMethodCacheable() && !$route_match_has_no_big_pipe_option && $request_has_session) {
  51       $this->assertSameSize($expected_big_pipe_placeholders, $processed_placeholders, 'BigPipe is able to deliver all placeholders.');
  52       foreach (array_keys($placeholders) as $placeholder) {
  53         $this->assertSame($expected_big_pipe_placeholders[$placeholder], $processed_placeholders[$placeholder], "Verifying how BigPipeStrategy handles the placeholder '$placeholder'");
  54       }
  55     }
  56     else {
  57       $this->assertSame(0, count($processed_placeholders));
  58     }
  59   }
  60
  61   /**
  62    * @see \Drupal\big_pipe_test\BigPipePlaceholderTestCases
  63    */
  64   public function placeholdersProvider() {
  65     $cases = BigPipePlaceholderTestCases::cases();
  66
  67     // Generate $placeholders variable as expected by
  68     // \Drupal\Core\Render\Placeholder\PlaceholderStrategyInterface::processPlaceholders().
  69     $placeholders = [
  70       $cases['html']->placeholder                             => $cases['html']->placeholderRenderArray,
  71       $cases['html_attribute_value']->placeholder             => $cases['html_attribute_value']->placeholderRenderArray,
  72       $cases['html_attribute_value_subset']->placeholder      => $cases['html_attribute_value_subset']->placeholderRenderArray,
  73       $cases['edge_case__invalid_html']->placeholder          => $cases['edge_case__invalid_html']->placeholderRenderArray,
  74       $cases['edge_case__html_non_lazy_builder']->placeholder => $cases['edge_case__html_non_lazy_builder']->placeholderRenderArray,
  75       $cases['exception__lazy_builder']->placeholder          => $cases['exception__lazy_builder']->placeholderRenderArray,
  76       $cases['exception__embedded_response']->placeholder     => $cases['exception__embedded_response']->placeholderRenderArray,
  77     ];
  78
  79     return [
  80       '_no_big_pipe absent, no session, no-JS cookie absent' => [$placeholders, 'GET', FALSE, FALSE, FALSE, []],
  81       '_no_big_pipe absent, no session, no-JS cookie present' => [$placeholders, 'GET', FALSE, FALSE, TRUE, []],
  82       '_no_big_pipe present, no session, no-JS cookie absent' => [$placeholders, 'GET', TRUE, FALSE, FALSE, []],
  83       '_no_big_pipe present, no session, no-JS cookie present' => [$placeholders, 'GET', TRUE, FALSE, TRUE, []],
  84       '_no_big_pipe present, session, no-JS cookie absent' => [$placeholders, 'GET', TRUE, TRUE, FALSE, []],
  85       '_no_big_pipe present, session, no-JS cookie present' => [$placeholders, 'GET', TRUE, TRUE, TRUE, []],
  86       '_no_big_pipe absent, session, no-JS cookie absent: (JS-powered) BigPipe placeholder used for HTML placeholders' => [
  87         $placeholders, 'GET', FALSE, TRUE, FALSE, [
  88           $cases['html']->placeholder                             => $cases['html']->bigPipePlaceholderRenderArray,
  89           $cases['html_attribute_value']->placeholder             => $cases['html_attribute_value']->bigPipeNoJsPlaceholderRenderArray,
  90           $cases['html_attribute_value_subset']->placeholder      => $cases['html_attribute_value_subset']->bigPipeNoJsPlaceholderRenderArray,
  91           $cases['edge_case__invalid_html']->placeholder          => $cases['edge_case__invalid_html']->bigPipeNoJsPlaceholderRenderArray,
  92           $cases['edge_case__html_non_lazy_builder']->placeholder => $cases['edge_case__html_non_lazy_builder']->bigPipePlaceholderRenderArray,
  93           $cases['exception__lazy_builder']->placeholder          => $cases['exception__lazy_builder']->bigPipePlaceholderRenderArray,
  94           $cases['exception__embedded_response']->placeholder     => $cases['exception__embedded_response']->bigPipePlaceholderRenderArray,
  95         ],
  96       ],
  97       '_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, []],
  98       '_no_big_pipe absent, session, no-JS cookie present: no-JS BigPipe placeholder used for HTML placeholders' => [
  99         $placeholders, 'GET', FALSE, TRUE, TRUE, [
 100           $cases['html']->placeholder                             => $cases['html']->bigPipeNoJsPlaceholderRenderArray,
 101           $cases['html_attribute_value']->placeholder             => $cases['html_attribute_value']->bigPipeNoJsPlaceholderRenderArray,
 102           $cases['html_attribute_value_subset']->placeholder      => $cases['html_attribute_value_subset']->bigPipeNoJsPlaceholderRenderArray,
 103           $cases['edge_case__invalid_html']->placeholder          => $cases['edge_case__invalid_html']->bigPipeNoJsPlaceholderRenderArray,
 104           $cases['edge_case__html_non_lazy_builder']->placeholder => $cases['edge_case__html_non_lazy_builder']->bigPipeNoJsPlaceholderRenderArray,
 105           $cases['exception__lazy_builder']->placeholder          => $cases['exception__lazy_builder']->bigPipeNoJsPlaceholderRenderArray,
 106           $cases['exception__embedded_response']->placeholder     => $cases['exception__embedded_response']->bigPipeNoJsPlaceholderRenderArray,
 107         ],
 108       ],
 109       '_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, []],
 110     ];
 111   }
 112
 113 }