global: improve admin and logging (#54)

backoffice/workflows/admin.py

@@ -28,11 +28,25 @@ def has_permission(self, request):
         )
 
 
+@admin.register(Workflow)
 class WorkflowAdmin(admin.ModelAdmin):
     """
     Admin class for Workflow model. Define get, update and delete permissions.
     """
 
+    ordering = ("-_updated_at",)
+    search_fields = ["id", "data"]
+    list_display = (
+        "id",
+        "workflow_type",
+        "status",
+        "core",
+        "is_update",
+        "_created_at",
+        "_updated_at",
+    )
+    list_filter = ["workflow_type", "status", "core", "is_update", "_created_at", "_updated_at"]
+
     def has_view_permission(self, request, obj=None):
         """
         Returns True if the user has permission to view the Workflow model.
@@ -53,8 +67,3 @@ def has_delete_permission(self, request, obj=None):
         """
         permission_check = IsAdminOrCuratorUser()
         return request.user.is_superuser or permission_check.has_permission(request, self)
-
-
-admin.site.register(Workflow)
-workflow_admin_site = WorkflowsAdminSite(name="backoffice_admin")
-workflow_admin_site.register(Workflow, WorkflowAdmin)

backoffice/workflows/api/views.py

@@ -1,3 +1,5 @@
+import logging
+
 from django.shortcuts import get_object_or_404
 from django_elasticsearch_dsl_drf.viewsets import BaseDocumentViewSet
 from rest_framework import status, viewsets
@@ -17,6 +19,8 @@
     WorkflowTicketSerializer,
 )
 
+logger = logging.getLogger(__name__)
+
 
 class WorkflowViewSet(viewsets.ModelViewSet):
     queryset = Workflow.objects.all()
@@ -82,18 +86,22 @@ class AuthorWorkflowViewSet(viewsets.ViewSet):
     serializer_class = WorkflowSerializer
 
     def create(self, request):
+        logger.info("Creating workflow with data: %s", request.data)
         serializer = self.serializer_class(data=request.data)
         if serializer.is_valid(raise_exception=True):
             workflow = Workflow.objects.create(
                 data=serializer.validated_data["data"], workflow_type=serializer.validated_data["workflow_type"]
             )
+        logger.info("Trigger Airflow DAG: %s for %s", WORKFLOW_DAG[workflow.workflow_type], workflow.id)
         return airflow_utils.trigger_airflow_dag(WORKFLOW_DAG[workflow.workflow_type], str(workflow.id), workflow.data)
 
     @action(detail=True, methods=["post"])
     def resolve(self, request, pk=None):
+        logger.info("Resolving data: %s", request.data)
         serializer = AuthorResolutionSerializer(data=request.data)
         if serializer.is_valid(raise_exception=True):
             extra_data = {"create_ticket": serializer.validated_data["create_ticket"]}
+            logger.info("Trigger Airflow DAG: %s for %s", ResolutionDags[serializer.validated_data["value"]], pk)
             return airflow_utils.trigger_airflow_dag(
                 ResolutionDags[serializer.validated_data["value"]].label, pk, extra_data
             )

backoffice/workflows/tests/test_views.py

@@ -128,7 +128,12 @@ def test_patch_admin(self):
         workflow = Workflow.objects.filter(id=str(self.workflow.id))[0]
         self.assertEqual(response.status_code, 200)
         self.assertEquals(workflow.status, "approval")
-        self.assertEquals(workflow.data, {"test": "test"})
+        self.assertEquals(
+            workflow.data,
+            {
+                "test": "test",
+            },
+        )
 
     def test_patch_anonymous(self):
         self.api_client.force_authenticate(user=self.user)

config/urls.py

@@ -7,15 +7,9 @@
 from django.views.generic import TemplateView
 from drf_spectacular.views import SpectacularAPIView, SpectacularSwaggerView
 from rest_framework.authtoken.views import obtain_auth_token
-from rest_framework_simplejwt.views import (
-    TokenObtainPairView,
-    TokenRefreshView,
-)
-
-from backoffice.workflows.admin import workflow_admin_site
+from rest_framework_simplejwt.views import TokenObtainPairView, TokenRefreshView
 
 urlpatterns = [
-    path("dashboard/", workflow_admin_site.urls),
     path("", TemplateView.as_view(template_name="pages/home.html"), name="home"),
     path("about/", TemplateView.as_view(template_name="pages/about.html"), name="about"),
     # Django Admin, use {% url 'admin:index' %}
@@ -42,8 +36,8 @@
         SpectacularSwaggerView.as_view(url_name="api-schema"),
         name="api-docs",
     ),
-    path('api/token/', TokenObtainPairView.as_view(), name='token_obtain_pair'),
-    path('api/token/refresh/', TokenRefreshView.as_view(), name='token_refresh'),
+    path("api/token/", TokenObtainPairView.as_view(), name="token_obtain_pair"),
+    path("api/token/refresh/", TokenRefreshView.as_view(), name="token_refresh"),
 ]
 
 if settings.DEBUG: