kiba-core 0.5.3.dev94__tar.gz → 0.5.3.dev96__tar.gz

{kiba_core-0.5.3.dev94 → kiba_core-0.5.3.dev96}/CHANGELOG.md

@@ -8,6 +8,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 ## [Unreleased]
 
 ### Added
+- [MINOR] Added `excludedPaths` (exact) and `excludedPathPrefixes` to `DatabaseConnectionMiddleware`: matching requests run without a context connection, e.g. a long-lived SSE stream that shouldn't hold a pooled connection and open transaction, or routes that use a different database
+- [PATCH] Updated `ExceptionHandlingMiddleware` to answer a client that disconnects before the response starts (starlette's `ClientDisconnect`, e.g. while reading the body) with a 499 instead of logging a traceback and a 500
 - [MAJOR] Added `priority` to `SqlMessageQueue.send_message` and `send_messages` (default 0): visible messages are claimed highest priority first, then by `visibleDate`, and a duplicate send, or a retry folded into a pending duplicate, keeps the higher priority. `tbl_queue_messages` has a new `priority` column (`INTEGER NOT NULL DEFAULT 0`), so apps must add it with a migration before upgrading
 - [PATCH] Fixed `DatabaseConnectionMiddleware`'s commit when the response starts failing ("another operation is in progress") for streaming responses behind a `BaseHTTPMiddleware`: `Database.execute` and `Database.commit_context_connection` now wait for each other on the same connection
 - [MINOR] Added `Database.commit_context_connection` to commit the context connection's writes so far; anything run on it afterwards is committed when the context connection ends

{kiba_core-0.5.3.dev94 → kiba_core-0.5.3.dev96}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: kiba-core
-Version: 0.5.3.dev94
+Version: 0.5.3.dev96
 Summary: Kiba Labs' python utilities
 Project-URL: repository, https://github.com/kibalabs/core-py
 Requires-Python: <4,>=3.12

{kiba_core-0.5.3.dev94 → kiba_core-0.5.3.dev96}/core/api/middleware/database_connection_middleware.py

@@ -1,3 +1,5 @@
+from collections.abc import Collection
+
 from starlette.types import ASGIApp
 from starlette.types import Message
 from starlette.types import Receive
@@ -8,14 +10,16 @@ from core.store.database import Database
 
 
 class DatabaseConnectionMiddleware:
-    def __init__(self, app: ASGIApp, database: Database) -> None:
+    def __init__(self, app: ASGIApp, database: Database, excludedPaths: Collection[str] = (), excludedPathPrefixes: Collection[str] = ()) -> None:
         self.app = app
         self.database = database
+        self.excludedPaths = frozenset(excludedPaths)
+        self.excludedPathPrefixes = tuple(excludedPathPrefixes)
 
     # NOTE(krishan711): see note in database.py about why this can cause problems with concurrent operations
     # NOTE(krishan711): raw ASGI (not BaseHTTPMiddleware) so the DB connection stays open across streaming body
     async def __call__(self, scope: Scope, receive: Receive, send: Send) -> None:
-        if scope['type'] != 'http':
+        if scope['type'] != 'http' or scope['path'] in self.excludedPaths or scope['path'].startswith(self.excludedPathPrefixes):
             await self.app(scope, receive, send)
             return
         async with self.database.create_context_connection():

{kiba_core-0.5.3.dev94 → kiba_core-0.5.3.dev96}/core/api/middleware/exception_handling_middleware.py

@@ -1,5 +1,6 @@
 from starlette.middleware.base import BaseHTTPMiddleware
 from starlette.middleware.base import RequestResponseEndpoint
+from starlette.requests import ClientDisconnect
 from starlette.requests import Request
 from starlette.responses import Response
 from starlette.types import ASGIApp
@@ -29,6 +30,8 @@ class ExceptionHandlingMiddleware(BaseHTTPMiddleware):
         except RedirectException as exception:
             response = Response(status_code=exception.statusCode)
             response.headers.update(exception.outgoing_headers())
+        except ClientDisconnect:
+            response = Response(status_code=499)
         except ClientException as exception:
             if self.shouldSquashClientExceptions:
                 logging.error(f'{exception.exceptionType} occurred: {exception.message}')

{kiba_core-0.5.3.dev94 → kiba_core-0.5.3.dev96}/kiba_core.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: kiba-core
-Version: 0.5.3.dev94
+Version: 0.5.3.dev96
 Summary: Kiba Labs' python utilities
 Project-URL: repository, https://github.com/kibalabs/core-py
 Requires-Python: <4,>=3.12

{kiba_core-0.5.3.dev94 → kiba_core-0.5.3.dev96}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "kiba-core"
-version = "0.5.3.dev94"
+version = "0.5.3.dev96"
 description = "Kiba Labs' python utilities"
 readme = "README.md"
 requires-python = ">=3.12, <4"

{kiba_core-0.5.3.dev94 → kiba_core-0.5.3.dev96}/tests/api/test_database_connection_middleware.py

@@ -99,6 +99,28 @@ async def test_writes_are_rolled_back_when_the_request_fails_before_responding(d
     assert await get_record_names(database=database) == []
 
 
+@pytest.mark.asyncio
+@pytest.mark.parametrize(('path', 'isExcluded'), [('/live-events', True), ('/live-events/123', False), ('/mcp', True), ('/mcp/exports/token', True), ('/v1/mcp', False), ('/', False)])
+async def test_excluded_paths_run_without_a_context_connection(database, path, isExcluded):
+    hasContextConnectionHolder: list[bool] = []
+
+    async def app(scope, receive, send):
+        hasContextConnectionHolder.append(database._get_context_connection() is not None)
+        await send({'type': 'http.response.start', 'status': 200, 'headers': []})
+        await send({'type': 'http.response.body', 'body': b'ok'})
+
+    async def receive():
+        return {'type': 'http.request', 'body': b'', 'more_body': False}
+
+    async def send(message):
+        pass
+
+    middleware = DatabaseConnectionMiddleware(app=app, database=database, excludedPaths={'/live-events'}, excludedPathPrefixes=('/mcp',))
+    await middleware({'type': 'http', 'method': 'GET', 'path': path}, receive, send)
+
+    assert hasContextConnectionHolder == [not isExcluded]
+
+
 async def post_to_app(app) -> tuple[int, bytes]:
     scope = {
         'type': 'http', 'asgi': {'version': '3.0'}, 'http_version': '1.1', 'method': 'POST', 'scheme': 'http', 'path': '/', 'raw_path': b'/',

{kiba_core-0.5.3.dev94 → kiba_core-0.5.3.dev96}/tests/api/test_exception_handling_middleware.py

@@ -119,3 +119,24 @@ def test_plain_exception_has_no_extra_headers(plain_error_client):
     assert response.status_code == 400
     assert 'retry-after' not in response.headers
     assert 'location' not in response.headers
+
+
+@pytest.mark.asyncio
+async def test_client_disconnect_while_reading_body_returns_499():
+    @json_route(requestType=SimpleRequest, responseType=SimpleResponse)
+    async def endpoint(request: KibaApiRequest[SimpleRequest]) -> SimpleResponse:
+        return SimpleResponse(result=request.data.value)
+
+    app = Starlette(routes=[Route('/echo', endpoint, methods=['POST'])])
+    app.add_middleware(ExceptionHandlingMiddleware)
+    sentMessages = []
+
+    async def receive():
+        return {'type': 'http.disconnect'}
+
+    async def send(message):
+        sentMessages.append(message)
+
+    scope = {'type': 'http', 'asgi': {'version': '3.0'}, 'method': 'POST', 'path': '/echo', 'headers': [(b'content-type', b'application/json')], 'query_string': b''}
+    await app(scope, receive, send)
+    assert sentMessages[0]['status'] == 499