@lobehub/chat 0.147.16 → 0.147.17

package/CHANGELOG.md

@@ -2,6 +2,31 @@
 
 # Changelog
 
+### [Version 0.147.17](https://github.com/lobehub/lobe-chat/compare/v0.147.16...v0.147.17)
+
+<sup>Released on **2024-04-16**</sup>
+
+#### ♻ Code Refactoring
+
+- **misc**: Refactor service to a uniform interface.
+
+<br/>
+
+<details>
+<summary><kbd>Improvements and Fixes</kbd></summary>
+
+#### Code refactoring
+
+- **misc**: Refactor service to a uniform interface, closes [#2062](https://github.com/lobehub/lobe-chat/issues/2062) ([86779e2](https://github.com/lobehub/lobe-chat/commit/86779e2))
+
+</details>
+
+<div align="right">
+
+[![](https://img.shields.io/badge/-BACK_TO_TOP-151515?style=flat-square)](#readme-top)
+
+</div>
+
 ### [Version 0.147.16](https://github.com/lobehub/lobe-chat/compare/v0.147.15...v0.147.16)
 
 <sup>Released on **2024-04-14**</sup>

package/contributing/Basic/Feature-Development.md

@@ -231,7 +231,7 @@ This requirement involves upgrading the Sessions feature to transform it from a
 
 To handle these groups, we need to refactor the implementation logic of `useFetchSessions`. Here are the key changes:
 
-1. Use the `sessionService.getSessionsWithGroup` method to call the backend API and retrieve the grouped session data.
+1. Use the `sessionService.getGroupedSessions` method to call the backend API and retrieve the grouped session data.
 2. Save the retrieved data into three different state fields: `pinnedSessions`, `customSessionGroups`, and `defaultSessions`.
 
 #### `useFetchSessions` Method
@@ -247,7 +247,7 @@ export const createSessionSlice: StateCreator<
 > = (set, get) => ({
   // ... other methods
   useFetchSessions: () =>
-    useSWR<ChatSessionList>(FETCH_SESSIONS_KEY, sessionService.getSessionsWithGroup, {
+    useSWR<ChatSessionList>(FETCH_SESSIONS_KEY, sessionService.getGroupedSessions, {
       onSuccess: (data) => {
         set(
           {
@@ -267,15 +267,15 @@ export const createSessionSlice: StateCreator<
 
 After successfully retrieving the data, we use the `set` method to update the `customSessionGroups`, `defaultSessions`, `pinnedSessions`, and `sessions` states. This ensures that the states are synchronized with the latest session data.
 
-#### `sessionService.getSessionsWithGroup` Method
+#### `sessionService.getGroupedSessions` Method
 
-The `sessionService.getSessionsWithGroup` method is responsible for calling the backend API `SessionModel.queryWithGroups()`.
+The `sessionService.getGroupedSessions` method is responsible for calling the backend API `SessionModel.queryWithGroups()`.
 
 ```typescript
 class SessionService {
   // ... other SessionGroup related implementations
 
-  async getSessionsWithGroup(): Promise<ChatSessionList> {
+  async getGroupedSessions(): Promise<ChatSessionList> {
     return SessionModel.queryWithGroups();
   }
 }
@@ -283,7 +283,7 @@ class SessionService {
 
 #### `SessionModel.queryWithGroups` Method
 
-This method is the core method called by `sessionService.getSessionsWithGroup`, and it is responsible for querying and organizing session data. The code is as follows:
+This method is the core method called by `sessionService.getGroupedSessions`, and it is responsible for querying and organizing session data. The code is as follows:
 
 ```typescript
 class _SessionModel extends BaseModel {
@@ -617,7 +617,7 @@ class ConfigService {
   // ... Other code omitted
 
   exportSessions = async () => {
-    const sessions = await sessionService.getSessions();
+    const sessions = await sessionService.getAllSessions();
 +   const sessionGroups = await sessionService.getSessionGroups();
     const messages = await messageService.getAllMessages();
     const topics = await topicService.getAllTopics();

package/contributing/Basic/Feature-Development.zh-CN.md

@@ -231,7 +231,7 @@ export const createSessionGroupSlice: StateCreator<
 
 为了处理这些分组，我们需要改造 `useFetchSessions` 的实现逻辑。以下是关键的改动点：
 
-1. 使用 `sessionService.getSessionsWithGroup` 方法负责调用后端接口来获取分组后的会话数据；
+1. 使用 `sessionService.getGroupedSessions` 方法负责调用后端接口来获取分组后的会话数据；
 2. 将获取后的数据保存为三到不同的状态字段中：`pinnedSessions`、`customSessionGroups` 和 `defaultSessions`；
 
 #### `useFetchSessions` 方法
@@ -247,7 +247,7 @@ export const createSessionSlice: StateCreator<
 > = (set, get) => ({
   // ... 其他方法
   useFetchSessions: () =>
-    useSWR<ChatSessionList>(FETCH_SESSIONS_KEY, sessionService.getSessionsWithGroup, {
+    useSWR<ChatSessionList>(FETCH_SESSIONS_KEY, sessionService.getGroupedSessions, {
       onSuccess: (data) => {
         set(
           {
@@ -267,15 +267,15 @@ export const createSessionSlice: StateCreator<
 
 在成功获取数据后，我们使用 `set` 方法来更新 `customSessionGroups`、`defaultSessions`、`pinnedSessions` 和 `sessions` 状态。这将保证状态与最新的会话数据同步。
 
-#### getSessionsWithGroup
+#### getGroupedSessions
 
-使用 `sessionService.getSessionsWithGroup` 方法负责调用后端接口 `SessionModel.queryWithGroups()`
+使用 `sessionService.getGroupedSessions` 方法负责调用后端接口 `SessionModel.queryWithGroups()`
 
 ```typescript
 class SessionService {
   // ... 其他 SessionGroup 相关的实现
 
-  async getSessionsWithGroup(): Promise<ChatSessionList> {
+  async getGroupedSessions(): Promise<ChatSessionList> {
     return SessionModel.queryWithGroups();
   }
 }
@@ -283,7 +283,7 @@ class SessionService {
 
 #### `SessionModel.queryWithGroups` 方法
 
-此方法是 `sessionService.getSessionsWithGroup` 调用的核心方法，它负责查询和组织会话数据，代码如下：
+此方法是 `sessionService.getGroupedSessions` 调用的核心方法，它负责查询和组织会话数据，代码如下：
 
 ```typescript
 class _SessionModel extends BaseModel {
@@ -611,7 +611,7 @@ class ConfigService {
   // ... 省略其他
 
   exportSessions = async () => {
-    const sessions = await sessionService.getSessions();
+    const sessions = await sessionService.getAllSessions();
 +   const sessionGroups = await sessionService.getSessionGroups();
     const messages = await messageService.getAllMessages();
     const topics = await topicService.getAllTopics();

package/next.config.mjs

@@ -1,5 +1,6 @@
 import nextPWA from '@ducanh2912/next-pwa';
 import analyzer from '@next/bundle-analyzer';
+import { withSentryConfig } from '@sentry/nextjs';
 
 const isProd = process.env.NODE_ENV === 'production';
 const buildWithDocker = process.env.DOCKER === 'true';
@@ -9,18 +10,6 @@ const API_PROXY_ENDPOINT = process.env.API_PROXY_ENDPOINT || '';
 
 const basePath = process.env.NEXT_PUBLIC_BASE_PATH;
 
-const withBundleAnalyzer = analyzer({
-  enabled: process.env.ANALYZE === 'true',
-});
-
-const withPWA = nextPWA({
-  dest: 'public',
-  register: true,
-  workboxOptions: {
-    skipWaiting: true,
-  },
-});
-
 /** @type {import('next').NextConfig} */
 const nextConfig = {
   compress: isProd,
@@ -67,4 +56,63 @@ const nextConfig = {
   },
 };
 
-export default isProd ? withBundleAnalyzer(withPWA(nextConfig)) : nextConfig;
+const noWrapper = (config) => config;
+
+const withBundleAnalyzer = process.env.ANALYZE === 'true' ? analyzer() : noWrapper;
+
+const withPWA = isProd
+  ? nextPWA({
+      dest: 'public',
+      register: true,
+      workboxOptions: {
+        skipWaiting: true,
+      },
+    })
+  : noWrapper;
+
+const hasSentry = !!process.env.NEXT_PUBLIC_SENTRY_DSN;
+const withSentry =
+  isProd && hasSentry
+    ? (c) =>
+        withSentryConfig(
+          c,
+          {
+            // For all available options, see:
+            // https://github.com/getsentry/sentry-webpack-plugin#options
+
+            // Suppresses source map uploading logs during build
+            silent: true,
+            org: process.env.SENTRY_ORG,
+            project: process.env.SENTRY_PROJECT,
+          },
+          {
+            // For all available options, see:
+            // https://docs.sentry.io/platforms/javascript/guides/nextjs/manual-setup/
+
+            // Upload a larger set of source maps for prettier stack traces (increases build time)
+            widenClientFileUpload: true,
+
+            // Transpiles SDK to be compatible with IE11 (increases bundle size)
+            transpileClientSDK: true,
+
+            // Routes browser requests to Sentry through a Next.js rewrite to circumvent ad-blockers. (increases server load)
+            // Note: Check that the configured route will not match with your Next.js middleware, otherwise reporting of client-
+            // side errors will fail.
+            tunnelRoute: '/monitoring',
+
+            // Hides source maps from generated client bundles
+            hideSourceMaps: true,
+
+            // Automatically tree-shake Sentry logger statements to reduce bundle size
+            disableLogger: true,
+
+            // Enables automatic instrumentation of Vercel Cron Monitors.
+            // See the following for more information:
+            // https://docs.sentry.io/product/crons/
+            // https://vercel.com/docs/cron-jobs
+            automaticVercelMonitors: true,
+          },
+        )
+    : noWrapper;
+
+export default withBundleAnalyzer(withPWA(withSentry(nextConfig)));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lobehub/chat",
-  "version": "0.147.16",
+  "version": "0.147.17",
   "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",
@@ -94,6 +94,7 @@
     "@lobehub/tts": "latest",
     "@lobehub/ui": "^1.137.7",
     "@next/third-parties": "^14.1.4",
+    "@sentry/nextjs": "^7.105.0",
     "@vercel/analytics": "^1.2.2",
     "@vercel/speed-insights": "^1.0.10",
     "ahooks": "^3.7.11",

package/sentry.client.config.ts

@@ -0,0 +1,30 @@
+// This file configures the initialization of Sentry on the client.
+// The config you add here will be used whenever a users loads a page in their browser.
+// https://docs.sentry.io/platforms/javascript/guides/nextjs/
+import * as Sentry from '@sentry/nextjs';
+
+if (!!process.env.NEXT_PUBLIC_SENTRY_DSN) {
+  Sentry.init({
+    // Setting this option to true will print useful information to the console while you're setting up Sentry.
+    debug: false,
+
+    dsn: process.env.NEXT_PUBLIC_SENTRY_DSN,
+    // You can remove this option if you're not planning to use the Sentry Session Replay feature:
+    integrations: [
+      Sentry.replayIntegration({
+        blockAllMedia: true,
+        // Additional Replay configuration goes in here, for example:
+        maskAllText: true,
+      }),
+    ],
+
+    replaysOnErrorSampleRate: 1,
+
+    // This sets the sample rate to be 10%. You may want this to be 100% while
+    // in development and sample at a lower rate in production
+    replaysSessionSampleRate: 0.1,
+
+    // Adjust this value in production, or use tracesSampler for greater control
+    tracesSampleRate: 1,
+  });
+}

package/sentry.edge.config.ts

@@ -0,0 +1,17 @@
+// This file configures the initialization of Sentry for edge features (middleware, edge routes, and so on).
+// The config you add here will be used whenever one of the edge features is loaded.
+// Note that this config is unrelated to the Vercel Edge Runtime and is also required when running locally.
+// https://docs.sentry.io/platforms/javascript/guides/nextjs/
+import * as Sentry from '@sentry/nextjs';
+
+if (!!process.env.NEXT_PUBLIC_SENTRY_DSN) {
+  Sentry.init({
+    // Setting this option to true will print useful information to the console while you're setting up Sentry.
+    debug: false,
+
+    dsn: process.env.NEXT_PUBLIC_SENTRY_DSN,
+
+    // Adjust this value in production, or use tracesSampler for greater control
+    tracesSampleRate: 1,
+  });
+}

package/sentry.server.config.ts

@@ -0,0 +1,19 @@
+// This file configures the initialization of Sentry on the server.
+// The config you add here will be used whenever the server handles a request.
+// https://docs.sentry.io/platforms/javascript/guides/nextjs/
+import * as Sentry from '@sentry/nextjs';
+
+if (!!process.env.NEXT_PUBLIC_SENTRY_DSN) {
+  Sentry.init({
+    // Setting this option to true will print useful information to the console while you're setting up Sentry.
+    debug: false,
+
+    dsn: process.env.NEXT_PUBLIC_SENTRY_DSN,
+
+    // Adjust this value in production, or use tracesSampler for greater control
+    tracesSampleRate: 1,
+
+    // uncomment the line below to enable Spotlight (https://spotlightjs.com)
+    // spotlight: process.env.NODE_ENV === 'development',
+  });
+}

package/src/app/home/Redirect.tsx

@@ -8,8 +8,8 @@ import { sessionService } from '@/services/session';
 
 const checkHasConversation = async () => {
   const hasMessages = await messageService.hasMessages();
-  const hasAgents = await sessionService.hasSessions();
-  return hasMessages || hasAgents;
+  const hasAgents = await sessionService.countSessions();
+  return hasMessages || hasAgents === 0;
 };
 
 const Redirect = memo(() => {

package/src/database/client/models/__tests__/session.test.ts

@@ -111,12 +111,10 @@ describe('SessionModel', () => {
 
       expect(updatedSession).toHaveProperty('group', 'newGroup');
     });
-  });
 
-  describe('updatePinned', () => {
     it('should update pinned status of a session', async () => {
       const createdSession = await SessionModel.create('agent', sessionData);
-      await SessionModel.updatePinned(createdSession.id, true);
+      await SessionModel.update(createdSession.id, { pinned: 1 });
       const updatedSession = await SessionModel.findById(createdSession.id);
       expect(updatedSession).toHaveProperty('pinned', 1);
     });

package/src/database/client/models/session.ts

@@ -171,6 +171,10 @@ class _SessionModel extends BaseModel {
     return (await this.table.count()) === 0;
   }
 
+  async count() {
+    return this.table.count();
+  }
+
   // **************** Create *************** //
 
   async create(type: 'agent' | 'group', defaultValue: Partial<LobeAgentSession>, id = uuid()) {
@@ -238,10 +242,6 @@ class _SessionModel extends BaseModel {
     return super._updateWithSync(id, data);
   }
 
-  async updatePinned(id: string, pinned: boolean) {
-    return this.update(id, { pinned: pinned ? 1 : 0 });
-  }
-
   async updateConfig(id: string, data: DeepPartial<LobeAgentConfig>) {
     const session = await this.findById(id);
     if (!session) return;

package/src/services/config.ts

@@ -33,7 +33,7 @@ class ConfigService {
     return await sessionService.batchCreateSessions(sessions);
   };
   importMessages = async (messages: ChatMessage[]) => {
-    return messageService.batchCreate(messages);
+    return messageService.batchCreateMessages(messages);
   };
   importSettings = async (settings: GlobalSettings) => {
     useGlobalStore.getState().importAppSettings(settings);
@@ -105,7 +105,7 @@ class ConfigService {
    * export all agents
    */
   exportAgents = async () => {
-    const agents = await sessionService.getAllAgents();
+    const agents = await sessionService.getSessionsByType('agent');
     const sessionGroups = await sessionService.getSessionGroups();
 
     const config = createConfigFile('agents', { sessionGroups, sessions: agents });
@@ -117,7 +117,7 @@ class ConfigService {
    * export all sessions
    */
   exportSessions = async () => {
-    const sessions = await sessionService.getSessions();
+    const sessions = await sessionService.getSessionsByType();
     const sessionGroups = await sessionService.getSessionGroups();
     const messages = await messageService.getAllMessages();
     const topics = await topicService.getAllTopics();
@@ -188,7 +188,7 @@ class ConfigService {
    * export all data
    */
   exportAll = async () => {
-    const sessions = await sessionService.getSessions();
+    const sessions = await sessionService.getSessionsByType();
     const sessionGroups = await sessionService.getSessionGroups();
     const messages = await messageService.getAllMessages();
     const topics = await topicService.getAllTopics();

package/src/services/file/client.test.ts

@@ -3,9 +3,9 @@ import { Mock, beforeEach, describe, expect, it, vi } from 'vitest';
 import { FileModel } from '@/database/client/models/file';
 import { DB_File } from '@/database/client/schemas/files';
 
-import { FileService } from './client';
+import { ClientService } from './client';
 
-const fileService = new FileService();
+const fileService = new ClientService();
 
 // Mocks for the FileModel
 vi.mock('@/database/client/models/file', () => ({

package/src/services/file/client.ts

@@ -4,12 +4,9 @@ import { FilePreview } from '@/types/files';
 import compressImage from '@/utils/compressImage';
 
 import { API_ENDPOINTS } from '../_url';
+import { IFileService } from './type';
 
-export class FileService {
-  private isImage(fileType: string) {
-    const imageRegex = /^image\//;
-    return imageRegex.test(fileType);
-  }
+export class ClientService implements IFileService {
   async uploadFile(file: DB_File) {
     // 跳过图片上传测试
     const isTestData = file.size === 1;
@@ -22,26 +19,6 @@ export class FileService {
     return FileModel.create(file);
   }
 
-  async uploadImageFile(file: DB_File) {
-    // 加载图片
-    const url = file.url || URL.createObjectURL(new Blob([file.data]));
-
-    const img = new Image();
-    img.src = url;
-    await (() =>
-      new Promise((resolve) => {
-        img.addEventListener('load', resolve);
-      }))();
-
-    // 压缩图片
-    const base64String = compressImage({ img, type: file.fileType });
-    const binaryString = atob(base64String.split('base64,')[1]);
-    const uint8Array = Uint8Array.from(binaryString, (char) => char.charCodeAt(0));
-    file.data = uint8Array.buffer;
-
-    return FileModel.create(file);
-  }
-
   async uploadImageByUrl(url: string, file: Pick<DB_File, 'name' | 'metadata'>) {
     const res = await fetch(API_ENDPOINTS.proxy, { body: url, method: 'POST' });
     const data = await res.arrayBuffer();
@@ -57,14 +34,6 @@ export class FileService {
     });
   }
 
-  async removeFile(id: string) {
-    return FileModel.delete(id);
-  }
-
-  async removeAllFiles() {
-    return FileModel.clear();
-  }
-
   async getFile(id: string): Promise<FilePreview> {
     const item = await FileModel.findById(id);
     if (!item) {
@@ -83,4 +52,37 @@ export class FileService {
       url,
     };
   }
+
+  async removeFile(id: string) {
+    return FileModel.delete(id);
+  }
+
+  async removeAllFiles() {
+    return FileModel.clear();
+  }
+
+  private isImage(fileType: string) {
+    const imageRegex = /^image\//;
+    return imageRegex.test(fileType);
+  }
+
+  private async uploadImageFile(file: DB_File) {
+    // 加载图片
+    const url = file.url || URL.createObjectURL(new Blob([file.data]));
+
+    const img = new Image();
+    img.src = url;
+    await (() =>
+      new Promise((resolve) => {
+        img.addEventListener('load', resolve);
+      }))();
+
+    // 压缩图片
+    const base64String = compressImage({ img, type: file.fileType });
+    const binaryString = atob(base64String.split('base64,')[1]);
+    const uint8Array = Uint8Array.from(binaryString, (char) => char.charCodeAt(0));
+    file.data = uint8Array.buffer;
+
+    return FileModel.create(file);
+  }
 }

package/src/services/file/index.ts

@@ -1,3 +1,9 @@
-import { FileService } from './client';
+// import { getClientConfig } from '@/config/client';
+import { ClientService } from './client';
 
-export const fileService = new FileService();
+// import { ServerService } from './server';
+//
+// const { ENABLED_SERVER_SERVICE } = getClientConfig();
+//
+// export const fileService = ENABLED_SERVER_SERVICE ? new ServerService() : new ClientService();
+export const fileService = new ClientService();

package/src/services/file/type.ts

@@ -0,0 +1,11 @@
+/* eslint-disable typescript-sort-keys/interface */
+import { DB_File } from '@/database/client/schemas/files';
+import { FilePreview } from '@/types/files';
+
+export interface IFileService {
+  uploadFile(file: DB_File): Promise<any>;
+  uploadImageByUrl(url: string, file: Pick<DB_File, 'name' | 'metadata'>): Promise<any>;
+  removeFile(id: string): Promise<any>;
+  removeAllFiles(): Promise<any>;
+  getFile(id: string): Promise<FilePreview>;
+}

package/src/services/message/client.test.ts

@@ -3,9 +3,9 @@ import { Mock, describe, expect, it, vi } from 'vitest';
 import { CreateMessageParams, MessageModel } from '@/database/client/models/message';
 import { ChatMessage, ChatMessageError, ChatPluginPayload } from '@/types/message';
 
-import { MessageService } from './client';
+import { ClientService } from './client';
 
-const messageService = new MessageService();
+const messageService = new ClientService();
 
 // Mock the MessageModel
 vi.mock('@/database/client/models/message', () => {
@@ -27,7 +27,7 @@ vi.mock('@/database/client/models/message', () => {
   };
 });
 
-describe('MessageService', () => {
+describe('MessageClientService', () => {
   // Mock data
   const mockMessageId = 'mock-message-id';
   const mockMessage = {
@@ -57,7 +57,7 @@ describe('MessageService', () => {
       (MessageModel.create as Mock).mockResolvedValue({ id: mockMessageId });
 
       // Execute
-      const messageId = await messageService.create(createParams);
+      const messageId = await messageService.createMessage(createParams);
 
       // Assert
       expect(MessageModel.create).toHaveBeenCalledWith(createParams);
@@ -71,7 +71,7 @@ describe('MessageService', () => {
       (MessageModel.batchCreate as Mock).mockResolvedValue(mockMessages);
 
       // Execute
-      const result = await messageService.batchCreate(mockMessages);
+      const result = await messageService.batchCreateMessages(mockMessages);
 
       // Assert
       expect(MessageModel.batchCreate).toHaveBeenCalledWith(mockMessages);
@@ -79,32 +79,6 @@ describe('MessageService', () => {
     });
   });
 
-  describe('hasMessages', () => {
-    it('should return true if there are messages', async () => {
-      // Setup
-      (MessageModel.count as Mock).mockResolvedValue(1);
-
-      // Execute
-      const hasMessages = await messageService.hasMessages();
-
-      // Assert
-      expect(MessageModel.count).toHaveBeenCalled();
-      expect(hasMessages).toBe(true);
-    });
-
-    it('should return false if there are no messages', async () => {
-      // Setup
-      (MessageModel.count as Mock).mockResolvedValue(0);
-
-      // Execute
-      const hasMessages = await messageService.hasMessages();
-
-      // Assert
-      expect(MessageModel.count).toHaveBeenCalled();
-      expect(hasMessages).toBe(false);
-    });
-  });
-
   describe('removeMessage', () => {
     it('should remove a message by id', async () => {
       // Setup
@@ -172,7 +146,7 @@ describe('MessageService', () => {
       (MessageModel.clearTable as Mock).mockResolvedValue(true);
 
       // Execute
-      const result = await messageService.clearAllMessage();
+      const result = await messageService.removeAllMessages();
 
       // Assert
       expect(MessageModel.clearTable).toHaveBeenCalled();