refactor(server): config system (#11081)

packages/backend/server/src/__tests__/mocks/copilot.mock.ts

@@ -0,0 +1,113 @@
+import { randomBytes } from 'node:crypto';
+
+import {
+  CopilotCapability,
+  CopilotChatOptions,
+  CopilotEmbeddingOptions,
+  PromptMessage,
+} from '../../plugins/copilot/providers';
+import {
+  DEFAULT_DIMENSIONS,
+  OpenAIProvider,
+} from '../../plugins/copilot/providers/openai';
+import { sleep } from '../utils/utils';
+
+export class MockCopilotProvider extends OpenAIProvider {
+  override readonly models = [
+    'test',
+    'gpt-4o',
+    'gpt-4o-2024-08-06',
+    'fast-sdxl/image-to-image',
+    'lcm-sd15-i2i',
+    'clarity-upscaler',
+    'imageutils/rembg',
+  ];
+
+  override readonly capabilities = [
+    CopilotCapability.TextToText,
+    CopilotCapability.TextToEmbedding,
+    CopilotCapability.TextToImage,
+    CopilotCapability.ImageToImage,
+    CopilotCapability.ImageToText,
+  ];
+
+  // ====== text to text ======
+
+  override async generateText(
+    messages: PromptMessage[],
+    model: string = 'test',
+    options: CopilotChatOptions = {}
+  ): Promise<string> {
+    this.checkParams({ messages, model, options });
+    // make some time gap for history test case
+    await sleep(100);
+    return 'generate text to text';
+  }
+
+  override async *generateTextStream(
+    messages: PromptMessage[],
+    model: string = 'gpt-4o-mini',
+    options: CopilotChatOptions = {}
+  ): AsyncIterable<string> {
+    this.checkParams({ messages, model, options });
+
+    // make some time gap for history test case
+    await sleep(100);
+    const result = 'generate text to text stream';
+    for (const message of result) {
+      yield message;
+      if (options.signal?.aborted) {
+        break;
+      }
+    }
+  }
+
+  // ====== text to embedding ======
+
+  override async generateEmbedding(
+    messages: string | string[],
+    model: string,
+    options: CopilotEmbeddingOptions = { dimensions: DEFAULT_DIMENSIONS }
+  ): Promise<number[][]> {
+    messages = Array.isArray(messages) ? messages : [messages];
+    this.checkParams({ embeddings: messages, model, options });
+
+    // make some time gap for history test case
+    await sleep(100);
+    return [Array.from(randomBytes(options.dimensions)).map(v => v % 128)];
+  }
+
+  // ====== text to image ======
+  override async generateImages(
+    messages: PromptMessage[],
+    model: string = 'test',
+    _options: {
+      signal?: AbortSignal;
+      user?: string;
+    } = {}
+  ): Promise<Array<string>> {
+    const { content: prompt } = messages[0] || {};
+    if (!prompt) {
+      throw new Error('Prompt is required');
+    }
+
+    // make some time gap for history test case
+    await sleep(100);
+    // just let test case can easily verify the final prompt
+    return [`https://example.com/${model}.jpg`, prompt];
+  }
+
+  override async *generateImagesStream(
+    messages: PromptMessage[],
+    model: string = 'dall-e-3',
+    options: {
+      signal?: AbortSignal;
+      user?: string;
+    } = {}
+  ): AsyncIterable<string> {
+    const ret = await this.generateImages(messages, model, options);
+    for (const url of ret) {
+      yield url;
+    }
+  }
+}

packages/backend/server/src/__tests__/mocks/eventbus.mock.ts

@@ -0,0 +1,35 @@
+import Sinon from 'sinon';
+
+import { EventBus } from '../../base';
+import { EventName } from '../../base/event/def';
+
+export class MockEventBus {
+  private readonly stub = Sinon.createStubInstance(EventBus);
+
+  emit = this.stub.emitAsync;
+  emitAsync = this.stub.emitAsync;
+  broadcast = this.stub.broadcast;
+
+  last<Event extends EventName>(
+    name: Event
+  ): { name: Event; payload: Events[Event] } {
+    const call = this.emitAsync
+      .getCalls()
+      .reverse()
+      .find(call => call.args[0] === name);
+    if (!call) {
+      throw new Error(`Event ${name} never called`);
+    }
+
+    // @ts-expect-error allow
+    return {
+      name,
+      payload: call.args[1],
+    };
+  }
+
+  count(name: EventName) {
+    return this.emitAsync.getCalls().filter(call => call.args[0] === name)
+      .length;
+  }
+}

packages/backend/server/src/__tests__/mocks/index.ts

@@ -4,7 +4,9 @@ export * from './user.mock';
 export * from './workspace.mock';
 export * from './workspace-user.mock';
 
+import { MockCopilotProvider } from './copilot.mock';
 import { MockDocMeta } from './doc-meta.mock';
+import { MockEventBus } from './eventbus.mock';
 import { MockMailer } from './mailer.mock';
 import { MockJobQueue } from './queue.mock';
 import { MockTeamWorkspace } from './team-workspace.mock';
@@ -22,4 +24,4 @@ export const Mockers = {
   DocMeta: MockDocMeta,
 };
 
-export { MockJobQueue, MockMailer };
+export { MockCopilotProvider, MockEventBus, MockJobQueue, MockMailer };