Files
ai-kefu-admin/app/platform/registry.py
T
浅念 1824bb1590 test: PromptProvider 审查修复(组装缝断言/占位符约定文档与glob守护/边界注记)
- I-1: test_company_facts 捕获完整 prompt 的用例补话术池注入断言
  ("- EN:"/"- ZH:" 分组行在场)——守 AIService 组装缝,防 Task 9
  重接提示词线时静默丢池
- I-2: seed_profiles/README.md 落档 $DEFLECTION_POOL 占位符约定
  (缺失 = 话术池静默不注入);test_prompt_provider 占位符防漂移改
  glob 遍历 seed_profiles/*/prompts/system.md,第三租户自动纳管
  (空 glob 显性兜底,防假守护)
- Minor-1 注记: _format_deflection_pool docstring 记已知边界——条目
  含引号/换行暂不转义,Phase 2 编辑器批次处理
- Minor-5: test_provider_loads_from_tenant_dir 删恒真 or 侧,改单一
  明确断言;registry 加载期显性失败清单补 prompts 读取失败
  (FileNotFoundError 说明);conftest build_jiancai_runtime 注明
  data_dir 仅占位、从不 ensure_ready

Co-Authored-By: Claude Code <noreply@anthropic.com>
2026-10-12 20:16:40 +08:00

311 lines
14 KiB
Python

"""TenantRegistry——进程内租户注册表(Phase 1 文件加载器)。
数据源:seed_profiles/<slug>/tenant.json(站点/品牌/引擎配置)+ 同目录
wall.json(并入 snapshot["wall"],compile_wall 编译期显性炸)。Phase 2 换
platform.db 时本模块的对外接口不变(spec §5.3:后台保存→原子替换条目,
进行中的会话下一条消息即用新配置)。
关键行为:
- resolve_site(host):host 小写去端口 → 域名索引 → (TenantRuntime, Site);
未知 Host → UnknownTenantError(spec §4:404,不做兜底租户);租户停用 →
TenantDisabledError(Task 7 中间件映射为 503 中性"服务暂停"页,非 404)。
resolve(host) 只是它的便捷形式——双 API 一层实现,防两套解析漂移。
- 懒建:首次 resolve 才建 engine(WAL/pool=2)+ session_factory + ensure_schema,
per-slug asyncio.Lock 串行,锁内双检防并发双建;持锁后现势检查——条目
已被 reload 换掉则放弃本次建库、按当前条目重走(旧 runtime 永不产生
孤儿 engine);建库失败 dispose 半开 engine,保持未就绪下次重试。
- registry_reload(slug):磁盘读取/校验在锁外,swap+dispose 段与懒建/
dispose_all 取同一把 per-slug 锁。坏配置(无效 JSON/墙编译失败/零站点/
域名冲突)在替换前抛,旧条目原样服务;替换后 dispose 旧 engine
(Windows 下不关=库文件句柄泄漏)。
测试/teardown 纪律:凡建过 engine 的 Registry 用完必须 await dispose_all()
(Windows 文件锁,tmp 目录删不掉)。
"""
import asyncio
import json
import pathlib
from dataclasses import dataclass
from sqlalchemy import event
from sqlalchemy.ext.asyncio import (
AsyncEngine,
AsyncSession,
async_sessionmaker,
create_async_engine,
)
from app.engine.models import ensure_schema
from app.engine.services.ai_service import PromptProvider
from app.engine.wall_schema import CompiledWall, compile_wall
from app.platform.tenant_config import Site, TenantConfig
class UnknownTenantError(LookupError):
"""Host/域名无法映射到任何租户(调用方语义:聊天/公开端点 404)。"""
class TenantDisabledError(LookupError):
"""租户 status != "active"(调用方语义:503 中性"服务暂停"页,非 404;
Task 7 中间件负责映射)。"""
def _read_json(path: pathlib.Path):
"""读 JSON 文件;读不了/解析不了都带路径抛 ValueError——哪份文件
坏了一目了然(裸 FileNotFoundError/JSONDecodeError 不含路径上下文)。"""
try:
text = path.read_text(encoding="utf-8")
except OSError as exc:
raise ValueError(f"{path}: 无法读取: {exc}") from exc
try:
return json.loads(text)
except ValueError as exc: # JSONDecodeError 等
raise ValueError(f"{path}: 无效 JSON: {exc}") from exc
def make_tenant_engine(db_path: pathlib.Path) -> AsyncEngine:
"""每租户 SQLite engine:pool=2 无溢出(单租户低并发),忙等 30s
(对齐 jc 现状:后台推送连接可能撞 SMTP 窗口写锁),打开即 WAL
(spec §6.1 硬纪律:读写不互斥,优于靠 timeout 硬扛)。"""
engine = create_async_engine(
f"sqlite+aiosqlite:///{db_path.as_posix()}",
pool_size=2, max_overflow=0,
connect_args={"timeout": 30})
@event.listens_for(engine.sync_engine, "connect")
def _wal(dbapi_conn, _): # dbapi_conn = aiosqlite 同步适配层
dbapi_conn.execute("PRAGMA journal_mode=WAL")
return engine
def _normalize_host(host: str) -> str:
"""Host 头归一:去空白/小写/去端口/去 FQDN 尾点(真实请求 Host:8018、
大写都可能出现);IPv6 字面量 [::1]:8018 取方括号内部分。"""
host = (host or "").strip().lower().rstrip(".")
if host.startswith("["):
return host.split("]", 1)[0].lstrip("[")
return host.split(":", 1)[0]
@dataclass
class TenantRuntime:
"""单租户运行时。
加载期就绪:config(TenantConfig:data=快照⊕出厂默认,含 sites)/
db_path(该租户 SQLite 文件路径)/seed_dir(seed_profiles/<slug>/)/
compiled_wall(墙编译产物)/prompts(Task 6 PromptProvider,from_dir
(seed_dir/prompts) 四件套——$DEFLECTION_POOL 话术池注入的单一消费口)。
懒建:engine/session_factory(Registry 首次 resolve,ensure_schema 已跑)。
manager(Task 5b)由装配线另行构造注入,不在本类持有。
"""
config: TenantConfig
db_path: pathlib.Path
seed_dir: pathlib.Path
compiled_wall: CompiledWall
prompts: PromptProvider
engine: AsyncEngine | None = None
session_factory: async_sessionmaker | None = None
def site_by_slug(self, slug: str) -> Site | None:
"""按 slug 取站点(空域名站点如 es 靠嵌入代码 data-site 接入)。"""
for site in self.config.sites:
if site.slug == slug:
return site
return None
class TenantRegistry:
"""tenant slug → TenantRuntime;域名 → (tenant_slug, site_slug) 索引。
reload 重建索引而非增量维护——租户数是个位数,整建最简且无漂移。"""
def __init__(self):
self._seed_dir: pathlib.Path | None = None
self._data_dir: pathlib.Path | None = None
self._by_slug: dict[str, TenantRuntime] = {}
self._domain_index: dict[str, tuple[str, str]] = {}
self._locks: dict[str, asyncio.Lock] = {}
# ---- 加载 -----------------------------------------------------------
@classmethod
def load_from_dir(cls, seed_dir, data_dir) -> "TenantRegistry":
"""seed_profiles/<slug>/tenant.json(+同目录 wall.json)→ Registry。
加载期显性失败(不流入运行期):目录无任何 tenant.json(seed_dir
路径拼错→静默空注册表→全量 404,必须炸)、无效 JSON、slug 与目录
名不一致、零站点、wall 编译错误、域名重复绑定、prompts 读取失败
(Task 6: prompts/ 目录缺失或四件套不齐 → PromptProvider.from_dir
的 FileNotFoundError,加载即炸,不流入运行期)。
"""
reg = cls()
reg._seed_dir = pathlib.Path(seed_dir)
reg._data_dir = pathlib.Path(data_dir)
tenant_jsons = sorted(reg._seed_dir.glob("*/tenant.json"))
if not tenant_jsons:
raise ValueError(f"{reg._seed_dir} 下没有任何 <slug>/tenant.json")
for tenant_json in tenant_jsons:
rt = reg._load_tenant(tenant_json.parent)
if rt.config.slug in reg._by_slug:
raise ValueError(f"租户 slug 重复: {rt.config.slug}")
reg._by_slug[rt.config.slug] = rt
reg._domain_index = reg._build_domain_index(reg._by_slug)
return reg
def _load_tenant(self, tenant_dir: pathlib.Path) -> TenantRuntime:
slug = tenant_dir.name
tenant_json = _read_json(tenant_dir / "tenant.json")
if tenant_json.get("slug") != slug:
raise ValueError(
f"{tenant_dir / 'tenant.json'}: slug 字段 "
f"{tenant_json.get('slug')!r} 与目录名 {slug!r} 不一致")
sites = tenant_json.get("sites") or []
if not sites:
raise ValueError(f"{slug}: 每租户至少一个站点(sites 为空)")
# wall 并入 snapshot["wall"]:data["wall"] 保留原始词表(后台编辑/
# 回滚用),编译产物挂 runtime.compiled_wall(引擎消费,单一编译)
wall_cfg = _read_json(tenant_dir / "wall.json")
snapshot = dict(tenant_json.get("config") or {})
snapshot["wall"] = wall_cfg
config = TenantConfig.from_snapshot(
slug, tenant_json.get("name", slug), snapshot,
sites=sites, status=tenant_json.get("status", "active"))
return TenantRuntime(
config=config,
db_path=self._data_dir / f"{slug}.db",
seed_dir=tenant_dir,
compiled_wall=compile_wall(wall_cfg),
prompts=PromptProvider.from_dir(tenant_dir / "prompts"))
def _build_domain_index(
self, by_slug: dict[str, TenantRuntime]
) -> dict[str, tuple[str, str]]:
index: dict[str, tuple[str, str]] = {}
for slug, rt in by_slug.items():
for site in rt.config.sites:
for domain in site.domains:
key = _normalize_host(domain)
if not key:
continue
if key in index and index[key] != (slug, site.slug):
raise ValueError(
f"域名 {key} 已绑定 (tenant={index[key][0]}, "
f"site={index[key][1]}),不能同时绑定 "
f"(tenant={slug}, site={site.slug})")
index[key] = (slug, site.slug)
return index
# ---- 解析(对外 API)--------------------------------------------------
async def resolve_site(self, host: str) -> tuple[TenantRuntime, Site]:
"""host → (TenantRuntime, Site)。未知 Host → UnknownTenantError;
租户停用 → TenantDisabledError;首次 resolve 懒建该租户 engine。
返回的 runtime 以 _ensure_ready 的返回值为准(等锁期间条目可能
已被 reload 换成新配置)。"""
mapped = self._domain_index.get(_normalize_host(host))
if mapped is None:
raise UnknownTenantError(f"未知 Host: {host!r}")
tenant_slug, site_slug = mapped
rt = self._by_slug[tenant_slug]
if rt.config.status != "active":
raise TenantDisabledError(f"租户已停用: {tenant_slug!r}")
rt = await self._ensure_ready(rt)
site = rt.site_by_slug(site_slug)
if site is None: # reload 竞态:域名命中后站点被换掉,视同未知
raise UnknownTenantError(
f"站点 {site_slug!r} 不存在于租户 {tenant_slug!r}"
f"(可能已被 reload 移除)")
return rt, site
async def resolve(self, host: str) -> TenantRuntime:
"""resolve_site 的便捷形式(双 API 一层实现)。"""
return (await self.resolve_site(host))[0]
# ---- 装配期辅助(Task 5b: main.lifespan 逐租户启动清扫)------------------
def runtimes(self) -> tuple[TenantRuntime, ...]:
"""全部租户运行时的加载期快照(engine 仍懒建)——装配期遍历用
(lifespan 启动清扫逐租户跑)。返回快照 tuple:遍历中 registry_reload
换条目不影响本轮迭代。"""
return tuple(self._by_slug.values())
async def ensure_ready(self, rt: TenantRuntime) -> TenantRuntime:
"""懒建的公开入口(装配期批处理用)——与 resolve 走同一条就绪路径,
现势检查/双检/建库失败半开语义完全一致。"""
return await self._ensure_ready(rt)
# ---- 懒建 / 热加载 / 释放 ---------------------------------------------
async def _ensure_ready(self, rt: TenantRuntime) -> TenantRuntime:
"""懒建 engine + session_factory + ensure_schema,per-slug Lock 串行。
持锁后现势检查:_by_slug 条目已被 registry_reload 换掉 → 放弃本次
建库(否则旧 runtime 会产出无人 dispose 的孤儿 engine),按当前
条目重走;双检:等锁期间前一个协程可能已建好。建库失败 dispose
半开 engine 并保持未就绪,下次 resolve 重试。
"""
slug = rt.config.slug
while True:
if rt.engine is not None:
return rt
lock = self._locks.setdefault(slug, asyncio.Lock())
async with lock:
current = self._by_slug.get(slug)
if current is None:
raise UnknownTenantError(f"租户已不存在: {slug!r}")
if current is not rt:
rt = current # 条目已被 reload 换掉,按新条目重走
continue
if rt.engine is not None: # 双检:等锁期间已建好
return rt
self._data_dir.mkdir(parents=True, exist_ok=True)
engine = make_tenant_engine(rt.db_path)
try:
await ensure_schema(engine)
except Exception:
await engine.dispose()
raise
rt.engine = engine
rt.session_factory = async_sessionmaker(
engine, class_=AsyncSession, expire_on_commit=False)
return rt
async def registry_reload(self, slug: str) -> None:
"""重读磁盘,原子替换条目;旧 runtime 若已建 engine,dispose 掉。
磁盘读取/校验在锁外,swap+dispose 段与 _ensure_ready/dispose_all
取同一把 per-slug 锁:懒建要么完整发生在替换前(dispose 得到旧
engine),要么持锁后发现条目已换而放弃——不存在"建到一半被换"
的孤儿窗口。坏配置在替换前抛,旧条目原样服务,不留半更新状态。
"""
if slug not in self._by_slug:
raise UnknownTenantError(f"租户不存在: {slug!r}")
rt = self._load_tenant(self._seed_dir / slug)
lock = self._locks.setdefault(slug, asyncio.Lock())
async with lock:
old = self._by_slug.get(slug)
candidate = dict(self._by_slug)
candidate[slug] = rt
new_index = self._build_domain_index(candidate) # 冲突在此抛,状态未动
self._by_slug[slug] = rt # 原子替换(锁内,无 await)
self._domain_index = new_index
if old is not None and old.engine is not None:
await old.engine.dispose()
old.engine = old.session_factory = None
async def dispose_all(self) -> None:
"""关闭全部 engine 并复位为未就绪(测试 teardown 用——Windows 文件锁;
复位后若再 resolve 会重新懒建,可安全复用)。
与懒建/reload 取同一把 per-slug 锁:dispose 期间该租户不会有并发
建库(否则新建的 engine 会被本次复位漏掉或反过来被关)。迭代前
快照 _locks——迭代中并发 resolve 可能 setdefault 新锁。
"""
for slug, lock in list(self._locks.items()):
async with lock:
rt = self._by_slug.get(slug)
if rt is not None and rt.engine is not None:
await rt.engine.dispose()
rt.engine = rt.session_factory = None