29 add background fastapi tasks for pdf generation (#30)

* Append background task to reporting

* Add pdf file name which will be used in the future

* Decoded JWT info update

* Add user ID inside pdf name

* Retrieve user PDF

* Add response schema

* Update reporting dir and test locally

* Refactor usage uuid

---------

Co-authored-by: JoleVLF <Jovan@DESKTOP-JTIACNO>

Author: JoleVLF

.gitignore

@@ -4,3 +4,4 @@ venv
 .alembic
 __pycache__
 .env
+app/user_reports

README.md

@@ -51,8 +51,25 @@ docker compose up
 
 The application will be served on http://127.0.0.1:8009 (I.E. typing localhost/docs in your browser will load the swagger documentation)
 
-Full list of APIs available you can check [here](https://editor-next.swagger.io/?url=https://gist.githubusercontent.com/JoleVLF/20645c6e8e3545d02c7c4570271bdc49/raw/6efafb74bd2bc33e4221ee2a202d0c830b867c70/reporting)
+Full list of APIs available you can check [here](https://editor-next.swagger.io/?url=https://gist.githubusercontent.com/JoleVLF/b1bcdd77ac82aeb115a6c94fb3dadbdc/raw/4ce7fea5b022142002d0dfebcd2156a3e408fbe4/api.json)
 # Documentation
+<h3>GET</h3>
+
+```
+/api/v1/openagri-report/{report_id}/
+```
+
+## Path Params
+
+### report_id
+- **Type**: `uuid str`
+- **Description**: UUID of the generated PDF file..
+
+
+## Response
+
+Response is generated PDF file.
+
 <h3>POST</h3>
 
 ```
@@ -69,8 +86,7 @@ Full list of APIs available you can check [here](https://editor-next.swagger.io/
 
 ## Response
 
-Response is generated PDF file.
-
+Response is uuid of generated PDF file.
 
 <h3>POST</h3>
 
@@ -95,13 +111,13 @@ Response is generated PDF file.
 
 
 ## Response 
-Response is generated PDF file.
+Response is uuid of generated PDF file.
 
 <h3> Example usage </h3>
 
 Compost and Irrigation Report APIs can be used with and without Gatekeeper support.
 If Gatekeeper is used, data file param can be ignored.
-When service is run wihtout Gatekeeper data must be provided in .json file format.
+When service is run without Gatekeeper data must be provided in .json file format.
 
 
 ```shell
@@ -142,7 +158,7 @@ If a valid JSON file is uploaded, the API processes the data directly to generat
 
 ## Response
 
-Response is generated PDF file.
+Response is uuid of generated PDF file.
 
 <h2>Pytest</h2>
 Pytest can be run on the same machine the service has been deployed to by moving into the tests dir and running:

app/api/api_v1/endpoints/report.py

@@ -1,81 +1,95 @@
-import json
+import os
 import uuid
-from json import JSONDecodeError
 from typing import Optional
 
-from fastapi import APIRouter, File, Depends, HTTPException, UploadFile, Response
+from fastapi import (
+    APIRouter,
+    Depends,
+    HTTPException,
+    UploadFile,
+    BackgroundTasks,
+)
 from pydantic import UUID4
 
 from api import deps
 from core import settings
+from schemas import PDF
+from utils import decode_jwt_token
 from utils.animals_report import process_animal_data
 from utils.farm_calendar_report import process_farm_calendar_data
 from utils.irrigation_report import process_irrigation_data
-from utils.json_handler import make_get_request
+from fastapi.responses import FileResponse
 
 router = APIRouter()
 
 
-@router.post("/irrigation-report/")
-async def generate_irrigation_report(
+@router.get("{report_id}", response_class=FileResponse)
+def retrieve_generated_pdf(
+    report_id: str,
     token=Depends(deps.get_current_user),
-    data: UploadFile = None,
 ):
     """
-    Generates Irrigation Report PDF file
+
+    Retrieve generated PDF file
 
     """
+    user_id = (
+        decode_jwt_token(token)["user_id"]
+        if settings.REPORTING_USING_GATEKEEPER
+        else token.id
+    )
 
-    if not data and not settings.REPORTING_USING_GATEKEEPER:
-        raise HTTPException(
-            status_code=400,
-            detail=f"Data file must be provided if gatekeeper is not used.",
-        )
+    file_path = f"{settings.PDF_DIRECTORY}{user_id}/{report_id}.pdf"
 
-    pdf = None
-    if not data:
-        params = {"format": "json"}
-        farm_calendar_irrigation_response = make_get_request(
-            url=f'{settings.REPORTING_FARMCALENDAR_BASE_URL}{settings.REPORTING_FARMCALENDAR_URLS["irrigations"]}',
-            token=token,
-            params=params,
+    if not os.path.exists(file_path):
+        raise HTTPException(
+            status_code=404,
+            detail=f"File with uuid {report_id} for logged user not found.",
         )
 
-        if not farm_calendar_irrigation_response:
-            raise HTTPException(status_code=400, detail="No Irrigation data found.")
+    return FileResponse(
+        path=file_path, media_type="application/pdf", filename=f"{report_id}"
+    )
 
-        pdf = process_irrigation_data(json_data=farm_calendar_irrigation_response)
 
-    else:
-        try:
-            pdf = process_irrigation_data(json_data=json.load(data.file))
+@router.post("/irrigation-report/", response_model=PDF)
+async def generate_irrigation_report(
+    background_tasks: BackgroundTasks,
+    token=Depends(deps.get_current_user),
+    data: UploadFile = None,
+):
+    """
+    Generates Irrigation Report PDF file
 
-        except JSONDecodeError as e:
-            raise HTTPException(
-                status_code=400,
-                detail=f"Reporting service failed during PDF generation. File is not correct JSON.",
-            )
+    """
+    uuid_v4 = str(uuid.uuid4())
+    user_id = (
+        decode_jwt_token(token)["user_id"]
+        if settings.REPORTING_USING_GATEKEEPER
+        else token.id
+    )
+    uuid_of_pdf = f"{user_id}/{uuid_v4}"
 
-    if not pdf:
+    if not data and not settings.REPORTING_USING_GATEKEEPER:
         raise HTTPException(
             status_code=400,
-            detail=f"Reporting service failed during PDF generation.",
-        )
-
-    headers = {
-        "Content-Disposition": "attachment; filename=irrigation-report-{}.pdf".format(
-            uuid.uuid4()
+            detail=f"Data file must be provided if gatekeeper is not used.",
         )
-    }
 
-    return Response(
-        content=bytes(pdf.output()), media_type="application/pdf", headers=headers
+    background_tasks.add_task(
+        process_irrigation_data,
+        data=data,
+        token=token,
+        pdf_file_name=uuid_of_pdf,
     )
 
+    return PDF(uuid=uuid_v4)
+
 
-@router.post("/compost-report/")
+@router.post("/compost-report/", response_model=PDF)
 async def generate_generic_observation_report(
     observation_type_name: str,
+    background_tasks: BackgroundTasks,
     token=Depends(deps.get_current_user),
     data: UploadFile = None,
 ):
@@ -90,86 +104,28 @@ async def generate_generic_observation_report(
 
     if observation_type_name == "CropStressIndicator":
         observation_type_name = "Crop Stress Indicator"
-
-    pdf = None
-    if not data:
-        if not settings.REPORTING_USING_GATEKEEPER:
-            raise HTTPException(
-                status_code=400,
-                detail=f"Data file must be provided if gatekeeper is not used.",
-            )
-
-        params = {"format": "json", "name": observation_type_name}
-        farm_activity_type_info = make_get_request(
-            url=f'{settings.REPORTING_FARMCALENDAR_BASE_URL}{settings.REPORTING_FARMCALENDAR_URLS["activity_types"]}',
-            token=token,
-            params=params,
-        )
-
-        if not farm_activity_type_info:
-            raise HTTPException(status_code=400, detail="Activity Type API failed.")
-
-        del params["name"]
-        params["activity_type"] = farm_activity_type_info[0]["@id"].split(":")[3]
-
-        observations = make_get_request(
-            url=f'{settings.REPORTING_FARMCALENDAR_BASE_URL}{settings.REPORTING_FARMCALENDAR_URLS["observations"]}',
-            token=token,
-            params=params,
-        )
-
-        if not observations:
-            raise HTTPException(status_code=400, detail="Observations are empty.")
-
-        farm_activities = make_get_request(
-            url=f'{settings.REPORTING_FARMCALENDAR_BASE_URL}{settings.REPORTING_FARMCALENDAR_URLS["activities"]}',
-            token=token,
-            params=params,
-        )
-
-        if not farm_activities:
-            raise HTTPException(status_code=400, detail="Farm Activities are empty.")
-
-        pdf = process_farm_calendar_data(
-            activity_type_info=observation_type_name,
-            observations=observations,
-            farm_activities=farm_activities,
-        )
-
-    else:
-        try:
-            dt = json.load(data.file)
-            pdf = process_farm_calendar_data(
-                activity_type_info=observation_type_name,
-                observations=dt["observations"],
-                farm_activities=dt["farm_activities"],
-            )
-
-        except JSONDecodeError as e:
-            raise HTTPException(
-                status_code=400,
-                detail=f"Reporting service failed during PDF generation. File is not correct JSON.",
-            )
-
-    if not pdf:
-        raise HTTPException(
-            status_code=400,
-            detail=f"Reporting service failed during PDF generation.",
-        )
-
-    headers = {
-        "Content-Disposition": "attachment; filename=compost-report-{}.pdf".format(
-            uuid.uuid4()
-        )
-    }
-
-    return Response(
-        content=bytes(pdf.output()), media_type="application/pdf", headers=headers
+    uuid_v4 = str(uuid.uuid4())
+    user_id = (
+        decode_jwt_token(token)["user_id"]
+        if settings.REPORTING_USING_GATEKEEPER
+        else token.id
+    )
+    uuid_of_pdf = f"{user_id}/{uuid_v4}"
+
+    background_tasks.add_task(
+        process_farm_calendar_data,
+        observation_type_name=observation_type_name,
+        token=token,
+        data=data,
+        pdf_file_name=uuid_of_pdf,
     )
 
+    return PDF(uuid=uuid_v4)
 
-@router.post("/animal-report/")
+
+@router.post("/animal-report/", response_model=PDF)
 async def generate_animal_report(
+    background_tasks: BackgroundTasks,
     token=Depends(deps.get_current_user),
     animal_group: Optional[str] = None,
     name: Optional[str] = None,
@@ -180,8 +136,14 @@ async def generate_animal_report(
     """
     Generates Animal Report PDF file
     """
-
-    pdf = None
+    uuid_v4 = str(uuid.uuid4())
+    user_id = (
+        decode_jwt_token(token)["user_id"]
+        if settings.REPORTING_USING_GATEKEEPER
+        else token.id
+    )
+    uuid_of_pdf = f"{user_id}/{uuid_v4}"
+    params = None
     if not data:
         if not settings.REPORTING_USING_GATEKEEPER:
             raise HTTPException(
@@ -199,31 +161,12 @@ async def generate_animal_report(
         if status is not None:
             params["status"] = status
 
-        json_response = make_get_request(
-            url=f'{settings.REPORTING_FARMCALENDAR_BASE_URL}{settings.REPORTING_FARMCALENDAR_URLS["animals"]}',
-            token=token,
-            params=params,
-        )
-
-        if not json_response:
-            raise HTTPException(status_code=400, detail="No animal data found.")
-
-        pdf = process_animal_data(json_data=json_response)
-        if not pdf:
-            raise HTTPException(
-                status_code=400,
-                detail="Reporting service failed during PDF generation.",
-            )
-    else:
-        try:
-            pdf = process_animal_data(json_data=json.load(data.file))
-
-        except JSONDecodeError as e:
-            raise HTTPException(
-                status_code=400,
-                detail=f"Reporting service failed during PDF generation. File is not correct JSON.",
-            )
-    headers = {"Content-Disposition": "attachment; filename=animal-report.pdf"}
-    return Response(
-        content=bytes(pdf.output()), media_type="application/pdf", headers=headers
+    background_tasks.add_task(
+        process_animal_data,
+        data=data,
+        token=token,
+        params=params,
+        pdf_file_name=uuid_of_pdf,
     )
+
+    return PDF(uuid=uuid_v4)

app/core/config.py

@@ -32,6 +32,7 @@ class Settings(BaseSettings):
         "animals": "/FarmAnimals/",
     }
 
+    PDF_DIRECTORY: str = "user_reports/"
     SQLALCHEMY_DATABASE_URI: Optional[str] = None
 
     @field_validator("SQLALCHEMY_DATABASE_URI", mode="before")

app/schemas/animals.py

@@ -18,7 +18,7 @@ class Animal(BaseModel):
     description: str
     hasAgriParcel: Optional[HasAgriParcel] = None
     sex: int
-    castrated: bool
+    isCastrated: bool = False
     species: str
     breed: str
     birthdate: datetime

app/schemas/generic.py

@@ -3,3 +3,7 @@
 
 class Message(BaseModel):
     message: str
+
+
+class PDF(BaseModel):
+    uuid: str