Automate client builds (#66)

* Updated .gitignore

* Auto confirm yarn install

* Ignore nodeenv when linting

* Added nodeenv to gitignore

* Always use local node, build heuristics, build before publish

* Typo

---------

Co-authored-by: Brent Yi <[email protected]>

.github/workflows/publish.yml

@@ -22,6 +22,8 @@ jobs:
           pip install --upgrade pip
           pip install -e ".[dev]"
           pip install build twine
+          # Build client files.
+          python -c "import viser; viser.ViserServer()"
       - name: Build and publish
         env:
           PYPI_USERNAME: ${{ secrets.PYPI_USERNAME }}

.gitignore

@@ -14,3 +14,5 @@ htmlcov
 .DS_Store
 .envrc
 .lvimrc
+viser/client/build
+viser/client/.nodeenv

pyproject.toml

@@ -31,6 +31,7 @@ dependencies = [
     "gdown>=4.6.6",
     "rich>=13.3.3",
     "trimesh>=3.21.7",
+    "nodeenv>=1.8.0",
 ]
 
 [project.optional-dependencies]
@@ -71,9 +72,13 @@ profile = "black"
 python_version = "3.8"
 ignore_missing_imports = true
 warn_unused_configs = true
+exclude="viser/client/.nodeenv"
 
 [tool.pyright]
-exclude = ["./docs/**/*", "./examples/assets/**/*"]
+exclude = ["./docs/**/*", "./examples/assets/**/*", "./viser/client/.nodeenv"]
+
+[tool.black]
+exclude = "viser/client/.nodeenv"
 
 [tool.ruff]
 select = [
@@ -99,3 +104,4 @@ ignore = [
     "PLW0603",  # Globa statement updates are discouraged.
     "PLW2901",  # For loop variable overwritten.
 ]
+exclude = [ ".nodeenv" ]

viser/_client_autobuild.py

@@ -0,0 +1,64 @@
+import subprocess
+import sys
+from pathlib import Path
+
+client_dir = Path(__file__).absolute().parent / "client"
+build_dir = client_dir / "build"
+
+
+def ensure_client_is_built() -> None:
+    """Ensure that the client is built."""
+
+    if not (client_dir / "src").exists():
+        assert (build_dir / "index.html").exists(), (
+            "Something went wrong! At least one of the client source or build"
+            " directories should be present."
+        )
+        return
+
+    # Do we need to re-trigger a build?
+    build = False
+    if not (build_dir / "index.html").exists():
+        print("[viser] No client build found. Building now...")
+        build = True
+    elif _modified_time_recursive(client_dir / "src") > _modified_time_recursive(
+        build_dir
+    ):
+        print("[viser] Client build looks out of date. Building now...")
+        build = True
+
+    # Install nodejs and build if necessary.
+    if build:
+        env_dir = _install_sandboxed_node()
+        npx_path = env_dir / "bin" / "npx"
+        subprocess.run(
+            args=(
+                f"source {env_dir / 'bin' / 'activate'};"
+                f"{npx_path} yarn install;"
+                "yarn run build;"
+            ),
+            cwd=client_dir,
+            shell=True,
+        )
+
+
+def _install_sandboxed_node() -> Path:
+    """Install a sandboxed copy of nodejs using nodeenv, and return a path to the
+    environment root."""
+    env_dir = client_dir / ".nodeenv"
+    if (env_dir / "bin" / "npx").exists():
+        print("[viser] nodejs already set up!")
+        return env_dir
+
+    subprocess.run([sys.executable, "-m", "nodeenv", "--node=20.4.0", env_dir])
+    subprocess.run(
+        args=[env_dir / "bin" / "npm", "install", "yarn"],
+        input="y\n".encode(),
+    )
+    assert (env_dir / "bin" / "npx").exists()
+    return env_dir
+
+
+def _modified_time_recursive(dir: Path) -> float:
+    """Recursively get the last time a file was modified in a directory."""
+    return max([f.stat().st_mtime for f in dir.glob("**/*")])

viser/_viser.py

@@ -11,7 +11,7 @@
 import numpy.typing as npt
 from typing_extensions import override
 
-from . import _messages, infra
+from . import _client_autobuild, _messages, infra
 from . import transforms as tf
 from ._message_api import MessageApi, cast_vector
 from ._scene_handle import FrameHandle, _SceneNodeHandleState
@@ -227,6 +227,8 @@ def __init__(self, host: str = "0.0.0.0", port: int = 8080):
         )
         super().__init__(server)
 
+        _client_autobuild.ensure_client_is_built()
+
         state = _ViserServerState(server)
         self._state = state
         self._client_connect_cb: List[Callable[[ClientHandle], None]] = []