View source
<?php
namespace Drupal\Tests\comment\Functional;
use Drupal\comment\CommentManagerInterface;
use Drupal\Component\Render\FormattableMarkup;
use Drupal\node\Entity\Node;
class CommentPagerTest extends CommentTestBase {
protected $defaultTheme = 'classy';
public function testCommentPaging() {
$this
->drupalLogin($this->adminUser);
$this
->setCommentForm(TRUE);
$this
->setCommentSubject(TRUE);
$this
->setCommentPreview(DRUPAL_DISABLED);
$node = $this
->drupalCreateNode([
'type' => 'article',
'promote' => 1,
]);
$comments = [];
$comments[] = $this
->postComment($node, $this
->randomMachineName(), $this
->randomMachineName(), TRUE);
$comments[] = $this
->postComment($node, $this
->randomMachineName(), $this
->randomMachineName(), TRUE);
$comments[] = $this
->postComment($node, $this
->randomMachineName(), $this
->randomMachineName(), TRUE);
$this
->setCommentSettings('default_mode', CommentManagerInterface::COMMENT_MODE_FLAT, 'Comment paging changed.');
$this
->setCommentsPerPage(1);
$this
->drupalGet('node/' . $node
->id());
$this
->assertSession()
->pageTextContains('next');
$this
->assertTrue($this
->commentExists($comments[0]), 'Comment 1 appears on page 1.');
$this
->assertFalse($this
->commentExists($comments[1]), 'Comment 2 does not appear on page 1.');
$this
->assertFalse($this
->commentExists($comments[2]), 'Comment 3 does not appear on page 1.');
$this
->drupalGet('node/' . $node
->id(), [
'query' => [
'page' => 1,
],
]);
$this
->assertTrue($this
->commentExists($comments[1]), 'Comment 2 appears on page 2.');
$this
->assertFalse($this
->commentExists($comments[0]), 'Comment 1 does not appear on page 2.');
$this
->assertFalse($this
->commentExists($comments[2]), 'Comment 3 does not appear on page 2.');
$this
->drupalGet('node/' . $node
->id(), [
'query' => [
'page' => 2,
],
]);
$this
->assertTrue($this
->commentExists($comments[2]), 'Comment 3 appears on page 3.');
$this
->assertFalse($this
->commentExists($comments[0]), 'Comment 1 does not appear on page 3.');
$this
->assertFalse($this
->commentExists($comments[1]), 'Comment 2 does not appear on page 3.');
$oldest_comment = reset($comments);
$this
->drupalGet('comment/reply/node/' . $node
->id() . '/comment/' . $oldest_comment
->id());
$reply = $this
->postComment(NULL, $this
->randomMachineName(), $this
->randomMachineName(), TRUE);
$this
->setCommentsPerPage(2);
$this
->drupalGet('node/' . $node
->id(), [
'query' => [
'page' => 0,
],
]);
$this
->assertFalse($this
->commentExists($reply, TRUE), 'In flat mode, reply does not appear on page 1.');
$this
->setCommentSettings('default_mode', CommentManagerInterface::COMMENT_MODE_THREADED, 'Switched to threaded mode.');
$this
->drupalGet('node/' . $node
->id(), [
'query' => [
'page' => 0,
],
]);
$this
->assertTrue($this
->commentExists($reply, TRUE), 'In threaded mode, reply appears on page 1.');
$this
->assertFalse($this
->commentExists($comments[1]), 'In threaded mode, comment 2 has been bumped off of page 1.');
$reply2 = $this
->postComment(NULL, $this
->randomMachineName(), $this
->randomMachineName(), TRUE);
$this
->drupalGet('node/' . $node
->id(), [
'query' => [
'page' => 0,
],
]);
$this
->assertFalse($this
->commentExists($reply2, TRUE), 'In threaded mode where # replies > # comments per page, the newest reply does not appear on page 1.');
$this
->setCommentsPerPage(0);
$this
->drupalGet('node/' . $node
->id(), [
'query' => [
'page' => 0,
],
]);
$this
->assertFalse($this
->commentExists($reply2, TRUE), 'Threaded mode works correctly when comments per page is 0.');
$this
->drupalLogout();
}
public function testCommentPermalink() {
$this
->drupalLogin($this->adminUser);
$this
->setCommentForm(TRUE);
$this
->setCommentSubject(TRUE);
$this
->setCommentPreview(DRUPAL_DISABLED);
$node = $this
->drupalCreateNode([
'type' => 'article',
'promote' => 1,
]);
$comments = [];
$comments[] = $this
->postComment($node, 'comment 1: ' . $this
->randomMachineName(), $this
->randomMachineName(), TRUE);
$comments[] = $this
->postComment($node, 'comment 2: ' . $this
->randomMachineName(), $this
->randomMachineName(), TRUE);
$comments[] = $this
->postComment($node, 'comment 3: ' . $this
->randomMachineName(), $this
->randomMachineName(), TRUE);
$this
->setCommentSettings('default_mode', CommentManagerInterface::COMMENT_MODE_FLAT, 'Comment paging changed.');
$this
->setCommentsPerPage(1);
foreach ($comments as $index => $comment) {
$this
->drupalGet($comment
->toUrl());
$this
->assertTrue($this
->commentExists($comment), sprintf('Comment %d appears on page %d.', $index + 1, $index + 1));
}
}
public function testCommentOrderingThreading() {
$this
->drupalLogin($this->adminUser);
$this
->setCommentForm(TRUE);
$this
->setCommentSubject(TRUE);
$this
->setCommentPreview(DRUPAL_DISABLED);
$this
->setCommentsPerPage(1000);
$node = $this
->drupalCreateNode([
'type' => 'article',
'promote' => 1,
]);
$comments = [];
$comments[] = $this
->postComment($node, $this
->randomMachineName(), $this
->randomMachineName(), TRUE);
$comments[] = $this
->postComment($node, $this
->randomMachineName(), $this
->randomMachineName(), TRUE);
$comments[] = $this
->postComment($node, $this
->randomMachineName(), $this
->randomMachineName(), TRUE);
$this
->drupalGet('comment/reply/node/' . $node
->id() . '/comment/' . $comments[1]
->id());
$comments[] = $this
->postComment(NULL, $this
->randomMachineName(), $this
->randomMachineName(), TRUE);
$this
->drupalGet('comment/reply/node/' . $node
->id() . '/comment/' . $comments[0]
->id());
$comments[] = $this
->postComment(NULL, $this
->randomMachineName(), $this
->randomMachineName(), TRUE);
$this
->drupalGet('comment/reply/node/' . $node
->id() . '/comment/' . $comments[2]
->id());
$comments[] = $this
->postComment(NULL, $this
->randomMachineName(), $this
->randomMachineName(), TRUE);
$this
->drupalGet('comment/reply/node/' . $node
->id() . '/comment/' . $comments[3]
->id());
$comments[] = $this
->postComment(NULL, $this
->randomMachineName(), $this
->randomMachineName(), TRUE);
$this
->setCommentSettings('default_mode', CommentManagerInterface::COMMENT_MODE_FLAT, 'Comment paging changed.');
$expected_order = [
0,
1,
2,
3,
4,
5,
6,
];
$this
->drupalGet('node/' . $node
->id());
$this
->assertCommentOrder($comments, $expected_order);
$this
->setCommentSettings('default_mode', CommentManagerInterface::COMMENT_MODE_THREADED, 'Switched to threaded mode.');
$expected_order = [
0,
4,
1,
3,
6,
2,
5,
];
$this
->drupalGet('node/' . $node
->id());
$this
->assertCommentOrder($comments, $expected_order);
}
public function assertCommentOrder(array $comments, array $expected_order) {
$expected_cids = [];
foreach ($expected_order as $key) {
$expected_cids[] = $comments[$key]
->id();
}
$comment_anchors = $this
->xpath('//article[starts-with(@id,"comment-")]');
$result_order = [];
foreach ($comment_anchors as $anchor) {
$result_order[] = substr($anchor
->getAttribute('id'), 8);
}
$this
->assertEquals($expected_cids, $result_order, new FormattableMarkup('Comment order: expected @expected, returned @returned.', [
'@expected' => implode(',', $expected_cids),
'@returned' => implode(',', $result_order),
]));
}
public function testCommentNewPageIndicator() {
$this
->drupalLogin($this->adminUser);
$this
->setCommentForm(TRUE);
$this
->setCommentSubject(TRUE);
$this
->setCommentPreview(DRUPAL_DISABLED);
$this
->setCommentsPerPage(1);
$node = $this
->drupalCreateNode([
'type' => 'article',
'promote' => 1,
]);
$comments = [];
$comments[] = $this
->postComment($node, $this
->randomMachineName(), $this
->randomMachineName(), TRUE);
$comments[] = $this
->postComment($node, $this
->randomMachineName(), $this
->randomMachineName(), TRUE);
$comments[] = $this
->postComment($node, $this
->randomMachineName(), $this
->randomMachineName(), TRUE);
$this
->drupalGet('comment/reply/node/' . $node
->id() . '/comment/' . $comments[1]
->id());
$comments[] = $this
->postComment(NULL, $this
->randomMachineName(), $this
->randomMachineName(), TRUE);
$this
->drupalGet('comment/reply/node/' . $node
->id() . '/comment/' . $comments[0]
->id());
$comments[] = $this
->postComment(NULL, $this
->randomMachineName(), $this
->randomMachineName(), TRUE);
$this
->drupalGet('comment/reply/node/' . $node
->id() . '/comment/' . $comments[2]
->id());
$comments[] = $this
->postComment(NULL, $this
->randomMachineName(), $this
->randomMachineName(), TRUE);
$this
->setCommentSettings('default_mode', CommentManagerInterface::COMMENT_MODE_FLAT, 'Comment paging changed.');
$expected_pages = [
1 => 5,
2 => 4,
3 => 3,
4 => 2,
5 => 1,
6 => 0,
];
$node = Node::load($node
->id());
foreach ($expected_pages as $new_replies => $expected_page) {
$returned_page = \Drupal::entityTypeManager()
->getStorage('comment')
->getNewCommentPageNumber($node
->get('comment')->comment_count, $new_replies, $node, 'comment');
$this
->assertSame($expected_page, $returned_page, new FormattableMarkup('Flat mode, @new replies: expected page @expected, returned page @returned.', [
'@new' => $new_replies,
'@expected' => $expected_page,
'@returned' => $returned_page,
]));
}
$this
->setCommentSettings('default_mode', CommentManagerInterface::COMMENT_MODE_THREADED, 'Switched to threaded mode.');
$expected_pages = [
1 => 5,
2 => 1,
3 => 1,
4 => 1,
5 => 1,
6 => 0,
];
\Drupal::entityTypeManager()
->getStorage('node')
->resetCache([
$node
->id(),
]);
$node = Node::load($node
->id());
foreach ($expected_pages as $new_replies => $expected_page) {
$returned_page = \Drupal::entityTypeManager()
->getStorage('comment')
->getNewCommentPageNumber($node
->get('comment')->comment_count, $new_replies, $node, 'comment');
$this
->assertEquals($expected_page, $returned_page, new FormattableMarkup('Threaded mode, @new replies: expected page @expected, returned page @returned.', [
'@new' => $new_replies,
'@expected' => $expected_page,
'@returned' => $returned_page,
]));
}
}
public function testTwoPagers() {
$this
->addDefaultCommentField('node', 'article', 'comment_2');
\Drupal::service('entity_display.repository')
->getViewDisplay('node', 'article')
->setComponent('comment_2', [
'label' => 'hidden',
'type' => 'comment_default',
'weight' => 30,
'settings' => [
'pager_id' => 1,
'view_mode' => 'default',
],
])
->save();
$account = $this
->drupalCreateUser([
'administer node display',
]);
$this
->drupalLogin($account);
$this
->drupalGet('admin/structure/types/manage/article/display');
$this
->assertSession()
->pageTextNotContains('Pager ID: 0');
$this
->assertSession()
->pageTextContains('Pager ID: 1');
$this
->submitForm([], 'comment_settings_edit');
$this
->submitForm([
'fields[comment][settings_edit_form][settings][pager_id]' => 2,
], 'Save');
$this
->assertSession()
->pageTextContains('Pager ID: 2');
$this
->submitForm([], 'comment_settings_edit');
$this
->submitForm([
'fields[comment][settings_edit_form][settings][pager_id]' => 0,
], 'Save');
$this
->assertSession()
->pageTextNotContains('Pager ID: 0');
$this
->drupalLogin($this->adminUser);
$node = $this
->drupalCreateNode([
'type' => 'article',
'promote' => 1,
'uid' => $this->webUser
->id(),
]);
$comments = [];
foreach ([
'comment',
'comment_2',
] as $field_name) {
$this
->setCommentForm(TRUE, $field_name);
$this
->setCommentPreview(DRUPAL_OPTIONAL, $field_name);
$this
->setCommentSettings('default_mode', CommentManagerInterface::COMMENT_MODE_FLAT, 'Comment paging changed.', $field_name);
$this
->setCommentsPerPage(1, $field_name);
for ($i = 0; $i < 3; $i++) {
$comment = t('Comment @count on field @field', [
'@count' => $i + 1,
'@field' => $field_name,
]);
$comments[] = $this
->postComment($node, $comment, $comment, TRUE, $field_name);
}
}
$this
->drupalGet('node/' . $node
->id());
$this
->assertSession()
->pageTextContains('next');
$this
->assertSession()
->pageTextContains('Comment 1 on field comment');
$this
->assertSession()
->pageTextContains('Comment 1 on field comment_2');
$this
->clickLinkWithXPath('//h3/a[normalize-space(text())=:label]/ancestor::section[1]//a[@rel="next"]', [
':label' => 'Comment 1 on field comment',
]);
$this
->assertSession()
->pageTextContains('Comment 2 on field comment');
$this
->assertSession()
->pageTextContains('Comment 1 on field comment_2');
$this
->drupalGet('node/' . $node
->id());
$this
->clickLinkWithXPath('//h3/a[normalize-space(text())=:label]/ancestor::section[1]//a[@rel="next"]', [
':label' => 'Comment 1 on field comment_2',
]);
$this
->assertSession()
->pageTextContains('Comment 1 on field comment');
$this
->assertSession()
->pageTextContains('Comment 2 on field comment_2');
$this
->clickLinkWithXPath('//h3/a[normalize-space(text())=:label]/ancestor::section[1]//a[@rel="next"]', [
':label' => 'Comment 1 on field comment',
]);
$this
->assertSession()
->pageTextContains('Comment 2 on field comment');
$this
->assertSession()
->pageTextContains('Comment 2 on field comment_2');
}
protected function clickLinkWithXPath($xpath, $arguments = [], $index = 0) {
$url_before = $this
->getUrl();
$urls = $this
->xpath($xpath, $arguments);
if (isset($urls[$index])) {
$url_target = $this
->getAbsoluteUrl($urls[$index]
->getAttribute('href'));
return $this
->drupalGet($url_target);
}
$this
->fail(new FormattableMarkup('Link %label does not exist on @url_before', [
'%label' => $xpath,
'@url_before' => $url_before,
]), 'Browser');
return FALSE;
}
}