Issue #2170251 by lauriii, mgifford, joshi.rohit100, lokapujya, mparker17,...

Issue #2170251 by lauriii, mgifford, joshi.rohit100, lokapujya, mparker17, Mirabuck, Jalandhar: Fixed Comment headings can spit out empty heading tags.

core/modules/comment/src/Tests/CommentTitleTest.php

+<?php
+
+/**
+ * @file
+ * Contains \Drupal\comment\Tests\CommentTitleTest.
+ */
+
+namespace Drupal\comment\Tests;
+
+/**
+ * Tests comment titles.
+ */
+class CommentTitleTest extends CommentTestBase {
+  public static function getInfo() {
+    return array(
+      'name' => 'Comment titles',
+      'description' => 'Test to ensure that appropriate and accessible markup is created for comment titles.',
+      'group' => 'Comment',
+    );
+  }
+
+  /**
+   * Tests markup for comments with empty titles.
+   */
+  public function testCommentEmptyTitles() {
+    // Enables module that sets comments to an empty string.
+    \Drupal::moduleHandler()->install(array('comment_empty_title_test'));
+
+    // Set comments to have a subject with preview disabled.
+    $this->setCommentPreview(DRUPAL_DISABLED);
+    $this->setCommentForm(TRUE);
+    $this->setCommentSubject(TRUE);
+
+    // Create a node.
+    $this->drupalLogin($this->web_user);
+    $this->node = $this->drupalCreateNode(array('type' => 'article', 'promote' => 1, 'uid' => $this->web_user->id()));
+
+    // Post comment #1 and verify that h3's are not rendered.
+    $subject_text = $this->randomName();
+    $comment_text = $this->randomName();
+    $comment = $this->postComment($this->node, $comment_text, $subject_text, TRUE);
+    // Confirm that the comment was created.
+    $regex = '/<a id="comment-' . $comment->id() . '"(.*?)';
+    $regex .= $comment->comment_body->value . '(.*?)';
+    $regex .= '/s';
+    $this->assertPattern($regex, 'Comment is created succesfully');
+    // Tests that markup is not generated for the comment without header.
+    $this->assertNoPattern('|<h3[^>]*></h3>|', 'Comment title H3 element not found when title is an empty string.');
+  }
+
+  /**
+   * Tests markup for comments with populated titles.
+   */
+  public function testCommentPopulatedTitles() {
+    // Set comments to have a subject with preview disabled.
+    $this->setCommentPreview(DRUPAL_DISABLED);
+    $this->setCommentForm(TRUE);
+    $this->setCommentSubject(TRUE);
+
+    // Create a node.
+    $this->drupalLogin($this->web_user);
+    $this->node = $this->drupalCreateNode(array('type' => 'article', 'promote' => 1, 'uid' => $this->web_user->id()));
+
+    // Post comment #1 and verify that title is rendered in h3.
+    $subject_text = $this->randomName();
+    $comment_text = $this->randomName();
+    $comment1 = $this->postComment($this->node, $comment_text, $subject_text, TRUE);
+    // Confirm that the comment was created.
+    $this->assertTrue($this->commentExists($comment1), 'Comment #1. Comment found.');
+    // Tests that markup is created for comment with heading.
+    $this->assertPattern('|<h3[^>]*><a[^>]*>' . $subject_text . '</a></h3>|', 'Comment title is rendered in h3 when title populated.');
+  }
+}

core/modules/comment/templates/comment.html.twig

@@ -65,7 +65,9 @@
  */
 #}
 <article{{ attributes }}>
-  {{ title_prefix }}
+  {% if title %}
+    {{ title_prefix }}
+  {% endif %}
 
   {#
   Hide the "new" indicator by default, let a piece of JavaScript ask
@@ -74,9 +76,11 @@
   #}
   <mark class="hidden new" data-comment-timestamp="{{ new_indicator_timestamp }}"></mark>
 
-  <h3{{ title_attributes }}>{{ title }}</h3>
+  {% if title %}
+    <h3{{ title_attributes }}>{{ title }}</h3>
+    {{ title_suffix }}
+  {% endif %}
 
-  {{ title_suffix }}
 
   <footer>
     {{ user_picture }}

core/modules/comment/tests/modules/comment_empty_title_test/comment_empty_title_test.info.yml

+name: 'Comment empty titles test'
+type: module
+description: 'Support module for testing empty title accessibility with Comment module.'
+package: Testing
+version: VERSION
+core: 8.x
+dependencies:
+  - comment

core/modules/comment/tests/modules/comment_empty_title_test/comment_empty_title_test.module

+<?php
+
+/**
+ * @file
+ * Dummy module emptying comment titles to test for approriate and accessible
+ * markup in edge case scenarios where comments have empty titles.
+ */
+
+use Drupal\comment\CommentInterface;
+
+/**
+ * Implements hook_preprocess_comment().
+ */
+function comment_empty_titles_test_preprocess_comment(&$variables) {
+  $variables['title'] = '';
+}

core/themes/bartik/templates/comment.html.twig

@@ -102,9 +102,11 @@
     #}
     <span class="hidden new" data-comment-timestamp="{{ new_indicator_timestamp }}"></span>
 
-    {{ title_prefix }}
-    <h3{{ title_attributes }}>{{ title }}</h3>
-    {{ title_suffix }}
+    {% if title %}
+      {{ title_prefix }}
+      <h3{{ title_attributes }}>{{ title }}</h3>
+      {{ title_suffix }}
+    {% endif %}
 
     <div{{ content_attributes }}>
       {{ content|without('links') }}