move client utils into private module

Author: rmorshea

src/idom/_option.py

@@ -1,5 +1,7 @@
+from __future__ import annotations
+
 import os
-from typing import Callable, Generic, TypeVar
+from typing import Any, Callable, Generic, TypeVar
 
 _O = TypeVar("_O")
 
@@ -12,16 +14,13 @@ def __init__(
         name: str,
         default: _O,
         allow_changes: bool = True,
-        from_string: Callable[[str], _O] = lambda x: x,
+        validator: Callable[[Any], _O] = lambda x: x,
     ) -> None:
         self.name = name
         self._default = default
         self._allow_changes = allow_changes
-        assert name == name.upper()
-        if name not in os.environ:
-            self._value = default
-        else:
-            self._value = from_string(os.environ[name])
+        self._validator = validator
+        self._value = validator(os.environ.get(name, default))
 
     def get(self) -> _O:
         return self._value
@@ -30,7 +29,7 @@ def set(self, new: _O) -> _O:
         if not self._allow_changes:
             raise ValueError(f"{self.name} cannot be modified.")
         old = self._value
-        self._value = new
+        self._value = self._validator(new)
         return old
 
     def reset(self) -> _O:

src/idom/client/utils.py renamed to src/idom/client/_private.py

@@ -1,6 +1,42 @@
 import re
+import shutil
+from pathlib import Path
 from typing import List, Tuple
 
+from idom.config import IDOM_CLIENT_BUILD_DIR
+
+HERE = Path(__file__).parent
+
+
+APP_DIR = HERE / "app"
+BACKUP_BUILD_DIR = APP_DIR / "build"
+
+
+if not IDOM_CLIENT_BUILD_DIR.get().exists():
+    shutil.copytree(BACKUP_BUILD_DIR, IDOM_CLIENT_BUILD_DIR.get(), symlinks=True)
+
+
+def build_dir() -> Path:
+    return IDOM_CLIENT_BUILD_DIR.get()
+
+
+def web_modules_dir() -> Path:
+    return build_dir() / "_snowpack" / "pkg"
+
+
+def restore_build_dir_from_backup() -> None:
+    target = build_dir()
+    if target.exists():
+        shutil.rmtree(target)
+    shutil.copytree(BACKUP_BUILD_DIR, target, symlinks=True)
+
+
+def replace_build_dir(source: Path) -> None:
+    target = build_dir()
+    if target.exists():
+        shutil.rmtree(target)
+    shutil.copytree(source, target, symlinks=True)
+
 
 def get_package_name(pkg: str) -> str:
     return split_package_name_and_version(pkg)[0]

src/idom/client/manage.py

@@ -6,48 +6,23 @@
 from tempfile import TemporaryDirectory
 from typing import List, Sequence, Set, Union
 
-from idom.config import IDOM_CLIENT_BUILD_DIR
+from idom.config import IDOM_CLIENT_WEB_MODULE_BASE_URL
 
-from .utils import find_js_module_exports_in_source, get_package_name
+from . import _private
 
 logger = getLogger(__name__)
 
 
-_THIS_DIR = Path(__file__).parent
-_APP_DIR = _THIS_DIR / "app"
-_BACKUP_BUILD_DIR = _APP_DIR / "build"
-# these directory are modified when users install packages
-
-
-def _build_dir() -> Path:
-    return IDOM_CLIENT_BUILD_DIR.get()
-
-
-def _web_modules_dir() -> Path:
-    return _build_dir() / "_snowpack" / "pkg"
-
-
-def _copy_to_build_dir(source: Path) -> None:
-    target = _build_dir()
-    if target.exists():
-        shutil.rmtree(target)
-    shutil.copytree(source, target, symlinks=True)
-
-
-if not _build_dir().exists():  # coverage: skip
-    _copy_to_build_dir(_BACKUP_BUILD_DIR)
-
-
 def web_module_exports(package_name: str) -> List[str]:
     web_module_path(package_name, must_exist=True)
-    return find_js_module_exports_in_source(
+    return _private.find_js_module_exports_in_source(
         web_module_path(package_name).read_text(encoding="utf-8")
     )
 
 
 def web_module_url(package_name: str) -> str:
     web_module_path(package_name, must_exist=True)
-    return f"./_snowpack/pkg/{package_name}.js"
+    return IDOM_CLIENT_WEB_MODULE_BASE_URL.get() + f"/{package_name}.js"
 
 
 def web_module_exists(package_name: str) -> bool:
@@ -56,7 +31,7 @@ def web_module_exists(package_name: str) -> bool:
 
 def web_module_names() -> Set[str]:
     names = []
-    web_mod_dir = _web_modules_dir()
+    web_mod_dir = _private.web_modules_dir()
     for pth in web_mod_dir.glob("**/*.js"):
         rel_pth = pth.relative_to(web_mod_dir)
         if Path("common") in rel_pth.parents:
@@ -79,7 +54,7 @@ def add_web_module(package_name: str, source: Union[Path, str]) -> str:
 
 
 def web_module_path(package_name: str, must_exist: bool = False) -> Path:
-    path = _web_modules_dir().joinpath(*(package_name + ".js").split("/"))
+    path = _private.web_modules_dir().joinpath(*(package_name + ".js").split("/"))
     if must_exist and not path.exists():
         raise ValueError(
             f"Web module {package_name!r} does not exist at path {str(path)!r}"
@@ -88,7 +63,7 @@ def web_module_path(package_name: str, must_exist: bool = False) -> Path:
 
 
 def restore() -> None:
-    _copy_to_build_dir(_BACKUP_BUILD_DIR)
+    _private.restore_build_dir_from_backup()
 
 
 def build(packages_to_install: Sequence[str], clean_build: bool = False) -> None:
@@ -101,9 +76,11 @@ def build(packages_to_install: Sequence[str], clean_build: bool = False) -> None
         package_json_path = temp_app_dir / "package.json"
 
         # copy over the whole APP_DIR directory into the temp one
-        shutil.copytree(_APP_DIR, temp_app_dir, symlinks=True)
+        shutil.copytree(_private.APP_DIR, temp_app_dir, symlinks=True)
 
-        package_names_to_install = {get_package_name(p) for p in packages_to_install}
+        package_names_to_install = {
+            _private.get_package_name(p) for p in packages_to_install
+        }
 
         # make sure we don't delete anything we've already installed
         built_package_json_path = temp_build_dir / "package.json"
@@ -130,7 +107,7 @@ def build(packages_to_install: Sequence[str], clean_build: bool = False) -> None
         _npm_run_build(temp_app_dir)
         logger.info("Client built successfully ✅")
 
-        _copy_to_build_dir(temp_build_dir)
+        _private.replace_build_dir(temp_build_dir)
 
     not_discovered = package_names_to_install.difference(web_module_names())
     if not_discovered:

src/idom/client/module.py

@@ -4,8 +4,7 @@
 
 from idom.core.vdom import ImportSourceDict, VdomDict, make_vdom_constructor
 
-from . import manage
-from .utils import get_package_name
+from . import _private, manage
 
 
 @overload
@@ -36,7 +35,7 @@ def install(
         packages = [packages]
         return_one = True
 
-    pkg_names = {get_package_name(pkg) for pkg in packages}
+    pkg_names = {_private.get_package_name(pkg) for pkg in packages}
 
     if ignore_installed or pkg_names.difference(manage.web_module_names()):
         manage.build(packages)

src/idom/config.py

@@ -1,24 +1,25 @@
 from pathlib import Path
 
-from ._option import Option
+from . import _option
 
-IDOM_DEBUG_MODE = Option(
+IDOM_DEBUG_MODE = _option.Option(
     "IDOM_DEBUG_MODE",
     default=False,
     allow_changes=False,
-    from_string=lambda x: bool(int(x)),
+    validator=lambda x: bool(int(x)),
 )
 """Turn on/off debug mode"""
 
-IDOM_CLIENT_BUILD_DIR = Option(
+IDOM_CLIENT_BUILD_DIR = _option.Option(
     "IDOM_CLIENT_BUILD_DIR",
     default=Path(__file__).parent / "client" / "build",
-    from_string=Path,
+    validator=Path,
 )
 """The location IDOM will use for its client application"""
 
-IDOM_CLIENT_WEB_MODULE_BASE_URL = Option(
+IDOM_CLIENT_WEB_MODULE_BASE_URL = _option.Option(
     "IDOM_CLIENT_WEB_MODULE_BASE_URL",
-    default="./_snowpack/pkg",
+    default=".",
+    validator=lambda x: x.rstrip("/"),
 )
 """The base URL where all user-installed web modules reside"""

src/idom/server/sanic.py

@@ -9,7 +9,7 @@
 from sanic_cors import CORS
 from websockets import WebSocketCommonProtocol
 
-from idom.client.manage import IDOM_CLIENT_BUILD_DIR
+from idom.config import IDOM_CLIENT_BUILD_DIR
 from idom.core.dispatcher import (
     AbstractDispatcher,
     RecvCoroutine,

tests/test_client/test_manage.py

@@ -23,7 +23,7 @@ def test_web_module_path_must_exist():
 
 def test_web_module_url(victory):
     assert web_module_exists("victory")
-    assert web_module_url("victory") == "./victory.js"
+    assert web_module_url("victory") == "./_snowpack/pkg/victory.js"
 
 
 def test_web_module_exports(victory):

tests/test_client/test_utils.py renamed to tests/test_client/test_private.py

@@ -1,6 +1,6 @@
 import pytest
 
-from idom.client.utils import (
+from idom.client._private import (
     find_js_module_exports_in_source,
     split_package_name_and_version,
 )