Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ install-dev:
bootstrap:
$(UV) sync --inexact --frozen --extra proxy --group proxy-dev --group e2e-dev
$(UV_RUN) python scripts/prisma_generate_if_needed.py
cd ui/litellm-dashboard && npm install --no-audit --no-fund
cd ui/litellm-dashboard && ../../scripts/with_dashboard_node.sh npm install --no-audit --no-fund
@main_root=$$(git worktree list --porcelain | head -1 | sed 's/^worktree //'); \
if [ "$$main_root" != "$$(git rev-parse --show-toplevel)" ] && [ -f "$$main_root/.env" ] && [ ! -f .env ]; then \
cp "$$main_root/.env" .env && echo "bootstrap: copied .env from $$main_root"; \
Expand Down
52 changes: 52 additions & 0 deletions scripts/with_dashboard_node.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
#!/usr/bin/env bash
set -eu

[ $# -gt 0 ] || { echo "usage: $0 <command> [args...]" >&2; exit 2; }

repo_root=$(cd "$(dirname "$0")/.." && pwd)
dashboard="$repo_root/ui/litellm-dashboard"
floor=$(sed -n 's/.*"node": *">=\([0-9][0-9.]*\)".*/\1/p' "$dashboard/package.json")
pinned=$(tr -d '[:space:]' < "$dashboard/.nvmrc")
floor="${floor:-$pinned}"

meets_floor() {
awk -v have="$1" -v need="$2" 'BEGIN {
split(have, h, "."); split(need, n, ".")
for (i = 1; i <= 3; i++) {
if (h[i] + 0 < n[i] + 0) exit 1
if (h[i] + 0 > n[i] + 0) exit 0
}
}'
}

current=$(node --version 2>/dev/null | tr -d 'v' || true)
if [ -n "$current" ] && meets_floor "$current" "$floor"; then
exec "$@"
fi

nvm_script="${NVM_DIR:-$HOME/.nvm}/nvm.sh"
if [ -r "$nvm_script" ]; then
echo "with_dashboard_node: node ${current:-missing} is below the dashboard floor $floor; switching to $pinned via nvm" >&2
set +eu
. "$nvm_script" --no-use || { echo "with_dashboard_node: could not load nvm from $nvm_script" >&2; exit 1; }
nvm install "$pinned" >&2 || { echo "with_dashboard_node: nvm install $pinned failed" >&2; exit 1; }
nvm use "$pinned" >&2 || { echo "with_dashboard_node: nvm use $pinned failed" >&2; exit 1; }
set -eu
Comment thread
greptile-apps[bot] marked this conversation as resolved.
Resolved
exec "$@"
fi

if command -v fnm > /dev/null 2>&1; then
echo "with_dashboard_node: node ${current:-missing} is below the dashboard floor $floor; switching to $pinned via fnm" >&2
fnm install "$pinned" >&2
eval "$(fnm env)"
fnm use "$pinned" >&2
exec "$@"
fi

cat >&2 <<EOF
with_dashboard_node: node ${current:-missing} does not meet ui/litellm-dashboard's engines floor (>= $floor) and neither nvm nor fnm is available to switch automatically.
Fix it with one of:
- install nvm (https://github.com/nvm-sh/nvm) and re-run; it will pick up node $pinned for you
- or install/upgrade node yourself to >= $floor (e.g. brew install node), then re-run
EOF
exit 1
138 changes: 138 additions & 0 deletions tests/test_litellm/test_with_dashboard_node.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,138 @@
import json
import os
import subprocess
from pathlib import Path

ROOT = Path(__file__).resolve().parents[2]
SCRIPT = ROOT / "scripts" / "with_dashboard_node.sh"


def _floor() -> str:
pkg = json.loads((ROOT / "ui" / "litellm-dashboard" / "package.json").read_text())
return pkg["engines"]["node"].removeprefix(">=")


def _bump_major(version: str, delta: int) -> str:
major, minor, patch = version.split(".")
return f"{int(major) + delta}.{minor}.{patch}"


def _fake_node(bin_dir: Path, version: str) -> Path:
bin_dir.mkdir(parents=True, exist_ok=True)
node = bin_dir / "node"
node.write_text(f'#!/bin/sh\necho "v{version}"\n')
node.chmod(0o755)
return bin_dir


def _run(bin_dirs: list[Path], home: Path) -> subprocess.CompletedProcess[str]:
path = os.pathsep.join([*(str(b) for b in bin_dirs), "/usr/bin", "/bin"])
home.mkdir(parents=True, exist_ok=True)
return subprocess.run(
[str(SCRIPT), "sh", "-c", "node --version"],
capture_output=True,
text=True,
env={"PATH": path, "HOME": str(home)},
)


def test_node_meeting_the_floor_runs_the_command_as_is(tmp_path):
bins = _fake_node(tmp_path / "bin", _floor())
proc = _run([bins], tmp_path / "home")
assert proc.returncode == 0, proc.stderr
assert proc.stdout.strip() == f"v{_floor()}"


def test_node_above_the_floor_runs_the_command_as_is(tmp_path):
above = _bump_major(_floor(), 1)
bins = _fake_node(tmp_path / "bin", above)
proc = _run([bins], tmp_path / "home")
assert proc.returncode == 0, proc.stderr
assert proc.stdout.strip() == f"v{above}"


def test_old_node_without_any_manager_fails_with_instructions(tmp_path):
bins = _fake_node(tmp_path / "bin", _bump_major(_floor(), -1))
proc = _run([bins], tmp_path / "home")
assert proc.returncode == 1
assert "does not meet" in proc.stderr
assert _floor() in proc.stderr
assert "nvm" in proc.stderr


def test_missing_node_without_any_manager_fails_with_instructions(tmp_path):
proc = _run([], tmp_path / "home")
assert proc.returncode == 1
assert "missing" in proc.stderr


def test_old_node_switches_via_nvm_when_present(tmp_path):
old = _fake_node(tmp_path / "old-bin", _bump_major(_floor(), -1))
new = _fake_node(tmp_path / "new-bin", "99.0.0")
home = tmp_path / "home"
nvm_dir = home / ".nvm"
nvm_dir.mkdir(parents=True)
(nvm_dir / "nvm.sh").write_text(
f'nvm() {{ [ "$1" = use ] && PATH="{new}:$PATH"; return 0; }}\n'
)
proc = _run([old], home)
assert proc.returncode == 0, proc.stderr
assert proc.stdout.strip() == "v99.0.0"
assert "via nvm" in proc.stderr


def test_old_node_switches_via_fnm_when_nvm_is_absent(tmp_path):
old = _fake_node(tmp_path / "old-bin", _bump_major(_floor(), -1))
new = _fake_node(tmp_path / "new-bin", "99.0.0")
fnm = tmp_path / "old-bin" / "fnm"
fnm.write_text(
f'#!/bin/sh\n[ "$1" = env ] && echo \'export PATH="{new}:$PATH"\'\nexit 0\n'
)
fnm.chmod(0o755)
proc = _run([old], tmp_path / "home")
assert proc.returncode == 0, proc.stderr
assert proc.stdout.strip() == "v99.0.0"
assert "via fnm" in proc.stderr


def _nvm_home(tmp_path, nvm_sh: str) -> Path:
home = tmp_path / "home"
nvm_dir = home / ".nvm"
nvm_dir.mkdir(parents=True)
(nvm_dir / "nvm.sh").write_text(nvm_sh)
return home


def test_failing_nvm_load_stops_before_running_the_command(tmp_path):
old = _fake_node(tmp_path / "old-bin", _bump_major(_floor(), -1))
proc = _run([old], _nvm_home(tmp_path, "false\n"))
assert proc.returncode == 1
assert "could not load nvm" in proc.stderr
assert proc.stdout == ""


def test_failing_nvm_install_stops_before_running_the_command(tmp_path):
old = _fake_node(tmp_path / "old-bin", _bump_major(_floor(), -1))
proc = _run([old], _nvm_home(tmp_path, 'nvm() { [ "$1" = install ] && return 1; return 0; }\n'))
assert proc.returncode == 1
assert "nvm install" in proc.stderr
assert proc.stdout == ""


def test_failing_nvm_use_stops_before_running_the_command(tmp_path):
old = _fake_node(tmp_path / "old-bin", _bump_major(_floor(), -1))
proc = _run([old], _nvm_home(tmp_path, 'nvm() { [ "$1" = use ] && return 1; return 0; }\n'))
assert proc.returncode == 1
assert "nvm use" in proc.stderr
assert proc.stdout == ""


def test_no_command_is_a_usage_error(tmp_path):
proc = subprocess.run(
[str(SCRIPT)],
capture_output=True,
text=True,
env={"PATH": "/usr/bin:/bin", "HOME": str(tmp_path)},
)
assert proc.returncode == 2
assert "usage" in proc.stderr
Loading