rename Server proto to ServerType + test_sample

Author: rmorshea

src/idom/sample.py

@@ -1,4 +1,9 @@
+from __future__ import annotations
+
 import webbrowser
+from typing import Any
+
+from idom.server.proto import ServerType
 
 from . import html
 from .core.component import component
@@ -22,17 +27,34 @@ def App() -> VdomDict:
     )
 
 
-def run_sample_app(open_browser: bool = False) -> None:
-    """Run a sample application."""
-    host = "127.0.0.1"
-    port = find_available_port(host)
+def run_sample_app(
+    host: str = "127.0.0.1",
+    port: int | None = None,
+    open_browser: bool = False,
+    run_in_thread: bool | None = None,
+) -> ServerType[Any]:
+    """Run a sample application.
+
+    Args:
+        host: host where the server should run
+        port: the port on the host to serve from
+        open_browser: whether to open a browser window after starting the server
+    """
+    port = port or find_available_port(host)
     server_type = find_builtin_server_type("PerClientStateServer")
     server = server_type(App)
 
-    if not open_browser:
+    run_in_thread = open_browser or run_in_thread
+
+    if not run_in_thread:  # pragma: no cover
         server.run(host=host, port=port)
-    else:
-        thread = server.run_in_thread(host=host, port=port)
-        server.wait_until_started(5)
+        return server
+
+    thread = server.run_in_thread(host=host, port=port)
+    server.wait_until_started(5)
+
+    if open_browser:  # pragma: no cover
         webbrowser.open(f"http://{host}:{port}")
         thread.join()
+
+    return server

src/idom/server/prefab.py

@@ -9,7 +9,7 @@
 from idom.core.proto import ComponentConstructor
 from idom.widgets import MountFunc, MultiViewMount, hotswap, multiview
 
-from .proto import Server, ServerFactory
+from .proto import ServerFactory, ServerType
 from .utils import find_available_port, find_builtin_server_type
 
 
@@ -28,7 +28,7 @@ def run(
     run_kwargs: Optional[Dict[str, Any]] = None,
     app: Optional[Any] = None,
     daemon: bool = False,
-) -> Server[_App]:
+) -> ServerType[_App]:
     """A utility for quickly running a render server with minimal boilerplate
 
     Parameters:
@@ -77,7 +77,7 @@ def multiview_server(
     server_config: Optional[_Config] = None,
     run_kwargs: Optional[Dict[str, Any]] = None,
     app: Optional[Any] = None,
-) -> Tuple[MultiViewMount, Server[_App]]:
+) -> Tuple[MultiViewMount, ServerType[_App]]:
     """Set up a server where views can be dynamically added.
 
     In other words this allows the user to work with IDOM in an imperative manner. Under
@@ -120,7 +120,7 @@ def hotswap_server(
     run_kwargs: Optional[Dict[str, Any]] = None,
     app: Optional[Any] = None,
     sync_views: bool = False,
-) -> Tuple[MountFunc, Server[_App]]:
+) -> Tuple[MountFunc, ServerType[_App]]:
     """Set up a server where views can be dynamically swapped out.
 
     In other words this allows the user to work with IDOM in an imperative manner. Under

src/idom/server/proto.py

@@ -20,11 +20,11 @@ def __call__(
         constructor: ComponentConstructor,
         config: Optional[_Config] = None,
         app: Optional[_App] = None,
-    ) -> Server[_App]:
+    ) -> ServerType[_App]:
         ...
 
 
-class Server(Protocol[_App]):
+class ServerType(Protocol[_App]):
     """A thin wrapper around a web server that provides a common operational interface"""
 
     app: _App

src/idom/server/utils.py

@@ -43,20 +43,6 @@ def target() -> None:
     return wrapper
 
 
-def threaded_no_event_loop(function: Callable[_FuncParams, None]) -> Callable[_FuncParams, Thread]:  # type: ignore
-    @wraps(function)
-    def wrapper(*args: Any, **kwargs: Any) -> Thread:
-        def target() -> None:
-            function(*args, **kwargs)
-
-        thread = Thread(target=target, daemon=True)
-        thread.start()
-
-        return thread
-
-    return wrapper
-
-
 def wait_on_event(description: str, event: Event, timeout: Optional[float]) -> None:
     if not event.wait(timeout):
         raise TimeoutError(f"Did not {description} within {timeout} seconds")

src/idom/testing.py

@@ -31,7 +31,7 @@
 from idom.core.events import EventHandler, to_event_handler_function
 from idom.core.hooks import LifeCycleHook, current_hook
 from idom.server.prefab import hotswap_server
-from idom.server.proto import Server, ServerFactory
+from idom.server.proto import ServerFactory, ServerType
 from idom.server.utils import find_available_port
 
 
@@ -60,7 +60,7 @@ def create_simple_selenium_web_driver(
 
 _Self = TypeVar("_Self", bound="ServerMountPoint[Any, Any]")
 _Mount = TypeVar("_Mount")
-_Server = TypeVar("_Server", bound=Server[Any])
+_Server = TypeVar("_Server", bound=ServerType[Any])
 _App = TypeVar("_App")
 _Config = TypeVar("_Config")
 

tests/test_sample.py

@@ -0,0 +1,15 @@
+from idom.sample import run_sample_app
+from idom.server.utils import find_available_port
+
+
+def test_sample_app(driver):
+    host = "127.0.0.1"
+    port = find_available_port(host, allow_reuse_waiting_ports=False)
+
+    run_sample_app(host=host, port=port, run_in_thread=True)
+
+    driver.get(f"http://{host}:{port}")
+
+    h1 = driver.find_element("tag name", "h1")
+
+    assert h1.get_attribute("innerHTML") == "Sample Application"