[DOP-19778] Common error format (#95)

Co-authored-by: Ilyas Gasanov <izgasanov@mts.ru>

Author: IlyasDevelopment

docs/changelog/next_release/95.breaking.rst

@@ -0,0 +1 @@
+Implement a single error handling format to improve consistency

syncmaster/backend/__init__.py

@@ -1,6 +1,8 @@
 # SPDX-FileCopyrightText: 2023-2024 MTS PJSC
 # SPDX-License-Identifier: Apache-2.0
 from fastapi import FastAPI, HTTPException
+from fastapi.exceptions import RequestValidationError
+from pydantic import ValidationError
 from starlette.middleware.cors import CORSMiddleware
 
 from syncmaster.backend.api.deps import (
@@ -13,6 +15,8 @@
 from syncmaster.backend.handler import (
     http_exception_handler,
     syncmsater_exception_handler,
+    unknown_exception_handler,
+    validation_exception_handler,
 )
 from syncmaster.config import Settings
 from syncmaster.db.factory import create_engine, create_session_factory, get_uow
@@ -33,8 +37,11 @@ def application_factory(settings: Settings) -> FastAPI:
     )
 
     application.include_router(api_router)
-    application.exception_handler(HTTPException)(http_exception_handler)
+    application.exception_handler(RequestValidationError)(validation_exception_handler)
+    application.exception_handler(ValidationError)(validation_exception_handler)
     application.exception_handler(SyncmasterError)(syncmsater_exception_handler)
+    application.exception_handler(HTTPException)(http_exception_handler)
+    application.exception_handler(Exception)(unknown_exception_handler)
 
     engine = create_engine(connection_uri=settings.build_db_connection_uri())
     session_factory = create_session_factory(engine=engine)

syncmaster/backend/api/monitoring.py

@@ -2,7 +2,9 @@
 # SPDX-License-Identifier: Apache-2.0
 from fastapi import APIRouter
 
-router = APIRouter(tags=["monitoring"], prefix="/monitoring")
+from syncmaster.errors.registration import get_error_responses
+
+router = APIRouter(tags=["monitoring"], prefix="/monitoring", responses=get_error_responses())
 
 
 @router.get("/ping")

syncmaster/backend/api/v1/auth/router.py

@@ -7,10 +7,17 @@
 from syncmaster.backend.api.v1.auth.utils import sign_jwt
 from syncmaster.backend.services import UnitOfWork
 from syncmaster.config import Settings
+from syncmaster.errors.registration import get_error_responses
+from syncmaster.errors.schemas.invalid_request import InvalidRequestSchema
+from syncmaster.errors.schemas.not_authorized import NotAuthorizedSchema
 from syncmaster.exceptions import EntityNotFoundError
 from syncmaster.schemas.v1.auth import AuthTokenSchema
 
-router = APIRouter(prefix="/auth", tags=["Auth"])
+router = APIRouter(
+    prefix="/auth",
+    tags=["Auth"],
+    responses=get_error_responses(include={NotAuthorizedSchema, InvalidRequestSchema}),
+)
 
 
 @router.post("/token")

syncmaster/backend/api/v1/connections.py

@@ -9,6 +9,7 @@
 from syncmaster.backend.services import UnitOfWork, get_user
 from syncmaster.db.models import Connection, Transfer, User
 from syncmaster.db.utils import Permission
+from syncmaster.errors.registration import get_error_responses
 from syncmaster.exceptions import ActionNotAllowedError
 from syncmaster.exceptions.connection import (
     ConnectionDeleteError,
@@ -34,7 +35,7 @@
 from syncmaster.schemas.v1.page import MetaPageSchema
 from syncmaster.schemas.v1.status import StatusResponseSchema
 
-router = APIRouter(tags=["Connections"])
+router = APIRouter(tags=["Connections"], responses=get_error_responses())
 
 CONNECTION_TYPES = ORACLE_TYPE, POSTGRES_TYPE, HIVE_TYPE, S3_TYPE, HDFS_TYPE
 

syncmaster/backend/api/v1/groups.py

@@ -6,6 +6,7 @@
 from syncmaster.backend.services import UnitOfWork, get_user
 from syncmaster.db.models import User
 from syncmaster.db.utils import Permission
+from syncmaster.errors.registration import get_error_responses
 from syncmaster.exceptions import ActionNotAllowedError
 from syncmaster.exceptions.group import GroupNotFoundError
 from syncmaster.schemas.v1.groups import (
@@ -18,7 +19,7 @@
 from syncmaster.schemas.v1.status import StatusResponseSchema
 from syncmaster.schemas.v1.users import UserPageSchemaAsGroupMember
 
-router = APIRouter(tags=["Groups"])
+router = APIRouter(tags=["Groups"], responses=get_error_responses())
 
 
 @router.get("/groups")

syncmaster/backend/api/v1/queue.py

@@ -6,6 +6,7 @@
 from syncmaster.backend.services import UnitOfWork, get_user
 from syncmaster.db.models import User
 from syncmaster.db.utils import Permission
+from syncmaster.errors.registration import get_error_responses
 from syncmaster.exceptions import ActionNotAllowedError
 from syncmaster.exceptions.group import GroupNotFoundError
 from syncmaster.exceptions.queue import QueueDeleteError, QueueNotFoundError
@@ -17,7 +18,7 @@
 )
 from syncmaster.schemas.v1.status import StatusResponseSchema
 
-router = APIRouter(tags=["Queues"])
+router = APIRouter(tags=["Queues"], responses=get_error_responses())
 
 
 @router.get("/queues/{queue_id}", description="Read queue by id")

syncmaster/backend/api/v1/transfers.py

@@ -8,6 +8,7 @@
 from syncmaster.backend.services import UnitOfWork, get_user
 from syncmaster.db.models import Status, User
 from syncmaster.db.utils import Permission
+from syncmaster.errors.registration import get_error_responses
 from syncmaster.exceptions.base import ActionNotAllowedError
 from syncmaster.exceptions.connection import ConnectionNotFoundError
 from syncmaster.exceptions.group import GroupNotFoundError
@@ -38,7 +39,7 @@
 )
 from syncmaster.worker.config import celery
 
-router = APIRouter(tags=["Transfers"])
+router = APIRouter(tags=["Transfers"], responses=get_error_responses())
 
 
 @router.get("/transfers")

syncmaster/backend/api/v1/users.py

@@ -7,12 +7,13 @@
 from syncmaster.backend.api.deps import UnitOfWorkMarker
 from syncmaster.backend.services import UnitOfWork, get_user
 from syncmaster.db.models import User
+from syncmaster.errors.registration import get_error_responses
 from syncmaster.schemas.v1.users import ReadUserSchema, UserPageSchema
 
 logger = logging.getLogger(__name__)
 
 
-router = APIRouter(tags=["Users"])
+router = APIRouter(tags=["Users"], responses=get_error_responses())
 
 
 @router.get("/users")