hhhge/NeteaseUrl
Archived
1
0 Fork 0
Code Issues Actions Packages Projects Releases Wiki Activity

refactor: 拆掉 auth_system 包内循环依赖，路径常量收敛到 db 单一来源

Browse Source 
为什么：auth_system 的 11 个子模块此前构成一个强连通分量——db.py 与 backup.py
为了「动态读取路径常量」而在模块级 `import auth_system`（包自身），而包 __init__
又再导出这两个子模块的全部符号，互相指成环。

这个环当前并不崩（实测 8/8 种导入姿势全通过），它的代价是**双绑定**：
`auth_system.DB_PATH is auth_system.db.DB_PATH` 初始为 True，但只 patch 其一
另一处不跟随。于是测试不得不把 4 个路径常量**两处都 patch**
（setattr(auth,...) + setattr(db,...)）——而漏 patch 的后果是静默写生产库，
commit fc7fc21 修的那次「黄金测试写进生产库」正是这么来的。

改法：让路径常量回归**模块属性单一来源**。
- db.py：删掉 `import auth_system`，内部改用本模块常量（DATA_DIR / DB_PATH /
  SECRET_KEY_PATH）。这些常量本就定义在本模块，绕道包属性纯属多余。
- backup.py：改用 `import auth_system.db as db` 做模块限定访问，路径走
  db.BACKUP_DIR / db.DB_PATH——保留动态读取能力，来源从「包属性」换成
  「db 模块」，与唯一来源一致。
  注意**不能**写成 `from . import db`：该形式在静态图里同时指向包本身与子模块，
  会把这个环重新连上（实测确实如此，SCC 从 11 降到 2 就卡住了）。
- admin_site.py：5 处 `auth.DB_PATH` / `auth.BACKUP_DIR`（auth 是包别名）同样
  改为经 db 模块访问。**这处不修就会出事**——它读的是包属性快照，而测试已改为
  patch db 模块，于是备份上传会静默落到生产 data/backups/（本次实测真的发生了，
  2 个 upload_*.db 已清理，副本留在临时目录）。
- 测试：7 个文件的 patch 目标从包属性迁到 auth_system.db.*。
- __init__.py：补注释说明这些常量在此只是 import 快照，禁止经包属性重定向。

验证：
- Tarjan 重算：非平凡强连通分量 11 → **0**（import 图已是 DAG）
- AST 全仓扫描：经包属性访问路径常量的点 **0 处残留**
- 行为：子进程内 patch auth_system.db.* 后，get_conn 连的库 / create_backup
  落盘目录 / get_secret_key 目标路径**三者全部跟随**
- 导入姿势回归 8/8 通过
- 门禁：ruff 0 · pyright 0 errors 0 warnings · pytest 175 passed
This commit is contained in:
snowy-yang committed 2026-09-26 14:37:58 +08:00
1 parent d600b6a630
commit 70ca21974b
11 files changed
+67 -66
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

auth_system/__init__.py
+8
View File
@@ -13,6 +13,14 @@
# 兼容门面：实现已按职责拆分到同包各子模块，此处原样再导出。
# 用 `__all__` 声明再导出（ruff F401 与 pyright 均据此认定「有意再导出」），
# 使既有调用点（auth_system.xxx / from auth_system import Y）零改动。
#
# ⚠️ 路径常量（DATA_DIR / DB_PATH / BACKUP_DIR / SECRET_KEY_PATH）在此只是
# **import 时的值快照**：它们是再导出的绑定，运行时改 auth_system.DB_PATH
# 不会影响 db / backup 的实际读写路径（那只会静默失效，且看起来"改成功了"）。
# 一律不要经由包属性做重定向：
# - 测试：patch `auth_system.db.<NAME>`（唯一来源，db 与 backup 都随动）
# - 部署：设置环境变量 SITE_DATA_DIR（须在进程启动前）
# 此处保留再导出仅为不破坏既有 `auth_system.DB_PATH` 读取方（如黄金测试）。
from .backup import (
_BACKUP_ERR_TS,
auth_system/backup.py
+19 -24
View File
@@ -14,13 +14,8 @@ import time
from pathlib import Path
from typing import Any
import auth_system # 路径常量以包属性为唯一来源（动态读取，便于测试/运维覆盖）
import auth_system.db as db # 绝对导入子模块：不经过包属性，避免与包 __init__ 互指成环
from .db import (
_DB_LOCK,
get_conn,
init_db,
)
from .settings import (
get_setting,
set_setting,
@@ -39,17 +34,17 @@ def create_backup() -> str:
WAL 模式下用独立只读连接走 SQLite 在线备份 API：拿到的是一致性快照，
且不持有 _DB_LOCK——原实现备份期间阻塞全站写请求，大库时会卡住所有用户。"""
auth_system.BACKUP_DIR.mkdir(parents=True, exist_ok=True)
db.BACKUP_DIR.mkdir(parents=True, exist_ok=True)
with _BACKUP_NAME_LOCK:
base = 'backup_' + time.strftime('%Y%m%d_%H%M%S')
name = base + '.db'
k = 1
while (auth_system.BACKUP_DIR / name).exists():
while (db.BACKUP_DIR / name).exists():
name = f'{base}-{k}.db'
k += 1
# 占位创建目标文件（锁内），保证并发下同秒命名仍唯一
dest = sqlite3.connect(str(auth_system.BACKUP_DIR / name))
conn = get_conn()
dest = sqlite3.connect(str(db.BACKUP_DIR / name))
conn = db.get_conn()
try:
try:
conn.backup(dest)
@@ -64,7 +59,7 @@ def create_backup() -> str:
except Exception:
# 备份失败：清掉占位文件，不留半个坏备份
try:
(auth_system.BACKUP_DIR / name).unlink(missing_ok=True)
(db.BACKUP_DIR / name).unlink(missing_ok=True)
except OSError:
pass
raise
@@ -74,10 +69,10 @@ def create_backup() -> str:
def list_backups() -> list[dict[str, Any]]:
"""备份列表（按文件修改时间倒序——按名字排序会让 upload_ 永远排前，误删新自动备份）"""
if not auth_system.BACKUP_DIR.exists():
if not db.BACKUP_DIR.exists():
return []
out = []
for p in auth_system.BACKUP_DIR.glob('*.db'):
for p in db.BACKUP_DIR.glob('*.db'):
st = p.stat()
out.append({'name': p.name, 'size': st.st_size,
'time': time.strftime('%Y-%m-%d %H:%M:%S', time.localtime(st.st_mtime)),
@@ -90,7 +85,7 @@ def list_backups() -> list[dict[str, Any]]:
def backup_path(name: str) -> Path | None:
name = Path(name).name # 防目录穿越
p = auth_system.BACKUP_DIR / name
p = db.BACKUP_DIR / name
return p if p.exists() and p.suffix == '.db' else None
@@ -132,11 +127,11 @@ def restore_backup(name: str) -> None:
_before_restore_hook()
except Exception:
pass
safety = auth_system.BACKUP_DIR / ('pre_restore_' + time.strftime('%Y%m%d_%H%M%S') + '.db')
with _DB_LOCK:
safety = db.BACKUP_DIR / ('pre_restore_' + time.strftime('%Y%m%d_%H%M%S') + '.db')
with db._DB_LOCK:
# 0) 先尽力清 WAL 并合并进主库（被占用导致 checkpoint 忙时明确失败，不假装成功）；
# 必须在留安全副本之前做——否则副本缺 WAL 里未合并的最近提交，回滚点不完整
conn = get_conn()
conn = db.get_conn()
try:
row = conn.execute('PRAGMA wal_checkpoint(TRUNCATE)').fetchone()
busy = bool(row and row[0] == 1) # 1 = busy
@@ -145,18 +140,18 @@ def restore_backup(name: str) -> None:
if busy:
raise RuntimeError('数据库当前有其他读写在途（checkpoint 忙），请稍后重试恢复')
# 1) checkpoint 后留安全副本（包含全部已提交数据，可回滚）
shutil.copy2(str(auth_system.DB_PATH), str(safety))
shutil.copy2(str(db.DB_PATH), str(safety))
# 2) 源备份复制到临时文件（不动源备份本身）
tmp = auth_system.DB_PATH.with_suffix('.db.restore_tmp')
tmp = db.DB_PATH.with_suffix('.db.restore_tmp')
shutil.copy2(str(src), str(tmp))
# 3) 原子替换 + 立即校验
os.replace(str(tmp), str(auth_system.DB_PATH))
os.replace(str(tmp), str(db.DB_PATH))
try:
init_db()
db.init_db()
except Exception:
# 替换后初始化失败：回滚安全副本，恢复原库
shutil.copy2(str(safety), str(auth_system.DB_PATH))
init_db()
shutil.copy2(str(safety), str(db.DB_PATH))
db.init_db()
raise RuntimeError('恢复后数据库初始化失败，已自动回滚到恢复前状态') from None
# 裁剪移出 _DB_LOCK——glob/unlink 的 I/O 不阻塞全站写
try:
@@ -195,7 +190,7 @@ def prune_backups(keep_normal: int = 20, keep_pre_restore: int = 5) -> None:
pre = [b for b in list_backups() if b['name'].startswith('pre_restore_')]
for b in pre[keep_pre_restore:]:
try:
(auth_system.BACKUP_DIR / b['name']).unlink()
(db.BACKUP_DIR / b['name']).unlink()
except OSError:
pass
auth_system/db.py
+9 -11
View File
@@ -12,8 +12,6 @@ import threading
import time
from pathlib import Path
import auth_system # 路径常量以包属性为唯一来源（动态读取，便于测试/运维覆盖）
from .security import (
_hash_new,
_normalize_email,
@@ -46,8 +44,8 @@ _DB_LOCK = threading.RLock()
def get_conn() -> sqlite3.Connection:
auth_system.DATA_DIR.mkdir(parents=True, exist_ok=True)
conn = sqlite3.connect(str(auth_system.DB_PATH), timeout=15)
DATA_DIR.mkdir(parents=True, exist_ok=True)
conn = sqlite3.connect(str(DB_PATH), timeout=15)
conn.row_factory = sqlite3.Row
conn.execute('PRAGMA journal_mode=WAL')
return conn
@@ -81,7 +79,7 @@ def _x(sql: str, params: tuple = ()) -> int:
def init_db() -> None:
"""初始化表结构与默认数据"""
auth_system.DATA_DIR.mkdir(parents=True, exist_ok=True)
DATA_DIR.mkdir(parents=True, exist_ok=True)
with _DB_LOCK:
conn = get_conn()
try:
@@ -227,21 +225,21 @@ def get_secret_key() -> str:
"""获取（或生成）持久化的会话签名密钥（原子写入 + 失败显式告警）"""
key = ''
try:
if auth_system.SECRET_KEY_PATH.exists():
key = auth_system.SECRET_KEY_PATH.read_text(encoding='utf-8').strip()
if SECRET_KEY_PATH.exists():
key = SECRET_KEY_PATH.read_text(encoding='utf-8').strip()
if key:
return key
except OSError:
pass
new_key = secrets.token_hex(32)
try:
auth_system.SECRET_KEY_PATH.parent.mkdir(parents=True, exist_ok=True)
SECRET_KEY_PATH.parent.mkdir(parents=True, exist_ok=True)
# 先写临时文件再原子替换，避免部分写入留下损坏密钥
tmp = auth_system.SECRET_KEY_PATH.with_suffix('.key.tmp')
tmp = SECRET_KEY_PATH.with_suffix('.key.tmp')
tmp.write_text(new_key, encoding='utf-8')
os.replace(str(tmp), str(auth_system.SECRET_KEY_PATH))
os.replace(str(tmp), str(SECRET_KEY_PATH))
# 并发初始化者以"替换后文件里的值"为准（最后写入者胜出但全员一致）
final = auth_system.SECRET_KEY_PATH.read_text(encoding='utf-8').strip()
final = SECRET_KEY_PATH.read_text(encoding='utf-8').strip()
return final or new_key
except OSError as e:
# 写入失败不能装作成功：显著告警，返回临时值（本进程会话可用，重启后失效）