Merge branch 'master' into feature/advanced_search/join_attrs

Author: userlocalhost

CHANGELOG.md

@@ -11,6 +11,16 @@
 
 ### Fixed
 
+## v3.82.0
+
+### Added
+* Enable to check verification error details on webhooks by users.
+  Contributed by @syucream
+
+### Changed
+* Use enum on the job status.
+  Contributed by @syucream
+
 ## v3.81.0
 
 ### Changed

acl/api_v2/views.py

@@ -6,6 +6,7 @@
 from drf_spectacular.utils import OpenApiParameter, extend_schema
 from rest_framework import generics, mixins, viewsets
 from rest_framework.permissions import BasePermission, IsAuthenticated
+from rest_framework.request import Request
 from rest_framework.response import Response
 
 from acl.api_v2.serializers import ACLHistorySerializer, ACLSerializer
@@ -18,7 +19,7 @@
 
 
 class ACLPermission(BasePermission):
-    def has_object_permission(self, request, view, obj):
+    def has_object_permission(self, request: Request, view, obj) -> bool:
         user: User = request.user
         permisson = {
             "retrieve": ACLType.Readable,
@@ -50,7 +51,7 @@ def get_queryset(self):
         """Unnecessary in this serializer"""
         pass
 
-    def get(self, request, pk: int):
+    def get(self, request: Request, pk: int) -> Response:
         acl = ACLBase.objects.filter(id=pk).first()
         if not acl:
             raise Http404

airone/lib/job.py

@@ -10,24 +10,24 @@ def may_schedule_until_job_is_ready(
     @functools.wraps(func)
     def wrapper(kls, job_id: int):
         job = Job.objects.get(id=job_id)
-        if job.proceed_if_ready():
-            # update Job status from PREPARING to PROCEEDING
-            job.update(JobStatus.PROCESSING.value)
 
-            try:
-                # running Job processing
-                ret: JobStatus | tuple[int, str] | None = func(kls, job)
-            except Exception:
-                ret = JobStatus.ERROR
+        if not job.proceed_if_ready():
+            return
+        # update Job status from PREPARING to PROCEEDING
+        job.update(JobStatus.PROCESSING.value)
 
-            # update Job status after finishing Job processing
-            if isinstance(ret, JobStatus):
-                job.update(status=ret.value)
-            elif (
-                isinstance(ret, tuple) and isinstance(ret[0], JobStatus) and isinstance(ret[1], str)
-            ):
-                job.update(status=ret[0].value, text=ret[1])
-            elif not job.is_canceled():
-                job.update(JobStatus.DONE.value)
+        try:
+            # running Job processing
+            ret: JobStatus | tuple[JobStatus, str] | None = func(kls, job)
+        except Exception:
+            ret = JobStatus.ERROR
+
+        # update Job status after finishing Job processing
+        if isinstance(ret, JobStatus):
+            job.update(status=ret.value)
+        elif isinstance(ret, tuple) and isinstance(ret[0], JobStatus) and isinstance(ret[1], str):
+            job.update(status=ret[0].value, text=ret[1])
+        elif not job.is_canceled():
+            job.update(JobStatus.DONE.value)
 
     return wrapper

dashboard/tasks.py

@@ -1,19 +1,20 @@
 import csv
 import io
 import json
-from typing import Any, Optional
+from typing import Any
 
 import yaml
 from django.conf import settings
 from natsort import natsorted
 
 from airone.celery import app
+from airone.lib.job import may_schedule_until_job_is_ready
 from airone.lib.types import AttrTypeValue
 from entry.models import Entry
-from job.models import Job, JobStatus
+from job.models import Job
 
 
-def _csv_export(job: Job, values, recv_data: dict, has_referral: bool) -> Optional[io.StringIO]:
+def _csv_export(job: Job, values, recv_data: dict, has_referral: bool) -> io.StringIO | None:
     output = io.StringIO(newline="")
     writer = csv.writer(output)
 
@@ -102,7 +103,7 @@ def _csv_export(job: Job, values, recv_data: dict, has_referral: bool) -> Option
     return output
 
 
-def _yaml_export(job: Job, values, recv_data: dict, has_referral: bool) -> Optional[io.StringIO]:
+def _yaml_export(job: Job, values, recv_data: dict, has_referral: bool) -> io.StringIO | None:
     output = io.StringIO()
 
     def _get_attr_value(atype: int, value: dict):
@@ -163,22 +164,15 @@ def _get_attr_value(atype: int, value: dict):
 
 
 @app.task(bind=True)
-def export_search_result(self, job_id):
-    job = Job.objects.get(id=job_id)
-
-    if not job.proceed_if_ready():
-        return
-
-    # set flag to indicate that this job starts processing
-    job.update(JobStatus.PROCESSING.value)
-
+@may_schedule_until_job_is_ready
+def export_search_result(self, job: Job):
     user = job.user
     recv_data = json.loads(job.params)
 
     # Do not care whether the "has_referral" value is
     has_referral: bool = recv_data.get("has_referral", False)
-    referral_name: Optional[str] = recv_data.get("referral_name")
-    entry_name: Optional[str] = recv_data.get("entry_name")
+    referral_name: str | None = recv_data.get("referral_name")
+    entry_name: str | None = recv_data.get("entry_name")
     if has_referral and referral_name is None:
         referral_name = ""
 
@@ -191,15 +185,11 @@ def export_search_result(self, job_id):
         referral_name,
     )
 
-    io_stream: Optional[io.StringIO] = None
+    io_stream: io.StringIO | None = None
     if recv_data["export_style"] == "yaml":
         io_stream = _yaml_export(job, resp["ret_values"], recv_data, has_referral)
     elif recv_data["export_style"] == "csv":
         io_stream = _csv_export(job, resp["ret_values"], recv_data, has_referral)
 
     if io_stream:
         job.set_cache(io_stream.getvalue())
-
-    # update job status and save it except for the case that target job is canceled.
-    if not job.is_canceled():
-        job.update(JobStatus.DONE.value)

entity/api_v2/serializers.py

@@ -59,14 +59,14 @@ class Meta:
         read_only_fields = ["is_verified"]
         extra_kwargs = {"url": {"required": False}}
 
-    def validate_id(self, id: Optional[int]):
+    def validate_id(self, id: int | None):
         entity: Entity = self.parent.parent.instance
         if id is not None and not entity.webhooks.filter(id=id).exists():
             raise ObjectNotExistsError("Invalid id(%s) object does not exist" % id)
 
         return id
 
-    def validate(self, webhook):
+    def validate(self, webhook: dict):
         # case create Webhook
         if "id" not in webhook and "url" not in webhook:
             raise RequiredParameterError("id or url field is required")
@@ -95,13 +95,13 @@ class Meta:
             "note",
         ]
 
-    def validate_type(self, type):
+    def validate_type(self, type: int | None):
         if type not in AttrTypeValue.values():
             raise ObjectNotExistsError("attrs type(%s) does not exist" % type)
 
         return type
 
-    def validate(self, attr):
+    def validate(self, attr: dict):
         referral = attr.get("referral", [])
 
         if attr["type"] & AttrTypeValue["object"] and not len(referral):
@@ -130,21 +130,21 @@ class Meta:
         ]
         extra_kwargs = {"name": {"required": False}, "type": {"required": False}}
 
-    def validate_id(self, id):
+    def validate_id(self, id: int):
         entity: Entity = self.parent.parent.instance
         entity_attr: Optional[EntityAttr] = entity.attrs.filter(id=id, is_active=True).first()
         if not entity_attr:
             raise ObjectNotExistsError("Invalid id(%s) object does not exist" % id)
 
         return id
 
-    def validate_type(self, type):
+    def validate_type(self, type: int | None):
         if type not in AttrTypeValue.values():
             raise ObjectNotExistsError("attrs type(%s) does not exist" % type)
 
         return type
 
-    def validate(self, attr):
+    def validate(self, attr: dict):
         # case update EntityAttr
         if "id" in attr:
             entity_attr = EntityAttr.objects.get(id=attr["id"])
@@ -207,14 +207,14 @@ def _update_or_create(
         user: User,
         entity_id: Optional[int],
         validated_data: EntityCreateData | EntityUpdateData,
-    ):
+    ) -> Entity:
         is_toplevel_data = validated_data.pop("is_toplevel", None)
         attrs_data = validated_data.pop("attrs")
         webhooks_data = validated_data.pop("webhooks")
 
         entity: Entity
         entity, is_created_entity = Entity.objects.get_or_create(
-            id=entity_id, created_user=user, defaults={**validated_data}
+            id=entity_id, defaults={**validated_data}
         )
         if not is_created_entity:
             # record history for specific fields on update
@@ -347,7 +347,7 @@ class Meta:
         fields = ["id", "name", "note", "is_toplevel", "attrs", "webhooks"]
         extra_kwargs = {"note": {"write_only": True}}
 
-    def validate_name(self, name):
+    def validate_name(self, name: str):
         if Entity.objects.filter(name=name, is_active=True).exists():
             raise DuplicatedObjectExistsError("Duplication error. There is same named Entity")
 
@@ -399,7 +399,7 @@ class Meta:
         fields = ["id", "name", "note", "is_toplevel", "attrs", "webhooks"]
         extra_kwargs = {"name": {"required": False}, "note": {"write_only": True}}
 
-    def validate_name(self, name):
+    def validate_name(self, name: str):
         if self.instance.name != name and Entity.objects.filter(name=name, is_active=True).exists():
             raise DuplicatedObjectExistsError("Duplication error. There is same named Entity")
 
@@ -630,10 +630,10 @@ class EntityImportExportRootSerializer(serializers.Serializer):
     Entity = EntityImportExportSerializer(many=True)
     EntityAttr = EntityAttrImportExportSerializer(many=True)
 
-    def save(self, **kwargs):
+    def save(self, **kwargs) -> None:
         user: User = self.context.get("request").user
 
-        def _do_import(resource, iter_data):
+        def _do_import(resource, iter_data: Any):
             results = []
             for data in iter_data:
                 try:

entity/api_v2/views.py

@@ -11,6 +11,7 @@
 from rest_framework.exceptions import ValidationError
 from rest_framework.pagination import LimitOffsetPagination, PageNumberPagination
 from rest_framework.permissions import BasePermission, IsAuthenticated
+from rest_framework.request import Request
 from rest_framework.response import Response
 from rest_framework.serializers import Serializer
 
@@ -34,7 +35,7 @@
 
 
 @http_get
-def history(request, pk):
+def history(request, pk: int) -> HttpResponse:
     if not Entity.objects.filter(id=pk).exists():
         return HttpResponse("Failed to get entity of specified id", status=400)
 
@@ -68,7 +69,7 @@ def history(request, pk):
 
 
 class EntityPermission(BasePermission):
-    def has_permission(self, request, view):
+    def has_permission(self, request: Request, view) -> bool:
         permisson = {
             "list": ACLType.Readable,
             "create": ACLType.Writable,
@@ -82,7 +83,7 @@ def has_permission(self, request, view):
         view.entity = entity
         return True
 
-    def has_object_permission(self, request, view, obj):
+    def has_object_permission(self, request: Request, view, obj) -> bool:
         user: User = request.user
         permisson = {
             "retrieve": ACLType.Readable,
@@ -131,7 +132,7 @@ def get_queryset(self):
         return Entity.objects.filter(**filter_condition).exclude(**exclude_condition)
 
     @extend_schema(request=EntityCreateSerializer)
-    def create(self, request, *args, **kwargs):
+    def create(self, request: Request, *args, **kwargs) -> Response:
         user: User = request.user
 
         serializer = EntityCreateSerializer(data=request.data, context={"_user": user})
@@ -143,7 +144,7 @@ def create(self, request, *args, **kwargs):
         return Response(status=status.HTTP_202_ACCEPTED)
 
     @extend_schema(request=EntityUpdateSerializer)
-    def update(self, request, *args, **kwargs):
+    def update(self, request: Request, *args, **kwargs) -> Response:
         user: User = request.user
         entity: Entity = self.get_object()
 
@@ -157,7 +158,7 @@ def update(self, request, *args, **kwargs):
 
         return Response(status=status.HTTP_202_ACCEPTED)
 
-    def destroy(self, request, *args, **kwargs):
+    def destroy(self, request: Request, *args, **kwargs) -> Response:
         user: User = request.user
         entity: Entity = self.get_object()
 
@@ -197,7 +198,7 @@ def get_queryset(self):
         return self.queryset.filter(schema=entity)
 
     @extend_schema(request=EntryCreateSerializer)
-    def create(self, request, entity_id):
+    def create(self, request: Request, entity_id: int) -> Response:
         user: User = request.user
         request.data["schema"] = entity_id
 
@@ -233,7 +234,7 @@ class EntityImportAPI(generics.GenericAPIView):
     parser_classes = [YAMLParser]
     serializer_class = serializers.Serializer
 
-    def post(self, request):
+    def post(self, request: Request) -> Response:
         import_datas = request.data
         serializer = EntityImportExportRootSerializer(
             data=import_datas, context={"request": self.request}
@@ -248,7 +249,7 @@ class EntityExportAPI(generics.RetrieveAPIView):
     serializer_class = EntityImportExportRootSerializer
     renderer_classes = [YAMLRenderer]
 
-    def get_object(self):
+    def get_object(self) -> dict:
         user: User = self.request.user
         entities = get_permitted_objects(user, Entity, ACLType.Readable)
         attrs = get_permitted_objects(user, EntityAttr, ACLType.Readable)
@@ -282,7 +283,7 @@ def get_queryset(self):
                 # filter only names appear in all specified entities
                 return EntityAttr.objects.filter(parent_entity__in=entities, is_active=True)
 
-    def get(self, request):
+    def get(self, request: Request) -> Response:
         queryset = self.get_queryset()
 
         entity_ids: List[int] = list(