@lobehub/chat 1.128.0 → 1.128.1

package/packages/context-engine/src/processors/__tests__/PlaceholderVariables.test.ts

@@ -0,0 +1,334 @@
+import { describe, expect, it } from 'vitest';
+
+import {
+  PlaceholderVariablesProcessor,
+  parsePlaceholderVariables,
+  parsePlaceholderVariablesMessages,
+} from '../PlaceholderVariables';
+
+describe('PlaceholderVariablesProcessor', () => {
+  const mockVariableGenerators = {
+    date: () => '2023-12-25',
+    time: () => '14:30:45',
+    username: () => 'TestUser',
+    random: () => '12345',
+    nested: () => 'Value with {{date}} inside',
+  };
+
+  describe('parsePlaceholderVariables', () => {
+    it('should replace simple placeholder variables', () => {
+      const text = 'Today is {{date}} and the time is {{time}}';
+      const result = parsePlaceholderVariables(text, mockVariableGenerators);
+      expect(result).toBe('Today is 2023-12-25 and the time is 14:30:45');
+    });
+
+    it('should handle missing variables gracefully', () => {
+      const text = 'Hello {{username}}, missing: {{missing}}';
+      const result = parsePlaceholderVariables(text, mockVariableGenerators);
+      expect(result).toBe('Hello TestUser, missing: {{missing}}');
+    });
+
+    it('should handle nested variables with recursion', () => {
+      const text = 'Nested: {{nested}}';
+      const result = parsePlaceholderVariables(text, mockVariableGenerators);
+      expect(result).toBe('Nested: Value with 2023-12-25 inside');
+    });
+
+    it('should respect depth limit', () => {
+      const text = 'Nested: {{nested}}';
+      const result = parsePlaceholderVariables(text, mockVariableGenerators, 1);
+      expect(result).toBe('Nested: Value with {{date}} inside');
+    });
+
+    it('should handle empty text', () => {
+      const text = '';
+      const result = parsePlaceholderVariables(text, mockVariableGenerators);
+      expect(result).toBe('');
+    });
+
+    it('should handle text without placeholders', () => {
+      const text = 'No placeholders here';
+      const result = parsePlaceholderVariables(text, mockVariableGenerators);
+      expect(result).toBe('No placeholders here');
+    });
+  });
+
+  describe('parsePlaceholderVariablesMessages', () => {
+    it('should process string content messages', () => {
+      const messages = [
+        {
+          id: '1',
+          role: 'user',
+          content: 'Hello {{username}}, today is {{date}}',
+        },
+        {
+          id: '2',
+          role: 'assistant',
+          content: 'Hi there! The time is {{time}}',
+        },
+      ];
+
+      const result = parsePlaceholderVariablesMessages(messages, mockVariableGenerators);
+
+      expect(result).toEqual([
+        {
+          id: '1',
+          role: 'user',
+          content: 'Hello TestUser, today is 2023-12-25',
+        },
+        {
+          id: '2',
+          role: 'assistant',
+          content: 'Hi there! The time is 14:30:45',
+        },
+      ]);
+    });
+
+    it('should process array content messages with text parts', () => {
+      const messages = [
+        {
+          id: '1',
+          role: 'user',
+          content: [
+            {
+              type: 'text',
+              text: 'Hello {{username}}, today is {{date}}',
+            },
+            {
+              type: 'image_url',
+              image_url: { url: 'data:image/png;base64,abc123' },
+            },
+          ],
+        },
+      ];
+
+      const result = parsePlaceholderVariablesMessages(messages, mockVariableGenerators);
+
+      expect(result).toEqual([
+        {
+          id: '1',
+          role: 'user',
+          content: [
+            {
+              type: 'text',
+              text: 'Hello TestUser, today is 2023-12-25',
+            },
+            {
+              type: 'image_url',
+              image_url: { url: 'data:image/png;base64,abc123' },
+            },
+          ],
+        },
+      ]);
+    });
+
+    it('should skip messages without content', () => {
+      const messages = [
+        {
+          id: '1',
+          role: 'user',
+        },
+        {
+          id: '2',
+          role: 'assistant',
+          content: null,
+        },
+      ];
+
+      const result = parsePlaceholderVariablesMessages(messages, mockVariableGenerators);
+
+      expect(result).toEqual(messages);
+    });
+
+    it('should handle mixed content types', () => {
+      const messages = [
+        {
+          id: '1',
+          role: 'user',
+          content: 'Simple {{username}} message',
+        },
+        {
+          id: '2',
+          role: 'user',
+          content: [{ type: 'text', text: 'Complex {{date}} message' }],
+        },
+        {
+          id: '3',
+          role: 'assistant',
+          content: { type: 'object', data: 'not processed' },
+        },
+      ];
+
+      const result = parsePlaceholderVariablesMessages(messages, mockVariableGenerators);
+
+      expect(result).toEqual([
+        {
+          id: '1',
+          role: 'user',
+          content: 'Simple TestUser message',
+        },
+        {
+          id: '2',
+          role: 'user',
+          content: [{ type: 'text', text: 'Complex 2023-12-25 message' }],
+        },
+        {
+          id: '3',
+          role: 'assistant',
+          content: { type: 'object', data: 'not processed' },
+        },
+      ]);
+    });
+  });
+
+  describe('PlaceholderVariablesProcessor', () => {
+    it('should process messages through the processor', async () => {
+      const processor = new PlaceholderVariablesProcessor({
+        variableGenerators: mockVariableGenerators,
+      });
+
+      const context = {
+        initialState: {
+          messages: [],
+          model: 'gpt-4',
+          provider: 'openai',
+          systemRole: '',
+          tools: [],
+        },
+        messages: [
+          {
+            id: '1',
+            role: 'user',
+            content: 'Hello {{username}}, today is {{date}}',
+            createdAt: Date.now(),
+            updatedAt: Date.now(),
+          },
+        ],
+        metadata: {
+          model: 'gpt-4',
+          maxTokens: 4096,
+        },
+        isAborted: false,
+        executedProcessors: [],
+      };
+
+      const result = await processor.process(context);
+
+      expect(result.messages[0].content).toBe('Hello TestUser, today is 2023-12-25');
+      expect(result.metadata.placeholderVariablesProcessed).toBe(1);
+    });
+
+    it('should handle processing errors gracefully', async () => {
+      const faultyGenerators = {
+        error: () => {
+          throw new Error('Generator error');
+        },
+        working: () => 'works',
+      };
+
+      const processor = new PlaceholderVariablesProcessor({
+        variableGenerators: faultyGenerators,
+      });
+
+      const context = {
+        initialState: {
+          messages: [],
+          model: 'gpt-4',
+          provider: 'openai',
+          systemRole: '',
+          tools: [],
+        },
+        messages: [
+          {
+            id: '1',
+            role: 'user',
+            content: 'This {{working}} but this {{error}} fails',
+            createdAt: Date.now(),
+            updatedAt: Date.now(),
+          },
+        ],
+        metadata: {
+          model: 'gpt-4',
+          maxTokens: 4096,
+        },
+        isAborted: false,
+        executedProcessors: [],
+      };
+
+      // Should not throw, but continue processing
+      const result = await processor.process(context);
+      expect(result.messages).toHaveLength(1);
+    });
+
+    it('should use custom depth setting', async () => {
+      const processor = new PlaceholderVariablesProcessor({
+        variableGenerators: mockVariableGenerators,
+        depth: 1,
+      });
+
+      const context = {
+        initialState: {
+          messages: [],
+          model: 'gpt-4',
+          provider: 'openai',
+          systemRole: '',
+          tools: [],
+        },
+        messages: [
+          {
+            id: '1',
+            role: 'user',
+            content: 'Nested: {{nested}}',
+            createdAt: Date.now(),
+            updatedAt: Date.now(),
+          },
+        ],
+        metadata: {
+          model: 'gpt-4',
+          maxTokens: 4096,
+        },
+        isAborted: false,
+        executedProcessors: [],
+      };
+
+      const result = await processor.process(context);
+
+      expect(result.messages[0].content).toBe('Nested: Value with {{date}} inside');
+    });
+
+    it('should not modify messages that do not need processing', async () => {
+      const processor = new PlaceholderVariablesProcessor({
+        variableGenerators: mockVariableGenerators,
+      });
+
+      const context = {
+        initialState: {
+          messages: [],
+          model: 'gpt-4',
+          provider: 'openai',
+          systemRole: '',
+          tools: [],
+        },
+        messages: [
+          {
+            id: '1',
+            role: 'user',
+            content: 'No variables here',
+            createdAt: Date.now(),
+            updatedAt: Date.now(),
+          },
+        ],
+        metadata: {
+          model: 'gpt-4',
+          maxTokens: 4096,
+        },
+        isAborted: false,
+        executedProcessors: [],
+      };
+
+      const result = await processor.process(context);
+
+      expect(result.metadata.placeholderVariablesProcessed).toBe(0);
+    });
+  });
+});

package/packages/context-engine/src/processors/__tests__/ToolMessageReorder.test.ts

@@ -0,0 +1,186 @@
+import { describe, expect, it } from 'vitest';
+
+import type { PipelineContext } from '../../types';
+import { ToolMessageReorder } from '../ToolMessageReorder';
+
+const createContext = (messages: any[]): PipelineContext => ({
+  initialState: { messages: [] } as any,
+  messages,
+  metadata: { model: 'gpt-4', maxTokens: 4096 },
+  isAborted: false,
+});
+
+describe('ToolMessageReorder', () => {
+  it('should place tool messages right after their assistant calls and drop invalid tools', async () => {
+    const proc = new ToolMessageReorder();
+    const messages = [
+      { id: 'u1', role: 'user', content: 'hi' },
+      {
+        id: 'a1',
+        role: 'assistant',
+        content: 'calling',
+        tool_calls: [
+          { id: 'call_1', type: 'function', function: { name: 'test', arguments: '{}' } },
+        ],
+      },
+      { id: 't1', role: 'tool', content: '{"ok":1}', tool_call_id: 'call_1' },
+      { id: 't_invalid', role: 'tool', content: '{"ok":0}' },
+    ];
+
+    const ctx = createContext(messages);
+    const res = await proc.process(ctx);
+
+    expect(res.messages.map((m) => m.id)).toEqual(['u1', 'a1', 't1']);
+  });
+
+  it('should reorderToolMessages', async () => {
+    const proc = new ToolMessageReorder();
+    const messages = [
+      {
+        content: '## Tools\n\nYou can use these tools',
+        role: 'system',
+      },
+      {
+        content: '',
+        role: 'assistant',
+        tool_calls: [
+          {
+            function: {
+              arguments:
+                '{"query":"LobeChat","searchEngines":["brave","google","duckduckgo","qwant"]}',
+              name: 'lobe-web-browsing____searchWithSearXNG____builtin',
+            },
+            id: 'call_6xCmrOtFOyBAcqpqO1TGfw2B',
+            type: 'function',
+          },
+          {
+            function: {
+              arguments:
+                '{"query":"LobeChat","searchEngines":["brave","google","duckduckgo","qwant"]}',
+              name: 'lobe-web-browsing____searchWithSearXNG____builtin',
+            },
+            id: 'tool_call_nXxXHW8Z',
+            type: 'function',
+          },
+        ],
+      },
+      {
+        content: '[]',
+        name: 'lobe-web-browsing____searchWithSearXNG____builtin',
+        role: 'tool',
+        tool_call_id: 'call_6xCmrOtFOyBAcqpqO1TGfw2B',
+      },
+      {
+        content: 'LobeHub 是一个专注于设计和开发现代人工智能生成内容（AIGC）工具和组件的团队。',
+        role: 'assistant',
+      },
+      {
+        content: '[]',
+        name: 'lobe-web-browsing____searchWithSearXNG____builtin',
+        role: 'tool',
+        tool_call_id: 'tool_call_nXxXHW8Z',
+      },
+      {
+        content: '[]',
+        name: 'lobe-web-browsing____searchWithSearXNG____builtin',
+        role: 'tool',
+        tool_call_id: 'tool_call_2f3CEKz9',
+      },
+      {
+        content: '### LobeHub 智能AI聚合神器\n\nLobeHub 是一个强大的AI聚合平台',
+        role: 'assistant',
+      },
+    ];
+
+    const ctx = createContext(messages);
+
+    const output = await proc.process(ctx);
+
+    expect(output.messages).toEqual([
+      {
+        content: '## Tools\n\nYou can use these tools',
+        role: 'system',
+      },
+      {
+        content: '',
+        role: 'assistant',
+        tool_calls: [
+          {
+            function: {
+              arguments:
+                '{"query":"LobeChat","searchEngines":["brave","google","duckduckgo","qwant"]}',
+              name: 'lobe-web-browsing____searchWithSearXNG____builtin',
+            },
+            id: 'call_6xCmrOtFOyBAcqpqO1TGfw2B',
+            type: 'function',
+          },
+          {
+            function: {
+              arguments:
+                '{"query":"LobeChat","searchEngines":["brave","google","duckduckgo","qwant"]}',
+              name: 'lobe-web-browsing____searchWithSearXNG____builtin',
+            },
+            id: 'tool_call_nXxXHW8Z',
+            type: 'function',
+          },
+        ],
+      },
+      {
+        content: '[]',
+        name: 'lobe-web-browsing____searchWithSearXNG____builtin',
+        role: 'tool',
+        tool_call_id: 'call_6xCmrOtFOyBAcqpqO1TGfw2B',
+      },
+      {
+        content: '[]',
+        name: 'lobe-web-browsing____searchWithSearXNG____builtin',
+        role: 'tool',
+        tool_call_id: 'tool_call_nXxXHW8Z',
+      },
+      {
+        content: 'LobeHub 是一个专注于设计和开发现代人工智能生成内容（AIGC）工具和组件的团队。',
+        role: 'assistant',
+      },
+      {
+        content: '### LobeHub 智能AI聚合神器\n\nLobeHub 是一个强大的AI聚合平台',
+        role: 'assistant',
+      },
+    ]);
+  });
+
+  it('should correctly reorder when a tool message appears before the assistant message', async () => {
+    const messages = [
+      {
+        role: 'system',
+        content: 'System message',
+      },
+      {
+        role: 'tool',
+        tool_call_id: 'tool_call_1',
+        name: 'test-plugin____testApi',
+        content: 'Tool result',
+      },
+      {
+        role: 'assistant',
+        content: '',
+        tool_calls: [
+          { id: 'tool_call_1', type: 'function', function: { name: 'testApi', arguments: '{}' } },
+        ],
+      },
+    ];
+
+    const proc = new ToolMessageReorder();
+
+    const ctx = createContext(messages);
+
+    const { messages: output } = await proc.process(ctx);
+
+    // Verify reordering logic works and covers line 688 hasPushed check
+    // In this test, tool messages are duplicated but the second occurrence is skipped
+    expect(output.length).toBe(4); // Original has 3, assistant will add corresponding tool message again
+    expect(output[0].role).toBe('system');
+    expect(output[1].role).toBe('tool');
+    expect(output[2].role).toBe('assistant');
+    expect(output[3].role).toBe('tool'); // Tool message added by assistant's tool_calls
+  });
+});

package/packages/context-engine/src/processors/index.ts

@@ -0,0 +1,15 @@
+// Transformer processors
+export { HistoryTruncateProcessor } from './HistoryTruncate';
+export { InputTemplateProcessor } from './InputTemplate';
+export { MessageCleanupProcessor } from './MessageCleanup';
+export { MessageContentProcessor } from './MessageContent';
+export { PlaceholderVariablesProcessor } from './PlaceholderVariables';
+export { ToolCallProcessor } from './ToolCall';
+export { ToolMessageReorder } from './ToolMessageReorder';
+
+// Re-export types
+export type { HistoryTruncateConfig } from './HistoryTruncate';
+export type { InputTemplateConfig } from './InputTemplate';
+export type { MessageContentConfig, UserMessageContentPart } from './MessageContent';
+export type { PlaceholderVariablesConfig } from './PlaceholderVariables';
+export type { ToolCallConfig } from './ToolCall';

package/packages/context-engine/src/providers/HistorySummary.ts

@@ -0,0 +1,102 @@
+import debug from 'debug';
+
+import { BaseProvider } from '../base/BaseProvider';
+import type { PipelineContext, ProcessorOptions } from '../types';
+
+const log = debug('context-engine:provider:HistorySummaryProvider');
+
+/**
+ * History Summary Configuration
+ */
+export interface HistorySummaryConfig {
+  /** History summary template function */
+  formatHistorySummary?: (summary: string) => string;
+  /** History summary content */
+  historySummary?: string;
+}
+
+/**
+ * Default history summary formatter function
+ */
+const defaultHistorySummaryFormatter = (historySummary: string): string => `<chat_history_summary>
+<docstring>Users may have lots of chat messages, here is the summary of the history:</docstring>
+<summary>${historySummary}</summary>
+</chat_history_summary>`;
+
+/**
+ * History Summary Provider
+ * Responsible for injecting history conversation summary into system messages
+ */
+export class HistorySummaryProvider extends BaseProvider {
+  readonly name = 'HistorySummaryProvider';
+
+  constructor(
+    private config: HistorySummaryConfig,
+    options: ProcessorOptions = {},
+  ) {
+    super(options);
+  }
+
+  protected async doProcess(context: PipelineContext): Promise<PipelineContext> {
+    const clonedContext = this.cloneContext(context);
+
+    // 检查是否有历史摘要
+    if (!this.config.historySummary) {
+      log('No history summary content, skipping processing');
+      return this.markAsExecuted(clonedContext);
+    }
+
+    // 格式化历史摘要
+    const formattedSummary = this.formatHistorySummary(this.config.historySummary);
+
+    // 注入历史摘要
+    this.injectHistorySummary(clonedContext, formattedSummary);
+
+    // 更新元数据
+    clonedContext.metadata.historySummary = {
+      formattedLength: formattedSummary.length,
+      injected: true,
+      originalLength: this.config.historySummary.length,
+    };
+
+    log(
+      `History summary injection completed, original length: ${this.config.historySummary.length}, formatted length: ${formattedSummary.length}`,
+    );
+    return this.markAsExecuted(clonedContext);
+  }
+
+  /**
+   * Format history summary
+   */
+  private formatHistorySummary(historySummary: string): string {
+    const formatter = this.config.formatHistorySummary || defaultHistorySummaryFormatter;
+    return formatter(historySummary);
+  }
+
+  /**
+   * Inject history summary to system message
+   */
+  private injectHistorySummary(context: PipelineContext, formattedSummary: string): void {
+    const existingSystemMessage = context.messages.find((msg) => msg.role === 'system');
+
+    if (existingSystemMessage) {
+      // 合并到现有系统消息
+      existingSystemMessage.content = [existingSystemMessage.content, formattedSummary]
+        .filter(Boolean)
+        .join('\n\n');
+
+      log(
+        `History summary merged to existing system message, final length: ${existingSystemMessage.content.length}`,
+      );
+    } else {
+      // 创建新的系统消息
+      const systemMessage = {
+        content: formattedSummary,
+        role: 'system' as const,
+      };
+
+      context.messages.unshift(systemMessage as any);
+      log(`New history summary system message created, content length: ${formattedSummary.length}`);
+    }
+  }
+}