Merge pull request #153 from multinet-app/session-model-view

Add "Session" model to capture session-based Trrack information

Author: waxlamp

multinet/api/migrations/0014_networksession_tablesession.py

@@ -0,0 +1,45 @@
+# Generated by Django 3.2.16 on 2023-05-18 15:23
+
+from django.db import migrations, models
+import django.db.models.deletion
+import django_extensions.db.fields
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('api', '0013_alter_upload_data_type'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='TableSession',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('created', django_extensions.db.fields.CreationDateTimeField(auto_now_add=True, verbose_name='created')),
+                ('modified', django_extensions.db.fields.ModificationDateTimeField(auto_now=True, verbose_name='modified')),
+                ('name', models.CharField(max_length=300)),
+                ('visapp', models.CharField(max_length=64)),
+                ('state', models.JSONField()),
+                ('table', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='api.table')),
+            ],
+            options={
+                'abstract': False,
+            },
+        ),
+        migrations.CreateModel(
+            name='NetworkSession',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('created', django_extensions.db.fields.CreationDateTimeField(auto_now_add=True, verbose_name='created')),
+                ('modified', django_extensions.db.fields.ModificationDateTimeField(auto_now=True, verbose_name='modified')),
+                ('name', models.CharField(max_length=300)),
+                ('visapp', models.CharField(max_length=64)),
+                ('state', models.JSONField()),
+                ('network', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='api.network')),
+            ],
+            options={
+                'abstract': False,
+            },
+        ),
+    ]

multinet/api/models/__init__.py

@@ -1,12 +1,15 @@
 from .network import Network
+from .session import NetworkSession, TableSession
 from .table import Table, TableTypeAnnotation
 from .tasks import AqlQuery, Task, Upload
 from .workspace import Workspace, WorkspaceRole, WorkspaceRoleChoice
 
 __all__ = [
     'AqlQuery',
     'Network',
+    'NetworkSession',
     'Table',
+    'TableSession',
     'TableTypeAnnotation',
     'Task',
     'Upload',

multinet/api/models/session.py

@@ -0,0 +1,23 @@
+from django.db import models
+from django_extensions.db.models import TimeStampedModel
+
+from .network import Network
+from .table import Table
+
+
+class Session(TimeStampedModel):
+    name = models.CharField(max_length=300)
+
+    visapp = models.CharField(max_length=64)
+    state = models.JSONField()
+
+    class Meta:
+        abstract = True
+
+
+class TableSession(Session):
+    table = models.ForeignKey(Table, on_delete=models.CASCADE)
+
+
+class NetworkSession(Session):
+    network = models.ForeignKey(Network, on_delete=models.CASCADE)

multinet/api/views/__init__.py

@@ -1,5 +1,6 @@
 from .network import NetworkViewSet
 from .query import AqlQueryViewSet
+from .session import NetworkSessionViewSet, TableSessionViewSet
 from .table import TableViewSet
 from .upload import UploadViewSet
 from .users import users_me_view, users_search_view
@@ -8,7 +9,9 @@
 __all__ = [
     'users_me_view',
     'users_search_view',
+    'NetworkSessionViewSet',
     'NetworkViewSet',
+    'TableSessionViewSet',
     'TableViewSet',
     'UploadViewSet',
     'WorkspaceViewSet',

multinet/api/views/common.py

@@ -42,6 +42,28 @@ def paginate_queryset(self, query: ArangoQuery, request: Request) -> List[Dict]:
 
 
 class WorkspaceChildMixin(NestedViewSetMixin):
+    prefix = None
+
+    @property
+    def workspace_field(self):
+        field = 'workspace__name'
+        if self.prefix is not None:
+            field = f'{self.prefix}__{field}'
+
+        return field
+
+    def get_parents_query_dict(self):
+        parents_query_dict = super().get_parents_query_dict()
+
+        # Replace the standard lookup field with one that (possibly) goes
+        # through the session object's related network or table object.
+        new_field = self.workspace_field
+        if new_field not in parents_query_dict:
+            old_field = 'workspace__name'
+            parents_query_dict[new_field] = parents_query_dict.pop(old_field)
+
+        return parents_query_dict
+
     def get_queryset(self):
         """
         Get the queryset for workspace child enpoints.
@@ -56,7 +78,7 @@ def get_queryset(self):
 
         parent_query_dict = self.get_parents_query_dict()
         workspace = get_object_or_404(
-            Workspace.objects.select_related('owner'), name=parent_query_dict['workspace__name']
+            Workspace.objects.select_related('owner'), name=parent_query_dict[self.workspace_field]
         )
 
         # No user or user permission required for public workspaces
@@ -78,3 +100,11 @@ def get_queryset(self):
 
         # Read access denied
         raise Http404
+
+
+class NetworkWorkspaceChildMixin(WorkspaceChildMixin):
+    prefix = 'network'
+
+
+class TableWorkspaceChildMixin(WorkspaceChildMixin):
+    prefix = 'table'

multinet/api/views/network.py

@@ -10,7 +10,7 @@
 from rest_framework_extensions.mixins import DetailSerializerMixin
 
 from multinet.api.auth.decorators import require_workspace_permission
-from multinet.api.models import Network, Table, Workspace, WorkspaceRoleChoice
+from multinet.api.models import Network, NetworkSession, Table, Workspace, WorkspaceRoleChoice
 from multinet.api.tasks.upload.csv import create_csv_network
 from multinet.api.utils.arango import ArangoQuery
 from multinet.api.views.serializers import (
@@ -20,6 +20,7 @@
     NetworkReturnDetailSerializer,
     NetworkReturnSerializer,
     NetworkSerializer,
+    NetworkSessionSerializer,
     NetworkTablesSerializer,
     PaginatedResultSerializer,
     TableReturnSerializer,
@@ -204,3 +205,17 @@ def tables(self, request, parent_lookup_workspace__name: str, name: str):
         serializer = TableReturnSerializer(network_tables, many=True)
 
         return Response(serializer.data, status=status.HTTP_200_OK)
+
+    @swagger_auto_schema(
+        responses={200: NetworkSessionSerializer(many=True)},
+    )
+    @action(detail=True, url_path='sessions')
+    @require_workspace_permission(WorkspaceRoleChoice.READER)
+    def sessions(self, request, parent_lookup_workspace__name: str, name: str):
+        workspace: Workspace = get_object_or_404(Workspace, name=parent_lookup_workspace__name)
+        network: Network = get_object_or_404(Network, workspace=workspace, name=name)
+
+        sessions = NetworkSession.objects.filter(network=network.id)
+        serializer = NetworkSessionSerializer(sessions, many=True)
+
+        return Response(serializer.data, status=status.HTTP_200_OK)

multinet/api/views/serializers.py

@@ -2,7 +2,16 @@
 from django.contrib.auth.validators import UnicodeUsernameValidator
 from rest_framework import serializers
 
-from multinet.api.models import AqlQuery, Network, Table, TableTypeAnnotation, Upload, Workspace
+from multinet.api.models import (
+    AqlQuery,
+    Network,
+    NetworkSession,
+    Table,
+    TableSession,
+    TableTypeAnnotation,
+    Upload,
+    Workspace,
+)
 
 
 # The default ModelSerializer for User fails if the user already exists
@@ -230,6 +239,18 @@ class NetworkTablesSerializer(serializers.Serializer):
     type = serializers.ChoiceField(choices=['node', 'edge', 'all'], default='all', required=False)
 
 
+class NetworkSessionSerializer(serializers.ModelSerializer):
+    class Meta:
+        model = NetworkSession
+        fields = '__all__'
+
+
+class TableSessionSerializer(serializers.ModelSerializer):
+    class Meta:
+        model = TableSession
+        fields = '__all__'
+
+
 class UploadCreateSerializer(serializers.Serializer):
     field_value = serializers.CharField()
 

multinet/api/views/session.py

@@ -0,0 +1,101 @@
+from django.http.response import Http404
+from django.shortcuts import get_object_or_404
+from drf_yasg.utils import swagger_auto_schema
+from rest_framework import serializers, status
+from rest_framework.decorators import action
+from rest_framework.mixins import (
+    CreateModelMixin,
+    DestroyModelMixin,
+    ListModelMixin,
+    RetrieveModelMixin,
+)
+from rest_framework.response import Response
+from rest_framework.viewsets import GenericViewSet
+
+from ..auth.decorators import require_workspace_permission
+from ..models import NetworkSession, TableSession, Workspace, WorkspaceRoleChoice
+from .common import NetworkWorkspaceChildMixin, TableWorkspaceChildMixin
+from .serializers import NetworkSessionSerializer, TableSessionSerializer
+
+
+class SessionCreateSerializer(serializers.Serializer):
+    workspace = serializers.CharField()
+    network = serializers.CharField(required=False)
+    table = serializers.CharField(required=False)
+
+    visapp = serializers.CharField()
+    name = serializers.CharField()
+
+    def validate(self, data):
+        if not bool(data.get('network')) ^ bool(data.get('table')):
+            raise serializers.ValidationError('exactly one of `network` or `table` is required')
+
+        return data
+
+
+class SessionStatePatchSerializer(serializers.Serializer):
+    state = serializers.JSONField()
+
+
+class SessionNamePatchSerializer(serializers.Serializer):
+    name = serializers.CharField(max_length=300)
+
+
+class SessionViewSet(
+    CreateModelMixin, RetrieveModelMixin, DestroyModelMixin, ListModelMixin, GenericViewSet
+):
+    swagger_tags = ['sessions']
+
+    @swagger_auto_schema(request_body=SessionStatePatchSerializer)
+    @action(detail=True, methods=['patch'])
+    @require_workspace_permission(WorkspaceRoleChoice.WRITER)
+    def state(self, request, parent_lookup_workspace__name: str, pk=None):
+        session = self.get_object()
+
+        workspace: Workspace = get_object_or_404(Workspace, name=parent_lookup_workspace__name)
+        session_ws = (
+            session.table.workspace if hasattr(session, 'table') else session.network.workspace
+        )
+        if workspace.id != session_ws.id:
+            raise Http404
+
+        serializer = SessionStatePatchSerializer(data=request.data)
+        serializer.is_valid(raise_exception=True)
+        data = serializer.validated_data['state']
+
+        session.state = data
+        session.save()
+
+        return Response(status=status.HTTP_204_NO_CONTENT)
+
+    @swagger_auto_schema(request_body=SessionNamePatchSerializer)
+    @action(detail=True, methods=['patch'], url_path='name')
+    @require_workspace_permission(WorkspaceRoleChoice.WRITER)
+    def set_name(self, request, parent_lookup_workspace__name: str, pk=None):
+        session = self.get_object()
+
+        workspace: Workspace = get_object_or_404(Workspace, name=parent_lookup_workspace__name)
+        session_ws = (
+            session.table.workspace if hasattr(session, 'table') else session.network.workspace
+        )
+        if workspace.id != session_ws.id:
+            raise Http404
+
+        serializer = SessionNamePatchSerializer(data=request.data)
+        serializer.is_valid(raise_exception=True)
+        name = serializer.validated_data['name']
+
+        session.name = name
+        session.save()
+
+        return Response(status=status.HTTP_204_NO_CONTENT)
+
+
+class NetworkSessionViewSet(NetworkWorkspaceChildMixin, SessionViewSet):
+    queryset = NetworkSession.objects.all().select_related('network__workspace')
+    serializer_class = NetworkSessionSerializer
+
+
+class TableSessionViewSet(TableWorkspaceChildMixin, SessionViewSet):
+    queryset = TableSession.objects.all().select_related('table__workspace')
+    serializer_class = TableSessionSerializer

multinet/api/views/table.py

@@ -12,14 +12,21 @@
 from rest_framework.viewsets import ReadOnlyModelViewSet
 
 from multinet.api.auth.decorators import require_workspace_permission
-from multinet.api.models import Table, TableTypeAnnotation, Workspace, WorkspaceRoleChoice
+from multinet.api.models import (
+    Table,
+    TableSession,
+    TableTypeAnnotation,
+    Workspace,
+    WorkspaceRoleChoice,
+)
 from multinet.api.utils.arango import ArangoQuery
 from multinet.api.views.serializers import (
     PaginatedResultSerializer,
     TableCreateSerializer,
     TableReturnSerializer,
     TableRowRetrieveSerializer,
     TableSerializer,
+    TableSessionSerializer,
 )
 
 from .common import ArangoPagination, MultinetPagination, WorkspaceChildMixin
@@ -152,3 +159,17 @@ def get_type_annotations(self, request, parent_lookup_workspace__name: str, name
         annotations = TableTypeAnnotation.objects.all().filter(table=table)
         annotations_dict = {ann.column: ann.type for ann in annotations}
         return Response(annotations_dict, status=status.HTTP_200_OK)
+
+    @swagger_auto_schema(
+        responses={200: TableSessionSerializer(many=True)},
+    )
+    @action(detail=True, url_path='sessions')
+    @require_workspace_permission(WorkspaceRoleChoice.READER)
+    def sessions(self, request, parent_lookup_workspace__name: str, name: str):
+        workspace: Workspace = get_object_or_404(Workspace, name=parent_lookup_workspace__name)
+        table: Table = get_object_or_404(Table, workspace=workspace, name=name)
+
+        sessions = TableSession.objects.filter(table=table.id)
+        serializer = TableSessionSerializer(sessions, many=True)
+
+        return Response(serializer.data, status=status.HTTP_200_OK)

multinet/urls.py

@@ -8,7 +8,9 @@
 
 from multinet.api.views import (
     AqlQueryViewSet,
+    NetworkSessionViewSet,
     NetworkViewSet,
+    TableSessionViewSet,
     TableViewSet,
     UploadViewSet,
     WorkspaceViewSet,
@@ -42,7 +44,18 @@
     basename='query',
     parents_query_lookups=[f'workspace__{WorkspaceViewSet.lookup_field}'],
 )
-
+workspaces_routes.register(
+    'sessions/network',
+    NetworkSessionViewSet,
+    basename='session',
+    parents_query_lookups=[f'workspace__{WorkspaceViewSet.lookup_field}'],
+)
+workspaces_routes.register(
+    'sessions/table',
+    TableSessionViewSet,
+    basename='session',
+    parents_query_lookups=[f'workspace__{WorkspaceViewSet.lookup_field}'],
+)
 
 # OpenAPI generation
 schema_view = get_schema_view(