Merge pull request #16 from cloudblue/enh/LITE-26853

LITE-26853 Better handling of DB and Client Server errors

Author: maxipavlovic

CHANGELOG.md

@@ -13,4 +13,5 @@
     * `c-` for Connect SPA directly borrowed ones
     * `ez-` for Connect SPA components replicas
     * `ui-` for ones imported from Connect UI Toolkit
-  * Table columns now may be styled directly with a column descriptor `style` property
+  * Table columns now may be styled directly with a column descriptor `style` property
+* 0.2.3: Better handling of DB and Client Server errors

Dockerfile

@@ -1,4 +1,4 @@
-FROM cloudblueconnect/connect-extension-runner:27.16
+FROM cloudblueconnect/connect-extension-runner:27.17
 
 COPY pyproject.toml /install_temp/.
 COPY poetry.* /install_temp/.

dbaas/extension.json

@@ -1,9 +1,9 @@
 {
   "name": "DBaaS",
   "description": "On-demand provisioning of cloud-based database storages as a service.",
-  "version": "0.2.2",
+  "version": "0.2.3",
   "audience": ["reseller", "distributor", "vendor"],
-  "readme_url": "https://github.com/cloudblue/connect-extension-dbaas/blob/0.2.2/README.md",
-  "changelog_url": "https://github.com/cloudblue/connect-extension-dbaas/blob/0.2.2/CHANGELOG.md",
+  "readme_url": "https://github.com/cloudblue/connect-extension-dbaas/blob/0.2.3/README.md",
+  "changelog_url": "https://github.com/cloudblue/connect-extension-dbaas/blob/0.2.3/CHANGELOG.md",
   "icon": "googleExtensionBaseline"
 }

dbaas/webapp.py

@@ -7,6 +7,7 @@
 from logging import LoggerAdapter
 from typing import Optional
 
+from connect.client import ClientError
 from connect.eaas.core.decorators import (
     devops_pages,
     proxied_connect_api,
@@ -39,14 +40,16 @@
 _db_id_type = constr(strict=True, max_length=16)
 
 
-async def handle_db_exceptions_mw(request: Request, call_next) -> responses.Response:
-    try:
-        response = await call_next(request)
+async def na_exception_handler(request: Request, exc: Exception) -> responses.JSONResponse:
+    return responses.JSONResponse({'message': 'Service Unavailable.'}, status_code=503)
 
-    except DBException:
-        response = responses.JSONResponse({'message': 'Service Unavailable.'}, status_code=503)
 
-    return response
+async def client_error_handler(request: Request, exc: ClientError) -> responses.JSONResponse:
+    if (not exc.status_code) or exc.status_code >= 500:
+        return await na_exception_handler(request, exc)
+
+    message = exc.errors[0] if exc.errors else exc.message
+    return responses.JSONResponse({'message': message}, status_code=400)
 
 
 @web_app(router)
@@ -60,8 +63,11 @@ async def handle_db_exceptions_mw(request: Request, call_next) -> responses.Resp
 ])
 class DBaaSWebApplication(WebApplicationBase):
     @classmethod
-    def get_middlewares(cls):
-        return [handle_db_exceptions_mw]
+    def get_exception_handlers(cls, _):
+        return {
+            ClientError: client_error_handler,
+            DBException: na_exception_handler,
+        }
 
     @router.get(
         '/v1/databases',

package-lock.json

@@ -14,7 +14,7 @@ readme = "./README.md"
 
 [tool.poetry.dependencies]
 python = ">=3.8,<4"
-connect-eaas-core = ">=27.10,<28"
+connect-eaas-core = ">=27.13,<28"
 motor = "3.*"
 cryptography = "39.*"
 

poetry.lock

@@ -3,7 +3,6 @@
 # Copyright (c) 2023, Ingram Micro
 # All rights reserved.
 #
-from unittest.mock import AsyncMock
 
 import pytest
 from connect.client import ClientError
@@ -18,7 +17,7 @@
     DatabaseOutList,
     RegionOut,
 )
-from dbaas.webapp import DBaaSWebApplication, handle_db_exceptions_mw
+from dbaas.webapp import client_error_handler, DBaaSWebApplication, na_exception_handler
 
 from tests.constants import DB_DEP_MOCK, INSTALLATION_CLIENT_DEP_MOCK
 from tests.factories import DBFactory, RegionFactory
@@ -29,45 +28,37 @@
 
 
 @pytest.mark.asyncio
-async def test_handle_db_exceptions_mw_no_exceptions():
-    call_next = AsyncMock(return_value='response')
+@pytest.mark.parametrize('error, body, code', (
+    (ClientError(message='abc', status_code=400), b'{"message":"abc"}', 400),
+    (ClientError(message='abc', status_code=404), b'{"message":"abc"}', 400),
+    (ClientError(message='abc'), b'{"message":"Service Unavailable."}', 503),
+    (ClientError(message='abc', status_code=500), b'{"message":"Service Unavailable."}', 503),
+    (ClientError(errors=['cbd'], status_code=503), b'{"message":"Service Unavailable."}', 503),
+    (ClientError(errors=['cbd', 'abc'], message="x", status_code=404), b'{"message":"cbd"}', 400),
+))
+async def test_client_error_handler(error, body, code):
+    result = await client_error_handler(None, error)
 
-    result = await handle_db_exceptions_mw('request', call_next)
-    assert result == 'response'
-
-    call_next.assert_called_once_with('request')
+    assert result.status_code == code
+    assert result.body == body
 
 
 @pytest.mark.asyncio
 @pytest.mark.parametrize('error_cls', (PyMongoError, ServerSelectionTimeoutError))
-async def test_handle_db_exceptions_mw_db_exception(error_cls):
-    def raise_err(*a):
-        raise error_cls('test')
-
-    call_next = AsyncMock(side_effect=raise_err)
+async def test_na_exception_handler(error_cls):
+    result = await na_exception_handler(None, error_cls)
 
-    result = await handle_db_exceptions_mw('request1', call_next)
     assert result.status_code == 503
+    assert result.body == b'{"message":"Service Unavailable."}'
 
-    call_next.assert_called_once_with('request1')
-
-
-@pytest.mark.asyncio
-@pytest.mark.parametrize('error_cls', (RuntimeError, ClientError))
-async def test_handle_db_exceptions_mw_other_exception(error_cls):
-    def raise_err(*a):
-        raise error_cls('test')
 
-    call_next = AsyncMock(side_effect=raise_err)
+def test_get_exception_handlers():
+    handlers = DBaaSWebApplication.get_exception_handlers({RuntimeError: None})
 
-    with pytest.raises(error_cls):
-        await handle_db_exceptions_mw('request', call_next)
-
-    call_next.assert_called_once_with('request')
-
-
-def test_get_middlewares():
-    assert DBaaSWebApplication.get_middlewares() == [handle_db_exceptions_mw]
+    assert handlers == {
+        ClientError: client_error_handler,
+        PyMongoError: na_exception_handler,
+    }
 
 
 @pytest.mark.asyncio