@lobehub/chat 0.120.6 → 0.121.0

package/src/store/global/slices/settings/selectors.test.ts

@@ -153,187 +153,137 @@ describe('settingsSelectors', () => {
       expect(result).toMatchSnapshot();
     });
   });
+  describe('defaultAgent', () => {
+    it('should merge DEFAULT_AGENT and s.settings.defaultAgent correctly', () => {
+      const s = {
+        settings: {
+          defaultAgent: {
+            config: {
+              systemRole: 'user',
+              model: LanguageModel.GPT3_5,
+            },
+            meta: {
+              avatar: 'agent-avatar.jpg',
+              description: 'Test agent',
+            },
+          },
+        },
+      } as unknown as GlobalStore;
+
+      const result = settingsSelectors.defaultAgent(s);
+
+      expect(result).toMatchSnapshot();
+    });
+  });
+
+  describe('defaultAgentConfig', () => {
+    it('should merge DEFAULT_AGENT_CONFIG and defaultAgent(s).config correctly', () => {
+      const s = {
+        settings: {
+          defaultAgent: {
+            config: {
+              systemRole: 'user',
+              model: LanguageModel.GPT3_5,
+              params: {
+                temperature: 0.7,
+              },
+            },
+          },
+        },
+      } as unknown as GlobalStore;
+
+      const result = settingsSelectors.defaultAgentConfig(s);
+
+      expect(result).toMatchSnapshot();
+    });
+  });
+
+  describe('defaultAgentMeta', () => {
+    it('should merge DEFAULT_AGENT_META and defaultAgent(s).meta correctly', () => {
+      const s = {
+        settings: {
+          defaultAgent: {
+            meta: {
+              avatar: 'agent-avatar.jpg',
+              description: 'Test agent',
+            },
+          },
+        },
+      } as unknown as GlobalStore;
+
+      const result = settingsSelectors.defaultAgentMeta(s);
+
+      expect(result).toMatchSnapshot();
+    });
+  });
 
-  // describe('defaultAgent', () => {
-  //   it('should merge DEFAULT_AGENT and s.settings.defaultAgent correctly', () => {
-  //     const s: GlobalStore = {
-  //       settings: {
-  //         defaultAgent: {
-  //           config: {
-  //             model: 'gpt-3.5-turbo',
-  //             maxTokens: 100,
-  //           },
-  //           meta: {
-  //             name: 'Default Agent',
-  //             description: 'Default agent for testing',
-  //           },
-  //         },
-  //       },
-  //     };
-  //
-  //     const result = settingsSelectors.defaultAgent(s);
-  //
-  //     expect(result).toEqual(expected);
-  //   });
-  // });
-  //
-  // describe('defaultAgentConfig', () => {
-  //   it('should merge DEFAULT_AGENT_CONFIG and defaultAgent(s).config correctly', () => {
-  //     const s: GlobalStore = {
-  //       settings: {
-  //         defaultAgent: {
-  //           config: {
-  //             model: 'gpt-3.5-turbo',
-  //             maxTokens: 100,
-  //           },
-  //         },
-  //       },
-  //     };
-  //
-  //     const result = settingsSelectors.defaultAgentConfig(s);
-  //
-  //     const defaultAgent = settingsSelectors.defaultAgent(s);
-  //     const expected = merge({}, DEFAULT_AGENT_CONFIG, defaultAgent.config);
-  //
-  //     expect(result).toEqual(expected);
-  //   });
-  // });
-  //
-  // describe('defaultAgentMeta', () => {
-  //   it('should merge DEFAULT_AGENT_META and defaultAgent(s).meta correctly', () => {
-  //     const s: GlobalStore = {
-  //       settings: {
-  //         defaultAgent: {
-  //           meta: {
-  //             name: 'Default Agent',
-  //             description: 'Default agent for testing',
-  //           },
-  //         },
-  //       },
-  //     };
-  //
-  //     const result = settingsSelectors.defaultAgentMeta(s);
-  //
-  //     const defaultAgent = settingsSelectors.defaultAgent(s);
-  //     const expected = merge({}, DEFAULT_AGENT_META, defaultAgent.meta);
-  //
-  //     expect(result).toEqual(expected);
-  //   });
-  // });
-  //
-  // describe('exportSettings', () => {
-  //   it('should remove OPENAI_API_KEY and password fields from s.settings', () => {
-  //     const s: GlobalStore = {
-  //       settings: {
-  //         OPENAI_API_KEY: 'openai-api-key',
-  //         password: 'password123',
-  //         avatar: 'avatar.jpg',
-  //         fontSize: 14,
-  //         language: 'en',
-  //         neutralColor: 'white',
-  //         primaryColor: 'blue',
-  //         themeMode: 'light',
-  //         defaultAgent: {
-  //           config: {
-  //             model: 'gpt-3.5-turbo',
-  //             maxTokens: 100,
-  //           },
-  //           meta: {
-  //             name: 'Default Agent',
-  //             description: 'Default agent for testing',
-  //           },
-  //         },
-  //         languageModel: {
-  //           azureOpenAI: {
-  //             AZURE_API_KEY: 'azure-api-key',
-  //             apiVersion: 'v1',
-  //             endpoint: 'https://azure-openai-endpoint.com',
-  //             models: ['gpt-3.5-turbo'],
-  //           },
-  //           openAI: {
-  //             OPENAI_API_KEY: 'openai-api-key',
-  //             endpoint: 'https://openai-endpoint.com',
-  //             models: ['gpt-3.5-turbo'],
-  //           },
-  //         },
-  //       },
-  //     };
-  //
-  //     const result = settingsSelectors.exportSettings(s);
-  //
-  //     const expected = {
-  //       avatar: 'avatar.jpg',
-  //       fontSize: 14,
-  //       language: 'en',
-  //       neutralColor: 'white',
-  //       primaryColor: 'blue',
-  //       themeMode: 'light',
-  //       defaultAgent: {
-  //         config: {
-  //           model: 'gpt-3.5-turbo',
-  //           maxTokens: 100,
-  //         },
-  //         meta: {
-  //           name: 'Default Agent',
-  //           description: 'Default agent for testing',
-  //         },
-  //       },
-  //       languageModel: {
-  //         azureOpenAI: {
-  //           AZURE_API_KEY: 'azure-api-key',
-  //           apiVersion: 'v1',
-  //           endpoint: 'https://azure-openai-endpoint.com',
-  //           models: ['gpt-3.5-turbo'],
-  //         },
-  //         openAI: {
-  //           endpoint: 'https://openai-endpoint.com',
-  //           models: ['gpt-3.5-turbo'],
-  //         },
-  //       },
-  //     };
-  //
-  //     expect(result).toEqual(expected);
-  //   });
-  //
-  //   it('should return the result as GlobalSettings type', () => {
-  //     const s: GlobalStore = {
-  //       settings: {
-  //         avatar: 'avatar.jpg',
-  //         fontSize: 14,
-  //         language: 'en',
-  //         neutralColor: 'white',
-  //         password: 'password123',
-  //         primaryColor: 'blue',
-  //         themeMode: 'light',
-  //         defaultAgent: {
-  //           config: {
-  //             model: 'gpt-3.5-turbo',
-  //             maxTokens: 100,
-  //           },
-  //           meta: {
-  //             name: 'Default Agent',
-  //             description: 'Default agent for testing',
-  //           },
-  //         },
-  //         languageModel: {
-  //           azureOpenAI: {
-  //             AZURE_API_KEY: 'azure-api-key',
-  //             apiVersion: 'v1',
-  //             endpoint: 'https://azure-openai-endpoint.com',
-  //             models: ['gpt-3.5-turbo'],
-  //           },
-  //           openAI: {
-  //             OPENAI_API_KEY: 'openai-api-key',
-  //             endpoint: 'https://openai-endpoint.com',
-  //             models: ['gpt-3.5-turbo'],
-  //           },
-  //         },
-  //       },
-  //     };
-  //
-  //     const result = settingsSelectors.exportSettings(s);
-  //
-  //     expect(result).toBeInstanceOf(GlobalSettings);
-  //   });
-  // });
+  describe('currentTTS', () => {
+    it('should merge DEFAULT_TTS_CONFIG and s.settings.tts correctly', () => {
+      const s = {
+        settings: {
+          tts: {
+            sttAutoStop: false,
+            openAI: {
+              sttModel: 'whisper-2',
+            },
+          },
+        },
+      } as unknown as GlobalStore;
+
+      const result = settingsSelectors.currentTTS(s);
+
+      expect(result).toMatchSnapshot();
+    });
+  });
+
+  describe('currentLanguage', () => {
+    it('should return the correct language setting', () => {
+      const s = {
+        settings: {
+          language: 'fr',
+        },
+      } as unknown as GlobalStore;
+
+      const result = settingsSelectors.currentLanguage(s);
+
+      expect(result).toBe('fr');
+    });
+  });
+
+  describe('dalleConfig', () => {
+    it('should return the dalle configuration', () => {
+      const s = {
+        settings: {
+          tool: {
+            dalle: {
+              apiKey: 'dalle-api-key',
+              autoGenerate: true,
+            },
+          },
+        },
+      } as unknown as GlobalStore;
+
+      const result = settingsSelectors.dalleConfig(s);
+
+      expect(result).toMatchSnapshot();
+    });
+  });
+
+  describe('isDalleAutoGenerating', () => {
+    it('should return the autoGenerate flag from dalle configuration', () => {
+      const s = {
+        settings: {
+          tool: {
+            dalle: {
+              autoGenerate: true,
+            },
+          },
+        },
+      } as unknown as GlobalStore;
+
+      const result = settingsSelectors.isDalleAutoGenerating(s);
+
+      expect(result).toBe(true);
+    });
+  });
 });

package/src/store/global/store.ts

@@ -5,6 +5,7 @@ import { createWithEqualityFn } from 'zustand/traditional';
 import { StateCreator } from 'zustand/vanilla';
 
 import { DEFAULT_AGENT, DEFAULT_LLM_CONFIG } from '@/const/settings';
+import { SessionDefaultGroup } from '@/types/session';
 import { isDev } from '@/utils/env';
 
 import { createHyperStorage } from '../middleware/createHyperStorage';
@@ -32,6 +33,12 @@ const persistOptions: PersistOptions<GlobalStore, GlobalPersist> = {
     return {
       ...currentState,
       ...state,
+      preference: produce(state.preference, (draft) => {
+        if (!draft.expandSessionGroupKeys) {
+          draft.expandSessionGroupKeys = [SessionDefaultGroup.Pinned, SessionDefaultGroup.Default];
+          delete (draft as any).sessionGroupKeys;
+        }
+      }),
       settings: produce(state.settings, (draft) => {
         if (!draft.defaultAgent) {
           draft.defaultAgent = DEFAULT_AGENT;

package/src/store/session/initialState.ts

@@ -1,34 +1,9 @@
-import { AppRouterInstance } from 'next/dist/shared/lib/app-router-context.shared-runtime';
+import { SessionState, initialSessionState } from './slices/session/initialState';
+import { SessionGroupState, initSessionGroupState } from './slices/sessionGroup/initialState';
 
-import { LobeAgentSession } from '@/types/session';
-
-export type SessionStoreState = SessionState;
-
-export interface SessionState {
-  /**
-   * @title 当前活动的会话
-   * @description 当前正在编辑或查看的会话
-   */
-  activeId: string;
-  isMobile?: boolean;
-  isSearching: boolean;
-  isSessionsFirstFetchFinished: boolean;
-  /**
-   * 后续看看是否可以将 router 部分的逻辑移出去
-   * @deprecated
-   */
-  router?: AppRouterInstance;
-  searchKeywords: string;
-  searchSessions: LobeAgentSession[];
-  sessions: LobeAgentSession[];
-}
+export interface SessionStoreState extends SessionGroupState, SessionState {}
 
 export const initialState: SessionStoreState = {
-  activeId: 'inbox',
-  isMobile: false,
-  isSearching: false,
-  isSessionsFirstFetchFinished: false,
-  searchKeywords: '',
-  searchSessions: [],
-  sessions: [],
+  ...initSessionGroupState,
+  ...initialSessionState,
 };

package/src/store/session/selectors.ts

@@ -1,2 +1,3 @@
 export { agentSelectors } from './slices/agent/selectors';
-export { sessionExportSelectors, sessionSelectors } from './slices/session/selectors';
+export { sessionSelectors } from './slices/session/selectors';
+export { sessionGroupSelectors } from './slices/sessionGroup/selectors';

package/src/store/session/slices/session/action.test.ts

@@ -17,7 +17,9 @@ vi.mock('@/services/session', () => ({
     updateSessionGroup: vi.fn(),
     removeSession: vi.fn(),
     getSessions: vi.fn(),
+    updateSessionGroupId: vi.fn(),
     searchSessions: vi.fn(),
+    updateSessionPinned: vi.fn(),
   },
 }));
 
@@ -133,4 +135,58 @@ describe('SessionAction', () => {
       );
     });
   });
+
+  describe('activeSession', () => {
+    it('should set the provided session id as active', async () => {
+      const { result } = renderHook(() => useSessionStore());
+      const sessionId = 'active-session-id';
+
+      act(() => {
+        result.current.activeSession(sessionId);
+      });
+
+      expect(result.current.activeId).toBe(sessionId);
+    });
+  });
+
+  describe('pinSession', () => {
+    it('should pin a session when pinned is true', async () => {
+      const { result } = renderHook(() => useSessionStore());
+      const sessionId = 'session-id-to-pin';
+
+      await act(async () => {
+        await result.current.pinSession(sessionId, true);
+      });
+
+      expect(sessionService.updateSessionPinned).toHaveBeenCalledWith(sessionId, true);
+      expect(mockRefresh).toHaveBeenCalled();
+    });
+
+    it('should unpin a session when pinned is false', async () => {
+      const { result } = renderHook(() => useSessionStore());
+      const sessionId = 'session-id-to-unpin';
+
+      await act(async () => {
+        await result.current.pinSession(sessionId, false);
+      });
+
+      expect(sessionService.updateSessionPinned).toHaveBeenCalledWith(sessionId, false);
+      expect(mockRefresh).toHaveBeenCalled();
+    });
+  });
+
+  describe('updateSessionGroupId', () => {
+    it('should update the session group and refresh the list', async () => {
+      const { result } = renderHook(() => useSessionStore());
+      const sessionId = 'session-id';
+      const groupId = 'new-group-id';
+
+      await act(async () => {
+        await result.current.updateSessionGroupId(sessionId, groupId);
+      });
+
+      expect(sessionService.updateSessionGroupId).toHaveBeenCalledWith(sessionId, groupId);
+      expect(mockRefresh).toHaveBeenCalled();
+    });
+  });
 });

package/src/store/session/slices/session/action.ts

@@ -11,8 +11,8 @@ import { useGlobalStore } from '@/store/global';
 import { settingsSelectors } from '@/store/global/selectors';
 import { SessionStore } from '@/store/session';
 import {
+  ChatSessionList,
   LobeAgentSession,
-  LobeAgentSettings,
   LobeSessionType,
   LobeSessions,
 } from '@/types/session';
@@ -42,12 +42,12 @@ export interface SessionAction {
    * @param agent
    * @returns sessionId
    */
-  createSession: (agent?: DeepPartial<LobeAgentSettings>) => Promise<string>;
+  createSession: (session?: DeepPartial<LobeAgentSession>) => Promise<string>;
   duplicateSession: (id: string) => Promise<void>;
   /**
    * Pins or unpins a session.
    */
-  pinSession: (id: string, pinned?: boolean) => Promise<void>;
+  pinSession: (id: string, pinned: boolean) => Promise<void>;
   /**
    * re-fetch the data
    */
@@ -127,7 +127,7 @@ export const createSessionSlice: StateCreator<
   },
 
   pinSession: async (sessionId, pinned) => {
-    await sessionService.updateSessionGroup(sessionId, pinned ? 'pinned' : 'default');
+    await sessionService.updateSessionPinned(sessionId, pinned);
 
     await get().refreshSessions();
   },
@@ -144,6 +144,7 @@ export const createSessionSlice: StateCreator<
       get().switchSession();
     }
   },
+
   switchSession: (sessionId = INBOX_SESSION_ID) => {
     const { isMobile, router } = get();
 
@@ -154,20 +155,23 @@ export const createSessionSlice: StateCreator<
   },
 
   useFetchSessions: () =>
-    useSWR<LobeSessions>(FETCH_SESSIONS_KEY, sessionService.getSessions, {
+    useSWR<ChatSessionList>(FETCH_SESSIONS_KEY, sessionService.getSessionsWithGroup, {
       onSuccess: (data) => {
         // 由于 https://github.com/lobehub/lobe-chat/pull/541 的关系
         // 只有触发了 refreshSessions 才会更新 sessions，进而触发页面 rerender
-        // 因此这里不能补充判断，否则会导致页面不更新
+        // 因此这里不能补充 equal 判断，否则会导致页面不更新
+        // if (get().isSessionsFirstFetchFinished && isEqual(get().sessions, data)) return;
+
         // TODO：后续的根本解法应该是解除 inbox 和 session 的数据耦合
         // 避免互相依赖的情况出现
 
-        // if (get().isSessionsFirstFetchFinished && isEqual(get().sessions, data)) return;
-
         set(
           {
+            customSessionGroups: data.customGroup,
+            defaultSessions: data.default,
             isSessionsFirstFetchFinished: true,
-            sessions: data,
+            pinnedSessions: data.pinned,
+            sessions: data.all,
           },
           false,
           n('useFetchSessions/onSuccess', data),

package/src/store/session/slices/session/helpers.ts

@@ -1,9 +1,8 @@
-import { LobeAgentSession, LobeSessions, SessionGroupDefaultKeys } from '@/types/session';
+import { LobeAgentSession, LobeSessions } from '@/types/session';
 
 import { initLobeSession } from './initialState';
 
-export const getSessionPinned = (session: LobeAgentSession) =>
-  session.group === SessionGroupDefaultKeys.Pinned;
+export const getSessionPinned = (session: LobeAgentSession) => session.pinned;
 
 const getSessionById = (id: string, sessions: LobeSessions): LobeAgentSession => {
   const session = sessions.find((s) => s.id === id);

package/src/store/session/slices/session/initialState.ts

@@ -1,44 +1,52 @@
 import { AppRouterInstance } from 'next/dist/shared/lib/app-router-context.shared-runtime';
 
-import { DEFAULT_AGENT_META, DEFAULT_INBOX_AVATAR } from '@/const/meta';
+import { DEFAULT_AGENT_META } from '@/const/meta';
 import { DEFAULT_AGENT_CONFIG } from '@/const/settings';
-import { LobeAgentSession, LobeSessionType } from '@/types/session';
-import { merge } from '@/utils/merge';
+import { CustomSessionGroup, LobeAgentSession, LobeSessionType } from '@/types/session';
+
+export const initLobeSession: LobeAgentSession = {
+  config: DEFAULT_AGENT_CONFIG,
+  createdAt: Date.now(),
+  id: '',
+  meta: DEFAULT_AGENT_META,
+  type: LobeSessionType.Agent,
+  updatedAt: Date.now(),
+};
 
 export interface SessionState {
   /**
    * @title 当前活动的会话
    * @description 当前正在编辑或查看的会话
    */
-  activeId: string | undefined;
-  fetchSessionsLoading: boolean;
+  activeId: string;
+  customSessionGroups: CustomSessionGroup[];
+  defaultSessions: LobeAgentSession[];
   isMobile?: boolean;
+  isSearching: boolean;
+  isSessionsFirstFetchFinished: boolean;
+  pinnedSessions: LobeAgentSession[];
+  /**
+   * 后续看看是否可以将 router 部分的逻辑移出去
+   * @deprecated
+   */
   router?: AppRouterInstance;
   searchKeywords: string;
+  searchSessions: LobeAgentSession[];
+  /**
+   * it means defaultSessions
+   */
   sessions: LobeAgentSession[];
-  topicSearchKeywords: string;
 }
 
-export const initLobeSession: LobeAgentSession = {
-  config: DEFAULT_AGENT_CONFIG,
-  createdAt: Date.now(),
-  id: '',
-  meta: DEFAULT_AGENT_META,
-  type: LobeSessionType.Agent,
-  updatedAt: Date.now(),
-};
-export const initInboxSession: LobeAgentSession = merge(initLobeSession, {
-  id: 'inbox',
-  meta: {
-    avatar: DEFAULT_INBOX_AVATAR,
-  },
-});
-
 export const initialSessionState: SessionState = {
   activeId: 'inbox',
-  fetchSessionsLoading: true,
+  customSessionGroups: [],
+  defaultSessions: [],
   isMobile: false,
+  isSearching: false,
+  isSessionsFirstFetchFinished: false,
+  pinnedSessions: [],
   searchKeywords: '',
+  searchSessions: [],
   sessions: [],
-  topicSearchKeywords: '',
 };

package/src/store/session/slices/session/selectors/index.ts

@@ -1,2 +1 @@
-export * from './export';
 export * from './list';