Files
ss-tools/run.sh

321 lines
10 KiB
Bash
Executable File

#!/bin/bash
# #region run [C:2] [TYPE Module]
# @PURPOSE: Utility script for run
# @COMPLEXITY: 1
# Project Launch Script
# Automates setup and concurrent execution of backend and frontend servers.
set -e
# Default configuration
DEV_MODE="${DEV_MODE:-false}"
BACKEND_PORT=${BACKEND_PORT:-8000}
FRONTEND_PORT=${FRONTEND_PORT:-5173}
AGENT_PORT=${AGENT_PORT:-7860}
SKIP_INSTALL=false
# Help message
show_help() {
echo "Usage: ./run.sh [options]"
echo ""
echo "Options:"
echo " --help Show this help message"
echo " --skip-install Skip dependency checks and installation"
echo ""
echo "Environment Variables:"
echo " DEV_MODE Hot-reload mode (true/false). Default: false"
echo " Enables uvicorn --reload + watchfiles agent watcher"
echo " BACKEND_PORT Port for the backend server (default: 8000)"
echo " FRONTEND_PORT Port for the frontend server (default: 5173)"
echo " AGENT_PORT Port for the Gradio agent (default: 7860)"
echo " AGENT_CONFIRM_TOOLS Enable HITL confirmation before tool calls (default: true)"
echo ""
echo " LLM providers are fetched from FastAPI /api/agent/llm-config at startup."
echo " Configure them in Admin -> LLM Settings."
}
# Parse arguments
while [[ "$#" -gt 0 ]]; do
case $1 in
--help) show_help; exit 0 ;;
--skip-install) SKIP_INSTALL=true ;;
*) echo "Unknown parameter passed: $1"; show_help; exit 1 ;;
esac
shift
done
echo "Starting Project Launch Script..."
# Environment validation
validate_env() {
echo "Validating environment..."
if ! command -v python3 &> /dev/null; then
echo "Error: python3 is not installed."
exit 1
fi
if ! python3 -c 'import sys; exit(0) if sys.version_info >= (3, 9) else exit(1)'; then
PYTHON_VERSION=$(python3 -c 'import sys; print(".".join(map(str, sys.version_info[:2])))')
echo "Error: python3 version 3.9 or higher is required. Found $PYTHON_VERSION"
exit 1
fi
if ! command -v npm &> /dev/null; then
echo "Error: npm is not installed."
exit 1
fi
PYTHON_VERSION=$(python3 -c 'import sys; print(".".join(map(str, sys.version_info[:2])))')
echo "Environment validation passed (Python $PYTHON_VERSION, npm $(npm -v))"
}
validate_env
# Database connectivity preflight
check_database() {
# Keep resolution order aligned with backend/src/core/database.py defaults.
local DB_URL="${DATABASE_URL:-${POSTGRES_URL:-postgresql+psycopg2://postgres:postgres@localhost:5432/ss_tools}}"
# SQLite does not require external service.
if [[ "$DB_URL" == sqlite* ]]; then
echo "Database preflight: sqlite detected, skipping PostgreSQL connectivity check."
return
fi
local DB_HOST DB_PORT
read -r DB_HOST DB_PORT < <(
python3 - "$DB_URL" <<'PY'
import sys
from urllib.parse import urlparse
url = sys.argv[1]
if "://" not in url:
print("localhost 5432")
raise SystemExit(0)
# Support SQLAlchemy schemes like postgresql+psycopg2://...
scheme, rest = url.split("://", 1)
parsed = urlparse(f"{scheme.split('+', 1)[0]}://{rest}")
host = parsed.hostname or "localhost"
port = parsed.port or 5432
print(f"{host} {port}")
PY
)
local check_cmd
check_cmd='import socket,sys; socket.create_connection((sys.argv[1], int(sys.argv[2])), timeout=1).close()'
if python3 -c "$check_cmd" "$DB_HOST" "$DB_PORT" >/dev/null 2>&1; then
echo "Database preflight: reachable at ${DB_HOST}:${DB_PORT}."
return
fi
echo "Database preflight: cannot connect to ${DB_HOST}:${DB_PORT}."
# For local development defaults, attempt to auto-start bundled PostgreSQL.
if [ "$DB_HOST" = "localhost" ] && [ "$DB_PORT" = "5432" ] && command -v docker >/dev/null 2>&1; then
if [ -f "docker-compose.yml" ]; then
echo "Attempting to start local PostgreSQL via docker compose (service: db)..."
docker compose up -d db || true
fi
fi
for _ in {1..20}; do
if python3 -c "$check_cmd" "$DB_HOST" "$DB_PORT" >/dev/null 2>&1; then
echo "Database preflight: reachable at ${DB_HOST}:${DB_PORT}."
return
fi
sleep 1
done
echo "Error: PostgreSQL is unavailable at ${DB_HOST}:${DB_PORT}."
echo "Run: docker compose up -d db"
echo "Or set DATABASE_URL/POSTGRES_URL to a reachable database."
exit 1
}
check_database
# Backend dependency management
setup_backend() {
if [ "$SKIP_INSTALL" = true ]; then
echo "Skipping backend installation..."
return
fi
echo "Setting up backend..."
cd backend
if [ ! -d ".venv" ]; then
echo "Creating virtual environment..."
python3 -m venv .venv
fi
source .venv/bin/activate
if [ -f "requirements.txt" ]; then
echo "Installing backend dependencies..."
pip install -r requirements.txt
else
echo "Warning: backend/requirements.txt not found."
fi
cd ..
}
# Frontend dependency management
setup_frontend() {
if [ "$SKIP_INSTALL" = true ]; then
echo "Skipping frontend installation..."
return
fi
echo "Setting up frontend..."
cd frontend
if [ ! -d "node_modules" ]; then
echo "Installing frontend dependencies..."
npm install
else
echo "frontend/node_modules already exists. Skipping npm install."
fi
cd ..
}
setup_backend
setup_frontend
# Cleanup function for graceful shutdown
cleanup() {
echo ""
echo "Stopping services..."
# Phase 1: kill by tracked PID (process substitution ensures correct PID capture)
if [ -n "$BACKEND_PID" ]; then
kill -TERM $BACKEND_PID 2>/dev/null || true
fi
if [ -n "$FRONTEND_PID" ]; then
kill -TERM $FRONTEND_PID 2>/dev/null || true
fi
if [ -n "$AGENT_PID" ]; then
kill -TERM $AGENT_PID 2>/dev/null || true
fi
# Phase 2: wait for graceful exit (up to 2s), then force kill
sleep 1
if [ -n "$BACKEND_PID" ]; then
kill -KILL $BACKEND_PID 2>/dev/null || true
fi
if [ -n "$FRONTEND_PID" ]; then
kill -KILL $FRONTEND_PID 2>/dev/null || true
fi
if [ -n "$AGENT_PID" ]; then
kill -KILL $AGENT_PID 2>/dev/null || true
fi
# Phase 3: fuser fallback — kill anything still on our ports (belt-and-suspenders)
if command -v fuser &>/dev/null; then
fuser -k ${AGENT_PORT}/tcp 2>/dev/null || true
fuser -k ${BACKEND_PORT}/tcp 2>/dev/null || true
fuser -k ${FRONTEND_PORT}/tcp 2>/dev/null || true
fi
echo "Services stopped."
exit 0
}
# Trap SIGINT (Ctrl+C), SIGTERM (kill), and SIGHUP (terminal close)
trap cleanup SIGINT SIGTERM SIGHUP
# Start Backend
start_backend() {
echo -e "\033[0;34m[Backend]\033[0m Starting on port $BACKEND_PORT..."
cd backend
local -a uvicorn_env_args=()
if [ -f ".venv/bin/activate" ]; then
source .venv/bin/activate
else
echo -e "\033[0;31m[Backend]\033[0m Warning: .venv/bin/activate not found. Attempting to run without venv."
fi
if [ -f ".env" ]; then
uvicorn_env_args=(--env-file .env)
# Also export .env vars so Python's os.environ sees them before app.py imports.
# uvicorn --env-file only affects uvicorn's own config, not the application.
# Guard DEV_MODE from .env override — run.sh DEV_MODE must take precedence.
local _saved_dev_mode="$DEV_MODE"
set -a
# shellcheck disable=SC1091
. .env
set +a
DEV_MODE="${_saved_dev_mode:-$DEV_MODE}"
fi
# PYTHONUNBUFFERED=1 prevents stderr buffering when piped through awk.
# awk with fflush() handles child-process stderr correctly (unlike sed),
# making --reload safe in DEV_MODE.
local -a reload_args=()
if [ "$DEV_MODE" = "true" ]; then
reload_args=(--reload --reload-dir src)
echo -e "\033[0;34m[Backend]\033[0m Hot-reload enabled (watching src/)"
fi
local _color=$'\033[0;34m[Backend]\033[0m '
PYTHONUNBUFFERED=1 python3 -m uvicorn src.app:app --port "$BACKEND_PORT" \
"${uvicorn_env_args[@]}" "${reload_args[@]}" \
> >(awk -v prefix="$_color " '{print prefix $0; fflush()}') 2>&1 &
BACKEND_PID=$!
cd ..
}
# Start Frontend
start_frontend() {
echo -e "\033[0;32m[Frontend]\033[0m Starting on port $FRONTEND_PORT..."
cd frontend
local _color=$'\033[0;32m[Frontend]\033[0m '
BACKEND_URL="http://127.0.0.1:${BACKEND_PORT}" \
GRADIO_URL="http://127.0.0.1:${AGENT_PORT}" \
npm run dev -- --port "$FRONTEND_PORT" \
> >(awk -v prefix="$_color " '{print prefix $0; fflush()}') 2>&1 &
FRONTEND_PID=$!
cd ..
}
# Start Gradio Agent
start_agent() {
echo -e "\033[0;35m[Agent]\033[0m Starting Gradio agent on port $AGENT_PORT..."
echo -e "\033[0;35m[Agent]\033[0m LLM config will be fetched from FastAPI /api/agent/llm-config at startup."
echo -e "\033[0;35m[Agent]\033[0m Configure LLM providers in Admin → LLM Settings."
cd backend
if [ -f ".venv/bin/activate" ]; then
source .venv/bin/activate
fi
if [ -f ".env" ]; then
local _saved_dev_mode="$DEV_MODE"
set -a
# shellcheck disable=SC1091
. .env
set +a
DEV_MODE="${_saved_dev_mode:-$DEV_MODE}"
fi
local _color=$'\033[0;35m[Agent]\033[0m '
export GRADIO_SERVER_PORT="$AGENT_PORT"
export GRADIO_ALLOW_PORT_FALLBACK="${GRADIO_ALLOW_PORT_FALLBACK:-false}"
export AGENT_CONFIRM_TOOLS="${AGENT_CONFIRM_TOOLS:-true}"
if [ "$DEV_MODE" = "true" ]; then
echo -e "\033[0;35m[Agent]\033[0m Hot-reload enabled via watchfiles (watching src/agent/)"
PYTHONUNBUFFERED=1 python3 -m watchfiles --filter python \
"python -m src.agent.run" src/agent \
> >(awk -v prefix="$_color " '{print prefix $0; fflush()}') 2>&1 &
else
PYTHONUNBUFFERED=1 python3 -m src.agent.run \
> >(awk -v prefix="$_color " '{print prefix $0; fflush()}') 2>&1 &
fi
AGENT_PID=$!
cd ..
}
start_backend
start_frontend
start_agent
echo "Services are running. Press Ctrl+C to stop."
wait
# [/DEF:run:Module]