Merge pull request #217 from python-ellar/application_context

fix: Application Context Round Usage

Author: eadwinCode

ellar/app/__init__.py

@@ -1,4 +1,5 @@
-from .context import config, current_injector
+from ellar.core.context import config, current_injector
+
 from .factory import AppFactory
 from .main import App
 

ellar/app/factory.py

@@ -7,14 +7,14 @@
 from ellar.common.constants import MODULE_METADATA, MODULE_WATERMARK
 from ellar.common.models import GuardCanActivate
 from ellar.core import Config, DynamicModule, LazyModuleImport, ModuleBase, ModuleSetup
+from ellar.core.context import ApplicationContext
 from ellar.core.modules import ModuleRefBase
 from ellar.di import EllarInjector, ProviderConfig
 from ellar.reflect import reflect
 from ellar.threading.sync_worker import execute_async_context_manager
 from ellar.utils import get_name, get_unique_type
 from starlette.routing import BaseRoute, Host, Mount
 
-from .context import ApplicationContext
 from .main import App
 from .services import EllarAppService
 

ellar/app/main.py

@@ -3,10 +3,14 @@
 import logging.config
 import typing as t
 
-from ellar.app.context import ApplicationContext
 from ellar.auth.handlers import AuthenticationHandlerType
 from ellar.auth.middleware import IdentityMiddleware, SessionMiddleware
-from ellar.common import GlobalGuard, IIdentitySchemes
+from ellar.common import (
+    GlobalGuard,
+    IHostContext,
+    IHostContextFactory,
+    IIdentitySchemes,
+)
 from ellar.common.compatible import cached_property
 from ellar.common.constants import (
     ELLAR_LOG_FMT_STRING,
@@ -21,12 +25,13 @@
 from ellar.common.types import ASGIApp, TReceive, TScope, TSend
 from ellar.core.conf import Config
 from ellar.core.connection import Request
+from ellar.core.context import ApplicationContext
 from ellar.core.middleware import (
     CORSMiddleware,
     ExceptionMiddleware,
     Middleware,
-    RequestServiceProviderMiddleware,
     RequestVersioningMiddleware,
+    ServerErrorMiddleware,
     TrustedHostMiddleware,
 )
 from ellar.core.routing import ApplicationRouter, AppStaticFileMount
@@ -151,6 +156,7 @@ def debug(self, value: bool) -> None:
     def build_middleware_stack(self) -> ASGIApp:
         service_middleware = self.injector.get(IExceptionMiddlewareService)
         service_middleware.build_exception_handlers(*self._exception_handlers)
+
         error_handler = service_middleware.get_500_error_handler()
         allowed_hosts = self.config.ALLOWED_HOSTS
 
@@ -175,7 +181,7 @@ def build_middleware_stack(self) -> ASGIApp:
                     max_age=self.config.CORS_MAX_AGE,
                 ),
                 Middleware(
-                    RequestServiceProviderMiddleware,
+                    ServerErrorMiddleware,
                     debug=self.debug,
                     handler=error_handler,
                 ),
@@ -219,19 +225,25 @@ def application_context(self) -> ApplicationContext:
         return ApplicationContext.create(app=self)
 
     async def __call__(self, scope: TScope, receive: TReceive, send: TSend) -> None:
-        async with self.application_context():
+        async with self.application_context() as context:
             scope["app"] = self
 
-            if self.middleware_stack is None:
-                self.middleware_stack = self.build_middleware_stack()
+            async with context.injector.create_asgi_args() as service_provider:
+                context_factory = service_provider.get(IHostContextFactory)
+                service_provider.update_scoped_context(
+                    IHostContext, context_factory.create_context(scope)
+                )
+
+                if self.middleware_stack is None:
+                    self.middleware_stack = self.build_middleware_stack()
 
-                if (
-                    self.config.STATIC_MOUNT_PATH
-                    and self.config.STATIC_MOUNT_PATH not in self.router.routes
-                ):
-                    self.router.append(AppStaticFileMount(self))
+                    if (
+                        self.config.STATIC_MOUNT_PATH
+                        and self.config.STATIC_MOUNT_PATH not in self.router.routes
+                    ):
+                        self.router.add_route(AppStaticFileMount(self))
 
-            await self.middleware_stack(scope, receive, send)
+                await self.middleware_stack(scope, receive, send)
 
     @property
     def routes(self) -> t.List[BaseRoute]:
@@ -294,6 +306,7 @@ def get_module_loaders(self) -> t.Generator[ModuleTemplating, None, None]:
             yield loader
 
     def _create_jinja_environment(self) -> Environment:
+        # TODO: rename to `create_jinja_environment`
         def select_jinja_auto_escape(filename: str) -> bool:
             if filename is None:  # pragma: no cover
                 return True

ellar/core/__init__.py

@@ -2,6 +2,7 @@
 
 from .conf import Config, ConfigDefaultTypesMixin
 from .connection import HTTPConnection, Request, WebSocket
+from .context import ApplicationContext, config, current_injector
 from .execution_context import ExecutionContext, HostContext
 from .guards import GuardConsumer
 from .interceptors import EllarInterceptorConsumer
@@ -29,6 +30,9 @@
     "VersioningSchemes",
     "mount",
     "host",
+    "current_injector",
+    "config",
+    "ApplicationContext",
 ]
 
 

ellar/core/conf/app_settings_models.py

@@ -11,14 +11,12 @@
 from ellar.common.serializer import Serializer, SerializerFilter
 from ellar.common.templating import JinjaLoaderType
 from ellar.common.types import ASGIApp, TReceive, TScope, TSend
-from ellar.core.versioning import DefaultAPIVersioning
+from ellar.core.conf.mixins import ConfigDefaultTypesMixin
 from ellar.pydantic import ENCODERS_BY_TYPE as encoders_by_type
 from ellar.pydantic import field_validator
 from starlette.exceptions import HTTPException as StarletteHTTPException
 from starlette.websockets import WebSocketClose
 
-from .mixins import ConfigDefaultTypesMixin
-
 if t.TYPE_CHECKING:  # pragma: no cover
     from ellar.app.main import App
 
@@ -69,7 +67,7 @@ class ConfigValidationSchema(Serializer, ConfigDefaultTypesMixin):
     JINJA_LOADERS: t.List[JinjaLoaderType] = []
 
     # Application route versioning scheme
-    VERSIONING_SCHEME: IAPIVersioning = DefaultAPIVersioning()
+    VERSIONING_SCHEME: t.Optional[IAPIVersioning] = None
 
     REDIRECT_SLASHES: bool = False
 

ellar/core/conf/config.py

@@ -3,12 +3,11 @@
 from ellar.common.compatible.dict import AttributeDictAccessMixin
 from ellar.common.constants import ELLAR_CONFIG_MODULE
 from ellar.common.types import VT
+from ellar.core.conf.app_settings_models import ConfigValidationSchema
+from ellar.core.conf.mixins import ConfigDefaultTypesMixin
 from ellar.utils.importer import import_from_string
 from starlette.config import environ
 
-from .app_settings_models import ConfigValidationSchema
-from .mixins import ConfigDefaultTypesMixin
-
 
 class ConfigRuntimeError(RuntimeError):
     pass

ellar/core/conf/mixins.py

@@ -31,7 +31,7 @@ class ConfigDefaultTypesMixin:
     JINJA_LOADERS: t.List[t.Union[JinjaLoaderType, t.Any]]
 
     # Application route versioning scheme
-    VERSIONING_SCHEME: IAPIVersioning
+    VERSIONING_SCHEME: t.Optional[IAPIVersioning]
 
     # Enable or Disable Application Router route searching by appending backslash
     REDIRECT_SLASHES: bool

ellar/core/connection/http.py

@@ -1,7 +1,7 @@
 import typing as t
 
 from ellar.common import Identity
-from ellar.common.constants import SCOPE_SERVICE_PROVIDER
+from ellar.core.context import current_injector
 from starlette.requests import (
     HTTPConnection as StarletteHTTPConnection,
 )
@@ -16,10 +16,7 @@
 class HTTPConnection(StarletteHTTPConnection):
     @property
     def service_provider(self) -> "EllarInjector":
-        assert (
-            SCOPE_SERVICE_PROVIDER in self.scope
-        ), "RequestServiceProviderMiddleware must be installed to access request.service_provider"
-        return t.cast("EllarInjector", self.scope[SCOPE_SERVICE_PROVIDER])
+        return current_injector
 
     @property
     def user(self) -> Identity:

ellar/app/context.py ellar/core/context.pyellar/app/context.py renamed to ellar/core/context.py

@@ -5,7 +5,7 @@
 
 from ellar.common.constants import ELLAR_CONFIG_MODULE
 from ellar.common.logging import logger
-from ellar.core import Config
+from ellar.core.conf import Config
 from ellar.di import EllarInjector
 from ellar.events import app_context_started, app_context_teardown
 from ellar.utils.functional import SimpleLazyObject, empty

ellar/core/execution_context/host.py

@@ -8,12 +8,12 @@
     IWebSocketHostContext,
 )
 from ellar.common.compatible import cached_property
-from ellar.common.constants import SCOPE_SERVICE_PROVIDER
 from ellar.common.interfaces import IHostContext
 from ellar.common.types import TReceive, TScope, TSend
+from ellar.core.context import current_injector
 
 if t.TYPE_CHECKING:  # pragma: no cover
-    from ellar.core.main import App
+    from ellar.app.main import App
     from ellar.di import EllarInjector
 
 
@@ -36,11 +36,7 @@ def __init__(
         self.send = send
 
     def get_service_provider(self) -> "EllarInjector":
-        return self._service_provider
-
-    @cached_property
-    def _service_provider(self) -> "EllarInjector":
-        return self.scope[SCOPE_SERVICE_PROVIDER]  # type:ignore[no-any-return]
+        return current_injector
 
     @cached_property
     def _get_websocket_context(self) -> IWebSocketHostContext: