@lobehub/chat 0.149.4 → 0.149.5

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

@@ -7,6 +7,8 @@ import { sessionService } from '@/services/session';
 import { useSessionStore } from '@/store/session';
 import { LobeSessionType } from '@/types/session';
 
+import { sessionSelectors } from './selectors';
+
 // Mock sessionService 和其他依赖项
 vi.mock('@/services/session', () => ({
   sessionService: {
@@ -189,4 +191,45 @@ describe('SessionAction', () => {
       expect(mockRefresh).toHaveBeenCalled();
     });
   });
+
+  describe('updateAgentMeta', () => {
+    it('should not update meta if there is no current session', async () => {
+      const { result } = renderHook(() => useSessionStore());
+      const meta = { title: 'Test Agent' };
+      const updateSessionMock = vi.spyOn(sessionService, 'updateSession');
+      const refreshSessionsMock = vi.spyOn(result.current, 'refreshSessions');
+
+      // 模拟没有当前会话
+      vi.spyOn(sessionSelectors, 'currentSession').mockReturnValue(null as any);
+
+      await act(async () => {
+        await result.current.updateSessionMeta(meta as any);
+      });
+
+      expect(updateSessionMock).not.toHaveBeenCalled();
+      expect(refreshSessionsMock).not.toHaveBeenCalled();
+      updateSessionMock.mockRestore();
+      refreshSessionsMock.mockRestore();
+    });
+
+    it('should update session meta and refresh sessions', async () => {
+      const { result } = renderHook(() => useSessionStore());
+      const meta = { title: 'Test Agent' };
+      const updateSessionMock = vi.spyOn(sessionService, 'updateSession');
+      const refreshSessionsMock = vi.spyOn(result.current, 'refreshSessions');
+
+      // 模拟有当前会话
+      vi.spyOn(sessionSelectors, 'currentSession').mockReturnValue({ id: 'session-id' } as any);
+      vi.spyOn(result.current, 'activeId', 'get').mockReturnValue('session-id');
+
+      await act(async () => {
+        await result.current.updateSessionMeta(meta);
+      });
+
+      expect(updateSessionMock).toHaveBeenCalledWith('session-id', { meta });
+      expect(refreshSessionsMock).toHaveBeenCalled();
+      updateSessionMock.mockRestore();
+      refreshSessionsMock.mockRestore();
+    });
+  });
 });

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

@@ -1,15 +1,17 @@
 import { t } from 'i18next';
+import { isEqual } from 'lodash-es';
 import useSWR, { SWRResponse, mutate } from 'swr';
 import { DeepPartial } from 'utility-types';
 import { StateCreator } from 'zustand/vanilla';
 
 import { message } from '@/components/AntdStaticMethods';
-import { INBOX_SESSION_ID } from '@/const/session';
-import { SWRRefreshParams, useClientDataSWR } from '@/libs/swr';
+import { DEFAULT_AGENT_LOBE_SESSION, INBOX_SESSION_ID } from '@/const/session';
+import { useClientDataSWR } from '@/libs/swr';
 import { sessionService } from '@/services/session';
 import { useGlobalStore } from '@/store/global';
 import { settingsSelectors } from '@/store/global/selectors';
 import { SessionStore } from '@/store/session';
+import { MetaData } from '@/types/meta';
 import {
   ChatSessionList,
   LobeAgentSession,
@@ -21,10 +23,9 @@ import {
 import { merge } from '@/utils/merge';
 import { setNamespace } from '@/utils/storeDebug';
 
-import { agentSelectors } from '../agent/selectors';
-import { initLobeSession } from './initialState';
 import { SessionDispatch, sessionsReducer } from './reducers';
 import { sessionSelectors } from './selectors';
+import { sessionMetaSelectors } from './selectors/meta';
 
 const n = setNamespace('session');
 
@@ -53,6 +54,7 @@ export interface SessionAction {
   ) => Promise<string>;
   duplicateSession: (id: string) => Promise<void>;
   updateSessionGroupId: (sessionId: string, groupId: string) => Promise<void>;
+  updateSessionMeta: (meta: Partial<MetaData>) => void;
 
   /**
    * Pins or unpins a session.
@@ -61,7 +63,7 @@ export interface SessionAction {
   /**
    * re-fetch the data
    */
-  refreshSessions: (params?: SWRRefreshParams<ChatSessionList>) => Promise<void>;
+  refreshSessions: () => Promise<void>;
   /**
    * remove session
    * @param id - sessionId
@@ -106,7 +108,7 @@ export const createSessionSlice: StateCreator<
 
     // merge the defaultAgent in settings
     const defaultAgent = merge(
-      initLobeSession,
+      DEFAULT_AGENT_LOBE_SESSION,
       settingsSelectors.defaultAgent(useGlobalStore.getState()),
     );
 
@@ -125,7 +127,7 @@ export const createSessionSlice: StateCreator<
     const session = sessionSelectors.getSessionById(id)(get());
 
     if (!session) return;
-    const title = agentSelectors.getTitle(session.meta);
+    const title = sessionMetaSelectors.getTitle(session.meta);
 
     const newTitle = t('duplicateSession.title', { ns: 'chat', title: title });
 
@@ -157,10 +159,6 @@ export const createSessionSlice: StateCreator<
     await get().internal_updateSession(id, { pinned });
   },
 
-  refreshSessions: async () => {
-    await mutate(FETCH_SESSIONS_KEY);
-  },
-
   removeSession: async (sessionId) => {
     await sessionService.removeSession(sessionId);
     await get().refreshSessions();
@@ -175,16 +173,25 @@ export const createSessionSlice: StateCreator<
     await get().internal_updateSession(sessionId, { group });
   },
 
+  updateSessionMeta: async (meta) => {
+    const session = sessionSelectors.currentSession(get());
+    if (!session) return;
+
+    const { activeId, refreshSessions } = get();
+
+    await sessionService.updateSession(activeId, { meta });
+    await refreshSessions();
+  },
+
   useFetchSessions: () =>
     useClientDataSWR<ChatSessionList>(FETCH_SESSIONS_KEY, sessionService.getGroupedSessions, {
       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.sessions) &&
+          isEqual(get().sessionGroups, data.sessionGroups)
+        )
+          return;
 
         get().internal_processSessions(
           data.sessions,
@@ -239,4 +246,7 @@ export const createSessionSlice: StateCreator<
       n('processSessions'),
     );
   },
+  refreshSessions: async () => {
+    await mutate(FETCH_SESSIONS_KEY);
+  },
 });

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

@@ -1,13 +1,12 @@
+import { DEFAULT_AGENT_LOBE_SESSION } from '@/const/session';
 import { LobeAgentSession, LobeSessions } from '@/types/session';
 
-import { initLobeSession } from './initialState';
-
 export const getSessionPinned = (session: LobeAgentSession) => session.pinned;
 
 const getSessionById = (id: string, sessions: LobeSessions): LobeAgentSession => {
   const session = sessions.find((s) => s.id === id);
 
-  if (!session) return initLobeSession;
+  if (!session) return DEFAULT_AGENT_LOBE_SESSION;
 
   return session;
 };

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

@@ -1,20 +1,4 @@
-import { DEFAULT_AGENT_META } from '@/const/meta';
-import { DEFAULT_AGENT_CONFIG } from '@/const/settings';
-import {
-  CustomSessionGroup,
-  LobeAgentSession,
-  LobeSessionGroups,
-  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(),
-};
+import { CustomSessionGroup, LobeAgentSession, LobeSessionGroups } from '@/types/session';
 
 export interface SessionState {
   /**

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

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

package/src/store/session/slices/session/selectors/list.test.ts

@@ -1,7 +1,7 @@
+import { DEFAULT_AGENT_LOBE_SESSION } from '@/const/session';
 import type { SessionStore } from '@/store/session';
 import { LobeAgentSession, LobeSessionType } from '@/types/session';
 
-import { initLobeSession } from '../initialState';
 import { sessionSelectors } from './list';
 
 describe('currentSession', () => {
@@ -64,7 +64,9 @@ describe('currentSessionSafe', () => {
   } as unknown as SessionStore;
 
   it('should return initLobeSession when currentSession(s) returns undefined', () => {
-    expect(sessionSelectors.currentSessionSafe({ sessions: {} } as any)).toEqual(initLobeSession);
+    expect(sessionSelectors.currentSessionSafe({ sessions: {} } as any)).toEqual(
+      DEFAULT_AGENT_LOBE_SESSION,
+    );
   });
 
   it('should return the result of currentSession(s) when it returns a non-undefined value', () => {
@@ -102,7 +104,7 @@ describe('getSessionById', () => {
   });
 
   it('should return initLobeSession when the session with the specified id does not exist', () => {
-    expect(sessionSelectors.getSessionById('3')(s)).toEqual(initLobeSession);
+    expect(sessionSelectors.getSessionById('3')(s)).toEqual(DEFAULT_AGENT_LOBE_SESSION);
   });
 });
 

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

@@ -1,10 +1,9 @@
-import { INBOX_SESSION_ID } from '@/const/session';
+import { DEFAULT_AGENT_LOBE_SESSION, INBOX_SESSION_ID } from '@/const/session';
 import { sessionHelpers } from '@/store/session/slices/session/helpers';
 import { MetaData } from '@/types/meta';
 import { CustomSessionGroup, LobeAgentSession, LobeSessions } from '@/types/session';
 
 import { SessionStore } from '../../../store';
-import { initLobeSession } from '../initialState';
 
 const defaultSessions = (s: SessionStore): LobeSessions => s.defaultSessions;
 const pinnedSessions = (s: SessionStore): LobeSessions => s.pinnedSessions;
@@ -33,7 +32,7 @@ const currentSession = (s: SessionStore): LobeAgentSession | undefined => {
 };
 
 const currentSessionSafe = (s: SessionStore): LobeAgentSession => {
-  return currentSession(s) || initLobeSession;
+  return currentSession(s) || DEFAULT_AGENT_LOBE_SESSION;
 };
 
 const hasCustomAgents = (s: SessionStore) => defaultSessions(s).length > 0;

package/src/store/session/slices/session/selectors/meta.test.ts

@@ -0,0 +1,108 @@
+import { describe, expect, it } from 'vitest';
+
+import { DEFAULT_AVATAR } from '@/const/meta';
+import { DEFAULT_AGENT_CONFIG, DEFAUTT_AGENT_TTS_CONFIG } from '@/const/settings';
+import { SessionStore } from '@/store/session';
+import { MetaData } from '@/types/meta';
+import { LobeAgentSession, LobeSessionType } from '@/types/session';
+
+import { sessionMetaSelectors } from './meta';
+
+vi.mock('i18next', () => ({
+  t: vi.fn((key) => key), // Simplified mock return value
+}));
+
+const mockSessionStore = {
+  activeId: '1',
+  sessions: [
+    {
+      id: '1',
+      config: DEFAULT_AGENT_CONFIG,
+      meta: {
+        title: 'title1',
+        description: 'description1',
+      },
+      type: LobeSessionType.Agent,
+    } as LobeAgentSession,
+    {
+      id: '2',
+      meta: {
+        title: 'title2',
+        description: 'description2',
+      },
+      config: DEFAULT_AGENT_CONFIG,
+      type: LobeSessionType.Agent,
+    } as LobeAgentSession,
+  ],
+} as unknown as SessionStore;
+
+describe('sessionMetaSelectors', () => {
+  describe('currentAgentMeta', () => {
+    it('should return the merged default and session-specific meta data', () => {
+      const meta = sessionMetaSelectors.currentAgentMeta(mockSessionStore);
+      expect(meta).toEqual(expect.objectContaining(mockSessionStore.sessions[0].meta));
+    });
+
+    it('should return inbox defaults if it is an inbox session', () => {
+      // Assume sessionSelectors.isInboxSession() is mocked to return true for this test
+      const meta = sessionMetaSelectors.currentAgentMeta(mockSessionStore);
+      expect(meta.avatar).toBe(DEFAULT_AVATAR);
+    });
+  });
+
+  describe('currentAgentTitle', () => {
+    it('should return the title from the session meta data', () => {
+      const title = sessionMetaSelectors.currentAgentTitle(mockSessionStore);
+      expect(title).toBe(mockSessionStore.sessions[0].meta.title);
+    });
+  });
+
+  describe('currentAgentDescription', () => {
+    it('should return the description from the session meta data', () => {
+      const description = sessionMetaSelectors.currentAgentDescription(mockSessionStore);
+      expect(description).toBe(mockSessionStore.sessions[0].meta.description);
+    });
+  });
+
+  describe('getAvatar', () => {
+    it('should return the avatar from the meta data', () => {
+      const meta: MetaData = { avatar: 'custom-avatar.png' };
+      const avatar = sessionMetaSelectors.getAvatar(meta);
+      expect(avatar).toBe(meta.avatar);
+    });
+
+    it('should return the default avatar if none is defined in the meta data', () => {
+      const meta: MetaData = {};
+      const avatar = sessionMetaSelectors.getAvatar(meta);
+      expect(avatar).toBe(DEFAULT_AVATAR);
+    });
+  });
+
+  describe('getTitle', () => {
+    it('should return the title from the meta data', () => {
+      const meta: MetaData = { title: 'Custom Title' };
+      const title = sessionMetaSelectors.getTitle(meta);
+      expect(title).toBe(meta.title);
+    });
+
+    it('should return the default title if none is defined in the meta data', () => {
+      const meta: MetaData = {};
+      const title = sessionMetaSelectors.getTitle(meta);
+      expect(title).toBe('defaultSession'); // Assuming translation returns this key
+    });
+  });
+
+  describe('getDescription', () => {
+    it('should return the description from the meta data', () => {
+      const meta: MetaData = { description: 'Custom Description' };
+      const description = sessionMetaSelectors.getDescription(meta);
+      expect(description).toBe(meta.description);
+    });
+
+    it('should return the default description if none is defined in the meta data', () => {
+      const meta: MetaData = {};
+      const description = sessionMetaSelectors.getDescription(meta);
+      expect(description).toBe('noDescription'); // Assuming translation returns this key
+    });
+  });
+});

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

@@ -0,0 +1,45 @@
+import { t } from 'i18next';
+
+import { DEFAULT_AVATAR, DEFAULT_BACKGROUND_COLOR, DEFAULT_INBOX_AVATAR } from '@/const/meta';
+import { SessionStore } from '@/store/session';
+import { MetaData } from '@/types/meta';
+import { merge } from '@/utils/merge';
+
+import { sessionSelectors } from './list';
+
+// ==========   Meta   ============== //
+const currentAgentMeta = (s: SessionStore): MetaData => {
+  const isInbox = sessionSelectors.isInboxSession(s);
+
+  const defaultMeta = {
+    avatar: isInbox ? DEFAULT_INBOX_AVATAR : DEFAULT_AVATAR,
+    backgroundColor: DEFAULT_BACKGROUND_COLOR,
+    description: isInbox ? t('inbox.desc', { ns: 'chat' }) : t('noDescription'),
+    title: isInbox ? t('inbox.title', { ns: 'chat' }) : t('defaultSession'),
+  };
+
+  const session = sessionSelectors.currentSession(s);
+
+  return merge(defaultMeta, session?.meta);
+};
+
+const currentAgentTitle = (s: SessionStore) => currentAgentMeta(s).title;
+const currentAgentDescription = (s: SessionStore) => currentAgentMeta(s).description;
+const currentAgentAvatar = (s: SessionStore) => currentAgentMeta(s).avatar;
+const currentAgentBackgroundColor = (s: SessionStore) => currentAgentMeta(s).backgroundColor;
+
+const getAvatar = (s: MetaData) => s.avatar || DEFAULT_AVATAR;
+const getTitle = (s: MetaData) => s.title || t('defaultSession', { ns: 'common' });
+export const getDescription = (s: MetaData) =>
+  s.description || t('noDescription', { ns: 'common' });
+
+export const sessionMetaSelectors = {
+  currentAgentAvatar,
+  currentAgentBackgroundColor,
+  currentAgentDescription,
+  currentAgentMeta,
+  currentAgentTitle,
+  getAvatar,
+  getDescription,
+  getTitle,
+};

package/src/store/session/store.ts

@@ -6,21 +6,15 @@ import { StateCreator } from 'zustand/vanilla';
 import { isDev } from '@/utils/env';
 
 import { SessionStoreState, initialState } from './initialState';
-import { AgentAction, createAgentSlice } from './slices/agent/action';
 import { SessionAction, createSessionSlice } from './slices/session/action';
 import { SessionGroupAction, createSessionGroupSlice } from './slices/sessionGroup/action';
 
 //  ===============  聚合 createStoreFn ============ //
 
-export interface SessionStore
-  extends SessionAction,
-    AgentAction,
-    SessionGroupAction,
-    SessionStoreState {}
+export interface SessionStore extends SessionAction, SessionGroupAction, SessionStoreState {}
 
 const createStore: StateCreator<SessionStore, [['zustand/devtools', never]]> = (...parameters) => ({
   ...initialState,
-  ...createAgentSlice(...parameters),
   ...createSessionSlice(...parameters),
   ...createSessionGroupSlice(...parameters),
 });

package/src/types/session.ts

@@ -30,6 +30,7 @@ export type SessionGroups = SessionGroupItem[];
 export interface LobeAgentSession extends BaseDataModel {
   config: LobeAgentConfig;
   group?: SessionGroupId;
+  model: string;
   pinned?: boolean;
   type: LobeSessionType.Agent;
 }

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

@@ -1,84 +0,0 @@
-import { produce } from 'immer';
-import { StateCreator } from 'zustand/vanilla';
-
-import { sessionService } from '@/services/session';
-import { useGlobalStore } from '@/store/global';
-import { agentSelectors } from '@/store/session/selectors';
-import { LobeAgentConfig } from '@/types/agent';
-import { MetaData } from '@/types/meta';
-
-import { SessionStore } from '../../store';
-import { sessionSelectors } from '../session/selectors';
-
-/**
- * 助手接口
- */
-export interface AgentAction {
-  removePlugin: (id: string) => void;
-  togglePlugin: (id: string, open?: boolean) => Promise<void>;
-  updateAgentConfig: (config: Partial<LobeAgentConfig>) => void;
-  updateAgentMeta: (meta: Partial<MetaData>) => void;
-}
-
-export const createAgentSlice: StateCreator<
-  SessionStore,
-  [['zustand/devtools', never]],
-  [],
-  AgentAction
-> = (set, get) => ({
-  removePlugin: async (id) => {
-    await get().togglePlugin(id, false);
-  },
-
-  togglePlugin: async (id, open) => {
-    const originConfig = agentSelectors.currentAgentConfig(get());
-
-    const config = produce(originConfig, (draft) => {
-      draft.plugins = produce(draft.plugins || [], (plugins) => {
-        const index = plugins.indexOf(id);
-        const shouldOpen = open !== undefined ? open : index === -1;
-
-        if (shouldOpen) {
-          // 如果 open 为 true 或者 id 不存在于 plugins 中，则添加它
-          if (index === -1) {
-            plugins.push(id);
-          }
-        } else {
-          // 如果 open 为 false 或者 id 存在于 plugins 中，则移除它
-          if (index !== -1) {
-            plugins.splice(index, 1);
-          }
-        }
-      });
-    });
-
-    get().updateAgentConfig(config);
-  },
-  updateAgentConfig: async (config) => {
-    // if is the inbox session, update the global config
-    const isInbox = sessionSelectors.isInboxSession(get());
-    if (isInbox) {
-      await useGlobalStore.getState().updateDefaultAgent({ config });
-    } else {
-      const session = sessionSelectors.currentSession(get());
-      if (!session) return;
-
-      const { activeId } = get();
-
-      await sessionService.updateSessionConfig(activeId, config);
-    }
-
-    // trigger store rerender
-    await get().refreshSessions();
-  },
-
-  updateAgentMeta: async (meta) => {
-    const session = sessionSelectors.currentSession(get());
-    if (!session) return;
-
-    const { activeId, refreshSessions } = get();
-
-    await sessionService.updateSession(activeId, { meta });
-    await refreshSessions();
-  },
-});