Upgraded starlette and dropped on_request_started and on_request_finished

eadwinCode · eadwinCode · commit d7233f635bb7 · 2023-04-08T16:04:59.000+01:00
diff --git a/ellar/common/__init__.py b/ellar/common/__init__.py
@@ -13,8 +13,6 @@
     extra_args,
     file,
     middleware,
-    on_shutdown,
-    on_startup,
     openapi_info,
     render,
     serializer_filter,
@@ -89,8 +87,6 @@
     "middleware",
     "exception_handler",
     "serializer_filter",
-    "on_shutdown",
-    "on_startup",
     "template_filter",
     "template_global",
     "Res",
diff --git a/ellar/common/decorators/__init__.py b/ellar/common/decorators/__init__.py
@@ -11,7 +11,6 @@
 from .middleware import middleware
 from .modules import Module
 from .openapi import openapi_info
-from .request import on_shutdown, on_startup
 from .serializer import serializer_filter
 from .versioning import Version
 
@@ -24,9 +23,7 @@
     "template_global",
     "file",
     "render",
-    "on_startup",
     "exception_handler",
-    "on_shutdown",
     "command",
     "set_metadata",
     "middleware",
diff --git a/ellar/common/decorators/request.py b/ellar/common/decorators/request.py
diff --git a/ellar/constants.py b/ellar/constants.py
@@ -64,9 +64,6 @@ def __new__(mcls, name, bases, namespace):
 RESPONSE_OVERRIDE_KEY = "RESPONSE_OVERRIDE"
 EXCEPTION_HANDLERS_KEY = "EXCEPTION_HANDLERS"
 
-ON_REQUEST_STARTUP_KEY = "ON_REQUEST_STARTUP"
-ON_REQUEST_SHUTDOWN_KEY = "ON_REQUEST_SHUTDOWN"
-
 TEMPLATE_GLOBAL_KEY = "TEMPLATE_GLOBAL_FILTERS"
 TEMPLATE_FILTER_KEY = "TEMPLATE_FILTERS"
 
diff --git a/ellar/core/conf/app_settings_models.py b/ellar/core/conf/app_settings_models.py
@@ -11,13 +11,7 @@
 from ellar.serializer import Serializer, SerializerFilter
 from ellar.types import ASGIApp, TReceive, TScope, TSend
 
-from .mixins import (
-    ConfigDefaultTypesMixin,
-    TEventHandler,
-    TExceptionHandler,
-    TMiddleware,
-    TVersioning,
-)
+from .mixins import ConfigDefaultTypesMixin, TExceptionHandler, TMiddleware, TVersioning
 
 if t.TYPE_CHECKING:  # pragma: no cover
     from ellar.core.main import App
@@ -113,9 +107,6 @@ class Config:
     # logging Level
     LOG_LEVEL: t.Optional[log_levels] = log_levels.info
 
-    ON_REQUEST_STARTUP: t.List[TEventHandler] = []
-    ON_REQUEST_SHUTDOWN: t.List[TEventHandler] = []
-
     TEMPLATE_FILTERS: t.Dict[str, t.Callable[..., t.Any]] = {}
     TEMPLATE_GLOBAL_FILTERS: t.Dict[str, t.Callable[..., t.Any]] = {}
 
diff --git a/ellar/core/conf/mixins.py b/ellar/core/conf/mixins.py
@@ -126,12 +126,6 @@ class ConfigDefaultTypesMixin:
     # defines other custom json encoders
     SERIALIZER_CUSTOM_ENCODER: t.Dict[t.Any, t.Callable[[t.Any], t.Any]]
 
-    # will be set automatically when @on_startup is found in a Module class
-    ON_REQUEST_STARTUP: t.List[TEventHandler]
-
-    # will be set automatically when @on_shutdown is found in a Module class
-    ON_REQUEST_SHUTDOWN: t.List[TEventHandler]
-
     # will be set automatically when @template_filter is found in a Module class
     TEMPLATE_FILTERS: t.Dict[str, t.Callable[..., t.Any]]
 
diff --git a/ellar/core/factory.py b/ellar/core/factory.py
@@ -137,14 +137,9 @@ def _get_config_kwargs() -> t.Dict:
 
         cls._build_modules(app_module=module, injector=injector, config=config)
 
-        shutdown_event = config.ON_REQUEST_STARTUP
-        startup_event = config.ON_REQUEST_SHUTDOWN
-
         app = App(
             config=config,
             injector=injector,
-            on_shutdown_event_handlers=shutdown_event if shutdown_event else None,
-            on_startup_event_handlers=startup_event if startup_event else None,
             lifespan=config.DEFAULT_LIFESPAN_HANDLER,
             global_guards=global_guards,
         )
diff --git a/ellar/core/main.py b/ellar/core/main.py
@@ -29,7 +29,6 @@
 from ellar.core.templating import AppTemplating, Environment
 from ellar.core.versioning import BaseAPIVersioning, VersioningSchemes
 from ellar.di.injector import EllarInjector
-from ellar.events import EventHandler, RouterEventManager
 from ellar.logger import logger
 from ellar.types import ASGIApp, T, TReceive, TScope, TSend
 
@@ -41,8 +40,6 @@ def __init__(
         self,
         config: "Config",
         injector: EllarInjector,
-        on_startup_event_handlers: t.Optional[t.Sequence[EventHandler]] = None,
-        on_shutdown_event_handlers: t.Optional[t.Sequence[EventHandler]] = None,
         lifespan: t.Optional[t.Callable[["App"], t.AsyncContextManager]] = None,
         global_guards: t.List[
             t.Union[t.Type[GuardCanActivate], GuardCanActivate]
@@ -53,12 +50,6 @@ def __init__(
             injector, EllarInjector
         ), "injector must instance of EllarInjector"
 
-        # The lifespan context function is a newer style that replaces
-        # on_startup / on_shutdown handlers. Use one or the other, not both.
-        assert lifespan is None or (
-            on_startup_event_handlers is None and on_shutdown_event_handlers is None
-        ), "Use either 'lifespan' or 'on_startup'/'on_shutdown', not both."
-
         self._config = config
         self._injector: EllarInjector = injector
 
@@ -67,15 +58,6 @@ def __init__(
 
         self._user_middleware = list(t.cast(list, self.config.MIDDLEWARE))
 
-        self.on_startup = RouterEventManager(
-            [] if on_startup_event_handlers is None else list(on_startup_event_handlers)
-        )
-        self.on_shutdown = RouterEventManager(
-            []
-            if on_shutdown_event_handlers is None
-            else list(on_shutdown_event_handlers)
-        )
-
         self._static_app: t.Optional[ASGIApp] = None
 
         self.state = State()
@@ -85,12 +67,6 @@ def __init__(
         self.router = ApplicationRouter(
             routes=self._get_module_routes(),
             redirect_slashes=self.config.REDIRECT_SLASHES,
-            on_startup=[self.on_startup.async_run]
-            if self.config.DEFAULT_LIFESPAN_HANDLER is None
-            else None,
-            on_shutdown=[self.on_shutdown.async_run]
-            if self.config.DEFAULT_LIFESPAN_HANDLER is None
-            else None,
             default=self.config.DEFAULT_NOT_FOUND_HANDLER,  # type: ignore
             lifespan=self.config.DEFAULT_LIFESPAN_HANDLER,
         )
diff --git a/ellar/core/modules/builder.py b/ellar/core/modules/builder.py
@@ -4,12 +4,9 @@
     EXCEPTION_HANDLERS_KEY,
     MIDDLEWARE_HANDLERS_KEY,
     MODULE_FIELDS,
-    ON_REQUEST_SHUTDOWN_KEY,
-    ON_REQUEST_STARTUP_KEY,
     TEMPLATE_FILTER_KEY,
     TEMPLATE_GLOBAL_KEY,
 )
-from ellar.events import EventHandler
 from ellar.reflect import reflect
 
 from ..exceptions.callable_exceptions import CallableExceptionHandler
@@ -34,8 +31,6 @@ def __init__(self, cls: t.Union[t.Type["ModuleBase"], "ModuleBaseMeta"]) -> None
             {
                 EXCEPTION_HANDLERS_KEY: self.exception_config,
                 MIDDLEWARE_HANDLERS_KEY: self.middleware_config,
-                ON_REQUEST_SHUTDOWN_KEY: self.on_request_shut_down_config,
-                ON_REQUEST_STARTUP_KEY: self.on_request_startup_config,
                 TEMPLATE_GLOBAL_KEY: self.template_global_config,
                 TEMPLATE_FILTER_KEY: self.template_filter_config,
             },
@@ -57,26 +52,6 @@ def middleware_config(self, middleware: "MiddlewareSchema") -> None:
             self._cls,
         )
 
-    def on_request_shut_down_config(self, on_shutdown_event: EventHandler) -> None:
-        on_shutdown_event.handler = module_callable_factory(
-            on_shutdown_event.handler, self._cls
-        )
-        reflect.define_metadata(
-            ON_REQUEST_SHUTDOWN_KEY,
-            [on_shutdown_event],
-            self._cls,
-        )
-
-    def on_request_startup_config(self, on_startup_event: EventHandler) -> None:
-        on_startup_event.handler = module_callable_factory(
-            on_startup_event.handler, self._cls
-        )
-        reflect.define_metadata(
-            ON_REQUEST_STARTUP_KEY,
-            [on_startup_event],
-            self._cls,
-        )
-
     def template_filter_config(self, template_filter: "TemplateFunctionData") -> None:
         reflect.define_metadata(
             TEMPLATE_FILTER_KEY,
diff --git a/ellar/core/modules/ref.py b/ellar/core/modules/ref.py
@@ -12,8 +12,6 @@
     MODULE_METADATA,
     MODULE_REF_TYPES,
     MODULE_WATERMARK,
-    ON_REQUEST_SHUTDOWN_KEY,
-    ON_REQUEST_STARTUP_KEY,
     TEMPLATE_FILTER_KEY,
     TEMPLATE_GLOBAL_KEY,
 )
@@ -28,8 +26,7 @@
 from .base import ModuleBase, ModuleBaseMeta
 
 if t.TYPE_CHECKING:  # pragma: no cover
-    from ellar.conf import Config
-    from ellar.core import ControllerBase
+    from ellar.core import Config, ControllerBase
 
 
 class InvalidModuleTypeException(Exception):
@@ -194,7 +191,6 @@ def __init__(
         self._flatten_routes: t.List[BaseRoute] = []
 
         self.scan_templating_filters()
-        self.scan_request_events()
         self.scan_exceptions_handlers()
         self.scan_middleware()
         self.register_providers()
@@ -301,22 +297,3 @@ def _get_all_routers(self) -> t.Sequence[t.Union[ModuleMount, Mount, BaseRoute]]
             ) and isinstance(controller, ControllerType), "Invalid Controller Type."
             _routers.append(controller_router_factory(controller))
         return _routers
-
-    def scan_request_events(self) -> None:
-        request_startup = (
-            reflect.get_metadata(ON_REQUEST_STARTUP_KEY, self._module_type) or []
-        )
-        if not self._config.get(ON_REQUEST_STARTUP_KEY) or not isinstance(
-            self._config[ON_REQUEST_STARTUP_KEY], list
-        ):
-            self._config[ON_REQUEST_STARTUP_KEY] = []
-        self._config[ON_REQUEST_STARTUP_KEY].extend(request_startup)
-
-        request_shutdown = (
-            reflect.get_metadata(ON_REQUEST_SHUTDOWN_KEY, self._module_type) or []
-        )
-        if not self._config.get(ON_REQUEST_SHUTDOWN_KEY) or not isinstance(
-            self._config[ON_REQUEST_SHUTDOWN_KEY], list
-        ):
-            self._config[ON_REQUEST_SHUTDOWN_KEY] = []
-        self._config[ON_REQUEST_SHUTDOWN_KEY].extend(request_shutdown)
diff --git a/ellar/core/templating/interface.py b/ellar/core/templating/interface.py
@@ -10,6 +10,7 @@
 from ellar.compatible import cached_property
 from ellar.constants import TEMPLATE_FILTER_KEY, TEMPLATE_GLOBAL_KEY
 from ellar.core.connection import Request
+from ellar.core.datastructures import URL
 from ellar.core.staticfiles import StaticFiles
 from ellar.types import ASGIApp, TemplateFilterCallable, TemplateGlobalCallable
 
@@ -182,7 +183,7 @@ def select_jinja_auto_escape(filename: str) -> bool:
             jinja_options.setdefault(k, v)
 
         @pass_context
-        def url_for(context: dict, name: str, **path_params: t.Any) -> str:
+        def url_for(context: dict, name: str, **path_params: t.Any) -> URL:
             request = t.cast(Request, context["request"])
             return request.url_for(name, **path_params)
 
diff --git a/pyproject.toml b/pyproject.toml
@@ -42,7 +42,7 @@ classifiers = [
 
 dependencies = [
     "injector == 0.20.1",
-    "starlette == 0.23.1",
+    "starlette == 0.26.1",
     "pydantic >=1.6.2,!=1.7,!=1.7.1,!=1.7.2,!=1.7.3,!=1.8,!=1.8.1,<2.0.0",
     "jinja2",
     # cli
diff --git a/tests/test_application/test_application_functions.py b/tests/test_application/test_application_functions.py
@@ -19,7 +19,6 @@
     VersioningSchemes as VERSIONING,
 )
 from ellar.di import EllarInjector
-from ellar.events import EventHandler
 from ellar.helper.importer import get_class_import
 from ellar.openapi import OpenAPIDocumentModule
 from ellar.services.reflector import Reflector
@@ -110,33 +109,6 @@ def test_middleware(self):
         assert response.status_code == 400
         assert response.text == "Invalid host header"
 
-    def test_app_add_event_handler(self, test_client_factory):
-        startup_complete = False
-        cleanup_complete = False
-
-        def run_startup():
-            nonlocal startup_complete
-            startup_complete = True
-
-        def run_cleanup():
-            nonlocal cleanup_complete
-            cleanup_complete = True
-
-        app = App(
-            config=Config(),
-            injector=EllarInjector(),
-            on_startup_event_handlers=[EventHandler(run_startup)],
-            on_shutdown_event_handlers=[EventHandler(run_cleanup)],
-        )
-
-        assert not startup_complete
-        assert not cleanup_complete
-        with test_client_factory(app):
-            assert startup_complete
-            assert not cleanup_complete
-        assert startup_complete
-        assert cleanup_complete
-
     def test_app_async_cm_lifespan(self, test_client_factory):
         startup_complete = False
         cleanup_complete = False
diff --git a/tests/test_common/test_decorators/test_request.py b/tests/test_common/test_decorators/test_request.py
diff --git a/tests/test_conf/test_mixins.py b/tests/test_conf/test_mixins.py
diff --git a/tests/test_modules/test_module_ref.py b/tests/test_modules/test_module_ref.py
