CI / backend (push) Canceled after 0s
需求是"改完 Android 端怎么送到手机上"。不发应用商店,也不想每次手动传包,
于是做了最小闭环:后端存一份安装包清单,App 启动时查、下载、交给系统安装器。
后端
- 新增 /app/release/latest 与 /app/release/download/{file},都免登录:
还没装上新包的客户端未必带着有效令牌,检查更新不该被登录挡住
- download_url 用相对路径,客户端拿自己配置的 API 地址拼——同一份清单要在
内网、公网、模拟器之间共用,写死域名只会让其中一个坏掉
- has_update 只比对 version_code,不比版本名字符串(0.10.0 与 0.9.0 的字典序是坑)
- 下载只认清单里登记的文件名,含 ..%2F 一律 9001
- scripts/publish_apk.py 负责复制 APK 并写 latest.json(sha256/size/published_at),
backend/static/apk/ 不进版本库
安卓
- AppUpdater:查清单 → 下到应用自己的 updates 目录(先写 .part 再改名)→
校验 sha256 → 经 FileProvider 交给系统安装器
- UpdateDialog:版本号、更新说明、下载进度、失败重试;「允许安装未知应用」
是系统开关,只跳设置页,不代点
- 启动时自动查一次,首页底部另有「检查更新」入口
- 图标换成和 Web 的 <Logo/> 同一套图形:墨绿圆角底、三条米白圆头线、陶土点;
同时出 mipmap 各密度 PNG、自适应图标与 512px 预览
- versionCode=2 / versionName=0.2.0;发布签名从 android/keystore.properties 读,
没有该文件时回落调试签名,保证别人 clone 下来也能 assembleRelease
文档
- API.md 第 7 节:两个接口、清单字段、签名与 sha256 的约定、9001
- DEPLOY.md 第 5 节:出包命令(JDK 17 + Gradle 8.9 + 干净的 GRADLE_USER_HOME)、
发布清单、传到服务器、验证
- ROADMAP 第 6 节记录本次范围与本机踩过的构建环境坑
验证
- 后端 pytest 103 passed;ruff check / format --check 全绿
- assembleRelease 成功,app-release.apk 7.4 MB,apksigner 验签显示 CN=Dadao Task
- 本地与生产 GET /app/release/latest?version_code=1 → has_update=true,
version_code=2 → false;下载返回 200 / application/vnd.android.package-archive
170 lines
6.2 KiB
Python
170 lines
6.2 KiB
Python
"""FastAPI 入口。"""
|
|
|
|
from __future__ import annotations
|
|
|
|
from contextlib import asynccontextmanager
|
|
from pathlib import Path
|
|
from typing import Any
|
|
|
|
from fastapi import FastAPI, Request
|
|
from fastapi.exceptions import RequestValidationError
|
|
from fastapi.middleware.cors import CORSMiddleware
|
|
from fastapi.responses import JSONResponse
|
|
from sqlalchemy import text
|
|
from starlette.exceptions import HTTPException as StarletteHTTPException
|
|
from starlette.responses import Response
|
|
from starlette.staticfiles import StaticFiles
|
|
from starlette.types import Scope
|
|
|
|
from .api import app_release, attachments, auth, items, knowledge, tickets, workspaces
|
|
from .config import get_settings
|
|
from .db import SessionFactory, current_app_role, engine
|
|
from .errors import AppError, ErrorCode, http_status_for
|
|
from .logging_setup import get_logger, request_id_ctx, setup_logging
|
|
from .middleware import IdempotencyMiddleware, RequestContextMiddleware, error_body
|
|
|
|
settings = get_settings()
|
|
setup_logging("DEBUG" if settings.env == "dev" else "INFO")
|
|
logger = get_logger("app")
|
|
|
|
|
|
@asynccontextmanager
|
|
async def lifespan(app: FastAPI):
|
|
settings.validate_runtime()
|
|
if settings.env == "prod" and settings.internal_test_login:
|
|
logger.warning(
|
|
"内测登录已开启:任意手机号可用固定验证码登录,只能在内网访问,切勿暴露公网",
|
|
extra={"extra_fields": {"sms_provider": settings.sms_provider}},
|
|
)
|
|
logger.info(
|
|
"服务启动",
|
|
extra={"extra_fields": {"env": settings.env, "commit": settings.build_commit}},
|
|
)
|
|
yield
|
|
await engine.dispose()
|
|
|
|
|
|
app = FastAPI(
|
|
title=f"{settings.app_name} API",
|
|
version="0.1.0",
|
|
description="达道Task —— 任务 / 工单 / 知识库,一条流。",
|
|
lifespan=lifespan,
|
|
docs_url="/docs" if settings.env != "prod" else None,
|
|
redoc_url=None,
|
|
)
|
|
|
|
app.add_middleware(
|
|
CORSMiddleware,
|
|
allow_origins=settings.cors_origins,
|
|
allow_credentials=True,
|
|
allow_methods=["*"],
|
|
allow_headers=["*"],
|
|
expose_headers=["X-Request-Id", "X-Idempotent-Replay"],
|
|
)
|
|
# 后加的中间件先执行:RequestContext 必须最外层
|
|
app.add_middleware(IdempotencyMiddleware)
|
|
app.add_middleware(RequestContextMiddleware)
|
|
|
|
|
|
# ── 异常处理:对外永远是 {code, message, data, request_id} ──
|
|
@app.exception_handler(AppError)
|
|
async def handle_app_error(request: Request, exc: AppError) -> JSONResponse:
|
|
return JSONResponse(
|
|
status_code=exc.http_status,
|
|
content=error_body(request_id_ctx.get(), exc.code, exc.message, exc.details),
|
|
)
|
|
|
|
|
|
@app.exception_handler(RequestValidationError)
|
|
async def handle_validation(request: Request, exc: RequestValidationError) -> JSONResponse:
|
|
details: list[dict[str, Any]] = [
|
|
{"field": ".".join(str(p) for p in err["loc"][1:]), "msg": err["msg"]}
|
|
for err in exc.errors()
|
|
]
|
|
return JSONResponse(
|
|
status_code=422,
|
|
content=error_body(
|
|
request_id_ctx.get(), ErrorCode.VALIDATION_FAILED, "参数校验失败", details
|
|
),
|
|
)
|
|
|
|
|
|
@app.exception_handler(StarletteHTTPException)
|
|
async def handle_http(request: Request, exc: StarletteHTTPException) -> JSONResponse:
|
|
code = ErrorCode.NOT_FOUND if exc.status_code == 404 else ErrorCode.BAD_REQUEST
|
|
return JSONResponse(
|
|
status_code=exc.status_code,
|
|
content=error_body(request_id_ctx.get(), code, str(exc.detail)),
|
|
)
|
|
|
|
|
|
@app.exception_handler(Exception)
|
|
async def handle_unexpected(request: Request, exc: Exception) -> JSONResponse:
|
|
logger.exception("未处理异常")
|
|
return JSONResponse(
|
|
status_code=http_status_for(ErrorCode.INTERNAL),
|
|
content=error_body(request_id_ctx.get(), ErrorCode.INTERNAL, "服务器内部错误"),
|
|
)
|
|
|
|
|
|
app.include_router(auth.router, prefix=settings.api_prefix)
|
|
app.include_router(workspaces.router, prefix=settings.api_prefix)
|
|
app.include_router(items.router, prefix=settings.api_prefix)
|
|
app.include_router(items.tag_router, prefix=settings.api_prefix)
|
|
app.include_router(tickets.router, prefix=settings.api_prefix)
|
|
app.include_router(tickets.notify_router, prefix=settings.api_prefix)
|
|
app.include_router(knowledge.router, prefix=settings.api_prefix)
|
|
app.include_router(attachments.router, prefix=settings.api_prefix)
|
|
app.include_router(app_release.router, prefix=settings.api_prefix)
|
|
|
|
|
|
@app.get("/health", tags=["运维"], summary="存活探针")
|
|
async def health() -> dict:
|
|
db_ok = True
|
|
try:
|
|
async with SessionFactory() as session:
|
|
await session.execute(text("SELECT 1"))
|
|
except Exception: # noqa: BLE001
|
|
logger.exception("数据库探活失败")
|
|
db_ok = False
|
|
return {"status": "ok" if db_ok else "degraded", "db": db_ok, "env": settings.env}
|
|
|
|
|
|
@app.get("/version", tags=["运维"], summary="构建标记")
|
|
async def version() -> dict:
|
|
"""部署后必须校验:commit 必须等于 git rev-parse --short HEAD。"""
|
|
role = None
|
|
try:
|
|
async with SessionFactory() as session:
|
|
role = await current_app_role(session)
|
|
except Exception: # noqa: BLE001
|
|
logger.warning("读取数据库角色失败")
|
|
|
|
return {
|
|
"app": settings.app_name,
|
|
"env": settings.env,
|
|
"commit": settings.build_commit,
|
|
"build_time": settings.build_time,
|
|
"api_prefix": settings.api_prefix,
|
|
"db_role": role,
|
|
}
|
|
|
|
|
|
# ── 前端产物:单端口部署(没有 nginx 时也让一个端口提供完整站点)────────
|
|
# 顺序很重要:必须挂在所有 API 路由之后,否则挂载 "/" 会吞掉 /api、/health、/version。
|
|
class _SPAStaticFiles(StaticFiles):
|
|
"""静态命中就返回,未命中回退 index.html——前端路由(如 /w/<id>)交给浏览器处理。"""
|
|
|
|
async def get_response(self, path: str, scope: Scope) -> Response:
|
|
try:
|
|
return await super().get_response(path, scope)
|
|
except StarletteHTTPException as exc:
|
|
if exc.status_code == 404:
|
|
return await super().get_response("index.html", scope)
|
|
raise
|
|
|
|
|
|
_web_dist = Path(settings.web_dist_dir) if settings.web_dist_dir else None
|
|
if _web_dist is not None and (_web_dist / "index.html").is_file():
|
|
app.mount("/", _SPAStaticFiles(directory=str(_web_dist), html=True), name="web")
|