mirror of
https://github.com/jxxghp/MoviePilot.git
synced 2026-09-04 23:17:20 +08:00
refactor: 收口订阅与插件应用边界
This commit is contained in:
@@ -7,7 +7,7 @@
|
||||
> [`docs/rules/04-design-patterns.md`](rules/04-design-patterns.md) 为准,本文与其保持一致;
|
||||
> 如出现差异,以规则文档为准。
|
||||
>
|
||||
> *Last Updated: 2026-08-17*
|
||||
> *Last Updated: 2026-08-18*
|
||||
|
||||
---
|
||||
|
||||
@@ -28,7 +28,8 @@ flowchart LR
|
||||
|
||||
subgraph 后端["MoviePilot 后端(FastAPI)"]
|
||||
API["REST API / MCP / 兼容协议"]
|
||||
Core["核心引擎<br/>Chain / Module / Plugin / Agent"]
|
||||
Core["核心引擎<br/>Chain / Application / Module / Plugin / Agent"]
|
||||
Persist["持久化端口 / Oper"]
|
||||
end
|
||||
|
||||
subgraph 外部服务["外部生态"]
|
||||
@@ -45,7 +46,8 @@ flowchart LR
|
||||
Msg -->|Webhook / 轮询| Core
|
||||
ExtAgent -->|JSON-RPC| API
|
||||
API --> Core
|
||||
Core --> DB
|
||||
Core -->|通过应用端口 / Oper| Persist
|
||||
Persist --> DB
|
||||
Core <--> Site
|
||||
Core <--> DL
|
||||
Core <--> MS
|
||||
@@ -69,7 +71,7 @@ flowchart TB
|
||||
Workflow["app/workflow<br/>工作流"]
|
||||
Scheduler["app/scheduler<br/>定时任务"]
|
||||
CLI["app/cli<br/>命令行"]
|
||||
PluginPkg["app/plugins<br/>插件"]
|
||||
PluginPkg["插件运行时目录<br/>app/plugins/*(副本/覆盖层)"]
|
||||
end
|
||||
|
||||
subgraph 编排层["编排层"]
|
||||
@@ -96,7 +98,7 @@ flowchart TB
|
||||
subgraph 组合根["组合根 / 边界"]
|
||||
Startup["app/startup<br/>Composition Root"]
|
||||
Sdk["app/sdk<br/>插件稳定导入面"]
|
||||
Compat["app/runtime/compat<br/>旧导入路径映射"]
|
||||
Compat["app/runtime/compat<br/>旧导入路径与符号映射"]
|
||||
end
|
||||
|
||||
ApiPkg --> Chain
|
||||
@@ -109,9 +111,9 @@ flowchart TB
|
||||
|
||||
Chain -->|run_module 分发| Modules
|
||||
Chain --> App
|
||||
Chain --> Db
|
||||
Chain -->|经应用端口 / Oper 适配| Db
|
||||
App --> Modules
|
||||
App --> Db
|
||||
App -->|应用端口 / Oper 适配| Db
|
||||
|
||||
Modules --> Domain
|
||||
App --> Domain
|
||||
@@ -122,15 +124,25 @@ flowchart TB
|
||||
Runtime --> Foundation
|
||||
Adapters --> Domain
|
||||
Adapters --> Foundation
|
||||
App --> Adapters
|
||||
App -->|允许的技术适配依赖;优先由 startup 装配| Adapters
|
||||
|
||||
Startup -.注入/装配.-> Runtime
|
||||
Startup -.注入/装配.-> App
|
||||
Startup -.注入/装配.-> Modules
|
||||
Sdk -.门面转发.-> App
|
||||
Compat -.惰性映射.-> Sdk
|
||||
Compat -.精确别名.-> App
|
||||
Compat -.精确别名.-> Db
|
||||
Compat -.精确别名.-> Foundation
|
||||
Compat -.精确别名.-> Adapters
|
||||
```
|
||||
|
||||
图中的 `Chain → Db`、`Application → Db` 表示通过应用端口、Oper 或组合根注入的实现完成持久化,
|
||||
不是允许在用例代码中直接创建数据库引擎或拼接 SQL。`compat` 也不是只面向 SDK 的转发层,
|
||||
它按 `app/runtime/compat/manifest.py` 的白名单把已经删除的旧模块/符号精确映射到各自的 canonical
|
||||
归属。`app/application/subscribe.py` 与 `app/application/plugins.py` 都是 V3 重构过程中新增、
|
||||
未形成插件 ABI 的宿主内部聚合文件,主题实现收口后直接删除,不在 manifest 中制造新的兼容债务。
|
||||
|
||||
**依赖方向的核心约束**(由 `tests/test_architecture_dependencies.py` 强制检查):
|
||||
|
||||
| 方向 | 状态 |
|
||||
@@ -155,26 +167,29 @@ flowchart TB
|
||||
| `app/foundation/` | 无状态、无配置、无 I/O 的底层原语:反射/动态导入、加密、DOM、单例、文本、URL、版本比较 | `reflection.py`、`crypto.py`、`singleton.py` |
|
||||
| `app/domain/` | 纯 MoviePilot 业务语义:媒体上下文、识别解析、站点状态解释、磁力语义、NFO 刮削 | `context.py`、`metainfo.py`、`meta/`、`scraper.py` |
|
||||
| `app/runtime/` | 进程级运行机制:配置、事件、完整日志、缓存契约与内存后端、并发、调度、限流、本地化、GC、重启状态 | `config.py`、`events.py`、`log.py`、`cache.py` |
|
||||
| `app/runtime/extensions/` | 模块 / 插件 / 配置化服务 / 托管资源的发现、注册与生命周期适配 | `module_manager.py`、`plugin_manager.py` |
|
||||
| `app/runtime/compat/` | 仅标准库的精确旧导入路由(`app.core/helper/utils/log` → canonical) | `manifest.py`、`imports.py` |
|
||||
| `app/runtime/extensions/` | 模块 / 插件 / 配置化服务 / 托管资源的发现、注册与生命周期适配;旧管理器文件保留稳定 ABI 门面,具体实现拆在主题子包 | `module_manager.py`、`plugin_manager.py`、`plugin/` |
|
||||
| `app/runtime/compat/` | 仅标准库的精确旧模块、包与符号导入路由;不是业务实现,也不是通用 re-export 层 | `manifest.py`、`imports.py` |
|
||||
| `app/adapters/network/` | 通用 HTTP、浏览器、DNS、Cloudflare、IP 传输机制 | `http.py`、`browser.py` |
|
||||
| `app/adapters/cache/` | Redis 与文件缓存的具体实现 | `backends.py`、`redis.py` |
|
||||
| `app/adapters/system/` | OS/文件/进程/stdio/显示/包安装/Rust 加速适配 | `host.py`、`resource.py`、`fsproxy.py` |
|
||||
| `app/adapters/external/` | 命名外部生态:插件市场、CookieCloud、OCR、IP 归属、MP Server、微信加密 | `market.py`、`server.py`、`wechat_crypt.py` |
|
||||
| `app/application/` | 读取配置/持久化状态的聚焦应用服务:识别、过滤、通知、RSS、站点、下载器、媒体服务器、存储、整理规则等 | `recognition.py`、`filter.py`、`rss.py`、`site/` |
|
||||
| `app/application/` | 读取配置/持久化状态的聚焦应用服务:识别、过滤、通知、RSS、站点、下载器、媒体服务器、存储、整理规则等;同一主题拆成子包 | `recognition.py`、`rules.py`、`rss.py`、`site/`、`subscription/`、`plugin/` |
|
||||
| `app/application/subscription/` | 订阅新增、查询、变更、删除、媒体身份与搜索契约 | `write.py`、`contract.py`、`mutation.py`、`delete.py`、`identity.py`、`search.py` |
|
||||
| `app/application/plugin/` | 插件市场、安装、运行时端口、文件夹操作和动态路由用例;具体 FastAPI 路由适配器在 adapters 层 | `catalog.py`、`install.py`、`runtime.py`、`folders.py`、`routes.py` |
|
||||
| `app/application/messaging/` | 消息渲染/路由、命令交互会话、插件按钮回调、Agent 消息桥接 | `message.py`、`router.py`、`agent.py` |
|
||||
| `app/application/security/` | 认证、授权、Cookie、Passkey、OTP/二次认证、SSRF 与 URL/路径安全 | `auth.py`、`url.py`、`twofactor.py` |
|
||||
| `app/chain/` | 跨入口复用的用例编排:订阅、搜索、下载、整理、媒体、消息等 Chain | `subscribe.py`、`search.py`、`transfer.py` |
|
||||
| `app/modules/` | 可插拔后端:下载器、媒体服务器、元数据源、消息渠道、索引器、存储 | `qbittorrent/`、`emby/`、`telegram/`、`themoviedb/` |
|
||||
| `app/db/` | SQLAlchemy 模型(`models/`)与一一对应的数据访问类(`oper/`) | `models/subscribe.py` ↔ `oper/subscribe.py` |
|
||||
| `app/schemas/` | Pydantic 传输模型、枚举(`ModuleType`、`EventType`、`SystemConfigKey` 等) | `types.py`、`context.py` |
|
||||
| `app/api/` | FastAPI 端点、鉴权依赖、统一响应封装 | `apiv1.py`、`endpoints/`、`response.py` |
|
||||
| `app/api/` | FastAPI 主端点、鉴权依赖、统一 `Response` 响应封装;动态插件端点不走此统一包装 | `apiv1.py`、`endpoints/`、`response.py` |
|
||||
| `app/adapters/web/plugin/` | FastAPI 动态插件路由的技术适配:注册/移除、认证依赖、OpenAPI 重建;保留插件原生响应结构 | `routes.py` |
|
||||
| `app/agent/` | AI Agent:编排器、运行时、工具、中间件、LLM、记忆、技能、策略 | `orchestrator.py`、`runtime_loader.py`、`tools/` |
|
||||
| `app/startup/` | 组合根:装配注入、初始化/关停排序、重启策略 | `lifecycle.py`、`modules_initializer.py` |
|
||||
| `app/sdk/` | 面向新插件的稳定导入面(网络、缓存、日志、浏览器等) | `network.py`、`browser.py`、`cache.py` |
|
||||
| `app/sdk/` | 面向新插件的稳定导入面(网络、缓存、日志、浏览器等);`_legacy/` 只承载旧插件行为适配薄门面 | `network.py`、`browser.py`、`cache.py`、`_legacy/` |
|
||||
| `app/monitor/` | 源目录监控 → 触发整理 | `watcher.py`、`dispatcher.py` |
|
||||
| `app/workflow/` | 工作流引擎 | — |
|
||||
| `app/plugins/` | 内置插件宿主目录(插件可访问 `app.core/helper/utils` 旧路径) | — |
|
||||
| `app/plugins/` | 插件运行时副本/覆盖目录,由插件管理器加载;不是官方插件源码或宿主架构实现,架构审计以插件仓库与宿主边界为准 | — |
|
||||
|
||||
---
|
||||
|
||||
@@ -327,7 +342,9 @@ flowchart LR
|
||||
```
|
||||
|
||||
- Oper 只接收和返回持久化值;`MediaInfo` / `MetaBase` 与数据库行之间的转换属于业务逻辑,
|
||||
归 `app/application/`(见 `application/subscribe.py`、`application/history.py`)。
|
||||
归 `app/application/`(见 `application/subscription/write.py`、`application/history.py`)。
|
||||
订阅新增、查询、变更、删除、身份和搜索契约已经统一收口在 `application/subscription/`,
|
||||
不再保留主题包之外的第二个写入入口。
|
||||
- 每次表结构变更必须新增 `database/versions/` 下的 Alembic 迁移。
|
||||
- 运行期业务配置使用 `SystemConfigKey` 枚举 + `SystemConfigOper`,禁止裸字符串键;
|
||||
用户级配置使用 `UserConfigOper`。
|
||||
@@ -370,7 +387,7 @@ sequenceDiagram
|
||||
|
||||
```mermaid
|
||||
flowchart TB
|
||||
A["用户创建订阅<br/>API / 消息 / Agent"] --> B["SubscribeChain<br/>写入订阅(application/subscribe → SubscribeOper)"]
|
||||
A["用户创建订阅<br/>API / 消息 / Agent"] --> B["SubscribeChain<br/>写入订阅(application/subscription/write.py)"]
|
||||
B --> C{"调度器周期触发<br/>SubscribeChain.process"}
|
||||
C --> D["搜索缺失集数<br/>(复用搜索流程)"]
|
||||
D --> E{"命中资源?"}
|
||||
@@ -445,8 +462,10 @@ flowchart TB
|
||||
|
||||
- Chain 访问 Agent 运行时只能经 `app/application/agent.py`;
|
||||
`app/chain/agent.py` 的 `AgentChain` 是链层入口,Agent 实现保持在 `app/agent/`。
|
||||
- Agent 工具不直接 import API / 调度器 / 命令,统一使用
|
||||
`application/plugins.py`、`application/scheduling.py`、`application/commands.py` 三个门面。
|
||||
- Agent 工具不直接 import API / 调度器 / 命令:插件动态路由与文件夹操作使用
|
||||
`application/plugin/routes.py`、`application/plugin/folders.py`,调度和命令分别使用
|
||||
`application/scheduling.py`、`application/commands.py`。FastAPI 具体实现位于
|
||||
`adapters/web/plugin/`,入口层不承载路由实现。
|
||||
- 对外暴露 MCP 端点 `/api/v1/mcp` 与 OpenAI / Anthropic 兼容端点,
|
||||
错误响应在 `app/factory.py` 中按协议原生格式单独处理(不走统一 `Response` 包装)。
|
||||
|
||||
@@ -457,12 +476,12 @@ flowchart TB
|
||||
```mermaid
|
||||
flowchart TB
|
||||
subgraph 插件侧
|
||||
P["app/plugins/*<br/>(含第三方插件)"]
|
||||
P["app/plugins/*<br/>(运行时副本/覆盖层)"]
|
||||
end
|
||||
|
||||
subgraph 宿主边界
|
||||
SDK["app/sdk<br/>新插件稳定导入面<br/>network / cache / logging / browser ..."]
|
||||
Compat["app/runtime/compat<br/>精确旧路径映射 manifest<br/>app.core / app.helper / app.utils / app.log"]
|
||||
Compat["app/runtime/compat<br/>manifest 精确模块/符号映射<br/>app.core / app.helper / app.utils / app.log 及已删除旧路径"]
|
||||
PM["PluginManager<br/>发现 / 生命周期 / 事件桥接"]
|
||||
end
|
||||
|
||||
@@ -474,16 +493,25 @@ flowchart TB
|
||||
P -->|旧插件(DEBUG 下告警)| Compat
|
||||
SDK -->|门面转发| Canonical
|
||||
Compat -.惰性解析.-> SDK
|
||||
Compat -.惰性解析.-> Canonical
|
||||
PM -->|run_plugin 方法分发 / 事件广播| P
|
||||
Canonical -.-|禁止 import| Compat
|
||||
Canonical -.-|禁止 import| SDK
|
||||
```
|
||||
|
||||
- 宿主代码只使用 canonical 路径;只有 `app/plugins/` 与兼容性测试可用旧路径。
|
||||
- `app/plugins/` 是运行时插件副本,不是官方插件仓库的源码副本;它不纳入宿主架构拆分的源代码审计。
|
||||
宿主代码只使用 canonical 路径;只有运行时插件与兼容性测试可用旧路径。
|
||||
- `compat` 只存字符串映射并惰性解析,不得在模块导入期急切 import canonical 实现;
|
||||
canonical 包也不得为兼容而反向 import `compat` / `sdk`。
|
||||
- 插件 API 的动态注册/移除经 `app/application/plugins.py` 完成,
|
||||
FastAPI 实例由组合根(`app/factory.py`)在创建后注入,端点层禁止直接依赖 `factory`。
|
||||
- 插件 API 的动态注册/移除及端口协议统一位于 `app/application/plugin/routes.py`,
|
||||
FastAPI 技术实现位于
|
||||
`app/adapters/web/plugin/routes.py`;FastAPI 实例由组合根(`app/factory.py`)在创建后注入,
|
||||
端点层禁止直接依赖 `factory`。
|
||||
- 动态插件路由使用原生 `APIRoute`,插件自行决定返回结构;主程序的统一 `Response` 封装只适用于
|
||||
`app/api/` 的宿主端点。插件若已经自行返回 `Response`、字典、列表或其它可序列化值,宿主不再二次包裹。
|
||||
- `app/runtime/extensions/plugin_manager.py` 是保留插件 ABI 的管理器门面,发现、加载、生命周期、
|
||||
目录、同步等实现拆在 `app/runtime/extensions/plugin/`;这个“门面 + 实现包”是有意的兼容边界,
|
||||
不应为了目录整齐而让外部插件改用内部实现文件。
|
||||
- 插件可参与 `run_module` 方法分发(同名方法优先响应)并注册事件处理器。
|
||||
|
||||
---
|
||||
@@ -552,6 +580,29 @@ flowchart LR
|
||||
SDK 导出(若公开)、`docs/rules/05-architecture.md` 与上述架构测试。
|
||||
- 延迟导入不被接受为隐藏循环依赖的手段。
|
||||
|
||||
### 10.1 2026-08-18 收口状态与后续边界
|
||||
|
||||
本总览与本轮架构治理的关系如下:
|
||||
|
||||
- 已完成的宿主边界:旧 `app.core` / `app.helper` / `app.utils` / `app.log` 根路径通过
|
||||
`app/runtime/compat/manifest.py` 精确映射;订阅、历史、用户认证等旧 Oper 入口通过
|
||||
`app/sdk/_legacy/` 薄门面保留行为兼容。兼容清单是导入路由,不负责合并模块,也不负责把任意
|
||||
新实现重新导出到旧模块。
|
||||
- 已完成的插件边界:插件 API 的动态路由由 application 端口 + web adapter 组成,使用原生
|
||||
`APIRoute` 保留插件响应;插件管理器保留 `plugin_manager.py` 的稳定 ABI,内部实现拆在
|
||||
`runtime/extensions/plugin/`;`app/plugins/` 仅作为运行时插件副本/覆盖层处理。
|
||||
- 已完成的主题收口:订阅写入归入 `app/application/subscription/write.py`;插件动态路由与
|
||||
文件夹操作归入 `app/application/plugin/routes.py`、`folders.py`。原
|
||||
`app/application/subscribe.py`、`app/application/plugins.py` 未形成插件 ABI,已经直接删除,
|
||||
宿主调用统一改为 canonical 路径。
|
||||
- 判断是否需要新增 manifest 映射的标准:只有当旧物理模块被删除、改名或公开符号迁移时才登记;
|
||||
物理文件仍是稳定入口的,不应为了目录规整新增“自己映射自己”的别名,也不应在 canonical 包中
|
||||
保留多余导出。
|
||||
|
||||
详细的迁移批次、风险、验证命令和插件兼容矩阵见
|
||||
[`docs/refactor/backend-architecture-governance.md`](refactor/backend-architecture-governance.md) 与
|
||||
[`docs/refactor/backend-module-refactor-compatibility.md`](refactor/backend-module-refactor-compatibility.md)。
|
||||
|
||||
---
|
||||
|
||||
## 附录:相关文档索引
|
||||
@@ -566,3 +617,5 @@ flowchart LR
|
||||
| [`docs/rules/10-data-and-persistent.md`](rules/10-data-and-persistent.md) | 数据模型、迁移与缓存规范 |
|
||||
| [`docs/subscribe-lifecycle.md`](subscribe-lifecycle.md) | 订阅生命周期详解 |
|
||||
| [`docs/mcp-api.md`](mcp-api.md) | MCP 工具端点说明 |
|
||||
| [`docs/refactor/backend-architecture-governance.md`](refactor/backend-architecture-governance.md) | 分阶段架构治理、边界门禁与迁移验收 |
|
||||
| [`docs/refactor/backend-module-refactor-compatibility.md`](refactor/backend-module-refactor-compatibility.md) | 模块迁移与插件兼容层实施矩阵 |
|
||||
|
||||
+24
-22
@@ -3,7 +3,7 @@
|
||||
> 文档性质:现状审计、目标约束、迁移路线和 AI 实施手册
|
||||
> 适用仓库:`MoviePilot`,分支 `v3`
|
||||
> 审计基线:2026-08-18 当前工作树
|
||||
> 相关规范:`AGENTS.md`、`docs/rules/05-architecture.md`、`docs/architecture-overview.md`、`docs/backend-module-refactor-compatibility.md`
|
||||
> 相关规范:`AGENTS.md`、`docs/rules/05-architecture.md`、`docs/architecture-overview.md`、`docs/refactor/backend-module-refactor-compatibility.md`
|
||||
|
||||
## 1. 文档目的
|
||||
|
||||
@@ -25,7 +25,8 @@
|
||||
3. `PluginManager` 的加载、生命周期、注册表、投影、存储、目录、路径、同步、依赖、克隆和文件监控分别由 `app/runtime/extensions/plugin/` 下的单职责组件承担;旧管理器只保留 V3 ABI 门面和兼容调用顺序。
|
||||
4. 动态插件 API 使用专用 raw 路由;主程序统一响应信封不进入插件 `get_api()`。前端 `pluginApi` 对非 `Response` envelope 的 payload 原样交付调用方。
|
||||
5. 旧插件导入仅由 `app/runtime/compat/manifest.py` 精确映射;canonical 模块不复制旧 Manager/Helper/Oper 导出。`app/plugins/` 仍是运行时副本,继续排除在宿主架构扫描之外。
|
||||
6. 当前机器基线为 746 个宿主 Python 模块、6,021 条内部导入边;数据库边界、Adapter→DB、Runtime→DB、Application→DB 及新增 API/Agent/Chain 目标边均为 0。架构门禁、插件兼容快照和基线脚本均已重新生成。
|
||||
6. 当前机器基线为 746 个宿主 Python 模块、6,024 条内部导入边;数据库边界、Adapter→DB、Runtime→DB、Application→DB 及新增 API/Agent/Chain 目标边均为 0。架构门禁、插件兼容快照和基线脚本均已重新生成。
|
||||
7. 订阅写入统一归入 `app/application/subscription/write.py`;插件动态路由和文件夹操作统一归入 `app/application/plugin/routes.py`、`folders.py`。重构期间新增且未形成插件 ABI 的 `app/application/subscribe.py`、`app/application/plugins.py` 已直接删除,不进入 compat manifest。
|
||||
|
||||
## 2. 范围与明确排除项
|
||||
|
||||
@@ -98,7 +99,7 @@ MoviePilot V3 已经完成一轮重要基础工作:原 `app/core`、`app/helpe
|
||||
|
||||
### 4.3 模块规模
|
||||
|
||||
排除 `app/plugins/` 后,当前静态扫描得到 746 个 Python 模块、6,021 条内部导入边。主要一级目录规模如下(代码行数包含注释和空行,用于趋势比较而非质量评分):
|
||||
排除 `app/plugins/` 后,当前静态扫描得到 746 个 Python 模块、6,024 条内部导入边。主要一级目录规模如下(代码行数包含注释和空行,用于趋势比较而非质量评分):
|
||||
|
||||
| 一级目录 | 约代码行数 | Python 文件数 | 判断 |
|
||||
| --- | ---: | ---: | --- |
|
||||
@@ -147,7 +148,7 @@ MoviePilot V3 已经完成一轮重要基础工作:原 `app/core`、`app/helpe
|
||||
| 指标 | 初始审计 | 当前基线 | 说明 |
|
||||
| --- | ---: | ---: | --- |
|
||||
| Python 模块数 | 约 654 | 746 | 增量来自单一职责的 Application、Runtime、Adapter、插件组件和维护用例模块 |
|
||||
| 内部导入边 | 约 5,623 | 6,021 | 显式端口增加模块数但移除了反向边;边数不作为单独质量目标 |
|
||||
| 内部导入边 | 约 5,623 | 6,024 | 显式端口增加模块数但移除了反向边;边数不作为单独质量目标 |
|
||||
| SCC 数 | 14 | 1 | 自有代码 SCC 已归零,仅保留 TMDB 移植包内部隔离例外 |
|
||||
| `adapters -> db` | 存在 | 0 | `PluginHelper`、`MoviePilotServerHelper` 的本地数据读取已移到组合根/Application |
|
||||
| `runtime -> db` | 存在 | 0 | 插件存储、服务配置均改为启动注入 |
|
||||
@@ -324,25 +325,24 @@ app/chain/__init__.py # 保留 ChainBase 兼容门面
|
||||
4. 原 Facade 的参数默认值、返回类型、事件时机和消息副作用必须保持。
|
||||
5. 不为了缩短文件把相互调用的方法机械分散到多个 `helper.py`。
|
||||
|
||||
#### 建议的订阅拆分
|
||||
#### 已落地的订阅应用拆分
|
||||
|
||||
```text
|
||||
app/domain/subscription/
|
||||
identity.py # 订阅媒体键、稳定身份和纯比较
|
||||
matching.py # 不访问 DB/网络的匹配规则
|
||||
completion.py # 完整性与完成判定
|
||||
|
||||
app/application/subscription/
|
||||
commands.py # 新增、修改、删除、完成
|
||||
queries.py # 可见性和订阅读取
|
||||
recognition.py # 通过端口恢复媒体信息
|
||||
search.py # 搜索用例协调
|
||||
ports.py # Repository、Search、Recognition、Event 等协议
|
||||
write.py # 新增订阅、媒体翻译和写入端口
|
||||
query.py # 存在性、来源定位和公开查询
|
||||
mutation.py # 更新、重置和历史删除
|
||||
delete.py # 单条删除与事务端口
|
||||
identity.py # 按媒体身份批量删除
|
||||
search.py # 手工搜索调度
|
||||
contract.py # Chain 共用的媒体元数据与媒体键契约
|
||||
|
||||
app/chain/subscribe.py # V3 Facade,继续暴露 SubscribeChain 与旧辅助符号
|
||||
```
|
||||
|
||||
`app/application/subscribe.py` 已经承担订阅写入翻译,可先作为新目录的入口门面,或保留并转发到新服务。不能同时出现同名文件和包;若最终改为包,必须在一个原子批次中完成,并验证 `app.application.subscribe` 的所有导入。
|
||||
`app/application/subscribe.py` 是 V3 重构期间新增的内部过渡文件,插件仓与运行时插件均无导入;
|
||||
在宿主、测试和旧 `app.db.subscribe_oper` 行为适配切换到 `subscription/write.py` 后直接删除,
|
||||
不保留门面,也不在 `manifest.py` 中新增没有历史消费者的映射。
|
||||
|
||||
#### 建议的整理拆分
|
||||
|
||||
@@ -541,7 +541,7 @@ app/domain/events/ # 逐步增加 Typed payload,不承载总
|
||||
|
||||
#### 动态插件 API 的 P0 兼容冲突
|
||||
|
||||
这是治理前发现并已完成的 P0 兼容修复。主应用仍使用 `ResponseAPIRoute`,但 `app/adapters/web/plugin/routes.py` 在动态插件注册时显式使用原生 `APIRoute`;`app/application/plugin/routes.py` 只定义 `DynamicRouteRegistry` 端口。因此插件 `get_api()` 返回的 dict、Pydantic model、原生 `Response`、文件/流响应和自定义状态码均不进入主 API envelope。前端 `pluginApi` 也只在检测到严格 `Response` envelope 时解包,否则原样交付。
|
||||
这是治理前发现并已完成的 P0 兼容修复。主应用仍使用 `ResponseAPIRoute`,但 `app/adapters/web/plugin/routes.py` 在动态插件注册时显式使用原生 `APIRoute`;`app/application/plugin/routes.py` 定义 `DynamicRouteRegistry` 端口并承载注册/移除用例,不依赖 FastAPI。因此插件 `get_api()` 返回的 dict、Pydantic model、原生 `Response`、文件/流响应和自定义状态码均不进入主 API envelope。前端 `pluginApi` 也只在检测到严格 `Response` envelope 时解包,否则原样交付。
|
||||
|
||||
真实运行验证已覆盖:官方 V3 `TvdbDiscover` 插件加载后生成 `/api/v1/plugin/TvdbDiscover/tvdb_discover` 动态路由,未认证请求返回插件路由自己的认证错误体而非主 API 404/统一路由包装;对应 route class、raw 响应和前端 pass-through 均有测试。
|
||||
|
||||
@@ -578,7 +578,8 @@ app/runtime/extensions/plugin/projection.py # commands/apis/services/modules/
|
||||
app/runtime/extensions/plugin/storage.py # 运行时持久化窄端口
|
||||
app/application/plugin/catalog.py # 市场目录查询、代际合并和来源去重
|
||||
app/application/plugin/install.py # 安装用例与阶段结果
|
||||
app/application/plugin/routes.py # 动态 API 注册端口
|
||||
app/application/plugin/routes.py # 动态 API 注册端口与用例
|
||||
app/application/plugin/folders.py # 插件文件夹清理用例
|
||||
```
|
||||
|
||||
#### 插件钩子契约
|
||||
@@ -701,7 +702,7 @@ app/application/server/share.py # 订阅/工作流等分享用例
|
||||
#### 典型证据
|
||||
|
||||
- `app/application/messaging/skill.py` 通过 `SkillCatalogPort` 消费技能目录,`app.startup.agent_initializer` 才导入并注入 `SkillHelper`。
|
||||
- `app/application/plugins.py` 只持有 `DynamicRouteRegistry` Protocol;FastAPI app、`app.routes`、`openapi_schema` 和 `setup()` 均封装在 `app/adapters/web/plugin/routes.py`。
|
||||
- `app/application/plugin/routes.py` 持有 `DynamicRouteRegistry` Protocol 和注册/移除用例;FastAPI app、`app.routes`、`openapi_schema` 和 `setup()` 均封装在 `app/adapters/web/plugin/routes.py`。
|
||||
- 多个 `modules` 直接导入 `app.application.messaging.agent`、`mediaserver`、`storage` 等;其中一部分是合理 SPI 消费,一部分表明应用能力接口和具体实现未区分。
|
||||
- `SystemConfigOper()` 在大量文件中被直接构造,形成持久化配置服务定位器。
|
||||
|
||||
@@ -1120,7 +1121,8 @@ startup 注入具体依赖
|
||||
| 插件配置和数据持久化 | `app/runtime/extensions/plugin/storage.py` | 启动层用 `SystemConfigOper`、`PluginDataOper` 注入;Runtime 不导入 Oper |
|
||||
| 市场目录和版本/来源合并 | `app/application/plugin/catalog.py` | `PluginManager.get_online_plugins()` 等公开方法经启动注入的目录工厂委托 |
|
||||
| 插件安装阶段编排 | `app/application/plugin/install.py` | API 和 Agent 共用命令;旧管理器/Helper 安装入口保留 |
|
||||
| 动态插件路由 | `app/application/plugin/routes.py` + `app/adapters/web/plugin/routes.py` | `app/application/plugins.py` 保留旧 Facade;插件响应默认 raw |
|
||||
| 动态插件路由 | `app/application/plugin/routes.py` + `app/adapters/web/plugin/routes.py` | 过渡聚合文件无插件 ABI,已删除;插件响应默认 raw |
|
||||
| 插件文件夹清理 | `app/application/plugin/folders.py` | API 与 Agent 直接调用 canonical 用例,兼容新旧配置存储形态 |
|
||||
| 市场读取 | `app/adapters/external/plugin/client.py` | `app.adapters.external.market.PluginHelper` 保留正式公共实现路径 |
|
||||
| 包与依赖安装 | `app/adapters/system/plugin/package.py`、`dependency.py` | PluginManager 原方法只做委托和日志/上报 |
|
||||
| 中心服务统计/分享 | `app/application/server/report.py`、`share.py` | `MoviePilotServerHelper` 保留 transport 和公开静态/类方法,由启动层注入用例 |
|
||||
@@ -1196,7 +1198,7 @@ startup 注入具体依赖
|
||||
|
||||
### 任务 A:插件动态 API raw 契约
|
||||
|
||||
**范围**:`app/application/plugins.py`、`app/api/response.py`、`app/factory.py`、对应测试。
|
||||
**范围**:`app/application/plugin/routes.py`、`app/adapters/web/plugin/routes.py`、`app/api/response.py`、`app/factory.py`、对应测试。
|
||||
**目标**:主 API 统一信封,插件动态 API 默认自由返回。
|
||||
**禁止**:修改插件副本、修改普通 API 响应格式、修改鉴权默认值。
|
||||
**验证**:dict、Pydantic model、Response、StreamingResponse、204、自定义状态码、OpenAPI。
|
||||
@@ -1359,7 +1361,7 @@ done_when: []
|
||||
| 范围 | 命令 | 结果 |
|
||||
| --- | --- | --- |
|
||||
| 后端完整门禁 | `./.venv/bin/python tests/run.py` | 4,914 passed、2 failed、3 skipped(2026-08-18);失败为未修改的 Agent 图片能力测试,架构专项不受影响 |
|
||||
| 架构与插件快照 | `./.venv/bin/python scripts/architecture/baseline.py --check --plugin-repo ../MoviePilot-Plugins` | 已通过,基线已更新为 746 模块 / 6,021 边 |
|
||||
| 架构与插件快照 | `./.venv/bin/python scripts/architecture/baseline.py --check --plugin-repo ../MoviePilot-Plugins` | 已通过,基线已更新为 746 模块 / 6,024 边 |
|
||||
| 前端联邦 API 客户端 | `yarn test:run src/api/__tests__/client.spec.ts src/api/__tests__/index.spec.ts` | 36 passed |
|
||||
| 前端类型检查 | `yarn typecheck` | 通过 |
|
||||
| V3 插件契约与版本门禁 | `../MoviePilot/.venv/bin/python -m pytest tests/ci/test_v3_contract.py tests/ci/test_plugin_release_gate.py -q` | 16 passed |
|
||||
@@ -61,12 +61,12 @@ to make the directory tree look symmetrical.
|
||||
| Path | Ownership |
|
||||
|---|---|
|
||||
| `app/application/*.py` | Established single-module application services and compatibility facades |
|
||||
| `app/application/subscription/` | Subscription contracts and write commands: `contract.py` owns shared metadata/media-key projection; `delete.py` and `identity.py` own deletion use cases |
|
||||
| `app/application/subscription/` | Subscription use cases: `write.py` owns media-to-row translation and the write port; `contract.py` owns shared metadata/media-key projection; query, mutation, deletion, identity and search stay in their single-word modules |
|
||||
| `app/application/search/` | Search state and later search-plan use cases |
|
||||
| `app/application/download/` | Download task querying/control and later submission use cases |
|
||||
| `app/application/music/` | Multi-source music catalog orchestration |
|
||||
| `app/application/chain/` | Injectable Chain runtime context and compatibility provider |
|
||||
| `app/application/plugin/` | Plugin market catalog, installation command and dynamic-route port; filenames remain single words (`catalog.py`, `install.py`, `routes.py`) |
|
||||
| `app/application/plugin/` | Plugin market catalog, installation command, runtime port, folder operations and dynamic-route use cases; filenames remain single words (`catalog.py`, `install.py`, `runtime.py`, `folders.py`, `routes.py`) |
|
||||
| `app/application/server/` | MoviePilot Server reporting and sharing use cases; local data readers and transport callbacks are injected by startup |
|
||||
| `app/application/site/` | Configured site catalog, authentication level and index-resource capability; the generated extension and its data bundle stay together here |
|
||||
| `app/application/messaging/` | Message rendering/routing, interactions and the Agent-to-message bridge: `interaction.py` shared interaction contracts and view helpers; `router.py` unified interaction priority and callback dispatch; `site.py`/`subscribe.py`/`skill.py` per-command sessions, input parsing and views; `media.py` media interaction state while the business workflow stays in `MediaInteractionChain`; `plugin.py` plugin input capture and plugin button callbacks; `agent.py` agent choice state, callback protocol and WebAgent bridge; `message.py` notification rendering, templates and queue. Not a public SDK recommended for direct plugin use |
|
||||
@@ -345,7 +345,7 @@ requires an Alembic migration under `database/versions/`.
|
||||
|
||||
Oper classes take and return persistence values, not domain objects. Translating
|
||||
`MediaInfo` / `MetaBase` into a row is business logic and belongs in
|
||||
`app/application/` — see `application/subscribe.py` and `application/history.py`
|
||||
`app/application/` — see `application/subscription/write.py` and `application/history.py`
|
||||
for the two write paths. Column-type coercion (numeric year to string, boolean
|
||||
switches to integers) stays in the Oper because it follows the column, not the
|
||||
caller.
|
||||
@@ -396,8 +396,8 @@ policy. `app/db` therefore has no dependency on `app/domain`.
|
||||
| `entrypoint -> chain / application / Oper` | Allowed according to workflow complexity |
|
||||
| `chain -> module (only via run_module dispatch) / application / Oper / canonical capability` | Allowed; direct `chain -> module` imports forbidden |
|
||||
| `chain -> agent implementation` | Forbidden; chains reach Agent runtime only through `app/application/agent.py`; `app/startup/agent_initializer.py` registers lightweight providers at import time, and implementations are materialized only when the capability is enabled or first used |
|
||||
| `agent.tools -> api / scheduler / command` | Forbidden; tools use `app/application/plugins.py`, `scheduling.py` and `commands.py` facades |
|
||||
| `api -> factory` | Forbidden; the FastAPI instance is injected into `app/application/plugins.py` by the composition root after creation |
|
||||
| `agent.tools -> api / scheduler / command` | Forbidden; tools use `app/application/plugin/routes.py`, `plugin/folders.py`, `scheduling.py` and `commands.py` application services |
|
||||
| `api -> factory` | Forbidden; the FastAPI route adapter is injected into `app/application/plugin/routes.py` by the composition root after creation |
|
||||
| `application -> domain / runtime / adapter / Oper` | Allowed |
|
||||
| `module -> canonical capability / Oper` | Allowed |
|
||||
| `module -> module / chain` | Forbidden for new code |
|
||||
@@ -414,7 +414,7 @@ policy. `app/db` therefore has no dependency on `app/domain`.
|
||||
|---|---|
|
||||
| `app/application/agent.py` | Agent orchestration facade (`get_agent_manager` / `get_prompt_manager` / capability queries / prompt builders); lightweight providers register through `app/startup/agent_initializer.py`, with no static `application -> agent` edge |
|
||||
| `app/agent/runtime_loader.py` | Agent-specific capability discovery and canonical entrypoint/service materialization; reuses the generic Capability Runtime while keeping Agent ownership under `app/agent/` |
|
||||
| `app/application/plugins.py` | Plugin API dynamic route registration/removal; the FastAPI instance is injected by `app/factory.py` after creation |
|
||||
| `app/application/subscription/write.py` | Subscription media translation and sync/async write-port orchestration |
|
||||
| `app/application/scheduling.py` | Runtime scheduler facade for Agent tools and endpoints; `Scheduler` class registered by `app/startup/scheduler_initializer.py` |
|
||||
| `app/application/commands.py` | Command registry facade for Agent tools and endpoints; `Command` class registered by `app/startup/command_initializer.py` |
|
||||
| `app/chain/agent.py` | `AgentChain(ChainBase)`: the chain-layer entry for Agent sessions; Agent runtime stays in `app/agent/` |
|
||||
@@ -435,7 +435,8 @@ policy. `app/db` therefore has no dependency on `app/domain`.
|
||||
| `app/runtime/extensions/plugin/storage.py` | Injected plugin configuration/data persistence port; runtime code does not import DB Oper classes |
|
||||
| `app/application/plugin/catalog.py` | Plugin-market mapping, concurrent collection, generation merge and source/version deduplication |
|
||||
| `app/application/plugin/install.py` | Compatibility, package installation, reporting, installed-list persistence and runtime reload command |
|
||||
| `app/application/plugin/routes.py` | Dynamic plugin-route registry protocol; plugin response payloads remain raw unless the plugin chooses its own envelope |
|
||||
| `app/application/plugin/routes.py` | Dynamic plugin-route registry protocol and registration/removal use cases; plugin response payloads remain raw unless the plugin chooses its own envelope |
|
||||
| `app/application/plugin/folders.py` | Plugin-folder cleanup use case, compatible with current dictionary and legacy list storage shapes |
|
||||
| `app/application/plugin/runtime.py` | Plugin runtime port consumed by API, Agent and Workflow; the concrete `PluginManager` is registered only by startup |
|
||||
| `app/application/module.py` | Host module runtime port consumed by entrypoints; the concrete `ModuleManager` is registered only by startup |
|
||||
| `app/application/scheduling.py` | Scheduler runtime port consumed by API/Agent/application commands |
|
||||
|
||||
Reference in New Issue
Block a user