收口 P2 前预加载边界并补需求文档
This commit is contained in:
184
docs/reviews/p2-precheck-fifth-review.md
Normal file
184
docs/reviews/p2-precheck-fifth-review.md
Normal file
@@ -0,0 +1,184 @@
|
||||
# FlowScope P2 前第五轮复审意见
|
||||
|
||||
日期:2026-05-21
|
||||
审查对象:当前工作树中 `UIPreloadService` 与 `UIPreloadServiceTests` 的未提交修改
|
||||
审查范围:`ReleaseAll()` 后新旧 in-flight preload 隔离、旧任务完成清理、相关 PlayMode 测试、generated csproj 编译状态。
|
||||
审查结论:第四轮指出的 P1 gate 已收口;当前没有发现新的 P2 阻塞级问题。剩余主要是 `Release<TPanel>()` 与 `ReleaseAll()` 的 in-flight 语义不完全一致,可作为 P2 前小修或 P2 内 API polish。
|
||||
|
||||
---
|
||||
|
||||
## 本轮确认已收口
|
||||
|
||||
### 1. `ReleaseAll()` 后旧 in-flight 与新 preload 已隔离
|
||||
|
||||
相关文件:
|
||||
|
||||
- `My project/Assets/FlowScope/Runtime/UI/UIPreloadService.cs`
|
||||
- `My project/Assets/FlowScope/Tests/PlayMode/UI/UIPreloadServiceTests.cs`
|
||||
|
||||
当前 `PreloadAsync` 在发现已有 in-flight 但 generation 过期时,会创建新的 `InFlightPreload`:
|
||||
|
||||
```csharp
|
||||
if (!_inFlightLoads.TryGetValue(panelType, out inFlightLoad) ||
|
||||
inFlightLoad.ReleaseGeneration != _releaseGeneration)
|
||||
{
|
||||
var attribute = UIManager.GetPanelAttribute(panelType);
|
||||
path = UIManager.ResolvePath(panelType, attribute);
|
||||
inFlightLoad = new InFlightPreload();
|
||||
inFlightLoad.ReleaseGeneration = _releaseGeneration;
|
||||
_inFlightLoads[panelType] = inFlightLoad;
|
||||
startLoad = true;
|
||||
}
|
||||
```
|
||||
|
||||
评价:上一轮指出的“ReleaseAll 后、旧 load 完成前再次 preload 同一 panel 会复用旧任务并最终不缓存”的问题已经修正。
|
||||
|
||||
---
|
||||
|
||||
### 2. 旧 in-flight 完成时不会误删新 in-flight
|
||||
|
||||
当前 `LoadAndStoreAsync` 不再直接 `_inFlightLoads.Remove(panelType)`,而是只移除当前任务对应的 in-flight:
|
||||
|
||||
```csharp
|
||||
private void ForgetInFlightLoad(Type panelType, InFlightPreload inFlightLoad)
|
||||
{
|
||||
if (_inFlightLoads.TryGetValue(panelType, out var current) &&
|
||||
ReferenceEquals(current, inFlightLoad))
|
||||
{
|
||||
_inFlightLoads.Remove(panelType);
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
评价:这个修正是关键的。它避免旧任务完成或失败时把 release 后新建的 in-flight 条目删掉。
|
||||
|
||||
---
|
||||
|
||||
### 3. 新增测试覆盖了上一轮缺口
|
||||
|
||||
新增测试:
|
||||
|
||||
- `PreloadAsync_AfterReleaseAllWhileOldLoadInFlight_StartsNewLoadAndCachesNewHandle`
|
||||
- `OldInFlightCompletion_AfterReleaseAll_DoesNotRemoveNewInFlight`
|
||||
|
||||
覆盖的真实边界:
|
||||
|
||||
1. 旧 preload 正在加载。
|
||||
2. 调用 `ReleaseAll()`。
|
||||
3. 立刻再次 preload 同一 panel。
|
||||
4. 新 preload 必须触发新的资源加载。
|
||||
5. 旧任务完成后只能释放旧 handle,不能污染或删除新任务。
|
||||
6. 新任务完成后应缓存新 handle。
|
||||
|
||||
评价:这两条测试正好覆盖第四轮指出的 P1 风险。
|
||||
|
||||
---
|
||||
|
||||
## 当前未发现的 P2 阻塞项
|
||||
|
||||
从本轮审查范围看,以下上一轮 gate 已经闭环:
|
||||
|
||||
- `ShutdownAsync` best-effort cleanup。
|
||||
- `UIPreloadService` 首个 caller cancellation 不再污染其他 waiter。
|
||||
- `ReleaseAll/Dispose` 后旧异步任务不再写回缓存。
|
||||
- `ReleaseAll` 后重新 preload 同一 panel 不再复用旧 generation 任务。
|
||||
- 旧任务完成不会误删新 in-flight。
|
||||
|
||||
因此,如果 P2 的第一项不是“正式发布资源后端/Addressables 集成质量”,当前 Game Core 主线可以进入 P2。
|
||||
|
||||
---
|
||||
|
||||
## 中风险改进
|
||||
|
||||
### `Release<TPanel>()` 对 in-flight preload 仍不生效
|
||||
|
||||
风险等级:中
|
||||
建议:P2 前可小修;若 P2 首项不扩 UI preload,可放入 P2 内 polish。
|
||||
|
||||
证据文件:
|
||||
|
||||
- `My project/Assets/FlowScope/Runtime/UI/UIPreloadService.cs`
|
||||
|
||||
当前 `Release<TPanel>()` 只处理已经缓存到 `_handles` 的资源:
|
||||
|
||||
```csharp
|
||||
if (!_handles.TryGetValue(panelType, out handle))
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
_handles.Remove(panelType);
|
||||
```
|
||||
|
||||
它不会处理同 panel 的 in-flight preload。结果是:
|
||||
|
||||
1. `PreloadAsync<TPanel>()` 已启动但尚未完成。
|
||||
2. 调用 `Release<TPanel>()`。
|
||||
3. 因为 `_handles` 里还没有缓存,`Release<TPanel>()` 直接 return。
|
||||
4. 旧 preload 完成后仍会缓存 handle。
|
||||
|
||||
这与当前 `ReleaseAll()` 的语义不完全一致:`ReleaseAll()` 已经通过 `_releaseGeneration++` 明确让所有旧 in-flight 结果失效,而 `Release<TPanel>()` 仍只释放已缓存结果。
|
||||
|
||||
建议选一种语义并写清楚:
|
||||
|
||||
1. 如果 `Release<TPanel>()` 表示“释放该 panel 的预加载结果”,则应让该 panel 当前 in-flight 失效。
|
||||
2. 如果 `Release<TPanel>()` 只表示“释放已缓存 handle,不影响正在进行的 preload”,则建议在 runtime usage guide 明确说明,避免使用者误以为它会取消或丢弃 in-flight 结果。
|
||||
|
||||
更一致的实现方向:
|
||||
|
||||
- 给 `InFlightPreload` 增加 panel-level generation 或 invalidation flag。
|
||||
- `Release<TPanel>()` 在释放 `_handles` 后,同时让当前 panel 的旧 in-flight 结果不能缓存。
|
||||
- 补测试:`Release_WhenLoadInFlight_DoesNotCacheAndDisposesLoadedHandle`。
|
||||
|
||||
---
|
||||
|
||||
## 低风险改进
|
||||
|
||||
### Addressables 真实 load/release 验证仍薄
|
||||
|
||||
当前 `AddressablesResourceBackendTests` 仍主要覆盖 `Name_ReturnsAddressables`。
|
||||
这不是本轮 UI preload 修复引入的问题,但仍是包分发或资源后端推广前的验收缺口。
|
||||
|
||||
建议:
|
||||
|
||||
- 如果 P2 首项是 package/editor tooling,可放到 P2 内第一批验收。
|
||||
- 如果 P2 首项是资源后端能力发布,则建议先补最小 Addressables PlayMode 集成或人工验收记录。
|
||||
|
||||
---
|
||||
|
||||
## 本轮验证
|
||||
|
||||
执行:
|
||||
|
||||
```powershell
|
||||
dotnet build "My project\FlowScope.Tests.EditMode.csproj" --no-restore
|
||||
dotnet build "My project\FlowScope.Tests.PlayMode.csproj" --no-restore
|
||||
```
|
||||
|
||||
结果:
|
||||
|
||||
- EditMode generated csproj build:0 error。
|
||||
- PlayMode generated csproj build:0 error。
|
||||
- 仍有 Unity generated csproj 常见引用冲突 warning。
|
||||
|
||||
说明:
|
||||
|
||||
- 本轮未执行 Unity Test Runner。
|
||||
- 本轮未做 MainMenuP0 人工场景验收。
|
||||
- 本轮审查对象包含未提交工作树修改,不是新 commit。
|
||||
|
||||
---
|
||||
|
||||
## P2 Gate 判断
|
||||
|
||||
当前判断:可以准备进入 P2,但建议先做一次收尾确认。
|
||||
|
||||
P2 前建议最小动作:
|
||||
|
||||
1. 决定 `Release<TPanel>()` 是否需要与 `ReleaseAll()` 一样使同 panel in-flight 失效。
|
||||
2. 如果需要,补一个很小的测试和实现。
|
||||
3. 如果暂不处理,在 runtime usage guide 记录 `Release<TPanel>()` 当前只释放已缓存 handle。
|
||||
4. 跑一次 Unity Test Runner 或记录无法执行原因。
|
||||
|
||||
如果你希望严格一点,我建议先修 `Release<TPanel>()` 的 in-flight 语义,再正式开 P2;如果按当前 P2 迭代节奏推进,它已经不是阻塞级问题。
|
||||
|
||||
207
docs/reviews/p2-precheck-fourth-review.md
Normal file
207
docs/reviews/p2-precheck-fourth-review.md
Normal file
@@ -0,0 +1,207 @@
|
||||
# FlowScope P2 前第四轮复审意见
|
||||
|
||||
日期:2026-05-21
|
||||
审查对象:`2a88dad 修复预加载释放中的异步写回`
|
||||
审查范围:`UIPreloadService.ReleaseAll/Dispose` 与 in-flight preload 的生命周期边界、`GameBootstrap` 调用侧、相关 PlayMode 测试、generated csproj 编译状态。
|
||||
审查结论:上一轮指出的“释放后异步完成又写回缓存”主问题已修正;但 `ReleaseAll()` 后旧 in-flight 与新 preload 请求仍未隔离,建议 P2 前补掉这个窄边界。
|
||||
|
||||
---
|
||||
|
||||
## 本轮确认已收口
|
||||
|
||||
### 1. 释放后异步写回缓存的问题已基本修正
|
||||
|
||||
相关文件:
|
||||
|
||||
- `My project/Assets/FlowScope/Runtime/UI/UIPreloadService.cs`
|
||||
- `My project/Assets/FlowScope/Tests/PlayMode/UI/UIPreloadServiceTests.cs`
|
||||
|
||||
当前实现新增:
|
||||
|
||||
- `_releaseGeneration`
|
||||
- `_disposed`
|
||||
- `InFlightPreload.ReleaseGeneration`
|
||||
- `ThrowIfDisposed()`
|
||||
|
||||
`LoadAndStoreAsync()` 完成后只有在以下条件同时满足时才缓存 handle:
|
||||
|
||||
```csharp
|
||||
if (!_disposed &&
|
||||
inFlightLoad.ReleaseGeneration == _releaseGeneration &&
|
||||
inFlightLoad.WaiterCount > 0)
|
||||
{
|
||||
_handles[panelType] = handle;
|
||||
shouldCache = true;
|
||||
}
|
||||
```
|
||||
|
||||
对应测试已覆盖:
|
||||
|
||||
- `ReleaseAll_WhenLoadInFlight_DoesNotCacheAndDisposesLoadedHandle`
|
||||
- `Dispose_WhenLoadInFlight_DoesNotCacheAndDisposesLoadedHandle`
|
||||
- `PreloadAsync_AfterDispose_ThrowsObjectDisposedException`
|
||||
|
||||
评价:上一轮指出的 “ReleaseAll/Dispose 后,旧异步任务完成又把资源写回 `_handles`” 已经被 generation/disposed gate 挡住。
|
||||
|
||||
---
|
||||
|
||||
### 2. Dispose 后拒绝新 preload 请求
|
||||
|
||||
当前 `PreloadAsync` 在 lock 内调用:
|
||||
|
||||
```csharp
|
||||
ThrowIfDisposed();
|
||||
```
|
||||
|
||||
并且 `IsPreloaded` / `TryGetPreloadedHandle` 在 `_disposed` 后返回 false。
|
||||
|
||||
评价:`Dispose` 后服务不再接受 preload,语义清楚,和 Container / ResourceEntry 这类对象的 disposed 行为更一致。
|
||||
|
||||
---
|
||||
|
||||
### 3. GameBootstrap 调用侧仍保持 best-effort cleanup
|
||||
|
||||
相关文件:
|
||||
|
||||
- `My project/Assets/FlowScope/Samples/MainMenuP0/Scripts/GameBootstrap.cs`
|
||||
|
||||
`ShutdownAsync` 仍会在保存、GameFlow shutdown、preload release 三步里收集异常,并尽量执行完整清理。
|
||||
|
||||
评价:上一轮 shutdown gate 未被本轮改动破坏。
|
||||
|
||||
---
|
||||
|
||||
## 仍建议 P2 前修正的问题
|
||||
|
||||
### P1. `ReleaseAll()` 后、旧 in-flight 完成前,新 preload 会复用旧任务并最终不缓存
|
||||
|
||||
风险等级:高
|
||||
建议:进入 P2 前修正。
|
||||
|
||||
证据文件:
|
||||
|
||||
- `My project/Assets/FlowScope/Runtime/UI/UIPreloadService.cs`
|
||||
|
||||
当前 `ReleaseAll()` 只递增 generation 并清理已缓存 handle:
|
||||
|
||||
```csharp
|
||||
lock (_gate)
|
||||
{
|
||||
_releaseGeneration++;
|
||||
handles = new List<IResourceHandle<GameObject>>(_handles.Values);
|
||||
_handles.Clear();
|
||||
}
|
||||
```
|
||||
|
||||
但它不会移除或隔离 `_inFlightLoads`:
|
||||
|
||||
```csharp
|
||||
private readonly Dictionary<Type, InFlightPreload> _inFlightLoads = new();
|
||||
```
|
||||
|
||||
问题场景:
|
||||
|
||||
1. 调用 `PreloadAsync<Panel>()`,创建旧 `InFlightPreload`,其 `ReleaseGeneration = 0`。
|
||||
2. 底层资源仍在加载。
|
||||
3. 调用 `ReleaseAll()`,`_releaseGeneration` 变为 1。
|
||||
4. 在旧加载完成前,再次调用 `PreloadAsync<Panel>()`。
|
||||
5. 因为 `_inFlightLoads` 里仍有旧 in-flight,新请求会复用旧任务,并把 `WaiterCount++`。
|
||||
6. 旧加载完成后,`ReleaseGeneration != _releaseGeneration`,因此 handle 被 dispose,不缓存。
|
||||
7. 第二个 preload 请求 await 成功返回,但 `IsPreloaded<Panel>() == false`。
|
||||
|
||||
这会造成 API 使用者视角的语义不一致:`PreloadAsync` 成功完成,但资源并没有处于 preloaded 状态。
|
||||
如果 P2 后 UI preload 被当成可复用框架能力,这个边界会在“释放后立即重新预热同一 UI”的场景里变成隐性 bug。
|
||||
|
||||
建议修法:
|
||||
|
||||
1. `ReleaseAll()` 应让 release 前的 in-flight 与 release 后的新请求隔离。
|
||||
2. 可选实现方向:
|
||||
- `ReleaseAll()` 清理 `_inFlightLoads`,但 `LoadAndStoreAsync()` 完成时必须用 `ReferenceEquals(current, inFlightLoad)` 移除,避免旧任务误删新任务。
|
||||
- 或保留旧 in-flight,但 `PreloadAsync` 发现 `inFlightLoad.ReleaseGeneration != _releaseGeneration` 时,不复用旧任务,而是创建新 generation 的 in-flight。
|
||||
3. `LoadAndStoreAsync()` 里的 `_inFlightLoads.Remove(panelType)` 建议改成“只移除当前 in-flight”:
|
||||
|
||||
```csharp
|
||||
if (_inFlightLoads.TryGetValue(panelType, out var current) &&
|
||||
ReferenceEquals(current, inFlightLoad))
|
||||
{
|
||||
_inFlightLoads.Remove(panelType);
|
||||
}
|
||||
```
|
||||
|
||||
否则一旦允许 release 后创建新 in-flight,旧任务完成时可能误删新任务。
|
||||
|
||||
建议补测:
|
||||
|
||||
- `PreloadAsync_AfterReleaseAllWhileOldLoadInFlight_StartsNewLoadAndCachesNewHandle`
|
||||
- `OldInFlightCompletion_AfterReleaseAll_DoesNotRemoveNewInFlight`
|
||||
|
||||
---
|
||||
|
||||
## 中低风险观察
|
||||
|
||||
### 1. `ReleaseAll_WhenLoadInFlight` 当前测试只覆盖“不缓存旧 handle”
|
||||
|
||||
现有测试验证:
|
||||
|
||||
- 旧 load 完成后 handle 被 dispose。
|
||||
- `IsPreloaded` 为 false。
|
||||
|
||||
但没有覆盖 release 后立即再次 preload 的重入语义。
|
||||
这正是当前剩余风险所在。
|
||||
|
||||
### 2. `PreloadAsync` 在 `ReleaseAll()` 后等待旧任务成功返回的语义仍偏模糊
|
||||
|
||||
如果调用者在 `ReleaseAll()` 前已经开始等待旧 task,旧 task 最终成功返回但资源被 dispose、不缓存。
|
||||
这在 shutdown 场景可以接受,因为 release 代表放弃预热结果;但在普通运行时场景,最好通过文档或测试确认这是刻意语义。
|
||||
|
||||
若希望更严格,可以考虑让被 release generation 淘汰的等待者收到取消或特定异常。
|
||||
不过这会扩大改动范围,不一定是 P2 前最小必要项。
|
||||
|
||||
---
|
||||
|
||||
## 仍可后置的风险
|
||||
|
||||
### Addressables 真实 load/release 验证仍薄
|
||||
|
||||
本轮没有改变 Addressables 适配层。
|
||||
generated csproj 能编译,但真实 Addressables 资源加载、释放、失败诊断仍缺少强验证。
|
||||
|
||||
建议保留为 P2 内第一批验收项,除非 P2 首项就是资源后端分发能力。
|
||||
|
||||
---
|
||||
|
||||
## 本轮验证
|
||||
|
||||
执行:
|
||||
|
||||
```powershell
|
||||
dotnet build "My project\FlowScope.Tests.EditMode.csproj" --no-restore
|
||||
dotnet build "My project\FlowScope.Tests.PlayMode.csproj" --no-restore
|
||||
```
|
||||
|
||||
结果:
|
||||
|
||||
- EditMode generated csproj build:0 error。
|
||||
- PlayMode generated csproj build:0 error。
|
||||
- 仍有 Unity generated csproj 常见引用冲突 warning。
|
||||
|
||||
说明:
|
||||
|
||||
- 本轮未执行 Unity Test Runner。
|
||||
- 本轮未做 MainMenuP0 人工场景验收。
|
||||
|
||||
---
|
||||
|
||||
## P2 Gate 判断
|
||||
|
||||
当前建议:仍然暂缓进入 P2,先修一个更窄的 UI preload 重入问题。
|
||||
|
||||
P2 前最小清单:
|
||||
|
||||
1. 修复 `ReleaseAll()` 后旧 in-flight 与新 `PreloadAsync` 请求的隔离。
|
||||
2. 将 `_inFlightLoads.Remove(panelType)` 改为只移除当前 in-flight,避免旧任务误删新任务。
|
||||
3. 补 release 后立即重新 preload 同一 panel 的 PlayMode 测试。
|
||||
4. 保持 EditMode / PlayMode generated csproj build 0 error。
|
||||
|
||||
完成这项后,P2 gate 基本可以认为通过;剩余 Addressables 真实集成验收可以作为 P2 内第一项或 package 发布前验收项。
|
||||
|
||||
Reference in New Issue
Block a user