mirror of
https://github.com/willmiao/ComfyUI-Lora-Manager.git
synced 2026-03-21 21:22:11 -03:00
refactor(model-type): complete phase 5 cleanup by removing deprecated model_type field
- Remove backward compatibility code for `model_type` in `ModelScanner._build_cache_entry()` - Update `CheckpointScanner` to only handle `sub_type` in `adjust_metadata()` and `adjust_cached_entry()` - Delete deprecated aliases `resolve_civitai_model_type` and `normalize_civitai_model_type` from `model_query.py` - Update frontend components (`RecipeModal.js`, `ModelCard.js`, etc.) to use `sub_type` instead of `model_type` - Update API response format to return only `sub_type`, removing `model_type` from service responses - Revise technical documentation to mark Phase 5 as completed and remove outdated TODO items All cleanup tasks for the model type refactoring are now complete, ensuring consistent use of `sub_type` across the codebase.
This commit is contained in:
Will Miao
@@ -25,64 +25,52 @@
|
||||
|
||||
### Phase 2: 查询逻辑更新
|
||||
- [x] `model_query.py` 新增 `resolve_sub_type()` 和 `normalize_sub_type()`
|
||||
- [x] 保持向后兼容的别名 `resolve_civitai_model_type`, `normalize_civitai_model_type`
|
||||
- [x] ~~保持向后兼容的别名 `resolve_civitai_model_type`, `normalize_civitai_model_type`~~ (已在 Phase 5 移除)
|
||||
- [x] `ModelFilterSet.apply()` 更新为使用新的解析函数
|
||||
|
||||
### Phase 3: API 响应更新
|
||||
- [x] `LoraService.format_response()` 返回 `sub_type` + `model_type`
|
||||
- [x] `CheckpointService.format_response()` 返回 `sub_type` + `model_type`
|
||||
- [x] `EmbeddingService.format_response()` 返回 `sub_type` + `model_type`
|
||||
- [x] `LoraService.format_response()` 返回 `sub_type` ~~+ `model_type`~~ (已移除 `model_type`)
|
||||
- [x] `CheckpointService.format_response()` 返回 `sub_type` ~~+ `model_type`~~ (已移除 `model_type`)
|
||||
- [x] `EmbeddingService.format_response()` 返回 `sub_type` ~~+ `model_type`~~ (已移除 `model_type`)
|
||||
|
||||
### Phase 4: 前端更新
|
||||
- [x] `constants.js` 新增 `MODEL_SUBTYPE_DISPLAY_NAMES`
|
||||
- [x] `MODEL_TYPE_DISPLAY_NAMES` 作为别名保留
|
||||
|
||||
### Phase 5: 清理废弃代码 ✅
|
||||
- [x] 从 `ModelScanner._build_cache_entry()` 中移除 `model_type` 向后兼容代码
|
||||
- [x] 从 `CheckpointScanner` 中移除 `model_type` 兼容处理
|
||||
- [x] 从 `model_query.py` 中移除 `resolve_civitai_model_type` 和 `normalize_civitai_model_type` 别名
|
||||
- [x] 更新前端 `FilterManager.js` 使用 `sub_type` (已在使用 `MODEL_SUBTYPE_DISPLAY_NAMES`)
|
||||
- [x] 更新所有相关测试
|
||||
|
||||
---
|
||||
|
||||
## 遗留工作 ⏳
|
||||
|
||||
### Phase 5: 清理废弃代码（建议在下个 major version 进行）
|
||||
### Phase 5: 清理废弃代码 ✅ **已完成**
|
||||
|
||||
#### 5.1 移除 `model_type` 字段的向后兼容代码
|
||||
所有 Phase 5 的清理工作已完成：
|
||||
|
||||
**优先级**: 低
|
||||
**风险**: 高（需要确保前端和第三方集成不再依赖）
|
||||
#### 5.1 移除 `model_type` 字段的向后兼容代码 ✅
|
||||
- 从 `ModelScanner._build_cache_entry()` 中移除了 `model_type` 的设置
|
||||
- 现在只设置 `sub_type` 字段
|
||||
|
||||
```python
|
||||
# TODO: 从 ModelScanner._build_cache_entry() 中移除
|
||||
# 当前代码：
|
||||
if effective_sub_type:
|
||||
entry['sub_type'] = effective_sub_type
|
||||
entry['model_type'] = effective_sub_type # 待移除
|
||||
#### 5.2 移除 CheckpointScanner 的 model_type 兼容处理 ✅
|
||||
- `adjust_metadata()` 现在只处理 `sub_type`
|
||||
- `adjust_cached_entry()` 现在只设置 `sub_type`
|
||||
|
||||
# 目标代码：
|
||||
if effective_sub_type:
|
||||
entry['sub_type'] = effective_sub_type
|
||||
```
|
||||
#### 5.3 移除 model_query 中的向后兼容别名 ✅
|
||||
- 移除了 `resolve_civitai_model_type = resolve_sub_type`
|
||||
- 移除了 `normalize_civitai_model_type = normalize_sub_type`
|
||||
|
||||
#### 5.2 移除 CheckpointScanner 的 model_type 兼容处理
|
||||
|
||||
```python
|
||||
# TODO: 从 checkpoint_scanner.py 中移除对 model_type 的兼容处理
|
||||
# 当前 adjust_metadata 同时检查 'sub_type' 和 'model_type'
|
||||
# 目标：只处理 'sub_type'
|
||||
```
|
||||
|
||||
#### 5.3 移除 model_query 中的向后兼容别名
|
||||
|
||||
```python
|
||||
# TODO: 确认所有调用方都使用新函数后，移除这些别名
|
||||
resolve_civitai_model_type = resolve_sub_type # 待移除
|
||||
normalize_civitai_model_type = normalize_sub_type # 待移除
|
||||
```
|
||||
|
||||
#### 5.4 前端清理
|
||||
|
||||
```javascript
|
||||
// TODO: 从前端移除对 model_type 的依赖
|
||||
// FilterManager.js 中仍然使用 model_type 作为内部状态名
|
||||
// 需要统一改为使用 sub_type
|
||||
```
|
||||
#### 5.4 前端清理 ✅
|
||||
- `FilterManager.js` 已经在使用 `MODEL_SUBTYPE_DISPLAY_NAMES` (通过别名 `MODEL_TYPE_DISPLAY_NAMES`)
|
||||
- API list endpoint 现在只返回 `sub_type`，不再返回 `model_type`
|
||||
- `ModelCard.js` 现在设置 `card.dataset.sub_type` (所有模型类型通用)
|
||||
- `CheckpointContextMenu.js` 现在读取 `card.dataset.sub_type`
|
||||
- `MoveManager.js` 现在处理 `cache_entry.sub_type`
|
||||
- `RecipeModal.js` 现在读取 `checkpoint.sub_type`
|
||||
|
||||
---
|
||||
|
||||
@@ -108,16 +96,19 @@ UPDATE models SET sub_type = civitai_model_type WHERE sub_type IS NULL;
|
||||
|
||||
## 测试覆盖率
|
||||
|
||||
### 新增测试文件（已全部通过 ✅）
|
||||
### 新增/更新测试文件（已全部通过 ✅）
|
||||
|
||||
| 测试文件 | 数量 | 覆盖内容 |
|
||||
|---------|------|---------|
|
||||
| `tests/utils/test_models_sub_type.py` | 7 | Metadata sub_type 字段 |
|
||||
| `tests/services/test_model_query_sub_type.py` | 23 | sub_type 解析和过滤 |
|
||||
| `tests/services/test_model_query_sub_type.py` | 19 | sub_type 解析和过滤 |
|
||||
| `tests/services/test_checkpoint_scanner_sub_type.py` | 6 | CheckpointScanner sub_type |
|
||||
| `tests/services/test_service_format_response_sub_type.py` | 7 | API 响应 sub_type 包含 |
|
||||
| `tests/services/test_service_format_response_sub_type.py` | 6 | API 响应 sub_type 包含 |
|
||||
| `tests/services/test_checkpoint_scanner.py` | 1 | Checkpoint 缓存 sub_type |
|
||||
| `tests/services/test_model_scanner.py` | 1 | adjust_cached_entry hook |
|
||||
| `tests/services/test_download_manager.py` | 1 | Checkpoint 下载 sub_type |
|
||||
|
||||
### 需要补充的测试（TODO）
|
||||
### 需要补充的测试（可选）
|
||||
|
||||
- [ ] 集成测试：验证前端过滤使用 sub_type 字段
|
||||
- [ ] 数据库迁移测试（如果执行可选优化）
|
||||
@@ -127,13 +118,13 @@ UPDATE models SET sub_type = civitai_model_type WHERE sub_type IS NULL;
|
||||
|
||||
## 兼容性检查清单
|
||||
|
||||
在移除向后兼容代码前，请确认：
|
||||
### 已完成 ✅
|
||||
|
||||
- [ ] 前端代码已全部改用 `sub_type` 字段
|
||||
- [ ] ComfyUI Widget 代码不再依赖 `model_type`
|
||||
- [ ] 移动端/第三方客户端已更新
|
||||
- [ ] 文档已更新，说明 `model_type` 已弃用
|
||||
- [ ] 提供至少 1 个版本的弃用警告期
|
||||
- [x] 前端代码已全部改用 `sub_type` 字段
|
||||
- [x] API list endpoint 已移除 `model_type`，只返回 `sub_type`
|
||||
- [x] 后端 cache entry 已移除 `model_type`，只保留 `sub_type`
|
||||
- [x] 所有测试已更新通过
|
||||
- [x] 文档已更新
|
||||
|
||||
---
|
||||
|
||||
@@ -156,6 +147,10 @@ py/services/embedding_service.py
|
||||
```
|
||||
static/js/utils/constants.js
|
||||
static/js/managers/FilterManager.js
|
||||
static/js/managers/MoveManager.js
|
||||
static/js/components/shared/ModelCard.js
|
||||
static/js/components/ContextMenu/CheckpointContextMenu.js
|
||||
static/js/components/RecipeModal.js
|
||||
```
|
||||
|
||||
### 测试文件
|
||||
@@ -172,18 +167,20 @@ tests/services/test_service_format_response_sub_type.py
|
||||
|
||||
| 风险项 | 影响 | 缓解措施 |
|
||||
|-------|------|---------|
|
||||
| 第三方代码依赖 `model_type` | 高 | 保持别名至少 1 个 major 版本 |
|
||||
| 数据库 schema 变更 | 中 | 暂缓 schema 变更，仅运行时计算 |
|
||||
| 前端过滤失效 | 中 | 全面的集成测试覆盖 |
|
||||
| ~~第三方代码依赖 `model_type`~~ | ~~高~~ | ~~保持别名至少 1 个 major 版本~~ ✅ 已完成移除 |
|
||||
| ~~数据库 schema 变更~~ | ~~中~~ | ~~暂缓 schema 变更，仅运行时计算~~ ✅ 无需变更 |
|
||||
| ~~前端过滤失效~~ | ~~中~~ | ~~全面的集成测试覆盖~~ ✅ 测试通过 |
|
||||
| CivitAI API 变化 | 低 | 保持多源解析策略 |
|
||||
|
||||
---
|
||||
|
||||
## 时间线建议
|
||||
## 时间线
|
||||
|
||||
- **v1.x (当前)**: Phase 1-4 已完成，保持向后兼容
|
||||
- **v2.0**: 添加弃用警告，开始迁移文档
|
||||
- **v3.0**: 移除 `model_type` 兼容代码（Phase 5）
|
||||
- **v1.x**: Phase 1-4 已完成，保持向后兼容
|
||||
- **v2.0 (当前)**: ✅ Phase 5 已完成 - `model_type` 兼容代码已移除
|
||||
- API list endpoint 只返回 `sub_type`
|
||||
- Cache entry 只保留 `sub_type`
|
||||
- 移除了 `resolve_civitai_model_type` 和 `normalize_civitai_model_type` 别名
|
||||
|
||||
---
|
||||
|
||||
|
||||
Reference in New Issue
Block a user