Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
c106ce1a44 | ||
|
|
b7b1920846 | ||
|
|
8ccfa1f658 | ||
|
|
c23401de88 | ||
|
|
c271f66615 | ||
|
|
458d798022 | ||
|
|
f5fcd626e8 |
+88
-71
@@ -13,6 +13,7 @@ Options:
|
|||||||
import argparse
|
import argparse
|
||||||
import os
|
import os
|
||||||
import re
|
import re
|
||||||
|
import shutil
|
||||||
import subprocess
|
import subprocess
|
||||||
import sys
|
import sys
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
@@ -51,9 +52,7 @@ PYPROJECT_ADDITIONS = {
|
|||||||
# Frontend instantiation block for patching existing apps
|
# Frontend instantiation block for patching existing apps
|
||||||
FRONTEND_BLOCK = """
|
FRONTEND_BLOCK = """
|
||||||
# Vue Frontend static files
|
# Vue Frontend static files
|
||||||
frontend = Frontend(
|
frontend = Frontend(Path(__file__).with_name("frontend-build"), cached=["/assets/"])
|
||||||
Path(__file__).with_name("frontend-build"), spa=True, cached=["/assets/"]
|
|
||||||
)
|
|
||||||
"""
|
"""
|
||||||
|
|
||||||
# TypeScript health check script for Vue components
|
# TypeScript health check script for Vue components
|
||||||
@@ -120,7 +119,7 @@ Next steps:
|
|||||||
|
|
||||||
def load_template(path: str) -> str:
|
def load_template(path: str) -> str:
|
||||||
"""Load a template file from the template directory."""
|
"""Load a template file from the template directory."""
|
||||||
return (TEMPLATE_DIR / path).read_text()
|
return (TEMPLATE_DIR / path).read_text("UTF-8")
|
||||||
|
|
||||||
|
|
||||||
def find_module_name(project_dir: Path) -> str | None:
|
def find_module_name(project_dir: Path) -> str | None:
|
||||||
@@ -129,7 +128,7 @@ def find_module_name(project_dir: Path) -> str | None:
|
|||||||
if not pyproject.exists():
|
if not pyproject.exists():
|
||||||
return None
|
return None
|
||||||
|
|
||||||
data = tomlkit.parse(pyproject.read_text())
|
data = tomlkit.parse(pyproject.read_text("UTF-8"))
|
||||||
|
|
||||||
if "project" in data and "name" in data["project"]:
|
if "project" in data and "name" in data["project"]:
|
||||||
name = data["project"]["name"]
|
name = data["project"]["name"]
|
||||||
@@ -178,7 +177,9 @@ def find_fastapi_app(
|
|||||||
return None
|
return None
|
||||||
|
|
||||||
|
|
||||||
def _find_app_via_entrypoint(module_dir: Path, project_dir: Path) -> tuple[Path, str] | None:
|
def _find_app_via_entrypoint(
|
||||||
|
module_dir: Path, project_dir: Path
|
||||||
|
) -> tuple[Path, str] | None:
|
||||||
"""Find FastAPI app by following the CLI entrypoint in pyproject.toml.
|
"""Find FastAPI app by following the CLI entrypoint in pyproject.toml.
|
||||||
|
|
||||||
If pyproject.toml has a script like `myapp = "myapp.subpkg.__main__:main"`,
|
If pyproject.toml has a script like `myapp = "myapp.subpkg.__main__:main"`,
|
||||||
@@ -189,7 +190,7 @@ def _find_app_via_entrypoint(module_dir: Path, project_dir: Path) -> tuple[Path,
|
|||||||
return None
|
return None
|
||||||
|
|
||||||
try:
|
try:
|
||||||
data = tomlkit.parse(pyproject.read_text())
|
data = tomlkit.parse(pyproject.read_text("UTF-8"))
|
||||||
except Exception:
|
except Exception:
|
||||||
return None
|
return None
|
||||||
|
|
||||||
@@ -257,7 +258,7 @@ def _find_existing_cli_entrypoint(project_dir: Path, module_name: str) -> str |
|
|||||||
return None
|
return None
|
||||||
|
|
||||||
try:
|
try:
|
||||||
data = tomlkit.parse(pyproject.read_text())
|
data = tomlkit.parse(pyproject.read_text("UTF-8"))
|
||||||
except Exception:
|
except Exception:
|
||||||
return None
|
return None
|
||||||
|
|
||||||
@@ -268,7 +269,7 @@ def _find_existing_cli_entrypoint(project_dir: Path, module_name: str) -> str |
|
|||||||
# Look for any script that references our module
|
# Look for any script that references our module
|
||||||
for script_name, entry in scripts.items():
|
for script_name, entry in scripts.items():
|
||||||
if isinstance(entry, str) and entry.startswith(f"{module_name}."):
|
if isinstance(entry, str) and entry.startswith(f"{module_name}."):
|
||||||
return f"{script_name} = \"{entry}\""
|
return f'{script_name} = "{entry}"'
|
||||||
|
|
||||||
return None
|
return None
|
||||||
|
|
||||||
@@ -281,7 +282,7 @@ def _follow_init_reexport(init_file: Path, subpkg_dir: Path) -> tuple[Path, str]
|
|||||||
- from module.subpkg.mainapp import app
|
- from module.subpkg.mainapp import app
|
||||||
"""
|
"""
|
||||||
try:
|
try:
|
||||||
content = init_file.read_text()
|
content = init_file.read_text("UTF-8")
|
||||||
except Exception:
|
except Exception:
|
||||||
return None
|
return None
|
||||||
|
|
||||||
@@ -315,7 +316,7 @@ def _follow_init_reexport(init_file: Path, subpkg_dir: Path) -> tuple[Path, str]
|
|||||||
def _find_app_in_file(path: Path) -> str | None:
|
def _find_app_in_file(path: Path) -> str | None:
|
||||||
"""Find FastAPI app variable name in a file."""
|
"""Find FastAPI app variable name in a file."""
|
||||||
try:
|
try:
|
||||||
content = path.read_text()
|
content = path.read_text("UTF-8")
|
||||||
except Exception:
|
except Exception:
|
||||||
return None
|
return None
|
||||||
|
|
||||||
@@ -350,7 +351,7 @@ def patch_app_file(
|
|||||||
print(f"❌ Cannot patch {path} - file not found")
|
print(f"❌ Cannot patch {path} - file not found")
|
||||||
return False
|
return False
|
||||||
|
|
||||||
original_content = path.read_text()
|
original_content = path.read_text("UTF-8")
|
||||||
marker = "from fastapi_vue import Frontend"
|
marker = "from fastapi_vue import Frontend"
|
||||||
|
|
||||||
if marker in original_content:
|
if marker in original_content:
|
||||||
@@ -390,6 +391,7 @@ def patch_app_file(
|
|||||||
|
|
||||||
# Append route at end
|
# Append route at end
|
||||||
lines.append("")
|
lines.append("")
|
||||||
|
lines.append("# Serve the Vue frontend (needs to be last if SPA catch-all is used)")
|
||||||
lines.append(route_line)
|
lines.append(route_line)
|
||||||
content = "\n".join(lines)
|
content = "\n".join(lines)
|
||||||
|
|
||||||
@@ -416,7 +418,7 @@ def patch_app_file(
|
|||||||
print(f"[DRY RUN] Would patch {path}")
|
print(f"[DRY RUN] Would patch {path}")
|
||||||
return True
|
return True
|
||||||
|
|
||||||
path.write_text(content)
|
path.write_text(content, "UTF-8", newline="\n")
|
||||||
print(f"✅ Patched {path}")
|
print(f"✅ Patched {path}")
|
||||||
|
|
||||||
if not lifespan_patched:
|
if not lifespan_patched:
|
||||||
@@ -451,7 +453,7 @@ def patch_vite_config(
|
|||||||
print(f"❌ Cannot patch {path} - file not found")
|
print(f"❌ Cannot patch {path} - file not found")
|
||||||
return False
|
return False
|
||||||
|
|
||||||
original_content = path.read_text()
|
original_content = path.read_text("UTF-8")
|
||||||
marker = "vite-plugin-fastapi"
|
marker = "vite-plugin-fastapi"
|
||||||
|
|
||||||
if marker in original_content:
|
if marker in original_content:
|
||||||
@@ -506,7 +508,7 @@ def patch_vite_config(
|
|||||||
print(f"[DRY RUN] Would patch {path}")
|
print(f"[DRY RUN] Would patch {path}")
|
||||||
return True
|
return True
|
||||||
|
|
||||||
path.write_text(content)
|
path.write_text(content, "UTF-8", newline="\n")
|
||||||
print(f"✅ Patched {path}")
|
print(f"✅ Patched {path}")
|
||||||
return True
|
return True
|
||||||
|
|
||||||
@@ -540,7 +542,7 @@ def patch_frontend_health_check(frontend_dir: Path, dry_run: bool = False) -> bo
|
|||||||
print("⚠️ No Vue file found to patch, skipping frontend health check")
|
print("⚠️ No Vue file found to patch, skipping frontend health check")
|
||||||
return False
|
return False
|
||||||
|
|
||||||
original_content = target_file.read_text()
|
original_content = target_file.read_text("UTF-8")
|
||||||
|
|
||||||
# Check if already patched
|
# Check if already patched
|
||||||
if "/api/health" in original_content:
|
if "/api/health" in original_content:
|
||||||
@@ -606,7 +608,7 @@ def patch_frontend_health_check(frontend_dir: Path, dry_run: bool = False) -> bo
|
|||||||
print(f"[DRY RUN] Would patch {target_file}")
|
print(f"[DRY RUN] Would patch {target_file}")
|
||||||
return True
|
return True
|
||||||
|
|
||||||
target_file.write_text(content)
|
target_file.write_text(content, "UTF-8", newline="\n")
|
||||||
print(f"✅ Patched {target_file}")
|
print(f"✅ Patched {target_file}")
|
||||||
return True
|
return True
|
||||||
|
|
||||||
@@ -622,11 +624,14 @@ def write_file(
|
|||||||
dry_run: bool = False,
|
dry_run: bool = False,
|
||||||
executable: bool = False,
|
executable: bool = False,
|
||||||
fallback_path: Path | None = None,
|
fallback_path: Path | None = None,
|
||||||
|
force: bool = False,
|
||||||
) -> bool:
|
) -> bool:
|
||||||
"""Write content to a file, handling existing files and dry-run.
|
"""Write content to a file, handling existing files and dry-run.
|
||||||
|
|
||||||
If fallback_path is provided and the file exists without the upgrade marker,
|
If fallback_path is provided and the file exists without the upgrade marker,
|
||||||
the content will be written to fallback_path instead of being skipped.
|
the content will be written to fallback_path instead of being skipped.
|
||||||
|
|
||||||
|
If force=True, always overwrite without checking for upgrade marker.
|
||||||
"""
|
"""
|
||||||
exists = path.exists()
|
exists = path.exists()
|
||||||
if exists and not overwrite:
|
if exists and not overwrite:
|
||||||
@@ -635,13 +640,13 @@ def write_file(
|
|||||||
|
|
||||||
# Check if content is the same
|
# Check if content is the same
|
||||||
if exists:
|
if exists:
|
||||||
existing_content = path.read_text()
|
existing_content = path.read_text("UTF-8")
|
||||||
if existing_content == content:
|
if existing_content == content:
|
||||||
print(f"✔️ {path} (already up to date)")
|
print(f"✔️ {path} (already up to date)")
|
||||||
return False
|
return False
|
||||||
|
|
||||||
# If overwrite requested but file doesn't have upgrade marker
|
# If overwrite requested but file doesn't have upgrade marker (unless force)
|
||||||
if overwrite and UPGRADE_MARKER not in existing_content:
|
if overwrite and not force and UPGRADE_MARKER not in existing_content:
|
||||||
if fallback_path is not None:
|
if fallback_path is not None:
|
||||||
# Write to fallback path instead
|
# Write to fallback path instead
|
||||||
return _write_fallback_file(
|
return _write_fallback_file(
|
||||||
@@ -656,7 +661,7 @@ def write_file(
|
|||||||
return True
|
return True
|
||||||
|
|
||||||
path.parent.mkdir(parents=True, exist_ok=True)
|
path.parent.mkdir(parents=True, exist_ok=True)
|
||||||
path.write_text(content)
|
path.write_text(content, "UTF-8", newline="\n")
|
||||||
if executable and sys.platform != "win32":
|
if executable and sys.platform != "win32":
|
||||||
path.chmod(path.stat().st_mode | 0o111)
|
path.chmod(path.stat().st_mode | 0o111)
|
||||||
action = "Updated" if exists else "Created"
|
action = "Updated" if exists else "Created"
|
||||||
@@ -674,7 +679,7 @@ def _write_fallback_file(
|
|||||||
"""Write content to a fallback .new.py file when original can't be overwritten."""
|
"""Write content to a fallback .new.py file when original can't be overwritten."""
|
||||||
# Check if fallback already has same content
|
# Check if fallback already has same content
|
||||||
if fallback_path.exists():
|
if fallback_path.exists():
|
||||||
if fallback_path.read_text() == content:
|
if fallback_path.read_text("UTF-8") == content:
|
||||||
print(f"✔️ {fallback_path} (already up to date)")
|
print(f"✔️ {fallback_path} (already up to date)")
|
||||||
return False
|
return False
|
||||||
|
|
||||||
@@ -684,7 +689,7 @@ def _write_fallback_file(
|
|||||||
return True
|
return True
|
||||||
|
|
||||||
fallback_path.parent.mkdir(parents=True, exist_ok=True)
|
fallback_path.parent.mkdir(parents=True, exist_ok=True)
|
||||||
fallback_path.write_text(content)
|
fallback_path.write_text(content, "UTF-8", newline="\n")
|
||||||
if executable and sys.platform != "win32":
|
if executable and sys.platform != "win32":
|
||||||
fallback_path.chmod(fallback_path.stat().st_mode | 0o111)
|
fallback_path.chmod(fallback_path.stat().st_mode | 0o111)
|
||||||
print(f"✅ Created {fallback_path} (original customized by user)")
|
print(f"✅ Created {fallback_path} (original customized by user)")
|
||||||
@@ -721,6 +726,7 @@ def merge_pyproject(
|
|||||||
req = data["project"]["requires-python"]
|
req = data["project"]["requires-python"]
|
||||||
# Parse minimum version from strings like ">=3.10" or ">=3.9,<4"
|
# Parse minimum version from strings like ">=3.10" or ">=3.9,<4"
|
||||||
import re
|
import re
|
||||||
|
|
||||||
match = re.search(r">=\s*(\d+)\.(\d+)", req)
|
match = re.search(r">=\s*(\d+)\.(\d+)", req)
|
||||||
if match:
|
if match:
|
||||||
major, minor = int(match.group(1)), int(match.group(2))
|
major, minor = int(match.group(1)), int(match.group(2))
|
||||||
@@ -784,8 +790,6 @@ def find_js_runtime() -> tuple[str, str] | None:
|
|||||||
Returns (tool_path, tool_name) where tool_name is "deno", "npm", or "bun".
|
Returns (tool_path, tool_name) where tool_name is "deno", "npm", or "bun".
|
||||||
Returns None if no runtime is found.
|
Returns None if no runtime is found.
|
||||||
"""
|
"""
|
||||||
import shutil
|
|
||||||
|
|
||||||
options = ["deno", "npm", "bun"]
|
options = ["deno", "npm", "bun"]
|
||||||
|
|
||||||
# Check for JS_RUNTIME environment variable
|
# Check for JS_RUNTIME environment variable
|
||||||
@@ -892,6 +896,9 @@ def cmd_setup(args: argparse.Namespace) -> int:
|
|||||||
- Patching existing projects with integration files
|
- Patching existing projects with integration files
|
||||||
- Updating already-patched projects
|
- Updating already-patched projects
|
||||||
"""
|
"""
|
||||||
|
# Clear any existing virtual environment to avoid uv using the wrong one (warning)
|
||||||
|
os.environ.pop("VIRTUAL_ENV", None)
|
||||||
|
|
||||||
project_path = Path(args.project_dir)
|
project_path = Path(args.project_dir)
|
||||||
|
|
||||||
# Handle both "." and "/path/to/project"
|
# Handle both "." and "/path/to/project"
|
||||||
@@ -947,7 +954,9 @@ def cmd_setup(args: argparse.Namespace) -> int:
|
|||||||
fastapi_vue_scripts = scripts_dir / "fastapi-vue"
|
fastapi_vue_scripts = scripts_dir / "fastapi-vue"
|
||||||
|
|
||||||
# Find existing FastAPI app
|
# Find existing FastAPI app
|
||||||
app_info = find_fastapi_app(module_dir, project_dir) if module_dir.exists() else None
|
app_info = (
|
||||||
|
find_fastapi_app(module_dir, project_dir) if module_dir.exists() else None
|
||||||
|
)
|
||||||
|
|
||||||
if app_info:
|
if app_info:
|
||||||
app_file, app_var = app_info
|
app_file, app_var = app_info
|
||||||
@@ -963,29 +972,36 @@ def cmd_setup(args: argparse.Namespace) -> int:
|
|||||||
|
|
||||||
# Create directories
|
# Create directories
|
||||||
if not dry_run:
|
if not dry_run:
|
||||||
fastapi_vue_scripts.mkdir(parents=True, exist_ok=True)
|
|
||||||
if not module_dir.exists():
|
if not module_dir.exists():
|
||||||
module_dir.mkdir(parents=True)
|
module_dir.mkdir(parents=True)
|
||||||
|
fastapi_vue_scripts.mkdir(parents=True, exist_ok=True)
|
||||||
|
|
||||||
# === Install scripts (always update our own scripts) ===
|
# === Install scripts (always update our own scripts) ===
|
||||||
# util.py and build-frontend.py are internal and always overwritten
|
# Scripts in fastapi-vue folder are internal and always overwritten
|
||||||
# devserver.py can be customized, so use fallback if needed
|
# devserver.py can be customized, so use fallback if needed
|
||||||
internal_script_files = [
|
|
||||||
(fastapi_vue_scripts / "util.py", "scripts/fastapi-vue/util.py"),
|
|
||||||
(
|
|
||||||
fastapi_vue_scripts / "build-frontend.py",
|
|
||||||
"scripts/fastapi-vue/build-frontend.py",
|
|
||||||
),
|
|
||||||
]
|
|
||||||
|
|
||||||
for dest_path, template_path in internal_script_files:
|
# Remove obsolete util.py if present
|
||||||
template = load_template(template_path)
|
obsolete_util = fastapi_vue_scripts / "util.py"
|
||||||
|
if obsolete_util.exists():
|
||||||
|
if dry_run:
|
||||||
|
print(f"[DRY RUN] Would remove obsolete {obsolete_util}")
|
||||||
|
else:
|
||||||
|
obsolete_util.unlink()
|
||||||
|
print(f"🗑️ Removed obsolete {obsolete_util}")
|
||||||
|
|
||||||
|
# Copy all files from the template's fastapi-vue folder
|
||||||
|
template_fastapi_vue_dir = TEMPLATE_DIR / "scripts" / "fastapi-vue"
|
||||||
|
for template_file in template_fastapi_vue_dir.iterdir():
|
||||||
|
if template_file.is_file():
|
||||||
|
dest_path = fastapi_vue_scripts / template_file.name
|
||||||
|
template = template_file.read_text("UTF-8")
|
||||||
content = render_template(template, **tpl_vars)
|
content = render_template(template, **tpl_vars)
|
||||||
write_file(
|
write_file(
|
||||||
dest_path,
|
dest_path,
|
||||||
content,
|
content,
|
||||||
overwrite=True,
|
overwrite=True,
|
||||||
dry_run=dry_run,
|
dry_run=dry_run,
|
||||||
|
force=True, # Internal files, always overwrite
|
||||||
)
|
)
|
||||||
|
|
||||||
# devserver.py - use fallback if customized by user
|
# devserver.py - use fallback if customized by user
|
||||||
@@ -1022,20 +1038,16 @@ def cmd_setup(args: argparse.Namespace) -> int:
|
|||||||
write_file(app_file_path, content, overwrite=False, dry_run=dry_run)
|
write_file(app_file_path, content, overwrite=False, dry_run=dry_run)
|
||||||
|
|
||||||
# === Handle __main__.py ===
|
# === Handle __main__.py ===
|
||||||
# Skip if project already has a CLI entrypoint in pyproject.toml
|
|
||||||
existing_cli = _find_existing_cli_entrypoint(project_dir, module_name)
|
|
||||||
if existing_cli:
|
|
||||||
print(f"ℹ️ Using existing CLI entrypoint: {existing_cli}")
|
|
||||||
else:
|
|
||||||
main_file = module_dir / "__main__.py"
|
main_file = module_dir / "__main__.py"
|
||||||
main_fallback = module_dir / "__main__.new.py"
|
main_fallback = module_dir / "__main__.new.py"
|
||||||
template = load_template("backend/__main__.py")
|
template = load_template("backend/__main__.py")
|
||||||
main_content = render_template(template, **tpl_vars)
|
main_content = render_template(template, **tpl_vars)
|
||||||
|
|
||||||
# Use write_file with fallback - it handles all cases:
|
# Check if project already has a CLI entrypoint in pyproject.toml
|
||||||
# - File doesn't exist: create it
|
existing_cli = _find_existing_cli_entrypoint(project_dir, module_name)
|
||||||
# - File exists with marker: update it
|
|
||||||
# - File exists without marker: write to fallback
|
if main_file.exists():
|
||||||
|
# File exists: update if it has the auto-upgrade marker, otherwise use fallback
|
||||||
write_file(
|
write_file(
|
||||||
main_file,
|
main_file,
|
||||||
main_content,
|
main_content,
|
||||||
@@ -1043,6 +1055,15 @@ def cmd_setup(args: argparse.Namespace) -> int:
|
|||||||
dry_run=dry_run,
|
dry_run=dry_run,
|
||||||
fallback_path=main_fallback,
|
fallback_path=main_fallback,
|
||||||
)
|
)
|
||||||
|
elif not existing_cli:
|
||||||
|
# No file and no existing entrypoint: create new __main__.py
|
||||||
|
write_file(
|
||||||
|
main_file,
|
||||||
|
main_content,
|
||||||
|
overwrite=False,
|
||||||
|
dry_run=dry_run,
|
||||||
|
)
|
||||||
|
# else: no file but has existing entrypoint - don't create (user has custom CLI setup)
|
||||||
|
|
||||||
# === Update vite.config.js/ts ===
|
# === Update vite.config.js/ts ===
|
||||||
frontend_dir = project_dir / "frontend"
|
frontend_dir = project_dir / "frontend"
|
||||||
@@ -1071,7 +1092,7 @@ def cmd_setup(args: argparse.Namespace) -> int:
|
|||||||
# === Update pyproject.toml ===
|
# === Update pyproject.toml ===
|
||||||
pyproject_path = project_dir / "pyproject.toml"
|
pyproject_path = project_dir / "pyproject.toml"
|
||||||
if pyproject_path.exists():
|
if pyproject_path.exists():
|
||||||
old_content = pyproject_path.read_text()
|
old_content = pyproject_path.read_text("UTF-8")
|
||||||
data = tomlkit.parse(old_content)
|
data = tomlkit.parse(old_content)
|
||||||
|
|
||||||
updated = merge_pyproject(data, PYPROJECT_ADDITIONS, module_name)
|
updated = merge_pyproject(data, PYPROJECT_ADDITIONS, module_name)
|
||||||
@@ -1090,30 +1111,9 @@ def cmd_setup(args: argparse.Namespace) -> int:
|
|||||||
elif dry_run:
|
elif dry_run:
|
||||||
print(f"[DRY RUN] Would update {pyproject_path}")
|
print(f"[DRY RUN] Would update {pyproject_path}")
|
||||||
else:
|
else:
|
||||||
pyproject_path.write_text(new_content)
|
pyproject_path.write_text(new_content, "UTF-8", newline="\n")
|
||||||
print(f"✅ Updated {pyproject_path}")
|
print(f"✅ Updated {pyproject_path}")
|
||||||
|
|
||||||
# === Add dependencies using uv ===
|
|
||||||
if dry_run:
|
|
||||||
print("[DRY RUN] Would run: uv add -U 'fastapi[standard]' fastapi-vue")
|
|
||||||
print("[DRY RUN] Would run: uv add -U --group dev httpx")
|
|
||||||
else:
|
|
||||||
print("📦 Adding dependencies...")
|
|
||||||
result = subprocess.run(
|
|
||||||
["uv", "add", "-U", "fastapi[standard]", "fastapi-vue"],
|
|
||||||
cwd=project_dir,
|
|
||||||
check=False,
|
|
||||||
)
|
|
||||||
if result.returncode != 0:
|
|
||||||
print("⚠️ Failed to add main dependencies")
|
|
||||||
result = subprocess.run(
|
|
||||||
["uv", "add", "-U", "--group", "dev", "httpx"],
|
|
||||||
cwd=project_dir,
|
|
||||||
check=False,
|
|
||||||
)
|
|
||||||
if result.returncode != 0:
|
|
||||||
print("⚠️ Failed to add dev dependencies")
|
|
||||||
|
|
||||||
# === Update .gitignore ===
|
# === Update .gitignore ===
|
||||||
gitignore_path = project_dir / ".gitignore"
|
gitignore_path = project_dir / ".gitignore"
|
||||||
gitignore_entry = f"/{module_name}/frontend-build"
|
gitignore_entry = f"/{module_name}/frontend-build"
|
||||||
@@ -1126,14 +1126,31 @@ def cmd_setup(args: argparse.Namespace) -> int:
|
|||||||
else:
|
else:
|
||||||
nl = b"\r\n" if b"\r\n" in gitignore_content else b"\n"
|
nl = b"\r\n" if b"\r\n" in gitignore_content else b"\n"
|
||||||
suffix = b"" if gitignore_content.endswith(nl) else nl
|
suffix = b"" if gitignore_content.endswith(nl) else nl
|
||||||
gitignore_path.write_bytes(gitignore_content + suffix + gitignore_entry.encode() + nl)
|
gitignore_path.write_bytes(
|
||||||
|
gitignore_content + suffix + gitignore_entry.encode() + nl
|
||||||
|
)
|
||||||
print(f"✅ Added {gitignore_entry} to .gitignore")
|
print(f"✅ Added {gitignore_entry} to .gitignore")
|
||||||
elif dry_run:
|
elif dry_run:
|
||||||
print(f"[DRY RUN] Would create .gitignore with {gitignore_entry}")
|
print(f"[DRY RUN] Would create .gitignore with {gitignore_entry}")
|
||||||
else:
|
else:
|
||||||
gitignore_path.write_text(f"{gitignore_entry}\n")
|
gitignore_path.write_text(f"{gitignore_entry}\n", "UTF-8", newline="\n")
|
||||||
print("✅ Created .gitignore")
|
print("✅ Created .gitignore")
|
||||||
|
|
||||||
|
# === Add dependencies using uv ===
|
||||||
|
uv_add_main = ["uv", "add", "-q", "-U", "--no-sync", "fastapi[standard]", "fastapi-vue"]
|
||||||
|
uv_add_dev = ["uv", "add", "-q", "-U", "--group", "dev", "httpx"]
|
||||||
|
if dry_run:
|
||||||
|
print(f"[DRY RUN] Would run: {' '.join(uv_add_main)}")
|
||||||
|
print(f"[DRY RUN] Would run: {' '.join(uv_add_dev)}")
|
||||||
|
else:
|
||||||
|
print("📦 Adding dependencies...")
|
||||||
|
result = subprocess.run(uv_add_main, cwd=project_dir, check=False)
|
||||||
|
if result.returncode != 0:
|
||||||
|
print("⚠️ Failed to add main dependencies")
|
||||||
|
result = subprocess.run(uv_add_dev, cwd=project_dir, check=False)
|
||||||
|
if result.returncode != 0:
|
||||||
|
print("⚠️ Failed to add dev dependencies")
|
||||||
|
|
||||||
print()
|
print()
|
||||||
print("=" * 60)
|
print("=" * 60)
|
||||||
print("✅ Setup complete!")
|
print("✅ Setup complete!")
|
||||||
|
|||||||
@@ -3,35 +3,24 @@ import argparse
|
|||||||
import asyncio
|
import asyncio
|
||||||
import os
|
import os
|
||||||
|
|
||||||
import uvicorn
|
|
||||||
from fastapi_vue.hostutil import parse_endpoint
|
from fastapi_vue.hostutil import parse_endpoint
|
||||||
from uvicorn import Config, Server
|
from uvicorn import Config, Server
|
||||||
|
|
||||||
from .APP_MODULE import APP_VAR
|
|
||||||
|
|
||||||
DEFAULT_PORT = 5080
|
DEFAULT_PORT = 5080
|
||||||
|
|
||||||
|
|
||||||
def run_server(endpoints: list[dict], *, proxy="", devmode=False):
|
def run_server(endpoints: list[dict], *, proxy=""):
|
||||||
conf: dict[str, object] = {"app": "MODULE_NAME.APP_MODULE:APP_VAR"}
|
conf: dict[str, object] = {"app": "MODULE_NAME.APP_MODULE:APP_VAR"}
|
||||||
if proxy:
|
if proxy:
|
||||||
conf["proxy_headers"] = True
|
conf["proxy_headers"] = True
|
||||||
conf["forwarded_allow_ips"] = proxy
|
conf["forwarded_allow_ips"] = proxy
|
||||||
if devmode:
|
|
||||||
conf["reload"] = True
|
|
||||||
conf["reload_dirs"] = ["MODULE_NAME"]
|
|
||||||
APP_VAR.debug = True
|
|
||||||
|
|
||||||
if len(endpoints) > 1:
|
|
||||||
# Run separate servers for multiple endpoints
|
|
||||||
async def serve_all():
|
async def serve_all():
|
||||||
async with asyncio.TaskGroup() as tg:
|
async with asyncio.TaskGroup() as tg:
|
||||||
for ep in endpoints:
|
for ep in endpoints:
|
||||||
tg.create_task(Server(Config(**conf, **ep)).serve())
|
tg.create_task(Server(Config(**conf, **ep)).serve())
|
||||||
|
|
||||||
asyncio.run(serve_all())
|
asyncio.run(serve_all())
|
||||||
else:
|
|
||||||
uvicorn.run(**conf, **endpoints[0])
|
|
||||||
|
|
||||||
|
|
||||||
def main():
|
def main():
|
||||||
@@ -46,9 +35,10 @@ def main():
|
|||||||
)
|
)
|
||||||
args = parser.parse_args()
|
args = parser.parse_args()
|
||||||
proxy = os.getenv("FORWARDED_ALLOW_IPS", "127.0.0.1,::1")
|
proxy = os.getenv("FORWARDED_ALLOW_IPS", "127.0.0.1,::1")
|
||||||
devmode = bool(os.getenv("FASTAPI_VUE_FRONTEND_URL"))
|
try:
|
||||||
endpoints = parse_endpoint(args.endpoint, DEFAULT_PORT)
|
run_server(parse_endpoint(args.endpoint, DEFAULT_PORT), proxy=proxy)
|
||||||
run_server(endpoints, proxy=proxy, devmode=devmode)
|
except KeyboardInterrupt:
|
||||||
|
pass
|
||||||
|
|
||||||
|
|
||||||
if __name__ == "__main__":
|
if __name__ == "__main__":
|
||||||
|
|||||||
@@ -5,9 +5,7 @@ from fastapi import FastAPI
|
|||||||
from fastapi_vue import Frontend
|
from fastapi_vue import Frontend
|
||||||
|
|
||||||
# Vue Frontend static files
|
# Vue Frontend static files
|
||||||
frontend = Frontend(
|
frontend = Frontend(Path(__file__).with_name("frontend-build"), cached=["/assets/"])
|
||||||
Path(__file__).with_name("frontend-build"), spa=True, cached=["/assets/"]
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
@asynccontextmanager
|
@asynccontextmanager
|
||||||
@@ -29,5 +27,5 @@ async def health_check():
|
|||||||
return {"status": "ok"}
|
return {"status": "ok"}
|
||||||
|
|
||||||
|
|
||||||
# Final catch-all route for frontend files (keep at end of file)
|
# Serve the Vue frontend (needs to be last if SPA catch-all is used)
|
||||||
frontend.route(app, "/")
|
frontend.route(app, "/")
|
||||||
|
|||||||
+45
-234
@@ -1,242 +1,63 @@
|
|||||||
#!/usr/bin/env -S uv run
|
#!/usr/bin/env -S uv run
|
||||||
# auto-upgrade@fastapi-vue-setup - remove this if you modify this file
|
# auto-upgrade@fastapi-vue-setup - remove this if you modify this file
|
||||||
"""Run Vite development server for frontend and FastAPI backend with auto-reload.
|
"""Run Vite development server for frontend and FastAPI backend with auto-reload."""
|
||||||
|
|
||||||
Usage:
|
|
||||||
uv run scripts/devserver.py [host:port] [--backend host:port]
|
|
||||||
|
|
||||||
The optional host:port argument sets where the Vite frontend listens.
|
|
||||||
Supported forms: host[:port], :port (all interfaces), or just port.
|
|
||||||
The --backend option sets where the FastAPI backend listens (default: localhost:5180).
|
|
||||||
|
|
||||||
Environment:
|
|
||||||
JS_RUNTIME Path or name of JS runtime to use (deno, npm/node or bun).
|
|
||||||
FASTAPI_VUE_FRONTEND_URL Set by this script for the backend to know where Vite is.
|
|
||||||
"""
|
|
||||||
|
|
||||||
import argparse
|
import argparse
|
||||||
import asyncio
|
import asyncio
|
||||||
import contextlib
|
import contextlib
|
||||||
import os
|
import os
|
||||||
|
import sys
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
from sys import stderr
|
|
||||||
|
|
||||||
import httpx
|
# Import util.py from scripts/fastapi-vue (not a package, so we adjust sys.path)
|
||||||
from fastapi_vue.hostutil import parse_endpoint
|
sys.path.insert(0, str(Path(__file__).with_name("fastapi-vue")))
|
||||||
|
from devutil import ( # type: ignore
|
||||||
exec((Path(__file__).parent / "fastapi-vue/util.py").read_text("UTF-8")) # noqa: S102
|
ProcessGroup,
|
||||||
|
check_ports_free,
|
||||||
DEFAULT_VITE_PORT = 5173
|
logger,
|
||||||
DEFAULT_BACKEND_PORT = 5180
|
ready,
|
||||||
FRONTEND_PATH = Path(__file__).parent.parent / "frontend"
|
setup_fastapi,
|
||||||
|
setup_vite,
|
||||||
EPILOG = """
|
)
|
||||||
scripts/devserver.py # Default ports on localhost
|
|
||||||
scripts/devserver.py 3000 # Vite on localhost:3000
|
|
||||||
scripts/devserver.py :3000 --backend 8000 # *:3000, localhost:8000
|
|
||||||
"""
|
|
||||||
|
|
||||||
BUN_BUG = """\
|
|
||||||
┃ ⚠️ Bun cannot correctly proxy API requests to the backend.
|
|
||||||
┃ Bug report: https://github.com/oven-sh/bun/issues/9882
|
|
||||||
┃
|
|
||||||
┃ Consider using deno or npm instead for development.
|
|
||||||
"""
|
|
||||||
|
|
||||||
|
|
||||||
def resolve_frontend_tools(
|
async def run_devserver(frontend: str, backend: str) -> None:
|
||||||
vite_port: int, all_ifaces: bool
|
reporoot = Path(__file__).parent.parent
|
||||||
) -> tuple[list[str], list[str], str]:
|
front = reporoot / "frontend"
|
||||||
"""Resolve frontend install and dev commands.
|
if not (front / "package.json").exists():
|
||||||
|
logger.warning("Frontend source not found at %s", front)
|
||||||
Returns (install_cmd, dev_cmd, tool_name).
|
|
||||||
Raises SystemExit if tools are not available.
|
|
||||||
"""
|
|
||||||
if not (FRONTEND_PATH / "package.json").exists():
|
|
||||||
stderr.write(f"┃ ⚠️ Frontend source not found at {FRONTEND_PATH}\n")
|
|
||||||
raise SystemExit(1)
|
raise SystemExit(1)
|
||||||
|
|
||||||
result = find_js_runtime() # noqa # type: ignore
|
viteurl, npm_install, vite = setup_vite(frontend)
|
||||||
if result is None:
|
backurl, fastapi = setup_fastapi(backend, "MODULE_NAME.APP_MODULE:APP_VAR")
|
||||||
if not os.environ.get("JS_RUNTIME"):
|
|
||||||
stderr.write("┃ ⚠️ deno, npm or bun needed to run the frontend server.\n")
|
|
||||||
raise SystemExit(1)
|
|
||||||
|
|
||||||
tool, name = result
|
# Tell the everyone where the frontend and backend are (vite proxy, etc)
|
||||||
|
os.environ["FASTAPI_VUE_FRONTEND_URL"] = viteurl
|
||||||
|
os.environ["FASTAPI_VUE_BACKEND_URL"] = backurl
|
||||||
|
|
||||||
install_args = {
|
async with ProcessGroup() as pg:
|
||||||
"deno": ("install", "--quiet", "--allow-scripts=npm:vue-demi"),
|
npm_i = await pg.spawn(*npm_install, cwd=front)
|
||||||
"npm": ("install", "--silent"),
|
await check_ports_free(viteurl, backurl)
|
||||||
"bun": ("install", "--silent"),
|
await pg.spawn(
|
||||||
}
|
*fastapi,
|
||||||
dev_args = {
|
|
||||||
"deno": ("run", "dev", "--"),
|
|
||||||
"npm": ("--silent", "run", "dev", "--"),
|
|
||||||
"bun": ("run", "dev", "--"),
|
|
||||||
}
|
|
||||||
|
|
||||||
install_cmd = [tool, *install_args[name]]
|
|
||||||
dev_cmd = [
|
|
||||||
tool,
|
|
||||||
*dev_args[name],
|
|
||||||
"--clearScreen=false",
|
|
||||||
f"--port={vite_port}",
|
|
||||||
]
|
|
||||||
|
|
||||||
if all_ifaces:
|
|
||||||
dev_cmd.append("--host")
|
|
||||||
|
|
||||||
if name == "bun":
|
|
||||||
stderr.write(BUN_BUG)
|
|
||||||
|
|
||||||
return install_cmd, dev_cmd, name
|
|
||||||
|
|
||||||
|
|
||||||
async def wait_for_backend(host: str, port: int):
|
|
||||||
"""Wait for the backend to be ready by polling the health endpoint."""
|
|
||||||
max_attempts = 50
|
|
||||||
url = f"http://{host}:{port}"
|
|
||||||
|
|
||||||
async with httpx.AsyncClient() as client:
|
|
||||||
for attempt in range(max_attempts):
|
|
||||||
try:
|
|
||||||
await client.get(url, timeout=1.0)
|
|
||||||
stderr.write("✓ Backend ready!\n")
|
|
||||||
return True
|
|
||||||
except httpx.RequestError:
|
|
||||||
if attempt == max_attempts - 1:
|
|
||||||
stderr.write("┃ ⚠️ Backend didn't start in time\n")
|
|
||||||
return False
|
|
||||||
await asyncio.sleep(0.1)
|
|
||||||
return False
|
|
||||||
|
|
||||||
|
|
||||||
async def _terminate_process(proc: asyncio.subprocess.Process, name: str) -> None:
|
|
||||||
"""Gracefully terminate a subprocess."""
|
|
||||||
if proc.returncode is not None:
|
|
||||||
return
|
|
||||||
try:
|
|
||||||
proc.terminate()
|
|
||||||
except ProcessLookupError:
|
|
||||||
return
|
|
||||||
try:
|
|
||||||
await asyncio.wait_for(proc.wait(), timeout=2)
|
|
||||||
except TimeoutError:
|
|
||||||
try:
|
|
||||||
proc.kill()
|
|
||||||
except ProcessLookupError:
|
|
||||||
return
|
|
||||||
await proc.wait()
|
|
||||||
|
|
||||||
|
|
||||||
async def run_devserver(
|
|
||||||
vite_port: int,
|
|
||||||
all_ifaces: bool,
|
|
||||||
backend_host: str,
|
|
||||||
backend_port: int,
|
|
||||||
) -> None:
|
|
||||||
"""Run the development server with install, backend, and frontend."""
|
|
||||||
install_cmd, dev_cmd, tool_name = resolve_frontend_tools(vite_port, all_ifaces)
|
|
||||||
|
|
||||||
# Tell the backend where the Vite dev server is
|
|
||||||
os.environ["FASTAPI_VUE_FRONTEND_URL"] = f"http://localhost:{vite_port}"
|
|
||||||
# Tell Vite where the backend is (for proxying /api requests)
|
|
||||||
os.environ["FASTAPI_VUE_BACKEND_URL"] = f"http://{backend_host}:{backend_port}"
|
|
||||||
|
|
||||||
backend_cmd = [
|
|
||||||
"uvicorn",
|
|
||||||
"MODULE_NAME.app:app",
|
|
||||||
"--host",
|
|
||||||
backend_host,
|
|
||||||
"--port",
|
|
||||||
str(backend_port),
|
|
||||||
"--reload",
|
"--reload",
|
||||||
]
|
"--reload-dir=MODULE_NAME", # Don't reload on frontend changes
|
||||||
|
"--forwarded-allow-ips=*",
|
||||||
cwd = str(Path(__file__).parent.parent)
|
cwd=reporoot,
|
||||||
frontend_cwd = str(FRONTEND_PATH)
|
|
||||||
|
|
||||||
backend_proc: asyncio.subprocess.Process | None = None
|
|
||||||
install_proc: asyncio.subprocess.Process | None = None
|
|
||||||
frontend_proc: asyncio.subprocess.Process | None = None
|
|
||||||
|
|
||||||
try:
|
|
||||||
# Start install (concurrent with backend)
|
|
||||||
stderr.write(f">>> {tool_name} {' '.join(install_cmd[1:])}\n")
|
|
||||||
install_proc = await asyncio.create_subprocess_exec(
|
|
||||||
*install_cmd, cwd=frontend_cwd
|
|
||||||
)
|
)
|
||||||
|
|
||||||
await asyncio.sleep(0.1)
|
# Wait for both install and backend to be ready
|
||||||
|
await pg.wait(npm_i, ready(backurl, path="/api/health?from=devserver.py"))
|
||||||
|
|
||||||
# Start backend (concurrent with install)
|
# Start Vite dev server (ProcessGroup waits for any exit, then terminates others)
|
||||||
stderr.write(f">>> {' '.join(backend_cmd)}\n")
|
await pg.spawn(*vite, cwd=front)
|
||||||
backend_proc = await asyncio.create_subprocess_exec(*backend_cmd, cwd=cwd)
|
|
||||||
|
|
||||||
# Wait for install to complete and backend to be ready
|
|
||||||
install_task = asyncio.create_task(install_proc.wait(), name="install")
|
|
||||||
backend_ready_task = asyncio.create_task(
|
|
||||||
wait_for_backend(backend_host, backend_port), name="backend_ready"
|
|
||||||
)
|
|
||||||
|
|
||||||
done, pending = await asyncio.wait(
|
|
||||||
{install_task, backend_ready_task},
|
|
||||||
return_when=asyncio.FIRST_COMPLETED,
|
|
||||||
)
|
|
||||||
|
|
||||||
for task in done:
|
|
||||||
if task.get_name() == "install":
|
|
||||||
if task.result() != 0:
|
|
||||||
stderr.write("┃ ⚠️ Install failed\n")
|
|
||||||
raise SystemExit(1)
|
|
||||||
elif task.get_name() == "backend_ready" and not task.result():
|
|
||||||
raise SystemExit(1)
|
|
||||||
|
|
||||||
if pending:
|
|
||||||
done2, _ = await asyncio.wait(pending)
|
|
||||||
for task in done2:
|
|
||||||
if task.get_name() == "install":
|
|
||||||
if task.result() != 0:
|
|
||||||
stderr.write("┃ ⚠️ Install failed\n")
|
|
||||||
raise SystemExit(1)
|
|
||||||
elif task.get_name() == "backend_ready" and not task.result():
|
|
||||||
raise SystemExit(1)
|
|
||||||
|
|
||||||
install_proc = None
|
|
||||||
|
|
||||||
# Start Vite dev server
|
|
||||||
stderr.write(f">>> {tool_name} {' '.join(dev_cmd[1:])}\n")
|
|
||||||
frontend_proc = await asyncio.create_subprocess_exec(*dev_cmd, cwd=frontend_cwd)
|
|
||||||
|
|
||||||
# Wait for either process to exit
|
|
||||||
done, pending = await asyncio.wait(
|
|
||||||
{
|
|
||||||
asyncio.create_task(backend_proc.wait(), name="backend"),
|
|
||||||
asyncio.create_task(frontend_proc.wait(), name="frontend"),
|
|
||||||
},
|
|
||||||
return_when=asyncio.FIRST_COMPLETED,
|
|
||||||
)
|
|
||||||
for t in done:
|
|
||||||
t.result()
|
|
||||||
for t in pending:
|
|
||||||
t.cancel()
|
|
||||||
|
|
||||||
except asyncio.CancelledError:
|
|
||||||
stderr.write("\n✓ Shutting down...\n")
|
|
||||||
finally:
|
|
||||||
if frontend_proc is not None:
|
|
||||||
await _terminate_process(frontend_proc, "frontend")
|
|
||||||
if install_proc is not None:
|
|
||||||
await _terminate_process(install_proc, "install")
|
|
||||||
if backend_proc is not None:
|
|
||||||
await _terminate_process(backend_proc, "backend")
|
|
||||||
|
|
||||||
|
|
||||||
def main():
|
def main():
|
||||||
parser = argparse.ArgumentParser(
|
parser = argparse.ArgumentParser(
|
||||||
description="Run Vite and FastAPI development servers",
|
description="Run Vite and FastAPI development servers",
|
||||||
formatter_class=argparse.RawDescriptionHelpFormatter,
|
formatter_class=argparse.RawDescriptionHelpFormatter,
|
||||||
epilog=EPILOG,
|
epilog=HELP_EPILOG,
|
||||||
)
|
)
|
||||||
parser.add_argument(
|
parser.add_argument(
|
||||||
"frontend",
|
"frontend",
|
||||||
@@ -250,27 +71,17 @@ def main():
|
|||||||
help="FastAPI backend endpoint (default: localhost:5180)",
|
help="FastAPI backend endpoint (default: localhost:5180)",
|
||||||
)
|
)
|
||||||
args = parser.parse_args()
|
args = parser.parse_args()
|
||||||
|
|
||||||
# parse_endpoint returns list of dicts with host/port or uds keys
|
|
||||||
# Multiple entries means bind all interfaces (IPv4 + IPv6)
|
|
||||||
vite_endpoints = parse_endpoint(args.frontend, DEFAULT_VITE_PORT)
|
|
||||||
backend_endpoints = parse_endpoint(args.backend, DEFAULT_BACKEND_PORT)
|
|
||||||
|
|
||||||
# Vite doesn't support unix sockets
|
|
||||||
if "uds" in vite_endpoints[0]:
|
|
||||||
stderr.write("┃ ⚠️ Unix sockets not supported for frontend\n")
|
|
||||||
raise SystemExit(1)
|
|
||||||
if "uds" in backend_endpoints[0]:
|
|
||||||
stderr.write("┃ ⚠️ Unix sockets not supported for backend\n")
|
|
||||||
raise SystemExit(1)
|
|
||||||
|
|
||||||
vite_port = vite_endpoints[0]["port"]
|
|
||||||
all_ifaces = len(vite_endpoints) > 1
|
|
||||||
backend_host = backend_endpoints[0]["host"]
|
|
||||||
backend_port = backend_endpoints[0]["port"]
|
|
||||||
|
|
||||||
with contextlib.suppress(KeyboardInterrupt):
|
with contextlib.suppress(KeyboardInterrupt):
|
||||||
asyncio.run(run_devserver(vite_port, all_ifaces, backend_host, backend_port))
|
asyncio.run(run_devserver(args.frontend, args.backend))
|
||||||
|
|
||||||
|
|
||||||
|
HELP_EPILOG = """
|
||||||
|
scripts/devserver.py # Default ports on localhost
|
||||||
|
scripts/devserver.py 3000 # Vite on localhost:3000
|
||||||
|
scripts/devserver.py :3000 --backend 8000 # *:3000, localhost:8000
|
||||||
|
|
||||||
|
JS_RUNTIME environment variable can be used to select the JS runtime
|
||||||
|
"""
|
||||||
|
|
||||||
|
|
||||||
if __name__ == "__main__":
|
if __name__ == "__main__":
|
||||||
|
|||||||
@@ -1,34 +1,15 @@
|
|||||||
"""Hatch build hook for building Vue frontend during package build."""
|
"""Hatch build hook for building Vue frontend during package build."""
|
||||||
|
|
||||||
import subprocess
|
import sys
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
from sys import stderr
|
|
||||||
|
|
||||||
from hatchling.builders.hooks.plugin.interface import BuildHookInterface # type: ignore
|
from hatchling.builders.hooks.plugin.interface import BuildHookInterface # type: ignore
|
||||||
|
|
||||||
exec(Path(__file__).with_name("util.py").read_text("UTF-8")) # noqa: S102
|
sys.path.insert(0, str(Path(__file__).parent))
|
||||||
|
from buildutil import build
|
||||||
|
|
||||||
def run(cmd, **kwargs):
|
|
||||||
"""Run a command and display it."""
|
|
||||||
display_cmd = [Path(cmd[0]).name, *cmd[1:]]
|
|
||||||
stderr.write(f"### {' '.join(display_cmd)}\n")
|
|
||||||
subprocess.run(cmd, check=True, **kwargs)
|
|
||||||
|
|
||||||
|
|
||||||
class CustomBuildHook(BuildHookInterface):
|
class CustomBuildHook(BuildHookInterface):
|
||||||
"""Build hook that compiles Vue frontend before packaging."""
|
|
||||||
|
|
||||||
def initialize(self, version, build_data):
|
def initialize(self, version, build_data):
|
||||||
super().initialize(version, build_data)
|
super().initialize(version, build_data)
|
||||||
stderr.write(">>> Building the frontend\n")
|
build("frontend")
|
||||||
|
|
||||||
install_cmd, build_cmd = find_build_tool() # noqa # type: ignore
|
|
||||||
|
|
||||||
try:
|
|
||||||
run(install_cmd, cwd="frontend")
|
|
||||||
stderr.write("\n")
|
|
||||||
run(build_cmd, cwd="frontend")
|
|
||||||
except Exception as e:
|
|
||||||
stderr.write(f"Error occurred while building frontend: {e}\n")
|
|
||||||
raise
|
|
||||||
|
|||||||
@@ -0,0 +1,191 @@
|
|||||||
|
"""Utilities used at build time and in devserver script. No dependencies."""
|
||||||
|
|
||||||
|
import logging
|
||||||
|
import os
|
||||||
|
import re
|
||||||
|
import shutil
|
||||||
|
import subprocess
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
|
||||||
|
class _PrefixFormatter(logging.Formatter):
|
||||||
|
"""Formatter that adds prefix based on log level."""
|
||||||
|
|
||||||
|
def format(self, record: logging.LogRecord) -> str:
|
||||||
|
if record.levelno >= logging.WARNING:
|
||||||
|
return f"⚠️ {record.getMessage()}"
|
||||||
|
return record.getMessage()
|
||||||
|
|
||||||
|
|
||||||
|
_handler = logging.StreamHandler()
|
||||||
|
_handler.setFormatter(_PrefixFormatter())
|
||||||
|
logger = logging.getLogger("fastapi-vue")
|
||||||
|
logger.addHandler(_handler)
|
||||||
|
logger.setLevel(logging.INFO)
|
||||||
|
|
||||||
|
|
||||||
|
def _check_node_version(node_path: str) -> None:
|
||||||
|
"""Check if Node.js version is >= 20.
|
||||||
|
|
||||||
|
Raises RuntimeError if version is too old or cannot be determined.
|
||||||
|
"""
|
||||||
|
try:
|
||||||
|
result = subprocess.run(
|
||||||
|
[node_path, "--version"], capture_output=True, text=True, check=True
|
||||||
|
)
|
||||||
|
version_str = result.stdout.strip()
|
||||||
|
# Parse version like "v20.10.0" or "v18.17.1"
|
||||||
|
match = re.match(r"v(\d+)", version_str)
|
||||||
|
if match:
|
||||||
|
major_version = int(match.group(1))
|
||||||
|
if major_version >= 20:
|
||||||
|
return
|
||||||
|
raise RuntimeError(
|
||||||
|
f"Node.js {version_str} found, but v20+ required (install with nvm)"
|
||||||
|
)
|
||||||
|
except (subprocess.CalledProcessError, FileNotFoundError, ValueError):
|
||||||
|
pass
|
||||||
|
raise RuntimeError("Could not determine Node.js version")
|
||||||
|
|
||||||
|
|
||||||
|
def find_js_runtime() -> tuple[str, str]:
|
||||||
|
"""Find a JavaScript runtime from JS_RUNTIME env or auto-detect.
|
||||||
|
|
||||||
|
Returns (tool_path, tool_name) where tool_name is "deno", "npm", or "bun".
|
||||||
|
Raises JSRuntimeError if no suitable runtime is found.
|
||||||
|
"""
|
||||||
|
options = ["npm", "deno", "bun"]
|
||||||
|
node_version_error: RuntimeError | None = None
|
||||||
|
|
||||||
|
# Check for JS_RUNTIME environment variable
|
||||||
|
if js_runtime_env := os.environ.get("JS_RUNTIME"):
|
||||||
|
js_runtime = js_runtime_env
|
||||||
|
js_path = Path(js_runtime)
|
||||||
|
runtime_name = js_path.name
|
||||||
|
# Map node to npm
|
||||||
|
if runtime_name == "node":
|
||||||
|
runtime_name = "npm"
|
||||||
|
js_runtime = str(js_path.parent / "npm") if js_path.parent.name else "npm"
|
||||||
|
for option in options:
|
||||||
|
if option == runtime_name or runtime_name.startswith(option):
|
||||||
|
tool = shutil.which(js_runtime)
|
||||||
|
if tool is None:
|
||||||
|
raise RuntimeError(
|
||||||
|
f"JS_RUNTIME={js_runtime_env}: {option} not found"
|
||||||
|
)
|
||||||
|
# Check Node.js version if using npm
|
||||||
|
if option == "npm":
|
||||||
|
node_path = shutil.which("node", path=str(Path(tool).parent))
|
||||||
|
if node_path is None:
|
||||||
|
raise RuntimeError(
|
||||||
|
f"JS_RUNTIME={js_runtime_env}: node not found"
|
||||||
|
)
|
||||||
|
_check_node_version(node_path) # Raises on failure
|
||||||
|
return tool, option
|
||||||
|
raise RuntimeError(f"JS_RUNTIME={js_runtime_env} not recognized")
|
||||||
|
|
||||||
|
# Auto-detect
|
||||||
|
for option in options:
|
||||||
|
if tool := shutil.which(option):
|
||||||
|
# Check Node.js version if using npm
|
||||||
|
if option == "npm":
|
||||||
|
node_path = shutil.which("node", path=str(Path(tool).parent))
|
||||||
|
if node_path is None:
|
||||||
|
continue
|
||||||
|
try:
|
||||||
|
_check_node_version(node_path)
|
||||||
|
except RuntimeError as e:
|
||||||
|
node_version_error = e
|
||||||
|
continue # Try next runtime
|
||||||
|
return tool, option
|
||||||
|
|
||||||
|
# No runtime found - provide helpful error
|
||||||
|
if node_version_error:
|
||||||
|
raise node_version_error
|
||||||
|
raise RuntimeError("Node.js (v20+), Deno or Bun is required but none was found")
|
||||||
|
|
||||||
|
|
||||||
|
def find_build_tool():
|
||||||
|
"""Find JavaScript runtime and construct install/build commands.
|
||||||
|
|
||||||
|
Returns (install_cmd, build_cmd) tuples of command lists.
|
||||||
|
Raises RuntimeError if no runtime is found.
|
||||||
|
"""
|
||||||
|
install = {
|
||||||
|
"deno": ("install", "--allow-scripts=npm:vue-demi"),
|
||||||
|
"npm": ("install",),
|
||||||
|
"bun": ("--bun", "install"),
|
||||||
|
}
|
||||||
|
# Run vite directly for deno to avoid npm-run-all2/run-p issues
|
||||||
|
build = {
|
||||||
|
"deno": ("run", "-A", "npm:vite", "build"),
|
||||||
|
"npm": ("run", "build"),
|
||||||
|
"bun": ("--bun", "run", "build"),
|
||||||
|
}
|
||||||
|
|
||||||
|
tool, name = find_js_runtime()
|
||||||
|
return [tool, *install[name]], [tool, *build[name]]
|
||||||
|
|
||||||
|
|
||||||
|
def find_dev_tool() -> list[str]:
|
||||||
|
"""Find JavaScript runtime and construct dev command.
|
||||||
|
|
||||||
|
Returns dev_cmd (without vite-specific args).
|
||||||
|
Raises RuntimeError if no runtime is found.
|
||||||
|
"""
|
||||||
|
dev_args = {
|
||||||
|
"deno": ("run", "dev", "--"),
|
||||||
|
"npm": ("--silent", "run", "dev", "--"),
|
||||||
|
"bun": ("run", "dev", "--"),
|
||||||
|
}
|
||||||
|
|
||||||
|
tool, name = find_js_runtime()
|
||||||
|
|
||||||
|
if name == "bun":
|
||||||
|
logger.warning(
|
||||||
|
"Bun has a bug in WS proxying (https://github.com/oven-sh/bun/issues/9882). Consider using npm instead."
|
||||||
|
)
|
||||||
|
|
||||||
|
return [tool, *dev_args[name]]
|
||||||
|
|
||||||
|
|
||||||
|
def find_install_tool() -> list[str]:
|
||||||
|
"""Find JavaScript runtime and construct install command.
|
||||||
|
|
||||||
|
Returns install_cmd.
|
||||||
|
Raises RuntimeError if no runtime is found.
|
||||||
|
"""
|
||||||
|
install_args = {
|
||||||
|
"deno": ("install", "--quiet", "--allow-scripts=npm:vue-demi"),
|
||||||
|
"npm": ("install", "--silent"),
|
||||||
|
"bun": ("install", "--silent"),
|
||||||
|
}
|
||||||
|
|
||||||
|
tool, name = find_js_runtime()
|
||||||
|
return [tool, *install_args[name]]
|
||||||
|
|
||||||
|
|
||||||
|
def build(folder: str = "frontend") -> None:
|
||||||
|
"""Build the frontend in the specified folder.
|
||||||
|
|
||||||
|
Raises SystemExit(1) on failure.
|
||||||
|
"""
|
||||||
|
logger.info(">>> Building %s", folder)
|
||||||
|
|
||||||
|
try:
|
||||||
|
install_cmd, build_cmd = find_build_tool()
|
||||||
|
except RuntimeError as e:
|
||||||
|
logger.warning(e)
|
||||||
|
raise SystemExit(1)
|
||||||
|
|
||||||
|
def run(cmd):
|
||||||
|
display_cmd = [Path(cmd[0]).name, *cmd[1:]]
|
||||||
|
logger.info("### %s", " ".join(display_cmd))
|
||||||
|
subprocess.run(cmd, check=True, cwd=folder)
|
||||||
|
|
||||||
|
try:
|
||||||
|
run(install_cmd)
|
||||||
|
logger.info("")
|
||||||
|
run(build_cmd)
|
||||||
|
except subprocess.CalledProcessError:
|
||||||
|
raise SystemExit(1)
|
||||||
@@ -0,0 +1,197 @@
|
|||||||
|
"""Utilities meant for devserver script, used only in source repository with dev deps."""
|
||||||
|
|
||||||
|
import asyncio
|
||||||
|
import subprocess
|
||||||
|
from collections.abc import Coroutine
|
||||||
|
from pathlib import Path
|
||||||
|
from typing import Any
|
||||||
|
|
||||||
|
import httpx
|
||||||
|
from buildutil import find_dev_tool, find_install_tool, logger
|
||||||
|
from fastapi_vue.hostutil import parse_endpoint
|
||||||
|
|
||||||
|
DEFAULT_VITE_PORT = 5173
|
||||||
|
DEFAULT_BACKEND_PORT = 5180
|
||||||
|
|
||||||
|
|
||||||
|
class ProcessGroup:
|
||||||
|
"""Manage async subprocesses with automatic cleanup, like TaskGroup for processes."""
|
||||||
|
|
||||||
|
def __init__(self):
|
||||||
|
self._procs: list[asyncio.subprocess.Process] = []
|
||||||
|
self._cmds: dict[int, str] = {} # pid -> command name
|
||||||
|
|
||||||
|
async def spawn(
|
||||||
|
self, *cmd: str, cwd: str | None = None
|
||||||
|
) -> asyncio.subprocess.Process:
|
||||||
|
"""Spawn a subprocess and track it."""
|
||||||
|
cmd_name = Path(cmd[0]).name
|
||||||
|
logger.info(">>> %s", " ".join([cmd_name, *cmd[1:]]))
|
||||||
|
proc = await asyncio.create_subprocess_exec(*cmd, cwd=cwd)
|
||||||
|
self._procs.append(proc)
|
||||||
|
self._cmds[proc.pid] = cmd_name
|
||||||
|
return proc
|
||||||
|
|
||||||
|
async def wait(
|
||||||
|
self, *waitables: "asyncio.subprocess.Process | Coroutine[Any, Any, Any]"
|
||||||
|
) -> None:
|
||||||
|
"""Wait for processes/coroutines to complete, raise SystemExit on failure."""
|
||||||
|
|
||||||
|
async def wait_proc(proc: asyncio.subprocess.Process) -> None:
|
||||||
|
returncode = await proc.wait()
|
||||||
|
if returncode != 0:
|
||||||
|
cmd_name = self._cmds.get(proc.pid, "unknown")
|
||||||
|
raise subprocess.CalledProcessError(returncode, cmd_name)
|
||||||
|
|
||||||
|
tasks = [
|
||||||
|
wait_proc(w) if isinstance(w, asyncio.subprocess.Process) else w
|
||||||
|
for w in waitables
|
||||||
|
]
|
||||||
|
try:
|
||||||
|
await asyncio.gather(*tasks)
|
||||||
|
except subprocess.CalledProcessError as e:
|
||||||
|
logger.warning("%s failed with exit status %d", e.cmd, e.returncode)
|
||||||
|
raise SystemExit(1) from None
|
||||||
|
|
||||||
|
async def __aenter__(self):
|
||||||
|
return self
|
||||||
|
|
||||||
|
async def __aexit__(self, exc_type, *_):
|
||||||
|
"""Wait for one process to exit, terminate others, then wait for all."""
|
||||||
|
cleanup_task = asyncio.create_task(
|
||||||
|
self._cleanup(immediate=exc_type is not None)
|
||||||
|
)
|
||||||
|
try:
|
||||||
|
await asyncio.shield(cleanup_task)
|
||||||
|
except asyncio.CancelledError:
|
||||||
|
# Shield was cancelled but cleanup_task continues - wait for it
|
||||||
|
await cleanup_task
|
||||||
|
|
||||||
|
async def _cleanup(self, immediate: bool = False):
|
||||||
|
running = [p for p in self._procs if p.returncode is None]
|
||||||
|
if not running:
|
||||||
|
return
|
||||||
|
|
||||||
|
if not immediate:
|
||||||
|
# Wait for any one process to exit
|
||||||
|
await asyncio.wait(
|
||||||
|
[asyncio.create_task(p.wait()) for p in running],
|
||||||
|
return_when=asyncio.FIRST_COMPLETED,
|
||||||
|
)
|
||||||
|
|
||||||
|
# Terminate remaining processes
|
||||||
|
for p in self._procs:
|
||||||
|
if p.returncode is None:
|
||||||
|
try:
|
||||||
|
p.terminate()
|
||||||
|
except ProcessLookupError:
|
||||||
|
pass
|
||||||
|
|
||||||
|
# Wait for all to finish (with overall timeout)
|
||||||
|
still_running = [p for p in self._procs if p.returncode is None]
|
||||||
|
if still_running:
|
||||||
|
try:
|
||||||
|
await asyncio.wait_for(
|
||||||
|
asyncio.gather(*[p.wait() for p in still_running]),
|
||||||
|
timeout=10,
|
||||||
|
)
|
||||||
|
except TimeoutError:
|
||||||
|
for p in self._procs:
|
||||||
|
if p.returncode is None:
|
||||||
|
try:
|
||||||
|
p.kill()
|
||||||
|
except ProcessLookupError:
|
||||||
|
pass
|
||||||
|
await p.wait()
|
||||||
|
|
||||||
|
|
||||||
|
async def check_ports_free(*urls: str) -> None:
|
||||||
|
"""Verify URLs are not responding (ports are free). Raise SystemExit if any respond."""
|
||||||
|
async with httpx.AsyncClient() as client:
|
||||||
|
for url in urls:
|
||||||
|
try:
|
||||||
|
res = await client.get(url, timeout=0.1)
|
||||||
|
logger.warning(
|
||||||
|
"Conflicting %s already running at %s",
|
||||||
|
res.headers.get("server", "server"),
|
||||||
|
url,
|
||||||
|
)
|
||||||
|
raise SystemExit(1)
|
||||||
|
except httpx.RequestError:
|
||||||
|
pass # Expected - port is free
|
||||||
|
|
||||||
|
|
||||||
|
async def ready(url: str, path: str = "") -> None:
|
||||||
|
"""Wait for the server to be ready by polling an endpoint.
|
||||||
|
|
||||||
|
Raises SystemExit(1) if server doesn't start in time.
|
||||||
|
"""
|
||||||
|
max_attempts = 50
|
||||||
|
full_url = f"{url}{path}"
|
||||||
|
|
||||||
|
async with httpx.AsyncClient() as client:
|
||||||
|
for attempt in range(max_attempts):
|
||||||
|
try:
|
||||||
|
await client.get(full_url, timeout=1.0)
|
||||||
|
logger.info("✓ Backend ready!")
|
||||||
|
return
|
||||||
|
except httpx.RequestError:
|
||||||
|
if attempt == max_attempts - 1:
|
||||||
|
logger.warning("Backend didn't start in time")
|
||||||
|
raise SystemExit(1)
|
||||||
|
await asyncio.sleep(0.1)
|
||||||
|
|
||||||
|
|
||||||
|
def setup_vite(endpoint: str) -> tuple[str, list[str], list[str]]:
|
||||||
|
"""Parse frontend endpoint and build commands.
|
||||||
|
|
||||||
|
Returns (url, install_cmd, dev_cmd).
|
||||||
|
Raises SystemExit(1) on invalid config.
|
||||||
|
"""
|
||||||
|
endpoints = parse_endpoint(endpoint, DEFAULT_VITE_PORT)
|
||||||
|
|
||||||
|
if "uds" in endpoints[0]:
|
||||||
|
logger.warning("Unix sockets not supported with vite devserver")
|
||||||
|
raise SystemExit(1)
|
||||||
|
|
||||||
|
port = endpoints[0]["port"]
|
||||||
|
host = endpoints[0]["host"]
|
||||||
|
|
||||||
|
install_cmd = find_install_tool()
|
||||||
|
dev_cmd = find_dev_tool()
|
||||||
|
if host != "localhost":
|
||||||
|
dev_cmd.append("--host" if len(endpoints) > 1 else f"--host={host}")
|
||||||
|
if port != 5173:
|
||||||
|
dev_cmd.append(f"--port={port}")
|
||||||
|
|
||||||
|
return f"http://{host}:{port}", install_cmd, dev_cmd
|
||||||
|
|
||||||
|
|
||||||
|
def setup_fastapi(
|
||||||
|
endpoint: str, module: str, default_port: int = DEFAULT_BACKEND_PORT
|
||||||
|
) -> tuple[str, list[str]]:
|
||||||
|
"""Parse backend endpoint and build fastapi dev command.
|
||||||
|
|
||||||
|
Returns (url, cmd).
|
||||||
|
Raises SystemExit(1) on invalid config.
|
||||||
|
"""
|
||||||
|
endpoints = parse_endpoint(endpoint, default_port)
|
||||||
|
|
||||||
|
if "uds" in endpoints[0]:
|
||||||
|
logger.warning("Unix sockets not supported with vite devserver")
|
||||||
|
raise SystemExit(1)
|
||||||
|
|
||||||
|
host = endpoints[0]["host"]
|
||||||
|
port = endpoints[0]["port"]
|
||||||
|
|
||||||
|
cmd = [
|
||||||
|
"fastapi",
|
||||||
|
"dev",
|
||||||
|
"--entrypoint",
|
||||||
|
module,
|
||||||
|
"--host",
|
||||||
|
host,
|
||||||
|
"--port",
|
||||||
|
str(port),
|
||||||
|
]
|
||||||
|
return f"http://{host}:{port}", cmd
|
||||||
@@ -1,87 +0,0 @@
|
|||||||
"""Shared utilities for build and dev scripts."""
|
|
||||||
|
|
||||||
import os
|
|
||||||
import shutil
|
|
||||||
from pathlib import Path
|
|
||||||
from sys import stderr
|
|
||||||
|
|
||||||
|
|
||||||
def find_js_runtime() -> tuple[str, str] | None:
|
|
||||||
"""Find a JavaScript runtime from JS_RUNTIME env or auto-detect.
|
|
||||||
|
|
||||||
Returns (tool_path, tool_name) where tool_name is "deno", "npm", or "bun".
|
|
||||||
Returns None if no runtime is found.
|
|
||||||
"""
|
|
||||||
options = ["deno", "npm", "bun"]
|
|
||||||
|
|
||||||
# Check for JS_RUNTIME environment variable
|
|
||||||
if js_runtime_env := os.environ.get("JS_RUNTIME"):
|
|
||||||
js_runtime = js_runtime_env
|
|
||||||
js_path = Path(js_runtime)
|
|
||||||
runtime_name = js_path.name
|
|
||||||
# Map node to npm
|
|
||||||
if runtime_name == "node":
|
|
||||||
runtime_name = "npm"
|
|
||||||
js_runtime = str(js_path.parent / "npm") if js_path.parent.name else "npm"
|
|
||||||
for option in options:
|
|
||||||
if option == runtime_name or runtime_name.startswith(option):
|
|
||||||
tool = shutil.which(js_runtime)
|
|
||||||
if tool is None:
|
|
||||||
stderr.write(f"┃ ⚠️ JS_RUNTIME={js_runtime_env} not found\n")
|
|
||||||
return None
|
|
||||||
return tool, option
|
|
||||||
stderr.write(f"┃ ⚠️ JS_RUNTIME={js_runtime_env} not recognized\n")
|
|
||||||
return None
|
|
||||||
|
|
||||||
# Auto-detect
|
|
||||||
for option in options:
|
|
||||||
if tool := shutil.which(option):
|
|
||||||
return tool, option
|
|
||||||
return None
|
|
||||||
|
|
||||||
|
|
||||||
def find_build_tool():
|
|
||||||
"""Find JavaScript runtime and construct install/build commands.
|
|
||||||
|
|
||||||
Returns (install_cmd, build_cmd) tuples of command lists.
|
|
||||||
Raises RuntimeError if no runtime is found.
|
|
||||||
"""
|
|
||||||
install = {
|
|
||||||
"deno": ("install", "--allow-scripts=npm:vue-demi"),
|
|
||||||
"npm": ("install",),
|
|
||||||
"bun": ("--bun", "install"),
|
|
||||||
}
|
|
||||||
# Run vite directly for deno to avoid npm-run-all2/run-p issues
|
|
||||||
build = {
|
|
||||||
"deno": ("run", "-A", "npm:vite", "build"),
|
|
||||||
"npm": ("run", "build"),
|
|
||||||
"bun": ("--bun", "run", "build"),
|
|
||||||
}
|
|
||||||
|
|
||||||
result = find_js_runtime()
|
|
||||||
if result is None:
|
|
||||||
raise RuntimeError(
|
|
||||||
"Deno, npm or Bun is required for building but none was found"
|
|
||||||
)
|
|
||||||
|
|
||||||
tool, name = result
|
|
||||||
return [tool, *install[name]], [tool, *build[name]]
|
|
||||||
|
|
||||||
|
|
||||||
def find_dev_tool():
|
|
||||||
"""Find JavaScript runtime and construct dev command.
|
|
||||||
|
|
||||||
Returns (dev_cmd, tool_name) or (None, None) if not found.
|
|
||||||
"""
|
|
||||||
dev_args = {
|
|
||||||
"deno": ("run", "dev", "--"),
|
|
||||||
"npm": ("--silent", "run", "dev", "--"),
|
|
||||||
"bun": ("run", "dev", "--"),
|
|
||||||
}
|
|
||||||
|
|
||||||
result = find_js_runtime()
|
|
||||||
if result is None:
|
|
||||||
return None, None
|
|
||||||
|
|
||||||
tool, name = result
|
|
||||||
return [tool, *dev_args[name]], name
|
|
||||||
Reference in New Issue
Block a user