refactored out the events from the main Fast_API, and now we have a new Fast_API__With_Events that captures that (and can be used when events want to be captured)

added Middleware__Request_ID so that we always have an request id (specially when not using the events capture)

Author: DinisCruz

osbot_fast_api/api/Fast_API.py

@@ -1,3 +1,5 @@
+from osbot_fast_api.api.middlewares.Middleware__Http_Request import Middleware__Http_Request
+from osbot_fast_api.api.middlewares.Middleware__Request_ID import Middleware__Request_ID
 from osbot_fast_api.schemas.Schema__Fast_API__Config                            import Schema__Fast_API__Config
 from osbot_utils.type_safe.Type_Safe                                            import Type_Safe
 from osbot_utils.decorators.lists.index_by                                      import index_by
@@ -6,32 +8,20 @@
 from osbot_utils.utils.Json                                                     import json_loads, json_dumps
 from starlette.staticfiles                                                      import StaticFiles
 from osbot_fast_api.api.Fast_API__Offline_Docs                                  import Fast_API__Offline_Docs, FILE_PATH__STATIC__DOCS, URL__STATIC__DOCS, NAME__STATIC__DOCS
-from osbot_fast_api.api.events.Fast_API__Http_Events                            import Fast_API__Http_Events
 from osbot_fast_api.api.routes.Routes__Config                                   import Routes__Config
 from osbot_fast_api.api.routes.Routes__Set_Cookie                               import Routes__Set_Cookie
 from osbot_fast_api.schemas.consts.consts__Fast_API                             import ENV_VAR__FAST_API__AUTH__API_KEY__NAME, ENV_VAR__FAST_API__AUTH__API_KEY__VALUE
 
 
 
 class Fast_API(Type_Safe):
-    # base_path      : Safe_Str__Fast_API__Route__Prefix = '/'
-    # add_admin_ui   : bool                     = False
-    # docs_offline   : bool                     = True
-    # enable_cors    : bool                     = False
-    # enable_api_key : bool                     = False
-    # default_routes : bool                     = True
-    # name           : Safe_Str__Fast_API__Name = None
-    # version        : Safe_Str__Version        = version__osbot_fast_api
-    # description    : Safe_Str__Text           = None
     config         : Schema__Fast_API__Config
-    http_events    : Fast_API__Http_Events
     server_id      : Random_Guid
 
     def __init__(self, **kwargs):
         super().__init__(**kwargs)
         if not self.config.name:
-            self.config.name           = self.__class__.__name__
-        self.http_events.fast_api_name = self.config.name
+            self.config.name           = self.__class__.__name__                # this makes the api name more user friendly
 
     # todo: improve the error handling of validation errors (namely from Type_Safe_Primitive)
     #       see code example in https://claude.ai/chat/f443e322-fa43-487f-9dd9-2d4cfb261b1e
@@ -166,8 +156,8 @@ def routes_paths_all(self):
 
 
     def setup_middlewares(self):                 # overwrite to add more middlewares
+        self.setup_middleware__request_id       ()                                      # sets the 'fast-api-request-id' headers
         self.setup_middleware__detect_disconnect()
-        self.setup_middleware__http_events      ()
         self.setup_middleware__cors             ()
         self.setup_middleware__api_key_check    ()
         return self
@@ -230,12 +220,8 @@ def setup_middleware__detect_disconnect(self):
 
         self.app().add_middleware(Middleware__Detect_Disconnect)
 
-    def setup_middleware__http_events(self):
-        from osbot_fast_api.api.middlewares.Middleware__Http_Request import Middleware__Http_Request
-
-        self.app().add_middleware(Middleware__Http_Request , http_events=self.http_events)
-        return self
-
+    def setup_middleware__request_id(self):
+        self.app().add_middleware(Middleware__Request_ID)
 
     def user_middlewares(self, include_params=True):
         import types

osbot_fast_api/api/events/Fast_API__Http_Event.py

@@ -1,16 +1,16 @@
 import logging
 import time
-from decimal                                            import Decimal
-from fastapi                                            import Response, Request
-from osbot_fast_api.api.events.Fast_API__Http_Event__Info      import Fast_API__Http_Event__Info
-from osbot_fast_api.api.events.Fast_API__Http_Event__Request   import Fast_API__Http_Event__Request
-from osbot_fast_api.api.events.Fast_API__Http_Event__Response  import Fast_API__Http_Event__Response
-from osbot_fast_api.api.events.Fast_API__Http_Event__Traces    import Fast_API__Http_Event__Traces
-from osbot_utils.type_safe.Type_Safe                 import Type_Safe
-from osbot_utils.type_safe.primitives.domains.identifiers.Random_Guid                    import Random_Guid
-from osbot_utils.helpers.trace.Trace_Call               import Trace_Call
-from osbot_utils.utils.Misc                             import timestamp_utc_now, current_thread_id, str_to_bytes
-from osbot_utils.utils.Objects                          import pickle_to_bytes
+from decimal                                                            import Decimal
+from fastapi                                                            import Response, Request
+from osbot_fast_api.api.events.Fast_API__Http_Event__Info               import Fast_API__Http_Event__Info
+from osbot_fast_api.api.events.Fast_API__Http_Event__Request            import Fast_API__Http_Event__Request
+from osbot_fast_api.api.events.Fast_API__Http_Event__Response           import Fast_API__Http_Event__Response
+from osbot_fast_api.api.events.Fast_API__Http_Event__Traces             import Fast_API__Http_Event__Traces
+from osbot_utils.type_safe.Type_Safe                                    import Type_Safe
+from osbot_utils.type_safe.primitives.domains.identifiers.Random_Guid   import Random_Guid
+from osbot_utils.helpers.trace.Trace_Call                               import Trace_Call
+from osbot_utils.utils.Misc                                             import timestamp_utc_now, current_thread_id, str_to_bytes
+from osbot_utils.utils.Objects                                          import pickle_to_bytes
 
 HEADER_NAME__FAST_API_REQUEST_ID   = 'fast-api-request-id'
 HEADER_NAME__CACHE_CONTROL         = "cache-control"

osbot_fast_api/api/middlewares/Middleware__Request_ID.py

@@ -0,0 +1,20 @@
+from fastapi                                                          import Request, Response
+from osbot_utils.utils.Misc                                           import str_to_bytes
+from starlette.middleware.base                                        import BaseHTTPMiddleware
+from osbot_utils.type_safe.primitives.domains.identifiers.Random_Guid import Random_Guid
+
+
+class Middleware__Request_ID(BaseHTTPMiddleware):                                           # Lightweight middleware for request ID generation and propagation
+
+    async def dispatch(self, request: Request, call_next) -> Response:
+        request_id               = Random_Guid()                                            # Generate request ID once
+        request.state.request_id = request_id                                               # Make available during request processing
+
+
+        request.headers._list.append((b'fast-api-request-id', str_to_bytes(request_id)))    # Also add to request headers for consistency (though request.state is the preferred access method)
+
+        response = await call_next(request)                                                 # Process request
+
+        response.headers['fast-api-request-id'] = str(request_id)                           # Add to response headers for client
+
+        return response

osbot_fast_api/api/routes/Fast_API__Routes.py

@@ -1,16 +1,16 @@
 import functools
 import inspect
-from typing                                                         import get_type_hints
-from fastapi                                                        import APIRouter, FastAPI, HTTPException
-from osbot_utils.type_safe.Type_Safe                                import Type_Safe
-from osbot_utils.decorators.lists.index_by                          import index_by
-from osbot_utils.type_safe.Type_Safe__Primitive                     import Type_Safe__Primitive
-from fastapi.exceptions                                             import RequestValidationError
-from osbot_utils.type_safe.type_safe_core.shared.Type_Safe__Cache   import type_safe_cache
-from osbot_fast_api.api.routes.Fast_API__Route__Parser              import Fast_API__Route__Parser
-from osbot_fast_api.api.transformers.Type_Safe__To__BaseModel       import type_safe__to__basemodel
-from osbot_fast_api.schemas.safe_str.Safe_Str__Fast_API__Route__Prefix       import Safe_Str__Fast_API__Route__Prefix
-from osbot_fast_api.schemas.safe_str.Safe_Str__Fast_API__Route__Tag          import Safe_Str__Fast_API__Route__Tag
+from typing                                                              import get_type_hints
+from fastapi                                                             import APIRouter, FastAPI, HTTPException
+from osbot_utils.type_safe.Type_Safe                                     import Type_Safe
+from osbot_utils.decorators.lists.index_by                               import index_by
+from osbot_utils.type_safe.Type_Safe__Primitive                          import Type_Safe__Primitive
+from fastapi.exceptions                                                  import RequestValidationError
+from osbot_utils.type_safe.type_safe_core.shared.Type_Safe__Cache        import type_safe_cache
+from osbot_fast_api.api.routes.Fast_API__Route__Parser                   import Fast_API__Route__Parser
+from osbot_fast_api.api.transformers.Type_Safe__To__BaseModel            import type_safe__to__basemodel
+from osbot_fast_api.schemas.safe_str.Safe_Str__Fast_API__Route__Prefix   import Safe_Str__Fast_API__Route__Prefix
+from osbot_fast_api.schemas.safe_str.Safe_Str__Fast_API__Route__Tag      import Safe_Str__Fast_API__Route__Tag
 
 
 class Fast_API__Routes(Type_Safe):       # refactor to Fast_API__Routes

osbot_fast_api/events/Fast_API__With_Events.py

@@ -0,0 +1,61 @@
+from osbot_fast_api.api.Fast_API                        import Fast_API
+from osbot_fast_api.api.events.Fast_API__Http_Events    import Fast_API__Http_Events
+
+
+class Fast_API__With_Events(Fast_API):
+    http_events : Fast_API__Http_Events                                       # Only in this subclass
+
+    def __init__(self, **kwargs):
+        super().__init__(**kwargs)
+        self.http_events.fast_api_name = self.config.name                     # Wire up the name
+
+    def setup_middlewares(self):                                              # Add event middleware
+        super().setup_middlewares()                                           # Call parent middlewares first
+        self.setup_middleware__http_events()                                  # Then add events
+        return self
+
+    def setup_middleware__http_events(self):                                  # Moved from base class
+        from osbot_fast_api.api.middlewares.Middleware__Http_Request import Middleware__Http_Request
+
+        self.app().add_middleware(Middleware__Http_Request, http_events=self.http_events)
+        return self
+
+    def event_id(self, request):                                              # Event tracking methods
+        return self.http_events.event_id(request)
+
+    def request_data(self, request):
+        return self.http_events.request_data(request)
+
+    def request_messages(self, request):
+        return self.http_events.request_messages(request)
+
+    def add_background_task(self, task):                                      # Background task management
+        self.http_events.background_tasks.append(task)
+        return self
+
+    def enable_request_tracing(self, config=None):                            # Tracing configuration
+        self.http_events.trace_calls = True
+        if config:
+            self.http_events.trace_call_config = config
+        return self
+
+    def disable_request_tracing(self):
+        self.http_events.trace_calls = False
+        return self
+
+    def set_callback_on_request(self, callback):                              # Event callbacks
+        self.http_events.callback_on_request = callback
+        return self
+
+    def set_callback_on_response(self, callback):
+        self.http_events.callback_on_response = callback
+        return self
+
+    def get_recent_requests(self, count=10):                                  # Request history
+        recent = list(self.http_events.requests_order)[-count:]
+        return [self.http_events.requests_data.get(event_id) for event_id in recent]
+
+    def clear_request_history(self):
+        self.http_events.requests_data.clear()
+        self.http_events.requests_order.clear()
+        return self

osbot_fast_api/events/__init__.py

@@ -1,5 +1,4 @@
 import logging
-
 import pytest
 from collections                                      import deque
 from decimal                                          import Decimal

tests/unit/api/events/test_Fast_API__Http_Events.py

@@ -1,7 +1,7 @@
 from unittest                                                   import TestCase
 from osbot_fast_api.api.Fast_API                                import Fast_API, ENV_VAR__FAST_API__AUTH__API_KEY__NAME, ENV_VAR__FAST_API__AUTH__API_KEY__VALUE
 from osbot_fast_api.api.middlewares.Middleware__Check_API_Key   import ERROR_MESSAGE__NO_KEY_NAME_SETUP, ERROR_MESSAGE__NO_KEY_VALUE_SETUP, ERROR_MESSAGE__API_KEY_MISSING
-from osbot_fast_api.schemas.consts.consts__Fast_API import AUTH__EXCLUDED_PATHS
+from osbot_fast_api.schemas.consts.consts__Fast_API             import AUTH__EXCLUDED_PATHS
 from osbot_fast_api.utils.Fast_API__Server_Info                 import fast_api__server_info
 from osbot_utils.testing.Temp_Env_Vars                          import Temp_Env_Vars
 from osbot_utils.utils.Status                                   import status_error

tests/unit/api/middlewares/test_MIddleware__Check_API_Key.py

@@ -1,10 +1,9 @@
-from unittest                                                 import TestCase
-from fastapi                                                  import Request
-
-from osbot_fast_api.schemas.Schema__Fast_API__Config import Schema__Fast_API__Config
-from osbot_utils.type_safe.Type_Safe                          import Type_Safe
-from osbot_fast_api.api.Fast_API                              import Fast_API
-from osbot_fast_api.api.routes.Fast_API__Routes               import Fast_API__Routes
+from unittest                                                          import TestCase
+from fastapi                                                           import Request
+from osbot_fast_api.schemas.Schema__Fast_API__Config                   import Schema__Fast_API__Config
+from osbot_utils.type_safe.Type_Safe                                   import Type_Safe
+from osbot_fast_api.api.Fast_API                                       import Fast_API
+from osbot_fast_api.api.routes.Fast_API__Routes                        import Fast_API__Routes
 from osbot_fast_api.schemas.safe_str.Safe_Str__Fast_API__Route__Prefix import Safe_Str__Fast_API__Route__Prefix
 
 

tests/unit/api/routes/test_Fast_API__Routes__client.py

@@ -1,6 +1,6 @@
-from unittest                                   import TestCase
-from osbot_fast_api.api.Fast_API                import Fast_API
-from osbot_fast_api.api.routes.Fast_API__Routes import Fast_API__Routes
+from unittest                                        import TestCase
+from osbot_fast_api.api.Fast_API                     import Fast_API
+from osbot_fast_api.api.routes.Fast_API__Routes      import Fast_API__Routes
 from osbot_fast_api.schemas.Schema__Fast_API__Config import Schema__Fast_API__Config