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): make document metadata panel scrollable (#43621)

Mesrop Harutyunyan0efc98213af7
diff --git a/web/app/components/datasets/documents/detail/__tests__/index.spec.tsx b/web/app/components/datasets/documents/detail/__tests__/index.spec.tsx
index 23819673a46..7e1d8b13747 100644
--- a/web/app/components/datasets/documents/detail/__tests__/index.spec.tsx
+++ b/web/app/components/datasets/documents/detail/__tests__/index.spec.tsx
@@ -298,6 +298,26 @@ describe('DocumentDetail', () => {
).not.toBeInTheDocument()
})
+ it('opens metadata in a drawer on mobile instead of beside the chunks', async () => {
+ const user = userEvent.setup()
+ vi.stubGlobal('innerWidth', 390)
+ try {
+ render(<DocumentDetail datasetId="ds-1" documentId="doc-1" />)
+ expect(
+ screen.queryByText('dataset.metadata.documentMetadata.documentInformation'),
+ ).not.toBeInTheDocument()
+
+ await user.click(screen.getByRole('button', { name: /metadata\.title/ }))
+ expect(
+ within(await screen.findByRole('dialog')).getByText(
+ 'dataset.metadata.documentMetadata.documentInformation',
+ ),
+ ).toBeVisible()
+ } finally {
+ vi.unstubAllGlobals()
+ }
+ })
+
it.each([true, false])(
'allows metadata editing only with edit permission (%s)',
async (canEdit) => {
diff --git a/web/app/components/datasets/documents/detail/__tests__/metadata-panel.browser.spec.tsx b/web/app/components/datasets/documents/detail/__tests__/metadata-panel.browser.spec.tsx
new file mode 100644
index 00000000000..157e9f7e25f
--- /dev/null
+++ b/web/app/components/datasets/documents/detail/__tests__/metadata-panel.browser.spec.tsx
@@ -0,0 +1,155 @@
+import type { Locator } from 'vite-plus/test/browser'
+import { zDocumentDetailResponse } from '@dify/contracts/api/console/datasets/zod.gen'
+import { page, userEvent } from 'vite-plus/test/browser'
+import { render } from 'vitest-browser-react'
+import DatasetDetailContext from '@/context/dataset-detail'
+import { EventEmitterContextProvider } from '@/context/event-emitter-provider'
+import { consoleQuery } from '@/service/console'
+import { createConsoleQueryWrapper } from '@/test/console/query-data'
+import { createDatasetFixture } from '@/test/fixtures/dataset'
+import { createFileUploadConfigFixture } from '@/test/fixtures/file-upload-config'
+import { DatasetACLPermission } from '@/utils/permission'
+import { DataType } from '../../../metadata/types'
+import DocumentDetail from '../index'
+
+// Real English copy: raw i18n keys cannot wrap, so they would widen the edit header past the panel.
+vi.mock('react-i18next', async () => {
+ const { createReactI18nextMock } = await import('@/test/i18n-mock')
+ const withNamespace = (ns: string, messages: Record<string, string>) =>
+ Object.fromEntries(Object.entries(messages).map(([key, value]) => [`${ns}.${key}`, value]))
+ const { default: common } = await import('@/i18n/locales/en-US/common.json')
+ const { default: dataset } = await import('@/i18n/locales/en-US/dataset.json')
+ const { default: datasetDocuments } = await import('@/i18n/locales/en-US/dataset-documents.json')
+ return createReactI18nextMock({
+ ...withNamespace('common', common),
+ ...withNamespace('dataset', dataset),
+ ...withNamespace('datasetDocuments', datasetDocuments),
+ })
+})
+
+// Enough fields that the metadata panel overflows the viewport and renders its scrollbar. The last
+// one is a time field, whose date picker must shrink to keep its remove button inside the row.
+const fields = [
+ ...Array.from({ length: 13 }, (_, i) => ({
+ id: `field-${i + 1}`,
+ name: `field_${i + 1}`,
+ type: DataType.string,
+ value: `A long metadata value for field ${i + 1} that wraps onto a second line`,
+ })),
+ { id: 'field-14', name: 'recorded_at', type: DataType.time, value: 1759780800 },
+]
+const save = vi.fn()
+
+vi.mock('@/next/navigation', async (importOriginal) => ({
+ ...(await importOriginal<typeof import('@/next/navigation')>()),
+ useParams: () => ({ datasetId: 'ds-1', documentId: 'doc-1' }),
+ usePathname: () => '/datasets/ds-1/documents/doc-1',
+ useRouter: () => ({ push: vi.fn() }),
+ useSearchParams: () => new URLSearchParams(),
+}))
+
+vi.mock('@/service/console', async (importOriginal) => {
+ const actual = await importOriginal<typeof import('@/service/console')>()
+ const { withConsoleResponses } = await import('@/test/console/service-responses')
+ return {
+ ...actual,
+ consoleQuery: withConsoleResponses(actual.consoleQuery, {
+ 'datasets.byDatasetId.documents.byDocumentId.segments.get': async () => ({
+ data: [],
+ total: 0,
+ total_pages: 0,
+ page: 1,
+ limit: 10,
+ }),
+ 'datasets.byDatasetId.metadata.get': async () => ({
+ doc_metadata: fields,
+ built_in_field_enabled: false,
+ }),
+ 'datasets.byDatasetId.documents.metadata.post': (input) => save(input),
+ }),
+ }
+})
+
+const documentDetail = zDocumentDetailResponse.parse({
+ id: 'doc-1',
+ name: 'video-transcript.txt',
+ display_status: 'available',
+ enabled: true,
+ archived: false,
+ doc_form: 'text_model',
+ data_source_type: 'upload_file',
+ data_source_info: { upload_file: { extension: 'txt' } },
+ error: '',
+ document_process_rule: null,
+ dataset_process_rule: null,
+})
+
+const renderDocumentDetail = async () => {
+ const { queryClient, wrapper: Wrapper } = createConsoleQueryWrapper({
+ workspacePermissionKeys: [],
+ })
+ const document = consoleQuery.datasets.byDatasetId.documents.byDocumentId.get
+ const params = { dataset_id: 'ds-1', document_id: 'doc-1' }
+ queryClient.setQueryData(
+ document.queryKey({ input: { params, query: { metadata: 'without' } } }),
+ documentDetail,
+ )
+ queryClient.setQueryData(document.queryKey({ input: { params, query: { metadata: 'only' } } }), {
+ id: 'doc-1',
+ doc_metadata: fields,
+ })
+ queryClient.setQueryData(
+ consoleQuery.files.upload.get.queryKey(),
+ createFileUploadConfigFixture(),
+ )
+ const dataset = createDatasetFixture({
+ id: 'ds-1',
+ embedding_available: true,
+ permission_keys: [DatasetACLPermission.Edit],
+ })
+ return render(
+ <Wrapper>
+ {/* oxlint-disable-next-line eslint-react/no-context-provider -- This use-context-selector context requires its Provider. */}
+ <DatasetDetailContext.Provider value={{ dataset }}>
+ <EventEmitterContextProvider>
+ <div style={{ height: '100vh' }}>
+ <DocumentDetail datasetId="ds-1" documentId="doc-1" />
+ </div>
+ </EventEmitterContextProvider>
+ </DatasetDetailContext.Provider>
+ </Wrapper>,
+ )
+}
+
+// Press at the control's rightmost pixel column: the strip an overlay scrollbar would cover.
+const clickRightEdge = async (control: Locator) => {
+ const { width, height } = control.element().getBoundingClientRect()
+ await userEvent.click(control, { position: { x: width - 1, y: height / 2 } })
+}
+
+beforeEach(() => {
+ save.mockReset().mockResolvedValue({ result: 'success' })
+})
+
+it('keeps edit controls clickable beside the metadata scrollbar and reaches the last field', async () => {
+ await page.viewport(1280, 640)
+ const screen = await renderDocumentDetail()
+ await screen.getByRole('button', { name: 'Edit' }).click()
+
+ const removeButtons = screen.getByRole('button', { name: 'Remove' })
+ await expect.element(removeButtons.nth(fields.length - 1)).toBeInTheDocument()
+
+ // The last row starts below the fold, so this also proves the panel scrolls to it.
+ await clickRightEdge(removeButtons.nth(fields.length - 1))
+ await expect.poll(() => removeButtons.elements().length).toBe(fields.length - 1)
+
+ const saveButton = screen.getByRole('button', { name: 'Save' })
+ await clickRightEdge(saveButton)
+ await expect.poll(() => save.mock.calls.length).toBe(1)
+ expect(save.mock.calls[0]?.[0]).toMatchObject({
+ body: {
+ operation_data: [{ document_id: 'doc-1', metadata_list: fields.slice(0, fields.length - 1) }],
+ },
+ })
+ await expect.element(saveButton).not.toBeInTheDocument()
+})
diff --git a/web/app/components/datasets/documents/detail/index.tsx b/web/app/components/datasets/documents/detail/index.tsx
index e8a138b1422..80d3a1c59a8 100644
--- a/web/app/components/datasets/documents/detail/index.tsx
+++ b/web/app/components/datasets/documents/detail/index.tsx
@@ -6,6 +6,13 @@ import type { FileItem } from '@/models/datasets'
import type { SegmentImportStatus } from '@/types/dataset'
import { cn } from '@langgenius/dify-ui/cn'
import { IconButton } from '@langgenius/dify-ui/icon-button'
+import {
+ ScrollArea,
+ ScrollAreaContent,
+ ScrollAreaScrollbar,
+ ScrollAreaThumb,
+ ScrollAreaViewport,
+} from '@langgenius/dify-ui/scroll-area'
import { Separator } from '@langgenius/dify-ui/separator'
import { useMutation, useQuery, useQueryClient, useSuspenseQuery } from '@tanstack/react-query'
import { useAtomValue } from 'jotai'
@@ -276,6 +283,16 @@ const DocumentDetail: FC<DocumentDetailProps> = ({ datasetId, documentId }) => {
}
}, [documentDetail, documentMetadata])
+ const metadataPanel = docDetail && (
+ <Metadata
+ className={cn(isMobile && 'mt-3 mr-2')}
+ datasetId={datasetId}
+ documentId={documentId}
+ docDetail={docDetail}
+ canEdit={canEditDocument}
+ />
+ )
+
const backButtonLabel = t(($) => $['operation.back'], { ns: 'common' })
const metadataToggleLabel = `${
showMetadata
@@ -405,15 +422,20 @@ const DocumentDetail: FC<DocumentDetailProps> = ({ datasetId, documentId }) => {
isMobile={isMobile}
panelClassName="justify-start!"
>
- {docDetail && (
- <Metadata
- className="mt-3 mr-2"
- datasetId={datasetId}
- documentId={documentId}
- docDetail={docDetail}
- canEdit={canEditDocument}
- />
- )}
+ {metadataPanel &&
+ (isMobile ? (
+ metadataPanel
+ ) : (
+ <ScrollArea className="relative mt-3 min-h-0 shrink-0 overflow-hidden">
+ <ScrollAreaViewport className="overscroll-contain">
+ {/* pr-3 reserves a gutter for the 12px overlay scrollbar so it never covers the panel's controls */}
+ <ScrollAreaContent className="pr-3 pb-3">{metadataPanel}</ScrollAreaContent>
+ </ScrollAreaViewport>
+ <ScrollAreaScrollbar orientation="vertical">
+ <ScrollAreaThumb />
+ </ScrollAreaScrollbar>
+ </ScrollArea>
+ ))}
</FloatRightContainer>
</div>
<BatchModal
diff --git a/web/app/components/datasets/metadata/edit-metadata-batch/input-combined.tsx b/web/app/components/datasets/metadata/edit-metadata-batch/input-combined.tsx
index c7eec1285fb..5352e130f2f 100644
--- a/web/app/components/datasets/metadata/edit-metadata-batch/input-combined.tsx
+++ b/web/app/components/datasets/metadata/edit-metadata-batch/input-combined.tsx
@@ -36,7 +36,7 @@ const InputCombined: FC<Props> = ({
return (
<Datepicker
label={label}
- className={className}
+ className={cn(className, 'min-w-0')}
value={value}
onChange={onChange}
readOnly={readOnly}