From: Kohei Yoshino <kohei.yoshino@gmail.com>
Date: Tue, 23 Apr 2019 22:30:47 +0000 (-0400)
Subject: Bug 1544132 - Allow editing empty Descriptions
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=a99af70ff5d6bb3e2300268b04d5c1db1a39ce9c;p=thirdparty%2Fbugzilla.git

Bug 1544132 - Allow editing empty Descriptions
---

diff --git a/extensions/BugModal/lib/ActivityStream.pm b/extensions/BugModal/lib/ActivityStream.pm
index a0e1b18fd..18e3370cc 100644
--- a/extensions/BugModal/lib/ActivityStream.pm
+++ b/extensions/BugModal/lib/ActivityStream.pm
@@ -179,14 +179,6 @@ sub _add_comments_to_stream {
       $comment->{collapsed_reason} = $comment->author->name;
     }
 
-    if ( $comment->type != CMT_ATTACHMENT_CREATED
-      && $comment->count == 0
-      && length($comment->body) == 0)
-    {
-      $comment->{collapsed}        = 1;
-      $comment->{collapsed_reason} = 'empty';
-    }
-
 # If comment type is resolved as duplicate, do not add '...marked as duplicate...' string to comment body
     if ($comment->type == CMT_DUPE_OF) {
       $comment->set_type(0);
diff --git a/extensions/BugModal/template/en/default/bug_modal/activity_stream.html.tmpl b/extensions/BugModal/template/en/default/bug_modal/activity_stream.html.tmpl
index 55c792dfa..95881ded9 100644
--- a/extensions/BugModal/template/en/default/bug_modal/activity_stream.html.tmpl
+++ b/extensions/BugModal/template/en/default/bug_modal/activity_stream.html.tmpl
@@ -142,7 +142,7 @@
               </button>
             [% END %]
             <button type="button" class="reply-btn minor iconic" title="Reply to this comment" aria-label="Reply"
-                    data-reply-id="[% comment.count FILTER none %]"
+                    [% 'disabled' IF !comment.body %] data-reply-id="[% comment.count FILTER none %]"
                     data-reply-name="[% comment.author.name || comment.author.nick FILTER html %]">
               <span class="icon" aria-hidden="true"></span>
             </button>
@@ -290,13 +290,19 @@
     [% comment_tag = 'pre' %]
   [% END %]
 
-  [% IF comment.body %]
+  [%# Description (Comment 0) can be empty %]
+  [% IF comment.body || comment.count == 0 %]
     <[% comment_tag FILTER none %]
-        class="comment-text [%= "markdown-body" IF comment.is_markdown %] [%= "bz_private" IF comment.is_private %]"
+        class="comment-text [%= "markdown-body" IF comment.is_markdown %] [%= "bz_private" IF comment.is_private %]
+               [% "empty" IF !comment.body %]"
         id="ct-[% comment.count FILTER none %]" data-comment-id="[% comment.id FILTER none %]"
         [% IF comment.is_markdown +%] data-ismarkdown="true" [% END ~%]
         [% IF comment.collapsed +%] style="display:none"[% END ~%]>
-      [%~ comment.body_full({ exclude_attachment => 1 }) FILTER renderMarkdown(bug, comment) ~%]
+      [%~ IF comment.body ~%]
+        [%~ comment.body_full({ exclude_attachment => 1 }) FILTER renderMarkdown(bug, comment) ~%]
+      [%~ ELSE ~%]
+        <em>No description provided.</em>
+      [%~ END ~%]
     </[% comment_tag FILTER none %]>
   [% END %]
 [% END %]
diff --git a/extensions/EditComments/template/en/default/hook/bug_modal/activity_stream-comment_action.html.tmpl b/extensions/EditComments/template/en/default/hook/bug_modal/activity_stream-comment_action.html.tmpl
index 76208017e..8ef264ac9 100644
--- a/extensions/EditComments/template/en/default/hook/bug_modal/activity_stream-comment_action.html.tmpl
+++ b/extensions/EditComments/template/en/default/hook/bug_modal/activity_stream-comment_action.html.tmpl
@@ -7,7 +7,7 @@
   #%]
 
 [%
-  RETURN IF comment.body == '';
+  RETURN UNLESS comment.body || comment.count == 0;
   RETURN UNLESS user.is_insider
     || Param('edit_comments_group') && user.in_group(Param('edit_comments_group')) && comment.author.id == user.id;
   RETURN UNLESS
diff --git a/extensions/EditComments/template/en/default/pages/comment-revisions.html.tmpl b/extensions/EditComments/template/en/default/pages/comment-revisions.html.tmpl
index d4cc4e0b8..b2859d389 100644
--- a/extensions/EditComments/template/en/default/pages/comment-revisions.html.tmpl
+++ b/extensions/EditComments/template/en/default/pages/comment-revisions.html.tmpl
@@ -40,6 +40,8 @@
     <div class="body">
       [% IF !user.is_insider && a.is_hidden %]
         <div class="hidden-comment">(Hidden by Administrator)</div>
+      [% ELSIF comment.count == 0 && !a.new %]
+        <div class="empty-comment">No description provided.</div>
       [% ELSE %]
         <pre class="bz_comment_text">[% a.new FILTER quoteUrls(bug) %]</pre>
       [% END %]
diff --git a/extensions/EditComments/web/js/inline-editor.js b/extensions/EditComments/web/js/inline-editor.js
index 8c92bcf1f..6ddf668a6 100644
--- a/extensions/EditComments/web/js/inline-editor.js
+++ b/extensions/EditComments/web/js/inline-editor.js
@@ -48,7 +48,8 @@ Bugzilla.InlineCommentEditor = class InlineCommentEditor {
 
     this.$edit_button.addEventListener('click', event => this.edit_button_onclick(event));
 
-    // Check if the comment is written in Markdown
+    // Check if the comment is empty or written in Markdown
+    this.is_empty = this.$body.matches('.empty');
     this.is_markdown = this.$body.matches('[data-ismarkdown="true"]');
   }
 
@@ -140,6 +141,12 @@ Bugzilla.InlineCommentEditor = class InlineCommentEditor {
     // Adjust the height of `<textarea>`
     this.$textarea.style.height = `${this.$textarea.scrollHeight}px`;
 
+    // Let the user edit Description (Comment 0) immediately if it's empty
+    if (this.is_empty) {
+      this.fetch_onload({ comments: { [this.comment_id]: '' } });
+      return;
+    }
+
     // Retrieve the raw comment text
     bugzilla_ajax({
       url: `${BUGZILLA.config.basepath}rest/editcomments/comment/${this.comment_id}`,
@@ -284,11 +291,13 @@ Bugzilla.InlineCommentEditor = class InlineCommentEditor {
 
   /**
    * Enable or disable buttons on the comment actions toolbar (not the editor's own toolbar) while editing the comment
-   * to avoid any unexpected behaviour.
+   * to avoid any unexpected behaviour. The Reply button should always be disabled if the comment is empty.
    * @param {Boolean} disabled Whether the buttons should be disabled.
    */
   toggle_toolbar_buttons(disabled) {
-    this.$change_set.querySelectorAll('.comment-actions button').forEach($button => $button.disabled = disabled);
+    this.$change_set.querySelectorAll('.comment-actions button').forEach($button => {
+      $button.disabled = $button.matches('.reply-btn') && this.is_empty ? true : disabled;
+    });
   }
 
   /**
@@ -322,6 +331,13 @@ Bugzilla.InlineCommentEditor = class InlineCommentEditor {
    */
   save_onsuccess(data) {
     this.$body.innerHTML = data.html;
+
+    // Remove the empty state (new comment cannot be empty)
+    if (this.is_empty) {
+      this.is_empty = false;
+      this.$body.classList.remove('empty');
+    }
+
     this.finish();
 
     // Highlight code if possible
diff --git a/extensions/EditComments/web/styles/revisions.css b/extensions/EditComments/web/styles/revisions.css
index ccaeb5442..0614cf816 100644
--- a/extensions/EditComments/web/styles/revisions.css
+++ b/extensions/EditComments/web/styles/revisions.css
@@ -23,6 +23,7 @@
   flex: none;
 }
 
+.revision .empty-comment,
 .revision .hidden-comment {
   padding: 10px;
   font-style: italic;
diff --git a/skins/standard/global.css b/skins/standard/global.css
index 22c142074..aaacddbea 100644
--- a/skins/standard/global.css
+++ b/skins/standard/global.css
@@ -2171,6 +2171,10 @@ pre.comment-text {
     border: 1px dashed darkred;
 }
 
+.comment-text.empty {
+  color: #666;
+}
+
 /* Markdown styling adapted from https://github.com/sindresorhus/github-markdown-css */
 
 .markdown-body {