[feat] handle better error responses

README.md

@@ -13,21 +13,24 @@ Build the docker image:
 # clean any old active containers
 docker stop $(docker ps -a -q); docker rm $(docker ps -a -q)
 
-# build the image, use the tag "semgeo"
-docker build . --tag semgeo --progress=plain
+# build the base docker image with the docker aws repository tag
+docker build . -f dockerfiles/dockerfile-lambda-gdal-runner --tag 686901913580.dkr.ecr.eu-west-1.amazonaws.com/lambda-gdal-runner
+
+# build the final docker image
+docker build . -f dockerfiles/dockerfile-samgeo-api --tag lambda-samgeo-api --progress=plain
 ```
 
 Run the container (keep it on background) and show logs
 
 ```bash
-docker run  -d --name semgeo -p 7860:7860 semgeo; docker logs -f semgeo
+docker run  -d --name lambda-samgeo-api -p 8080:8080 lambda-samgeo-api; docker logs -f lambda-samgeo-api
 ```
 
 Test it with curl:
 
 ```bash
 curl -X 'POST' \
-  'http://localhost:7860/infer_samgeo' \
+  'http://localhost:8080/infer_samgeo' \
   -H 'accept: application/json' \
   -d '{}'
 ```

dockerfiles/{dockerfile-base-webserver → dockerfile-lambda-gdal-runner}

@@ -8,7 +8,6 @@ ARG RIE="https://github.com/aws/aws-lambda-runtime-interface-emulator/releases/l
 # Set working directory to function root directory
 WORKDIR ${LAMBDA_TASK_ROOT}
 COPY requirements_dev.txt ${LAMBDA_TASK_ROOT}/requirements_dev.txt
-COPY ./src ${LAMBDA_TASK_ROOT}/src
 
 RUN apt update && apt install -y curl python3-pip
 RUN python -m pip install -r ${LAMBDA_TASK_ROOT}/requirements_dev.txt --target ${LAMBDA_TASK_ROOT}
@@ -21,4 +20,3 @@ RUN chmod +x /lambda-entrypoint.sh
 RUN ls -l /lambda-entrypoint.sh
 
 ENTRYPOINT  ["/lambda-entrypoint.sh"]
-CMD [ "src.app.lambda_handler" ]

dockerfiles/dockerfile-samgeo-api

@@ -1,14 +1,13 @@
 FROM 686901913580.dkr.ecr.eu-west-1.amazonaws.com/lambda-gdal-runner:latest
 
+# Include global arg in this stage of the build
 ARG LAMBDA_TASK_ROOT="/var/task"
 ARG PYTHONPATH="${LAMBDA_TASK_ROOT}:${PYTHONPATH}:/usr/local/lib/python3/dist-packages"
 
+# Set working directory to function root directory
+WORKDIR ${LAMBDA_TASK_ROOT}
 COPY ./src ${LAMBDA_TASK_ROOT}/src
 
-COPY .env ${LAMBDA_TASK_ROOT}
-RUN ls -l ${LAMBDA_TASK_ROOT}/.env
-RUN . ${LAMBDA_TASK_ROOT}/.env
-
 RUN ls -l /usr/bin/which
 RUN /usr/bin/which python
 RUN python -v
@@ -19,13 +18,11 @@ RUN ls -l ${LAMBDA_TASK_ROOT}
 RUN ls -ld ${LAMBDA_TASK_ROOT}
 RUN python -c "import sys; print(sys.path)"
 RUN python -c "import osgeo"
-RUN python -c "import rasterio"
+# RUN python -c "import rasterio"
 RUN python -c "import awslambdaric"
 RUN python -m pip list
 RUN python -m pip freeze
 RUN df -h
 
-RUN echo "$(date "+%Y%m%d_%H%M%S")" > ${LAMBDA_TASK_ROOT}/buildtime.txt
-RUN python -m pip freeze > ${LAMBDA_TASK_ROOT}/pythonpackages.txt
-
-CMD [ "src.surferdtm_prediction_api.app.lambda_handler" ]
+ENTRYPOINT  ["/lambda-entrypoint.sh"]
+CMD [ "src.app.lambda_handler" ]

requirements_dev.txt

@@ -1,6 +1,6 @@
 awslambdaric
 aws_lambda_powertools
 fastjsonschema
-pydantic
 jmespath
-
+pydantic
+requests

src/app.py

@@ -1,6 +1,8 @@
 import json
 import time
+from http import HTTPStatus
 from aws_lambda_powertools import Logger
+from aws_lambda_powertools.event_handler import content_types, Response
 from aws_lambda_powertools.utilities.typing import LambdaContext
 from pydantic import BaseModel, ValidationError
 
@@ -10,18 +12,27 @@ from src.utilities.type_hints import input_floatlist, input_floatlist2
 logger = Logger()
 
 
+class JSONResponse(Response):
+    def response_to_json(self):
+        return json.dumps(self.__dict__)
+
+
 class BBoxWithPointInput(BaseModel):
     bbox: input_floatlist
     points: input_floatlist2
+    duration_run: float = 0
+    message: str = ""
+    request_id: str = ""
 
 
-def get_response(status: int, start_time: float, output: BaseModel = None) -> dict[str]:
+def get_response(status: int, start_time: float, request_id: str, output: BBoxWithPointInput = None) -> str:
     """
     Return a response for frontend clients.
 
     Args:
         status: status response
         start_time: request start time (float)
+        request_id: str
         output: dict we embed into our response
 
     Returns:
@@ -29,17 +40,22 @@ def get_response(status: int, start_time: float, output: BaseModel = None) -> di
 
     """
     messages = {200: "ok", 422: "validation error", 500: "internal server error"}
-    body = {"duration_run": time.time() - start_time, "message": messages[status]}
+    body = f"{messages[status]}, request_id: {request_id}."
     if status == 200:
-        body = {"output": output.model_dump_json(), **body}
-    return {
-        "statusCode": status,
-        "headers": {'Content-type': 'application/json', 'Accept': 'application/json'},
-        "body": json.dumps(body)
-    }
+        output.duration_run = time.time() - start_time
+        output.message = messages[status]
+        output.request_id = request_id
+        body = output.model_dump_json()
+    response = JSONResponse(
+        status_code=status,
+        content_type=content_types.APPLICATION_JSON if status == 200 else content_types.TEXT_PLAIN,
+        body=body
+    )
+    logger.info(f"response type:{type(response)} => {response}.")
+    return response.response_to_json()
 
 
-def lambda_handler(event: dict, context: LambdaContext) -> dict[str]:
+def lambda_handler(event: dict, context: LambdaContext):
     logger.info(f"start with aws_request_id:{context.aws_request_id}.")
     start_time = time.time()
     try:
@@ -49,13 +65,13 @@ def lambda_handler(event: dict, context: LambdaContext) -> dict[str]:
         try:
             bbox_points = BBoxWithPointInput(bbox=event["bbox"], points=event["points"])
             logger.info(f"validation ok, bbox_points:{bbox_points}...")
-            response = get_response(200, start_time, bbox_points)
+            response = get_response(HTTPStatus.OK.value, start_time, context.aws_request_id, bbox_points)
         except ValidationError as ve:
             logger.error(f"validation error:{ve}.")
-            response = get_response(422, start_time)
+            response = get_response(422, start_time, context.aws_request_id)
     except Exception as e:
         logger.error(f"exception:{e}.")
-        response = get_response(500, start_time)
+        response = get_response(500, start_time, context.aws_request_id)
 
-    logger.info(f"response:{response}...")
+    logger.info(f"response_dumped:{response}...")
     return response