mirror of
https://github.com/storytold/artcraft.git
synced 2026-11-16 14:52:31 +00:00
Dev infra: fresh-clone bootstrap for the fully-local dev stack (backend + webapp)
Adds script/bootstrap/ — idempotent Ubuntu 22.04+/WSL2/CI automation that takes a fresh clone to a running local stack with zero production traffic: - bootstrap_dev_stack.sh: apt packages, MySQL 8 + Redis up, storyteller DB/user, 281 diesel migrations, idempotent role/badge seeds, generated dummy development-secrets.env (19 required-at-boot vars no checked-in config supplies), SQLX_OFFLINE backend build, frontend npm install - run_backend_dev.sh / seed_demo_user.sh: run the API from the repo root and create+verify a demo login through the real POST /v1/create_account path - dev_stack_doctor.sh: PASS/WARN/FAIL diagnosis of every prerequisite _docs/dev_setup_local_stack.md records the requirements the scripts encode and corrects stale claims (server reads MYSQL_URL, not DATABASE_URL; repo-root .env is not loaded by the server; config precedence is first-value-wins; SQLX_OFFLINE is compile-time only). .gitattributes now forces LF for *.sh/*.env so Windows clones run under WSL2.
This commit is contained in:
1 parent
2d7bf65a23
commit
537409eb3e
7 files changed
+912
No files matched your search
Executable
+354
@@ -0,0 +1,354 @@
|
||||
#!/usr/bin/env bash
|
||||
# Bootstrap the full local dev stack (backend + frontend) on a fresh clone.
|
||||
#
|
||||
# Target platform: Ubuntu 22.04+ — native, WSL2, or a CI runner/container.
|
||||
# (macOS users: follow _docs/dev_setup_server.md manually; Windows users: run
|
||||
# this inside WSL2. See _docs/dev_setup_local_stack.md.)
|
||||
#
|
||||
# Idempotent: safe to re-run at any time; each step detects work already done.
|
||||
#
|
||||
# Usage:
|
||||
# ./script/bootstrap/bootstrap_dev_stack.sh [options]
|
||||
#
|
||||
# Options:
|
||||
# --yes, -y Non-interactive: assume "yes" for prompts (CI mode)
|
||||
# --skip-packages Don't apt-install system packages
|
||||
# --skip-rust-build Don't build the storyteller-web binary
|
||||
# --skip-frontend Don't run the frontend npm install
|
||||
#
|
||||
# After it succeeds:
|
||||
# ./script/bootstrap/run_backend_dev.sh # start the API on :12345
|
||||
# ./script/bootstrap/seed_demo_user.sh # create the demo login
|
||||
# cd frontend && npx nx dev artcraft-webapp # webapp on :4201
|
||||
set -euo pipefail
|
||||
|
||||
root_dir="$(cd "$(dirname "${BASH_SOURCE[0]}")/../.." && pwd)"
|
||||
source "${root_dir}/script/bootstrap/common.sh"
|
||||
|
||||
SECRETS_ENV_FILE="${root_dir}/crates/service/web/storyteller_web/config/storyteller-web.development-secrets.env"
|
||||
|
||||
# System packages: MySQL + Redis servers, the native libs needed to compile the
|
||||
# Rust workspace (per build/service_cpu.Dockerfile) and diesel_cli
|
||||
# (libmysqlclient-dev, libsqlite3-dev), plus curl/jq for the seeding scripts.
|
||||
SYSTEM_PACKAGES=(
|
||||
build-essential
|
||||
ca-certificates
|
||||
cmake
|
||||
curl
|
||||
ffmpeg
|
||||
fontconfig
|
||||
git
|
||||
jq
|
||||
libclang-dev
|
||||
libfontconfig1-dev
|
||||
libmysqlclient-dev
|
||||
libsqlite3-dev
|
||||
libssl-dev
|
||||
mysql-server
|
||||
perl
|
||||
pkg-config
|
||||
redis-server
|
||||
)
|
||||
|
||||
ASSUME_YES=false
|
||||
SKIP_PACKAGES=false
|
||||
SKIP_RUST_BUILD=false
|
||||
SKIP_FRONTEND=false
|
||||
|
||||
main() {
|
||||
parse_args "$@"
|
||||
ensure_supported_platform
|
||||
|
||||
install_system_packages
|
||||
ensure_mysql_running
|
||||
provision_mysql_database
|
||||
ensure_redis_running
|
||||
ensure_rust_toolchain
|
||||
ensure_diesel_cli
|
||||
run_migrations
|
||||
seed_roles_and_badges
|
||||
write_secrets_env_if_missing
|
||||
build_backend
|
||||
setup_frontend
|
||||
|
||||
print_next_steps
|
||||
}
|
||||
|
||||
parse_args() {
|
||||
for arg in "$@"; do
|
||||
case "${arg}" in
|
||||
--yes|-y) ASSUME_YES=true ;;
|
||||
--skip-packages) SKIP_PACKAGES=true ;;
|
||||
--skip-rust-build) SKIP_RUST_BUILD=true ;;
|
||||
--skip-frontend) SKIP_FRONTEND=true ;;
|
||||
--help|-h) sed -n '2,22p' "${BASH_SOURCE[0]}" | sed 's/^# \{0,1\}//'; exit 0 ;;
|
||||
*) die "Unknown option: ${arg} (try --help)" ;;
|
||||
esac
|
||||
done
|
||||
}
|
||||
|
||||
ensure_supported_platform() {
|
||||
case "$(uname -s)" in
|
||||
Linux) ;;
|
||||
Darwin)
|
||||
die "This script targets Ubuntu/WSL2. On macOS, follow _docs/dev_setup_server.md."
|
||||
;;
|
||||
*)
|
||||
die "Unsupported platform '$(uname -s)'. Run inside WSL2 Ubuntu (wsl --install -d Ubuntu-22.04)."
|
||||
;;
|
||||
esac
|
||||
|
||||
if grep -qi microsoft /proc/version 2>/dev/null && [[ "${root_dir}" == /mnt/* ]]; then
|
||||
warn "This checkout lives on the Windows filesystem (${root_dir})."
|
||||
warn "Rust + npm builds are dramatically slower through /mnt. Consider cloning"
|
||||
warn "into the WSL filesystem (e.g. ~/storyteller-rust) instead."
|
||||
fi
|
||||
}
|
||||
|
||||
install_system_packages() {
|
||||
step "System packages"
|
||||
if [ "${SKIP_PACKAGES}" = "true" ]; then
|
||||
log "Skipped (--skip-packages)."
|
||||
return
|
||||
fi
|
||||
|
||||
local missing=()
|
||||
for pkg in "${SYSTEM_PACKAGES[@]}"; do
|
||||
dpkg -s "${pkg}" >/dev/null 2>&1 || missing+=("${pkg}")
|
||||
done
|
||||
|
||||
if [ "${#missing[@]}" -eq 0 ]; then
|
||||
log "All required apt packages are already installed."
|
||||
return
|
||||
fi
|
||||
|
||||
log "Missing packages: ${missing[*]}"
|
||||
confirm "Install them with apt-get?" || die "Cannot continue without system packages (or pass --skip-packages if you manage them yourself)."
|
||||
maybe_sudo env DEBIAN_FRONTEND=noninteractive apt-get update
|
||||
maybe_sudo env DEBIAN_FRONTEND=noninteractive apt-get install -y "${missing[@]}"
|
||||
}
|
||||
|
||||
ensure_mysql_running() {
|
||||
step "MySQL server"
|
||||
if mysqladmin ping --silent 2>/dev/null; then
|
||||
log "MySQL is running."
|
||||
else
|
||||
log "Starting MySQL..."
|
||||
maybe_sudo service mysql start 2>/dev/null \
|
||||
|| maybe_sudo systemctl start mysql 2>/dev/null \
|
||||
|| die "Could not start MySQL (tried 'service mysql start' and 'systemctl start mysql')."
|
||||
mysqladmin ping --silent 2>/dev/null || sleep 3
|
||||
mysqladmin ping --silent 2>/dev/null || die "MySQL did not come up."
|
||||
fi
|
||||
|
||||
# The tooling supports the MySQL 8.x series; 9.x is known-unsupported
|
||||
# (_docs/dev_setup_server.md).
|
||||
local version
|
||||
version="$(mysqld --version 2>/dev/null || true)"
|
||||
case "${version}" in
|
||||
*" 8."*) ;;
|
||||
"") warn "Could not determine MySQL server version." ;;
|
||||
*) warn "MySQL 8.x is expected; found: ${version}" ;;
|
||||
esac
|
||||
}
|
||||
|
||||
provision_mysql_database() {
|
||||
step "MySQL database + user (${DEV_MYSQL_DB} / ${DEV_MYSQL_USER}@localhost)"
|
||||
if mysql_app_reachable; then
|
||||
log "Database and app user already provisioned."
|
||||
return
|
||||
fi
|
||||
|
||||
# Same DDL as _docs/dev_setup_server.md, made idempotent.
|
||||
mysql_admin <<SQL
|
||||
CREATE DATABASE IF NOT EXISTS ${DEV_MYSQL_DB};
|
||||
CREATE USER IF NOT EXISTS '${DEV_MYSQL_USER}'@'localhost' IDENTIFIED BY '${DEV_MYSQL_PASSWORD}';
|
||||
GRANT ALL PRIVILEGES ON ${DEV_MYSQL_DB}.* TO '${DEV_MYSQL_USER}'@'localhost';
|
||||
FLUSH PRIVILEGES;
|
||||
SQL
|
||||
|
||||
mysql_app_reachable || die "Provisioning ran but '${DEV_MYSQL_USER}' still cannot reach '${DEV_MYSQL_DB}'."
|
||||
log "Provisioned."
|
||||
}
|
||||
|
||||
ensure_redis_running() {
|
||||
step "Redis server"
|
||||
if redis_reachable; then
|
||||
log "Redis is running."
|
||||
return
|
||||
fi
|
||||
log "Starting Redis..."
|
||||
maybe_sudo service redis-server start 2>/dev/null \
|
||||
|| maybe_sudo systemctl start redis-server 2>/dev/null \
|
||||
|| die "Could not start Redis."
|
||||
redis_reachable || die "Redis did not come up."
|
||||
}
|
||||
|
||||
ensure_rust_toolchain() {
|
||||
step "Rust toolchain"
|
||||
ensure_cargo_on_path
|
||||
if command -v cargo >/dev/null 2>&1; then
|
||||
log "Found $(rustc --version 2>/dev/null || echo 'cargo (rustc missing?)')."
|
||||
return
|
||||
fi
|
||||
confirm "Rust is not installed. Install stable via rustup?" || die "Rust is required to build the backend."
|
||||
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y --default-toolchain stable
|
||||
ensure_cargo_on_path
|
||||
command -v cargo >/dev/null 2>&1 || die "rustup install finished but cargo is not on PATH."
|
||||
}
|
||||
|
||||
ensure_diesel_cli() {
|
||||
step "diesel_cli (migration runner)"
|
||||
if command -v diesel >/dev/null 2>&1; then
|
||||
log "Found $(diesel --version)."
|
||||
return
|
||||
fi
|
||||
# Same install command as _docs/dev_setup_server.md. Needs libmysqlclient-dev
|
||||
# and libsqlite3-dev (installed above).
|
||||
log "Installing diesel_cli (this compiles from source; a few minutes)..."
|
||||
cargo install diesel_cli --no-default-features --features mysql,sqlite
|
||||
}
|
||||
|
||||
run_migrations() {
|
||||
step "Database migrations (_database/sql/migrations)"
|
||||
# diesel-cli reads DATABASE_URL; the repo-root .env provides it, but export a
|
||||
# default so this also works if that file is ever absent (e.g. sparse CI).
|
||||
export DATABASE_URL="${DATABASE_URL:-mysql://${DEV_MYSQL_USER}:${DEV_MYSQL_PASSWORD}@${DEV_MYSQL_HOST}/${DEV_MYSQL_DB}}"
|
||||
cd "${root_dir}"
|
||||
# NB: "Encountered unknown type for Mysql: enum" warnings are harmless
|
||||
# (_docs/dev_setup_server.md).
|
||||
diesel migration run
|
||||
log "Migrations up to date."
|
||||
}
|
||||
|
||||
seed_roles_and_badges() {
|
||||
step "Seed data (system roles + badges)"
|
||||
# Same data as _database/sql/seed/bootstrap_inserts_roles_etc.sh, but guarded
|
||||
# so re-runs don't hit duplicate-key errors. The 'user' role is mandatory:
|
||||
# account creation hardcodes user_role_slug='user'.
|
||||
local role_count badge_count
|
||||
role_count="$(mysql_app -N -e "SELECT COUNT(*) FROM user_roles" 2>/dev/null || echo 0)"
|
||||
if [ "${role_count}" -gt 0 ]; then
|
||||
log "user_roles already seeded (${role_count} rows)."
|
||||
else
|
||||
mysql_app < "${root_dir}/_database/sql/seed/sql/system_roles.sql"
|
||||
log "Inserted system roles (user, mod, admin)."
|
||||
fi
|
||||
|
||||
badge_count="$(mysql_app -N -e "SELECT COUNT(*) FROM badges" 2>/dev/null || echo 0)"
|
||||
if [ "${badge_count}" -gt 0 ]; then
|
||||
log "badges already seeded (${badge_count} rows)."
|
||||
else
|
||||
mysql_app < "${root_dir}/_database/sql/seed/sql/user_badges.sql"
|
||||
log "Inserted badges."
|
||||
fi
|
||||
}
|
||||
|
||||
write_secrets_env_if_missing() {
|
||||
step "Development secrets file"
|
||||
if [ -f "${SECRETS_ENV_FILE}" ]; then
|
||||
log "Already exists: ${SECRETS_ENV_FILE} (leaving it untouched)."
|
||||
return
|
||||
fi
|
||||
|
||||
# Every env var below is read with get_env_string_required at server startup
|
||||
# (build_dependencies.rs / setup_inference_providers.rs / setup_stripe_*.rs)
|
||||
# but is NOT supplied by the checked-in config files. None of them is
|
||||
# contacted at boot — placeholder values are enough to run the server; the
|
||||
# endpoints that would use them fail lazily if exercised. Generation is still
|
||||
# safe: providers are only contacted by the separate job worker binaries,
|
||||
# which local dev does not run.
|
||||
#
|
||||
# NOTE: config loading is FIRST-VALUE-WINS (dotenv never overrides an
|
||||
# already-set key), so values here cannot override anything already set in
|
||||
# storyteller-web.development.env — only real process env vars can.
|
||||
cat > "${SECRETS_ENV_FILE}" <<'EOF'
|
||||
# Local-development secrets for storyteller-web. Generated by
|
||||
# script/bootstrap/bootstrap_dev_stack.sh — gitignored; edit freely.
|
||||
#
|
||||
# Placeholders below satisfy required-at-boot checks without enabling any
|
||||
# external integration. Replace individual values with real dev credentials
|
||||
# only if you need that specific integration locally.
|
||||
|
||||
# R2/S3 object storage (clients are constructed offline)
|
||||
ACCESS_KEY=dummy-local-dev
|
||||
SECRET_KEY=dummy-local-dev
|
||||
REGION_NAME=us-east-1
|
||||
W2L_PRIVATE_DOWNLOAD_BUCKET_NAME=dummy-local-dev-private
|
||||
W2L_PUBLIC_DOWNLOAD_BUCKET_NAME=dummy-local-dev-public
|
||||
|
||||
# Email (Resend)
|
||||
RESEND_API_KEY=dummy-local-dev
|
||||
|
||||
# Generation providers (only job workers ever contact these; workers are not
|
||||
# run in local dev, so enqueued jobs simply stay pending)
|
||||
FAL_API_KEY=dummy-local-dev
|
||||
GMICLOUD_API_KEY=dummy-local-dev
|
||||
GROK_API_KEY=dummy-local-dev
|
||||
BEEBLE_API_KEY=dummy-local-dev
|
||||
OPENAI_API_KEY=dummy-local-dev
|
||||
WORLDLABS_API_KEY=dummy-local-dev
|
||||
SEEDANCE2PRO_COOKIES=dummy-local-dev
|
||||
SEEDANCE2PRO_WHITELIST_COOKIES=dummy-local-dev
|
||||
SEEDANCE2PRO_BYTEPLUS_ULTRA_COOKIES=dummy-local-dev
|
||||
|
||||
# Stripe account ids (test-mode secret keys are already checked into
|
||||
# storyteller-web.development.env; only the account ids are missing there)
|
||||
STRIPE_FAKEYOU_ACCOUNT_ID=acct_dummylocaldev
|
||||
STRIPE_ARTCRAFT_ACCOUNT_ID=acct_dummylocaldev
|
||||
STRIPE_ARTCRAFT_SECRET_KEY=sk_test_dummylocaldev
|
||||
STRIPE_ARTCRAFT_SECRET_WEBHOOK_KEY=whsec_dummylocaldev
|
||||
EOF
|
||||
log "Wrote ${SECRETS_ENV_FILE}"
|
||||
}
|
||||
|
||||
build_backend() {
|
||||
step "Backend build (storyteller-web)"
|
||||
if [ "${SKIP_RUST_BUILD}" = "true" ]; then
|
||||
log "Skipped (--skip-rust-build)."
|
||||
return
|
||||
fi
|
||||
cd "${root_dir}"
|
||||
# SQLX_OFFLINE only affects compile-time query verification (uses the
|
||||
# checked-in .sqlx/ cache instead of a live DB); it has no runtime effect.
|
||||
log "Building (first build takes several minutes)..."
|
||||
SQLX_OFFLINE=true cargo build -p storyteller-web --bin storyteller-web
|
||||
log "Built target/debug/storyteller-web."
|
||||
}
|
||||
|
||||
setup_frontend() {
|
||||
step "Frontend install (frontend/)"
|
||||
if [ "${SKIP_FRONTEND}" = "true" ]; then
|
||||
log "Skipped (--skip-frontend)."
|
||||
return
|
||||
fi
|
||||
source "${root_dir}/script/common/frontend_preflight.sh"
|
||||
frontend_preflight "${root_dir}/frontend"
|
||||
pushd "${root_dir}/frontend" >/dev/null
|
||||
frontend_npm_install
|
||||
popd >/dev/null
|
||||
log "Frontend dependencies installed."
|
||||
}
|
||||
|
||||
print_next_steps() {
|
||||
step "Done"
|
||||
cat <<EOF
|
||||
The dev stack is bootstrapped. Next steps:
|
||||
|
||||
1. Start the backend (binds ${DEV_BACKEND_URL}):
|
||||
./script/bootstrap/run_backend_dev.sh
|
||||
|
||||
2. In another terminal, create the demo login (idempotent):
|
||||
./script/bootstrap/seed_demo_user.sh
|
||||
Credentials: ${DEMO_USERNAME} / ${DEMO_PASSWORD}
|
||||
|
||||
3. Start the webapp (binds http://localhost:4201; in dev it talks to
|
||||
${DEV_BACKEND_URL} automatically):
|
||||
cd frontend && npx nx dev artcraft-webapp
|
||||
|
||||
Health checks at any time:
|
||||
./script/bootstrap/dev_stack_doctor.sh
|
||||
EOF
|
||||
}
|
||||
|
||||
main "$@"
|
||||
Executable
+95
@@ -0,0 +1,95 @@
|
||||
#!/usr/bin/env bash
|
||||
# Shared helpers for the dev-stack bootstrap scripts.
|
||||
#
|
||||
# Usage (from a script that has set ${root_dir}):
|
||||
#
|
||||
# source "${root_dir}/script/bootstrap/common.sh"
|
||||
#
|
||||
# See _docs/dev_setup_local_stack.md for the full picture.
|
||||
|
||||
# Canonical local-dev database identity. These match _docs/dev_setup_server.md,
|
||||
# the diesel DATABASE_URL in the repo-root .env, and the server's MYSQL_URL
|
||||
# default (crates/schema/config/shared_env_var_config/src/mysql.rs). Override
|
||||
# via environment only if your local MySQL differs — most tooling assumes them.
|
||||
DEV_MYSQL_DB="${DEV_MYSQL_DB:-storyteller}"
|
||||
DEV_MYSQL_USER="${DEV_MYSQL_USER:-storyteller}"
|
||||
DEV_MYSQL_PASSWORD="${DEV_MYSQL_PASSWORD:-password}"
|
||||
DEV_MYSQL_HOST="${DEV_MYSQL_HOST:-localhost}"
|
||||
|
||||
# Where the backend listens (BIND_ADDRESS default in
|
||||
# storyteller_web/src/startup/build_dependencies.rs).
|
||||
DEV_BACKEND_URL="${DEV_BACKEND_URL:-http://localhost:12345}"
|
||||
|
||||
# Default demo account. The username must NOT be on the reserved-usernames list
|
||||
# (includes/binary_includes/usernames/reserved_usernames.txt — "demo", "admin",
|
||||
# "test", and "dev" are all reserved) and must match ^[A-Za-z0-9_\-]{3,16}$.
|
||||
DEMO_USERNAME="${DEMO_USERNAME:-localdev1}"
|
||||
DEMO_PASSWORD="${DEMO_PASSWORD:-localdev1pass}"
|
||||
DEMO_EMAIL="${DEMO_EMAIL:-localdev1@example.com}"
|
||||
|
||||
log() { echo "[bootstrap] $*"; }
|
||||
warn() { echo "[bootstrap] WARNING: $*" >&2; }
|
||||
die() { echo "[bootstrap] ERROR: $*" >&2; exit 1; }
|
||||
|
||||
step() {
|
||||
echo ""
|
||||
echo "=== $* ==="
|
||||
}
|
||||
|
||||
# sudo unless we already are root (CI containers often run as root without sudo).
|
||||
maybe_sudo() {
|
||||
if [ "$(id -u)" -eq 0 ]; then
|
||||
"$@"
|
||||
else
|
||||
sudo "$@"
|
||||
fi
|
||||
}
|
||||
|
||||
confirm() {
|
||||
local prompt="$1"
|
||||
if [ "${ASSUME_YES:-false}" = "true" ]; then
|
||||
return 0
|
||||
fi
|
||||
local reply
|
||||
read -r -p "${prompt} [y/N] " reply
|
||||
[[ "${reply}" =~ ^[Yy] ]]
|
||||
}
|
||||
|
||||
# Run a statement (or stdin) as the storyteller app user against the dev DB.
|
||||
# MYSQL_PWD keeps the password off the process list.
|
||||
mysql_app() {
|
||||
MYSQL_PWD="${DEV_MYSQL_PASSWORD}" mysql \
|
||||
-u "${DEV_MYSQL_USER}" -h "${DEV_MYSQL_HOST}" -D "${DEV_MYSQL_DB}" "$@"
|
||||
}
|
||||
|
||||
# Run a statement as an administrator, for provisioning the DB and user.
|
||||
# On a fresh Ubuntu/WSL install, root uses auth_socket, so `sudo mysql` works.
|
||||
# On GitHub Actions runners the preinstalled MySQL root password is "root" —
|
||||
# export MYSQL_ROOT_PASSWORD to use password auth instead.
|
||||
mysql_admin() {
|
||||
if [ -n "${MYSQL_ROOT_PASSWORD:-}" ]; then
|
||||
MYSQL_PWD="${MYSQL_ROOT_PASSWORD}" mysql -u root -h "${DEV_MYSQL_HOST}" "$@"
|
||||
else
|
||||
maybe_sudo mysql "$@"
|
||||
fi
|
||||
}
|
||||
|
||||
mysql_app_reachable() {
|
||||
mysql_app -e "SELECT 1" >/dev/null 2>&1
|
||||
}
|
||||
|
||||
redis_reachable() {
|
||||
redis-cli ping 2>/dev/null | grep -q PONG
|
||||
}
|
||||
|
||||
backend_reachable() {
|
||||
curl -sf -o /dev/null --max-time 3 "${DEV_BACKEND_URL}/_status"
|
||||
}
|
||||
|
||||
# Make ~/.cargo/bin visible when rustup was installed but the shell profile
|
||||
# hasn't been re-sourced (fresh installs, CI).
|
||||
ensure_cargo_on_path() {
|
||||
if ! command -v cargo >/dev/null 2>&1 && [ -x "${HOME}/.cargo/bin/cargo" ]; then
|
||||
export PATH="${HOME}/.cargo/bin:${PATH}"
|
||||
fi
|
||||
}
|
||||
Executable
+136
@@ -0,0 +1,136 @@
|
||||
#!/usr/bin/env bash
|
||||
# Diagnose the local dev stack: checks every prerequisite the bootstrap sets up
|
||||
# and reports PASS / WARN / FAIL per item.
|
||||
#
|
||||
# FAIL = the stack cannot work until fixed (exit code 1).
|
||||
# WARN = optional or run-time-only (e.g. backend not currently running).
|
||||
set -uo pipefail
|
||||
|
||||
root_dir="$(cd "$(dirname "${BASH_SOURCE[0]}")/../.." && pwd)"
|
||||
source "${root_dir}/script/bootstrap/common.sh"
|
||||
|
||||
SECRETS_ENV_FILE="${root_dir}/crates/service/web/storyteller_web/config/storyteller-web.development-secrets.env"
|
||||
|
||||
failures=0
|
||||
warnings=0
|
||||
|
||||
pass() { printf ' PASS %s\n' "$1"; }
|
||||
fail() { printf ' FAIL %s\n' "$1"; failures=$((failures + 1)); }
|
||||
warn_check() { printf ' WARN %s\n' "$1"; warnings=$((warnings + 1)); }
|
||||
|
||||
echo "Dev stack doctor (${root_dir})"
|
||||
echo ""
|
||||
echo "--- Toolchains ---"
|
||||
|
||||
ensure_cargo_on_path
|
||||
if command -v cargo >/dev/null 2>&1; then
|
||||
pass "rust: $(rustc --version 2>/dev/null | head -1)"
|
||||
else
|
||||
fail "rust: cargo not on PATH (bootstrap installs via rustup)"
|
||||
fi
|
||||
|
||||
if command -v diesel >/dev/null 2>&1; then
|
||||
pass "diesel_cli: $(diesel --version 2>/dev/null | head -1)"
|
||||
else
|
||||
fail "diesel_cli: not installed (cargo install diesel_cli --no-default-features --features mysql,sqlite)"
|
||||
fi
|
||||
|
||||
if command -v node >/dev/null 2>&1; then
|
||||
node_major="$(node --version | sed -E 's/^v([0-9]+).*/\1/')"
|
||||
if [ "${node_major}" -ge 20 ]; then
|
||||
pass "node: $(node --version) (>= 20 required by Nx 21 / Vite 6)"
|
||||
else
|
||||
fail "node: $(node --version) is too old — Node 20+ required"
|
||||
fi
|
||||
else
|
||||
fail "node: not installed (Node 20+ required for the frontend)"
|
||||
fi
|
||||
|
||||
echo ""
|
||||
echo "--- Services ---"
|
||||
|
||||
if mysql_app_reachable; then
|
||||
pass "mysql: reachable as '${DEV_MYSQL_USER}' on database '${DEV_MYSQL_DB}'"
|
||||
|
||||
migration_dirs="$(find "${root_dir}/_database/sql/migrations" -mindepth 1 -maxdepth 1 -type d | wc -l | tr -d ' ')"
|
||||
applied="$(mysql_app -N -e "SELECT COUNT(*) FROM __diesel_schema_migrations" 2>/dev/null || echo 0)"
|
||||
if [ "${applied}" -ge "${migration_dirs}" ] && [ "${applied}" -gt 0 ]; then
|
||||
pass "migrations: ${applied} applied (${migration_dirs} in _database/sql/migrations)"
|
||||
elif [ "${applied}" -gt 0 ]; then
|
||||
fail "migrations: only ${applied}/${migration_dirs} applied — run 'diesel migration run'"
|
||||
else
|
||||
fail "migrations: none applied — run 'diesel migration run'"
|
||||
fi
|
||||
|
||||
role_count="$(mysql_app -N -e "SELECT COUNT(*) FROM user_roles" 2>/dev/null || echo 0)"
|
||||
if [ "${role_count}" -ge 3 ]; then
|
||||
pass "seed: user_roles has ${role_count} rows (user/mod/admin present)"
|
||||
else
|
||||
fail "seed: user_roles has ${role_count} rows — account creation needs the 'user' role (re-run bootstrap)"
|
||||
fi
|
||||
|
||||
badge_count="$(mysql_app -N -e "SELECT COUNT(*) FROM badges" 2>/dev/null || echo 0)"
|
||||
if [ "${badge_count}" -gt 0 ]; then
|
||||
pass "seed: badges has ${badge_count} rows"
|
||||
else
|
||||
warn_check "seed: badges table is empty (cosmetic; re-run bootstrap to fill)"
|
||||
fi
|
||||
|
||||
demo_count="$(mysql_app -N -e "SELECT COUNT(*) FROM users WHERE username='${DEMO_USERNAME}'" 2>/dev/null || echo 0)"
|
||||
if [ "${demo_count}" -gt 0 ]; then
|
||||
pass "demo user: '${DEMO_USERNAME}' exists"
|
||||
else
|
||||
warn_check "demo user: '${DEMO_USERNAME}' not created yet (./script/bootstrap/seed_demo_user.sh, backend must be running)"
|
||||
fi
|
||||
else
|
||||
fail "mysql: cannot connect as '${DEV_MYSQL_USER}'@'${DEV_MYSQL_HOST}' to '${DEV_MYSQL_DB}' (is MySQL running? run bootstrap)"
|
||||
fi
|
||||
|
||||
if redis_reachable; then
|
||||
pass "redis: PONG"
|
||||
else
|
||||
fail "redis: not reachable on localhost (the backend's r2d2 pool connects eagerly at boot)"
|
||||
fi
|
||||
|
||||
echo ""
|
||||
echo "--- Backend ---"
|
||||
|
||||
if [ -f "${SECRETS_ENV_FILE}" ]; then
|
||||
pass "secrets env: ${SECRETS_ENV_FILE#"${root_dir}"/} exists"
|
||||
else
|
||||
fail "secrets env: missing — the server aborts at boot on ~19 required vars (re-run bootstrap)"
|
||||
fi
|
||||
|
||||
if [ -x "${root_dir}/target/debug/storyteller-web" ] || [ -x "${root_dir}/target/release/storyteller-web" ]; then
|
||||
pass "binary: storyteller-web is built"
|
||||
else
|
||||
warn_check "binary: storyteller-web not built yet (bootstrap builds it; cargo run will build on demand)"
|
||||
fi
|
||||
|
||||
if backend_reachable; then
|
||||
pass "server: ${DEV_BACKEND_URL}/_status responds"
|
||||
else
|
||||
warn_check "server: not running (./script/bootstrap/run_backend_dev.sh)"
|
||||
fi
|
||||
|
||||
echo ""
|
||||
echo "--- Frontend ---"
|
||||
|
||||
if [ -d "${root_dir}/frontend/node_modules" ]; then
|
||||
pass "frontend: node_modules present"
|
||||
else
|
||||
warn_check "frontend: node_modules missing (cd frontend && npm install)"
|
||||
fi
|
||||
|
||||
if [ -e "${root_dir}/frontend/pnpm-lock.yaml" ] || [ -d "${root_dir}/frontend/node_modules/.pnpm" ]; then
|
||||
fail "frontend: stale pnpm artifacts detected (see frontend/README.md — the workspace uses npm)"
|
||||
else
|
||||
pass "frontend: no stale pnpm artifacts"
|
||||
fi
|
||||
|
||||
echo ""
|
||||
echo "Summary: ${failures} failure(s), ${warnings} warning(s)."
|
||||
if [ "${failures}" -gt 0 ]; then
|
||||
echo "Fix failures with: ./script/bootstrap/bootstrap_dev_stack.sh (safe to re-run)"
|
||||
exit 1
|
||||
fi
|
||||
Executable
+26
@@ -0,0 +1,26 @@
|
||||
#!/usr/bin/env bash
|
||||
# Run the storyteller-web backend for local development (binds 0.0.0.0:12345).
|
||||
#
|
||||
# Must run from a bootstrapped environment (./script/bootstrap/bootstrap_dev_stack.sh).
|
||||
# Always runs from the repo root: the server's config search path
|
||||
# (crates/service/web/storyteller_web/config/*.env) and its includes/ defaults
|
||||
# are cwd-relative.
|
||||
set -euo pipefail
|
||||
|
||||
root_dir="$(cd "$(dirname "${BASH_SOURCE[0]}")/../.." && pwd)"
|
||||
source "${root_dir}/script/bootstrap/common.sh"
|
||||
|
||||
SECRETS_ENV_FILE="${root_dir}/crates/service/web/storyteller_web/config/storyteller-web.development-secrets.env"
|
||||
|
||||
mysql_app_reachable || die "MySQL is not reachable as '${DEV_MYSQL_USER}'. Run ./script/bootstrap/bootstrap_dev_stack.sh first."
|
||||
redis_reachable || die "Redis is not reachable. Run ./script/bootstrap/bootstrap_dev_stack.sh first."
|
||||
[ -f "${SECRETS_ENV_FILE}" ] || die "Missing ${SECRETS_ENV_FILE}. Run ./script/bootstrap/bootstrap_dev_stack.sh first."
|
||||
|
||||
ensure_cargo_on_path
|
||||
cd "${root_dir}"
|
||||
|
||||
# SERVER_ENVIRONMENT defaults to Development when unset (bootstrap.rs), and the
|
||||
# dev config files are picked up from the search path automatically.
|
||||
# SQLX_OFFLINE only affects compile-time query checking, never runtime.
|
||||
log "Starting storyteller-web on ${DEV_BACKEND_URL} (Ctrl-C to stop)..."
|
||||
exec env SQLX_OFFLINE=true cargo run -p storyteller-web --bin storyteller-web
|
||||
Executable
+83
@@ -0,0 +1,83 @@
|
||||
#!/usr/bin/env bash
|
||||
# Create (or verify) the local demo user via the running backend, then verify
|
||||
# that login works. Idempotent: an already-existing user is a success.
|
||||
#
|
||||
# Requires the backend to be up (./script/bootstrap/run_backend_dev.sh) — this
|
||||
# script waits up to --wait-seconds (default 60) for it.
|
||||
#
|
||||
# The account is created through POST /v1/create_account rather than raw SQL so
|
||||
# it exercises the real signup path (bcrypt hash, session, firehose row) and
|
||||
# stays correct if the users schema evolves.
|
||||
#
|
||||
# Override the credentials via DEMO_USERNAME / DEMO_PASSWORD / DEMO_EMAIL.
|
||||
# Username rules: 3-16 chars of [A-Za-z0-9_-], not on the reserved list
|
||||
# (includes/binary_includes/usernames/reserved_usernames.txt); password >= 6 chars.
|
||||
set -euo pipefail
|
||||
|
||||
root_dir="$(cd "$(dirname "${BASH_SOURCE[0]}")/../.." && pwd)"
|
||||
source "${root_dir}/script/bootstrap/common.sh"
|
||||
|
||||
WAIT_SECONDS=60
|
||||
for arg in "$@"; do
|
||||
case "${arg}" in
|
||||
--wait-seconds=*) WAIT_SECONDS="${arg#*=}" ;;
|
||||
--help|-h) sed -n '2,15p' "${BASH_SOURCE[0]}" | sed 's/^# \{0,1\}//'; exit 0 ;;
|
||||
*) die "Unknown option: ${arg} (try --help)" ;;
|
||||
esac
|
||||
done
|
||||
|
||||
command -v jq >/dev/null 2>&1 || die "jq is required (apt-get install jq)."
|
||||
|
||||
log "Waiting for backend at ${DEV_BACKEND_URL} (up to ${WAIT_SECONDS}s)..."
|
||||
deadline=$((SECONDS + WAIT_SECONDS))
|
||||
until backend_reachable; do
|
||||
if [ "${SECONDS}" -ge "${deadline}" ]; then
|
||||
die "Backend not reachable at ${DEV_BACKEND_URL}/_status. Start it with ./script/bootstrap/run_backend_dev.sh"
|
||||
fi
|
||||
sleep 2
|
||||
done
|
||||
log "Backend is up."
|
||||
|
||||
log "Creating account '${DEMO_USERNAME}'..."
|
||||
create_response="$(curl -sS -X POST "${DEV_BACKEND_URL}/v1/create_account" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d "$(jq -n \
|
||||
--arg u "${DEMO_USERNAME}" \
|
||||
--arg p "${DEMO_PASSWORD}" \
|
||||
--arg e "${DEMO_EMAIL}" \
|
||||
'{username: $u, password: $p, password_confirmation: $p, email_address: $e}')")"
|
||||
|
||||
if [ "$(echo "${create_response}" | jq -r '.success // false')" = "true" ]; then
|
||||
log "Account created."
|
||||
else
|
||||
error_code="$(echo "${create_response}" | jq -r '.error_code // .error_code_str // empty')"
|
||||
case "${error_code}" in
|
||||
*[Uu]sername[Tt]aken*|*[Ee]mail[Tt]aken*)
|
||||
log "Account already exists (${error_code}) — continuing."
|
||||
;;
|
||||
*)
|
||||
die "Account creation failed: ${create_response}"
|
||||
;;
|
||||
esac
|
||||
fi
|
||||
|
||||
log "Verifying login..."
|
||||
login_response="$(curl -sS -X POST "${DEV_BACKEND_URL}/v1/login" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d "$(jq -n \
|
||||
--arg u "${DEMO_USERNAME}" \
|
||||
--arg p "${DEMO_PASSWORD}" \
|
||||
'{username_or_email: $u, password: $p}')")"
|
||||
|
||||
if [ "$(echo "${login_response}" | jq -r '.success // false')" != "true" ]; then
|
||||
die "Login verification failed: ${login_response}"
|
||||
fi
|
||||
if [ -z "$(echo "${login_response}" | jq -r '.signed_session // empty')" ]; then
|
||||
die "Login succeeded but returned no signed_session: ${login_response}"
|
||||
fi
|
||||
|
||||
log "Demo user is ready."
|
||||
log " Username: ${DEMO_USERNAME}"
|
||||
log " Password: ${DEMO_PASSWORD}"
|
||||
log "Log in at the webapp /login page, or via curl:"
|
||||
log " curl -c /tmp/cookies.txt -X POST ${DEV_BACKEND_URL}/v1/login -H 'Content-Type: application/json' -d '{\"username_or_email\":\"${DEMO_USERNAME}\",\"password\":\"${DEMO_PASSWORD}\"}'"
|
||||
Reference in new issue
Block a user