Files
photo-live/apps/mobile/lib/features/uploads/upload_engine.dart
T

688 lines
25 KiB
Dart
Raw Normal View History

/// 上传传输引擎 + 源文件清理执行器(P3 计划 Task 6)。
///
/// 架构(对齐技术实施方案 §5.5):
/// - **驱动**:周期 timer + 工作可用通知([notifyWorkAvailable],准备器
/// 入队时挂接)双触发;每次唤醒执行一轮调度([drain])——补足并行
/// 配额([kMaxParallelUploads],dart-define MAX_PARALLEL_UPLOADS 覆盖);
/// - **出队**:账号隔离(TaskStore 读路径硬守护)内取最旧就绪任务:
/// queued 恒就绪;waitingNetwork/retryableFailed 需 nextRetryAt 到期
/// (retryableFailed 的 nextRetryAt=null 表示自动重试上限已到/需人工
/// 介入,永不自动出队);网络恢复([onNetworkRestored])对
/// waitingNetwork 立即绕过退避;
/// - **传输三步**:initUpload(幂等,clientTaskId + sourceDeviceId)→
/// presign PUT(**经 [Transport] 委托**——Android 走原生 WorkManager
/// 后台桥接(Task 7),其余平台裸 dio 流式;进度回调 + 取消令牌)→
/// completeUpload(幂等核验)→ completed;
/// - **失败分类**([UploadEngineSourceMissing] 之外见 [_classifyFailure]):
/// | 错误 | 目标状态 | 自动重试 |
/// |---|---|---|
/// | 网络不可达/超时/429 限速 | waitingNetwork | 退避 5s·2^n 封顶 10min,无次数上限 |
/// | 401 会话过期 | waitingNetwork | 30s 短退避;全局驱逐由 ApiClient 处理,不烧次数 |
/// | 400 UPLOAD_VERIFY_FAILED / 5xx / 未知 | retryableFailed | 退避重试,3 次后停止自动重试 |
/// | 409 ALBUM_UPLOAD_DISABLED / UPLOAD_SESSION_CONFLICT / 源文件缺失 | retryableFailed | 不自动重试(人工修正后 retryNow) |
/// | presign 403 凭证过期 | (renew 后原状重传) | renewUpload 至多 2 次 |
/// - **取消**([cancel]):未开始 → cancelled 后删行删文件(确定语义);
/// 进行中 → cancelToken 尽力取消 + 置 cancelled(文件保留,由清理
/// 执行器按保留期回收);
/// - **崩溃恢复**:进程被杀时卡在 uploading/uploadedConfirming 且不在
/// in-flight 表内的任务,每轮 drain 前归位 waitingNetwork 立即重试
/// (initUpload/completeUpload 幂等,重传安全;A05 模拟器级在 Task 11
/// 集成验证);
/// - **A15 连拍归属不变**:引擎只读任务行的 albumId/categoryId(无任何
/// 写通道),入队后相册/分类切换不影响既有任务;
/// - **清理执行器**([cleanup],随每轮 drain 与 App 启动执行):仅终态
/// (completed/cancelled,TaskStore 硬守护——未完成源文件永不清理)且
/// 超过 KEEP_COMPLETED_DAYS 保留期的源文件删除 + cleanedAt 标记
/// (行保留作记录)。
library;
import 'dart:async';
import 'dart:io';
import 'package:dio/dio.dart';
import '../../core/api_client.dart';
import '../../core/app_exception.dart';
import '../../core/device_id.dart';
import '../../core/error_codes.dart';
import 'models.dart';
import 'native_transport.dart';
import 'task_state.dart';
import 'task_store.dart';
/// 并行传输上限(计划:批量并发为可配置小值;dart-define
/// MAX_PARALLEL_UPLOADS 覆盖)。
const int kMaxParallelUploads =
int.fromEnvironment('MAX_PARALLEL_UPLOADS', defaultValue: 2);
/// completed/cancelled 任务源文件保留天数(dart-define
/// KEEP_COMPLETED_DAYS 覆盖)。
const int kKeepCompletedDays =
int.fromEnvironment('KEEP_COMPLETED_DAYS', defaultValue: 14);
/// 网络类失败的基础退避(5s·2^(attempt-1),封顶 10min)。
const Duration kBackoffBase = Duration(seconds: 5);
/// 退避封顶。
const Duration kBackoffCap = Duration(minutes: 10);
/// retryableFailed 自动重试次数上限(UPLOAD_VERIFY_FAILED 等;到达后
/// 停止自动重试,等人工 [UploadEngine.retryNow])。
const int kMaxAutoRetryAttempts = 3;
/// presign 凭证过期(403)的最多元数(renewUpload 次数)。
const int kMaxCredentialRenewals = 2;
/// 传输引擎。
///
/// 事件驱动 + 周期兜底;不 own isolate(传输多为 IO 等待,UI isolate
/// 足够;Android 后台延续由 [Transport] 原生实现承担——Task 7)。
class UploadEngine {
UploadEngine(
this._store,
this._apiClient,
this._deviceId, {
Dio? objectDio,
Transport? transport,
DateTime Function()? now,
this.maxParallel = kMaxParallelUploads,
this.keepCompletedDays = kKeepCompletedDays,
this.onProgress,
this.onError,
}) : _objectDio = objectDio,
_transport = transport ??
(objectDio != null
? DartHttpTransport(dio: objectDio)
: defaultUploadTransport()),
_ownsTransport = transport == null,
_now = now ?? DateTime.now;
final TaskStore _store;
final ApiClient _apiClient;
final DeviceId _deviceId;
/// presign PUT 专用裸 Dio(无鉴权拦截器,见库级注释;[objectDio] 注入
/// 时持有引用供 dispose 关闭——传输经 [DartHttpTransport] 使用)。
final Dio? _objectDio;
/// PUT 传输委托(Android 原生 WorkManager 桥接 / 其余平台 Dart dio;
/// 选择逻辑见 native_transport.dart)。
final Transport _transport;
/// dispose 时是否释放 [_transport](注入传输由注入方管理生命周期)。
final bool _ownsTransport;
final DateTime Function() _now;
/// 并行传输上限(运行时 <1 钳位为 1,见 [_effectiveParallel])。
final int maxParallel;
int get _effectiveParallel => maxParallel < 1 ? 1 : maxParallel;
/// 源文件保留天数(清理执行器)。
final int keepCompletedDays;
/// 传输进度回调(taskId, 已发字节, 总字节;队列 UI 进度条挂接点)。
final void Function(String taskId, int sent, int total)? onProgress;
/// 引擎级异常观察(未预期中断性错误;分类内失败不经此处)。
final void Function(String taskId, Object error)? onError;
/// 周期唤醒 timer([start] 创建,[stop] 取消;测试不 start,直接
/// 驱动 [drain]/[settle])。
Timer? _timer;
/// 当前引擎服务的账号(出队范围;账号切换=重新 [start])。
String? _accountId;
/// in-flight 任务表(崩溃恢复的「不在表内」判据 + 防同任务双发)。
final Map<String, _TransferHandle> _inFlight = <String, _TransferHandle>{};
/// drain 进行中Future(并发调用折叠为同轮——所有 await 方都等到完整
/// 调度结束;结束后清空)。
Future<void>? _drainPending;
/// 网络恢复信号:下一轮 drain 对 waitingNetwork 绕过退避(一次性)。
bool _bypassBackoffOnce = false;
/// 源文件缺失伪码(客户端本地;受管副本被系统清理等,不可恢复)。
static const String sourceMissingCode = 'UPLOAD_SOURCE_MISSING';
/// 启动引擎(账号切换时重复调用即换 scope;在途传输不被中断,自然
/// 收尾后不再出队旧账号任务)。
void start(String accountId,
{Duration period = const Duration(seconds: 15)}) {
_accountId = accountId;
_timer?.cancel();
_timer = Timer.periodic(period, (_) => drain());
unawaited(drain());
}
/// 停止引擎(登出/退后台策略;不中断在途传输,仅停止再出队)。
void stop() {
_timer?.cancel();
_timer = null;
_accountId = null;
}
/// 工作可用通知(准备器入队回调挂接):尽快调度一轮。
void notifyWorkAvailable() => unawaited(drain());
/// 网络恢复通知(连接监听挂接):waitingNetwork 立即绕过退避重试。
void onNetworkRestored() {
_bypassBackoffOnce = true;
unawaited(drain());
}
/// 是否仍在运行(周期 timer 挂着)。
bool get isRunning => _timer != null;
/// 等待全部在途传输结束(测试与优雅停机用)。
Future<void> settle() => Future.wait(
[for (final handle in _inFlight.values) handle.done],
).then((_) {});
/// 一轮调度:崩溃恢复 → 补足并行配额。并发调用折叠为同轮(见
/// [_drainPending]),所有 await 方等到完整调度结束。
Future<void> drain() {
final pending = _drainPending;
if (pending != null) return pending;
final future = _doDrain().whenComplete(() => _drainPending = null);
_drainPending = future;
return future;
}
Future<void> _doDrain() async {
final accountId = _accountId;
if (accountId == null) return;
final bypass = _bypassBackoffOnce;
_bypassBackoffOnce = false;
await _recoverInterrupted(accountId);
while (_inFlight.length < _effectiveParallel) {
final task = await _pickReady(accountId, bypassBackoff: bypass);
if (task == null) break;
_launch(task);
}
}
/// 就绪任务挑选(账号内 createdAt 最旧优先——store 已排序)。
Future<UploadTask?> _pickReady(
String accountId, {
bool bypassBackoff = false,
}) async {
final candidates = await _store.listByAccount(
accountId,
states: const {
UploadTaskState.queued,
UploadTaskState.waitingNetwork,
UploadTaskState.retryableFailed,
},
);
final now = _now();
for (final task in candidates) {
if (_inFlight.containsKey(task.id)) continue;
switch (task.state) {
case UploadTaskState.queued:
return task;
case UploadTaskState.waitingNetwork:
// 网络恢复绕过退避(一次性,仅此状态)。
if (bypassBackoff || _retryDue(task.nextRetryAt, now)) {
return task;
}
case UploadTaskState.retryableFailed:
// nextRetryAt=null:自动重试上限已到,等人工 retryNow。
if (_retryDue(task.nextRetryAt, now)) {
return task;
}
case UploadTaskState.preparing:
case UploadTaskState.preparationFailed:
case UploadTaskState.uploading:
case UploadTaskState.uploadedConfirming:
case UploadTaskState.completed:
case UploadTaskState.cancelled:
break; // 不在候选集(防御性穷举)。
}
}
return null;
}
static bool _retryDue(DateTime? nextRetryAt, DateTime now) =>
nextRetryAt != null && !nextRetryAt.isAfter(now);
/// 崩溃恢复:uploading/uploadedConfirming 但不在 in-flight 表 →
/// waitingNetwork(nextRetryAt=now 立即重试;幂等保障安全)。
Future<void> _recoverInterrupted(String accountId) async {
final stuck = await _store.listByAccount(
accountId,
states: const {
UploadTaskState.uploading,
UploadTaskState.uploadedConfirming,
},
);
for (final task in stuck) {
if (_inFlight.containsKey(task.id)) continue;
try {
await _store.updateState(
task.id,
UploadTaskState.waitingNetwork,
patch: UploadTaskPatch(nextRetryAt: _now()),
now: _now(),
);
} on StateError {
// 并发迁移(取消等)——恢复放弃该任务本轮处理。
}
}
}
/// 启动一次传输:登记 in-flight(同步,防双发)后转入后台协程。
void _launch(UploadTask task) {
final handle = _TransferHandle();
_inFlight[task.id] = handle;
final future = _runTransfer(task, handle);
handle.done = future;
unawaited(
future.whenComplete(() {
_inFlight.remove(task.id);
// 完成即补位(可能仍有就绪工作)。
unawaited(drain());
}),
);
}
/// 单任务传输协程:状态入 uploading → init → PUT(含 renew)→
/// complete,失败全程分类落库。
Future<void> _runTransfer(UploadTask task, _TransferHandle handle) async {
// retryableFailed → queued → uploading(状态机需经 queued 中转);
// waitingNetwork/queued → uploading 直达。
try {
var current = task;
if (current.state == UploadTaskState.retryableFailed) {
current = await _store.updateState(
current.id,
UploadTaskState.queued,
now: _now(),
);
}
await _store.updateState(
current.id,
UploadTaskState.uploading,
patch: const UploadTaskPatch(clearNextRetryAt: true),
now: _now(),
);
await _transferSteps(current, handle);
} on TransportException catch (e) {
// 传输层失败(两实现归一;取消已在 _putObject 内短路,到达这里的
// 均为待分类失败)。
await _classifyFailure(task, e);
} on DioException catch (e) {
// 防御性兜底(api 调用已归一 AppException;dio 异常仅可能自传输
// 层漏网),按原语义分类。
await _classifyFailure(task, e);
} on AppException catch (e) {
await _classifyFailure(task, e);
} on StateError {
// 并发取消抢走了状态迁移(任务已 cancelled):尽力取消语义达成。
} on Object catch (e) {
// 未预期错误(文件系统等):按可重试失败兜底 + 观察。
onError?.call(task.id, e);
await _classifyFailure(
task,
AppException(code: ErrorCodes.internalError, message: 'engine: $e'),
);
}
}
Future<void> _transferSteps(UploadTask task, _TransferHandle handle) async {
// a. initUpload(幂等:重试复用 clientTaskId,服务端返回原会话)。
final init = await _apiClient.initUpload(
UploadInitRequest(
albumId: task.albumId,
categoryId: task.categoryId,
clientTaskId: task.clientTaskId,
filename: task.filename,
bytes: task.bytes,
contentType: task.contentType,
sourceDeviceId: await _deviceId.value(),
),
);
// 回填会话/照片 ID(状态仍 uploading,旁路写入,见 TaskStore.updateMeta)。
await _store.updateMeta(
task.id,
serverUploadId: init.uploadId,
serverPhotoId: init.photoId,
now: _now(),
);
// b. presign PUT(transport 委托 + 进度 + 取消令牌;403 → renew 换
// 凭证重传——原生路径 re-register 新 URL,Dart 路径重发 dio PUT)。
var credential = init.credential;
var renewals = 0;
while (true) {
try {
await _putObject(task, credential, handle.cancelToken,
serverUploadId: init.uploadId);
break;
} on TransportRenewRequiredException {
if (renewals < kMaxCredentialRenewals) {
renewals++;
final renewed = await _apiClient.renewUpload(init.uploadId);
credential = renewed.credential;
continue;
}
rethrow;
}
}
// c. completeUpload(幂等核验)→ completed。
await _store.updateState(
task.id,
UploadTaskState.uploadedConfirming,
now: _now(),
);
final complete = await _apiClient.completeUpload(init.uploadId);
await _store.updateState(
task.id,
UploadTaskState.completed,
patch: UploadTaskPatch(
serverPhotoId: complete.photoId,
clearLastError: true,
clearNextRetryAt: true,
),
now: _now(),
);
}
/// presign PUT:委托 [_transport](Android 原生 WorkManager 桥接 /
/// 其余 Dart dio 流式),严格携带 credential.headers。源文件存在性前置
/// 检查保留在引擎侧(两路径共用的 sourceMissing 分类依据)。
Future<void> _putObject(
UploadTask task,
UploadCredential credential,
CancelToken cancelToken, {
String? serverUploadId,
}) async {
final file = File(task.sourceFilePath);
if (!await file.exists()) {
// 源文件缺失:不可恢复,分类按「不自动重试」处理。
throw const AppException(
code: UploadEngine.sourceMissingCode,
message: 'source file missing',
);
}
try {
await _transport.send(
taskId: task.id,
url: credential.url,
method: credential.method,
headers: credential.headers,
filePath: task.sourceFilePath,
metadata: <String, Object?>{
'uploadId': serverUploadId,
'attempt': task.attempt,
},
onProgress: (sent, total) => onProgress?.call(task.id, sent, total),
cancelToken: cancelToken,
);
} on TransportException catch (e) {
if (_isCancelledTransfer(e, cancelToken)) {
// 用户取消:状态已置 cancelled(cancel() 内),终止协程。
return;
}
rethrow;
}
}
/// 取消判定:取消令牌已触发或传输层报告 cancelled。
static bool _isCancelledTransfer(Object error, CancelToken cancelToken) =>
cancelToken.isCancelled ||
(error is TransportException &&
error.code == TransportErrorCodes.cancelled);
/// 失败分类与状态落库(分类表见库级注释;attempt 每次 +1,目标状态
/// 自 uploading/uploadedConfirming 均合法迁移)。
Future<void> _classifyFailure(UploadTask task, Object error) async {
final AppException app;
if (error is AppException) {
app = error;
} else if (error is TransportException) {
app = _normalizeTransportFailure(error);
} else if (error is DioException) {
app = ApiClient.mapDioException(error);
} else {
app = AppException(code: ErrorCodes.internalError, message: '$error');
}
final code = app.code;
final status = app.statusCode;
final attempt = task.attempt + 1;
// 1) 网络类(含超时)与限速:waitingNetwork 退避(无次数上限)。
if (code == ErrorCodes.networkError ||
code == ErrorCodes.networkTimeout ||
code == ErrorCodes.rateLimited) {
await _fail(
task,
UploadTaskState.waitingNetwork,
UploadTaskPatch(
attempt: attempt,
nextRetryAt: _now().add(backoffFor(attempt)),
lastError: code,
),
);
return;
}
// 2) 会话过期:waitingNetwork 短退避(重登录后续传;全局驱逐由
// ApiClient.onUnauthorized 处理,不烧自动重试次数、attempt 不变)。
if (status == 401 || code == ErrorCodes.authTokenExpired) {
await _fail(
task,
UploadTaskState.waitingNetwork,
UploadTaskPatch(
nextRetryAt: _now().add(const Duration(seconds: 30)),
lastError: code,
),
);
return;
}
// 3) 客户端重试无意义(服务端开关/幂等冲突/源文件缺失):不自动
// 重试,用户可见 lastError,修正后 retryNow 手动重试。
if (code == ErrorCodes.albumUploadDisabled ||
code == ErrorCodes.uploadSessionConflict ||
code == UploadEngine.sourceMissingCode) {
await _fail(
task,
UploadTaskState.retryableFailed,
UploadTaskPatch(lastError: code),
);
return;
}
// 4) 其余(UPLOAD_VERIFY_FAILED / 5xx / 未知):retryableFailed 退避
// 自动重试,达上限后停止(nextRetryAt 缺省=null)。
final autoRetry = attempt < kMaxAutoRetryAttempts;
await _fail(
task,
UploadTaskState.retryableFailed,
UploadTaskPatch(
attempt: attempt,
nextRetryAt: autoRetry ? _now().add(backoffFor(attempt)) : null,
lastError: code,
),
);
}
/// 传输层异常 → AppException 归一(与 dio 路径 mapDioException 语义
/// 对齐:网络类/429 → 网络桶;401 → 短退避桶;sourceMissing → 不自动
/// 重试桶;其余按 HTTP 状态归桶 4)。
static AppException _normalizeTransportFailure(TransportException e) {
switch (e.code) {
case TransportErrorCodes.network:
return const AppException(
code: ErrorCodes.networkError,
message: '传输失败(网络)',
);
case TransportErrorCodes.sourceMissing:
return const AppException(
code: UploadEngine.sourceMissingCode,
message: 'source file missing',
);
case TransportErrorCodes.cancelled:
return const AppException(
code: ErrorCodes.cancelled,
message: '传输已取消',
);
case TransportErrorCodes.channel:
return AppException(
code: ErrorCodes.internalError,
message: '原生桥接通道错误: ${e.cause}',
);
case TransportErrorCodes.http:
default:
final status = e.statusCode;
if (status == 401) {
return const AppException(
code: ErrorCodes.authTokenExpired,
statusCode: 401,
message: '未认证或会话已过期',
);
}
if (status == 429 || status == 408) {
return const AppException(
code: ErrorCodes.rateLimited,
statusCode: 429,
message: '传输限速',
);
}
if (status != null) {
return AppException(
code: status >= 500
? ErrorCodes.internalError
: ErrorCodes.httpError,
statusCode: status,
message: '传输 HTTP $status',
);
}
return AppException(
code: ErrorCodes.internalError,
message: '传输失败: ${e.cause ?? e}',
);
}
}
/// 分类落地(并发取消致 StateError 时静默——cancelled 已是终态)。
Future<void> _fail(
UploadTask task,
UploadTaskState to,
UploadTaskPatch patch,
) async {
try {
await _store.updateState(task.id, to, patch: patch, now: _now());
} on StateError {
// 已被并发取消(cancelled 终态):保留取消语义。
}
}
/// 退避时长:5s·2^(attempt-1),封顶 10min(attempt ≥ 1)。
///
/// 指数先钳位:Dart VM 下 `1 << n`(n ≥ 64)归零,超大 attempt 会使
/// 乘数溢出为 0;且 2^7 档(640s)已越过封顶,更大指数无意义。
static Duration backoffFor(int attempt) {
if (attempt < 1) return kBackoffBase;
const maxShift = 7;
final shift = attempt - 1 < maxShift ? attempt - 1 : maxShift;
final shifted = kBackoffBase * (1 << shift);
return shifted > kBackoffCap ? kBackoffCap : shifted;
}
/// 取消任务(语义见库级注释)。返回是否生效(终态/不存在=false)。
Future<bool> cancel(String accountId, String taskId) async {
final task = await _store.get(accountId, taskId);
if (task == null || task.state.isTerminal) return false;
await _store.updateState(
taskId,
UploadTaskState.cancelled,
patch: const UploadTaskPatch(clearNextRetryAt: true),
now: _now(),
);
final handle = _inFlight[taskId];
if (handle != null) {
// 进行中:尽力取消(协程在取消异常/下一检查点收敛)。
handle.cancelToken.cancel();
return true;
}
// 未开始:删行 + 删受管文件(best-effort;失败不回滚取消)。
await _store.delete(taskId);
try {
final file = File(task.sourceFilePath);
if (await file.exists()) {
await file.delete();
}
} on Object {
// 残留文件由清理执行器路径之外的孤儿——接受(行已删,无清理候选)。
}
return true;
}
/// 手动重试(队列 UI「重试」按钮):retryableFailed(含达上限)/
/// waitingNetwork 任务立即重新入队出队。
Future<void> retryNow(String accountId, String taskId) async {
final task = await _store.get(accountId, taskId);
if (task == null) return;
if (task.state != UploadTaskState.retryableFailed &&
task.state != UploadTaskState.waitingNetwork) {
return;
}
await _store.updateState(
taskId,
UploadTaskState.queued,
patch: const UploadTaskPatch(clearNextRetryAt: true),
now: _now(),
);
unawaited(drain());
}
/// 清理执行器:删除超过保留期的终态任务源文件并标记 cleanedAt(行
/// 保留作历史记录)。先删文件后标记——中断重入安全(文件已删为
/// no-op)。返回清理条数。候选集硬守护在 TaskStore.cleanupCandidates
/// (未完成任务永不出现)。
Future<int> cleanup({DateTime? now}) async {
final at = now ?? _now();
final candidates = await _store.cleanupCandidates(keepCompletedDays, now: at);
var cleaned = 0;
for (final task in candidates) {
try {
final file = File(task.sourceFilePath);
if (await file.exists()) {
await file.delete();
}
} on Object {
continue; // 单文件失败不阻断其余(下次唤醒重试)。
}
await _store.markCleanable(task.id, now: at);
cleaned++;
}
return cleaned;
}
/// 关闭(App 退出):停 timer、尽力断在途、释放注入的 object Dio 与
/// 自建传输。
void dispose() {
stop();
for (final handle in _inFlight.values) {
handle.cancelToken.cancel();
}
_objectDio?.close();
if (_ownsTransport) {
_transport.dispose();
}
}
}
/// 在途传输控制句柄。
class _TransferHandle {
final CancelToken cancelToken = CancelToken();
/// 传输协程完成信号(settle 用;_launch 内同步赋值)。
Future<void> done = Future<void>.value();
}