Merge branch 'develop' of https://github.com/dinesh-aot/EPIC.compliance into COMP-356

Author: dinesh-aot

compliance-api/src/compliance_api/config.py

@@ -83,6 +83,9 @@ class _Config:  # pylint: disable=too-few-public-methods
     KEYCLOAK_ADMIN_SECRET = os.getenv("MET_ADMIN_CLIENT_SECRET")
     AUTH_BASE_URL = os.getenv("AUTH_BASE_URL")
     EPIC_TRACK_URL = os.getenv("EPIC_TRACK_URL")
+    DOC_SERVICE_URL = os.getenv("DOC_SERVICE_URL")
+    STORAGE_HOST_URL = os.getenv("STORAGE_HOST_URL")
+    S3_BUCKET = os.getenv("S3_BUCKET")
 
     JWT_OIDC_WELL_KNOWN_CONFIG = os.getenv("JWT_OIDC_WELL_KNOWN_CONFIG")
     JWT_OIDC_ALGORITHMS = os.getenv("JWT_OIDC_ALGORITHMS", "RS256")

compliance-api/src/compliance_api/models/inspection/inspection_req_image.py

@@ -1,8 +1,10 @@
 """Model to handle the image uploads in inspection requirements."""
 
-from sqlalchemy import Column, DateTime, Enum, ForeignKey, Integer, String
+from sqlalchemy import Column, DateTime, Enum, ForeignKey, Integer, String, func
 from sqlalchemy.orm import relationship
 
+from compliance_api.utils.constant import DELETE_DIC_PARAMS
+
 from ..base_model import BaseModelVersioned
 from ..utils import with_session
 from .inspection_enum import ImageTypeEnum
@@ -91,3 +93,25 @@ def find_all_images(cls, requirement_id, image_type: ImageTypeEnum):
             is_active=True,
             is_deleted=False,
         ).all()
+
+    @classmethod
+    def find_image_by_url(cls, requirement_id, relative_url, image_type):
+        """Get image object by url."""
+        return cls.query.filter(
+            cls.requirement_id == requirement_id,
+            func.lower(cls.relative_url) == relative_url.lower(),
+            cls.image_type == image_type,
+            cls.is_active.is_(True),
+            cls.is_deleted.is_(False),
+        ).first()
+
+    @classmethod
+    @with_session
+    def delete_image(cls, image_id, session=None):
+        """Delete the image."""
+        image = cls.find_by_id(image_id)
+        if not image:
+            return None
+        image.update(DELETE_DIC_PARAMS, commit=False)
+        session.flush()
+        return image

compliance-api/src/compliance_api/resources/inspection_requirement.py

@@ -2,9 +2,11 @@
 
 from http import HTTPStatus
 
+from flask import request
 from flask_restx import Namespace, Resource
 
 from compliance_api.auth import auth
+from compliance_api.exceptions import BadRequestError
 from compliance_api.models.inspection import ImageTypeEnum
 from compliance_api.schemas.inspection_requirement import (
     InspectionReqImageSchema, InspectionRequirementCreateSchema, InspectionRequirementSchema,
@@ -164,13 +166,32 @@ class InspectionReqPhotos(Resource):
     )
     @auth.require
     @API.response(code=200, description="Success", model=[inspesction_req_image_schema])
-    def get(requirement_id):
+    def get(inspection_id, requirement_id):
         """Get all photos by requirement_id."""
         photos = InspectionRequirementService.get_all_images(
-            requirement_id, ImageTypeEnum.PHOTO
+            inspection_id, requirement_id, ImageTypeEnum.PHOTO
         )
         return InspectionReqImageSchema(many=True).dump(photos), HTTPStatus.OK
 
+    @staticmethod
+    @auth.require
+    @auth.has_one_of_roles([PermissionEnum.SUPERUSER])
+    @ApiHelper.swagger_decorators(
+        API, endpoint_description="Delete an inspection requirement photo"
+    )
+    @API.response(code=204, description="Success")
+    @API.response(400, "Bad Request")
+    @API.response(404, "Not Found")
+    def delete(inspection_id, requirement_id):
+        """Delete complaint."""
+        relative_url = request.args.get("relative_url", None)
+        if not relative_url:
+            raise BadRequestError("No 'relative_url' is passed as query parameter")
+        InspectionRequirementService.delete_image(
+            inspection_id, requirement_id, relative_url, ImageTypeEnum.PHOTO
+        )
+        return {}, HTTPStatus.NO_CONTENT
+
 
 @cors_preflight("GET, OPTIONS, DELETE")
 @API.route("/<int:requirement_id>/figures", methods=["OPTIONS", "GET", "DELETE"])
@@ -183,9 +204,9 @@ class InspectionReqFigures(Resource):
     )
     @auth.require
     @API.response(code=200, description="Success", model=[inspesction_req_image_schema])
-    def get(requirement_id):
+    def get(inspection_id, requirement_id):
         """Get all figures by requirement_id."""
         figures = InspectionRequirementService.get_all_images(
-            requirement_id, ImageTypeEnum.FIGURE
+            inspection_id, requirement_id, ImageTypeEnum.FIGURE
         )
         return InspectionReqImageSchema(many=True).dump(figures), HTTPStatus.OK

compliance-api/src/compliance_api/schemas/inspection_requirement.py

@@ -375,6 +375,9 @@ class Meta(AutoSchemaBase.Meta):  # pylint: disable=too-few-public-methods
         include_fk = True
 
     taken_by = fields.Nested(StaffUserSchema)
+    url = fields.Str(metadata={
+        "description": "The signed GET url of the file"
+    })
 
     @post_dump
     def post_dump_image_type(

compliance-api/src/compliance_api/services/document_service/constant.py

@@ -0,0 +1,3 @@
+"""Constants associated with the document service."""
+
+API_REQUEST_TIMEOUT = 120

compliance-api/src/compliance_api/services/document_service/doc_service.py

@@ -0,0 +1,56 @@
+"""Class to manage document service."""
+
+import requests
+from flask import current_app, g, json
+from tenacity import retry, retry_if_exception_type, stop_after_attempt, wait_fixed
+
+from compliance_api.exceptions import BusinessError
+from compliance_api.utils.enum import HttpMethod
+
+from .constant import API_REQUEST_TIMEOUT
+
+
+class DocService:
+    """Doc service."""
+
+    @staticmethod
+    def get_presigned_url(payload: dict):
+        """Get presigned url for the given action on the given file."""
+        response = _request_doc_service(
+            "storage-operations/presigned-urls", HttpMethod.POST, payload
+        )
+        if response.status_code != 200:
+            raise BusinessError("Error contacting the document service")
+        return response.json()
+
+
+@retry(
+    retry=retry_if_exception_type(requests.exceptions.RequestException),
+    stop=stop_after_attempt(3),  # Retry up to 3 times
+    wait=wait_fixed(2),  # Wait 2 seconds between retries
+)
+def _request_doc_service(
+    relative_url, http_method: HttpMethod = HttpMethod.GET, data=None
+):
+    """REST Api call to doc service."""
+    token = getattr(g, "access_token", None)
+    if not token:
+        raise BusinessError("No access token found", 401)
+    auth_base_url = current_app.config["DOC_SERVICE_URL"]
+    headers = {
+        "Content-Type": "application/json",
+        "Authorization": f"Bearer {token}",
+    }
+
+    url = f"{auth_base_url}/api/{relative_url}"
+
+    if http_method == HttpMethod.GET:
+        response = requests.get(url, headers=headers, timeout=60)
+    elif http_method == HttpMethod.POST:
+        response = requests.post(
+            url=url, headers=headers, data=json.dumps(data), timeout=API_REQUEST_TIMEOUT
+        )
+    else:
+        raise ValueError("Invalid HTTP method")
+    response.raise_for_status()
+    return response

compliance-api/src/compliance_api/services/document_service/doc_service_enum.py

@@ -0,0 +1,11 @@
+"""Enums related to document service."""
+
+from enum import Enum
+
+
+class ActionOnFileEnum(Enum):
+    """ActionOnFileEnum."""
+
+    PUT = "PUT"
+    DELETE = "DELETE"
+    GET = "GET"

compliance-api/src/compliance_api/services/inspection_requirement.py

@@ -1,9 +1,11 @@
 """InspectionRequirementService."""
 
+import requests
 from flask import g
 
 from compliance_api.auth import auth
-from compliance_api.exceptions import BadRequestError, PermissionDeniedError, ResourceNotFoundError
+from compliance_api.exceptions import (
+    BadRequestError, PermissionDeniedError, ResourceNotFoundError, UnprocessableEntityError)
 from compliance_api.models import ImageTypeEnum
 from compliance_api.models import Inspection as InspectionModel
 from compliance_api.models import InspectionReqDetailDocument as InspectionReqDetailDocumentModel
@@ -12,6 +14,8 @@
 from compliance_api.models import InspectionRequirement as InspectionRequirementModel
 from compliance_api.models import InspectionRequirementImage as InspectionRequirementImageModel
 from compliance_api.models.db import session_scope
+from compliance_api.services.document_service.doc_service import DocService
+from compliance_api.services.document_service.doc_service_enum import ActionOnFileEnum
 from compliance_api.utils.enum import PermissionEnum
 
 
@@ -49,13 +53,13 @@ def create(cls, inspection_id, requirement_data):
                 session,
             )
             #  inserting photos
-            _insert_images(
+            _insert_or_update_images(
                 requirement_id=created_requirement.id,
                 images=requirement_data.get("photos", []),
                 image_type=ImageTypeEnum.PHOTO,
                 session=session,
             )
-            _insert_images(
+            _insert_or_update_images(
                 requirement_id=created_requirement.id,
                 images=requirement_data.get("figures", []),
                 image_type=ImageTypeEnum.FIGURE,
@@ -85,13 +89,13 @@ def update(cls, inspection_id, requirement_id, requirement_data):
                 requirement_data.get("enforcement_action_ids", []),
                 session,
             )
-            _update_images(
+            _insert_or_update_images(
                 requirement_id=requirement_id,
                 images=requirement_data.get("photos", []),
                 image_type=ImageTypeEnum.PHOTO,
                 session=session,
             )
-            _update_images(
+            _insert_or_update_images(
                 requirement_id=requirement_id,
                 images=requirement_data.get("figures", []),
                 image_type=ImageTypeEnum.FIGURE,
@@ -167,12 +171,54 @@ def insert_or_update_enforcements(
                 )
 
     @classmethod
-    def get_all_images(cls, requirement_id, image_type: ImageTypeEnum):
+    def get_all_images(cls, inspection_id, requirement_id, image_type: ImageTypeEnum):
         """Get all photos."""
-        return InspectionRequirementImageModel.find_all_images(
+        _inspection_check(inspection_id)
+        _requirement_check(requirement_id)
+        images = InspectionRequirementImageModel.find_all_images(
             requirement_id=requirement_id, image_type=image_type
         )
 
+        for image in images:
+            presigned_url_reponse = DocService.get_presigned_url(
+                {
+                    "relative_url": image.relative_url,
+                    "action": ActionOnFileEnum.GET.value,
+                }
+            )
+            setattr(
+                image,
+                "url",
+                presigned_url_reponse["presigned_url"],
+            )
+        return images
+
+    @classmethod
+    def delete_image(cls, inspection_id, requirement_id, relative_url, image_type):
+        """Delete image."""
+        _inspection_check(inspection_id)
+        _requirement_check(requirement_id)
+        image = InspectionRequirementImageModel.find_image_by_url(
+            requirement_id, relative_url, image_type
+        )
+        if not image:
+            raise UnprocessableEntityError(
+                f"No {image_type.value} found for the given relative url"
+            )
+        #  Get the presigned delete url for the file
+        presigned_url_response = DocService.get_presigned_url(
+            {
+                "relative_url": image.relative_url,
+                "action": ActionOnFileEnum.DELETE.value,
+            }
+        )
+        presigned_delete_url = presigned_url_response.get("presigned_url")
+        #  Delete the actual file from cloud storage
+        delete_response = requests.delete(presigned_delete_url, timeout=120)
+        #  Mark the deletion in the inspection_req_images table
+        InspectionRequirementImageModel.delete_image(image.id)
+        return delete_response
+
 
 def _create_image_obj(requirement_id, index, img: dict, image_type):
     """Prepare the image object."""
@@ -188,26 +234,33 @@ def _create_image_obj(requirement_id, index, img: dict, image_type):
     }
 
 
-def _insert_images(
+def _insert_or_update_images(
     requirement_id, images: list[dict], image_type: ImageTypeEnum, session=None
 ):
-    """Insert the images."""
-    if images and len(images) > 0:
-        images = [
-            InspectionRequirementImageModel(
-                **_create_image_obj(requirement_id, index, img, image_type)
-            )
-            for index, img in enumerate(images)
-        ]
-        InspectionRequirementImageModel.bulk_insert(images, session=session)
+    """Update the images."""
+    # Fetch existing images from the database
+    existing_images = InspectionRequirementImageModel.find_all_images(
+        requirement_id=requirement_id, image_type=image_type
+    )
+    existing_image_ids = {img.id for img in existing_images}
 
+    # Track incoming image IDs (existing ones)
+    incoming_image_ids = {img["id"] for img in images if "id" in img}
 
-def _update_images(
-    requirement_id, images: list[dict], image_type: ImageTypeEnum, session=None
-):
-    """Update the images."""
+    # DELETE: Remove images that exist in DB but are not in the new list
+    images_to_delete = existing_image_ids - incoming_image_ids
+    for image_id in images_to_delete:
+        InspectionRequirementImageModel.delete_image(image_id, session=session)
+
+    # INSERT or UPDATE images while maintaining order
     for index, img in enumerate(images):
-        if not img.get("id", None):
+        img["sort_order"] = index + 1  # Maintain order
+
+        if "id" in img:  # Update existing image
+            InspectionRequirementImageModel.update_image(
+                img["id"], img, session=session
+            )
+        else:  # Insert new image
             image_obj = _create_image_obj(
                 requirement_id=requirement_id,
                 index=index,
@@ -217,11 +270,6 @@ def _update_images(
             InspectionRequirementImageModel.create_image(
                 image_obj=image_obj, session=session
             )
-        if img.get("id", None):
-            img["sort_order"] = index + 1
-            InspectionRequirementImageModel.update_image(
-                img.get("id"), img, session=session
-            )
 
 
 def _update_sort_order_subsequent(requirements, commit=False):

deployment/charts/compliance-api/templates/configmap.yaml

@@ -17,3 +17,4 @@ data:
   KEYCLOAK_BASE_URL: {{ .Values.auth.keycloak.uri }}
   KEYCLOAK_REALM_NAME: {{ .Values.auth.keycloak.realm }}
   CONNECT_TIMEOUT: "{{ .Values.python.connectTimeout }}"
+  DOC_SERVICE_URL: {{ .Values.doc_service.url }}

deployment/charts/compliance-api/templates/deploymentconfig.yaml

@@ -204,6 +204,11 @@ spec:
                 configMapKeyRef:
                   name: {{ .Chart.Name }}
                   key: CONNECT_TIMEOUT
+            - name: DOC_SERVICE_URL
+              valueFrom:
+                configMapKeyRef:
+                  name: {{ .Chart.Name }}
+                  key: DOC_SERVICE_URL
           ports:
             - containerPort: 8080
               protocol: TCP