allow replies to a note (bug 888707)

Author: dash1291

apps/comm/models.py

@@ -6,14 +6,10 @@
 
 import amo.models
 from mkt.constants import comm as const
-from translations.fields import TranslatedField, save_signal
+from translations.fields import save_signal
 
 
-class CommunicationThread(amo.models.ModelBase):
-    addon = models.ForeignKey('addons.Addon', related_name='threads')
-    version = models.ForeignKey('versions.Version', related_name='threads',
-                                null=True)
-
+class CommunicationPermissionModel(amo.models.ModelBase):
     # Read permissions imply write permissions as well.
     read_permission_public = models.BooleanField()
     read_permission_developer = models.BooleanField()
@@ -22,6 +18,15 @@ class CommunicationThread(amo.models.ModelBase):
     read_permission_mozilla_contact = models.BooleanField()
     read_permission_staff = models.BooleanField()
 
+    class Meta:
+        abstract = True
+
+
+class CommunicationThread(CommunicationPermissionModel):
+    addon = models.ForeignKey('addons.Addon', related_name='threads')
+    version = models.ForeignKey('versions.Version', related_name='threads',
+                                null=True)
+
     class Meta:
         db_table = 'comm_threads'
 
@@ -37,11 +42,13 @@ class Meta:
         unique_together = ('user', 'thread',)
 
 
-class CommunicationNote(amo.models.ModelBase):
+class CommunicationNote(CommunicationPermissionModel):
     thread = models.ForeignKey(CommunicationThread, related_name='notes')
     author = models.ForeignKey('users.UserProfile', related_name='comm_notes')
     note_type = models.IntegerField()
     body = models.TextField(null=True)
+    reply_to = models.ForeignKey('self', related_name='replies', null=True,
+                                 blank=True)
 
     class Meta:
         db_table = 'comm_thread_notes'

migrations/635-enable-reply-to-notes.sql

@@ -0,0 +1,11 @@
+ALTER TABLE `comm_thread_notes` ADD COLUMN `read_permission_public` bool NOT NULL;
+ALTER TABLE `comm_thread_notes` ADD COLUMN `read_permission_developer` bool NOT NULL;
+ALTER TABLE `comm_thread_notes` ADD COLUMN `read_permission_reviewer` bool NOT NULL;
+ALTER TABLE `comm_thread_notes` ADD COLUMN `read_permission_senior_reviewer` bool NOT NULL;
+ALTER TABLE `comm_thread_notes` ADD COLUMN `read_permission_staff` bool NOT NULL;
+ALTER TABLE `comm_thread_notes` ADD COLUMN `read_permission_mozilla_contact` bool NOT NULL;
+ALTER TABLE `comm_thread_notes` ADD COLUMN `reply_to_id` int(11) unsigned;
+ALTER TABLE `comm_thread_notes` ADD CONSTRAINT `reply_to_id_refs_id_df5d5709` FOREIGN KEY (`reply_to_id`) REFERENCES `comm_thread_notes` (`id`);
+
+CREATE INDEX `comm_thread_notes_dev_perm` ON `comm_thread_notes` (`read_permission_developer`);
+CREATE INDEX `comm_threads_dev_perm` ON `comm_threads` (`read_permission_developer`);

mkt/comm/api.py

@@ -10,7 +10,7 @@
 from rest_framework.mixins import (CreateModelMixin, DestroyModelMixin,
                                    ListModelMixin, RetrieveModelMixin)
 from rest_framework.permissions import BasePermission
-from rest_framework.relations import RelatedField
+from rest_framework.relations import PrimaryKeyRelatedField, RelatedField
 from rest_framework.serializers import ModelSerializer, SerializerMethodField
 
 from addons.models import Addon
@@ -36,11 +36,12 @@ class Meta:
 class NoteSerializer(ModelSerializer):
     body = CharField()
     author_meta = AuthorSerializer(source='author', read_only=True)
+    reply_to = PrimaryKeyRelatedField(required=False)
 
     class Meta:
         model = CommunicationNote
         fields = ('id', 'author', 'author_meta', 'note_type', 'body',
-                  'created', 'thread')
+                  'created', 'thread', 'reply_to')
 
 
 class AddonSerializer(ModelSerializer):
@@ -195,6 +196,13 @@ def get_serializer(self, instance=None, data=None,
         return super(NoteViewSet, self).get_serializer(data=data_dict,
             files=files, instance=instance, many=many, partial=partial)
 
+    def pre_save(self, obj):
+        """Inherit permissions from the thread."""
+        for key in ('developer', 'reviewer', 'senior_reviewer',
+                    'mozilla_contact', 'staff'):
+            perm = 'read_permission_%s' % key
+            setattr(obj, perm, getattr(self.comm_thread, perm))
+
 
 class EmailCreationPermission(object):
     def has_permission(self, request, view):
@@ -213,3 +221,26 @@ def post_email(request):
 
     consume_email.apply_async((email_body,))
     return Response(status=201)
+
+
+class ReplyViewSet(NoteViewSet):
+    cors_allowed_methods = ['get', 'post']
+
+    def initialize_request(self, request, *args, **kwargs):
+        self.parent_note = get_object_or_404(CommunicationNote,
+                                             id=kwargs['note_id'])
+
+        return super(ReplyViewSet, self).initialize_request(request, *args,
+                                                            **kwargs)
+
+    def get_queryset(self):
+        return self.parent_note.replies.all()
+
+    def pre_save(self, obj):
+        """Inherit permissions from the parent note."""
+        for key in ('developer', 'reviewer', 'senior_reviewer',
+                    'mozilla_contact', 'staff'):
+            perm = 'read_permission_%s' % key
+            setattr(obj, perm, getattr(self.parent_note, perm))
+
+        obj.reply_to = self.parent_note

mkt/comm/tests/test_api.py

@@ -154,7 +154,7 @@ def setUp(self):
         super(TestNote, self).setUp()
         addon = Webapp.objects.get(pk=337141)
         self.thread = CommunicationThread.objects.create(addon=addon,
-            read_permission_developer=True)
+            read_permission_developer=True, version=addon.current_version)
         self.thread_url = reverse('comm-thread-detail',
                                   kwargs={'pk': self.thread.id})
         self.list_url = reverse('comm-note-list',
@@ -170,6 +170,7 @@ def test_response(self):
                                               'pk': note.id}))
         eq_(res.status_code, 200)
         eq_(res.json['body'], 'something')
+        eq_(res.json['reply_to'], None)
 
     def test_creation(self):
         res = self.client.post(self.list_url, data=json.dumps(
@@ -188,6 +189,29 @@ def test_cors_allowed(self):
         res = self.client.get(self.list_url)
         self.assertCORS(res, 'get', 'post', 'delete')
 
+    def test_reply_list(self):
+        note = CommunicationNote.objects.create(author=self.profile,
+            thread=self.thread, note_type=0, body='something')
+        note.replies.create(body='somethingelse', note_type=0,
+            thread=self.thread, author=self.profile)
+        res = self.client.get(reverse('comm-note-replies-list',
+                                      kwargs={'thread_id': self.thread.id,
+                                              'note_id': note.id}))
+        eq_(res.status_code, 200)
+        eq_(len(res.json['objects']), 1)
+        eq_(res.json['objects'][0]['reply_to'], note.id)
+
+    def test_reply_create(self):
+        note = CommunicationNote.objects.create(author=self.profile,
+            thread=self.thread, note_type=0, body='something')
+        res = self.client.post(reverse('comm-note-replies-list',
+                                      kwargs={'thread_id': self.thread.id,
+                                              'note_id': note.id}),
+                               data=json.dumps({'note_type': '0',
+                                                'body': 'something'}))
+        eq_(res.status_code, 201)
+        eq_(note.replies.count(), 1)
+
 
 class TestEmailApi(RestOAuth):
 

mkt/comm/urls.py

@@ -2,13 +2,16 @@
 
 from rest_framework.routers import DefaultRouter
 
-from mkt.comm.api import NoteViewSet, ThreadViewSet, post_email
+from mkt.comm.api import NoteViewSet, post_email, ReplyViewSet, ThreadViewSet
 
 
 api_thread = DefaultRouter()
 api_thread.register(r'thread', ThreadViewSet, base_name='comm-thread')
 api_thread.register(r'thread/(?P<thread_id>\d+)/note', NoteViewSet,
                     base_name='comm-note')
+api_thread.register(
+	r'thread/(?P<thread_id>\d+)/note/(?P<note_id>\d+)/replies', ReplyViewSet,
+	base_name='comm-note-replies')
 
 api_patterns = patterns('',
     url(r'^comm/', include(api_thread.urls)),