Adds support for copying plios from personal workspace to organisational workspace

plio/migrations/0029_auto_20220110_1044.py

@@ -0,0 +1,21 @@
+# Generated by Django 3.1.1 on 2022-01-10 10:44
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("plio", "0028_auto_20210902_1120"),
+    ]
+
+    operations = [
+        migrations.AlterModelOptions(
+            name="item",
+            options={"ordering": ["time"]},
+        ),
+        migrations.AlterModelOptions(
+            name="question",
+            options={"ordering": ["item__time"]},
+        ),
+    ]

plio/models.py

@@ -117,6 +117,7 @@ class Item(SafeDeleteModel):
 
     class Meta:
         db_table = "item"
+        ordering = ["time"]
 
     def __str__(self):
         return "%d: %s - %s" % (self.id, self.plio.name, self.type)
@@ -140,3 +141,4 @@ class Question(SafeDeleteModel):
 
     class Meta:
         db_table = "question"
+        ordering = ["item__time"]

plio/permissions.py

@@ -6,16 +6,17 @@
 
 
 class PlioPermission(permissions.BasePermission):
-    """
-    Permission check for plios.
-    """
+    """Permission check for plios."""
 
     def has_permission(self, request, view):
         """View-level permissions for plio. This determines whether the request can access plio instances or not."""
         return True
 
     def has_object_permission(self, request, view, obj):
-        """Object-level permissions for plio/item/question. This determines whether the request can access a plio/item/question instance or not."""
+        """
+        Object-level permissions for plio/item/question.
+        This determines whether the request can access a plio/item/question instance or not.
+        """
         if request.user.is_superuser:
             return True
 

plio/tests.py

@@ -22,6 +22,7 @@
 from entries.models import Session
 from plio.views import StandardResultsSetPagination
 from plio.cache import get_cache_key
+from plio.serializers import ImageSerializer
 
 
 class BaseTestCase(APITestCase):
@@ -541,6 +542,125 @@ def test_updating_plio_recreates_instance_cache(self):
         self.assertEqual(len(cache.keys(cache_key_name)), 1)
         self.assertEqual(cache.get(cache_key_name)["name"], new_name)
 
+    def test_copying_without_specifying_workspace_fails(self):
+        response = self.client.post(f"/api/v1/plios/{self.plio_1.uuid}/copy/")
+        self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST)
+        self.assertEqual(response.data["detail"], "workspace is not provided")
+
+    def test_copying_to_non_existing_workspace_fails(self):
+        response = self.client.post(
+            f"/api/v1/plios/{self.plio_1.uuid}/copy/", {"workspace": "abcd"}
+        )
+        self.assertEqual(response.status_code, status.HTTP_404_NOT_FOUND)
+        self.assertEqual(response.data["detail"], "workspace does not exist")
+
+    def test_copying_to_workspace(self):
+        # create some items and questions
+        item_1 = Item.objects.create(type="question", plio=self.plio_1, time=1)
+        item_2 = Item.objects.create(type="question", plio=self.plio_1, time=10)
+        item_3 = Item.objects.create(type="question", plio=self.plio_1, time=20)
+
+        question_1 = Question.objects.create(type="checkbox", item=item_1)
+        # attach an image to one question
+        # upload a test image and retrieve the id
+        with open("plio/static/plio/test_image.jpeg", "rb") as img:
+            response = self.client.post(
+                reverse("images-list"), {"url": img, "alt_text": "test image"}
+            )
+        image_id = response.json()["id"]
+        question_2 = Question.objects.create(
+            type="subjective",
+            item=item_2,
+            image=Image.objects.filter(id=image_id).first(),
+        )
+        question_3 = Question.objects.create(type="checkbox", item=item_3)
+
+        response = self.client.post(
+            f"/api/v1/plios/{self.plio_1.uuid}/copy/",
+            {"workspace": self.organization.shortcode},
+        )
+        self.assertEqual(response.status_code, status.HTTP_200_OK)
+        new_plio_id = response.data["id"]
+        new_plio_uuid = response.data["uuid"]
+        new_video_id = response.data["video"]["id"]
+        new_item_ids = []
+        new_question_ids = []
+
+        for item in response.data.get("items", []):
+            new_item_ids.append(item["id"])
+            new_question_ids.append(item["details"]["id"])
+
+        # check that the instances are actually created in the given workspace
+        connection.set_schema(self.organization.schema_name)
+
+        response = self.client.get(
+            f"/api/v1/videos/{new_video_id}/",
+            HTTP_ORGANIZATION=self.organization.shortcode,
+        )
+        self.assertEqual(response.status_code, status.HTTP_200_OK)
+
+        response = self.client.get(
+            f"/api/v1/plios/{new_plio_uuid}/",
+            HTTP_ORGANIZATION=self.organization.shortcode,
+        )
+        self.assertEqual(response.status_code, status.HTTP_200_OK)
+
+        for new_item_id, old_item in zip(new_item_ids, [item_1, item_2, item_3]):
+            response = self.client.get(
+                f"/api/v1/items/{new_item_id}/",
+                HTTP_ORGANIZATION=self.organization.shortcode,
+            )
+            self.assertEqual(response.status_code, status.HTTP_200_OK)
+            self.assertEqual(response.data["plio"], new_plio_id)
+            self.assertEqual(response.data["type"], old_item.type)
+            self.assertEqual(response.data["time"], old_item.time)
+
+        for old_question, new_question_id, new_item_id in zip(
+            [question_1, question_2, question_3],
+            new_question_ids,
+            new_item_ids,
+        ):
+            response = self.client.get(
+                f"/api/v1/questions/{new_question_id}/",
+                HTTP_ORGANIZATION=self.organization.shortcode,
+            )
+            self.assertEqual(response.status_code, status.HTTP_200_OK)
+            self.assertEqual(response.data["item"], new_item_id)
+            self.assertEqual(response.data["type"], old_question.type)
+
+            if old_question.image is not None:
+                self.assertEqual(
+                    ImageSerializer(old_question.image).data["url"],
+                    response.data["image"]["url"],
+                )
+
+        # set db connection back to public (default) schema
+        connection.set_schema_to_public()
+
+    def test_copying_to_workspace_with_no_video(self):
+        plio = Plio.objects.create(
+            name="Plio 1", created_by=self.user, status="published"
+        )
+        response = self.client.post(
+            f"/api/v1/plios/{plio.uuid}/copy/",
+            {"workspace": self.organization.shortcode},
+        )
+        self.assertEqual(response.status_code, status.HTTP_200_OK)
+        new_plio_uuid = response.data["uuid"]
+
+        # check that the instance is actually created in the given workspace
+        connection.set_schema(self.organization.schema_name)
+
+        response = self.client.get(
+            f"/api/v1/plios/{new_plio_uuid}/",
+            HTTP_ORGANIZATION=self.organization.shortcode,
+        )
+        self.assertEqual(response.status_code, status.HTTP_200_OK)
+        self.assertEqual(response.data["video"]["url"], "")
+
+        # set db connection back to public (default) schema
+        connection.set_schema_to_public()
+
 
 class PlioDownloadTestCase(BaseTestCase):
     def setUp(self):

plio/views.py

@@ -12,6 +12,9 @@
 from django.db import connection
 from django.db.models import Q
 from django.http import FileResponse
+
+from django_tenants.utils import get_tenant_model
+
 import pandas as pd
 from storages.backends.s3boto3 import S3Boto3Storage
 
@@ -42,6 +45,7 @@
 )
 from plio.permissions import PlioPermission
 from plio.ordering import CustomOrderingFilter
+from plio.cache import invalidate_cache_for_instance
 
 
 class StandardResultsSetPagination(PageNumberPagination):
@@ -70,6 +74,23 @@ def get_paginated_response(self, params):
         )
 
 
+def set_tenant(workspace: str):
+    """
+    Sets the current tenant to the given workspace if it exists
+
+    :param workspace: workspace shortcode to use as the current tenant
+    :type workspace: str
+    """
+    tenant_model = get_tenant_model()
+    tenant = tenant_model.objects.filter(shortcode=workspace).first()
+
+    if not tenant:
+        return False
+
+    connection.set_tenant(tenant)
+    return True
+
+
 class VideoViewSet(viewsets.ModelViewSet):
     """
     Video ViewSet description
@@ -84,6 +105,7 @@ class VideoViewSet(viewsets.ModelViewSet):
 
     queryset = Video.objects.all()
     serializer_class = VideoSerializer
+    permission_classes = [IsAuthenticated]
 
 
 class PlioViewSet(viewsets.ModelViewSet):
@@ -215,6 +237,104 @@ def duplicate(self, request, uuid):
         plio.save()
         return Response(self.get_serializer(plio).data)
 
+    @action(
+        methods=["post"],
+        detail=True,
+        permission_classes=[IsAuthenticated, PlioPermission],
+    )
+    def copy(self, request, uuid):
+        """Copies the given plio to another workspace"""
+        if "workspace" not in request.data:
+            return Response(
+                {"detail": "workspace is not provided"},
+                status=status.HTTP_400_BAD_REQUEST,
+            )
+
+        # return 404 if user cannot access the object
+        # else fetch the object
+        plio = self.get_object()
+
+        if plio.video is not None:
+            video = Video.objects.filter(id=plio.video.id).first()
+            video.pk = None
+
+            items = list(Item.objects.filter(plio__id=plio.id))
+            questions = list(Question.objects.filter(item__plio__id=plio.id))
+
+            # will be needed to handle questions with images
+            question_indices_with_image = []
+            images = []
+
+            for index, question in enumerate(questions):
+                if question.image is not None:
+                    question_indices_with_image.append(index)
+                    images.append(question.image)
+        else:
+            video = None
+            items = []
+            questions = []
+
+        # django will auto-generate the key when the key is set to None
+        plio.pk = None
+        plio.uuid = None
+        plio.status = "draft"
+
+        # change workspace
+        workspace = request.data.get("workspace")
+        success = set_tenant(workspace)
+
+        if not success:
+            return Response(
+                {"detail": "workspace does not exist"},
+                status=status.HTTP_404_NOT_FOUND,
+            )
+
+        if video is not None:
+            video.save()
+            plio.video = video
+
+        plio.save()
+
+        if items:
+            # before creating the items in the given workspace, update the
+            # plio ids that they are linked to and reset the primary key;
+            # django will auto-generate the keys when they are set to None
+            for index, _ in enumerate(items):
+                items[index].plio = plio
+                items[index].pk = None
+
+            # create the items
+            items = Item.objects.bulk_create(items)
+
+            # before creating the questions in the given workspace, update the
+            # item ids that they are linked to and
+            # since we are ordering both items and questions by the item time,
+            # questions and items at the same index should be linked
+            for index, _ in enumerate(questions):
+                questions[index].item = items[index]
+                questions[index].pk = None
+
+            # if there are any questions with images, create instances of those images in the
+            # new workspace and link them to the question instances that need to be created
+            if images:
+                for index, _ in enumerate(images):
+                    # reset the key - django will auto-generate the keys when they are set to None
+                    images[index].pk = None
+
+                images = Image.objects.bulk_create(images)
+                for index, question_index in enumerate(question_indices_with_image):
+                    questions[question_index].image = images[index]
+
+            # create the questions
+            questions = Question.objects.bulk_create(questions)
+
+            # clear the cache for the destination plio or else the items wouldn't show up
+            # when the plio is fetched; we need to trigger this manually as bulk_create
+            # does not call the post_save signal
+            invalidate_cache_for_instance(plio)
+
+        return Response(self.get_serializer(plio).data)
+
     @action(
         methods=["get"],
         detail=True,