@lobehub/chat 1.77.15 → 1.77.16

package/CHANGELOG.md

@@ -2,6 +2,31 @@
 
 # Changelog
 
+### [Version 1.77.16](https://github.com/lobehub/lobe-chat/compare/v1.77.15...v1.77.16)
+
+<sup>Released on **2025-04-06**</sup>
+
+#### ♻ Code Refactoring
+
+- **misc**: Refactor the file service.
+
+<br/>
+
+<details>
+<summary><kbd>Improvements and Fixes</kbd></summary>
+
+#### Code refactoring
+
+- **misc**: Refactor the file service, closes [#7323](https://github.com/lobehub/lobe-chat/issues/7323) ([3721b88](https://github.com/lobehub/lobe-chat/commit/3721b88))
+
+</details>
+
+<div align="right">
+
+[![](https://img.shields.io/badge/-BACK_TO_TOP-151515?style=flat-square)](#readme-top)
+
+</div>
+
 ### [Version 1.77.15](https://github.com/lobehub/lobe-chat/compare/v1.77.14...v1.77.15)
 
 <sup>Released on **2025-04-06**</sup>

package/changelog/v1.json

@@ -1,4 +1,13 @@
 [
+  {
+    "children": {
+      "improvements": [
+        "Refactor the file service."
+      ]
+    },
+    "date": "2025-04-06",
+    "version": "1.77.16"
+  },
   {
     "children": {
       "improvements": [

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lobehub/chat",
-  "version": "1.77.15",
+  "version": "1.77.16",
   "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",

package/src/server/routers/async/file.ts

@@ -14,8 +14,8 @@ import { NewChunkItem, NewEmbeddingsItem } from '@/database/schemas';
 import { asyncAuthedProcedure, asyncRouter as router } from '@/libs/trpc/async';
 import { getServerDefaultFilesConfig } from '@/server/globalConfig';
 import { initAgentRuntimeWithUserPayload } from '@/server/modules/AgentRuntime';
-import { S3 } from '@/server/modules/S3';
 import { ChunkService } from '@/server/services/chunk';
+import { FileService } from '@/server/services/file';
 import {
   AsyncTaskError,
   AsyncTaskErrorType,
@@ -35,6 +35,7 @@ const fileProcedure = asyncAuthedProcedure.use(async (opts) => {
       chunkService: new ChunkService(ctx.userId),
       embeddingModel: new EmbeddingModel(ctx.serverDB, ctx.userId),
       fileModel: new FileModel(ctx.serverDB, ctx.userId),
+      fileService: new FileService(),
     },
   });
 });
@@ -162,11 +163,9 @@ export const fileRouter = router({
         throw new TRPCError({ code: 'BAD_REQUEST', message: 'File not found' });
       }
 
-      const s3 = new S3();
-
       let content: Uint8Array | undefined;
       try {
-        content = await s3.getFileByteArray(file.url);
+        content = await ctx.fileService.getFileByteArray(file.url);
       } catch (e) {
         console.error(e);
         // if file not found, delete it from db

package/src/server/routers/lambda/file.ts

@@ -7,8 +7,7 @@ import { ChunkModel } from '@/database/models/chunk';
 import { FileModel } from '@/database/models/file';
 import { authedProcedure, router } from '@/libs/trpc';
 import { serverDatabase } from '@/libs/trpc/lambda';
-import { S3 } from '@/server/modules/S3';
-import { getFullFileUrl } from '@/server/utils/files';
+import { FileService } from '@/server/services/file';
 import { AsyncTaskStatus, AsyncTaskType } from '@/types/asyncTask';
 import { FileListItem, QueryFileListSchema, UploadFileSchema } from '@/types/files';
 
@@ -20,6 +19,7 @@ const fileProcedure = authedProcedure.use(serverDatabase).use(async (opts) => {
       asyncTaskModel: new AsyncTaskModel(ctx.serverDB, ctx.userId),
       chunkModel: new ChunkModel(ctx.serverDB, ctx.userId),
       fileModel: new FileModel(ctx.serverDB, ctx.userId),
+      fileService: new FileService(),
     },
   });
 });
@@ -50,7 +50,7 @@ export const fileRouter = router({
         !isExist,
       );
 
-      return { id, url: await getFullFileUrl(input.url) };
+      return { id, url: await ctx.fileService.getFullFileUrl(input.url) };
     }),
   findById: fileProcedure
     .input(
@@ -62,7 +62,7 @@ export const fileRouter = router({
       const item = await ctx.fileModel.findById(input.id);
       if (!item) throw new TRPCError({ code: 'BAD_REQUEST', message: 'File not found' });
 
-      return { ...item, url: await getFullFileUrl(item?.url) };
+      return { ...item, url: await ctx.fileService.getFullFileUrl(item?.url) };
     }),
 
   getFileItemById: fileProcedure
@@ -95,7 +95,7 @@ export const fileRouter = router({
         embeddingError: embeddingTask?.error,
         embeddingStatus: embeddingTask?.status as AsyncTaskStatus,
         finishEmbedding: embeddingTask?.status === AsyncTaskStatus.Success,
-        url: await getFullFileUrl(item.url!),
+        url: await ctx.fileService.getFullFileUrl(item.url!),
       };
     }),
 
@@ -132,7 +132,7 @@ export const fileRouter = router({
         embeddingError: embeddingTask?.error ?? null,
         embeddingStatus: embeddingTask?.status as AsyncTaskStatus,
         finishEmbedding: embeddingTask?.status === AsyncTaskStatus.Success,
-        url: await getFullFileUrl(item.url!),
+        url: await ctx.fileService.getFullFileUrl(item.url!),
       } as FileListItem;
       resultFiles.push(fileItem);
     }
@@ -150,8 +150,7 @@ export const fileRouter = router({
     if (!file) return;
 
     // delele the file from remove from S3 if it is not used by other files
-    const s3Client = new S3();
-    await s3Client.deleteFile(file.url!);
+    await ctx.fileService.deleteFile(file.url!);
   }),
 
   removeFileAsyncTask: fileProcedure
@@ -184,9 +183,7 @@ export const fileRouter = router({
       if (!needToRemoveFileList || needToRemoveFileList.length === 0) return;
 
       // remove from S3
-      const s3Client = new S3();
-
-      await s3Client.deleteFiles(needToRemoveFileList.map((file) => file.url!));
+      await ctx.fileService.deleteFiles(needToRemoveFileList.map((file) => file.url!));
     }),
 });
 

package/src/server/routers/lambda/importer.ts

@@ -4,7 +4,7 @@ import { z } from 'zod';
 import { DataImporterRepos } from '@/database/repositories/dataImporter';
 import { authedProcedure, router } from '@/libs/trpc';
 import { serverDatabase } from '@/libs/trpc/lambda';
-import { S3 } from '@/server/modules/S3';
+import { FileService } from '@/server/services/file';
 import { ImportPgDataStructure } from '@/types/export';
 import { ImportResultData, ImporterEntryData } from '@/types/importer';
 
@@ -13,7 +13,7 @@ const importProcedure = authedProcedure.use(serverDatabase).use(async (opts) =>
   const dataImporterService = new DataImporterRepos(ctx.serverDB, ctx.userId);
 
   return opts.next({
-    ctx: { dataImporterService },
+    ctx: { dataImporterService, fileService: new FileService() },
   });
 });
 
@@ -24,8 +24,7 @@ export const importerRouter = router({
       let data: ImporterEntryData | undefined;
 
       try {
-        const s3 = new S3();
-        const dataStr = await s3.getFileContent(input.pathname);
+        const dataStr = await ctx.fileService.getFileContent(input.pathname);
         data = JSON.parse(dataStr);
       } catch {
         data = undefined;

package/src/server/routers/lambda/message.ts

@@ -5,7 +5,7 @@ import { updateMessagePluginSchema } from '@/database/schemas';
 import { getServerDB } from '@/database/server';
 import { authedProcedure, publicProcedure, router } from '@/libs/trpc';
 import { serverDatabase } from '@/libs/trpc/lambda';
-import { getFullFileUrl } from '@/server/utils/files';
+import { FileService } from '@/server/services/file';
 import { ChatMessage } from '@/types/message';
 import { BatchTaskResult } from '@/types/service';
 
@@ -15,7 +15,10 @@ const messageProcedure = authedProcedure.use(serverDatabase).use(async (opts) =>
   const { ctx } = opts;
 
   return opts.next({
-    ctx: { messageModel: new MessageModel(ctx.serverDB, ctx.userId) },
+    ctx: {
+      fileService: new FileService(),
+      messageModel: new MessageModel(ctx.serverDB, ctx.userId),
+    },
   });
 });
 
@@ -99,8 +102,11 @@ export const messageRouter = router({
       const serverDB = await getServerDB();
 
       const messageModel = new MessageModel(serverDB, ctx.userId);
+      const fileService = new FileService();
 
-      return messageModel.query(input, { postProcessUrl: (path) => getFullFileUrl(path) });
+      return messageModel.query(input, {
+        postProcessUrl: (path) => fileService.getFullFileUrl(path),
+      });
     }),
 
   rankModels: messageProcedure.query(async ({ ctx }) => {

package/src/server/routers/lambda/ragEval.ts

@@ -16,9 +16,8 @@ import {
 import { authedProcedure, router } from '@/libs/trpc';
 import { serverDatabase } from '@/libs/trpc/lambda';
 import { keyVaults } from '@/libs/trpc/middleware/keyVaults';
-import { S3 } from '@/server/modules/S3';
 import { createAsyncServerClient } from '@/server/routers/async';
-import { getFullFileUrl } from '@/server/utils/files';
+import { FileService } from '@/server/services/file';
 import {
   EvalDatasetRecord,
   EvalEvaluationStatus,
@@ -42,7 +41,7 @@ const ragEvalProcedure = authedProcedure
         datasetRecordModel: new EvalDatasetRecordModel(ctx.userId),
         evaluationModel: new EvalEvaluationModel(ctx.userId),
         evaluationRecordModel: new EvaluationRecordModel(ctx.userId),
-        s3: new S3(),
+        fileService: new FileService(),
       },
     });
   });
@@ -144,7 +143,7 @@ export const ragEvalRouter = router({
       }),
     )
     .mutation(async ({ input, ctx }) => {
-      const dataStr = await ctx.s3.getFileContent(input.pathname);
+      const dataStr = await ctx.fileService.getFileContent(input.pathname);
       const items = JSONL.parse<InsertEvalDatasetRecord>(dataStr);
 
       insertEvalDatasetRecordSchema.array().parse(items);
@@ -262,12 +261,12 @@ export const ragEvalRouter = router({
         const filename = `${date}-eval_${evaluation.id}-${evaluation.name}.jsonl`;
         const path = `rag_eval_records/${filename}`;
 
-        await ctx.s3.uploadContent(path, JSONL.stringify(evalRecords));
+        await ctx.fileService.uploadContent(path, JSONL.stringify(evalRecords));
 
         // 保存数据
         await ctx.evaluationModel.update(input.id, {
           status: EvalEvaluationStatus.Success,
-          evalRecordsUrl: await getFullFileUrl(path),
+          evalRecordsUrl: await ctx.fileService.getFullFileUrl(path),
         });
       }
 

package/src/server/services/file/impls/index.ts

@@ -0,0 +1,12 @@
+import { S3StaticFileImpl } from './s3';
+import { FileServiceImpl } from './type';
+
+/**
+ * 创建文件服务模块
+ */
+export const createFileServiceModule = (): FileServiceImpl => {
+  // 默认使用 S3 实现
+  return new S3StaticFileImpl();
+};
+
+export type { FileServiceImpl } from './type';

package/src/server/services/file/impls/s3.test.ts

@@ -0,0 +1,110 @@
+import { beforeEach, describe, expect, it, vi } from 'vitest';
+
+import { S3StaticFileImpl } from './s3';
+
+const config = {
+  S3_ENABLE_PATH_STYLE: false,
+  S3_PUBLIC_DOMAIN: 'https://example.com',
+  S3_BUCKET: 'my-bucket',
+  S3_SET_ACL: true,
+};
+
+// 模拟 fileEnv
+vi.mock('@/config/file', () => ({
+  get fileEnv() {
+    return config;
+  },
+}));
+
+// 模拟 S3 类
+vi.mock('@/server/modules/S3', () => ({
+  S3: vi.fn().mockImplementation(() => ({
+    createPreSignedUrlForPreview: vi
+      .fn()
+      .mockResolvedValue('https://presigned.example.com/test.jpg'),
+    getFileContent: vi.fn().mockResolvedValue('file content'),
+    getFileByteArray: vi.fn().mockResolvedValue(new Uint8Array([1, 2, 3])),
+    deleteFile: vi.fn().mockResolvedValue({}),
+    deleteFiles: vi.fn().mockResolvedValue({}),
+    createPreSignedUrl: vi.fn().mockResolvedValue('https://upload.example.com/test.jpg'),
+    uploadContent: vi.fn().mockResolvedValue({}),
+  })),
+}));
+
+describe('S3StaticFileImpl', () => {
+  let fileService: S3StaticFileImpl;
+
+  beforeEach(() => {
+    fileService = new S3StaticFileImpl();
+  });
+
+  describe('getFullFileUrl', () => {
+    it('should return empty string for null or undefined input', async () => {
+      expect(await fileService.getFullFileUrl(null)).toBe('');
+      expect(await fileService.getFullFileUrl(undefined)).toBe('');
+    });
+
+    it('当S3_SET_ACL为false时应返回预签名URL', async () => {
+      config.S3_SET_ACL = false;
+      const url = 'path/to/file.jpg';
+      expect(await fileService.getFullFileUrl(url)).toBe('https://presigned.example.com/test.jpg');
+      config.S3_SET_ACL = true;
+    });
+
+    it('should return correct URL when S3_ENABLE_PATH_STYLE is false', async () => {
+      const url = 'path/to/file.jpg';
+      expect(await fileService.getFullFileUrl(url)).toBe('https://example.com/path/to/file.jpg');
+    });
+
+    it('should return correct URL when S3_ENABLE_PATH_STYLE is true', async () => {
+      config.S3_ENABLE_PATH_STYLE = true;
+      const url = 'path/to/file.jpg';
+      expect(await fileService.getFullFileUrl(url)).toBe(
+        'https://example.com/my-bucket/path/to/file.jpg',
+      );
+      config.S3_ENABLE_PATH_STYLE = false;
+    });
+  });
+
+  describe('getFileContent', () => {
+    it('应该返回文件内容', async () => {
+      expect(await fileService.getFileContent('test.txt')).toBe('file content');
+    });
+  });
+
+  describe('getFileByteArray', () => {
+    it('应该返回文件字节数组', async () => {
+      const result = await fileService.getFileByteArray('test.jpg');
+      expect(result).toBeInstanceOf(Uint8Array);
+      expect(result.length).toBe(3);
+    });
+  });
+
+  describe('deleteFile', () => {
+    it('应该调用S3的deleteFile方法', async () => {
+      await fileService.deleteFile('test.jpg');
+      expect(fileService['s3'].deleteFile).toHaveBeenCalledWith('test.jpg');
+    });
+  });
+
+  describe('deleteFiles', () => {
+    it('应该调用S3的deleteFiles方法', async () => {
+      await fileService.deleteFiles(['test1.jpg', 'test2.jpg']);
+      expect(fileService['s3'].deleteFiles).toHaveBeenCalledWith(['test1.jpg', 'test2.jpg']);
+    });
+  });
+
+  describe('createPreSignedUrl', () => {
+    it('应该调用S3的createPreSignedUrl方法', async () => {
+      const result = await fileService.createPreSignedUrl('test.jpg');
+      expect(result).toBe('https://upload.example.com/test.jpg');
+    });
+  });
+
+  describe('uploadContent', () => {
+    it('应该调用S3的uploadContent方法', async () => {
+      await fileService.uploadContent('test.jpg', 'content');
+      expect(fileService['s3'].uploadContent).toHaveBeenCalledWith('test.jpg', 'content');
+    });
+  });
+});

package/src/server/services/file/impls/s3.ts

@@ -0,0 +1,60 @@
+import urlJoin from 'url-join';
+
+import { fileEnv } from '@/config/file';
+import { S3 } from '@/server/modules/S3';
+
+import { FileServiceImpl } from './type';
+
+/**
+ * 基于S3的文件服务实现
+ */
+export class S3StaticFileImpl implements FileServiceImpl {
+  private readonly s3: S3;
+
+  constructor() {
+    this.s3 = new S3();
+  }
+
+  async deleteFile(key: string) {
+    return this.s3.deleteFile(key);
+  }
+
+  async deleteFiles(keys: string[]) {
+    return this.s3.deleteFiles(keys);
+  }
+
+  async getFileContent(key: string): Promise<string> {
+    return this.s3.getFileContent(key);
+  }
+
+  async getFileByteArray(key: string): Promise<Uint8Array> {
+    return this.s3.getFileByteArray(key);
+  }
+
+  async createPreSignedUrl(key: string): Promise<string> {
+    return this.s3.createPreSignedUrl(key);
+  }
+
+  async createPreSignedUrlForPreview(key: string, expiresIn?: number): Promise<string> {
+    return this.s3.createPreSignedUrlForPreview(key, expiresIn);
+  }
+
+  async uploadContent(path: string, content: string) {
+    return this.s3.uploadContent(path, content);
+  }
+
+  async getFullFileUrl(url?: string | null, expiresIn?: number): Promise<string> {
+    if (!url) return '';
+
+    // If bucket is not set public read, the preview address needs to be regenerated each time
+    if (!fileEnv.S3_SET_ACL) {
+      return await this.createPreSignedUrlForPreview(url, expiresIn);
+    }
+
+    if (fileEnv.S3_ENABLE_PATH_STYLE) {
+      return urlJoin(fileEnv.S3_PUBLIC_DOMAIN!, fileEnv.S3_BUCKET!, url);
+    }
+
+    return urlJoin(fileEnv.S3_PUBLIC_DOMAIN!, url);
+  }
+}

package/src/server/services/file/impls/type.ts

@@ -0,0 +1,44 @@
+/**
+ * S3文件服务实现
+ */
+export interface FileServiceImpl {
+  /**
+   * 创建预签名上传URL
+   */
+  createPreSignedUrl(key: string): Promise<string>;
+
+  /**
+   * 创建预签名预览URL
+   */
+  createPreSignedUrlForPreview(key: string, expiresIn?: number): Promise<string>;
+
+  /**
+   * 删除文件
+   */
+  deleteFile(key: string): Promise<any>;
+
+  /**
+   * 批量删除文件
+   */
+  deleteFiles(keys: string[]): Promise<any>;
+
+  /**
+   * 获取文件字节数组
+   */
+  getFileByteArray(key: string): Promise<Uint8Array>;
+
+  /**
+   * 获取文件内容
+   */
+  getFileContent(key: string): Promise<string>;
+
+  /**
+   * 获取完整文件URL
+   */
+  getFullFileUrl(url?: string | null, expiresIn?: number): Promise<string>;
+
+  /**
+   * 上传内容
+   */
+  uploadContent(path: string, content: string): Promise<any>;
+}

package/src/server/services/file/index.ts

@@ -0,0 +1,65 @@
+import { FileServiceImpl, createFileServiceModule } from './impls';
+
+/**
+ * 文件服务类
+ * 使用模块化实现方式，提供文件操作服务
+ */
+export class FileService {
+  private impl: FileServiceImpl = createFileServiceModule();
+
+  /**
+   * 删除文件
+   */
+  public async deleteFile(key: string) {
+    return this.impl.deleteFile(key);
+  }
+
+  /**
+   * 批量删除文件
+   */
+  public async deleteFiles(keys: string[]) {
+    return this.impl.deleteFiles(keys);
+  }
+
+  /**
+   * 获取文件内容
+   */
+  public async getFileContent(key: string): Promise<string> {
+    return this.impl.getFileContent(key);
+  }
+
+  /**
+   * 获取文件字节数组
+   */
+  public async getFileByteArray(key: string): Promise<Uint8Array> {
+    return this.impl.getFileByteArray(key);
+  }
+
+  /**
+   * 创建预签名上传URL
+   */
+  public async createPreSignedUrl(key: string): Promise<string> {
+    return this.impl.createPreSignedUrl(key);
+  }
+
+  /**
+   * 创建预签名预览URL
+   */
+  public async createPreSignedUrlForPreview(key: string, expiresIn?: number): Promise<string> {
+    return this.impl.createPreSignedUrlForPreview(key, expiresIn);
+  }
+
+  /**
+   * 上传内容
+   */
+  public async uploadContent(path: string, content: string) {
+    return this.impl.uploadContent(path, content);
+  }
+
+  /**
+   * 获取完整文件URL
+   */
+  public async getFullFileUrl(url?: string | null, expiresIn?: number): Promise<string> {
+    return this.impl.getFullFileUrl(url, expiresIn);
+  }
+}

package/src/services/electron/__tests__/devtools.test.ts

@@ -0,0 +1,34 @@
+import { dispatch } from '@lobechat/electron-client-ipc';
+import { describe, expect, it, vi } from 'vitest';
+
+import { electronDevtoolsService } from '../devtools';
+
+vi.mock('@lobechat/electron-client-ipc', () => ({
+  dispatch: vi.fn(),
+}));
+
+describe('DevtoolsService', () => {
+  beforeEach(() => {
+    vi.clearAllMocks();
+  });
+
+  describe('openDevtools', () => {
+    it('should call dispatch with openDevtools', async () => {
+      await electronDevtoolsService.openDevtools();
+      expect(dispatch).toHaveBeenCalledWith('openDevtools');
+    });
+
+    it('should return void when dispatch succeeds', async () => {
+      vi.mocked(dispatch).mockResolvedValueOnce();
+      const result = await electronDevtoolsService.openDevtools();
+      expect(result).toBeUndefined();
+    });
+
+    it('should throw error when dispatch fails', async () => {
+      const error = new Error('Failed to open devtools');
+      vi.mocked(dispatch).mockRejectedValueOnce(error);
+
+      await expect(electronDevtoolsService.openDevtools()).rejects.toThrow(error);
+    });
+  });
+});

package/src/server/utils/files.test.ts

@@ -1,37 +0,0 @@
-import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
-
-import { fileEnv } from '@/config/file';
-
-import { getFullFileUrl } from './files';
-
-const config = {
-  S3_ENABLE_PATH_STYLE: false,
-  S3_PUBLIC_DOMAIN: 'https://example.com',
-  S3_BUCKET: 'my-bucket',
-  S3_SET_ACL: true,
-};
-
-vi.mock('@/config/file', () => ({
-  get fileEnv() {
-    return config;
-  },
-}));
-
-describe('getFullFileUrl', () => {
-  it('should return empty string for null or undefined input', async () => {
-    expect(await getFullFileUrl(null)).toBe('');
-    expect(await getFullFileUrl(undefined)).toBe('');
-  });
-
-  it('should return correct URL when S3_ENABLE_PATH_STYLE is false', async () => {
-    const url = 'path/to/file.jpg';
-    expect(await getFullFileUrl(url)).toBe('https://example.com/path/to/file.jpg');
-  });
-
-  it('should return correct URL when S3_ENABLE_PATH_STYLE is true', async () => {
-    config.S3_ENABLE_PATH_STYLE = true;
-    const url = 'path/to/file.jpg';
-    expect(await getFullFileUrl(url)).toBe('https://example.com/my-bucket/path/to/file.jpg');
-    config.S3_ENABLE_PATH_STYLE = false;
-  });
-});

package/src/server/utils/files.ts

@@ -1,20 +0,0 @@
-import urlJoin from 'url-join';
-
-import { fileEnv } from '@/config/file';
-import { S3 } from '@/server/modules/S3';
-
-export const getFullFileUrl = async (url?: string | null, expiresIn?: number) => {
-  if (!url) return '';
-
-  // If bucket is not set public read, the preview address needs to be regenerated each time
-  if (!fileEnv.S3_SET_ACL) {
-    const s3 = new S3();
-    return await s3.createPreSignedUrlForPreview(url, expiresIn);
-  }
-
-  if (fileEnv.S3_ENABLE_PATH_STYLE) {
-    return urlJoin(fileEnv.S3_PUBLIC_DOMAIN!, fileEnv.S3_BUCKET!, url);
-  }
-
-  return urlJoin(fileEnv.S3_PUBLIC_DOMAIN!, url);
-};