convert tornado + begin reworking test utils

Author: rmorshea

src/idom/core/types.py

@@ -21,6 +21,9 @@
 ComponentConstructor = Callable[..., "ComponentType"]
 """Simple function returning a new component"""
 
+RootComponentConstructor = Callable[[], "ComponentType"]
+"""The root component should be constructed by a function accepting no arguments."""
+
 
 Key = Union[str, int]
 

src/idom/server/any.py

@@ -1,12 +1,13 @@
 from __future__ import annotations
 
 import asyncio
+import sys
 import warnings
 import webbrowser
 from importlib import import_module
 from typing import Any, Awaitable, Iterator
 
-from idom.types import ComponentConstructor
+from idom.types import RootComponentConstructor
 
 from .types import ServerImplementation
 from .utils import find_available_port
@@ -22,10 +23,11 @@
 
 
 def run(
-    component: ComponentConstructor,
+    component: RootComponentConstructor,
     host: str = "127.0.0.1",
     port: int | None = None,
     open_browser: bool = True,
+    implementation: ServerImplementation = sys.modules[__name__],
 ) -> None:
     """Run a component with a development server"""
 
@@ -35,16 +37,16 @@ def run(
         stacklevel=2,
     )
 
-    app = create_development_app()
-    configure(app, component)
+    app = implementation.create_development_app()
+    implementation.configure(app, component)
 
     coros: list[Awaitable] = []
 
     host = host
     port = port or find_available_port(host)
     started = asyncio.Event()
 
-    coros.append(serve_development_app(app, host, port, started))
+    coros.append(implementation.serve_development_app(app, host, port, started))
 
     if open_browser:
 
@@ -57,25 +59,29 @@ async def _open_browser_after_server() -> None:
     asyncio.get_event_loop().run_forever(asyncio.gather(*coros))
 
 
-def configure(app: Any, component: ComponentConstructor) -> None:
+def configure(app: Any, component: RootComponentConstructor) -> None:
     """Configure the given app instance to display the given component"""
-    return get_implementation().configure(app, component)
+    return _get_any_implementation().configure(app, component)
 
 
 def create_development_app() -> Any:
     """Create an application instance for development purposes"""
-    return get_implementation().create_development_app()
+    return _get_any_implementation().create_development_app()
 
 
 async def serve_development_app(
     app: Any, host: str, port: int, started: asyncio.Event
 ) -> None:
     """Run an application using a development server"""
-    return await get_implementation().serve_development_app(app, host, port, started)
+    return await _get_any_implementation().serve_development_app(
+        app, host, port, started
+    )
 
 
-def get_implementation() -> ServerImplementation:
+def _get_any_implementation() -> ServerImplementation:
     """Get the first available server implementation"""
+    global _DEFAULT_IMPLEMENTATION
+
     if _DEFAULT_IMPLEMENTATION is not None:
         return _DEFAULT_IMPLEMENTATION
 
@@ -84,7 +90,6 @@ def get_implementation() -> ServerImplementation:
     except StopIteration:
         raise RuntimeError("No built-in server implementation installed.")
     else:
-        global _DEFAULT_IMPLEMENTATION
         _DEFAULT_IMPLEMENTATION = implementation
         return implementation
 

src/idom/server/fastapi.py

@@ -3,7 +3,7 @@
 from fastapi import FastAPI
 
 from idom.config import IDOM_DEBUG_MODE
-from idom.core.types import ComponentConstructor
+from idom.core.types import RootComponentConstructor
 
 from .starlette import (
     Options,
@@ -19,7 +19,7 @@
 
 def configure(
     app: FastAPI,
-    constructor: ComponentConstructor,
+    constructor: RootComponentConstructor,
     options: Options | None = None,
 ) -> None:
     """Prepare a :class:`FastAPI` server to serve the given component

src/idom/server/flask.py

@@ -21,7 +21,7 @@
 from idom.config import IDOM_DEBUG_MODE, IDOM_WEB_MODULES_DIR
 from idom.core.dispatcher import dispatch_single_view
 from idom.core.layout import LayoutEvent, LayoutUpdate
-from idom.core.types import ComponentConstructor, ComponentType
+from idom.core.types import ComponentType, RootComponentConstructor
 
 from .utils import CLIENT_BUILD_DIR
 
@@ -30,7 +30,7 @@
 
 
 def configure(
-    app: Flask, component: ComponentConstructor, options: Options | None = None
+    app: Flask, component: RootComponentConstructor, options: Options | None = None
 ) -> None:
     """Return a :class:`FlaskServer` where each client has its own state.
 
@@ -152,7 +152,7 @@ def redirect_to_index() -> Any:
 
 
 def _setup_single_view_dispatcher_route(
-    app: Flask, options: Options, constructor: ComponentConstructor
+    app: Flask, options: Options, constructor: RootComponentConstructor
 ) -> None:
     sockets = Sockets(app)
 

src/idom/server/sanic.py

@@ -18,7 +18,7 @@
     dispatch_single_view,
 )
 from idom.core.layout import Layout, LayoutEvent
-from idom.core.types import ComponentConstructor
+from idom.core.types import RootComponentConstructor
 
 from .utils import CLIENT_BUILD_DIR
 
@@ -27,7 +27,7 @@
 
 
 def configure(
-    app: Sanic, component: ComponentConstructor, options: Options | None = None
+    app: Sanic, component: RootComponentConstructor, options: Options | None = None
 ) -> None:
     """Configure an application instance to display the given component"""
     options = _setup_options(options)
@@ -107,7 +107,7 @@ def redirect_to_index(
 
 
 def _setup_single_view_dispatcher_route(
-    blueprint: Blueprint, constructor: ComponentConstructor
+    blueprint: Blueprint, constructor: RootComponentConstructor
 ) -> None:
     @blueprint.websocket("/stream")  # type: ignore
     async def model_stream(

src/idom/server/starlette.py

@@ -24,7 +24,7 @@
     dispatch_single_view,
 )
 from idom.core.layout import Layout, LayoutEvent
-from idom.core.types import ComponentConstructor
+from idom.core.types import RootComponentConstructor
 
 from .utils import CLIENT_BUILD_DIR
 
@@ -34,7 +34,7 @@
 
 def configure(
     app: Starlette,
-    constructor: ComponentConstructor,
+    constructor: RootComponentConstructor,
     options: Options | None = None,
 ) -> None:
     """Return a :class:`StarletteServer` where each client has its own state.
@@ -46,7 +46,7 @@ def configure(
         constructor: A component constructor
         options: Options for configuring server behavior
     """
-    options, app = _setup_options(options)
+    options = _setup_options(options)
     _setup_common_routes(options, app)
     _setup_single_view_dispatcher_route(options["url_prefix"], app, constructor)
 
@@ -154,7 +154,7 @@ def redirect_to_index(request: Request) -> RedirectResponse:
 
 
 def _setup_single_view_dispatcher_route(
-    url_prefix: str, app: Starlette, constructor: ComponentConstructor
+    url_prefix: str, app: Starlette, constructor: RootComponentConstructor
 ) -> None:
     @app.websocket_route(f"{url_prefix}/stream")
     async def model_stream(socket: WebSocket) -> None:

src/idom/server/tornado.py

@@ -4,6 +4,7 @@
 import json
 from asyncio import Queue as AsyncQueue
 from asyncio.futures import Future
+from concurrent.futures import ThreadPoolExecutor
 from threading import Event as ThreadEvent
 from typing import Any, List, Optional, Tuple, Type, Union
 from urllib.parse import urljoin
@@ -21,11 +22,45 @@
 from .utils import CLIENT_BUILD_DIR, threaded, wait_on_event
 
 
-_RouteHandlerSpecs = List[Tuple[str, Type[RequestHandler], Any]]
+def configure(
+    app: Application,
+    component: ComponentConstructor,
+    options: Options | None = None,
+) -> TornadoServer:
+    """Return a :class:`TornadoServer` where each client has its own state.
+
+    Implements the :class:`~idom.server.proto.ServerFactory` protocol
+
+    Parameters:
+        app: A tornado ``Application`` instance.
+        component: A root component constructor
+        options: Options for configuring how the component is mounted to the server.
+    """
+    options = _setup_options(options)
+    _add_handler(
+        app,
+        options,
+        _setup_common_routes(options) + _setup_single_view_dispatcher_route(component),
+    )
+    return TornadoServer(app)
 
 
-class Config(TypedDict, total=False):
-    """Render server config for :class:`TornadoRenderServer` subclasses"""
+def create_development_app() -> Application:
+    return Application(debug=True)
+
+
+async def serve_development_app(
+    app: Application, host: str, port: int, started: asyncio.Event
+) -> None:
+    loop = AsyncIOMainLoop()
+    loop.install()
+    app.listen(port, host)
+    loop.add_callback(lambda: loop.asyncio_loop.call_soon_threadsafe(started.set))
+    await loop.run_in_executor(ThreadPoolExecutor())
+
+
+class Options(TypedDict, total=False):
+    """Render server options for :class:`TornadoRenderServer` subclasses"""
 
     redirect_root_to_index: bool
     """Whether to redirect the root URL (with prefix) to ``index.html``"""
@@ -37,27 +72,7 @@ class Config(TypedDict, total=False):
     """The URL prefix where IDOM resources will be served from"""
 
 
-def PerClientStateServer(
-    constructor: ComponentConstructor,
-    config: Optional[Config] = None,
-    app: Optional[Application] = None,
-) -> TornadoServer:
-    """Return a :class:`TornadoServer` where each client has its own state.
-
-    Implements the :class:`~idom.server.proto.ServerFactory` protocol
-
-    Parameters:
-        constructor: A component constructor
-        config: Options for configuring server behavior
-        app: An application instance (otherwise a default instance is created)
-    """
-    config, app = _setup_config_and_app(config, app)
-    _add_handler(
-        app,
-        config,
-        _setup_common_routes(config) + _setup_single_view_dispatcher_route(constructor),
-    )
-    return TornadoServer(app)
+_RouteHandlerSpecs = List[Tuple[str, Type[RequestHandler], Any]]
 
 
 class TornadoServer:
@@ -105,23 +120,18 @@ def stop() -> None:
             wait_on_event(f"stop {self.app}", did_stop, timeout)
 
 
-def _setup_config_and_app(
-    config: Optional[Config], app: Optional[Application]
-) -> Tuple[Config, Application]:
-    return (
-        {
-            "url_prefix": "",
-            "serve_static_files": True,
-            "redirect_root_to_index": True,
-            **(config or {}),  # type: ignore
-        },
-        app or Application(),
-    )
+def _setup_options(options: Options | None) -> Options:
+    return {
+        "url_prefix": "",
+        "serve_static_files": True,
+        "redirect_root_to_index": True,
+        **(options or {}),  # type: ignore
+    }
 
 
-def _setup_common_routes(config: Config) -> _RouteHandlerSpecs:
+def _setup_common_routes(options: Options) -> _RouteHandlerSpecs:
     handlers: _RouteHandlerSpecs = []
-    if config["serve_static_files"]:
+    if options["serve_static_files"]:
         handlers.append(
             (
                 r"/client/(.*)",
@@ -136,16 +146,16 @@ def _setup_common_routes(config: Config) -> _RouteHandlerSpecs:
                 {"path": str(IDOM_WEB_MODULES_DIR.current)},
             )
         )
-        if config["redirect_root_to_index"]:
+        if options["redirect_root_to_index"]:
             handlers.append(("/", RedirectHandler, {"url": "./client/index.html"}))
     return handlers
 
 
 def _add_handler(
-    app: Application, config: Config, handlers: _RouteHandlerSpecs
+    app: Application, options: Options, handlers: _RouteHandlerSpecs
 ) -> None:
     prefixed_handlers: List[Any] = [
-        (urljoin(config["url_prefix"], route_pattern),) + tuple(handler_info)
+        (urljoin(options["url_prefix"], route_pattern),) + tuple(handler_info)
         for route_pattern, *handler_info in handlers
     ]
     app.add_handlers(r".*", prefixed_handlers)
@@ -157,13 +167,13 @@ def _setup_single_view_dispatcher_route(
     return [
         (
             "/stream",
-            PerClientStateModelStreamHandler,
+            ModelStreamHandler,
             {"component_constructor": constructor},
         )
     ]
 
 
-class PerClientStateModelStreamHandler(WebSocketHandler):
+class ModelStreamHandler(WebSocketHandler):
     """A web-socket handler that serves up a new model stream to each new client"""
 
     _dispatch_future: Future[None]

src/idom/server/types.py

@@ -3,7 +3,7 @@
 
 from typing_extensions import Protocol, runtime_checkable
 
-from idom.core.types import ComponentType
+from idom.core.types import RootComponentConstructor
 
 
 _App = TypeVar("_App")
@@ -13,7 +13,7 @@
 class ServerImplementation(Protocol):
     """Common interface for IDOM's builti-in server implementations"""
 
-    def configure(self, app: _App, component: Callable[[], ComponentType]) -> None:
+    def configure(self, app: _App, component: RootComponentConstructor) -> None:
         """Configure the given app instance to display the given component"""
 
     def create_development_app(self) -> _App: