chore: 项目定名为 workbuddy-portal，容器化并补齐文档体系
## 项目定名 - 目录 wb_usage_portal → workbuddy-portal - Python 包 wb_usage → workbuddy_portal（含 session cookie 名） - 界面品牌统一为 WorkBuddy Portal；项目标识收敛到 config 单一来源 ## 容器化 - Dockerfile：多阶段构建，依赖层与源码解耦；非 root(uid 1000)；内置健康检查 - docker-compose.yml：单服务 + 绑定挂载 data/logs + 日志轮转 + TZ - docker/entrypoint.sh：幂等初始化 → exec serve（LF 行尾，已由 .gitattributes 锁定） - docker/healthcheck.py：纯标准库探活 /login（slim 镜像无 curl） - .dockerignore / .env.example；数据目录可用 WB_DATA_DIR 等环境变量覆盖 ## 文档 - docs/USER-GUIDE.md 用户使用手册（含 9 张真实界面截图） - docs/DEPLOYMENT.md 部署运维（Docker / 裸机 / 反代 / 备份 / 推 Gitea 注册表） - docs/ARCHITECTURE.md 架构与设计说明（含已知坑与红线、验证体系） - docs/API.md 接口参考（路径 / 参数 / 返回结构 / 错误码） - docs/FAQ.md 常见问题；docs/CHANGELOG.md 变更日志 ## 修复缺陷（8） 1. /records/export 必然 500：生成器在请求上下文销毁后才迭代，改用自建连接 2. 大屏页图表全白：相对路径把 echarts.min.js 解析成 /vendor/... → 404 3. /users 500：路由已注册但模板缺失 4. 明细页日期筛选失效：视图传 f.frm、模板读 f.from 5. 配置页维护按钮全死：调用了不存在的 WBU.bindMaint() 6. 审计只能看最近 40 条：LIMIT 写死 7. 明细页多跑一条无用 SELECT：day_list() 取了没人用 8. 登录页锁定阈值未从配置注入 ## 安全加固 - 新增 safe_next()：拒绝 //evil.com 等协议相对 URL 的开放重定向 - 缺 CSRF 的写请求统一 400 - 默认开启云端 HTTPS 证书校验（ssl_verify=1）；Cookie 是账号凭证 - 登录失败计数表加上限与 TTL - /logout 拆分为 POST(执行) + GET(仅提示)，防 <img src=/logout> 静默退出 - settings 内部簿记键 slot:* 读写两侧过滤，不再从 /api/settings 泄漏 ## 内部质量与工具 - 设置项写时校验 + 读时兜底，杜绝「一个手滑的数字让采集整个跑不起来」 - 全局 ValueError → 400：手写 query string 不再暴露 500 页面 - CSV 导出改 csv.writer 流式写入（原手工拼串，字段含逗号会串列） - bundle 明细加 20000 上限并回传 recordsTotal/recordsTruncated，不静默丢数据 - tools/smoke.py 离线回归 99 项；tools/check_live.py 真实 HTTP 56 项 - tools/shots.py Playwright 逐页截图 + JS 报错收集 ## 验证 - compileall 通过；smoke 99/99；对容器实例 check_live 56/56；截图 0 JS 报错 - 容器内采集实测成功（trigger=startup 补跑：新增 11 条）
这个提交包含在：
+152
@@ -0,0 +1,152 @@
|
||||
#!/usr/bin/env python
|
||||
# -*- coding: utf-8 -*-
|
||||
"""界面实检：登录后逐页截图，用来目视确认「统一美化」是否真的落地。
|
||||
|
||||
用法：
|
||||
python manage.py serve --port 8849 --no-scheduler # 另开一个终端
|
||||
python tools/shots.py --base http://127.0.0.1:8849
|
||||
python tools/shots.py --full # 整页长图（默认只截首屏）
|
||||
|
||||
产物：data/shots/*.png（已被 .gitignore 之外的目录，可直接删）。
|
||||
|
||||
为什么不用 headless chrome 直出：本项目的页面都要登录态，
|
||||
`--screenshot` 无法注入会话 Cookie，所以必须用 Playwright 走一次真实登录。
|
||||
"""
|
||||
from __future__ import annotations
|
||||
|
||||
import argparse
|
||||
import os
|
||||
import sys
|
||||
|
||||
BASE = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
|
||||
sys.path.insert(0, BASE)
|
||||
|
||||
PAGES = [
|
||||
("login", "/login", "登录页"),
|
||||
("overview", "/", "概览"),
|
||||
("records", "/records", "数据明细"),
|
||||
("tasks", "/tasks", "任务管理"),
|
||||
("config", "/config", "配置管理"),
|
||||
("logs", "/logs", "日志管理"),
|
||||
("users", "/users", "用户管理"),
|
||||
("dashboard", "/dashboard", "用量大屏"),
|
||||
]
|
||||
|
||||
|
||||
def _find_browser() -> str | None:
|
||||
"""找一个可用的 Chromium 可执行文件。
|
||||
|
||||
Playwright 的驱动版本与本地已下载的浏览器版本常常错位（例如驱动要
|
||||
chromium_headless_shell-1234 而本机只有 -1228），此时 launch() 会直接报
|
||||
「Executable doesn't exist」。这里按优先级探测，命中就显式传 executable_path。
|
||||
"""
|
||||
import glob
|
||||
home = os.environ.get("LOCALAPPDATA") or os.path.expanduser("~")
|
||||
pats = [
|
||||
os.path.join(home, "ms-playwright", "chromium-*", "chrome-win64", "chrome.exe"),
|
||||
os.path.join(home, "ms-playwright", "chromium_headless_shell-*",
|
||||
"chrome-headless-shell-win64", "chrome-headless-shell.exe"),
|
||||
r"C:\Program Files\Google\Chrome\Application\chrome.exe",
|
||||
r"C:\Program Files (x86)\Google\Chrome\Application\chrome.exe",
|
||||
r"C:\Program Files (x86)\Microsoft\Edge\Application\msedge.exe",
|
||||
r"C:\Program Files\Microsoft\Edge\Application\msedge.exe",
|
||||
]
|
||||
for p in pats:
|
||||
hits = sorted(glob.glob(p))
|
||||
if hits:
|
||||
return hits[-1]
|
||||
return None
|
||||
|
||||
|
||||
def main() -> int:
|
||||
ap = argparse.ArgumentParser()
|
||||
ap.add_argument("--base", default="http://127.0.0.1:8849")
|
||||
ap.add_argument("-u", "--user", default="admin")
|
||||
ap.add_argument("-p", "--password", default="admin123")
|
||||
ap.add_argument("--out", default=os.path.join(BASE, "data", "shots"))
|
||||
ap.add_argument("--full", action="store_true", help="截整页长图")
|
||||
ap.add_argument("--browser", default="", help="显式指定 chrome/msedge 可执行文件")
|
||||
ap.add_argument("--width", type=int, default=1440)
|
||||
ap.add_argument("--height", type=int, default=900)
|
||||
a = ap.parse_args()
|
||||
|
||||
from playwright.sync_api import sync_playwright
|
||||
|
||||
exe = a.browser or _find_browser()
|
||||
os.makedirs(a.out, exist_ok=True)
|
||||
problems = []
|
||||
with sync_playwright() as pw:
|
||||
try:
|
||||
br = pw.chromium.launch(executable_path=exe) if exe else pw.chromium.launch()
|
||||
except Exception as e: # noqa: BLE001
|
||||
print("[FAIL] 启动浏览器失败：%s" % e)
|
||||
print(" 可用 --browser 显式指定，或用 `playwright install chromium` 装齐。")
|
||||
return 1
|
||||
print("浏览器：%s" % (exe or "playwright 默认"))
|
||||
ctx = br.new_context(viewport={"width": a.width, "height": a.height},
|
||||
device_scale_factor=2, locale="zh-CN")
|
||||
page = ctx.new_page()
|
||||
errors = []
|
||||
page.on("console", lambda m: errors.append(m.text) if m.type == "error" else None)
|
||||
page.on("pageerror", lambda e: errors.append(str(e)))
|
||||
|
||||
# 1) 先截未登录的登录页
|
||||
page.goto(a.base + "/login", wait_until="networkidle")
|
||||
page.screenshot(path=os.path.join(a.out, "00-login.png"), full_page=a.full)
|
||||
print("[ok] 00-login.png")
|
||||
|
||||
# 2) 登录
|
||||
page.fill('input[name=username]', a.user)
|
||||
page.fill('input[name=password]', a.password)
|
||||
page.click('button[type=submit]')
|
||||
page.wait_for_load_state("networkidle")
|
||||
if "/login" in page.url:
|
||||
print("[FAIL] 登录失败，后续截图无意义")
|
||||
br.close()
|
||||
return 1
|
||||
|
||||
# 3) 逐页截图
|
||||
for i, (slug, path, label) in enumerate(PAGES[1:], start=1):
|
||||
errors.clear()
|
||||
page.goto(a.base + path, wait_until="networkidle")
|
||||
page.wait_for_timeout(900) # 等 ECharts / 表格渲染稳下来
|
||||
page.screenshot(path=os.path.join(a.out, "%02d-%s.png" % (i, slug)),
|
||||
full_page=a.full)
|
||||
js_err = [e for e in errors if "favicon" not in e.lower()]
|
||||
flag = "" if not js_err else " [JS错误] " + " | ".join(js_err[:3])
|
||||
if js_err:
|
||||
problems.append("%s: %s" % (label, js_err[:3]))
|
||||
print("[ok] %02d-%s.png %s%s" % (i, slug, label, flag))
|
||||
|
||||
# 4) 大屏页再点几个交互，确认控件联动不炸
|
||||
page.goto(a.base + "/dashboard", wait_until="networkidle")
|
||||
page.wait_for_timeout(1200)
|
||||
for sel in ["#segRange button", ".seg button"]:
|
||||
btns = page.query_selector_all(sel)
|
||||
if len(btns) > 1:
|
||||
errors.clear()
|
||||
btns[1].click()
|
||||
page.wait_for_timeout(900)
|
||||
page.screenshot(path=os.path.join(a.out, "08-dashboard-interact.png"),
|
||||
full_page=a.full)
|
||||
js_err = [e for e in errors if "favicon" not in e.lower()]
|
||||
print("[ok] 08-dashboard-interact.png 点击 %s 第 2 项%s"
|
||||
% (sel, "" if not js_err else " [JS错误] %s" % js_err[:2]))
|
||||
if js_err:
|
||||
problems.append("大屏交互: %s" % js_err[:2])
|
||||
break
|
||||
|
||||
br.close()
|
||||
|
||||
print("\n截图目录：%s" % a.out)
|
||||
if problems:
|
||||
print("发现问题：")
|
||||
for p in problems:
|
||||
print(" - " + p)
|
||||
return 1
|
||||
print("RESULT: 全页面截图完成，无 JS 报错")
|
||||
return 0
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
sys.exit(main())
|
||||
在新工单中引用
屏蔽一个用户