Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cache for Image Query ID's Originating from the Edge Endpoint #17

Merged
merged 8 commits into from
Aug 18, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 21 additions & 3 deletions app/api/routes/image_queries.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,17 @@
from io import BytesIO

import numpy as np
from fastapi import APIRouter, Depends, Request
from fastapi import APIRouter, Depends, HTTPException, Request
from model import ImageQuery
from PIL import Image, ImageFile

from app.core.utils import get_groundlight_sdk_instance, get_motion_detector_instance, prefixed_ksuid, safe_call_api
from app.core.utils import (
get_edge_detector_manager,
get_groundlight_sdk_instance,
get_motion_detector_instance,
prefixed_ksuid,
safe_call_api,
)

logger = logging.getLogger(__name__)

Expand All @@ -23,6 +29,7 @@ async def post_image_query(
request: Request = None,
gl: Depends = Depends(get_groundlight_sdk_instance),
motion_detector: Depends = Depends(get_motion_detector_instance),
edge_detector_manager: Depends = Depends(get_edge_detector_manager),
):
image = await request.body()
img = Image.open(BytesIO(image))
Expand All @@ -44,9 +51,20 @@ async def post_image_query(
logger.debug("No motion detected")
new_image_query = ImageQuery(**motion_detector.image_query_response.dict())
new_image_query.id = prefixed_ksuid(prefix="iqe_")
edge_detector_manager.iqe_cache[new_image_query.id] = new_image_query

return new_image_query


@router.get("/{id}", response_model=ImageQuery)
async def get_image_query(id: str, gl: Depends = Depends(get_groundlight_sdk_instance)):
async def get_image_query(
id: str,
gl: Depends = Depends(get_groundlight_sdk_instance),
edge_detector_manager: Depends = Depends(get_edge_detector_manager),
):
if id.startswith("iqe_"):
image_query = edge_detector_manager.iqe_cache.get(id, None)
if not image_query:
raise HTTPException(status_code=404, detail=f"Image query with ID {id} not found")
return image_query
return safe_call_api(gl.get_image_query, id=id)
11 changes: 11 additions & 0 deletions app/core/edge_detector_manager.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
class EdgeDetectorManager:
"""
Fow now this class is just a container for the IQE cache.
The cache allows us to control the SDK's polling behavior for image queries
without having to change the SDK itself.
"""

def __init__(self) -> None:
# Cache for image query responses whose IDs start with "iqe_". This is needed
# because the cloud API does not currently recognize these IDs.
self.iqe_cache = {}
2 changes: 1 addition & 1 deletion app/core/motion_detection.py
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ async def motion_detected(self, new_img: np.ndarray) -> bool:
current_time = time.monotonic()
if current_time - self._previous_motion_detection_time > self._max_time_between_images:
self._previous_motion_detection_time = current_time
logger.debug("Maximum time between images exceeded")
logger.debug("Maximum time between cloud-submitted images exceeded")
return True

motion_is_detected = await asyncio.to_thread(self._motion_detector.motion_detected, new_img)
Expand Down
4 changes: 4 additions & 0 deletions app/core/utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,10 @@ def get_motion_detector_instance(request: Request):
return request.app.state.motion_detector


def get_edge_detector_manager(request: Request):
return request.app.state.edge_detector_manager


def safe_call_api(api_method: Callable, **kwargs):
"""
This ensures that we correctly handle HTTP error status codes. In some cases,
Expand Down
6 changes: 4 additions & 2 deletions app/main.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
from app.api.api import api_router, ping_router
from app.api.naming import API_BASE_PATH

from .core.edge_detector_manager import EdgeDetectorManager
from .core.motion_detection import AsyncMotionDetector, MotdetParameterSettings

LOG_LEVEL = os.environ.get("LOG_LEVEL", "INFO").upper()
Expand All @@ -21,7 +22,8 @@
# Create global shared Groundlight SDK client object in the app's state
app.state.groundlight = Groundlight()

parameters = MotdetParameterSettings()

# Create global shared motion detector object in the app's state
app.state.motion_detector = AsyncMotionDetector(parameters=MotdetParameterSettings())

# Create global shared edge detector manager object in the app's state
app.state.edge_detector_manager = EdgeDetectorManager()