Skip to content

armgit / dify

Public Imported from GitHub
0

Build Agentic workflows, RAG pipelines, with rich AI model and tool support on one collaborative workspace. Deploy on cloud, VPC, or self-hosted, so teams move from prototype to production without rebuilding the stack.

fix(web): use links in the document navigation menu (#44694)

yyh9ef228436847
diff --git a/oxlint-suppressions.json b/oxlint-suppressions.json
index 883a9e84123..2c2702f9328 100644
--- a/oxlint-suppressions.json
+++ b/oxlint-suppressions.json
@@ -2093,20 +2093,12 @@
"count": 1
}
},
- "web/app/components/datasets/common/document-picker/index.tsx": {
- "better-tailwindcss/enforce-logical-properties": {
- "count": 1
- }
- },
"web/app/components/datasets/common/document-picker/preview-document-picker.tsx": {
"better-tailwindcss/enforce-logical-properties": {
"count": 3
}
},
"web/app/components/datasets/common/document-status-with-action/status-with-action.tsx": {
- "better-tailwindcss/enforce-logical-properties": {
- "count": 3
- },
"eslint-react/static-components": {
"count": 2
}
diff --git a/web/app/components/datasets/common/document-picker/__tests__/index.spec.tsx b/web/app/components/datasets/common/document-picker/__tests__/index.spec.tsx
index dc846ba399e..3ba17cef352 100644
--- a/web/app/components/datasets/common/document-picker/__tests__/index.spec.tsx
+++ b/web/app/components/datasets/common/document-picker/__tests__/index.spec.tsx
@@ -3,6 +3,7 @@ import { QueryClient, QueryClientProvider } from '@tanstack/react-query'
import { render, screen, waitFor } from '@testing-library/react'
import userEvent from '@testing-library/user-event'
import { ChunkingMode, DataSourceType } from '@/models/datasets'
+import { createDeferred } from '@/test/deferred'
import { DocumentPicker } from '../index'
let mockDocumentListData: { data: DocumentWithSegmentsResponse[] } | undefined
@@ -58,8 +59,7 @@ const createDocument = (
const createProps = (overrides: Partial<React.ComponentProps<typeof DocumentPicker>> = {}) => ({
datasetId: 'dataset-1',
- value: createDocument({ id: 'doc-1', name: 'Document 1' }),
- onChange: vi.fn(),
+ currentDocument: createDocument({ id: 'doc-1', name: 'Document 1' }),
...overrides,
})
@@ -105,7 +105,7 @@ describe('DocumentPicker', () => {
it('should render the current document and chunking mode', () => {
renderDocumentPicker({
- value: createDocument({
+ currentDocument: createDocument({
id: 'current-doc',
name: 'Current Document',
doc_form: ChunkingMode.parentChild,
@@ -113,7 +113,7 @@ describe('DocumentPicker', () => {
parentMode: 'paragraph',
})
- expect(screen.getByRole('combobox', { name: 'Current Document' })).toBeInTheDocument()
+ expect(screen.getByRole('button', { name: 'Current Document' })).toBeInTheDocument()
expect(screen.getByText(/dataset.chunkingMode.parentChild/)).toBeInTheDocument()
expect(screen.getByText(/dataset.parentMode.paragraph/)).toBeInTheDocument()
})
@@ -122,7 +122,7 @@ describe('DocumentPicker', () => {
const user = userEvent.setup()
renderDocumentPicker({ datasetId: 'dataset-custom' })
- await user.click(screen.getByRole('combobox', { name: 'Document 1' }))
+ await user.click(screen.getByRole('button', { name: 'Document 1' }))
await user.type(screen.getByPlaceholderText('common.operation.search'), 'report')
await waitFor(() => {
@@ -152,7 +152,7 @@ describe('DocumentPicker', () => {
renderDocumentPicker()
- const trigger = screen.getByRole('combobox', { name: 'Document 1' })
+ const trigger = screen.getByRole('button', { name: 'Document 1' })
await user.click(trigger)
const searchInput = screen.getByPlaceholderText('common.operation.search')
@@ -168,20 +168,91 @@ describe('DocumentPicker', () => {
expect(trigger).not.toHaveFocus()
})
- it('should call onChange with the selected document', async () => {
+ it('renders document links and marks only the current page', async () => {
const user = userEvent.setup()
- const onChange = vi.fn()
- const selectedDocument = createDocument({ id: 'doc-2', name: 'Document 2' })
- mockDocumentListData = {
- data: [createDocument({ id: 'doc-1', name: 'Document 1' }), selectedDocument],
+ renderDocumentPicker()
+
+ await user.click(screen.getByRole('button', { name: 'Document 1' }))
+ const currentDocument = await screen.findByRole('menuitem', { name: 'Document 1' })
+ const otherDocument = screen.getByRole('menuitem', { name: 'Document 2' })
+
+ expect(currentDocument).toHaveAttribute('href', '/datasets/dataset-1/documents/doc-1')
+ expect(currentDocument).toHaveAttribute('aria-current', 'page')
+ expect(otherDocument).toHaveAttribute('href', '/datasets/dataset-1/documents/doc-2')
+ expect(otherDocument).not.toHaveAttribute('aria-current')
+ })
+
+ it('removes previous-query links until the new server results arrive', async () => {
+ const user = userEvent.setup()
+ const response = {
+ data: [createDocument({ id: 'report-id', name: 'Quarterly report' })],
+ total: 1,
+ page: 1,
+ limit: 20,
+ has_more: false,
}
+ const pendingSearch = createDeferred<typeof response>()
+ const initialResponse = mockUseDocumentList.getMockImplementation()!
+ mockUseDocumentList.mockImplementation((input) =>
+ input.query.keyword === 'report' ? pendingSearch.promise : initialResponse(input),
+ )
+ renderDocumentPicker()
- renderDocumentPicker({ onChange })
+ await user.click(screen.getByRole('button', { name: 'Document 1' }))
+ await screen.findByRole('menuitem', { name: 'Document 2' })
+ const input = screen.getByRole('searchbox', { name: 'common.operation.search' })
+ await user.type(input, 'report')
- await user.click(screen.getByRole('combobox', { name: 'Document 1' }))
- await user.click(await screen.findByRole('option', { name: /Document 2/ }))
+ expect(screen.queryByRole('menuitem')).not.toBeInTheDocument()
+ expect(screen.getByRole('status')).toHaveTextContent('common.loading')
+ expect(screen.queryByText('common.noData')).not.toBeInTheDocument()
+ await waitFor(() => {
+ expect(mockUseDocumentList).toHaveBeenLastCalledWith({
+ params: { dataset_id: 'dataset-1' },
+ query: { keyword: 'report', page: 1, limit: 20 },
+ })
+ })
+ await user.keyboard('{ArrowDown}{Enter}')
+ expect(input).toHaveFocus()
+ expect(screen.queryByRole('menuitem')).not.toBeInTheDocument()
+
+ pendingSearch.resolve(response)
+ const result = await screen.findByRole('menuitem', { name: 'Quarterly report' })
+ expect(result).toHaveAttribute('href', '/datasets/dataset-1/documents/report-id')
+ expect(input).toHaveFocus()
+ })
+
+ it('announces a failed search and retries without closing the menu', async () => {
+ const user = userEvent.setup()
+ mockUseDocumentList.mockRejectedValueOnce(new Error('Search unavailable'))
+ renderDocumentPicker()
+
+ const trigger = screen.getByRole('button', { name: 'Document 1' })
+ await user.click(trigger)
+ const retry = await screen.findByRole('menuitem', { name: 'common.operation.retry' })
+ expect(screen.getByRole('status')).toHaveTextContent('common.dynamicSelect.error')
+ expect(screen.queryByText('common.noData')).not.toBeInTheDocument()
+
+ await user.click(retry)
+ expect(await screen.findByRole('menuitem', { name: 'Document 2' })).toBeInTheDocument()
+ expect(trigger).toHaveAttribute('aria-expanded', 'true')
+ expect(screen.getByRole('status')).toBeEmptyDOMElement()
+ })
+
+ it('resets the search when the menu closes and reopens', async () => {
+ const user = userEvent.setup()
+ renderDocumentPicker()
+
+ const trigger = screen.getByRole('button', { name: 'Document 1' })
+ await user.click(trigger)
+ const input = screen.getByRole('searchbox', { name: 'common.operation.search' })
+ await user.type(input, 'report')
+ await user.keyboard('{Escape}')
+ await waitFor(() => expect(screen.queryByRole('dialog')).not.toBeInTheDocument())
+ await user.click(trigger)
- expect(onChange).toHaveBeenCalledWith(selectedDocument)
+ expect(screen.getByRole('searchbox', { name: 'common.operation.search' })).toHaveValue('')
+ expect(await screen.findByRole('menuitem', { name: 'Document 2' })).toBeInTheDocument()
})
})
diff --git a/web/app/components/datasets/common/document-picker/document-list.tsx b/web/app/components/datasets/common/document-picker/document-list.tsx
index 41aa58fda35..af46ce86928 100644
--- a/web/app/components/datasets/common/document-picker/document-list.tsx
+++ b/web/app/components/datasets/common/document-picker/document-list.tsx
@@ -1,13 +1,24 @@
'use client'
import type { DocumentWithSegmentsResponse } from '@dify/contracts/api/console/datasets/types.gen'
-import { cn } from '@langgenius/dify-ui/cn'
-import { ComboboxItem, ComboboxItemText, ComboboxList } from '@langgenius/dify-ui/combobox'
+import {
+ DropdownMenuItem,
+ DropdownMenuLinkItem,
+ DropdownMenuList,
+} from '@langgenius/dify-ui/dropdown-menu'
+import { SpinnerIcon } from '@langgenius/dify-ui/spinner'
+import { useQuery } from '@tanstack/react-query'
+import { useDebouncedValue } from 'foxact/use-debounced-value'
+import { useTranslation } from 'react-i18next'
import { getUploadFileExtension } from '@/app/components/datasets/documents/document-source'
+import Link from '@/next/link'
+import { consoleQuery } from '@/service/console'
import FileIcon from '../document-file-icon'
-type Props = Readonly<{
- className?: string
-}>
+type DocumentListProps = {
+ datasetId: string
+ currentDocumentId?: string
+ searchValue: string
+}
function getDocumentExtension(document: DocumentWithSegmentsResponse) {
const detailExtension = document.data_source_detail_dict?.upload_file?.extension
@@ -16,26 +27,63 @@ function getDocumentExtension(document: DocumentWithSegmentsResponse) {
return getUploadFileExtension(document.data_source_info) ?? ''
}
-export default function DocumentList({ className }: Props) {
+export default function DocumentList({
+ datasetId,
+ currentDocumentId,
+ searchValue,
+}: DocumentListProps) {
+ const { t } = useTranslation(['common'])
+ const keyword = searchValue.trim()
+ const debouncedKeyword = useDebouncedValue(keyword, 500)
+ const documentsQuery = useQuery(
+ consoleQuery.datasets.byDatasetId.documents.get.queryOptions({
+ input: {
+ params: { dataset_id: datasetId },
+ query: { keyword: debouncedKeyword, page: 1, limit: 20 },
+ },
+ }),
+ )
+ const isSearching = keyword !== debouncedKeyword || documentsQuery.isPending
+ const isError = !isSearching && documentsQuery.isError
+ // Previous-query links must not remain actionable during the debounce window.
+ const documents = isSearching || isError ? [] : (documentsQuery.data?.data ?? [])
+ const statusText = isSearching
+ ? t(($) => $.loading, { ns: 'common' })
+ : isError
+ ? t(($) => $['dynamicSelect.error'], { ns: 'common' })
+ : documents.length === 0
+ ? t(($) => $.noData, { ns: 'common' })
+ : null
+
return (
- <ComboboxList<DocumentWithSegmentsResponse>
- className={cn('max-h-[calc(100vh-120px)]', className)}
- >
- {(item) => {
- const extension = getDocumentExtension(item)
- return (
- <ComboboxItem
- key={item.id}
- value={item}
- className="flex h-8 grid-cols-none items-center gap-2 rounded-lg px-3 py-0"
+ <>
+ <div
+ role="status"
+ className="flex items-center gap-2 px-3 py-2 system-sm-regular text-text-tertiary empty:p-0"
+ >
+ {isSearching && <SpinnerIcon aria-hidden="true" />}
+ {statusText}
+ </div>
+ <DropdownMenuList aria-busy={isSearching}>
+ {documents.map((document) => (
+ <DropdownMenuLinkItem
+ key={document.id}
+ render={<Link href={`/datasets/${datasetId}/documents/${document.id}`} />}
+ aria-current={document.id === currentDocumentId ? 'page' : undefined}
+ className="gap-2 px-3"
>
- <FileIcon name={item.name} extension={extension} size="lg" />
- <ComboboxItemText className="system-sm-regular text-text-secondary">
- {item.name}
- </ComboboxItemText>
- </ComboboxItem>
- )
- }}
- </ComboboxList>
+ <FileIcon name={document.name} extension={getDocumentExtension(document)} size="lg" />
+ <span className="min-w-0 truncate system-sm-regular text-text-secondary">
+ {document.name}
+ </span>
+ </DropdownMenuLinkItem>
+ ))}
+ {isError && (
+ <DropdownMenuItem closeOnClick={false} onClick={() => documentsQuery.refetch()}>
+ {t(($) => $['operation.retry'], { ns: 'common' })}
+ </DropdownMenuItem>
+ )}
+ </DropdownMenuList>
+ </>
)
}
diff --git a/web/app/components/datasets/common/document-picker/index.tsx b/web/app/components/datasets/common/document-picker/index.tsx
index bae2e4757cc..1ed253dcca3 100644
--- a/web/app/components/datasets/common/document-picker/index.tsx
+++ b/web/app/components/datasets/common/document-picker/index.tsx
@@ -1,28 +1,19 @@
'use client'
import type { DocumentWithSegmentsResponse } from '@dify/contracts/api/console/datasets/types.gen'
-import type { ComboboxChangeEventDetails } from '@langgenius/dify-ui/combobox'
import type { ParentMode } from '@/models/datasets'
import { cn } from '@langgenius/dify-ui/cn'
import {
- Combobox,
- ComboboxEmpty,
- ComboboxInput,
- ComboboxInputGroup,
- ComboboxPopup,
- ComboboxPortal,
- ComboboxPositioner,
- ComboboxStatus,
- ComboboxTrigger,
- ComboboxValue,
-} from '@langgenius/dify-ui/combobox'
-import { SpinnerIcon } from '@langgenius/dify-ui/spinner'
-import { keepPreviousData, useQuery } from '@tanstack/react-query'
-import { useDebounce } from 'ahooks'
+ DropdownMenu,
+ DropdownMenuContent,
+ DropdownMenuFilterProvider,
+ DropdownMenuInput,
+ DropdownMenuInputGroup,
+ DropdownMenuTrigger,
+} from '@langgenius/dify-ui/dropdown-menu'
import { useState } from 'react'
import { useTranslation } from 'react-i18next'
import { getUploadFileExtension } from '@/app/components/datasets/documents/document-source'
import { ChunkingMode } from '@/models/datasets'
-import { consoleQuery } from '@/service/console'
import FileIcon from '../document-file-icon'
import DocumentList from './document-list'
@@ -35,23 +26,10 @@ export type PickerDocument = Pick<
data_source_detail_dict?: DocumentWithSegmentsResponse['data_source_detail_dict'] | null
}
-type Props = Readonly<{
+type DocumentPickerProps = {
datasetId: string
- value?: PickerDocument | null
+ currentDocument?: PickerDocument | null
parentMode?: ParentMode
- onChange: (value: PickerDocument) => void
-}>
-
-function getDocumentLabel(document: PickerDocument) {
- return document.name ?? ''
-}
-
-function getDocumentValue(document: PickerDocument) {
- return document.id
-}
-
-function isSameDocument(item: PickerDocument, value: PickerDocument) {
- return item.id === value.id
}
function getDocumentExtension(document?: PickerDocument | null) {
@@ -64,12 +42,9 @@ function getDocumentExtension(document?: PickerDocument | null) {
}
function DocumentPickerTriggerValue({
- document,
+ currentDocument: document,
parentMode,
-}: {
- document?: PickerDocument | null
- parentMode?: ParentMode
-}) {
+}: Pick<DocumentPickerProps, 'currentDocument' | 'parentMode'>) {
const { t } = useTranslation(['dataset'])
const isGeneralMode = document?.doc_form === ChunkingMode.text
const isParentChild = document?.doc_form === ChunkingMode.parentChild
@@ -120,97 +95,42 @@ function DocumentPickerTriggerValue({
)
}
-export function DocumentPicker({ datasetId, value, parentMode, onChange }: Props) {
+export function DocumentPicker({ datasetId, currentDocument, parentMode }: DocumentPickerProps) {
const { t } = useTranslation(['common'])
const [searchValue, setSearchValue] = useState('')
- const debouncedSearchValue = useDebounce(searchValue, { wait: 500 })
-
- const { data } = useQuery(
- consoleQuery.datasets.byDatasetId.documents.get.queryOptions({
- input: {
- params: { dataset_id: datasetId },
- query: { keyword: debouncedSearchValue, page: 1, limit: 20 },
- },
- placeholderData: keepPreviousData,
- }),
- )
- const documentsList = data?.data ?? []
-
- const handleInputValueChange = (inputValue: string, details: ComboboxChangeEventDetails) => {
- if (details.reason !== 'item-press') setSearchValue(inputValue)
- }
-
- const handleOpenChange = (nextOpen: boolean) => {
- if (!nextOpen) setSearchValue('')
- }
-
- const handleDocumentChange = (document: PickerDocument | null) => {
- if (!document) return
-
- onChange(document)
- setSearchValue('')
- }
return (
- <Combobox<PickerDocument>
- items={documentsList}
- value={value ?? null}
- inputValue={searchValue}
- onOpenChange={handleOpenChange}
- onInputValueChange={handleInputValueChange}
- onValueChange={handleDocumentChange}
- isItemEqualToValue={isSameDocument}
- itemToStringLabel={getDocumentLabel}
- itemToStringValue={getDocumentValue}
- filter={null}
- >
- <ComboboxTrigger
- aria-label={value?.name || t(($) => $['operation.search'], { ns: 'common' })}
- className="ml-1 flex min-w-0 items-center gap-0.5 rounded-lg px-2 py-1 text-start transition-colors hover:bg-state-base-hover focus-visible:bg-state-base-hover data-popup-open:bg-state-base-hover motion-reduce:transition-none"
- >
- <ComboboxValue<PickerDocument>>
- {(document) => <DocumentPickerTriggerValue document={document} parentMode={parentMode} />}
- </ComboboxValue>
- </ComboboxTrigger>
- <ComboboxPortal>
- <ComboboxPositioner sideOffset={0}>
- <ComboboxPopup
- aria-label={t(($) => $['operation.search'], { ns: 'common' })}
- className="w-90 rounded-xl border-[0.5px] border-components-panel-border bg-components-panel-bg-blur shadow-lg backdrop-blur-[5px]"
- >
- <ComboboxInputGroup>
- <span
- className="i-ri-search-line size-4 shrink-0 text-text-tertiary"
- aria-hidden="true"
- />
- <ComboboxInput
- aria-label={t(($) => $['operation.search'], { ns: 'common' })}
- placeholder={t(($) => $['operation.search'], { ns: 'common' })}
- />
- </ComboboxInputGroup>
- <DocumentList />
- <ComboboxEmpty className="p-0">
- {data && (
- <div className="mt-2 flex h-25 w-full items-center justify-center px-3 py-2 system-sm-regular text-text-tertiary">
- {t(($) => $.noData, { ns: 'common' })}
- </div>
- )}
- </ComboboxEmpty>
- <ComboboxStatus
- className={cn(!data ? 'mt-2 flex h-25 w-full items-center justify-center' : 'h-0')}
- >
- {!data && (
- <>
- <span className="sr-only">{t(($) => $.loading, { ns: 'common' })}</span>
- <div className="flex w-full justify-center" aria-hidden="true">
- <SpinnerIcon />
- </div>
- </>
- )}
- </ComboboxStatus>
- </ComboboxPopup>
- </ComboboxPositioner>
- </ComboboxPortal>
- </Combobox>
+ <DropdownMenuFilterProvider filter={null} value={searchValue} onValueChange={setSearchValue}>
+ <DropdownMenu>
+ <DropdownMenuTrigger
+ aria-label={currentDocument?.name || t(($) => $['operation.search'], { ns: 'common' })}
+ className="ms-1 flex min-w-0 items-center gap-0.5 rounded-lg px-2 py-1 text-start transition-colors hover:bg-state-base-hover focus-visible:bg-state-base-hover data-popup-open:bg-state-base-hover motion-reduce:transition-none"
+ >
+ <DocumentPickerTriggerValue currentDocument={currentDocument} parentMode={parentMode} />
+ </DropdownMenuTrigger>
+ <DropdownMenuContent
+ align="start"
+ sideOffset={0}
+ aria-label={t(($) => $['operation.search'], { ns: 'common' })}
+ className="w-90 max-w-(--available-width)"
+ >
+ <DropdownMenuInputGroup>
+ <span
+ className="i-ri-search-line size-4 shrink-0 text-text-tertiary"
+ aria-hidden="true"
+ />
+ <DropdownMenuInput
+ aria-label={t(($) => $['operation.search'], { ns: 'common' })}
+ placeholder={t(($) => $['operation.search'], { ns: 'common' })}
+ />
+ </DropdownMenuInputGroup>
+ <DocumentList
+ datasetId={datasetId}
+ currentDocumentId={currentDocument?.id}
+ searchValue={searchValue}
+ />
+ </DropdownMenuContent>
+ </DropdownMenu>
+ </DropdownMenuFilterProvider>
)
}
diff --git a/web/app/components/datasets/common/document-status-with-action/status-with-action.tsx b/web/app/components/datasets/common/document-status-with-action/status-with-action.tsx
index 9125a4646d7..bb36d7570ac 100644
--- a/web/app/components/datasets/common/document-status-with-action/status-with-action.tsx
+++ b/web/app/components/datasets/common/document-status-with-action/status-with-action.tsx
@@ -51,7 +51,7 @@ const StatusAction: FC<Props> = ({
}) => {
const { Icon, color } = getIcon(type)
return (
- <div className="relative flex h-8.5 items-center rounded-lg border border-components-panel-border bg-components-panel-bg-blur pr-3 pl-2 shadow-xs">
+ <div className="relative flex h-8.5 items-center rounded-lg border border-components-panel-border bg-components-panel-bg-blur ps-2 pe-3 shadow-xs">
<div
className={`absolute inset-0 rounded-lg opacity-40 ${
(type === 'success' &&
@@ -74,10 +74,7 @@ const StatusAction: FC<Props> = ({
type="button"
disabled={disabled}
onClick={onAction}
- className={cn(
- 'cursor-pointer border-none bg-transparent p-0 text-left text-[13px] font-semibold text-text-accent focus-visible:ring-1 focus-visible:ring-components-input-border-active focus-visible:outline-hidden',
- disabled && 'cursor-not-allowed text-text-disabled',
- )}
+ className="text-start text-[13px] font-semibold text-text-accent disabled:cursor-not-allowed disabled:text-text-disabled"
>
{actionText}
</button>
diff --git a/web/app/components/datasets/documents/detail/document-title.tsx b/web/app/components/datasets/documents/detail/document-title.tsx
index 45f6a65a849..ae7d62c1aec 100644
--- a/web/app/components/datasets/documents/detail/document-title.tsx
+++ b/web/app/components/datasets/documents/detail/document-title.tsx
@@ -1,7 +1,6 @@
import type { PickerDocument } from '../../common/document-picker'
import type { ParentMode } from '@/models/datasets'
import { cn } from '@langgenius/dify-ui/cn'
-import { useRouter } from '@/next/navigation'
import { DocumentPicker } from '../../common/document-picker'
type DocumentTitleProps = {
@@ -12,18 +11,9 @@ type DocumentTitleProps = {
}
export function DocumentTitle({ datasetId, document, parentMode, wrapperCls }: DocumentTitleProps) {
- const router = useRouter()
-
return (
<div className={cn('flex flex-1 items-center justify-start', wrapperCls)}>
- <DocumentPicker
- datasetId={datasetId}
- value={document}
- parentMode={parentMode}
- onChange={(doc) => {
- router.push(`/datasets/${datasetId}/documents/${doc.id}`)
- }}
- />
+ <DocumentPicker datasetId={datasetId} currentDocument={document} parentMode={parentMode} />
</div>
)
}