RAGFlow is an agent-native database: a Retrieval-Augmented Generation (RAG) engine that grew into context infrastructure.
Go agent-harnessagent-native-databaseagentic-aiagentic-retrievalagentic-searchaiai-agentscontext-enginecontext-engineeringcontext-managementharness-engineeringknowledge-compilationragretrieval-augmented-generationretrieval-harnesssearch-harness
Feat: Add a cancel button to pause tasks that are currently running or queued. (#21917)
balibabuf510e4ed56eb
diff --git a/web/src/hooks/__tests__/use-document-request-cancel-chain.test.tsx b/web/src/hooks/__tests__/use-document-request-cancel-chain.test.tsxindex 07a8ae8343..99d4304f91 100644--- a/web/src/hooks/__tests__/use-document-request-cancel-chain.test.tsx+++ b/web/src/hooks/__tests__/use-document-request-cancel-chain.test.tsx@@ -15,7 +15,10 @@*/import { IngestionTaskStatus } from '@/constants/knowledge';-import kbService, { listDocument } from '@/services/knowledge-service';+import kbService, {+ documentFilter,+ listDocument,+} from '@/services/knowledge-service';import { QueryClient, QueryClientProvider } from '@tanstack/react-query';import { act, renderHook, waitFor } from '@testing-library/react';import React from 'react';@@ -24,6 +27,7 @@ jest.mock('@/services/knowledge-service', () => ({__esModule: true,default: { documentIngest: jest.fn() },listDocument: jest.fn(),+ documentFilter: jest.fn(),}));jest.mock('@/components/list-filter-bar/use-handle-filter-submit', () => ({@@ -77,9 +81,14 @@ jest.mock('@/pages/dataset/dataset/use-select-filters', () => ({EMPTY_METADATA_FIELD: 'empty_metadata',}));-import { useFetchDocumentList, useRunDocument } from '../use-document-request';+import {+ useFetchDocumentList,+ useGetDocumentFilter,+ useRunDocument,+} from '../use-document-request';const mockList = jest.mocked(listDocument);+const mockFilter = jest.mocked(documentFilter);const mockIngest = jest.mocked(kbService.documentIngest);// Declared locally: an imported binding used in a type position breaks the@@ -109,6 +118,11 @@ const useCancelChain = () => ({run: useRunDocument(),});+const useStartFilterChain = () => ({+ filter: useGetDocumentFilter(),+ run: useRunDocument(),+});+function makeWrapper() {const queryClient = new QueryClient({defaultOptions: {@@ -151,6 +165,42 @@ describe('document cancel chain (list polling + stop-loss retry)', () => {jest.useRealTimers();});+ it('refreshes the pending counts when a parse start succeeds', async () => {+ mockFilter+ .mockResolvedValueOnce({+ data: {+ code: 0,+ data: { filter: { ingestion_status: { UNSTART: 1 } } },+ },+ } as never)+ .mockResolvedValue({+ data: {+ code: 0,+ data: { filter: { ingestion_status: { SCHEDULED: 1 } } },+ },+ } as never);+ mockIngest.mockResolvedValue({ data: { code: 0 } } as never);++ const { result } = renderHook(useStartFilterChain, {+ wrapper: makeWrapper(),+ });+ await waitFor(() =>+ expect(result.current.filter.statusCounts).toEqual({ UNSTART: 1 }),+ );++ await act(async () => {+ await result.current.run.runDocumentByIds({+ documentIds: ['doc-start'],+ run: 1,+ });+ });++ await waitFor(() =>+ expect(result.current.filter.statusCounts).toEqual({ SCHEDULED: 1 }),+ );+ expect(mockFilter).toHaveBeenCalledTimes(2);+ });+it('keeps polling fast after the click and re-sends the cancel once it is overdue', async () => {const docId = 'doc-chain-overdue';mockList.mockResolvedValueOnce(diff --git a/web/src/hooks/document-query-keys.ts b/web/src/hooks/document-query-keys.tsindex 823d7f4241..927155ab8d 100644--- a/web/src/hooks/document-query-keys.ts+++ b/web/src/hooks/document-query-keys.ts@@ -26,6 +26,7 @@ export const enum DocumentApiAction {CreateDocument = 'createDocument',FetchDocumentThumbnails = 'fetchDocumentThumbnails',ParseDocument = 'parseDocument',+ StopAllDocuments = 'stopAllDocuments',}export const DocumentKeys = {diff --git a/web/src/hooks/use-document-request.ts b/web/src/hooks/use-document-request.tsindex bc4c06ce17..8c046b744e 100644--- a/web/src/hooks/use-document-request.ts+++ b/web/src/hooks/use-document-request.ts@@ -50,6 +50,7 @@ import kbService, {documentFilter,listDocument,renameDocument,+ stopAllDocuments,uploadDocument,} from '@/services/knowledge-service';import { restAPIv1 } from '@/utils/api';@@ -370,6 +371,7 @@ export const useFetchDocumentsByIds = (// get document filterexport const useGetDocumentFilter = (): {filter: IDocumentInfoFilter;+ statusCounts: Record<string, number>;onOpenChange: (open: boolean) => void;} => {const { knowledgeId } = useGetKnowledgeSearchParams();@@ -404,6 +406,9 @@ export const useGetDocumentFilter = (): {suffix: {},metadata: {},},+ // Per-status exact counts (UNSTART/CREATED/SCHEDULED/RUNNING/...) before+ // the display-bucket adaptation, for callers that act on a single status.+ statusCounts: data?.filter?.ingestion_status ?? {},onOpenChange: handleOpenChange,};};@@ -549,6 +554,12 @@ export const useRunDocument = () => {queryKey: DocumentKeys.all(),});}+ // The status facet is independent of the list's optimistic state.+ // Refresh it as soon as the start succeeds so the dataset-wide cancel+ // control appears without waiting for the next list poll.+ queryClient.invalidateQueries({+ queryKey: DocumentKeys.allFilters(),+ });message.success(i18n.t('message.operated'));} else {queryClient.invalidateQueries({@@ -577,6 +588,48 @@ export const useRunDocument = () => {return { runDocumentByIds, loading, data };};+// Cancel every parsing task whose status is in runStatuses (dataset-wide,+// server-side document resolution). Mirrors the per-document cancel flow of+// useRunDocument: drop in-flight list refetches first so a pre-cancel+// response cannot land after the mutation, then invalidate the list and the+// status facet counts so both refresh immediately.+export const useStopAllDocuments = () => {+ const queryClient = useQueryClient();++ const {+ data,+ isPending: loading,+ mutateAsync,+ } = useMutation({+ mutationKey: [DocumentApiAction.StopAllDocuments],+ mutationFn: async ({+ datasetId,+ runStatuses,+ }: {+ datasetId: string;+ runStatuses: string[];+ }) => {+ await queryClient.cancelQueries({ queryKey: DocumentKeys.all() });+ const { data } = await stopAllDocuments(datasetId, runStatuses);+ if (data.code === 0) {+ message.success(+ i18n.t('knowledgeDetails.cancelTasksSuccess', {+ count: data.data?.success_count ?? 0,+ }),+ );+ }+ queryClient.invalidateQueries({ queryKey: DocumentKeys.all() });+ queryClient.invalidateQueries({ queryKey: DocumentKeys.allFilters() });+ return data;+ },+ onError: () => {+ queryClient.invalidateQueries({ queryKey: DocumentKeys.all() });+ },+ });++ return { stopAllDocuments: mutateAsync, loading, data };+};+export const useRemoveDocument = () => {const queryClient = useQueryClient();const { id: datasetId } = useParams();diff --git a/web/src/locales/en.ts b/web/src/locales/en.tsindex 2a42dd006e..5cfe20ad92 100644--- a/web/src/locales/en.ts+++ b/web/src/locales/en.ts@@ -606,6 +606,15 @@ Example: A 1 KB message with 1024-dim embedding uses ~9 KB. The 5 MB default limrunningStatus3: 'Success',runningStatus4: 'Fail',runningStatusQueued: 'Queued',+ cancelParsingTasks: 'Cancel parsing tasks',+ filesParsing: '{{count}} files parsing',+ filesPending: '{{count}} files pending',+ cancelParsingConfirmTitle: 'Cancel parsing',+ cancelParsingConfirm:+ 'Cancel parsing for the {{count}} files that are currently parsing?',+ cancelPendingConfirm:+ 'Remove the {{count}} pending files from the parsing queue?',+ cancelTasksSuccess: 'Canceled {{count}} parsing tasks',pageRanges: 'Page ranges',pageRangesTip:'Range of pages to be parsed; pages outside this range will not be processed.',diff --git a/web/src/locales/zh.ts b/web/src/locales/zh.tsindex 00b99985df..6ecc381fc1 100644--- a/web/src/locales/zh.ts+++ b/web/src/locales/zh.ts@@ -545,6 +545,13 @@ export default {runningStatus3: '成功',runningStatus4: '失败',runningStatusQueued: '排队中',+ cancelParsingTasks: '取消解析任务',+ filesParsing: '{{count}} 个文件解析中',+ filesPending: '{{count}} 个文件排队中',+ cancelParsingConfirmTitle: '取消解析',+ cancelParsingConfirm: '确定取消正在解析的 {{count}} 个文件吗?',+ cancelPendingConfirm: '确定取消排队中的 {{count}} 个文件吗?',+ cancelTasksSuccess: '已取消 {{count}} 个解析任务',pageRanges: '页码范围',pageRangesTip:'页码范围:定义需要解析的页面范围。 不包含在这些范围内的页面将被忽略。',diff --git a/web/src/pages/dataset/dataset/cancel-parsing-dropdown.test.tsx b/web/src/pages/dataset/dataset/cancel-parsing-dropdown.test.tsxnew file mode 100644index 0000000000..cb8966c590--- /dev/null+++ b/web/src/pages/dataset/dataset/cancel-parsing-dropdown.test.tsx@@ -0,0 +1,152 @@+import { fireEvent, render, screen, waitFor } from '@testing-library/react';++// NOTE: this suite uses jest.mock, so it is transformed by esbuild-jest's+// babel pipeline, which does not strip TypeScript. Imported bindings must not+// appear in type annotations and factory-referenced outer variables must keep+// the `mock` prefix (babel-plugin-jest-hoist restriction).+const mockStopAllDocuments = jest.fn();+let mockStatusCounts: Record<string, number> = {};++jest.mock('react-router', () => ({+ useParams: () => ({ id: 'kb-1' }),+}));++jest.mock('react-i18next', () => ({+ useTranslation: () => ({+ t: (key: string, options?: { count?: number }) =>+ options?.count === undefined ? key : `${key}:${options.count}`,+ }),+}));++jest.mock('@/hooks/use-document-request', () => ({+ useGetDocumentFilter: () => ({ statusCounts: mockStatusCounts }),+ useStopAllDocuments: () => ({ stopAllDocuments: mockStopAllDocuments }),+}));++import { TooltipProvider } from '@/components/ui/tooltip';+import { CancelParsingDropdown } from './cancel-parsing-dropdown';++beforeAll(() => {+ // jsdom lacks APIs Radix Popper/Menu rely on.+ global.ResizeObserver = class {+ observe() {}+ unobserve() {}+ disconnect() {}+ };+ if (!Element.prototype.hasPointerCapture) {+ Element.prototype.hasPointerCapture = () => false;+ }+ if (!Element.prototype.scrollIntoView) {+ Element.prototype.scrollIntoView = () => {};+ }+});++beforeEach(() => {+ mockStopAllDocuments.mockReset();+ mockStopAllDocuments.mockResolvedValue({ code: 0 });+ mockStatusCounts = {};+});++function renderDropdown() {+ return render(+ <TooltipProvider>+ <CancelParsingDropdown />+ </TooltipProvider>,+ );+}++function openMenu() {+ // Radix DropdownMenuTrigger toggles on pointerdown and on ArrowDown/Enter.+ // jsdom pointer events do not reliably drive Radix, so open via keyboard.+ fireEvent.keyDown(screen.getByRole('button'), { key: 'ArrowDown' });+}++describe('CancelParsingDropdown', () => {+ it('renders nothing when no parsing or pending files exist', () => {+ mockStatusCounts = { COMPLETED: 5 };+ const { container } = renderDropdown();+ expect(container.querySelector('button')).toBeNull();+ });++ it('renders the trigger when only pending files exist', () => {+ mockStatusCounts = { SCHEDULED: 7 };+ renderDropdown();+ expect(screen.getByRole('button')).toBeInTheDocument();+ });++ it('shows per-status counts in the dropdown', async () => {+ mockStatusCounts = { RUNNING: 297, SCHEDULED: 527 };+ renderDropdown();+ openMenu();+ expect(+ await screen.findByText('knowledgeDetails.filesParsing:297'),+ ).toBeInTheDocument();+ expect(+ screen.getByText('knowledgeDetails.filesPending:527'),+ ).toBeInTheDocument();+ });++ it('disables a row whose status count is zero', async () => {+ mockStatusCounts = { RUNNING: 3 };+ renderDropdown();+ openMenu();+ const pendingItem = await screen.findByText(+ 'knowledgeDetails.filesPending:0',+ );+ expect(pendingItem.closest('[role="menuitem"]')).toHaveAttribute(+ 'aria-disabled',+ 'true',+ );+ });++ it('asks for confirmation and cancels RUNNING tasks on ok', async () => {+ mockStatusCounts = { RUNNING: 297, SCHEDULED: 527 };+ renderDropdown();+ openMenu();+ fireEvent.click(+ await screen.findByText('knowledgeDetails.filesParsing:297'),+ );++ expect(+ await screen.findByText('knowledgeDetails.cancelParsingConfirm:297'),+ ).toBeInTheDocument();++ fireEvent.click(screen.getByTestId('confirm-delete-dialog-confirm-btn'));+ await waitFor(() =>+ expect(mockStopAllDocuments).toHaveBeenCalledWith({+ datasetId: 'kb-1',+ runStatuses: ['RUNNING'],+ }),+ );+ });++ it('asks for confirmation and cancels SCHEDULED tasks on ok', async () => {+ mockStatusCounts = { RUNNING: 297, SCHEDULED: 527 };+ renderDropdown();+ openMenu();+ fireEvent.click(+ await screen.findByText('knowledgeDetails.filesPending:527'),+ );++ expect(+ await screen.findByText('knowledgeDetails.cancelPendingConfirm:527'),+ ).toBeInTheDocument();++ fireEvent.click(screen.getByTestId('confirm-delete-dialog-confirm-btn'));+ await waitFor(() =>+ expect(mockStopAllDocuments).toHaveBeenCalledWith({+ datasetId: 'kb-1',+ runStatuses: ['SCHEDULED'],+ }),+ );+ });++ it('does not call the api when the confirm dialog is dismissed', async () => {+ mockStatusCounts = { RUNNING: 3 };+ renderDropdown();+ openMenu();+ fireEvent.click(await screen.findByText('knowledgeDetails.filesParsing:3'));+ fireEvent.click(screen.getByTestId('confirm-delete-dialog-cancel-btn'));+ expect(mockStopAllDocuments).not.toHaveBeenCalled();+ });+});diff --git a/web/src/pages/dataset/dataset/cancel-parsing-dropdown.tsx b/web/src/pages/dataset/dataset/cancel-parsing-dropdown.tsxnew file mode 100644index 0000000000..dcc8df2451--- /dev/null+++ b/web/src/pages/dataset/dataset/cancel-parsing-dropdown.tsx@@ -0,0 +1,167 @@+import { ConfirmDeleteDialog } from '@/components/confirm-delete-dialog';+import { Button } from '@/components/ui/button';+import {+ DropdownMenu,+ DropdownMenuContent,+ DropdownMenuItem,+ DropdownMenuSeparator,+ DropdownMenuTrigger,+} from '@/components/ui/dropdown-menu';+import { RAGFlowTooltip } from '@/components/ui/tooltip';+import { IngestionTaskStatus } from '@/constants/knowledge';+import {+ useGetDocumentFilter,+ useStopAllDocuments,+} from '@/hooks/use-document-request';+import { Pause, SquarePause } from 'lucide-react';+import { useCallback, useState } from 'react';+import { useTranslation } from 'react-i18next';+import { useParams } from 'react-router';++enum CancelScope {+ Parsing = 'parsing',+ Pending = 'pending',+}++const CancelScopeStatuses: Record<CancelScope, IngestionTaskStatus[]> = {+ [CancelScope.Parsing]: [IngestionTaskStatus.RUNNING],+ [CancelScope.Pending]: [IngestionTaskStatus.SCHEDULED],+};++function useCancelParsingTasks() {+ const { t } = useTranslation();+ const { id: datasetId } = useParams();+ const { statusCounts } = useGetDocumentFilter();+ const { stopAllDocuments } = useStopAllDocuments();+ const [confirmScope, setConfirmScope] = useState<CancelScope | null>(null);++ const counts: Record<CancelScope, number> = {+ [CancelScope.Parsing]: statusCounts[IngestionTaskStatus.RUNNING] ?? 0,+ [CancelScope.Pending]: statusCounts[IngestionTaskStatus.SCHEDULED] ?? 0,+ };++ const showConfirm = useCallback((scope: CancelScope) => {+ setConfirmScope(scope);+ }, []);++ const handleConfirmOpenChange = useCallback((open: boolean) => {+ if (!open) {+ setConfirmScope(null);+ }+ }, []);++ const handleConfirm = useCallback(async () => {+ if (!confirmScope || !datasetId) {+ return;+ }+ await stopAllDocuments({+ datasetId,+ runStatuses: CancelScopeStatuses[confirmScope],+ });+ setConfirmScope(null);+ }, [confirmScope, datasetId, stopAllDocuments]);++ const confirmContent =+ confirmScope === null+ ? ''+ : t(+ confirmScope === CancelScope.Parsing+ ? 'knowledgeDetails.cancelParsingConfirm'+ : 'knowledgeDetails.cancelPendingConfirm',+ { count: counts[confirmScope] },+ );++ return {+ counts,+ confirmScope,+ showConfirm,+ handleConfirmOpenChange,+ handleConfirm,+ confirmContent,+ };+}++interface CancelScopeItemProps {+ scope: CancelScope;+ label: string;+ disabled: boolean;+ onSelect: (scope: CancelScope) => void;+}++function CancelScopeItem({+ scope,+ label,+ disabled,+ onSelect,+}: CancelScopeItemProps) {+ const handleClick = useCallback(() => {+ onSelect(scope);+ }, [onSelect, scope]);++ return (+ <DropdownMenuItem disabled={disabled} onClick={handleClick}>+ <span>{label}</span>+ <SquarePause className="text-state-error" />+ </DropdownMenuItem>+ );+}++export function CancelParsingDropdown() {+ const { t } = useTranslation();+ const {+ counts,+ confirmScope,+ showConfirm,+ handleConfirmOpenChange,+ handleConfirm,+ confirmContent,+ } = useCancelParsingTasks();++ if (counts[CancelScope.Parsing] + counts[CancelScope.Pending] === 0) {+ return null;+ }++ return (+ <>+ <DropdownMenu>+ <RAGFlowTooltip+ asChild+ tooltip={t('knowledgeDetails.cancelParsingTasks')}+ >+ <DropdownMenuTrigger asChild>+ <Button variant="outline" size="icon">+ <Pause />+ </Button>+ </DropdownMenuTrigger>+ </RAGFlowTooltip>+ <DropdownMenuContent align="end" className="w-auto min-w-56">+ <CancelScopeItem+ scope={CancelScope.Parsing}+ label={t('knowledgeDetails.filesParsing', {+ count: counts[CancelScope.Parsing],+ })}+ disabled={counts[CancelScope.Parsing] === 0}+ onSelect={showConfirm}+ />+ <DropdownMenuSeparator />+ <CancelScopeItem+ scope={CancelScope.Pending}+ label={t('knowledgeDetails.filesPending', {+ count: counts[CancelScope.Pending],+ })}+ disabled={counts[CancelScope.Pending] === 0}+ onSelect={showConfirm}+ />+ </DropdownMenuContent>+ </DropdownMenu>+ <ConfirmDeleteDialog+ open={confirmScope !== null}+ onOpenChange={handleConfirmOpenChange}+ title={t('knowledgeDetails.cancelParsingConfirmTitle')}+ content={{ title: confirmContent }}+ okButtonText={t('common.ok')}+ onOk={handleConfirm}+ />+ </>+ );+}diff --git a/web/src/pages/dataset/dataset/index.tsx b/web/src/pages/dataset/dataset/index.tsxindex 3164bec6e7..f2a56aea25 100644--- a/web/src/pages/dataset/dataset/index.tsx+++ b/web/src/pages/dataset/dataset/index.tsx@@ -28,6 +28,7 @@ import { MetadataType } from '../components/metedata/constant';import { useManageMetadata } from '../components/metedata/hooks/use-manage-modal';import { ManageMetadataModal } from '../components/metedata/manage-modal';import { useKnowledgeBaseContext } from '../contexts/knowledge-base-context';+import { CancelParsingDropdown } from './cancel-parsing-dropdown';import { DatasetTable } from './dataset-table';import { useBulkOperateDataset } from './use-bulk-operate-dataset';import { useCreateEmptyDocument } from './use-create-empty-document';@@ -162,23 +163,26 @@ export default function Dataset() {</div>}>- <DropdownMenu>- <DropdownMenuTrigger asChild>- <Button size="default">- <LucidePlus />- {t('knowledgeDetails.addFile')}- </Button>- </DropdownMenuTrigger>- <DropdownMenuContent className="w-auto min-w-40" align="end">- <DropdownMenuItem onClick={showDocumentUploadModal}>- {t('fileManager.uploadFile')}- </DropdownMenuItem>- <DropdownMenuSeparator />- <DropdownMenuItem onClick={showCreateModal}>- {t('knowledgeDetails.emptyFiles')}- </DropdownMenuItem>- </DropdownMenuContent>- </DropdownMenu>+ <div className="flex items-center gap-2">+ <CancelParsingDropdown />+ <DropdownMenu>+ <DropdownMenuTrigger asChild>+ <Button size="default">+ <LucidePlus />+ {t('knowledgeDetails.addFile')}+ </Button>+ </DropdownMenuTrigger>+ <DropdownMenuContent className="w-auto min-w-40" align="end">+ <DropdownMenuItem onClick={showDocumentUploadModal}>+ {t('fileManager.uploadFile')}+ </DropdownMenuItem>+ <DropdownMenuSeparator />+ <DropdownMenuItem onClick={showCreateModal}>+ {t('knowledgeDetails.emptyFiles')}+ </DropdownMenuItem>+ </DropdownMenuContent>+ </DropdownMenu>+ </div></ListFilterBar>{rowSelectionIsEmpty || (diff --git a/web/src/services/knowledge-service.ts b/web/src/services/knowledge-service.tsindex 4f241359c7..24ce6990cc 100644--- a/web/src/services/knowledge-service.ts+++ b/web/src/services/knowledge-service.ts@@ -407,6 +407,20 @@ export const applyDatasetParserConfig = (datasetId: string) =>true,);+const stopAllDocumentsProxy = registerNextServer({+ stopAllDocuments: {+ url: ({ datasetId }: { datasetId: string }) =>+ api.stopAllDocuments(datasetId),+ method: 'post',+ },+});++export const stopAllDocuments = (datasetId: string, runStatuses: string[]) =>+ stopAllDocumentsProxy.stopAllDocuments(+ { datasetId, data: { cancel_all: true, run_statuses: runStatuses } },+ true,+ );+// Using RESTful API: GET /api/v1/datasets/{dataset_id}/documentsexport const listDocument = (params?: IFetchKnowledgeListRequestParams,diff --git a/web/src/utils/api.ts b/web/src/utils/api.tsindex dddb1effe7..cec36143e1 100644--- a/web/src/utils/api.ts+++ b/web/src/utils/api.ts@@ -277,6 +277,8 @@ const apiEndpoints = {documentRename: (datasetId: string, documentId: string) =>`${restAPIv1}/datasets/${datasetId}/documents/${documentId}`,documentIngest: `${restAPIv1}/documents/ingest`,+ stopAllDocuments: (datasetId: string) =>+ `${restAPIv1}/datasets/${datasetId}/documents/stop`,documentCreate: (datasetId: string) =>`${restAPIv1}/datasets/${datasetId}/documents?type=empty`,documentChangeParser: (datasetId: string, documentId: string) =>