Merge pull request #498 from uhh-lt/improve-tags-codes

Query Performance Improvements

Author: bigabig

.pre-commit-config.yaml

@@ -22,8 +22,8 @@ repos:
       - id: pyright
         name: "Pyright"
         types: [python]
-        entry: bash -c 'ENV_NAME=dats source backend/_activate_current_env.sh && pyright $@'
-        language: system
+        entry: ./bin/run-pyright.sh
+        language: script
   - repo: https://github.com/pre-commit/mirrors-eslint
     rev: v9.11.0
     hooks:

backend/src/api/dependencies.py

@@ -42,18 +42,6 @@ async def skip_limit_params(
     return result
 
 
-async def resolve_code_param(
-    resolve: bool = Query(
-        title="Resolve Code",
-        description="If true, the code_id of the"
-        " SpanAnnotation gets resolved and replaced"
-        " by the respective Code entity",
-        default=True,
-    ),
-) -> bool:
-    return resolve
-
-
 async def get_db_session() -> AsyncGenerator[Session, None]:
     session = SQLService().session_maker()
     try:

backend/src/api/endpoints/bbox_annotation.py

@@ -1,27 +1,21 @@
-from typing import List, Union
+from typing import List
 
 from fastapi import APIRouter, Depends
 from sqlalchemy.orm import Session
 
 from api.dependencies import (
     get_current_user,
     get_db_session,
-    resolve_code_param,
 )
-from api.util import get_object_memo_for_user, get_object_memos
 from app.core.authorization.authz_user import AuthzUser
 from app.core.data.crud import Crud
 from app.core.data.crud.bbox_annotation import crud_bbox_anno
 from app.core.data.dto.bbox_annotation import (
     BBoxAnnotationCreate,
     BBoxAnnotationRead,
-    BBoxAnnotationReadResolved,
     BBoxAnnotationUpdate,
 )
 from app.core.data.dto.code import CodeRead
-from app.core.data.dto.memo import (
-    MemoRead,
-)
 
 router = APIRouter(
     prefix="/bbox", dependencies=[Depends(get_current_user)], tags=["bboxAnnotation"]
@@ -30,81 +24,69 @@
 
 @router.put(
     "",
-    response_model=Union[BBoxAnnotationRead, BBoxAnnotationReadResolved],
+    response_model=BBoxAnnotationRead,
     summary="Creates a BBoxAnnotation",
 )
 def add_bbox_annotation(
     *,
     db: Session = Depends(get_db_session),
     bbox: BBoxAnnotationCreate,
-    resolve_code: bool = Depends(resolve_code_param),
     authz_user: AuthzUser = Depends(),
-) -> Union[BBoxAnnotationRead, BBoxAnnotationReadResolved]:
+) -> BBoxAnnotationRead:
     authz_user.assert_in_same_project_as(Crud.SOURCE_DOCUMENT, bbox.sdoc_id)
     authz_user.assert_in_same_project_as(Crud.CODE, bbox.code_id)
 
     db_obj = crud_bbox_anno.create(db=db, user_id=authz_user.user.id, create_dto=bbox)
-    if resolve_code:
-        return BBoxAnnotationReadResolved.model_validate(db_obj)
-    else:
-        return BBoxAnnotationRead.model_validate(db_obj)
+    return BBoxAnnotationRead.model_validate(db_obj)
 
 
 @router.get(
     "/{bbox_id}",
-    response_model=Union[BBoxAnnotationRead, BBoxAnnotationReadResolved],
+    response_model=BBoxAnnotationRead,
     summary="Returns the BBoxAnnotation with the given ID.",
 )
 def get_by_id(
     *,
     db: Session = Depends(get_db_session),
     bbox_id: int,
-    resolve_code: bool = Depends(resolve_code_param),
     authz_user: AuthzUser = Depends(),
-) -> Union[BBoxAnnotationRead, BBoxAnnotationReadResolved]:
+) -> BBoxAnnotationRead:
     authz_user.assert_in_same_project_as(Crud.BBOX_ANNOTATION, bbox_id)
 
     db_obj = crud_bbox_anno.read(db=db, id=bbox_id)
-    if resolve_code:
-        return BBoxAnnotationReadResolved.model_validate(db_obj)
-    else:
-        return BBoxAnnotationRead.model_validate(db_obj)
+    return BBoxAnnotationRead.model_validate(db_obj)
 
 
 @router.patch(
     "/{bbox_id}",
-    response_model=Union[BBoxAnnotationRead, BBoxAnnotationReadResolved],
+    response_model=BBoxAnnotationRead,
     summary="Updates the BBoxAnnotation with the given ID.",
 )
 def update_by_id(
     *,
     db: Session = Depends(get_db_session),
     bbox_id: int,
     bbox_anno: BBoxAnnotationUpdate,
-    resolve_code: bool = Depends(resolve_code_param),
     authz_user: AuthzUser = Depends(),
-) -> Union[BBoxAnnotationRead, BBoxAnnotationReadResolved]:
+) -> BBoxAnnotationRead:
     authz_user.assert_in_same_project_as(Crud.BBOX_ANNOTATION, bbox_id)
     authz_user.assert_in_same_project_as(Crud.CODE, bbox_anno.code_id)
 
     db_obj = crud_bbox_anno.update(db=db, id=bbox_id, update_dto=bbox_anno)
-    if resolve_code:
-        return BBoxAnnotationReadResolved.model_validate(db_obj)
-    else:
-        return BBoxAnnotationRead.model_validate(db_obj)
+    return BBoxAnnotationRead.model_validate(db_obj)
 
 
 @router.delete(
     "/{bbox_id}",
-    response_model=Union[BBoxAnnotationRead, BBoxAnnotationReadResolved],
+    response_model=BBoxAnnotationRead,
     summary="Deletes the BBoxAnnotation with the given ID.",
 )
 def delete_by_id(
     *,
     db: Session = Depends(get_db_session),
     bbox_id: int,
     authz_user: AuthzUser = Depends(),
-) -> Union[BBoxAnnotationRead, BBoxAnnotationReadResolved]:
+) -> BBoxAnnotationRead:
     authz_user.assert_in_same_project_as(Crud.BBOX_ANNOTATION, bbox_id)
 
     db_obj = crud_bbox_anno.remove(db=db, id=bbox_id)
@@ -128,43 +110,6 @@ def get_code(
     return CodeRead.model_validate(bbox_db_obj.code)
 
 
-@router.get(
-    "/{bbox_id}/memo",
-    response_model=List[MemoRead],
-    summary="Returns the Memos attached to the BBoxAnnotation with the given ID if it exists.",
-)
-def get_memos(
-    *,
-    db: Session = Depends(get_db_session),
-    bbox_id: int,
-    authz_user: AuthzUser = Depends(),
-) -> List[MemoRead]:
-    authz_user.assert_in_same_project_as(Crud.BBOX_ANNOTATION, bbox_id)
-
-    db_obj = crud_bbox_anno.read(db=db, id=bbox_id)
-    # TODO how to authorize memo access here?
-    return get_object_memos(db_obj=db_obj)
-
-
-@router.get(
-    "/{bbox_id}/memo/user",
-    response_model=MemoRead,
-    summary=(
-        "Returns the Memo attached to the BBoxAnnotation with the given ID of the logged-in User if it exists."
-    ),
-)
-def get_user_memo(
-    *,
-    db: Session = Depends(get_db_session),
-    bbox_id: int,
-    authz_user: AuthzUser = Depends(),
-) -> MemoRead:
-    authz_user.assert_in_same_project_as(Crud.BBOX_ANNOTATION, bbox_id)
-
-    db_obj = crud_bbox_anno.read(db=db, id=bbox_id)
-    return get_object_memo_for_user(db_obj=db_obj, user_id=authz_user.user.id)
-
-
 @router.get(
     "/code/{code_id}/user",
     response_model=List[BBoxAnnotationRead],

backend/src/api/endpoints/code.py

@@ -1,17 +1,11 @@
-from typing import List
-
 from fastapi import APIRouter, Depends
 from sqlalchemy.orm import Session
 
 from api.dependencies import get_current_user, get_db_session
-from api.util import get_object_memo_for_user, get_object_memos
 from app.core.authorization.authz_user import AuthzUser
 from app.core.data.crud import Crud
 from app.core.data.crud.code import crud_code
 from app.core.data.dto.code import CodeCreate, CodeRead, CodeUpdate
-from app.core.data.dto.memo import (
-    MemoRead,
-)
 
 router = APIRouter(
     prefix="/code", dependencies=[Depends(get_current_user)], tags=["code"]
@@ -87,39 +81,3 @@ def delete_by_id(
 
     db_obj = crud_code.remove(db=db, id=code_id)
     return CodeRead.model_validate(db_obj)
-
-
-@router.get(
-    "/{code_id}/memo",
-    response_model=List[MemoRead],
-    summary="Returns the Memo attached to the Code with the given ID if it exists.",
-)
-def get_memos(
-    *,
-    db: Session = Depends(get_db_session),
-    code_id: int,
-    authz_user: AuthzUser = Depends(),
-) -> List[MemoRead]:
-    authz_user.assert_in_same_project_as(Crud.CODE, code_id)
-
-    db_obj = crud_code.read(db=db, id=code_id)
-    return get_object_memos(db_obj=db_obj)
-
-
-@router.get(
-    "/{code_id}/memo/user",
-    response_model=MemoRead,
-    summary=(
-        "Returns the Memo attached to the Code with the given ID of the logged-in User if it exists."
-    ),
-)
-def get_user_memo(
-    *,
-    db: Session = Depends(get_db_session),
-    code_id: int,
-    authz_user: AuthzUser = Depends(),
-) -> MemoRead:
-    authz_user.assert_in_same_project_as(Crud.CODE, code_id)
-
-    db_obj = crud_code.read(db=db, id=code_id)
-    return get_object_memo_for_user(db_obj=db_obj, user_id=authz_user.user.id)

backend/src/api/endpoints/document_tag.py

@@ -4,7 +4,6 @@
 from sqlalchemy.orm import Session
 
 from api.dependencies import get_current_user, get_db_session
-from api.util import get_object_memo_for_user, get_object_memos
 from api.validation import Validate
 from app.core.authorization.authz_user import AuthzUser
 from app.core.data.crud import Crud
@@ -16,9 +15,6 @@
     SourceDocumentDocumentTagLinks,
     SourceDocumentDocumentTagMultiLink,
 )
-from app.core.data.dto.memo import (
-    MemoRead,
-)
 
 router = APIRouter(
     prefix="/doctag", dependencies=[Depends(get_current_user)], tags=["documentTag"]
@@ -228,42 +224,6 @@ def delete_by_id(
     return DocumentTagRead.model_validate(db_obj)
 
 
-@router.get(
-    "/{tag_id}/memo",
-    response_model=List[MemoRead],
-    summary="Returns the Memos attached to the DocumentTag with the given ID if it exists.",
-)
-def get_memos(
-    *,
-    db: Session = Depends(get_db_session),
-    tag_id: int,
-    authz_user: AuthzUser = Depends(),
-) -> List[MemoRead]:
-    authz_user.assert_in_same_project_as(Crud.DOCUMENT_TAG, tag_id)
-
-    db_obj = crud_document_tag.read(db=db, id=tag_id)
-    return get_object_memos(db_obj=db_obj)
-
-
-@router.get(
-    "/{tag_id}/memo/user",
-    response_model=MemoRead,
-    summary=(
-        "Returns the Memo attached to the document tag with the given ID of the logged-in User if it exists."
-    ),
-)
-def get_user_memo(
-    *,
-    db: Session = Depends(get_db_session),
-    tag_id: int,
-    authz_user: AuthzUser = Depends(),
-) -> MemoRead:
-    authz_user.assert_in_same_project_as(Crud.DOCUMENT_TAG, tag_id)
-
-    db_obj = crud_document_tag.read(db=db, id=tag_id)
-    return get_object_memo_for_user(db_obj=db_obj, user_id=authz_user.user.id)
-
-
 @router.get(
     "/{tag_id}/sdocs",
     response_model=List[int],