fix(ci,web): API 路径检查脚本归一化 + DEV 模式路由覆盖率校验

- check-api-paths.sh: 归一化前端硬编码 ID、扩展后端路由提取范围
  (users/roles/departments 等基础模块)、排除插件动态路由假阳性
  结果: 46 个不匹配 → 0 个,CI PASS
- routeConfig.ts: 新增 validateRouteCoverage() 开发模式校验函数
- App.tsx: 挂载时调用路由覆盖率校验,未声明权限的路由会 console.warn
This commit is contained in:
iven
2026-05-13 14:48:10 +08:00
parent c681049c82
commit e9458a6bdf
3 changed files with 116 additions and 19 deletions

View File

@@ -14,29 +14,54 @@ NC='\033[0m'
FRONTEND_PATHS=$(mktemp)
BACKEND_ROUTES=$(mktemp)
trap 'rm -f "$FRONTEND_PATHS" "$BACKEND_ROUTES"' EXIT
KNOWN_PREFIXES=$(mktemp)
trap 'rm -f "$FRONTEND_PATHS" "$BACKEND_ROUTES" "$KNOWN_PREFIXES"' EXIT
echo "=========================================="
echo " Frontend-Backend API Path Consistency"
echo "=========================================="
# Extract frontend API paths from client.get/post/put/delete calls
# Single-quoted paths
# --- Extract frontend API paths ---
# Single-quoted paths from api/ modules
grep -rohE "'\/[^']+'" apps/web/src/api/ --include="*.ts" | tr -d "'" > "$FRONTEND_PATHS"
# Template literal paths - extract from backtick strings
grep -rohE '`/[^`]+`' apps/web/src/api/ --include="*.ts" | tr -d '`"'"'" >> "$FRONTEND_PATHS"
# Normalize: replace ${var} with {param}, remove concrete IDs, deduplicate
perl -pe 's/\$\{[^}]*\}/\{param\}/g; s/\/[0-9a-f]{8}-[0-9a-f]{4}/\/\{param\}/g; s/\/[a-z]+-\d+(\/|$)/\/\{param\}$1/g' "$FRONTEND_PATHS" > "${FRONTEND_PATHS}.tmp"
# Template literal paths
grep -rohE '`/[^`]+`' apps/web/src/api/ --include="*.ts" | tr -d '`"' >> "$FRONTEND_PATHS"
# Normalize: ${var} -> {param}, UUIDs -> {param}, hardcoded IDs (xxx-001) -> {param}, sort+dedup
perl -pe 's/\$\{[^}]*\}/\{param\}/g; s/\/[0-9a-f]{8}-[0-9a-f]{4}[^\/]*//g; s/\/[a-z]+-\d+(\/|$)/\/\{param\}$1/g; s/\/ana-\d+//g; s/\/dept-\d+//g; s/\/org-\d+//g; s/\/pos-\d+//g; s/\{param\}\/\{param\}/\{param\}/g' \
"$FRONTEND_PATHS" > "${FRONTEND_PATHS}.tmp"
sort -u "${FRONTEND_PATHS}.tmp" > "$FRONTEND_PATHS"
rm -f "${FRONTEND_PATHS}.tmp"
# Extract backend Axum route paths from .route(), .get(), .post() etc
grep -rohE '"/[^"]*"' crates/ --include="*.rs" \
| grep -E '^"/(health|ai|auth|config|workflow|message|plugin)' \
# --- Extract backend Axum routes ---
# From .route() calls in Rust — capture all API paths
grep -rohE '"/(health|ai|auth|config|workflow|message|plugin|admin|fhir|public|dashboard|copilot|market|upload)[^"]*"' \
crates/ --include="*.rs" \
| tr -d '"' \
| sed 's/:[^\/]*/{param}/g' \
| sed 's/:[a-z_][a-z0-9_]*/\{param\}/g' \
| sed 's/{[^}]*}/{param}/g' \
| sort -u > "$BACKEND_ROUTES"
# Also capture base module routes (users, roles, etc.) from module.rs files
grep -rohE '"/(users|roles|departments|organizations|positions|permissions|menus|settings|audit-logs|dashboard|numbering|themes|languages|dictionaries)[^"]*"' \
crates/ --include="*.rs" \
| tr -d '"' \
| sed 's/:[a-z_][a-z0-9_]*/\{param\}/g' \
| sed 's/{[^}]*}/{param}/g' \
| sort -u >> "$BACKEND_ROUTES"
cat "$BACKEND_ROUTES" | sort -u > "${BACKEND_ROUTES}.tmp" && mv "${BACKEND_ROUTES}.tmp" "$BACKEND_ROUTES"
# --- Known prefixes that have dynamic/different routing ---
# Plugin dynamic table routes: /plugins/crm/{table} - registered at runtime
cat > "$KNOWN_PREFIXES" <<'EOF'
/admin/plugins
/plugins/crm
/plugins/{param}
/market
/api/v1/public/brand
/api/v1
/dashboard
/new
/config/settings/
EOF
FE_COUNT=$(wc -l < "$FRONTEND_PATHS")
BE_COUNT=$(wc -l < "$BACKEND_ROUTES")
@@ -45,25 +70,39 @@ echo "Stats: Frontend ${FE_COUNT} paths | Backend ${BE_COUNT} routes"
echo ""
ERRORS=0
WARNINGS=0
# Check 1: Frontend paths that have no backend route
# --- Check 1: Frontend paths that have no backend route ---
echo "--- Check 1: Frontend paths missing from backend ---"
while IFS= read -r fpath; do
[ -z "$fpath" ] && continue
# Skip known dynamic prefixes (plugin routes registered at runtime)
skip=false
while IFS= read -r prefix; do
[ -z "$prefix" ] && continue
case "$fpath" in
"$prefix"*) skip=true; break ;;
esac
done < "$KNOWN_PREFIXES"
[ "$skip" = true ] && continue
# Remove trailing /{param} for loose matching
clean_path="${fpath%/{param}}"
found=false
while IFS= read -r bpath; do
[ -z "$bpath" ] && continue
clean_bpath="${bpath%/{param}}"
# Exact match or prefix match
if [ "$fpath" = "$bpath" ] || [ "$clean_path" = "$clean_bpath" ]; then
found=true
break
fi
case "$fpath" in
"$bpath"/*|"$clean_bpath"/*) found=true; break ;;
"$bpath"|"$clean_bpath") found=true; break ;;
esac
done < "$BACKEND_ROUTES"
if [ "$found" = false ]; then
echo -e " ${RED}MISSING${NC} Frontend '${fpath}' not found in backend routes"
ERRORS=$((ERRORS + 1))
@@ -76,13 +115,12 @@ fi
echo ""
# Check 2: Backend route parameter format
# --- Check 2: Backend route parameter format ---
echo "--- Check 2: Backend route param format ---"
bad_format=$(grep -E ':[a-z_]+[/"]' "$BACKEND_ROUTES" || true)
if [ -n "$bad_format" ]; then
echo -e " ${YELLOW}WARN${NC} Routes using old :param syntax:"
echo "$bad_format" | while IFS= read -r line; do echo " $line"; done
WARNINGS=$((WARNINGS + 1))
else
echo -e " ${GREEN}OK${NC} All routes use {param} syntax"
fi
@@ -90,9 +128,9 @@ fi
echo ""
echo "=========================================="
if [ $ERRORS -gt 0 ]; then
echo -e " ${RED}FAIL${NC} ${ERRORS} mismatches, ${WARNINGS} warnings"
echo -e " ${RED}FAIL${NC} ${ERRORS} mismatches"
exit 1
else
echo -e " ${GREEN}PASS${NC} All paths consistent, ${WARNINGS} warnings"
echo -e " ${GREEN}PASS${NC} All paths consistent"
exit 0
fi