Add app versioning

Author: ajhai

apps/apis.py

@@ -29,7 +29,7 @@
 from .models import AppVisibility
 from .models import TestCase
 from .models import TestSet
-from .serializers import AppHubSerializer
+from .serializers import AppDataSerializer, AppHubSerializer
 from .serializers import AppSerializer
 from .serializers import AppTemplateSerializer
 from .serializers import AppTypeSerializer
@@ -140,6 +140,33 @@ def getShared(self, request):
         )
         return DRFResponse(serializer.data)
 
+    def versions(self, request, uid=None, version=None):
+        draft = request.query_params.get('draft', False)
+
+        if not uid:
+            return DRFResponse(status=400, data={'message': 'uid is required'})
+
+        app = get_object_or_404(
+            App,
+            Q(uuid=uuid.UUID(uid), owner=request.user) |
+            Q(uuid=uuid.UUID(uid), accessible_by__contains=[
+                request.user.email], visibility=AppVisibility.PRIVATE, is_published=True),
+        )
+
+        if version:
+            versioned_app_data = AppData.objects.filter(
+                app_uuid=app.uuid, version=version, is_draft=draft
+            ).first()
+            if versioned_app_data:
+                return DRFResponse(AppDataSerializer(versioned_app_data, context={'hide_details': False}).data)
+            else:
+                return DRFResponse(status=404, data={'message': 'Version not found'})
+        else:
+            queryset = AppData.objects.all().filter(
+                app_uuid=app.uuid).order_by('-created_at')
+            serializer = AppDataSerializer(queryset, many=True)
+            return DRFResponse(serializer.data)
+
     @xframe_options_exempt
     def getByPublishedUUID(self, request, published_uuid):
         app = get_object_or_404(App, published_uuid=published_uuid)
@@ -156,7 +183,7 @@ def getByPublishedUUID(self, request, published_uuid):
                 (
                         request.user.is_authenticated and ((app.visibility == AppVisibility.ORGANIZATION and Profile.objects.get(user=app.owner).organization == Profile.objects.get(user=request.user).organization) or
                                                            (app.visibility == AppVisibility.PRIVATE and request.user.email in app.accessible_by))
-                    ):
+                ):
                 serializer = AppSerializer(
                     instance=app, request_user=request.user,
                 )
@@ -388,8 +415,11 @@ def patch(self, request, uid):
             versioned_app_data.is_draft = draft
             versioned_app_data.save()
         else:
+            # Find the total number of published versions
+            published_versions = AppData.objects.filter(
+                app_uuid=app.uuid, is_draft=False).count()
             AppData.objects.create(
-                app_uuid=app.uuid, data=app_data, comment=comment, is_draft=draft
+                app_uuid=app.uuid, data=app_data, comment=comment, is_draft=draft, version=published_versions,
             )
 
         app.last_modified_by = request.user

apps/migrations/0005_appdata_version.py

@@ -0,0 +1,18 @@
+# Generated by Django 4.2.1 on 2023-09-06 22:34
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('apps', '0004_app_data_from_app'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='appdata',
+            name='version',
+            field=models.IntegerField(default=0, help_text='Version of the app'),
+        ),
+    ]

apps/models.py

@@ -248,6 +248,9 @@ class AppData(models.Model):
     app_uuid = models.UUIDField(
         default=None, help_text='UUID of the app', null=True, blank=True,
     )
+    version = models.IntegerField(
+        default=0, help_text='Version of the app',
+    )
     data = models.JSONField(
         default=dict, blank=True,
         help_text='Data for this endpoint',
@@ -268,6 +271,9 @@ class AppData(models.Model):
         auto_now=True, help_text='Time at which the app instance was last updated',
     )
 
+    def __str__(self) -> str:
+        return f'{self.app_uuid}_{"draft" if self.is_draft else "published"}_v{self.version}'
+
 
 class AppHub(models.Model):
     app = models.ForeignKey(

apps/serializers.py

@@ -313,6 +313,23 @@ class Meta:
         ]
 
 
+class AppDataSerializer(serializers.ModelSerializer):
+
+    data = serializers.SerializerMethodField()
+
+    def get_data(self, obj):
+        hide_details = self.context.get('hide_details', True)
+        if hide_details:
+            return None
+
+        return obj.data
+
+    class Meta:
+        model = AppData
+        fields = ['version', 'app_uuid', 'data',
+                  'created_at', 'last_updated_at', 'is_draft', 'comment']
+
+
 class AppHubSerializer(serializers.ModelSerializer):
     published_uuid = serializers.SerializerMethodField()
     name = serializers.SerializerMethodField()

apps/urls.py

@@ -29,9 +29,14 @@
     path('api/apps/shared', apis.AppViewSet.as_view({'get': 'getShared'})),
     path(
         'api/apps/<str:uid>',
-        apis.AppViewSet.as_view({'get': 'get', 'patch': 'patch', 'delete': 'delete'}),
+        apis.AppViewSet.as_view(
+            {'get': 'get', 'patch': 'patch', 'delete': 'delete'}),
     ),
     path('api/apps/<str:uid>/run', apis.AppViewSet.as_view({'post': 'run'})),
+    path('api/apps/<str:uid>/versions',
+         apis.AppViewSet.as_view({'get': 'versions'})),
+    path('api/apps/<str:uid>/versions/<str:version>',
+         apis.AppViewSet.as_view({'get': 'versions'})),
     path(
         'api/apps/<str:uid>/discord/run',
         apis.AppViewSet.as_view({'post': 'run_discord'}),