feat(dev): 本地开发环境(docker-compose + Mock OAuth + 一键脚本)
解决改代码 30-60min 才能看到结果的痛点。本地拉起完整 stack, 改代码 → 1-2min 看到结果,无需服务器。 ## 交付物 ### Docker stack (docker-compose.dev.yml) - postgres:16-alpine 端口 5432 - redis:7-alpine 端口 6379 - backend 端口 8000,代码 volume mount + uvicorn --reload ### Dev 镜像 (backend/Dockerfile.dev) - 单阶段(无需 gcc / libpq-dev) - apt 源换阿里云(公司内网) - 装 pytest pytest-asyncio httpx watchfiles - CMD: uvicorn --reload ### 配置 (.env.dev, 强制 add 因 .env.* 在 .gitignore) 内容是 dev 占位符,无任何真实密钥: - DEV_MODE=true (启用 Mock OAuth) - WECOM_* 全部 dev_xxx 占位 - 集成系统 API 全 dev_ 占位(调用会失败但不影响主流程) ### Mock OAuth (backend/app/api/dev_auth.py) - GET /api/dev/login?userid=xxx&name=xxx&role=xxx 走完全真实的 TokenService.create_token(不绕过业务逻辑) - GET /api/dev/users 列出 6 个预设 dev 用户 - GET /api/dev/health dev 模式状态自检 - 6 预设用户覆盖所有角色(user/agent/supervisor/security/admin/多角色) - 每个端点 _dev_mode_enabled() 二次校验,生产环境访问 403 ### 集成改动 - backend/app/main.py: 加 _is_dev_mode() + DEV_MODE=true 时条件挂载 dev_auth 路由 + 启动时大声警告 - backend/app/config.py: Settings 加 dev_mode / dev_default_userid / dev_default_name / dev_default_dept 字段 ### PowerShell 脚本 - scripts/dev-start.ps1: 5 步验证(检查 Docker / .env / compose / 健康 / dev health),首次 2-5min build,后续秒起 - scripts/dev-stop.ps1: 停止,支持 -v 清数据卷 - scripts/dev-test.ps1: 一键跑 pytest(可选 -Frontend 跑 vitest) ## 阶段 - ✅ Phase 0 基础(本 commit) - ⏳ Phase 1 pytest(任务 #90) - 500 bug 回归测试已就绪 - ⏳ Phase 2 vitest - ⏳ Phase 3 playwright E2E ## 安全保证 - DEV_MODE 三个地方都校验(环境变量/settings/端点内) - 生产环境 /api/dev/* 端点根本不存在(未挂载) - .env.dev 是 dev 占位符,无敏感,可入 git
This commit is contained in:
@@ -37,6 +37,30 @@ logging.basicConfig(
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
|
||||
# --------------------------------------------------------------------------
|
||||
# 开发模式判定(模块级 helper,避免在 create_app 内每次重复 import)
|
||||
# --------------------------------------------------------------------------
|
||||
def _is_dev_mode() -> bool:
|
||||
"""检查是否启用了开发模式(DEV_MODE=true)。
|
||||
|
||||
三个检查源(任一为 true 即启用):
|
||||
1. 环境变量 DEV_MODE=true(最高优先级,Docker 注入)
|
||||
2. settings.dev_mode(从 .env.dev 读)
|
||||
3. DEBUG 模式 + 本地主机(最严格)
|
||||
|
||||
注意:此函数与 backend/app/api/dev_auth.py 内的 _dev_mode_enabled() 逻辑一致,
|
||||
这里用于"是否挂载 dev_auth 路由",那里用于"端点内是否放行"。
|
||||
"""
|
||||
import os
|
||||
|
||||
env_val = os.getenv("DEV_MODE", "").lower() == "true"
|
||||
if env_val:
|
||||
return True
|
||||
if getattr(settings, "dev_mode", False):
|
||||
return True
|
||||
return False
|
||||
|
||||
|
||||
# --------------------------------------------------------------------------
|
||||
# 应用生命周期管理(启动和关闭事件)
|
||||
# --------------------------------------------------------------------------
|
||||
@@ -492,6 +516,30 @@ def create_app() -> FastAPI:
|
||||
# 请求到达后端时 /api/ 已被 strip,因此此处不需要再加 /api 前缀
|
||||
app.include_router(api_router)
|
||||
|
||||
# ----------------------------------------------------------------------
|
||||
# 开发模式 Mock OAuth(仅 DEV_MODE=true 时挂载)
|
||||
# ----------------------------------------------------------------------
|
||||
# ⚠️ 生产环境严禁启用(DEV_MODE=false 或不设置)
|
||||
# 挂载的端点:
|
||||
# GET /api/dev/login — Mock 登录,跳过企微 OAuth 直接返回 token
|
||||
# GET /api/dev/users — 列出预设 dev 用户
|
||||
# GET /api/dev/health — dev 模式状态自检
|
||||
# 即使挂载了,每个端点内部也会再 _dev_mode_enabled() 二次校验
|
||||
# ----------------------------------------------------------------------
|
||||
if _is_dev_mode():
|
||||
from app.api.dev_auth import router as dev_auth_router
|
||||
app.include_router(dev_auth_router)
|
||||
logger.warning(
|
||||
"🧪 ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\n"
|
||||
"🧪 DEV_MODE 已启用 - Mock OAuth 端点已挂载\n"
|
||||
"🧪 仅供本地开发测试使用,生产环境必须关闭!\n"
|
||||
"🧪 端点列表:\n"
|
||||
"🧪 GET /api/dev/login - Mock 登录\n"
|
||||
"🧪 GET /api/dev/users - 列出预设用户\n"
|
||||
"🧪 GET /api/dev/health - dev 模式状态\n"
|
||||
"🧪 ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━"
|
||||
)
|
||||
|
||||
# ----------------------------------------------------------------------
|
||||
# 挂载 WebSocket 路由
|
||||
# ----------------------------------------------------------------------
|
||||
|
||||
Reference in New Issue
Block a user