1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
use crate::error::{InnerErrorCode, MeowError};
use crate::file_transfer_record::FileTransferRecord;
use crate::ids::{GlobalProgressListenerId, TaskId};
use crate::inner::cb_dispatcher;
use crate::inner::group_state::{GroupState, RecordEntry};
use crate::inner::inner_task::InnerTask;
use crate::inner::scheduler_state::SchedulerState;
use crate::inner::task_callbacks::{ProgressCb, TaskCallbacks};
use crate::inner::worker_event::WorkerEvent;
use crate::inner::UniqueId;
use crate::meow_config::MeowConfig;
use crate::transfer_executor_trait::TransferTrait;
use crate::transfer_snapshot::TransferSnapshot;
use crate::transfer_status::TransferStatus;
use crate::transfer_task::TransferTask;
use std::sync::atomic::{AtomicBool, Ordering};
use std::sync::{Arc, Mutex, RwLock};
use std::thread::JoinHandle;
use tokio::sync::mpsc;
pub(crate) enum TransferCmd {
Enqueue {
inner: InnerTask,
callbacks: TaskCallbacks,
},
Pause {
task_id: TaskId,
/// 控制命令应答通道:返回 pause 的最终结果。
respond_to: tokio::sync::oneshot::Sender<Result<(), MeowError>>,
},
/// 恢复一个此前 pause 的任务;语义是“同 task_id 继续执行”。
Resume {
/// 外部暴露的任务 id,用于反查内部 dedupe key。
task_id: TaskId,
/// 控制命令应答通道:返回 resume 的最终结果。
respond_to: tokio::sync::oneshot::Sender<Result<(), MeowError>>,
},
Cancel {
task_id: TaskId,
/// 控制命令应答通道:返回 cancel 的最终结果。
respond_to: tokio::sync::oneshot::Sender<Result<(), MeowError>>,
},
Snapshot {
respond_to: tokio::sync::oneshot::Sender<TransferSnapshot>,
},
Close {
/// 控制命令应答通道:仅在 worker 完成清理后返回。
respond_to: tokio::sync::oneshot::Sender<Result<(), MeowError>>,
},
}
fn worker_loop(
mut cmd_rx: mpsc::Receiver<TransferCmd>,
mut worker_rx: mpsc::Receiver<WorkerEvent>,
worker_tx: mpsc::Sender<WorkerEvent>,
mut state: SchedulerState,
executor: Arc<dyn TransferTrait>,
mut cb_join: cb_dispatcher::CbDispatcherJoin,
) -> Result<JoinHandle<()>, MeowError> {
fn shutdown_callback_dispatcher(
state: &mut SchedulerState,
cb_join: &mut cb_dispatcher::CbDispatcherJoin,
) {
// Drop the scheduler's only callback sender before joining. This is
// required on every worker exit path; otherwise the dispatcher can
// wait forever for more jobs while the worker waits in join().
drop(state.take_cb_submit());
cb_join.join();
}
crate::meow_flow_log!("worker_loop", "starting scheduler worker thread");
let (startup_tx, startup_rx) = std::sync::mpsc::sync_channel::<Result<(), MeowError>>(1);
let handle = std::thread::spawn(move || {
let runtime_ret = tokio::runtime::Builder::new_multi_thread()
.enable_all()
.build();
match runtime_ret {
Ok(runtime) => {
crate::meow_flow_log!("worker_loop", "runtime created successfully");
let _ = startup_tx.send(Ok(()));
runtime.block_on(async move {
loop {
tokio::select! {
biased;
maybe_cmd = cmd_rx.recv() => {
let Some(cmd) = maybe_cmd else {
shutdown_callback_dispatcher(&mut state, &mut cb_join);
break;
};
match cmd {
TransferCmd::Enqueue { inner, callbacks } => {
let key = inner.dedupe_key();
crate::meow_flow_log!(
"cmd_enqueue",
"received enqueue: task_id={:?} key={:?} chunk_size={}",
inner.task_id(),
key,
inner.chunk_size()
);
if let Some(existing) = state.groups().get(&key) {
let leader = existing.leader_inner();
let dup_dto = to_record_inner(
leader,
TransferStatus::Failed(MeowError::from_code1(
InnerErrorCode::DuplicateTaskError,
)),
0,
leader.total_size(),
);
if let Some(cb) = &callbacks.progress_cb() {
crate::inner::exec_impl::emit::invoke_progress_cb(
&state,
cb,
dup_dto.clone(),
);
}
crate::inner::exec_impl::emit::emit_global_progress(
&state,
dup_dto,
);
crate::meow_flow_log!(
"cmd_enqueue",
"duplicate key rejected: key={:?}",
key
);
continue;
}
state
.task_id_to_dedupe_mut()
.insert(inner.task_id(), key.clone());
let should_send_running = state.active().contains_key(&key);
let entry = RecordEntry::new(inner.clone(), callbacks);
state.groups_mut().insert(
key.clone(),
GroupState::new(inner.clone(), entry),
);
if let Some(group) = state.groups().get(&key) {
let current = state.offsets().get(&key).copied().unwrap_or(0);
crate::inner::exec_impl::emit::emit_status(
&state,
group.entry(),
TransferStatus::Pending,
current,
group.entry().inner().total_size(),
);
if should_send_running {
crate::inner::exec_impl::emit::emit_status(
&state,
group.entry(),
TransferStatus::Transmission,
current,
group.entry().inner().total_size(),
);
}
}
if !state.active().contains_key(&key) && !state.queued_set().contains(&key) {
state.queued_mut().push_back(key.clone());
state.queued_set_mut().insert(key.clone());
crate::meow_flow_log!(
"cmd_enqueue",
"queued new key: key={:?} queued_len={}",
key,
state.queued().len()
);
}
let _ = crate::inner::exec_impl::exec::try_start_next(
&worker_tx,
&mut state,
&executor,
)
.await;
}
TransferCmd::Pause { task_id, respond_to } => {
crate::meow_flow_log!(
"cmd_pause",
"pause requested: task_id={:?}",
task_id
);
if let Some(key) = state.task_id_to_dedupe().get(&task_id).cloned()
{
pause_group(&mut state, &key).await;
let _ = respond_to.send(Ok(()));
crate::meow_flow_log!(
"cmd_pause",
"pause accepted: task_id={:?} key={:?}",
task_id,
key
);
} else {
crate::meow_flow_log!(
"cmd_pause",
"pause failed task not found: task_id={:?}",
task_id
);
let _ = respond_to.send(Err(task_not_found_error(task_id)));
}
let _ = crate::inner::exec_impl::exec::try_start_next(
&worker_tx,
&mut state,
&executor,
)
.await;
}
TransferCmd::Resume { task_id, respond_to } => {
crate::meow_flow_log!(
"cmd_resume",
"resume requested: task_id={:?}",
task_id
);
if let Some(key) = state.task_id_to_dedupe().get(&task_id).cloned()
{
let resume_ret = resume_group(&mut state, &key).await;
if let Err(e) = &resume_ret {
crate::meow_flow_log!(
"cmd_resume",
"resume rejected: task_id={:?} key={:?} err={}",
task_id,
key,
e
);
} else {
crate::meow_flow_log!(
"cmd_resume",
"resume accepted: task_id={:?} key={:?}",
task_id,
key
);
}
let _ = respond_to.send(resume_ret);
} else {
crate::meow_flow_log!(
"cmd_resume",
"resume failed task not found: task_id={:?}",
task_id
);
let _ = respond_to.send(Err(task_not_found_error(task_id)));
}
let _ = crate::inner::exec_impl::exec::try_start_next(
&worker_tx,
&mut state,
&executor,
)
.await;
}
TransferCmd::Cancel { task_id, respond_to } => {
crate::meow_flow_log!(
"cmd_cancel",
"cancel requested: task_id={:?}",
task_id
);
if let Some(key) = state.task_id_to_dedupe().get(&task_id).cloned()
{
cancel_group(&mut state, &key, &executor).await;
let _ = respond_to.send(Ok(()));
crate::meow_flow_log!(
"cmd_cancel",
"cancel accepted: task_id={:?} key={:?}",
task_id,
key
);
} else {
crate::meow_flow_log!(
"cmd_cancel",
"cancel failed task not found: task_id={:?}",
task_id
);
let _ = respond_to.send(Err(task_not_found_error(task_id)));
}
let _ = crate::inner::exec_impl::exec::try_start_next(
&worker_tx,
&mut state,
&executor,
)
.await;
}
TransferCmd::Snapshot { respond_to } => {
crate::meow_flow_log!(
"cmd_snapshot",
"snapshot requested: queued={} active={} paused={}",
state.queued().len(),
state.active().len(),
state.paused_set().len()
);
let _ = respond_to.send(TransferSnapshot {
queued_groups: state.queued().len(),
active_groups: state.active().len(),
active_keys: state.active().keys().cloned().collect(),
});
}
TransferCmd::Close { respond_to } => {
crate::meow_flow_log!(
"cmd_close",
"close requested: active={} groups={} queued={} paused={}",
state.active().len(),
state.groups().len(),
state.queued().len(),
state.paused_set().len()
);
for (_, active) in state.active().iter() {
active.cancel().cancel();
}
// emit Paused 时仍走 dispatcher(终态必送),保证回调线程把这些
// 终态收进队列;下一步关闭 channel 后线程会先 drain 再退出。
for (key, group) in state.groups().iter() {
let current = state.offsets().get(key).copied().unwrap_or(0);
crate::inner::exec_impl::emit::emit_status(
&state,
group.entry(),
TransferStatus::Paused,
current,
group.entry().inner().total_size(),
);
}
state.active_mut().clear();
state.groups_mut().clear();
state.task_id_to_dedupe_mut().clear();
state.queued_mut().clear();
state.queued_set_mut().clear();
state.paused_set_mut().clear();
state.offsets_mut().clear();
// 关闭回调 channel:drop 唯一持有的 sender。
// 之后阻塞 join 分发线程,确保所有终态回调(包括上面刚 emit
// 的 Paused)在 close().await 返回前已经被回放完毕。
shutdown_callback_dispatcher(&mut state, &mut cb_join);
crate::meow_flow_log!("cmd_close", "close finished, worker loop exiting");
let _ = respond_to.send(Ok(()));
break;
}
}
}
maybe_event = worker_rx.recv() => {
let Some(event) = maybe_event else { continue; };
crate::meow_flow_log!("worker_loop", "worker event received");
crate::inner::exec_impl::handle_worker_event::handle_worker_event(
event,
&mut state,
)
.await;
let _ = crate::inner::exec_impl::exec::try_start_next(
&worker_tx,
&mut state,
&executor,
)
.await;
}
}
}
});
}
Err(e) => {
crate::meow_flow_log!("worker_loop", "runtime creation failed: {}", e);
let _ = startup_tx.send(Err(MeowError::from_code(
InnerErrorCode::RuntimeCreationFailedError,
format!("runtime build failed: {}", e),
)));
}
}
});
startup_rx.recv().map_err(|e| {
MeowError::from_code(
InnerErrorCode::RuntimeCreationFailedError,
format!("runtime startup handshake failed: {}", e),
)
})??;
Ok(handle)
}
async fn pause_group(state: &mut SchedulerState, key: &UniqueId) {
crate::meow_flow_log!(
"pause_group",
"pause begin: key={:?} active={} queued={} paused={}",
key,
state.active().contains_key(key),
state.queued_set().contains(key),
state.paused_set().contains(key)
);
// 暂停语义要求“可恢复”,因此先从可运行集合移除,避免继续调度/执行。
if let Some(active) = state.active().get(key) {
// 对正在执行的组发出取消信号,让 worker 退出循环并回到可恢复状态。
// 注意:这里不立刻从 active 移除,避免 resume 与 Canceled 事件发生竞态。
active.cancel().cancel();
}
// 若任务尚在等待队列中,暂停后应立刻从队列剔除。
state.queued_mut().retain(|k| k != key);
// 同步更新队列镜像集合,确保状态一致。
state.queued_set_mut().remove(key);
// 关键:标记为 paused,而不是删除 group/mapping,这样 resume 才能找到原任务。
state.paused_set_mut().insert(key.clone());
if let Some(group) = state.groups().get(key) {
// 发送 Paused 事件给回调层,告诉调用方任务已进入可恢复暂停态。
let entry = group.entry();
// 使用当前 offset 作为暂停进度,保持对外可观测进度连续。
let current = state.offsets().get(key).copied().unwrap_or(0);
crate::inner::exec_impl::emit::emit_status(
state,
entry,
TransferStatus::Paused,
current,
entry.inner().total_size(),
);
crate::meow_flow_log!(
"pause_group",
"pause status emitted: key={:?} offset={}",
key,
current
);
}
}
async fn resume_group(state: &mut SchedulerState, key: &UniqueId) -> Result<(), MeowError> {
crate::meow_flow_log!(
"resume_group",
"resume begin: key={:?} active={} queued={} paused={}",
key,
state.active().contains_key(key),
state.queued_set().contains(key),
state.paused_set().contains(key)
);
// 非 paused 任务不允许 resume,防止错误状态转换。
if !state.paused_set().contains(key) {
crate::meow_flow_log!("resume_group", "resume rejected not paused: key={:?}", key);
return Err(MeowError::from_code(
InnerErrorCode::InvalidTaskState,
"resume target is not paused".to_string(),
));
}
// 仍在 active 说明 pause 正在收敛中,先拒绝本次 resume,避免和取消事件竞态。
if state.active().contains_key(key) {
crate::meow_flow_log!(
"resume_group",
"resume rejected still stopping: key={:?}",
key
);
return Err(MeowError::from_code(
InnerErrorCode::InvalidTaskState,
"resume target is still stopping, retry later".to_string(),
));
}
// paused 标记在恢复时移除,表示该任务重新进入调度生命周期。
state.paused_set_mut().remove(key);
// 若组已不存在则属于内部状态异常,直接报错而不是静默忽略。
let Some(group) = state.groups().get(key) else {
crate::meow_flow_log!(
"resume_group",
"resume rejected missing group: key={:?}",
key
);
return Err(MeowError::from_code(
InnerErrorCode::InvalidTaskState,
"resume target group missing".to_string(),
));
};
// 当前 offset 继续作为恢复起点,通知外部进入 Pending(待调度)状态。
let current = state.offsets().get(key).copied().unwrap_or(0);
crate::inner::exec_impl::emit::emit_status(
state,
group.entry(),
TransferStatus::Pending,
current,
group.entry().inner().total_size(),
);
// 仅当不在 active 且不在 queued 时重新入队,避免重复排队。
if !state.active().contains_key(key) && !state.queued_set().contains(key) {
state.queued_mut().push_back(key.clone());
state.queued_set_mut().insert(key.clone());
crate::meow_flow_log!(
"resume_group",
"resume requeued key={:?} queued_len={}",
key,
state.queued().len()
);
}
crate::meow_flow_log!("resume_group", "resume success: key={:?}", key);
Ok(())
}
async fn cancel_group(
state: &mut SchedulerState,
key: &UniqueId,
executor: &Arc<dyn TransferTrait>,
) {
crate::meow_flow_log!(
"cancel_group",
"cancel begin: key={:?} active={} queued={} paused={}",
key,
state.active().contains_key(key),
state.queued_set().contains(key),
state.paused_set().contains(key)
);
// 取消优先终止执行态。
if let Some(active) = state.active_mut().remove(key) {
active.cancel().cancel();
}
// 取消后不应继续排队。
state.queued_mut().retain(|k| k != key);
state.queued_set_mut().remove(key);
// 取消语义会彻底结束任务,因此需要清掉 paused 标记。
state.paused_set_mut().remove(key);
if let Some(group) = state.groups_mut().remove(key) {
// 对上传协议触发可选的远端取消语义(例如 OSS AbortMultipartUpload)。
let task_view = TransferTask::from_inner(group.leader_inner());
if let Err(err) = executor.cancel(&task_view).await {
crate::meow_flow_log!(
"cancel_group",
"protocol abort failed but continue cleanup: key={:?} err={}",
key,
err
);
}
// 取消后删除 task_id 映射,防止继续通过旧 id 控制。
state
.task_id_to_dedupe_mut()
.remove(&group.leader_inner().task_id());
let entry = group.entry();
let current = state.offsets().get(key).copied().unwrap_or(0);
crate::inner::exec_impl::emit::emit_status(
state,
entry,
TransferStatus::Canceled,
current,
entry.inner().total_size(),
);
crate::meow_flow_log!(
"cancel_group",
"cancel status emitted: key={:?} offset={}",
key,
current
);
}
}
fn task_not_found_error(task_id: TaskId) -> MeowError {
MeowError::from_code(
InnerErrorCode::TaskNotFound,
format!("task not found: {:?}", task_id),
)
}
/// Handle to the background scheduler worker.
///
/// The worker itself lives on a dedicated [`std::thread`] which in turn
/// drives a dedicated Tokio multi-thread runtime. The join handle is retained
/// so explicit [`Executor::close`] can wait until that thread has fully
/// exited. The worker only shuts down when one of the following happens:
///
/// 1. An explicit [`Executor::close`] command is processed and the loop
/// breaks cleanly (preferred path, drains state and emits `Paused`
/// events).
/// 2. All [`TransferCmd`] senders are dropped, in which case `cmd_rx.recv()`
/// returns `None` and the loop breaks naturally (fallback path).
///
/// Because path (1) is the only way to guarantee clean shutdown, deliver
/// terminal status events to user callbacks, drain the callback dispatcher,
/// and join the scheduler thread, `close()` is treated as a **required** part
/// of the lifecycle. The [`Drop`] impl below performs a best-effort shutdown
/// (plus a warning log) for the case where users forget it, but must not be
/// relied upon for correctness.
#[derive(Debug)]
pub(crate) struct Executor {
cmd_tx: tokio::sync::mpsc::Sender<TransferCmd>,
/// Scheduler thread join handle. Explicit `close()` takes and joins it so
/// close becomes a hard resource-release barrier.
worker_join: Mutex<Option<JoinHandle<()>>>,
/// Set to `true` by [`Executor::close`] after the worker acknowledges
/// shutdown. Read by [`Drop`] to decide whether a best-effort shutdown
/// is still required.
close_invoked: AtomicBool,
}
impl Executor {
pub(crate) fn new(
config: MeowConfig,
executor: Arc<dyn TransferTrait>,
global_progress_listener: Arc<RwLock<Vec<(GlobalProgressListenerId, ProgressCb)>>>,
) -> Result<Self, MeowError> {
crate::meow_flow_log!(
"executor",
"executor new: max_upload={} max_download={}",
config.max_upload_concurrency(),
config.max_download_concurrency()
);
let command_queue_capacity = config.command_queue_capacity();
let worker_event_queue_capacity = config.worker_event_queue_capacity();
let (cmd_tx, cmd_rx) = mpsc::channel::<TransferCmd>(command_queue_capacity);
let (worker_tx, worker_rx) = mpsc::channel::<WorkerEvent>(worker_event_queue_capacity);
// 在调度循环启动前就把回调分发线程拉起来,并把 sender 注入 SchedulerState。
// 这样 worker_loop 一开始就处于"回调物理隔离"的状态,第一条进度也走分发线程。
// 队列容量在 cb_dispatcher 内部锁定(CALLBACK_QUEUE_CAPACITY),不对外暴露。
let (cb_submit, cb_join) = cb_dispatcher::start()?;
let worker_join = worker_loop(
cmd_rx,
worker_rx,
worker_tx,
SchedulerState::new(
config.max_upload_concurrency(),
config.max_download_concurrency(),
global_progress_listener,
cb_submit,
),
executor,
cb_join,
)?;
crate::meow_flow_log!("executor", "executor worker started");
Ok(Self {
cmd_tx,
worker_join: Mutex::new(Some(worker_join)),
close_invoked: AtomicBool::new(false),
})
}
}
impl Drop for Executor {
/// Best-effort shutdown path for when the user forgot to call
/// [`crate::meow_client::MeowClient::close`].
///
/// We intentionally keep this path simple and non-blocking:
///
/// - Emits a `Warn`-level log so the misuse is observable.
/// - Attempts a non-blocking `try_send` of [`TransferCmd::Close`] so the
/// worker, if still draining commands, can clean up and emit `Paused`
/// events to user callbacks.
/// - Does **not** `await`, does **not** join the scheduler thread, and
/// does **not** attempt to translate in-flight failures: even if the
/// `try_send` fails (channel full or worker already gone), dropping
/// `cmd_tx` immediately afterwards closes the command channel, which
/// makes `cmd_rx.recv()` return `None` and lets the worker loop exit
/// on its own.
///
/// This is an aid, not a substitute: callers must still invoke
/// `close().await` for deterministic shutdown semantics (final status
/// callbacks, flushed resources, etc.).
fn drop(&mut self) {
if self.close_invoked.load(Ordering::SeqCst) {
crate::meow_flow_log!(
"executor_drop",
"executor dropped after explicit close() -- nothing to do"
);
return;
}
// Surface a Warn-level entry via the debug log listener (if any)
// so embedding applications can detect the misuse pattern.
crate::log::emit(crate::log::Log::new(
crate::log::LogLevel::Warn,
"executor_drop",
"MeowClient dropped without calling close().await; performing \
best-effort shutdown. The background scheduler thread will exit \
on its own, but terminal status events may be skipped. Always \
call MeowClient::close().await for deterministic shutdown.",
));
let (tx, _rx) = tokio::sync::oneshot::channel();
match self.cmd_tx.try_send(TransferCmd::Close { respond_to: tx }) {
Ok(()) => {
crate::meow_flow_log!(
"executor_drop",
"best-effort Close command queued during Drop"
);
}
Err(e) => {
crate::meow_flow_log!(
"executor_drop",
"best-effort Close try_send skipped: {}; relying on \
cmd_tx drop to unblock worker loop",
e
);
}
}
// `cmd_tx` is dropped right after this returns. That closes the
// command channel: if the Close command above never reached the
// worker, the naked `recv() -> None` branch in `worker_loop` still
// breaks the loop and tears the runtime down.
}
}
impl Executor {
async fn join_worker_thread(&self) -> Result<(), MeowError> {
let handle = {
let mut guard = self.worker_join.lock().map_err(|e| {
MeowError::from_code(
InnerErrorCode::LockPoisoned,
format!("worker join handle lock poisoned: {}", e),
)
})?;
guard.take()
};
let Some(handle) = handle else {
return Ok(());
};
tokio::task::spawn_blocking(move || handle.join())
.await
.map_err(|e| {
MeowError::from_code(
InnerErrorCode::Unknown,
format!("worker thread join task failed: {}", e),
)
})?
.map_err(|_| {
MeowError::from_code_str(
InnerErrorCode::Unknown,
"worker thread panicked during shutdown",
)
})
}
/// Non-blocking command submission for an `Enqueue` request.
///
/// This deliberately uses [`tokio::sync::mpsc::Sender::try_send`] rather
/// than `send().await`. The caller gets an immediate error if the command
/// channel is full (back-pressure signal) instead of being silently
/// suspended until the worker drains enough slots.
///
/// The public-facing entry point [`crate::meow_client::MeowClient::try_enqueue`]
/// reflects this by carrying the `try_` prefix in its name; do not change
/// this into an `await`ing `send` without renaming the public API as
/// well.
pub(crate) fn try_enqueue(
&self,
inner: InnerTask,
callbacks: TaskCallbacks,
) -> Result<TaskId, MeowError> {
let id = inner.task_id();
crate::meow_flow_log!(
"executor_api",
"try_enqueue send: task_id={:?} key={:?}",
id,
inner.dedupe_key()
);
self.cmd_tx
.try_send(TransferCmd::Enqueue { inner, callbacks })
.map_err(|e| {
crate::meow_flow_log!(
"executor_api",
"try_enqueue send failed: task_id={:?} err={}",
id,
e
);
MeowError::from_code(
InnerErrorCode::CommandSendFailed,
format!("try_enqueue_failed: {}", e),
)
})?;
crate::meow_flow_log!("executor_api", "try_enqueue send ok: task_id={:?}", id);
Ok(id)
}
pub(crate) async fn pause(&self, task_id: TaskId) -> Result<(), MeowError> {
crate::meow_flow_log!("executor_api", "pause send: task_id={:?}", task_id);
// 为 pause 建立一次性应答通道,确保可以拿到“是否找到任务”的明确结果。
let (tx, rx) = tokio::sync::oneshot::channel();
self.cmd_tx
.send(TransferCmd::Pause {
task_id,
respond_to: tx,
})
.await
.map_err(|e| {
crate::meow_flow_log!(
"executor_api",
"pause send failed: task_id={:?} err={}",
task_id,
e
);
MeowError::from_code(
InnerErrorCode::CommandSendFailed,
format!("pause_failed: {}", e),
)
})?;
crate::meow_flow_log!("executor_api", "pause send ok: task_id={:?}", task_id);
rx.await.map_err(|e| {
crate::meow_flow_log!(
"executor_api",
"pause response await failed: task_id={:?} err={}",
task_id,
e
);
MeowError::from_code(
InnerErrorCode::CommandResponseFailed,
format!("pause response failed: {}", e),
)
})?
}
pub(crate) async fn resume(&self, task_id: TaskId) -> Result<(), MeowError> {
crate::meow_flow_log!("executor_api", "resume send: task_id={:?}", task_id);
// 为 resume 建立一次性应答通道,避免“命令已发送但无结果”的静默行为。
let (tx, rx) = tokio::sync::oneshot::channel();
self.cmd_tx
.send(TransferCmd::Resume {
task_id,
respond_to: tx,
})
.await
.map_err(|e| {
crate::meow_flow_log!(
"executor_api",
"resume send failed: task_id={:?} err={}",
task_id,
e
);
MeowError::from_code(
InnerErrorCode::CommandSendFailed,
format!("resume_failed: {}", e),
)
})?;
crate::meow_flow_log!("executor_api", "resume send ok: task_id={:?}", task_id);
rx.await.map_err(|e| {
crate::meow_flow_log!(
"executor_api",
"resume response await failed: task_id={:?} err={}",
task_id,
e
);
MeowError::from_code(
InnerErrorCode::CommandResponseFailed,
format!("resume response failed: {}", e),
)
})?
}
pub(crate) async fn cancel(&self, task_id: TaskId) -> Result<(), MeowError> {
crate::meow_flow_log!("executor_api", "cancel send: task_id={:?}", task_id);
// 为 cancel 建立一次性应答通道,确保未知 task_id 能返回明确错误。
let (tx, rx) = tokio::sync::oneshot::channel();
self.cmd_tx
.send(TransferCmd::Cancel {
task_id,
respond_to: tx,
})
.await
.map_err(|e| {
crate::meow_flow_log!(
"executor_api",
"cancel send failed: task_id={:?} err={}",
task_id,
e
);
MeowError::from_code(
InnerErrorCode::CommandSendFailed,
format!("cancel_failed: {}", e),
)
})?;
crate::meow_flow_log!("executor_api", "cancel send ok: task_id={:?}", task_id);
rx.await.map_err(|e| {
crate::meow_flow_log!(
"executor_api",
"cancel response await failed: task_id={:?} err={}",
task_id,
e
);
MeowError::from_code(
InnerErrorCode::CommandResponseFailed,
format!("cancel response failed: {}", e),
)
})?
}
pub(crate) async fn snapshot(&self) -> Result<TransferSnapshot, MeowError> {
crate::meow_flow_log!("executor_api", "snapshot send");
let (tx, rx) = tokio::sync::oneshot::channel();
self.cmd_tx
.send(TransferCmd::Snapshot { respond_to: tx })
.await
.map_err(|e| {
crate::meow_flow_log!("executor_api", "snapshot send failed: err={}", e);
MeowError::from_code(
InnerErrorCode::CommandSendFailed,
format!("snapshot cmd_tx send failed: {}", e),
)
})?;
rx.await.map_err(|e| {
crate::meow_flow_log!("executor_api", "snapshot response await failed: err={}", e);
MeowError::from_code(
InnerErrorCode::CommandResponseFailed,
format!("snapshot rx.await failed: {}", e),
)
})
}
pub(crate) async fn close(&self) -> Result<(), MeowError> {
crate::meow_flow_log!("executor_api", "close send");
let (tx, rx) = tokio::sync::oneshot::channel();
self.cmd_tx
.send(TransferCmd::Close { respond_to: tx })
.await
.map_err(|e| {
crate::meow_flow_log!("executor_api", "close send failed: err={}", e);
MeowError::from_code(
InnerErrorCode::CommandSendFailed,
format!("close_failed: {}", e),
)
})?;
let result = rx.await.map_err(|e| {
MeowError::from_code(
InnerErrorCode::CommandResponseFailed,
format!("close response failed: {}", e),
)
})?;
// Only mark as fully closed after the worker acknowledges. If the
// handshake above failed, keep `close_invoked = false` so `Drop`
// still performs its best-effort shutdown path.
if result.is_ok() {
self.join_worker_thread().await?;
self.close_invoked.store(true, Ordering::SeqCst);
}
result
}
}
fn to_record_inner(
inner: &InnerTask,
status: TransferStatus,
transferred: u64,
file_size_u64: u64,
) -> FileTransferRecord {
let progress = if file_size_u64 == 0 {
0.0
} else {
transferred as f32 / file_size_u64 as f32
};
FileTransferRecord::new(
inner.task_id(),
inner.file_sign_arc(),
inner.file_name_arc(),
file_size_u64,
progress,
status,
inner.direction(),
)
}