Skip to content

armgit / peach

Public Imported from GitHub
0

Peach: Local-first video metadata scraper and media manager.

feat(tasks): 为任务中心接入暂停继续与取消控件

longmeidao871cac5000a6
diff --git a/frontend/src/react/activity/activity-page.tsx b/frontend/src/react/activity/activity-page.tsx
index 66cc73a64..d0b345886 100644
--- a/frontend/src/react/activity/activity-page.tsx
+++ b/frontend/src/react/activity/activity-page.tsx
@@ -34,10 +34,11 @@ import { Disclosure } from '../settings/section';
import { BackgroundIssues } from './background-issues';
import { DownloadsPanel } from './downloads-panel';
import { ErrorDetails, ErrorExcerpt } from './error-excerpt';
+import { TaskControls } from './task-controls';
import {
elapsedText, fetchEarlier, fetchTasks, foldByKind, foldRoutine, followupDetail, followupTally, groupFollowups, isActive,
hasResultProblems, isRoutine, latestOfKind, mergeFinished, momentText, pollInterval, problemDestination, progressText,
- statusLabel, summaryItems, taskIssues, TASKS_KEY, TRIGGER_LABELS, type FollowupCounts, type TaskRunPayload,
+ statusLabel, summaryItems, taskIssues, TASKS_KEY, TRIGGER_LABELS, type FollowupCounts, type TaskControlState, type TaskRunPayload,
} from './tasks';
/** 一张卡里最多列多少条后继。几批合成一张卡时会有上千条,全画出来一屏都是同一句。 */
@@ -50,7 +51,15 @@ const BADGE_COLORS: Record<string, 'lime' | 'rose' | 'yellow' | 'blue' | 'neutra
succeeded: 'lime', failed: 'rose', cancelled: 'neutral', interrupted: 'yellow', running: 'blue', pending: 'neutral',
};
+const CONTROL_LABELS: Record<TaskControlState, string> = {
+ running: '进行中', pausing: '正在暂停', paused: '已暂停', cancelling: '正在取消',
+};
+
function StatusBadge({ run }: { run: TaskRunPayload }) {
+ const control = isActive(run) ? run.control?.state : undefined;
+ if (control && control !== 'running') {
+ return <Chip color="neutral"><span data-copy-key={`tasks.control.state.${control}`}>{CONTROL_LABELS[control]}</span></Chip>;
+ }
const partial = run.status === 'failed' && run.task_key === 'library-processing'
&& run.result_summary?.outcome === 'partial';
const problems = partial || run.status === 'succeeded' && hasResultProblems(run);
@@ -79,6 +88,8 @@ function FollowupList({ rows }: { rows: TaskRunPayload[] }) {
{detail
? <span className="min-w-0 break-words text-caption-1-regular text-text-secondary">{detail}</span>
: null}
+ {isActive(row) && row.control?.actions.length
+ ? <div className="w-full min-w-0"><TaskControls run={row} /></div> : null}
{/* 排队中的那些还没有结果:空的「技术详情」展开只有一对花括号。 */}
{Object.keys(row.result_summary || {}).length
? <div className="w-full min-w-0">
@@ -126,6 +137,7 @@ function RunCard(
</div>
<p className="text-caption-1-regular text-text-secondary">{meta}</p>
{children}
+ <TaskControls run={run} />
</div>
{shown ? <div className="border-t border-separator-border px-5 py-2.5">
<Disclosure summary={`任务明细 · ${total.toLocaleString()} 项`}
@@ -155,7 +167,9 @@ function RunCard(
function RunningRun({ run, followups }: { run: TaskRunPayload; followups?: TaskRunPayload[] }) {
const total = run.progress_total || 0;
const current = run.progress_current || 0;
- const label = run.progress_label || '正在进行';
+ const control = run.control?.state;
+ const stopping = control && control !== 'running';
+ const label = stopping ? CONTROL_LABELS[control] : run.progress_label || '正在进行';
const elapsed = elapsedText(run.elapsed_seconds);
const meta = [TRIGGER_LABELS[run.trigger] || run.trigger, elapsed && `已跑 ${elapsed}`]
.filter(Boolean).join(' · ');
@@ -166,7 +180,8 @@ function RunningRun({ run, followups }: { run: TaskRunPayload; followups?: TaskR
<Progress label={label} value={Math.min(current, total)} max={total} />
<p className="text-caption-1-regular text-text-secondary wrap-anywhere">{label} · {progressText(current, total)} 项</p>
</div>
- : <LoadingDots label={label} />}
+ : stopping ? <p data-copy-key={`tasks.control.state.${control}`}
+ className="text-caption-1-regular text-text-secondary">{label}</p> : <LoadingDots label={label} />}
</RunCard>
);
}
diff --git a/frontend/src/react/activity/task-controls.tsx b/frontend/src/react/activity/task-controls.tsx
new file mode 100644
index 000000000..c1ce619b8
--- /dev/null
+++ b/frontend/src/react/activity/task-controls.tsx
@@ -0,0 +1,35 @@
+/* 任务动作由服务端逐轮给出;收到控制请求不代表后台已经停稳,状态仍以轮询为准。 */
+import { useQueryClient } from '@tanstack/react-query';
+
+import { Button } from '@/components/base/buttons/button';
+
+import { Note } from '../components/note';
+import { busyProps, useAction } from '../settings/use-action';
+import { controlTask, isActive, TASKS_KEY, type TaskControlAction, type TaskRunPayload } from './tasks';
+
+export function TaskControls({ run }: { run: TaskRunPayload }) {
+ const client = useQueryClient();
+ const request = useAction();
+ const actions = run.control?.actions || [];
+ if (!isActive(run) || !actions.length) return null;
+
+ const submit = (action: TaskControlAction) => {
+ void request.run(action, (signal) => controlTask(run.id, action, signal), () => {
+ void client.invalidateQueries({ queryKey: TASKS_KEY });
+ });
+ };
+
+ return (
+ <div className="flex min-w-0 flex-col gap-2" data-task-controls={run.id}>
+ <div role="group" aria-label={`${run.task_label}任务控制`} className="flex flex-wrap items-center gap-2">
+ {actions.map((action) => <Button key={action} type="button" variant="secondary" size="small"
+ {...busyProps(request.busy === action)} aria-disabled={Boolean(request.busy) || undefined}
+ onClick={() => submit(action)}
+ data-copy-key={`tasks.control.action.${action}`}>
+ {action === 'pause' ? '暂停' : action === 'resume' ? '继续' : '取消'}
+ </Button>)}
+ </div>
+ {request.error ? <Note tone="error">{request.error}</Note> : null}
+ </div>
+ );
+}
diff --git a/frontend/src/react/activity/tasks.ts b/frontend/src/react/activity/tasks.ts
index ed9be7cb3..e7fdce238 100644
--- a/frontend/src/react/activity/tasks.ts
+++ b/frontend/src/react/activity/tasks.ts
@@ -2,7 +2,7 @@
*
* 分三次取会出现「在跑那段是新的、完成那段是旧的」这种自相矛盾的一屏,所以只有一个
* queryKey。首屏由 `prefetchTasks` 写进 Query 缓存,组件挂上去读的就是它。 */
-import { apiGet } from '../../api';
+import { apiGet, apiSend } from '../../api';
import { fmtSize } from '@peach/legacy/core';
import { requestErrorMessage } from '../../core/request-error';
import { queryClient } from '../query';
@@ -11,6 +11,9 @@ export const TASKS_URL = '/api/tasks';
/** 整页共用这一个键:三段是同一次响应的三个字段。 */
export const TASKS_KEY = ['tasks'] as const;
+export type TaskControlAction = 'pause' | 'resume' | 'cancel';
+export type TaskControlState = 'running' | 'pausing' | 'paused' | 'cancelling';
+
export interface TaskRunPayload {
id: number;
task_key: string;
@@ -32,6 +35,8 @@ export interface TaskRunPayload {
/** 这条后继要做的那件事的全名。不是后继时是空串,界面据此判断它挂不挂到父卡片下。 */
followup_key: string;
followup_depth: number;
+ /** 服务端给出当前控制状态与可用动作,界面不按任务种类推断。 */
+ control?: { state: TaskControlState; actions: TaskControlAction[] };
}
export interface ActivityData {
@@ -110,6 +115,9 @@ export const pollInterval = (data: ActivityData | undefined): number =>
export const fetchTasks = (signal?: AbortSignal) => apiGet<ActivityData>(TASKS_URL, signal);
+export const controlTask = (id: number, action: TaskControlAction, signal?: AbortSignal) =>
+ apiSend(`${TASKS_URL}/${id}/control`, { action }, 'POST', signal);
+
/** 首屏:取完数才画。中止时 `fetchQuery` 把 `AbortError` 抛回给挂载方,它据此放弃这一次。 */
export async function prefetchTasks(signal: AbortSignal): Promise<void> {
await queryClient.fetchQuery({ queryKey: TASKS_KEY, queryFn: () => fetchTasks(signal) });
diff --git a/frontend/test/react/activity.test.tsx b/frontend/test/react/activity.test.tsx
index 385951e48..74fdbde5c 100644
--- a/frontend/test/react/activity.test.tsx
+++ b/frontend/test/react/activity.test.tsx
@@ -17,7 +17,7 @@ import type { ActivityData, FinishedPage, TaskRunPayload } from '../../src/react
import type { DownloadsSnapshot } from '../../src/react/bundle';
import { queryClient } from '../../src/react/query';
-import { buttonNamed, click, mount, mountRoot, settle } from './render';
+import { buttonNamed, click, mount, mountRoot, pending, settle } from './render';
// 客户端是模块级的单例(所有 React 根共用一个),用例之间不清就互相喂数据。
afterEach(() => queryClient.clear());
@@ -214,6 +214,120 @@ it('总量未知时不画假进度条,只说正在做什么', async () => {
expect(host.querySelector('[role=status]')?.textContent).toContain('正在查第三个来源');
});
+it('活动任务按服务端给出的动作暂停、继续和取消,并重新读取进度', async () => {
+ const posts: [string, unknown][] = [];
+ let current = run({ control: { state: 'running', actions: ['pause', 'cancel'] } });
+ stubFetch(async (input, init) => {
+ if (init?.method === 'POST') {
+ const body = JSON.parse(String(init.body));
+ posts.push([input, body]);
+ current = body.action === 'pause'
+ ? { ...current, control: { state: 'paused', actions: ['resume', 'cancel'] } }
+ : body.action === 'resume'
+ ? { ...current, control: { state: 'running', actions: ['pause', 'cancel'] } }
+ : { ...current, control: { state: 'cancelling', actions: [] } };
+ }
+ return { ok: true, status: 200, json: async () => payload({ running: [current] }) };
+ });
+ await prefetchTasks(new AbortController().signal);
+ const host = await mount(page());
+ await click(buttonNamed('暂停', host));
+ await vi.waitFor(() => expect(buttonNamed('继续', host)).not.toBeNull());
+ expect(host.querySelector('[data-run-id="1"]')?.textContent).toContain('已暂停');
+ expect(host.querySelector('[role="progressbar"]')?.getAttribute('aria-valuenow')).toBe('3');
+ await click(buttonNamed('继续', host));
+ await vi.waitFor(() => expect(buttonNamed('暂停', host)).not.toBeNull());
+ await click(buttonNamed('取消', host));
+ await vi.waitFor(() => expect(host.querySelector('[data-run-id="1"]')?.textContent).toContain('正在取消'));
+ expect(host.textContent).not.toContain('已取消');
+ expect(host.querySelector('[data-task-controls]')).toBeNull();
+ expect(posts).toEqual([
+ ['/api/tasks/1/control', { action: 'pause' }],
+ ['/api/tasks/1/control', { action: 'resume' }],
+ ['/api/tasks/1/control', { action: 'cancel' }],
+ ]);
+});
+
+it.each([
+ ['pausing', '正在暂停', ['resume', 'cancel']],
+ ['paused', '已暂停', ['resume', 'cancel']],
+ ['cancelling', '正在取消', []],
+] as const)('未知总量的任务处于 %s 时展示真实状态,不显示推进动画', async (state, label, actions) => {
+ const { host } = await open(payload({ running: [run({ progress_total: null, progress_current: null,
+ control: { state, actions: [...actions] } })] }));
+ expect(host.querySelector('[data-run-id="1"]')?.textContent).toContain(label);
+ expect(host.querySelector('[role="status"]')).toBeNull();
+ expect(buttonNamed('暂停', host)).toBeNull();
+ expect(Boolean(buttonNamed('继续', host))).toBe(state !== 'cancelling');
+});
+
+it('任务控制请求等待时保持按钮焦点并阻止重复提交', async () => {
+ const response = pending<{ ok: boolean; status: number; json: () => Promise<unknown> }>();
+ const posts: string[] = [];
+ const current = run({ control: { state: 'running', actions: ['pause', 'cancel'] } });
+ stubFetch(async (input, init) => {
+ if (init?.method === 'POST') {
+ posts.push(input);
+ return response.answer;
+ }
+ return { ok: true, status: 200, json: async () => payload({ running: [current] }) };
+ });
+ await prefetchTasks(new AbortController().signal);
+ const host = await mount(page());
+ const pause = buttonNamed('暂停', host)!;
+ pause.focus();
+ await click(pause);
+ expect(pause.hasAttribute('disabled')).toBe(false);
+ expect(pause.getAttribute('aria-busy')).toBe('true');
+ expect(document.activeElement).toBe(pause);
+ await click(pause);
+ await click(buttonNamed('取消', host));
+ expect(posts).toEqual(['/api/tasks/1/control']);
+ await response.release({ ok: true, status: 200, json: async () => ({ ok: true }) });
+});
+
+it('任务控制失败保留原状态和原因,可以在原位重试', async () => {
+ let attempts = 0;
+ const current = run({ control: { state: 'running', actions: ['pause', 'cancel'] } });
+ stubFetch(async (_input, init) => {
+ if (init?.method === 'POST') {
+ attempts += 1;
+ return { ok: false, status: 409, json: async () => ({ message: '任务已变化,请刷新后重试' }) };
+ }
+ return { ok: true, status: 200, json: async () => payload({ running: [current] }) };
+ });
+ await prefetchTasks(new AbortController().signal);
+ const host = await mount(page());
+ await click(buttonNamed('暂停', host));
+ expect(host.querySelector('[data-task-controls] [role="alert"]')?.textContent).toContain('任务已变化');
+ expect(buttonNamed('继续', host)).toBeNull();
+ await click(buttonNamed('暂停', host));
+ expect(attempts).toBe(2);
+});
+
+it('后继任务使用自身任务号控制,已结束任务没有控制按钮', async () => {
+ const child = followup(1, { id: 90, status: 'pending', finished_at: null,
+ control: { state: 'paused', actions: ['resume', 'cancel'] } });
+ const ended = run({ status: 'succeeded', control: { state: 'running', actions: ['pause', 'cancel'] } });
+ const posts: string[] = [];
+ stubFetch(async (input, init) => {
+ if (init?.method === 'POST') posts.push(input);
+ return { ok: true, status: 200, json: async () => payload({ running: [child], finished: [ended] }) };
+ });
+ await prefetchTasks(new AbortController().signal);
+ const host = await mount(page());
+ expect(host.querySelector('[data-task-controls="1"]')).toBeNull();
+ const controls = host.querySelector('[data-task-controls="90"]')!;
+ expect(controls).not.toBeNull();
+ await click(buttonNamed('继续', controls));
+ expect(posts).toEqual(['/api/tasks/90/control']);
+});
+
+it('服务端未给出控制能力时不按任务种类自行增加按钮', async () => {
+ const { host } = await open(payload({ running: [run()] }));
+ expect(host.querySelector('[data-task-controls]')).toBeNull();
+});
+
it('被挡下的那一轮单独成段,不在最近完成里再出现一次', async () => {
const blocked = run({
id: 7, status: 'cancelled', trigger: 'scheduled', progress_total: null,