views: Add notes to patch-detail view

The submission template now includes a section to display notes, these
can be filtered out depending if the request user is a maintainer for
the patch's project and on the note maintainer_only attribute

Signed-off-by: andrepapoti <[email protected]>

Author: andrepapoti

htdocs/css/style.css

@@ -340,6 +340,12 @@ table.patch-meta tr th, table.patch-meta tr td {
     border: 0;
 }
 
+.submission-message .action-icons {
+    margin-left: 16px;
+    display: flex;
+    gap: 4px;
+}
+
 .patch-pull-url {
     font-family: "DejaVu Sans Mono", fixed;
 }
@@ -449,6 +455,35 @@ div.patch-form {
     align-items: center;
 }
 
+#edit-note-form {
+    display: flex;
+    flex-direction: column;
+    gap: 10px; /* Space between form elements */
+    max-width: 100%;
+}
+
+#edit-note-form textarea {
+    flex-grow: 1; /* Allows textarea to grow */
+    width: 100%;
+    min-height: 150px;
+    resize: vertical; /* Allow vertical resizing */
+    padding: 10px;
+    box-sizing: border-box;
+    border: 1px solid #ccc;
+    border-radius: 5px;
+    font-size: 1rem;
+}
+
+#edit-note-form .form-actions {
+    display: flex;
+    justify-content: flex-start; /* Align buttons to the left */
+    gap: 10px; /* Add space between buttons */
+}
+#create-note-form div:first-of-type {
+  display: flex;
+  flex-direction: column;
+}
+
 select[class^=change-property-], .archive-patch-select, .add-bundle {
     padding: 4px;
     margin-right: 8px;
@@ -476,7 +511,7 @@ select[class^=change-property-], .archive-patch-select, .add-bundle {
     padding: 4px;
 }
 
-#patch-form-bundle, #add-to-bundle, #remove-bundle {
+#patch-form-bundle, #add-to-bundle, #remove-bundle, #create-note {
     margin-left: 16px;
 }
 

patchwork/forms.py

@@ -12,6 +12,7 @@
 from django.template.backends import django as django_template_backend
 
 from patchwork.models import Bundle
+from patchwork.models import Note
 from patchwork.models import Patch
 from patchwork.models import State
 from patchwork.models import UserProfile
@@ -106,6 +107,35 @@ class DeleteBundleForm(forms.Form):
     bundle_id = forms.IntegerField(widget=forms.HiddenInput)
 
 
+class CreateNoteForm(forms.ModelForm):
+    name = 'createnoteform'
+    form_name = forms.CharField(initial=name, widget=forms.HiddenInput)
+    content = forms.CharField(label='Content', widget=forms.Textarea)
+    maintainer_only = forms.BooleanField(
+        label='Maintainers Only', initial=True, widget=forms.CheckboxInput
+    )
+
+    class Meta:
+        model = Note
+        fields = ['content', 'maintainer_only']
+
+
+class EditNoteForm(forms.ModelForm):
+    name = 'editnoteform'
+    form_name = forms.CharField(initial=name, widget=forms.HiddenInput)
+    content = forms.CharField(label='Content', widget=forms.Textarea)
+
+    class Meta:
+        model = Note
+        fields = ['content', 'maintainer_only']
+
+
+class DeleteNoteForm(forms.Form):
+    name = 'deletenoteform'
+    form_name = forms.CharField(initial=name, widget=forms.HiddenInput)
+    note_id = forms.IntegerField(widget=forms.HiddenInput)
+
+
 class EmailForm(forms.Form):
     email = forms.EmailField(max_length=200)
 

patchwork/templates/patchwork/partials/patch-forms.html

@@ -44,6 +44,13 @@
       </button>
     </div>
     {% endif %}
+    {% if is_maintainer %}
+    <div id="create-note">
+      <button class="patch-form-submit btn btn-primary" name="action" value="Add-Note">
+        Add Note
+      </button>
+    </div>
+    {% endif %}
   </div>
 {% endif %}
 </div>

patchwork/templates/patchwork/submission.html

@@ -3,12 +3,14 @@
 {% load humanize %}
 {% load syntax %}
 {% load person %}
+{% load user %}
 {% load patch %}
 {% load static %}
 {% load utils %}
 
 {% block headers %}
     <script type="module" src="{% static "js/submission.js" %}"></script>
+    <script src="{% static "js/bundle.js" %}"></script>
 {% endblock %}
 
 {% block title %}{{submission.name}}{% endblock %}
@@ -136,6 +138,14 @@ <h1>{{ submission.name }}</h1>
   {% csrf_token %}
   {% include "patchwork/partials/patch-forms.html" %}
 </form>
+{% if create_note_form %}
+<form id="create-note-form" method="post">
+  <h2>New Note</h2>
+  {% csrf_token %}
+  {{ create_note_form.as_div }}
+  <input type="submit" class="patch-form-submit btn btn-primary" value="Add">
+</form>
+{% endif %}
 
 {% if submission.pull_url %}
 <h2>Pull-request</h2>
@@ -187,6 +197,60 @@ <h2>Message</h2>
   </pre>
 </div>
 
+{% for note in notes %}
+{% if forloop.first %}
+<h2>Notes</h2>
+{% endif %}
+<a name="{{ item.id }}"></a>
+<div class="submission-message">
+  <div class="meta">
+    User: {{ note.submitter|userfy }},
+    <span class="message-date">
+      Last modified: {{ note.updated_at }} UTC
+    </span>
+    <div class="action-icons">
+      {% if is_maintainer %}
+      <form
+        method="post"
+        onsubmit="openEditForm('{{ note.id }}')"
+      >
+        {% csrf_token %}
+        <input type="hidden" name="action" value="edit-note">
+        <input type="hidden" name="edit_note_id" value="{{ note.id }}">
+        <button type="submit" style="background: transparent; border: 0px; padding: 0; outline: 0;">
+          <span class="glyphicon glyphicon-pencil"></span>
+        </button>
+      </form>
+      <form method="post"
+        onsubmit="return confirm_delete('note', '{{ note.id|escapejs }}');">
+        {% csrf_token %}
+        {{ note.delete_form.as_p }}
+        <button type="submit" style="background: transparent; border: 0px; padding: 0; outline: 0;">
+          <span class="glyphicon glyphicon-trash"></span>
+        </button>
+      </form>
+      {% endif %}
+    </div>
+  </div>
+  <pre class="content">
+    {% if edit_note_form and edit_note_id == note.id %}
+    <form id="edit-note-form" method="post">
+        {% csrf_token %}
+        <input type="hidden" name="form_name" value="editnoteform">
+        <input type="hidden" name="note_id" value="{{ note.id }}">
+        <textarea name="content">{{ note.content }}</textarea>
+        <div class="form-actions">
+          <input type="submit" value="Save" class="btn btn-primary">
+          <button type="submit" name="cancel" value="Cancel">Cancel</button>
+        </div>
+    </form>
+    {% else %}
+    {{ note.content }}
+    {% endif %}
+  </pre>
+</div>
+{% endfor %}
+
 {% for item in comments %}
 {% if forloop.first %}
 <h2>Comments</h2>

patchwork/templatetags/user.py

@@ -0,0 +1,23 @@
+# Patchwork - automated patch tracking system
+# Copyright (C) 2024 Meta Platforms, Inc. and affiliates.
+#
+# SPDX-License-Identifier: GPL-2.0-or-later
+
+from django import template
+from django.utils.html import escape
+from django.utils.safestring import mark_safe
+
+
+register = template.Library()
+
+
+@register.filter
+def userfy(user):
+    if user.first_name and user.last_name:
+        linktext = escape(f'{user.first_name} {user.last_name}')
+    elif user.email:
+        linktext = escape(user.email)
+    else:
+        linktext = escape(user.username)
+
+    return mark_safe(linktext)

patchwork/tests/views/test_patch.py

@@ -19,6 +19,7 @@
 from patchwork.models import State
 from patchwork.tests.utils import create_check
 from patchwork.tests.utils import create_maintainer
+from patchwork.tests.utils import create_note
 from patchwork.tests.utils import create_patch
 from patchwork.tests.utils import create_patch_comment
 from patchwork.tests.utils import create_patches
@@ -247,6 +248,55 @@ def test_comment_redirect(self):
         response = self.client.get(requested_url)
         self.assertRedirects(response, redirect_url)
 
+    def test_show_note_for_maintainer(self):
+        project = create_project()
+        user = create_maintainer(project)
+        patch = create_patch(project=project)
+        note = create_note(patch=patch, submitter=user)
+        self.client.login(username=user.username, password=user.username)
+        requested_url = reverse(
+            'patch-detail',
+            kwargs={
+                'project_id': patch.project.linkname,
+                'msgid': patch.encoded_msgid,
+            },
+        )
+        response = self.client.get(requested_url)
+        self.assertIn('<h2>Notes</h2>'.encode('utf-8'), response.content)
+        self.assertIn(note.content.encode('utf-8'), response.content)
+
+    def test_hide_private_note(self):
+        project = create_project()
+        user = create_maintainer(project)
+        patch = create_patch(project=project)
+        note = create_note(patch=patch, submitter=user)
+        requested_url = reverse(
+            'patch-detail',
+            kwargs={
+                'project_id': patch.project.linkname,
+                'msgid': patch.encoded_msgid,
+            },
+        )
+        response = self.client.get(requested_url)
+        self.assertNotIn('<h2>Notes</h2>'.encode('utf-8'), response.content)
+        self.assertNotIn(note.content.encode('utf-8'), response.content)
+
+    def test_show_public_note(self):
+        project = create_project()
+        user = create_maintainer(project)
+        patch = create_patch(project=project)
+        note = create_note(patch=patch, submitter=user, maintainer_only=False)
+        requested_url = reverse(
+            'patch-detail',
+            kwargs={
+                'project_id': patch.project.linkname,
+                'msgid': patch.encoded_msgid,
+            },
+        )
+        response = self.client.get(requested_url)
+        self.assertIn('<h2>Notes</h2>'.encode('utf-8'), response.content)
+        self.assertIn(note.content.encode('utf-8'), response.content)
+
     def test_old_detail_url(self):
         patch = create_patch()