CommentPagerTest.php 17 KB
Newer Older
1
2
3
4
<?php

/**
 * @file
5
 * Contains \Drupal\comment\Tests\CommentPagerTest.
6
7
8
9
 */

namespace Drupal\comment\Tests;

10
use Drupal\comment\CommentManagerInterface;
11
use Drupal\Component\Utility\SafeMarkup;
12
use Drupal\node\Entity\Node;
13

14
/**
15
16
17
 * Tests paging of comments and their settings.
 *
 * @group comment
18
19
20
21
22
23
 */
class CommentPagerTest extends CommentTestBase {
  /**
   * Confirms comment paging works correctly with flat and threaded comments.
   */
  function testCommentPaging() {
24
    $this->drupalLogin($this->adminUser);
25
26
27
28
29
30
31
32
33

    // Set comment variables.
    $this->setCommentForm(TRUE);
    $this->setCommentSubject(TRUE);
    $this->setCommentPreview(DRUPAL_DISABLED);

    // Create a node and three comments.
    $node = $this->drupalCreateNode(array('type' => 'article', 'promote' => 1));
    $comments = array();
34
35
36
    $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);
37

38
    $this->setCommentSettings('default_mode', CommentManagerInterface::COMMENT_MODE_FLAT, 'Comment paging changed.');
39
40
41
42
43
44
45

    // Set comments to one per page so that we are able to test paging without
    // needing to insert large numbers of comments.
    $this->setCommentsPerPage(1);

    // Check the first page of the node, and confirm the correct comments are
    // shown.
46
    $this->drupalGet('node/' . $node->id());
47
48
49
50
    $this->assertRaw(t('next'), 'Paging links found.');
    $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.');
51
52

    // Check the second page.
53
    $this->drupalGet('node/' . $node->id(), array('query' => array('page' => 1)));
54
55
56
    $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.');
57
58

    // Check the third page.
59
    $this->drupalGet('node/' . $node->id(), array('query' => array('page' => 2)));
60
61
62
    $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.');
63
64
65

    // Post a reply to the oldest comment and test again.
    $oldest_comment = reset($comments);
66
    $this->drupalGet('comment/reply/node/' . $node->id() . '/comment/' . $oldest_comment->id());
67
    $reply = $this->postComment(NULL, $this->randomMachineName(), $this->randomMachineName(), TRUE);
68
69
70
71

    $this->setCommentsPerPage(2);
    // We are still in flat view - the replies should not be on the first page,
    // even though they are replies to the oldest comment.
72
    $this->drupalGet('node/' . $node->id(), array('query' => array('page' => 0)));
73
    $this->assertFalse($this->commentExists($reply, TRUE), 'In flat mode, reply does not appear on page 1.');
74
75
76
77

    // If we switch to threaded mode, the replies on the oldest comment
    // should be bumped to the first page and comment 6 should be bumped
    // to the second page.
78
    $this->setCommentSettings('default_mode', CommentManagerInterface::COMMENT_MODE_THREADED, 'Switched to threaded mode.');
79
    $this->drupalGet('node/' . $node->id(), array('query' => array('page' => 0)));
80
81
    $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.');
82
83
84

    // If (# replies > # comments per page) in threaded expanded view,
    // the overage should be bumped.
85
    $reply2 = $this->postComment(NULL, $this->randomMachineName(), $this->randomMachineName(), TRUE);
86
    $this->drupalGet('node/' . $node->id(), array('query' => array('page' => 0)));
87
    $this->assertFalse($this->commentExists($reply2, TRUE), 'In threaded mode where # replies > # comments per page, the newest reply does not appear on page 1.');
88

89
90
91
92
93
94
    // Test that the page build process does not somehow generate errors when
    // # comments per page is set to 0.
    $this->setCommentsPerPage(0);
    $this->drupalGet('node/' . $node->id(), array('query' => array('page' => 0)));
    $this->assertFalse($this->commentExists($reply2, TRUE), 'Threaded mode works correctly when comments per page is 0.');

95
96
97
98
99
100
101
    $this->drupalLogout();
  }

  /**
   * Tests comment ordering and threading.
   */
  function testCommentOrderingThreading() {
102
    $this->drupalLogin($this->adminUser);
103
104
105
106
107
108
109
110
111
112
113
114

    // Set comment variables.
    $this->setCommentForm(TRUE);
    $this->setCommentSubject(TRUE);
    $this->setCommentPreview(DRUPAL_DISABLED);

    // Display all the comments on the same page.
    $this->setCommentsPerPage(1000);

    // Create a node and three comments.
    $node = $this->drupalCreateNode(array('type' => 'article', 'promote' => 1));
    $comments = array();
115
116
117
    $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);
118
119

    // Post a reply to the second comment.
120
    $this->drupalGet('comment/reply/node/' . $node->id() . '/comment/' . $comments[1]->id());
121
    $comments[] = $this->postComment(NULL, $this->randomMachineName(), $this->randomMachineName(), TRUE);
122
123

    // Post a reply to the first comment.
124
    $this->drupalGet('comment/reply/node/' . $node->id() . '/comment/' . $comments[0]->id());
125
    $comments[] = $this->postComment(NULL, $this->randomMachineName(), $this->randomMachineName(), TRUE);
126
127

    // Post a reply to the last comment.
128
    $this->drupalGet('comment/reply/node/' . $node->id() . '/comment/' . $comments[2]->id());
129
    $comments[] = $this->postComment(NULL, $this->randomMachineName(), $this->randomMachineName(), TRUE);
130
131

    // Post a reply to the second comment.
132
    $this->drupalGet('comment/reply/node/' . $node->id() . '/comment/' . $comments[3]->id());
133
    $comments[] = $this->postComment(NULL, $this->randomMachineName(), $this->randomMachineName(), TRUE);
134
135
136
137
138
139
140
141
142
143

    // At this point, the comment tree is:
    // - 0
    //   - 4
    // - 1
    //   - 3
    //     - 6
    // - 2
    //   - 5

144
    $this->setCommentSettings('default_mode', CommentManagerInterface::COMMENT_MODE_FLAT, 'Comment paging changed.');
145
146
147
148
149
150
151
152
153
154

    $expected_order = array(
      0,
      1,
      2,
      3,
      4,
      5,
      6,
    );
155
    $this->drupalGet('node/' . $node->id());
156
157
    $this->assertCommentOrder($comments, $expected_order);

158
    $this->setCommentSettings('default_mode', CommentManagerInterface::COMMENT_MODE_THREADED, 'Switched to threaded mode.');
159
160
161
162
163
164
165
166
167
168

    $expected_order = array(
      0,
      4,
      1,
      3,
      6,
      2,
      5,
    );
169
    $this->drupalGet('node/' . $node->id());
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
    $this->assertCommentOrder($comments, $expected_order);
  }

  /**
   * Asserts that the comments are displayed in the correct order.
   *
   * @param $comments
   *   And array of comments.
   * @param $expected_order
   *   An array of keys from $comments describing the expected order.
   */
  function assertCommentOrder(array $comments, array $expected_order) {
    $expected_cids = array();

    // First, rekey the expected order by cid.
    foreach ($expected_order as $key) {
186
      $expected_cids[] = $comments[$key]->id();
187
188
189
190
191
192
193
    }

    $comment_anchors = $this->xpath('//a[starts-with(@id,"comment-")]');
    $result_order = array();
    foreach ($comment_anchors as $anchor) {
      $result_order[] = substr($anchor['id'], 8);
    }
194
    return $this->assertEqual($expected_cids, $result_order, format_string('Comment order: expected @expected, returned @returned.', array('@expected' => implode(',', $expected_cids), '@returned' => implode(',', $result_order))));
195
196
197
  }

  /**
198
   * Tests calculation of first page with new comment.
199
200
   */
  function testCommentNewPageIndicator() {
201
    $this->drupalLogin($this->adminUser);
202
203
204
205
206
207
208
209
210
211
212
213
214

    // Set comment variables.
    $this->setCommentForm(TRUE);
    $this->setCommentSubject(TRUE);
    $this->setCommentPreview(DRUPAL_DISABLED);

    // Set comments to one per page so that we are able to test paging without
    // needing to insert large numbers of comments.
    $this->setCommentsPerPage(1);

    // Create a node and three comments.
    $node = $this->drupalCreateNode(array('type' => 'article', 'promote' => 1));
    $comments = array();
215
216
217
    $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);
218
219

    // Post a reply to the second comment.
220
    $this->drupalGet('comment/reply/node/' . $node->id() . '/comment/' . $comments[1]->id());
221
    $comments[] = $this->postComment(NULL, $this->randomMachineName(), $this->randomMachineName(), TRUE);
222
223

    // Post a reply to the first comment.
224
    $this->drupalGet('comment/reply/node/' . $node->id() . '/comment/' . $comments[0]->id());
225
    $comments[] = $this->postComment(NULL, $this->randomMachineName(), $this->randomMachineName(), TRUE);
226
227

    // Post a reply to the last comment.
228
    $this->drupalGet('comment/reply/node/' . $node->id() . '/comment/' . $comments[2]->id());
229
    $comments[] = $this->postComment(NULL, $this->randomMachineName(), $this->randomMachineName(), TRUE);
230
231
232
233
234
235
236
237
238

    // At this point, the comment tree is:
    // - 0
    //   - 4
    // - 1
    //   - 3
    // - 2
    //   - 5

239
    $this->setCommentSettings('default_mode', CommentManagerInterface::COMMENT_MODE_FLAT, 'Comment paging changed.');
240
241
242
243
244
245
246
247
248
249

    $expected_pages = array(
      1 => 5, // Page of comment 5
      2 => 4, // Page of comment 4
      3 => 3, // Page of comment 3
      4 => 2, // Page of comment 2
      5 => 1, // Page of comment 1
      6 => 0, // Page of comment 0
    );

250
    $node = Node::load($node->id());
251
    foreach ($expected_pages as $new_replies => $expected_page) {
252
      $returned_page = \Drupal::entityManager()->getStorage('comment')
253
        ->getNewCommentPageNumber($node->get('comment')->comment_count, $new_replies, $node, 'comment');
254
      $this->assertIdentical($expected_page, $returned_page, format_string('Flat mode, @new replies: expected page @expected, returned page @returned.', array('@new' => $new_replies, '@expected' => $expected_page, '@returned' => $returned_page)));
255
256
    }

257
    $this->setCommentSettings('default_mode', CommentManagerInterface::COMMENT_MODE_THREADED, 'Switched to threaded mode.');
258
259
260
261
262
263
264
265
266
267

    $expected_pages = array(
      1 => 5, // Page of comment 5
      2 => 1, // Page of comment 4
      3 => 1, // Page of comment 4
      4 => 1, // Page of comment 4
      5 => 1, // Page of comment 4
      6 => 0, // Page of comment 0
    );

268
    \Drupal::entityManager()->getStorage('node')->resetCache(array($node->id()));
269
    $node = Node::load($node->id());
270
    foreach ($expected_pages as $new_replies => $expected_page) {
271
      $returned_page = \Drupal::entityManager()->getStorage('comment')
272
        ->getNewCommentPageNumber($node->get('comment')->comment_count, $new_replies, $node, 'comment');
273
      $this->assertEqual($expected_page, $returned_page, format_string('Threaded mode, @new replies: expected page @expected, returned page @returned.', array('@new' => $new_replies, '@expected' => $expected_page, '@returned' => $returned_page)));
274
275
    }
  }
276
277
278
279
280
281

  /**
   * Confirms comment paging works correctly with two pagers.
   */
  function testTwoPagers() {
    // Add another field to article content-type.
282
    $this->addDefaultCommentField('node', 'article', 'comment_2');
283
284
285
286
287
    // Set default to display comment list with unique pager id.
    entity_get_display('node', 'article', 'default')
      ->setComponent('comment_2', array(
        'label' => 'hidden',
        'type' => 'comment_default',
288
        'weight' => 30,
289
290
291
292
293
        'settings' => array(
          'pager_id' => 1,
        )
      ))
      ->save();
294
295
296
297
298
299
300
301
302
303
304

    // Make sure pager appears in formatter summary and settings form.
    $account = $this->drupalCreateUser(array('administer node display'));
    $this->drupalLogin($account);
    $this->drupalGet('admin/structure/types/manage/article/display');
    $this->assertNoText(t('Pager ID: @id', array('@id' => 0)), 'No summary for standard pager');
    $this->assertText(t('Pager ID: @id', array('@id' => 1)));
    $this->drupalPostAjaxForm(NULL, array(), 'comment_settings_edit');
    // Change default pager to 2.
    $this->drupalPostForm(NULL, array('fields[comment][settings_edit_form][settings][pager_id]' => 2), t('Save'));
    $this->assertText(t('Pager ID: @id', array('@id' => 2)));
305
    // Revert the changes.
306
307
308
309
    $this->drupalPostAjaxForm(NULL, array(), 'comment_settings_edit');
    $this->drupalPostForm(NULL, array('fields[comment][settings_edit_form][settings][pager_id]' => 0), t('Save'));
    $this->assertNoText(t('Pager ID: @id', array('@id' => 0)), 'No summary for standard pager');

310
    $this->drupalLogin($this->adminUser);
311

312
    // Add a new node with both comment fields open.
313
    $node = $this->drupalCreateNode(array('type' => 'article', 'promote' => 1, 'uid' => $this->webUser->id()));
314
315
316
317
318
    // Set comment options.
    $comments = array();
    foreach (array('comment', 'comment_2') as $field_name) {
      $this->setCommentForm(TRUE, $field_name);
      $this->setCommentPreview(DRUPAL_OPTIONAL, $field_name);
319
      $this->setCommentSettings('default_mode', CommentManagerInterface::COMMENT_MODE_FLAT, 'Comment paging changed.', $field_name);
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339

      // Set comments to one per page so that we are able to test paging without
      // needing to insert large numbers of comments.
      $this->setCommentsPerPage(1, $field_name);
      for ($i = 0; $i < 3; $i++) {
        $comment = t('Comment @count on field @field', array(
          '@count' => $i + 1,
          '@field' => $field_name,
        ));
        $comments[] = $this->postComment($node, $comment, $comment, TRUE, $field_name);
      }
    }

    // Check the first page of the node, and confirm the correct comments are
    // shown.
    $this->drupalGet('node/' . $node->id());
    $this->assertRaw(t('next'), 'Paging links found.');
    $this->assertRaw('Comment 1 on field comment');
    $this->assertRaw('Comment 1 on field comment_2');
    // Navigate to next page of field 1.
340
    $this->clickLinkWithXPath('//h3/a[normalize-space(text())=:label]/ancestor::section[1]//a[@rel="next"]', array(':label' => 'Comment 1 on field comment'));
341
342
343
344
345
346
    // Check only one pager updated.
    $this->assertRaw('Comment 2 on field comment');
    $this->assertRaw('Comment 1 on field comment_2');
    // Return to page 1.
    $this->drupalGet('node/' . $node->id());
    // Navigate to next page of field 2.
347
    $this->clickLinkWithXPath('//h3/a[normalize-space(text())=:label]/ancestor::section[1]//a[@rel="next"]', array(':label' => 'Comment 1 on field comment_2'));
348
349
350
351
    // Check only one pager updated.
    $this->assertRaw('Comment 1 on field comment');
    $this->assertRaw('Comment 2 on field comment_2');
    // Navigate to next page of field 1.
352
    $this->clickLinkWithXPath('//h3/a[normalize-space(text())=:label]/ancestor::section[1]//a[@rel="next"]', array(':label' => 'Comment 1 on field comment'));
353
354
355
356
    // Check only one pager updated.
    $this->assertRaw('Comment 2 on field comment');
    $this->assertRaw('Comment 2 on field comment_2');
  }
357

358
359
360
361
362
363
364
365
366
367
  /**
   * Follows a link found at a give xpath query.
   *
   * Will click the first link found with the given xpath query by default,
   * or a later one if an index is given.
   *
   * If the link is discovered and clicked, the test passes. Fail otherwise.
   *
   * @param string $xpath
   *   Xpath query that targets an anchor tag, or set of anchor tags.
368
369
370
371
   * @param array $arguments
   *   An array of arguments with keys in the form ':name' matching the
   *   placeholders in the query. The values may be either strings or numeric
   *   values.
372
373
374
375
376
377
378
379
   * @param int $index
   *   Link position counting from zero.
   *
   * @return string|false
   *   Page contents on success, or FALSE on failure.
   *
   * @see WebTestBase::clickLink()
   */
380
  protected function clickLinkWithXPath($xpath, $arguments = array(), $index = 0) {
381
    $url_before = $this->getUrl();
382
    $urls = $this->xpath($xpath, $arguments);
383
384
    if (isset($urls[$index])) {
      $url_target = $this->getAbsoluteUrl($urls[$index]['href']);
385
      $this->pass(SafeMarkup::format('Clicked link %label (@url_target) from @url_before', array('%label' => $xpath, '@url_target' => $url_target, '@url_before' => $url_before)), 'Browser');
386
387
      return $this->drupalGet($url_target);
    }
388
    $this->fail(SafeMarkup::format('Link %label does not exist on @url_before', array('%label' => $xpath, '@url_before' => $url_before)), 'Browser');
389
390
391
    return FALSE;
  }

392
}