BigPipeRegressionTest.php in Drupal 8

Namespace

Drupal\Tests\big_pipe\FunctionalJavascript

File

core/modules/big_pipe/tests/src/FunctionalJavascript/BigPipeRegressionTest.php

<?php

namespace Drupal\Tests\big_pipe\FunctionalJavascript;

use Drupal\big_pipe\Render\BigPipe;
use Drupal\big_pipe_regression_test\BigPipeRegressionTestController;
use Drupal\comment\CommentInterface;
use Drupal\comment\Entity\Comment;
use Drupal\comment\Plugin\Field\FieldType\CommentItemInterface;
use Drupal\comment\Tests\CommentTestTrait;
use Drupal\Core\Url;
use Drupal\editor\Entity\Editor;
use Drupal\filter\Entity\FilterFormat;
use Drupal\FunctionalJavascriptTests\WebDriverTestBase;
use Drupal\Tests\node\Traits\ContentTypeCreationTrait;
use Drupal\Tests\node\Traits\NodeCreationTrait;

/**
 * BigPipe regression tests.
 *
 * @group big_pipe
 */
class BigPipeRegressionTest extends WebDriverTestBase {
  use CommentTestTrait;
  use ContentTypeCreationTrait;
  use NodeCreationTrait;

  /**
   * {@inheritdoc}
   */
  public static $modules = [
    'big_pipe',
    'big_pipe_regression_test',
  ];

  /**
   * {@inheritdoc}
   */
  protected $defaultTheme = 'stark';

  /**
   * {@inheritdoc}
   */
  public function setUp() {
    parent::setUp();

    // Use the big_pipe_test_theme theme.
    $this->container
      ->get('theme_installer')
      ->install([
      'big_pipe_test_theme',
    ]);
    $this->container
      ->get('config.factory')
      ->getEditable('system.theme')
      ->set('default', 'big_pipe_test_theme')
      ->save();
  }

  /**
   * Ensure comment form works with history and big_pipe modules.
   *
   * @see https://www.drupal.org/node/2698811
   */
  public function testCommentForm_2698811() {
    $this
      ->assertTrue($this->container
      ->get('module_installer')
      ->install([
      'comment',
      'history',
      'ckeditor',
    ], TRUE), 'Installed modules.');

    // Ensure an `article` node type exists.
    $this
      ->createContentType([
      'type' => 'article',
    ]);
    $this
      ->addDefaultCommentField('node', 'article');

    // Enable CKEditor.
    $format = $this
      ->randomMachineName();
    FilterFormat::create([
      'format' => $format,
      'name' => $this
        ->randomString(),
      'weight' => 1,
      'filters' => [],
    ])
      ->save();
    $settings['toolbar']['rows'] = [
      [
        [
          'name' => 'Links',
          'items' => [
            'DrupalLink',
            'DrupalUnlink',
          ],
        ],
      ],
    ];
    $editor = Editor::create([
      'format' => $format,
      'editor' => 'ckeditor',
    ]);
    $editor
      ->setSettings($settings);
    $editor
      ->save();
    $admin_user = $this
      ->drupalCreateUser([
      'access comments',
      'post comments',
      'use text format ' . $format,
    ]);
    $this
      ->drupalLogin($admin_user);
    $node = $this
      ->createNode([
      'type' => 'article',
      'comment' => CommentItemInterface::OPEN,
    ]);

    // Create some comments.
    foreach (range(1, 5) as $i) {
      $comment = Comment::create([
        'status' => CommentInterface::PUBLISHED,
        'field_name' => 'comment',
        'entity_type' => 'node',
        'entity_id' => $node
          ->id(),
      ]);
      $comment
        ->save();
    }
    $this
      ->drupalGet($node
      ->toUrl()
      ->toString());

    // Confirm that CKEditor loaded.
    $javascript = <<<JS
    (function(){
      return Object.keys(CKEDITOR.instances).length > 0;
    }());
JS;
    $this
      ->assertJsCondition($javascript);
  }

  /**
   * Ensure BigPipe works despite inline JS containing the string "</body>".
   *
   * @see https://www.drupal.org/node/2678662
   */
  public function testMultipleClosingBodies_2678662() {
    $this
      ->assertTrue($this->container
      ->get('module_installer')
      ->install([
      'render_placeholder_message_test',
    ], TRUE), 'Installed modules.');
    $this
      ->drupalLogin($this
      ->drupalCreateUser());
    $this
      ->drupalGet(Url::fromRoute('big_pipe_regression_test.2678662'));

    // Confirm that AJAX behaviors were instantiated, if not, this points to a
    // JavaScript syntax error.
    $javascript = <<<JS
    (function(){
      return Object.keys(Drupal.ajax.instances).length > 0;
    }());
JS;
    $this
      ->assertJsCondition($javascript);

    // Besides verifying there is no JavaScript syntax error, also verify the
    // HTML structure.
    $this
      ->assertSession()
      ->responseContains(BigPipe::STOP_SIGNAL . "\n\n\n</body></html>", 'The BigPipe stop signal is present just before the closing </body> and </html> tags.');
    $js_code_until_closing_body_tag = substr(BigPipeRegressionTestController::MARKER_2678662, 0, strpos(BigPipeRegressionTestController::MARKER_2678662, '</body>'));
    $this
      ->assertSession()
      ->responseNotContains($js_code_until_closing_body_tag . "\n" . BigPipe::START_SIGNAL, 'The BigPipe start signal does NOT start at the closing </body> tag string in an inline script.');
  }

  /**
   * Ensure messages set in placeholders always appear.
   *
   * @see https://www.drupal.org/node/2712935
   */
  public function testMessages_2712935() {
    $this
      ->assertTrue($this->container
      ->get('module_installer')
      ->install([
      'render_placeholder_message_test',
    ], TRUE), 'Installed modules.');
    $this
      ->drupalLogin($this
      ->drupalCreateUser());
    $messages_markup = '<div role="contentinfo" aria-label="Status message"';
    $test_routes = [
      // Messages placeholder rendered first.
      'render_placeholder_message_test.first',
      // Messages placeholder rendered after one, before another.
      'render_placeholder_message_test.middle',
      // Messages placeholder rendered last.
      'render_placeholder_message_test.last',
    ];
    $assert = $this
      ->assertSession();
    foreach ($test_routes as $route) {

      // Verify that we start off with zero messages queued.
      $this
        ->drupalGet(Url::fromRoute('render_placeholder_message_test.queued'));
      $assert
        ->responseNotContains($messages_markup);

      // Verify the test case at this route behaves as expected.
      $this
        ->drupalGet(Url::fromRoute($route));
      $assert
        ->elementContains('css', 'p.logged-message:nth-of-type(1)', 'Message: P1');
      $assert
        ->elementContains('css', 'p.logged-message:nth-of-type(2)', 'Message: P2');
      $assert
        ->responseContains($messages_markup);
      $assert
        ->elementExists('css', 'div[aria-label="Status message"] ul');
      $assert
        ->elementContains('css', 'div[aria-label="Status message"] ul li:nth-of-type(1)', 'P1');
      $assert
        ->elementContains('css', 'div[aria-label="Status message"] ul li:nth-of-type(2)', 'P2');

      // Verify that we end with all messages printed, hence again zero queued.
      $this
        ->drupalGet(Url::fromRoute('render_placeholder_message_test.queued'));
      $assert
        ->responseNotContains($messages_markup);
    }
  }

  /**
   * Ensure default BigPipe placeholder HTML cannot split paragraphs.
   *
   * @see https://www.drupal.org/node/2802923
   */
  public function testPlaceholderInParagraph_2802923() {
    $this
      ->drupalLogin($this
      ->drupalCreateUser());
    $this
      ->drupalGet(Url::fromRoute('big_pipe_regression_test.2802923'));
    $this
      ->assertJsCondition('document.querySelectorAll(\'p\').length === 1');
  }

}

Classes

Name	Description
BigPipeRegressionTest	BigPipe regression tests.