check backend route priorities

Author: rmorshea

src/idom/backend/_urls.py

@@ -0,0 +1,7 @@
+from pathlib import PurePosixPath
+
+
+PATH_PREFIX = PurePosixPath("/_idom")
+MODULES_PATH = PATH_PREFIX / "modules"
+ASSETS_PATH = PATH_PREFIX / "assets"
+STREAM_PATH = PATH_PREFIX / "stream"

src/idom/backend/default.py

@@ -23,6 +23,11 @@ def create_development_app() -> Any:
     return _default_implementation().create_development_app()
 
 
+def Options(*args: Any, **kwargs: Any) -> Any:
+    """Create configuration options"""
+    return _default_implementation().Options(*args, **kwargs)
+
+
 async def serve_development_app(
     app: Any,
     host: str,

src/idom/backend/flask.py

@@ -33,6 +33,7 @@
 from idom.core.types import ComponentType, RootComponentConstructor
 from idom.utils import Ref
 
+from ._urls import ASSETS_PATH, MODULES_PATH, PATH_PREFIX, STREAM_PATH
 from .utils import (
     CLIENT_BUILD_DIR,
     safe_client_build_dir_path,
@@ -55,7 +56,7 @@ def configure(
     """
     options = options or Options()
 
-    api_bp = Blueprint(f"idom_api_{id(app)}", __name__, url_prefix="/_idom")
+    api_bp = Blueprint(f"idom_api_{id(app)}", __name__, url_prefix=str(PATH_PREFIX))
     spa_bp = Blueprint(f"idom_spa_{id(app)}", __name__, url_prefix=options.url_prefix)
 
     _setup_single_view_dispatcher_route(api_bp, options, component)
@@ -161,11 +162,11 @@ def _setup_common_routes(
 
     if options.serve_static_files:
 
-        @api_blueprint.route("/assets/<path:path>")
+        @api_blueprint.route(f"/{ASSETS_PATH.name}/<path:path>")
         def send_assets_dir(path: str = "") -> Any:
             return send_file(safe_client_build_dir_path(f"assets/{path}"))
 
-        @api_blueprint.route("/modules/<path:path>")
+        @api_blueprint.route(f"/{MODULES_PATH.name}/<path:path>")
         def send_modules_dir(path: str = "") -> Any:
             return send_file(safe_web_modules_dir_path(path))
 
@@ -189,8 +190,8 @@ def recv() -> LayoutEvent:
 
         _dispatch_in_thread(ws, path, constructor(), send, recv)
 
-    sock.route("stream", endpoint="without_path")(model_stream)
-    sock.route("stream/<path:path>", endpoint="with_path")(model_stream)
+    sock.route(STREAM_PATH.name, endpoint="without_path")(model_stream)
+    sock.route(f"{STREAM_PATH.name}/<path:path>", endpoint="with_path")(model_stream)
 
 
 def _dispatch_in_thread(

src/idom/backend/sanic.py

@@ -25,6 +25,7 @@
 from idom.core.types import RootComponentConstructor
 
 from ._asgi import serve_development_asgi
+from ._urls import ASSETS_PATH, MODULES_PATH, PATH_PREFIX, STREAM_PATH
 from .hooks import ConnectionContext
 from .hooks import use_connection as _use_connection
 from .utils import (
@@ -44,7 +45,7 @@ def configure(
     options = options or Options()
 
     spa_bp = Blueprint(f"idom_spa_{id(app)}", url_prefix=options.url_prefix)
-    api_bp = Blueprint(f"idom_api_{id(app)}", url_prefix="/_idom")
+    api_bp = Blueprint(f"idom_api_{id(app)}", url_prefix=str(PATH_PREFIX))
 
     _setup_common_routes(api_bp, spa_bp, options)
     _setup_single_view_dispatcher_route(api_bp, component, options)
@@ -133,7 +134,7 @@ async def asset_files(
             path = urllib_parse.unquote(path)
             return await response.file(safe_client_build_dir_path(f"assets/{path}"))
 
-        api_blueprint.add_route(asset_files, "/assets/<path:path>")
+        api_blueprint.add_route(asset_files, f"/{ASSETS_PATH.name}/<path:path>")
 
         async def web_module_files(
             request: request.Request,
@@ -146,7 +147,7 @@ async def web_module_files(
                 mime_type="text/javascript",
             )
 
-        api_blueprint.add_route(web_module_files, "/modules/<path:path>")
+        api_blueprint.add_route(web_module_files, f"/{MODULES_PATH.name}/<path:path>")
 
 
 def _setup_single_view_dispatcher_route(
@@ -189,8 +190,8 @@ async def model_stream(
             recv,
         )
 
-    api_blueprint.add_websocket_route(model_stream, "/stream")
-    api_blueprint.add_websocket_route(model_stream, "/stream/<path:path>/")
+    api_blueprint.add_websocket_route(model_stream, f"/{STREAM_PATH.name}")
+    api_blueprint.add_websocket_route(model_stream, f"/{STREAM_PATH.name}/<path:path>/")
 
 
 def _make_send_recv_callbacks(

src/idom/backend/starlette.py

@@ -26,6 +26,7 @@
 from idom.core.types import RootComponentConstructor
 
 from ._asgi import serve_development_asgi
+from ._urls import ASSETS_PATH, MODULES_PATH, STREAM_PATH
 from .hooks import ConnectionContext
 from .hooks import use_connection as _use_connection
 from .utils import CLIENT_BUILD_DIR
@@ -115,11 +116,11 @@ def _setup_common_routes(options: Options, app: Starlette) -> None:
 
     if options.serve_static_files:
         app.mount(
-            "/_idom/modules",
+            str(MODULES_PATH),
             StaticFiles(directory=IDOM_WEB_MODULES_DIR.current, check_dir=False),
         )
         app.mount(
-            "/_idom/assets",
+            str(ASSETS_PATH),
             StaticFiles(directory=CLIENT_BUILD_DIR / "assets", check_dir=False),
         )
         # register this last so it takes least priority
@@ -134,8 +135,8 @@ async def serve_index(request: Request) -> FileResponse:
 def _setup_single_view_dispatcher_route(
     options: Options, app: Starlette, constructor: RootComponentConstructor
 ) -> None:
-    @app.websocket_route("/_idom/stream")
-    @app.websocket_route("/_idom/stream/{path:path}")
+    @app.websocket_route(str(STREAM_PATH))
+    @app.websocket_route(f"{STREAM_PATH}/{{path:path}}")
     async def model_stream(socket: WebSocket) -> None:
         await socket.accept()
         send, recv = _make_send_recv_callbacks(socket)

src/idom/backend/tornado.py

@@ -22,6 +22,7 @@
 from idom.core.serve import VdomJsonPatch, serve_json_patch
 from idom.core.types import ComponentConstructor
 
+from ._urls import ASSETS_PATH, MODULES_PATH, STREAM_PATH
 from .hooks import ConnectionContext
 from .hooks import use_connection as _use_connection
 from .utils import CLIENT_BUILD_DIR
@@ -117,15 +118,15 @@ def _setup_common_routes(options: Options) -> _RouteHandlerSpecs:
     if options.serve_static_files:
         handlers.append(
             (
-                r"/_idom/modules/(.*)",
+                rf"{MODULES_PATH}/(.*)",
                 StaticFileHandler,
                 {"path": str(IDOM_WEB_MODULES_DIR.current)},
             )
         )
 
         handlers.append(
             (
-                r"/_idom/assets/(.*)",
+                rf"{ASSETS_PATH}/(.*)",
                 StaticFileHandler,
                 {"path": str(CLIENT_BUILD_DIR / "assets")},
             )
@@ -158,12 +159,12 @@ def _setup_single_view_dispatcher_route(
 ) -> _RouteHandlerSpecs:
     return [
         (
-            r"/_idom/stream/(.*)",
+            rf"{STREAM_PATH}/(.*)",
             ModelStreamHandler,
             {"component_constructor": constructor},
         ),
         (
-            r"/_idom/stream",
+            str(STREAM_PATH),
             ModelStreamHandler,
             {"component_constructor": constructor},
         ),

src/idom/backend/types.py

@@ -2,7 +2,7 @@
 
 import asyncio
 from dataclasses import dataclass
-from typing import Any, Generic, MutableMapping, TypeVar
+from typing import Any, Callable, Generic, MutableMapping, TypeVar
 
 from typing_extensions import Protocol, runtime_checkable
 
@@ -16,6 +16,9 @@
 class BackendImplementation(Protocol[_App]):
     """Common interface for built-in web server/framework integrations"""
 
+    Options: Callable[..., Any]
+    """A constructor for options passed to :meth:`BackendImplementation.configure`"""
+
     def configure(
         self,
         app: _App,

tests/test_backend/test_common.py

@@ -1,11 +1,13 @@
+from dataclasses import dataclass
 from typing import MutableMapping
 
 import pytest
 
 import idom
 from idom import html
 from idom.backend import default as default_implementation
-from idom.backend.types import Connection, Location
+from idom.backend._urls import PATH_PREFIX
+from idom.backend.types import BackendImplementation, Connection, Location
 from idom.backend.utils import all_implementations
 from idom.testing import BackendFixture, DisplayFixture, poll
 
@@ -16,7 +18,12 @@
     scope="module",
 )
 async def display(page, request):
-    async with BackendFixture(implementation=request.param) as server:
+    imp: BackendImplementation = request.param
+    async with BackendFixture(
+        implementation=imp,
+        # we do this to check that route priorities for each backend are correct
+        options=imp.Options(url_prefix=str(PATH_PREFIX)),
+    ) as server:
         async with DisplayFixture(backend=server, driver=page) as display:
             yield display