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: restore comment marker focus after closing threads (#41978)

Joele75b5f6bc9b0
diff --git a/web/app/components/workflow/comment/__tests__/comment-close-focus.spec.tsx b/web/app/components/workflow/comment/__tests__/comment-close-focus.spec.tsx
new file mode 100644
index 00000000000..a8d11c527b9
--- /dev/null
+++ b/web/app/components/workflow/comment/__tests__/comment-close-focus.spec.tsx
@@ -0,0 +1,250 @@
+import type { WorkflowCommentList } from '../types'
+import { act, screen, waitFor } from '@testing-library/react'
+import userEvent from '@testing-library/user-event'
+import { Fragment } from 'react'
+import { seedAccountProfileQuery } from '@/test/console/account-profile'
+import { createConsoleQueryClient, seedSystemFeatures } from '@/test/console/query-data'
+import { renderWorkflowComponent } from '../../__tests__/workflow-test-env'
+import { useWorkflowComment } from '../../hooks/use-workflow-comment'
+import { useStore } from '../../store'
+import { CommentIcon } from '../comment-icon'
+import { CommentThread } from '../thread'
+
+const mockFetchComments = vi.hoisted(() => vi.fn())
+const mockFetchComment = vi.hoisted(() => vi.fn())
+const mockUpdateComment = vi.hoisted(() => vi.fn())
+
+vi.mock('reactflow', async () =>
+ (await import('../../__tests__/reactflow-mock-state')).createReactFlowModuleMock(),
+)
+
+vi.mock('@/next/navigation', () => ({
+ useParams: () => ({ appId: 'app-1' }),
+}))
+
+vi.mock('@/hooks/use-format-time-from-now', () => ({
+ useFormatTimeFromNow: () => ({ formatTimeFromNow: () => 'just now' }),
+}))
+
+vi.mock('@/app/components/workflow/collaboration/core/collaboration-manager', () => ({
+ collaborationManager: {
+ onCommentsUpdate: () => () => {},
+ emitCommentsUpdate: vi.fn(),
+ },
+}))
+
+vi.mock('@/service/console', async (importOriginal) => {
+ const actual = await importOriginal<typeof import('@/service/console')>()
+ return {
+ ...actual,
+ consoleClient: {
+ ...actual.consoleClient,
+ apps: {
+ byAppId: {
+ workflow: {
+ comments: {
+ get: (...args: unknown[]) => mockFetchComments(...args),
+ byCommentId: {
+ get: (...args: unknown[]) => mockFetchComment(...args),
+ put: (...args: unknown[]) => mockUpdateComment(...args),
+ },
+ },
+ },
+ },
+ },
+ },
+ }
+})
+
+const comment: WorkflowCommentList = {
+ id: 'comment-1',
+ position_x: 10,
+ position_y: 20,
+ content: 'Check this workflow',
+ created_by: 'user-1',
+ created_by_account: {
+ id: 'user-1',
+ name: 'Alice',
+ email: '[email protected]',
+ avatar_url: null,
+ },
+ created_at: 100,
+ updated_at: 100,
+ resolved: false,
+ mention_count: 0,
+ reply_count: 0,
+ participants: [],
+}
+
+function CommentCanvas() {
+ const showUserComments = useStore((state) => state.showUserComments)
+ const {
+ comments,
+ activeComment,
+ activeCommentLoading,
+ handleCommentIconClick,
+ handleActiveCommentClose,
+ handleCommentReply,
+ handleCommentPositionUpdate,
+ handleCommentNavigate,
+ } = useWorkflowComment()
+
+ return (
+ <div id="workflow-container">
+ {comments.map((item, index) => {
+ // Match Workflow's active/inactive branches: opening and closing rebuild the marker.
+ if (activeComment?.id === item.id) {
+ return (
+ <Fragment key={item.id}>
+ <CommentIcon
+ key={`${item.id}-icon`}
+ comment={item}
+ onClick={() => handleCommentIconClick(item)}
+ isActive
+ onPositionUpdate={(position) => handleCommentPositionUpdate(item.id, position)}
+ />
+ <CommentThread
+ key={`${item.id}-thread`}
+ comment={activeComment}
+ loading={activeCommentLoading}
+ onClose={handleActiveCommentClose}
+ onReply={(content, ids) => handleCommentReply(item.id, content, ids)}
+ onPrev={index > 0 ? () => handleCommentNavigate('prev') : undefined}
+ onNext={
+ index < comments.length - 1 ? () => handleCommentNavigate('next') : undefined
+ }
+ canGoPrev={index > 0}
+ canGoNext={index < comments.length - 1}
+ />
+ </Fragment>
+ )
+ }
+
+ return showUserComments ? (
+ <CommentIcon
+ key={item.id}
+ comment={item}
+ onClick={() => handleCommentIconClick(item)}
+ onPositionUpdate={(position) => handleCommentPositionUpdate(item.id, position)}
+ />
+ ) : null
+ })}
+ </div>
+ )
+}
+
+function renderCommentCanvas(comments = [comment]) {
+ mockFetchComments.mockResolvedValue({ data: comments })
+ mockFetchComment.mockImplementation(({ params }: { params: { comment_id: string } }) =>
+ Promise.resolve({
+ ...comments.find((item) => item.id === params.comment_id),
+ mentions: [],
+ replies: [],
+ }),
+ )
+ const queryClient = createConsoleQueryClient()
+ seedAccountProfileQuery(queryClient, { id: 'user-1', name: 'Alice' })
+ seedSystemFeatures(queryClient, { enable_collaboration_mode: true })
+ return renderWorkflowComponent(<CommentCanvas />, {
+ queryClient,
+ initialStoreState: {
+ comments,
+ showUserComments: true,
+ mentionableUsersCache: { 'app-1': [] },
+ },
+ })
+}
+
+describe('Comment keyboard focus lifecycle', () => {
+ beforeEach(() => {
+ vi.clearAllMocks()
+ mockUpdateComment.mockResolvedValue({})
+ })
+
+ it.each([
+ { open: 'Enter', key: '{Enter}', close: 'Escape' },
+ { open: 'Space', key: ' ', close: 'Escape' },
+ { open: 'Enter', key: '{Enter}', close: 'close button' },
+ ])(
+ 'restores the current marker after $open and $close, so arrow keys still move it',
+ async ({ key, close }) => {
+ const user = userEvent.setup()
+ renderCommentCanvas()
+
+ await user.tab()
+ expect(screen.getByRole('button', { name: /keyboard.openComment/ })).toHaveFocus()
+ await user.keyboard(key)
+
+ const reply = await screen.findByRole('textbox')
+ await waitFor(() => expect(reply).toHaveFocus())
+ if (close === 'Escape') {
+ await user.keyboard('{Escape}')
+ } else {
+ await user.tab({ shift: true })
+ await user.tab({ shift: true })
+ expect(screen.getByRole('button', { name: /comments.aria.closeComment/ })).toHaveFocus()
+ await user.keyboard('{Enter}')
+ }
+
+ await waitFor(() => expect(screen.queryByRole('textbox')).not.toBeInTheDocument())
+ await waitFor(() => {
+ expect(screen.getByRole('button', { name: /keyboard.openComment/ })).toHaveFocus()
+ })
+ await user.keyboard('{ArrowRight}')
+
+ await waitFor(() => {
+ expect(mockUpdateComment).toHaveBeenCalledWith({
+ params: { app_id: 'app-1', comment_id: comment.id },
+ body: { content: comment.content, position_x: 15, position_y: 20 },
+ })
+ })
+ },
+ )
+
+ it('restores the last viewed comment marker after navigating to another thread', async () => {
+ const user = userEvent.setup()
+ const otherComment: WorkflowCommentList = {
+ ...comment,
+ id: 'comment-2',
+ content: 'Another comment',
+ created_by: 'user-2',
+ created_by_account: {
+ id: 'user-2',
+ name: 'Bob',
+ email: '[email protected]',
+ avatar_url: null,
+ },
+ }
+ renderCommentCanvas([comment, otherComment])
+ await user.tab()
+ await user.keyboard('{Enter}')
+ await waitFor(() => expect(screen.getByRole('textbox')).toHaveFocus())
+
+ await user.tab({ shift: true })
+ await user.tab({ shift: true })
+ await user.tab({ shift: true })
+ expect(screen.getByRole('button', { name: /comments.aria.nextComment/ })).toHaveFocus()
+ await user.keyboard('{Enter}')
+ await waitFor(() => expect(screen.getByRole('textbox')).toHaveFocus())
+ expect(screen.getByText(otherComment.content)).toBeInTheDocument()
+ await user.keyboard('{Escape}')
+
+ await waitFor(() => expect(screen.queryByRole('textbox')).not.toBeInTheDocument())
+ expect(screen.getByRole('button', { name: /keyboard.openComment.*Bob/ })).toHaveFocus()
+ })
+
+ it('closes safely when comment markers have been hidden', async () => {
+ const user = userEvent.setup()
+ const { store } = renderCommentCanvas()
+ await user.tab()
+ await user.keyboard('{Enter}')
+ const reply = await screen.findByRole('textbox')
+ await waitFor(() => expect(reply).toHaveFocus())
+
+ act(() => store.getState().setShowUserComments(false))
+ await user.keyboard('{Escape}')
+
+ await waitFor(() => expect(screen.queryByRole('textbox')).not.toBeInTheDocument())
+ expect(screen.queryByRole('button', { name: /keyboard.openComment/ })).not.toBeInTheDocument()
+ })
+})
diff --git a/web/app/components/workflow/comment/comment-icon.tsx b/web/app/components/workflow/comment/comment-icon.tsx
index 401b68e30c9..c8e8fccdf28 100644
--- a/web/app/components/workflow/comment/comment-icon.tsx
+++ b/web/app/components/workflow/comment/comment-icon.tsx
@@ -251,6 +251,7 @@ export const CommentIcon: FC<CommentIconProps> = memo(
transform: 'translate(-50%, -50%)',
}}
data-role="comment-marker"
+ id={`workflow-comment-marker-${comment.id}`}
{...pointerEventHandlers}
onClick={(event) => {
if (event.detail === 0 && !isActive) {
diff --git a/web/app/components/workflow/hooks/use-workflow-comment.ts b/web/app/components/workflow/hooks/use-workflow-comment.ts
index 26207f0e04a..f4024343bc0 100644
--- a/web/app/components/workflow/hooks/use-workflow-comment.ts
+++ b/web/app/components/workflow/hooks/use-workflow-comment.ts
@@ -4,7 +4,7 @@ import type {
WorkflowCommentList,
} from '@/app/components/workflow/comment/types'
import { useSuspenseQuery } from '@tanstack/react-query'
-import { useCallback, useEffect, useMemo, useRef } from 'react'
+import { useCallback, useEffect, useLayoutEffect, useMemo, useRef } from 'react'
import { useReactFlow } from 'reactflow'
import { collaborationManager } from '@/app/components/workflow/collaboration/core/collaboration-manager'
import { userProfileQueryOptions } from '@/features/account-profile/client'
@@ -78,6 +78,16 @@ export const useWorkflowComment = () => {
})
const commentDetailCacheRef = useRef<Record<string, WorkflowCommentDetail>>(commentDetailCache)
const activeCommentIdRef = useRef<string | null>(null)
+ const commentFocusToRestoreRef = useRef<string | null>(null)
+
+ useLayoutEffect(() => {
+ const commentId = commentFocusToRestoreRef.current
+ commentFocusToRestoreRef.current = null
+ if (!commentId || activeCommentId) return
+
+ // Closing rebuilds the marker, so resolve its identity after the DOM commit.
+ document.getElementById(`workflow-comment-marker-${commentId}`)?.focus({ preventScroll: true })
+ }, [activeCommentId])
useEffect(() => {
activeCommentIdRef.current = activeCommentId ?? null
@@ -269,6 +279,7 @@ export const useWorkflowComment = () => {
const handleCommentIconClick = useCallback(
async (comment: WorkflowCommentList) => {
+ commentFocusToRestoreRef.current = null
setPendingComment(null)
activeCommentIdRef.current = comment.id
@@ -596,6 +607,7 @@ export const useWorkflowComment = () => {
)
const handleActiveCommentClose = useCallback(() => {
+ commentFocusToRestoreRef.current = activeCommentIdRef.current
setActiveComment(null)
setActiveCommentLoading(false)
setActiveCommentId(null)