@lobehub/lobehub 2.0.0-next.360 → 2.0.0-next.362

package/packages/context-engine/src/base/__tests__/BaseEveryUserContentProvider.test.ts

@@ -0,0 +1,354 @@
+import { describe, expect, it } from 'vitest';
+
+import type { Message, PipelineContext } from '../../types';
+import { BaseEveryUserContentProvider } from '../BaseEveryUserContentProvider';
+
+class TestEveryUserContentProvider extends BaseEveryUserContentProvider {
+  readonly name = 'TestEveryUserContentProvider';
+
+  constructor(
+    private contentBuilder?: (
+      message: Message,
+      index: number,
+      isLastUser: boolean,
+    ) => { content: string; contextType: string } | null,
+  ) {
+    super();
+  }
+
+  protected buildContentForMessage(
+    message: Message,
+    index: number,
+    isLastUser: boolean,
+  ): { content: string; contextType: string } | null {
+    if (this.contentBuilder) {
+      return this.contentBuilder(message, index, isLastUser);
+    }
+    // Default: inject content for every user message
+    return {
+      content: `Content for message ${index}`,
+      contextType: 'test_context',
+    };
+  }
+
+  // Expose protected methods for testing
+  testHasSystemContextWrapper(content: string | any[]) {
+    return this.hasSystemContextWrapper(content);
+  }
+
+  testWrapWithSystemContext(content: string, contextType: string) {
+    return this.wrapWithSystemContext(content, contextType);
+  }
+
+  testCreateContextBlock(content: string, contextType: string) {
+    return this.createContextBlock(content, contextType);
+  }
+
+  testAppendToMessage(message: Message, content: string, contextType: string) {
+    return this.appendToMessage(message, content, contextType);
+  }
+
+  testFindLastUserMessageIndex(messages: Message[]) {
+    return this.findLastUserMessageIndex(messages);
+  }
+}
+
+describe('BaseEveryUserContentProvider', () => {
+  const createContext = (messages: any[] = []): PipelineContext => ({
+    initialState: {
+      messages: [],
+      model: 'test-model',
+      provider: 'test-provider',
+    },
+    isAborted: false,
+    messages,
+    metadata: {
+      maxTokens: 4000,
+      model: 'test-model',
+    },
+  });
+
+  describe('findLastUserMessageIndex', () => {
+    it('should find the last user message', () => {
+      const provider = new TestEveryUserContentProvider();
+      const messages = [
+        { content: 'Hello', role: 'user' },
+        { content: 'Hi', role: 'assistant' },
+        { content: 'Question', role: 'user' },
+        { content: 'Answer', role: 'assistant' },
+      ];
+
+      expect(provider.testFindLastUserMessageIndex(messages)).toBe(2);
+    });
+
+    it('should return -1 when no user messages exist', () => {
+      const provider = new TestEveryUserContentProvider();
+      const messages = [{ content: 'System', role: 'system' }];
+
+      expect(provider.testFindLastUserMessageIndex(messages)).toBe(-1);
+    });
+  });
+
+  describe('hasSystemContextWrapper', () => {
+    it('should detect existing system context wrapper in string content', () => {
+      const provider = new TestEveryUserContentProvider();
+
+      const withWrapper = `Question
+<!-- SYSTEM CONTEXT (NOT PART OF USER QUERY) -->
+<test>content</test>
+<!-- END SYSTEM CONTEXT -->`;
+
+      const withoutWrapper = 'Simple question';
+
+      expect(provider.testHasSystemContextWrapper(withWrapper)).toBe(true);
+      expect(provider.testHasSystemContextWrapper(withoutWrapper)).toBe(false);
+    });
+
+    it('should detect existing system context wrapper in array content', () => {
+      const provider = new TestEveryUserContentProvider();
+
+      const withWrapper = [
+        {
+          text: `Question
+<!-- SYSTEM CONTEXT (NOT PART OF USER QUERY) -->
+<test>content</test>
+<!-- END SYSTEM CONTEXT -->`,
+          type: 'text',
+        },
+      ];
+
+      const withoutWrapper = [{ text: 'Simple question', type: 'text' }];
+
+      expect(provider.testHasSystemContextWrapper(withWrapper)).toBe(true);
+      expect(provider.testHasSystemContextWrapper(withoutWrapper)).toBe(false);
+    });
+  });
+
+  describe('wrapWithSystemContext', () => {
+    it('should wrap content with system context markers', () => {
+      const provider = new TestEveryUserContentProvider();
+      const result = provider.testWrapWithSystemContext('Test content', 'test_type');
+
+      expect(result).toContain('<!-- SYSTEM CONTEXT (NOT PART OF USER QUERY) -->');
+      expect(result).toContain('<context.instruction>');
+      expect(result).toContain('<test_type>');
+      expect(result).toContain('Test content');
+      expect(result).toContain('</test_type>');
+      expect(result).toContain('<!-- END SYSTEM CONTEXT -->');
+    });
+  });
+
+  describe('createContextBlock', () => {
+    it('should create context block without wrapper', () => {
+      const provider = new TestEveryUserContentProvider();
+      const result = provider.testCreateContextBlock('Block content', 'block_type');
+
+      expect(result).toBe(`<block_type>
+Block content
+</block_type>`);
+    });
+  });
+
+  describe('appendToMessage', () => {
+    it('should append with new wrapper to string content without existing wrapper', () => {
+      const provider = new TestEveryUserContentProvider();
+      const message: Message = { content: 'Original question', role: 'user' };
+
+      const result = provider.testAppendToMessage(message, 'New content', 'new_type');
+
+      expect(result.content).toContain('Original question');
+      expect(result.content).toContain('<!-- SYSTEM CONTEXT (NOT PART OF USER QUERY) -->');
+      expect(result.content).toContain('<new_type>');
+      expect(result.content).toContain('New content');
+      expect(result.content).toContain('<!-- END SYSTEM CONTEXT -->');
+    });
+
+    it('should insert into existing wrapper in string content', () => {
+      const provider = new TestEveryUserContentProvider();
+      const message: Message = {
+        content: `Original question
+
+<!-- SYSTEM CONTEXT (NOT PART OF USER QUERY) -->
+<context.instruction>...</context.instruction>
+<existing_type>
+Existing content
+</existing_type>
+<!-- END SYSTEM CONTEXT -->`,
+        role: 'user',
+      };
+
+      const result = provider.testAppendToMessage(message, 'New content', 'new_type');
+
+      // Should have only one SYSTEM CONTEXT wrapper
+      const content = result.content as string;
+      const startCount = (content.match(/<!-- SYSTEM CONTEXT/g) || []).length;
+      const endCount = (content.match(/<!-- END SYSTEM CONTEXT/g) || []).length;
+
+      expect(startCount).toBe(1);
+      expect(endCount).toBe(1);
+      expect(content).toContain('<existing_type>');
+      expect(content).toContain('<new_type>');
+      expect(content).toContain('New content');
+    });
+
+    it('should handle array content without existing wrapper', () => {
+      const provider = new TestEveryUserContentProvider();
+      const message: Message = {
+        content: [
+          { text: 'Original question', type: 'text' },
+          { image_url: { url: 'http://example.com/img.png' }, type: 'image_url' },
+        ],
+        role: 'user',
+      };
+
+      const result = provider.testAppendToMessage(message, 'New content', 'new_type');
+
+      expect(result.content[0].text).toContain('Original question');
+      expect(result.content[0].text).toContain('<!-- SYSTEM CONTEXT');
+      expect(result.content[0].text).toContain('<new_type>');
+      expect(result.content[1].type).toBe('image_url');
+    });
+
+    it('should add new text part when array content has no text part', () => {
+      const provider = new TestEveryUserContentProvider();
+      const message: Message = {
+        content: [{ image_url: { url: 'http://example.com/img.png' }, type: 'image_url' }],
+        role: 'user',
+      };
+
+      const result = provider.testAppendToMessage(message, 'New content', 'new_type');
+
+      expect(result.content).toHaveLength(2);
+      expect(result.content[1].type).toBe('text');
+      expect(result.content[1].text).toContain('<!-- SYSTEM CONTEXT');
+      expect(result.content[1].text).toContain('New content');
+    });
+  });
+
+  describe('process integration', () => {
+    it('should inject content to all user messages', async () => {
+      const provider = new TestEveryUserContentProvider();
+      const context = createContext([
+        { content: 'First question', role: 'user' },
+        { content: 'First answer', role: 'assistant' },
+        { content: 'Second question', role: 'user' },
+        { content: 'Second answer', role: 'assistant' },
+        { content: 'Third question', role: 'user' },
+      ]);
+
+      const result = await provider.process(context);
+
+      // All user messages should have content injected
+      expect(result.messages[0].content).toContain('First question');
+      expect(result.messages[0].content).toContain('<test_context>');
+      expect(result.messages[0].content).toContain('Content for message 0');
+
+      expect(result.messages[2].content).toContain('Second question');
+      expect(result.messages[2].content).toContain('<test_context>');
+      expect(result.messages[2].content).toContain('Content for message 2');
+
+      expect(result.messages[4].content).toContain('Third question');
+      expect(result.messages[4].content).toContain('<test_context>');
+      expect(result.messages[4].content).toContain('Content for message 4');
+
+      // Assistant messages should be unchanged
+      expect(result.messages[1].content).toBe('First answer');
+      expect(result.messages[3].content).toBe('Second answer');
+    });
+
+    it('should correctly identify isLastUser parameter', async () => {
+      const isLastUserCalls: boolean[] = [];
+
+      const provider = new TestEveryUserContentProvider((message, index, isLastUser) => {
+        isLastUserCalls.push(isLastUser);
+        return { content: `Content ${index}`, contextType: 'test' };
+      });
+
+      const context = createContext([
+        { content: 'First', role: 'user' },
+        { content: 'Answer', role: 'assistant' },
+        { content: 'Second', role: 'user' },
+        { content: 'Answer', role: 'assistant' },
+        { content: 'Third (last)', role: 'user' },
+      ]);
+
+      await provider.process(context);
+
+      expect(isLastUserCalls).toEqual([false, false, true]);
+    });
+
+    it('should skip injection when buildContentForMessage returns null', async () => {
+      const provider = new TestEveryUserContentProvider((message, index) => {
+        // Only inject for first user message
+        if (index === 0) {
+          return { content: 'First only', contextType: 'test' };
+        }
+        return null;
+      });
+
+      const context = createContext([
+        { content: 'First question', role: 'user' },
+        { content: 'Answer', role: 'assistant' },
+        { content: 'Second question', role: 'user' },
+      ]);
+
+      const result = await provider.process(context);
+
+      expect(result.messages[0].content).toContain('<test>');
+      expect(result.messages[0].content).toContain('First only');
+      expect(result.messages[2].content).toBe('Second question');
+    });
+
+    it('should update metadata with injection count', async () => {
+      const provider = new TestEveryUserContentProvider();
+      const context = createContext([
+        { content: 'First', role: 'user' },
+        { content: 'Second', role: 'user' },
+        { content: 'Third', role: 'user' },
+      ]);
+
+      const result = await provider.process(context);
+
+      expect(result.metadata.TestEveryUserContentProviderInjectedCount).toBe(3);
+    });
+
+    it('should not set metadata when no injections made', async () => {
+      const provider = new TestEveryUserContentProvider(() => null);
+      const context = createContext([{ content: 'Question', role: 'user' }]);
+
+      const result = await provider.process(context);
+
+      expect(result.metadata.TestEveryUserContentProviderInjectedCount).toBeUndefined();
+    });
+  });
+
+  describe('integration with BaseLastUserContentProvider', () => {
+    it('should allow BaseLastUserContentProvider to reuse wrapper created by BaseEveryUserContentProvider', async () => {
+      // First: BaseEveryUserContentProvider injects to last user message
+      const everyProvider = new TestEveryUserContentProvider((message, index, isLastUser) => {
+        if (isLastUser) {
+          return { content: 'Selection content', contextType: 'user_selections' };
+        }
+        return null;
+      });
+
+      const context = createContext([
+        { content: 'First question', role: 'user' },
+        { content: 'Answer', role: 'assistant' },
+        { content: 'Last question', role: 'user' },
+      ]);
+
+      const result = await everyProvider.process(context);
+
+      // The last user message should have a SYSTEM CONTEXT wrapper
+      const lastUserContent = result.messages[2].content as string;
+      expect(lastUserContent).toContain('<!-- SYSTEM CONTEXT (NOT PART OF USER QUERY) -->');
+      expect(lastUserContent).toContain('<user_selections>');
+      expect(lastUserContent).toContain('Selection content');
+      expect(lastUserContent).toContain('<!-- END SYSTEM CONTEXT -->');
+
+      // Now BaseLastUserContentProvider can detect and reuse this wrapper
+      expect(everyProvider.testHasSystemContextWrapper(lastUserContent)).toBe(true);
+    });
+  });
+});

package/packages/context-engine/src/base/constants.ts

@@ -0,0 +1,20 @@
+/**
+ * Shared constants for context injection
+ */
+
+/**
+ * System context wrapper markers
+ * Used to wrap injected context content so models can distinguish it from user content
+ */
+export const SYSTEM_CONTEXT_START = '<!-- SYSTEM CONTEXT (NOT PART OF USER QUERY) -->';
+export const SYSTEM_CONTEXT_END = '<!-- END SYSTEM CONTEXT -->';
+
+/**
+ * Context instruction text
+ * Provides guidance to the model on how to handle injected context
+ */
+export const CONTEXT_INSTRUCTION = `<context.instruction>following part contains context information injected by the system. Please follow these instructions:
+
+1. Always prioritize handling user-visible content.
+2. the context is only required when user's queries rely on it.
+</context.instruction>`;

package/packages/context-engine/src/engine/messages/MessagesEngine.ts

@@ -28,6 +28,7 @@ import {
   HistorySummaryProvider,
   KnowledgeInjector,
   PageEditorContextInjector,
+  PageSelectionsInjector,
   SystemRoleInjector,
   ToolSystemRoleProvider,
   UserMemoryInjector,
@@ -143,19 +144,19 @@ export class MessagesEngine {
 
     return [
       // =============================================
-      // Phase 2: System Role Injection
+      // Phase 1: System Role Injection
       // =============================================
 
-      // 2. System role injection (agent's system role)
+      // 1. System role injection (agent's system role)
       new SystemRoleInjector({ systemRole }),
 
       // =============================================
-      // Phase 2.5: First User Message Context Injection
+      // Phase 2: First User Message Context Injection
       // These providers inject content before the first user message
       // Order matters: first executed = first in content
       // =============================================
 
-      // 4. User memory injection (conditionally added, injected first)
+      // 2. User memory injection (conditionally added, injected first)
       ...(isUserMemoryEnabled ? [new UserMemoryInjector(userMemory)] : []),
 
       // 3. Group context injection (agent identity and group info for multi-agent chat)
@@ -169,7 +170,7 @@ export class MessagesEngine {
         systemPrompt: agentGroup?.systemPrompt,
       }),
 
-      // 4.5. GTD Plan injection (conditionally added, after user memory, before knowledge)
+      // 4. GTD Plan injection (conditionally added, after user memory, before knowledge)
       ...(isGTDPlanEnabled ? [new GTDPlanInjector({ enabled: true, plan: gtd.plan })] : []),
 
       // 5. Knowledge injection (full content for agent files + metadata for knowledge bases)
@@ -179,7 +180,7 @@ export class MessagesEngine {
       }),
 
       // =============================================
-      // Phase 2.6: Additional System Context
+      // Phase 3: Additional System Context
       // =============================================
 
       // 6. Agent Builder context injection (current agent config/meta for editing)
@@ -212,7 +213,10 @@ export class MessagesEngine {
         historySummary,
       }),
 
-      // 10. Page Editor context injection
+      // 12. Page Selections injection (inject user-selected text into each user message that has them)
+      new PageSelectionsInjector({ enabled: isPageEditorEnabled }),
+
+      // 10. Page Editor context injection (inject current page content to last user message)
       new PageEditorContextInjector({
         enabled: isPageEditorEnabled,
         // Use direct pageContentContext if provided (server-side), otherwise build from initialContext + stepContext (frontend)
@@ -232,37 +236,37 @@ export class MessagesEngine {
             : undefined,
       }),
 
-      // 10.5. GTD Todo injection (conditionally added, at end of last user message)
+      // 11. GTD Todo injection (conditionally added, at end of last user message)
       ...(isGTDTodoEnabled ? [new GTDTodoInjector({ enabled: true, todos: gtd.todos })] : []),
 
       // =============================================
-      // Phase 3: Message Transformation
+      // Phase 4: Message Transformation
       // =============================================
 
-      // 11. Input template processing
+      // 13. Input template processing
       new InputTemplateProcessor({ inputTemplate }),
 
-      // 11. Placeholder variables processing
+      // 14. Placeholder variables processing
       new PlaceholderVariablesProcessor({
         variableGenerators: variableGenerators || {},
       }),
 
-      // 12. AgentCouncil message flatten (convert role=agentCouncil to standard assistant + tool messages)
+      // 15. AgentCouncil message flatten (convert role=agentCouncil to standard assistant + tool messages)
       new AgentCouncilFlattenProcessor(),
 
-      // 13. Group message flatten (convert role=assistantGroup to standard assistant + tool messages)
+      // 16. Group message flatten (convert role=assistantGroup to standard assistant + tool messages)
       new GroupMessageFlattenProcessor(),
 
-      // 14. Tasks message flatten (convert role=tasks to individual task messages)
+      // 17. Tasks message flatten (convert role=tasks to individual task messages)
       new TasksFlattenProcessor(),
 
-      // 15. Task message processing (convert role=task to assistant with instruction + content)
+      // 18. Task message processing (convert role=task to assistant with instruction + content)
       new TaskMessageProcessor(),
 
-      // 15. Supervisor role restore (convert role=supervisor back to role=assistant for model)
+      // 19. Supervisor role restore (convert role=supervisor back to role=assistant for model)
       new SupervisorRoleRestoreProcessor(),
 
-      // 15.5. Group orchestration filter (remove supervisor's orchestration messages like broadcast/speak)
+      // 20. Group orchestration filter (remove supervisor's orchestration messages like broadcast/speak)
       // This must be BEFORE GroupRoleTransformProcessor so we filter based on original agentId/tools
       ...(isAgentGroupEnabled && agentGroup.agentMap && agentGroup.currentAgentId
         ? [
@@ -277,7 +281,7 @@ export class MessagesEngine {
           ]
         : []),
 
-      // 16. Group role transform (convert other agents' messages to user role with speaker tags)
+      // 21. Group role transform (convert other agents' messages to user role with speaker tags)
       // This must be BEFORE ToolCallProcessor so other agents' tool messages are converted first
       ...(isAgentGroupEnabled && agentGroup.currentAgentId
         ? [
@@ -289,10 +293,10 @@ export class MessagesEngine {
         : []),
 
       // =============================================
-      // Phase 4: Content Processing
+      // Phase 5: Content Processing
       // =============================================
 
-      // 17. Message content processing (image encoding, etc.)
+      // 22. Message content processing (image encoding, etc.)
       new MessageContentProcessor({
         fileContext: fileContext || { enabled: true, includeFileUrl: true },
         isCanUseVideo: capabilities?.isCanUseVideo || (() => false),
@@ -301,7 +305,7 @@ export class MessagesEngine {
         provider,
       }),
 
-      // 18. Tool call processing
+      // 23. Tool call processing
       new ToolCallProcessor({
         genToolCallingName: this.toolNameResolver.generate.bind(this.toolNameResolver),
         isCanUseFC: capabilities?.isCanUseFC || (() => true),
@@ -309,10 +313,10 @@ export class MessagesEngine {
         provider,
       }),
 
-      // 19. Tool message reordering
+      // 24. Tool message reordering
       new ToolMessageReorder(),
 
-      // 20. Message cleanup (final step, keep only necessary fields)
+      // 25. Message cleanup (final step, keep only necessary fields)
       new MessageCleanupProcessor(),
     ];
   }