chore: Jest Testing structure (#2707)

* deps: add jest deps

* chore: mock

* feat: use mocinggoose

* feat: jest

* chore: remove babel.config.js

projects/app/jest.config.js

@@ -0,0 +1,184 @@
+/**
+ * For a detailed explanation regarding each configuration property, visit:
+ * https://jestjs.io/docs/configuration
+ */
+const esModules = ['nanoid'].join('|');
+
+/** @type {import('jest').Config} */
+const config = {
+  // All imported modules in your tests should be mocked automatically
+  // automock: false,
+
+  // Stop running tests after `n` failures
+  // bail: 0,
+
+  // The directory where Jest should store its cached dependency information
+  // cacheDirectory: "/tmp/jest_rs",
+
+  // Automatically clear mock calls, instances, contexts and results before every test
+  // clearMocks: false,
+
+  // Indicates whether the coverage information should be collected while executing the test
+  collectCoverage: true,
+
+  // An array of glob patterns indicating a set of files for which coverage information should be collected
+  // collectCoverageFrom: undefined,
+
+  // The directory where Jest should output its coverage files
+  coverageDirectory: './tmp/coverage',
+
+  // An array of regexp pattern strings used to skip coverage collection
+  coveragePathIgnorePatterns: ['/node_modules/', '/__mocks__/', '/src/test/'],
+
+  // Indicates which provider should be used to instrument code for coverage
+  // coverageProvider: "babel",
+
+  // A list of reporter names that Jest uses when writing coverage reports
+  // coverageReporters: [
+  //   "json",
+  //   "text",
+  //   "lcov",
+  //   "clover"
+  // ],
+
+  // An object that configures minimum threshold enforcement for coverage results
+  // coverageThreshold: undefined,
+
+  // A path to a custom dependency extractor
+  // dependencyExtractor: undefined,
+
+  // Make calling deprecated APIs throw helpful error messages
+  // errorOnDeprecated: false,
+
+  // The default configuration for fake timers
+  // fakeTimers: {
+  //   "enableGlobally": false
+  // },
+
+  // Force coverage collection from ignored files using an array of glob patterns
+  // forceCoverageMatch: [],
+
+  // A path to a module which exports an async function that is triggered once before all test suites
+  // globalSetup: undefined,
+
+  // A path to a module which exports an async function that is triggered once after all test suites
+  // globalTeardown: undefined,
+
+  // A set of global variables that need to be available in all test environments
+  // globals: {},
+
+  // The maximum amount of workers used to run your tests. Can be specified as % or a number. E.g. maxWorkers: 10% will use 10% of your CPU amount + 1 as the maximum worker number. maxWorkers: 2 will use a maximum of 2 workers.
+  // maxWorkers: "50%",
+
+  // An array of directory names to be searched recursively up from the requiring module's location
+  moduleDirectories: ['node_modules', 'src'],
+
+  // An array of file extensions your modules use
+  // moduleFileExtensions: ['js', 'mjs', 'cjs', 'jsx', 'ts', 'tsx', 'json', 'node'],
+
+  // A map from regular expressions to module names or to arrays of module names that allow to stub out resources with a single module
+  moduleNameMapper: {
+    '@/(.*)': '<rootDir>/src/$1',
+    '^nanoid(/(.*)|$)': 'nanoid$1'
+  },
+
+  // An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader
+  // modulePathIgnorePatterns: [],
+
+  // Activates notifications for test results
+  // notify: false,
+
+  // An enum that specifies notification mode. Requires { notify: true }
+  // notifyMode: "failure-change",
+
+  // A preset that is used as a base for Jest's configuration
+  preset: 'ts-jest',
+
+  // Run tests from one or more projects
+  // projects: undefined,
+
+  // Use this configuration option to add custom reporters to Jest
+  // reporters: undefined,
+
+  // Automatically reset mock state before every test
+  // resetMocks: false,
+
+  // Reset the module registry before running each individual test
+  // resetModules: false,
+
+  // A path to a custom resolver
+  // resolver: undefined,
+
+  // Automatically restore mock state and implementation before every test
+  // restoreMocks: false,
+
+  // The root directory that Jest should scan for tests and modules within
+  // rootDir: undefined,
+
+  // A list of paths to directories that Jest should use to search for files in
+  // roots: [
+  //   "<rootDir>"
+  // ],
+
+  // Allows you to use a custom runner instead of Jest's default test runner
+  // runner: "jest-runner",
+
+  // The paths to modules that run some code to configure or set up the testing environment before each test
+  // setupFiles: [],
+
+  // A list of paths to modules that run some code to configure or set up the testing framework before each test
+  // setupFilesAfterEnv: [],
+
+  // The number of seconds after which a test is considered as slow and reported as such in the results.
+  // slowTestThreshold: 5,
+
+  // A list of paths to snapshot serializer modules Jest should use for snapshot testing
+  // snapshotSerializers: [],
+
+  // The test environment that will be used for testing
+  testEnvironment: 'node',
+
+  // Options that will be passed to the testEnvironment
+  // testEnvironmentOptions: {},
+
+  // Adds a location field to test results
+  // testLocationInResults: false,
+
+  // The glob patterns Jest uses to detect test files
+  // testMatch: [
+  //   "**/__tests__/**/*.[jt]s?(x)",
+  //   "**/?(*.)+(spec|test).[tj]s?(x)"
+  // ],
+
+  // An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
+  // testPathIgnorePatterns: ['/node_modules/'],
+
+  // The regexp pattern or array of patterns that Jest uses to detect test files
+  // testRegex: [],
+
+  // This option allows the use of a custom results processor
+  // testResultsProcessor: undefined,
+
+  // This option allows use of a custom test runner
+  // testRunner: "jest-circus/runner",
+
+  // A map from regular expressions to paths to transformers
+  // transform: undefined,
+
+  // An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation
+  transformIgnorePatterns: [`/node_modules/(?!${esModules})`]
+
+  // An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them
+  // unmockedModulePathPatterns: undefined,
+
+  // Indicates whether each individual test should be reported during the run
+  // verbose: undefined,
+
+  // An array of regexp patterns that are matched against all source file paths before re-running tests in watch mode
+  // watchPathIgnorePatterns: [],
+
+  // Whether to use watchman for file crawling
+  // watchman: true,
+};
+
+module.exports = config;

projects/app/package.json

@@ -6,7 +6,8 @@
     "dev": "next dev",
     "build": "next build",
     "start": "next start",
-    "lint": "next lint"
+    "lint": "next lint",
+    "test": "jest"
   },
   "dependencies": {
     "@bany/curl-to-json": "^1.2.8",
@@ -25,6 +26,7 @@
     "@fortaine/fetch-event-source": "^3.0.6",
     "@node-rs/jieba": "1.10.0",
     "@tanstack/react-query": "^4.24.10",
+    "@types/jest": "^29.5.2",
     "@types/nprogress": "^0.2.0",
     "ahooks": "^3.7.11",
     "axios": "^1.5.1",
@@ -37,6 +39,7 @@
     "hyperdown": "^2.4.29",
     "i18next": "23.11.5",
     "immer": "^9.0.19",
+    "jest": "^29.5.0",
     "js-yaml": "^4.1.0",
     "json5": "^2.2.3",
     "jsonwebtoken": "^9.0.2",
@@ -62,10 +65,12 @@
     "remark-math": "^6.0.0",
     "request-ip": "^3.3.0",
     "sass": "^1.58.3",
+    "ts-jest": "^29.1.0",
     "use-context-selector": "^1.4.4",
     "zustand": "^4.3.5"
   },
   "devDependencies": {
+    "@shelf/jest-mongodb": "^4.3.2",
     "@svgr/webpack": "^6.5.1",
     "@types/formidable": "^2.0.5",
     "@types/js-yaml": "^4.0.9",
@@ -78,6 +83,8 @@
     "@types/request-ip": "^0.0.37",
     "eslint": "8.56.0",
     "eslint-config-next": "14.2.3",
+    "mockingoose": "^2.16.2",
+    "mongodb-memory-server": "^10.0.0",
     "nextjs-node-loader": "^1.1.5",
     "typescript": "^5.1.3"
   }

projects/app/src/pages/api/__mocks__/base.ts

@@ -0,0 +1,76 @@
+import { MongoMemoryServer } from 'mongodb-memory-server';
+import mongoose from 'mongoose';
+import { MockParseHeaderCert } from '@/test/utils';
+import { initMockData } from './db/init';
+
+jest.mock('nanoid', () => {
+  return {
+    nanoid: () => {}
+  };
+});
+
+jest.mock('@fastgpt/global/common/string/tools', () => {
+  return {
+    hashStr(str: string) {
+      return str;
+    }
+  };
+});
+
+jest.mock('@fastgpt/service/common/system/log', jest.fn());
+
+jest.mock('@fastgpt/service/support/permission/controller', () => {
+  return {
+    parseHeaderCert: MockParseHeaderCert,
+    getResourcePermission: jest.requireActual('@fastgpt/service/support/permission/controller')
+      .getResourcePermission,
+    getResourceAllClbs: jest.requireActual('@fastgpt/service/support/permission/controller')
+      .getResourceAllClbs
+  };
+});
+
+const parse = jest.createMockFromModule('@fastgpt/service/support/permission/controller') as any;
+parse.parseHeaderCert = MockParseHeaderCert;
+
+jest.mock('@/service/middleware/entry', () => {
+  return {
+    NextAPI: (...args: any) => {
+      return async function api(req: any, res: any) {
+        try {
+          let response = null;
+          for (const handler of args) {
+            response = await handler(req, res);
+          }
+          return {
+            code: 200,
+            data: response
+          };
+        } catch (error) {
+          return {
+            code: 500,
+            error
+          };
+        }
+      };
+    }
+  };
+});
+
+beforeAll(async () => {
+  if (!global.mongod || !global.mongodb) {
+    const mongod = await MongoMemoryServer.create();
+    global.mongod = mongod;
+    global.mongodb = mongoose;
+    await global.mongodb.connect(mongod.getUri());
+    await initMockData();
+  }
+});
+
+afterAll(async () => {
+  if (global.mongodb) {
+    await global.mongodb.disconnect();
+  }
+  if (global.mongod) {
+    await global.mongod.stop();
+  }
+});

projects/app/src/pages/api/__mocks__/db/init.ts

@@ -0,0 +1,48 @@
+import { TeamMemberRoleEnum } from '@fastgpt/global/support/user/team/constant';
+import { MongoApp } from '@fastgpt/service/core/app/schema';
+import { MongoUser } from '@fastgpt/service/support/user/schema';
+import { MongoTeamMember } from '@fastgpt/service/support/user/team/teamMemberSchema';
+import { MongoTeam } from '@fastgpt/service/support/user/team/teamSchema';
+
+export const root = {
+  uid: '',
+  tmbId: '',
+  teamId: '',
+  isRoot: true,
+  appId: ''
+};
+
+export const initMockData = async () => {
+  // init root user
+  const rootUser = await MongoUser.create({
+    username: 'root',
+    password: '123456'
+  });
+
+  const rootTeam = await MongoTeam.create({
+    name: 'root-default-team',
+    ownerId: rootUser._id
+  });
+
+  const rootTeamMember = await MongoTeamMember.create({
+    teamId: rootTeam._id,
+    userId: rootUser._id,
+    name: 'root-default-team-member',
+    status: 'active',
+    role: TeamMemberRoleEnum.owner
+  });
+
+  const rootApp = await MongoApp.create({
+    name: 'root-default-app',
+    teamId: rootTeam._id,
+    tmbId: rootTeam._id,
+    type: 'advanced'
+  });
+
+  root.uid = rootUser._id;
+  root.tmbId = rootTeamMember._id;
+  root.teamId = rootTeam._id;
+  root.appId = rootApp._id;
+
+  await Promise.all([rootUser.save(), rootTeam.save(), rootTeamMember.save(), rootApp.save()]);
+};

projects/app/src/pages/api/__mocks__/type.d.ts

@@ -0,0 +1,4 @@
+import { MongoMemoryServer } from 'mongodb-memory-server';
+declare global {
+  var mongod: MongoMemoryServer | undefined;
+}

projects/app/src/pages/api/support/outLink/list.test.ts

@@ -0,0 +1,67 @@
+import '../../__mocks__/base';
+import { root } from '../../__mocks__/db/init';
+import { getTestRequest } from '@/test/utils';
+import type { OutLinkListQuery } from './list';
+import { AppErrEnum } from '@fastgpt/global/common/error/code/app';
+import handler from './list';
+import { MongoOutLink } from '@fastgpt/service/support/outLink/schema';
+
+beforeAll(async () => {
+  await MongoOutLink.create({
+    shareId: 'aaa',
+    appId: root.appId,
+    tmbId: root.tmbId,
+    teamId: root.teamId,
+    type: 'share',
+    name: 'aaa'
+  });
+  await MongoOutLink.create({
+    shareId: 'bbb',
+    appId: root.appId,
+    tmbId: root.tmbId,
+    teamId: root.teamId,
+    type: 'share',
+    name: 'bbb'
+  });
+});
+
+test('Should return a list of outLink', async () => {
+  const res = (await handler(
+    ...getTestRequest<OutLinkListQuery>({
+      query: {
+        appId: root.appId,
+        type: 'share'
+      },
+      user: root
+    })
+  )) as any;
+
+  expect(res.code).toBe(200);
+  expect(res.data.length).toBe(2);
+});
+
+test('appId is required', async () => {
+  const res = (await handler(
+    ...getTestRequest<OutLinkListQuery>({
+      query: {
+        type: 'share'
+      },
+      user: root
+    })
+  )) as any;
+  expect(res.code).toBe(500);
+  expect(res.error).toBe(AppErrEnum.unExist);
+});
+
+test('if type is not provided, return nothing', async () => {
+  const res = (await handler(
+    ...getTestRequest<OutLinkListQuery>({
+      query: {
+        appId: root.appId
+      },
+      user: root
+    })
+  )) as any;
+  expect(res.code).toBe(200);
+  expect(res.data.length).toBe(0);
+});

projects/app/src/pages/api/support/outLink/list.ts

@@ -4,6 +4,7 @@ import { ManagePermissionVal } from '@fastgpt/global/support/permission/constant
 import type { ApiRequestProps } from '@fastgpt/service/type/next';
 import { NextAPI } from '@/service/middleware/entry';
 import { OutLinkSchema } from '@fastgpt/global/support/outLink/type';
+import { PublishChannelEnum } from '@fastgpt/global/support/outLink/constant';
 
 export const ApiMetadata = {
   name: '获取应用内所有 Outlink',
@@ -11,19 +12,18 @@ export const ApiMetadata = {
   version: '0.1.0'
 };
 
-// Outlink
 export type OutLinkListQuery = {
   appId: string; // 应用 ID
-  type: string; // 类型
+  type: `${PublishChannelEnum}`;
 };
 
 export type OutLinkListBody = {};
 
-// 响应: 应用内全部 Outlink
+// 应用内全部 Outlink 列表
 export type OutLinkListResponse = OutLinkSchema[];
 
-// 查询应用内全部 Outlink
-async function handler(
+// 查询应用的所有 OutLink
+export async function handler(
   req: ApiRequestProps<OutLinkListBody, OutLinkListQuery>
 ): Promise<OutLinkListResponse> {
   const { appId, type } = req.query;
@@ -43,4 +43,5 @@ async function handler(
 
   return data;
 }
+
 export default NextAPI(handler);

projects/app/src/pages/api/support/outLink/update.test.ts

@@ -0,0 +1,48 @@
+import { getTestRequest } from '@/test/utils';
+import '../../__mocks__/base';
+import handler, { OutLinkUpdateBody, OutLinkUpdateQuery } from './update';
+import { root } from '../../__mocks__/db/init';
+import { MongoOutLink } from '@fastgpt/service/support/outLink/schema';
+import { CommonErrEnum } from '@fastgpt/global/common/error/code/common';
+
+test('Update Outlink', async () => {
+  const outlink = await MongoOutLink.create({
+    shareId: 'aaa',
+    appId: root.appId,
+    tmbId: root.tmbId,
+    teamId: root.teamId,
+    type: 'share',
+    name: 'aaa'
+  });
+
+  await outlink.save();
+
+  const res = (await handler(
+    ...getTestRequest<OutLinkUpdateQuery, OutLinkUpdateBody>({
+      body: {
+        _id: outlink._id,
+        name: 'changed'
+      },
+      user: root
+    })
+  )) as any;
+
+  expect(res.code).toBe(200);
+
+  const link = await MongoOutLink.findById(outlink._id).lean();
+  expect(link?.name).toBe('changed');
+});
+
+test('Did not post _id', async () => {
+  const res = (await handler(
+    ...getTestRequest<OutLinkUpdateQuery, OutLinkUpdateBody>({
+      body: {
+        name: 'changed'
+      },
+      user: root
+    })
+  )) as any;
+
+  expect(res.code).toBe(500);
+  expect(res.error).toBe(CommonErrEnum.missingParams);
+});

projects/app/src/pages/api/support/outLink/update.ts

@@ -7,7 +7,18 @@ import { NextAPI } from '@/service/middleware/entry';
 import { CommonErrEnum } from '@fastgpt/global/common/error/code/common';
 
 export type OutLinkUpdateQuery = {};
-export type OutLinkUpdateBody = OutLinkEditType & {};
+
+// {
+// _id?: string; // Outlink 的 ID
+// name: string; // Outlink 的名称
+// responseDetail?: boolean; // 是否开启详细回复
+// immediateResponse?: string; // 立即回复的内容
+// defaultResponse?: string; // 默认回复的内容
+// limit?: OutLinkSchema<T>['limit']; // 限制
+// app?: T; // 平台的配置
+// }
+export type OutLinkUpdateBody = OutLinkEditType;
+
 export type OutLinkUpdateResponse = {};
 
 async function handler(

projects/app/src/test/utils.ts

@@ -0,0 +1,94 @@
+import { ERROR_ENUM } from '@fastgpt/global/common/error/errorCode';
+
+export type TestTokenType = {
+  userId: string;
+  teamId: string;
+  tmbId: string;
+  isRoot: boolean;
+};
+
+export type TestRequest = {
+  headers: {
+    cookie?: {
+      token?: TestTokenType;
+    };
+    authorization?: string; // testkey
+    rootkey?: string; // rootkey
+  };
+  query: {
+    [key: string]: string;
+  };
+  body: {
+    [key: string]: string;
+  };
+};
+
+export function getTestRequest<Q = any, B = any>({
+  query = {},
+  body = {},
+  authToken = true,
+  // authRoot = false,
+  // authApiKey = false,
+  user
+}: {
+  body?: Partial<B>;
+  query?: Partial<Q>;
+  authToken?: boolean;
+  authRoot?: boolean;
+  authApiKey?: boolean;
+  user?: {
+    uid: string;
+    tmbId: string;
+    teamId: string;
+    isRoot: boolean;
+  };
+}): [any, any] {
+  const headers: TestRequest['headers'] = {};
+  if (authToken) {
+    headers.cookie = {
+      token: {
+        userId: String(user?.uid || ''),
+        teamId: String(user?.teamId || ''),
+        tmbId: String(user?.tmbId || ''),
+        isRoot: user?.isRoot || false
+      }
+    };
+  }
+  return [
+    {
+      headers,
+      query,
+      body
+    },
+    {}
+  ];
+}
+
+export const MockParseHeaderCert = async ({
+  req,
+  authToken = true,
+  authRoot = false,
+  authApiKey = false
+}: {
+  req: TestRequest;
+  authToken?: boolean;
+  authRoot?: boolean;
+  authApiKey?: boolean;
+}): Promise<TestTokenType> => {
+  if (authToken) {
+    const token = req.headers?.cookie?.token;
+    if (!token) {
+      return Promise.reject(ERROR_ENUM.unAuthorization);
+    }
+    return token;
+  }
+  // if (authRoot) {
+  //   // TODO: unfinished
+  //   return req.headers.rootkey;
+  // }
+  // if (authApiKey) {
+  //   // TODO: unfinished
+  //   return req.headers.authorization;
+  // }
+  return {} as any;
+};