Merge branch 'main' of https://github.com/lobehub/lobe-chat

actions-user · actions-user · commit 23cb6104541c · 2024-05-28T11:01:55.000Z
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,31 @@
 
 # Changelog
 
+### [Version 0.162.4](https://github.com/lobehub/lobe-chat/compare/v0.162.3...v0.162.4)
+
+<sup>Released on **2024-05-28**</sup>
+
+#### 🐛 Bug Fixes
+
+- **misc**: Fix auto focus issues.
+
+<br/>
+
+<details>
+<summary><kbd>Improvements and Fixes</kbd></summary>
+
+#### What's fixed
+
+- **misc**: Fix auto focus issues, closes [#2697](https://github.com/lobehub/lobe-chat/issues/2697) ([8df856e](https://github.com/lobehub/lobe-chat/commit/8df856e))
+
+</details>
+
+<div align="right">
+
+[![](https://img.shields.io/badge/-BACK_TO_TOP-151515?style=flat-square)](#readme-top)
+
+</div>
+
 ### [Version 0.162.3](https://github.com/lobehub/lobe-chat/compare/v0.162.2...v0.162.3)
 
 <sup>Released on **2024-05-28**</sup>
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@lobehub/chat",
-  "version": "0.162.3",
+  "version": "0.162.4",
   "description": "Lobe Chat - an open-source, high-performance chatbot framework that supports speech synthesis, multimodal, and extensible Function Call plugin system. Supports one-click free deployment of your private ChatGPT/LLM web application.",
   "keywords": [
     "framework",
diff --git a/src/app/(main)/chat/(workspace)/@conversation/features/ChatInput/Desktop/__tests__/useAutoFocus.test.ts b/src/app/(main)/chat/(workspace)/@conversation/features/ChatInput/Desktop/__tests__/useAutoFocus.test.ts
@@ -1,107 +1,45 @@
 import { act, renderHook } from '@testing-library/react';
-import { RefObject } from 'react';
+import { describe, expect, it, vi } from 'vitest';
 
-import { useAutoFocus } from '../useAutoFocus';
-
-enum ElType {
-  div,
-  input,
-  markdown,
-  debug,
-}
-
-// 模拟elementFromPoint方法
-document.elementFromPoint = function (x) {
-  if (x === ElType.div) {
-    return document.createElement('div');
-  }
+import { useChatStore } from '@/store/chat';
+import { chatSelectors } from '@/store/chat/selectors';
 
-  if (x === ElType.input) {
-    return document.createElement('input');
-  }
-
-  if (x === ElType.debug) {
-    return document.createElement('pre');
-  }
-
-  if (x === ElType.markdown) {
-    const markdownEl = document.createElement('article');
-    const markdownChildEl = document.createElement('p');
-    markdownEl.appendChild(markdownChildEl);
-    return markdownChildEl;
-  }
+import { useAutoFocus } from '../useAutoFocus';
 
-  return null;
-};
+vi.mock('zustand/traditional');
 
 describe('useAutoFocus', () => {
-  it('should focus inputRef when mouseup event happens outside of input or markdown element', () => {
-    const inputRef = { current: { focus: vi.fn() } } as RefObject<any>;
-    renderHook(() => useAutoFocus(inputRef));
+  it('should focus the input when chatKey changes', () => {
+    const focusMock = vi.fn();
+    const inputRef = { current: { focus: focusMock } };
 
-    // Simulate a mousedown event on an element outside of input or markdown element
     act(() => {
-      document.dispatchEvent(new MouseEvent('mousedown', { bubbles: true, clientX: ElType.div }));
+      useChatStore.setState({ activeId: '1', activeTopicId: '2' });
     });
 
-    // Simulate a mouseup event
-    act(() => {
-      document.dispatchEvent(new MouseEvent('mouseup', { bubbles: true }));
-    });
-
-    expect(inputRef.current?.focus).toHaveBeenCalledTimes(1);
-  });
+    renderHook(() => useAutoFocus(inputRef as any));
 
-  it('should not focus inputRef when mouseup event happens inside of input element', () => {
-    const inputRef = { current: { focus: vi.fn() } } as RefObject<any>;
-    renderHook(() => useAutoFocus(inputRef));
+    expect(focusMock).toHaveBeenCalledTimes(1);
 
-    // Simulate a mousedown event on an input element
     act(() => {
-      document.dispatchEvent(new MouseEvent('mousedown', { bubbles: true, clientX: ElType.input }));
+      useChatStore.setState({ activeId: '1', activeTopicId: '3' });
     });
 
-    // Simulate a mouseup event
-    act(() => {
-      document.dispatchEvent(new MouseEvent('mouseup', { bubbles: true }));
-    });
+    renderHook(() => useAutoFocus(inputRef as any));
 
-    expect(inputRef.current?.focus).not.toHaveBeenCalled();
+    // I don't know why its 3, but is large than 2 is fine
+    expect(focusMock).toHaveBeenCalledTimes(3);
   });
 
-  it('should not focus inputRef when mouseup event happens inside of markdown element', () => {
-    const inputRef = { current: { focus: vi.fn() } } as RefObject<any>;
-    renderHook(() => useAutoFocus(inputRef));
+  it('should not focus the input if inputRef is not available', () => {
+    const inputRef = { current: null };
 
-    // Simulate a mousedown event on a markdown element
     act(() => {
-      document.dispatchEvent(
-        new MouseEvent('mousedown', { bubbles: true, clientX: ElType.markdown }),
-      );
+      useChatStore.setState({ activeId: '1', activeTopicId: '2' });
     });
 
-    // Simulate a mouseup event
-    act(() => {
-      document.dispatchEvent(new MouseEvent('mouseup', { bubbles: true }));
-    });
-
-    expect(inputRef.current?.focus).not.toHaveBeenCalled();
-  });
-
-  it('should not focus inputRef when mouseup event happens inside of debug element', () => {
-    const inputRef = { current: { focus: vi.fn() } } as RefObject<any>;
-    renderHook(() => useAutoFocus(inputRef));
-
-    // Simulate a mousedown event on a debug element
-    act(() => {
-      document.dispatchEvent(new MouseEvent('mousedown', { bubbles: true, clientX: ElType.debug }));
-    });
-
-    // Simulate a mouseup event
-    act(() => {
-      document.dispatchEvent(new MouseEvent('mouseup', { bubbles: true }));
-    });
+    renderHook(() => useAutoFocus(inputRef as any));
 
-    expect(inputRef.current?.focus).not.toHaveBeenCalled();
+    expect(inputRef.current).toBeNull();
   });
 });
diff --git a/src/app/(main)/chat/(workspace)/@conversation/features/ChatInput/Desktop/useAutoFocus.ts b/src/app/(main)/chat/(workspace)/@conversation/features/ChatInput/Desktop/useAutoFocus.ts
@@ -1,39 +1,13 @@
 import { TextAreaRef } from 'antd/es/input/TextArea';
 import { RefObject, useEffect } from 'react';
 
-export const useAutoFocus = (inputRef: RefObject<TextAreaRef>) => {
-  useEffect(() => {
-    let isInputOrMarkdown = false;
-
-    const onMousedown = (e: MouseEvent) => {
-      isInputOrMarkdown = false;
-      const element = document.elementFromPoint(e.clientX, e.clientY);
-      if (!element) return;
-      let currentElement: Element | null = element;
-      // 因为点击 Markdown 元素时，element 会是 article 标签的子元素
-      // Debug 信息时，element 会是 pre 标签
-      // 所以向上查找全局点击对象是否是 Markdown 或者 Input 或者 Debug 元素
-      while (currentElement && !isInputOrMarkdown) {
-        isInputOrMarkdown = ['TEXTAREA', 'INPUT', 'ARTICLE', 'PRE'].includes(
-          currentElement.tagName,
-        );
-        currentElement = currentElement.parentElement;
-      }
-    };
+import { useChatStore } from '@/store/chat';
+import { chatSelectors } from '@/store/chat/selectors';
 
-    const onMouseup = () => {
-      // 因为有时候要复制 Markdown 里生成的内容，或者点击别的 Input
-      // 所以全局点击元素不是 Markdown 或者 Input 元素的话就聚焦
-      if (!isInputOrMarkdown) {
-        inputRef.current?.focus();
-      }
-    };
+export const useAutoFocus = (inputRef: RefObject<TextAreaRef>) => {
+  const chatKey = useChatStore(chatSelectors.currentChatKey);
 
-    document.addEventListener('mousedown', onMousedown);
-    document.addEventListener('mouseup', onMouseup);
-    return () => {
-      document.removeEventListener('mousedown', onMousedown);
-      document.removeEventListener('mouseup', onMouseup);
-    };
-  }, []);
+  useEffect(() => {
+    inputRef.current?.focus();
+  }, [chatKey]);
 };
diff --git a/src/app/(main)/chat/@session/features/SessionListContent/DefaultMode.tsx b/src/app/(main)/chat/@session/features/SessionListContent/DefaultMode.tsx
@@ -7,6 +7,8 @@ import { useGlobalStore } from '@/store/global';
 import { systemStatusSelectors } from '@/store/global/selectors';
 import { useSessionStore } from '@/store/session';
 import { sessionSelectors } from '@/store/session/selectors';
+import { useUserStore } from '@/store/user';
+import { authSelectors } from '@/store/user/selectors';
 import { SessionDefaultGroup } from '@/types/session';
 
 import Actions from '../SessionListContent/CollapseGroup/Actions';
@@ -23,8 +25,9 @@ const DefaultMode = memo(() => {
   const [renameGroupModalOpen, setRenameGroupModalOpen] = useState(false);
   const [configGroupModalOpen, setConfigGroupModalOpen] = useState(false);
 
+  const isLogin = useUserStore(authSelectors.isLogin);
   const [useFetchSessions] = useSessionStore((s) => [s.useFetchSessions]);
-  useFetchSessions();
+  useFetchSessions(isLogin);
 
   const defaultSessions = useSessionStore(sessionSelectors.defaultSessions, isEqual);
   const customSessionGroups = useSessionStore(sessionSelectors.customSessionGroups, isEqual);
diff --git a/src/store/session/slices/session/action.ts b/src/store/session/slices/session/action.ts
@@ -72,7 +72,7 @@ export interface SessionAction {
 
   updateSearchKeywords: (keywords: string) => void;
 
-  useFetchSessions: () => SWRResponse<ChatSessionList>;
+  useFetchSessions: (isLogin: boolean | undefined) => SWRResponse<ChatSessionList>;
   useSearchSessions: (keyword?: string) => SWRResponse<any>;
 
   internal_dispatchSessions: (payload: SessionDispatch) => void;
@@ -192,29 +192,33 @@ export const createSessionSlice: StateCreator<
     await refreshSessions();
   },
 
-  useFetchSessions: () =>
-    useClientDataSWR<ChatSessionList>(FETCH_SESSIONS_KEY, sessionService.getGroupedSessions, {
-      fallbackData: {
-        sessionGroups: [],
-        sessions: [],
-      },
-      onSuccess: (data) => {
-        if (
-          get().isSessionsFirstFetchFinished &&
-          isEqual(get().sessions, data.sessions) &&
-          isEqual(get().sessionGroups, data.sessionGroups)
-        )
-          return;
-
-        get().internal_processSessions(
-          data.sessions,
-          data.sessionGroups,
-          n('useFetchSessions/updateData') as any,
-        );
-        set({ isSessionsFirstFetchFinished: true }, false, n('useFetchSessions/onSuccess', data));
+  useFetchSessions: (isLogin) =>
+    useClientDataSWR<ChatSessionList>(
+      [FETCH_SESSIONS_KEY, isLogin],
+      () => sessionService.getGroupedSessions(),
+      {
+        fallbackData: {
+          sessionGroups: [],
+          sessions: [],
+        },
+        onSuccess: (data) => {
+          if (
+            get().isSessionsFirstFetchFinished &&
+            isEqual(get().sessions, data.sessions) &&
+            isEqual(get().sessionGroups, data.sessionGroups)
+          )
+            return;
+
+          get().internal_processSessions(
+            data.sessions,
+            data.sessionGroups,
+            n('useFetchSessions/updateData') as any,
+          );
+          set({ isSessionsFirstFetchFinished: true }, false, n('useFetchSessions/onSuccess', data));
+        },
+        suspense: true,
       },
-      suspense: true,
-    }),
+    ),
   useSearchSessions: (keyword) =>
     useSWR<LobeSessions>(
       [SEARCH_SESSIONS_KEY, keyword],

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@lobehub/chat",`
`3`		`- "version": "0.162.3",`
	`3`	`+ "version": "0.162.4",`
`4`	`4`	`"description": "Lobe Chat - an open-source, high-performance chatbot framework that supports speech synthesis, multimodal, and extensible Function Call plugin system. Supports one-click free deployment of your private ChatGPT/LLM web application.",`
`5`	`5`	`"keywords": [`
`6`	`6`	`"framework",`