misc work

straighten out the client protocol and add a few tests for
new functions

also update examples scripts

Author: rmorshea

idom/client/build_config.py

@@ -270,7 +270,7 @@ def _hash_config_item(config_item: Dict[str, Any]) -> str:
             "properties": {
                 "source_name": {
                     "type": "string",
-                    "pattern": r"^[\w\d\-]+$",
+                    "pattern": r"^[\w\d\-\.]+$",
                 },
                 "js_dependencies": {
                     "type": "array",

idom/client/manage.py

@@ -2,14 +2,14 @@
 import subprocess
 from pathlib import Path
 from tempfile import TemporaryDirectory
-from typing import Optional, Iterable, Sequence, List
+from typing import Optional, Iterable, Sequence, List, Tuple
 
 from .build_config import (
     BuildConfig,
     BuildConfigItem,
     find_python_packages_build_config_items,
 )
-from .utils import open_modifiable_json, find_js_module_exports
+from .utils import open_modifiable_json, find_js_module_exports_in_source
 
 from idom.cli import console
 
@@ -19,6 +19,10 @@
 _BUILD_CONFIG: Optional[BuildConfig] = None
 
 
+class WebModuleError(Exception):
+    """Related to the use of javascript web modules"""
+
+
 def build_config() -> BuildConfig:
     global _BUILD_CONFIG
     if _BUILD_CONFIG is None:
@@ -27,23 +31,24 @@ def build_config() -> BuildConfig:
 
 
 def web_module_exports(source_name: str, package_name: str) -> List[str]:
-    dep_alias = build_config().get_js_dependency_alias(source_name, package_name)
-    if dep_alias is None:
-        return []
-    module_file = find_client_build_path(f"web_modules/{dep_alias}.js")
-    if module_file is None:
-        return []
-    return find_js_module_exports(module_file)
+    _, module_file = _web_module_alias_and_file_path(source_name, package_name)
+    with module_file.open() as f:
+        return find_js_module_exports_in_source(f.read())
 
 
 def web_module_url(source_name: str, package_name: str) -> Optional[str]:
-    dep_alias = build_config().get_js_dependency_alias(source_name, package_name)
-    if dep_alias is None:
-        return None
-    if find_client_build_path(f"web_modules/{dep_alias}.js") is None:
-        return None
-    # need to go back a level since the JS that import this is in `core_components`
-    return f"../web_modules/{dep_alias}.js"
+    alias, _ = _web_module_alias_and_file_path(source_name, package_name)
+    # need to go back a level since the JS that imports this is in `core_components`
+    return f"../web_modules/{alias}.js"
+
+
+def web_module_exists(source_name: str, package_name: str) -> bool:
+    try:
+        _web_module_alias_and_file_path(source_name, package_name)
+    except WebModuleError:
+        return False
+    else:
+        return True
 
 
 def find_client_build_path(rel_path: str) -> Optional[Path]:
@@ -108,6 +113,22 @@ def restore() -> None:
         _run_subprocess(["npm", "run", "build"], APP_DIR)
 
 
+def _web_module_alias_and_file_path(
+    source_name: str, package_name: str
+) -> Tuple[str, Path]:
+    alias = build_config().get_js_dependency_alias(source_name, package_name)
+    if alias is None:
+        raise WebModuleError(
+            f"Package {package_name!r} is not declared as a dependency of {source_name!r}"
+        )
+    module_file = find_client_build_path(f"web_modules/{alias}.js")
+    if module_file is None:
+        raise WebModuleError(
+            f"Dependency {package_name!r} of {source_name!r} was not installed"
+        )
+    return alias, module_file
+
+
 def _npm_install(packages: Sequence[str], cwd: Path) -> None:
     _run_subprocess(["npm", "install"] + packages, cwd)
 

idom/client/module.py

@@ -52,12 +52,7 @@ def __init__(
             if source_name is None:
                 module_name: str = inspect.currentframe().f_back.f_globals["__name__"]
                 source_name = module_name.split(".", 1)[0]
-            url = client.current.web_module_url(source_name, url_or_name)
-            if url is None:
-                raise ValueError(
-                    f"{url_or_name!r} is not installed for {source_name!r}"
-                )
-            self.url = url
+            self.url = client.current.web_module_url(source_name, url_or_name)
             self.installed = True
             if check_exports:
                 self.exports = client.current.web_module_exports(

idom/client/protocol.py

@@ -1,4 +1,4 @@
-from typing import cast, Optional
+from typing import cast, List
 
 from typing_extensions import Protocol
 
@@ -10,9 +10,15 @@
 class ClientImplementation(Protocol):
     """A minimal set of functions required to use :class:`idom.widget.module.Module`"""
 
-    def web_module_url(self, source_name: str, package_name: str) -> Optional[str]:
+    def web_module_url(self, source_name: str, package_name: str) -> str:
         """Return the URL to import the module with the given name."""
 
+    def web_module_exports(self, source_name: str, package_name: str) -> List[str]:
+        """Return a list of names exported by a Javascript module."""
+
+    def web_module_exists(self, source_name: str, package_name: str) -> bool:
+        """Whether or not the given web module exists or is installed"""
+
 
 client_implementation: Ref[ClientImplementation] = Ref(
     cast(ClientImplementation, manage)

idom/client/utils.py

@@ -16,19 +16,19 @@ def open_modifiable_json(path: Path) -> Iterator[Any]:
         json.dump(data, f)
 
 
-_JS_MODULE_EXPORT_PATTERN = re.compile(r";export{(.*?)};")
-_JS_MODULE_EXPORT_NAME_PATTERN = re.compile(r";export (.*?) .*?;")
+_JS_VARIABLE_NAME = r"[a-zA-Z_$][0-9a-zA-Z_$]*"
+_JS_MODULE_EXPORT_PATTERN = re.compile(f";export{({_JS_VARIABLE_NAME})};")
+_JS_MODULE_EXPORT_NAME_PATTERN = re.compile(
+    f";export ({_JS_VARIABLE_NAME}) {_JS_VARIABLE_NAME};"
+)
 
 
-def find_js_module_exports(path: Path) -> List[str]:
+def find_js_module_exports_in_source(content: str) -> List[str]:
     names: List[str] = []
-    if path.suffix != ".js":
-        # we only know how to do this for javascript modules
-        return []
-    with path.open() as f:
-        content = f.read()
-        for match in _JS_MODULE_EXPORT_PATTERN.findall(content):
-            for export in match.split(","):
-                names.append(export.split(" as ", 1)[1].strip())
-        names.extend(_JS_MODULE_EXPORT_NAME_PATTERN.findall(content))
+    for match in _JS_MODULE_EXPORT_PATTERN.findall(content):
+        for export in match.split(","):
+            export_parts = export.split(" as ", 1)
+            print(export_parts)
+            names.append(export_parts[1].strip())
+    names.extend(_JS_MODULE_EXPORT_NAME_PATTERN.findall(content))
     return names

idom/server/sanic.py

@@ -2,7 +2,7 @@
 import json
 import uuid
 
-from typing import Tuple, Any, Dict, Union, Optional, cast
+from typing import Tuple, Any, Dict, Union, cast
 
 from sanic import Blueprint, Sanic, request, response
 from sanic_cors import CORS
@@ -16,14 +16,14 @@
     RecvCoroutine,
 )
 from idom.core.layout import LayoutEvent
-from idom.client.manage import find_client_build_path
+from idom.client.manage import BUILD_DIR
 
 from .base import AbstractRenderServer
 
 
 class Config(TypedDict, total=False):
     cors: Union[bool, Dict[str, Any]]
-    url_prefix: Optional[str]
+    url_prefix: str
     server_static_files: bool
     redirect_root_to_index: bool
 
@@ -37,7 +37,7 @@ def _stop(self) -> None:
     def _init_config(self) -> Config:
         return Config(
             cors=False,
-            url_prefix=None,
+            url_prefix="",
             server_static_files=True,
             redirect_root_to_index=True,
         )
@@ -81,30 +81,13 @@ def handler_name(function: Any) -> str:
             return f"{blueprint.name}.{function.__name__}"
 
         if config["server_static_files"]:
+            blueprint.static("/client", str(BUILD_DIR))
 
-            @blueprint.route("/client/<path:path>")  # type: ignore
-            async def client_files(
-                request: request.Request, path: str
-            ) -> response.HTTPResponse:
-                file_extensions = [".html", ".js", ".json"]
-                abs_path = find_client_build_path(path)
-                return (
-                    await response.file_stream(str(abs_path))
-                    if (
-                        abs_path is not None
-                        and abs_path.suffix in file_extensions
-                        and not abs_path.stem.startswith(".")
-                    )
-                    else response.text(f"Could not find: {path!r}", status=404)
-                )
-
-        if config["redirect_root_to_index"]:
+        if config["server_static_files"] and config["redirect_root_to_index"]:
 
             @blueprint.route("/")  # type: ignore
             def redirect_to_index(request: request.Request) -> response.HTTPResponse:
-                return response.redirect(
-                    request.app.url_for(handler_name(client_files), path="index.html")
-                )
+                return response.redirect(f"{blueprint.url_prefix}/client/index.html")
 
     def _run_application(
         self, app: Sanic, config: Config, args: Tuple[Any, ...], kwargs: Dict[str, Any]

scripts/all_examples.py

@@ -8,8 +8,6 @@
 from scripts.install_doc_js_modules import install_doc_js_modules
 
 
-install_doc_js_modules()
-
 here = Path(__file__).parent
 examples_dir = here.parent / "docs" / "source" / "examples"
 sys.path.insert(0, str(examples_dir))
@@ -20,6 +18,8 @@
 
 
 def main():
+    install_doc_js_modules()
+
     views = []
 
     for example_file in examples_dir.glob("*.py"):

scripts/install_doc_js_modules.py

@@ -1,5 +1,21 @@
-def install_doc_js_modules(show_spinner=True):
-    ...
+from pathlib import Path
+
+from idom.client.build_config import find_build_config_item_in_python_file
+from idom.client.manage import build, build_config
+
+
+DOCS_PATH = Path(__file__).parent.parent / "docs"
+
+
+def install_doc_js_modules():
+    config_item = find_build_config_item_in_python_file(
+        "__main__", DOCS_PATH / "main.py"
+    )
+    if (
+        config_item is not None
+        and config_item["source_name"] not in build_config().config["by_source"]
+    ):
+        build([config_item])
 
 
 if __name__ == "__main__":

scripts/one_example.py

@@ -6,8 +6,6 @@
 from scripts.install_doc_js_modules import install_doc_js_modules
 
 
-install_doc_js_modules()
-
 here = Path(__file__).parent
 examples_dir = here.parent / "docs" / "source" / "examples"
 sys.path.insert(0, str(examples_dir))
@@ -18,6 +16,8 @@
 
 
 def main():
+    install_doc_js_modules()
+
     try:
         ex_name = sys.argv[1]
     except IndexError:

tests/test_client/test_manage.py

@@ -1,6 +1,12 @@
 import pytest
 
-from idom.client.manage import web_module_url, web_module_exports, build, restore
+from idom.client.manage import (
+    web_module_url,
+    web_module_exports,
+    web_module_exists,
+    build,
+    restore,
+)
 
 from tests.general_utils import assert_same_items
 
@@ -15,14 +21,17 @@ def _setup_build_for_tests():
 
 
 def test_web_module_url():
-    assert web_module_url("tests", "does/not/exist") is None
     assert (
         web_module_url("tests", "victory") == "../web_modules/victory-tests-24fa38b.js"
     )
 
 
+def test_web_module_exists():
+    assert not web_module_exists("tests", "does/not/exist")
+    assert web_module_exists("tests", "victory")
+
+
 def test_web_module_exports():
-    assert web_module_exports("tests", "does/not/exist") == []
     assert_same_items(
         web_module_exports("tests", "victory"),
         [