Enhanced ChatGPT Clone: Features Agents, MCP, Skills, DeepSeek, Anthropic, AWS, OpenAI, Responses API, Azure, Groq, o1, GPT-5, Mistral, OpenRouter, Vertex AI, Gemini, Artifacts, AI model switching, message search, Code Interpreter, langchain, DALL-E-3, OpenAPI Actions, Functions, Secure Multi-User Auth, Presets, open-source for self-hosting. Active
TypeScript aianthropicartifactsawsazurechatgptchatgpt-cloneclaudeclonedeepseekgeminigooglegpt-5librechatmcpo1openairesponses-apivisionwebui
⚡ perf: Append Saved Message Ids Instead of Rebuilding the Conversation Array (#15141)
Danny Avilad8645977310c
diff --git a/api/app/clients/BaseClient.js b/api/app/clients/BaseClient.jsindex 1cacd4666e..839a135aed 100644--- a/api/app/clients/BaseClient.js+++ b/api/app/clients/BaseClient.js@@ -1315,6 +1315,7 @@ class BaseClient {unsetFields,noUpsert: req?._agentEventBindingParentConversationId != null,createdAtOnInsert: shouldSetCreatedAtOnInsert ? validCreatedAtOnInsert : undefined,+ ...(savedMessage?._id != null ? { appendMessageIds: [savedMessage._id] } : {}),});return { message: savedMessage, conversation };diff --git a/api/app/clients/specs/BaseClient.test.js b/api/app/clients/specs/BaseClient.test.jsindex bf0e025926..3bb7f57e63 100644--- a/api/app/clients/specs/BaseClient.test.js+++ b/api/app/clients/specs/BaseClient.test.js@@ -1871,6 +1871,36 @@ describe('BaseClient', () => {);});+ test('saveMessageToDatabase appends the saved message id instead of rebuilding the array', async () => {+ const savedId = new (require('mongoose').Types.ObjectId)();+ saveMessage.mockResolvedValueOnce({ _id: savedId, messageId: 'saved-1' });+ saveConvo.mockResolvedValueOnce({ conversationId });++ await TestClient.saveMessageToDatabase(+ { messageId: 'saved-1', conversationId, text: 'hi' },+ TestClient.getSaveOptions(),+ );++ expect(saveConvo).toHaveBeenCalledWith(+ expect.anything(),+ expect.anything(),+ expect.objectContaining({ appendMessageIds: [savedId] }),+ );+ });++ test('saveMessageToDatabase rebuilds the array when the saved message has no _id', async () => {+ saveMessage.mockResolvedValueOnce({ messageId: 'saved-2' });+ saveConvo.mockResolvedValueOnce({ conversationId });++ await TestClient.saveMessageToDatabase(+ { messageId: 'saved-2', conversationId, text: 'hi' },+ TestClient.getSaveOptions(),+ );++ const metadata = saveConvo.mock.calls[saveConvo.mock.calls.length - 1][2];+ expect(metadata).not.toHaveProperty('appendMessageIds');+ });+test('saveMessageToDatabase returns early when this.options is null (client disposed)', async () => {const savedOptions = TestClient.options;TestClient.options = null;diff --git a/api/server/routes/__tests__/messages-get.spec.js b/api/server/routes/__tests__/messages-get.spec.jsindex 2fede91f9b..d44afc9486 100644--- a/api/server/routes/__tests__/messages-get.spec.js+++ b/api/server/routes/__tests__/messages-get.spec.js@@ -443,7 +443,10 @@ describe('message route conversation ownership filters', () => {model: savedMessage.model,iconURL: savedMessage.iconURL,},- { context: 'POST /api/messages/:conversationId' },+ {+ context: 'POST /api/messages/:conversationId',+ appendMessageIds: [savedMessage._id],+ },);});diff --git a/api/server/routes/messages.js b/api/server/routes/messages.jsindex 8a0a5d9c94..b54986f761 100644--- a/api/server/routes/messages.js+++ b/api/server/routes/messages.js@@ -504,6 +504,7 @@ router.post('/:conversationId', storedMessageMutationMiddleware, async (req, res};await db.saveConvo(reqCtx, conversationUpdate, {context: 'POST /api/messages/:conversationId',+ ...(savedMessage._id != null ? { appendMessageIds: [savedMessage._id] } : {}),});res.status(201).json(savedMessage);} catch (error) {diff --git a/packages/api/src/agents/guard.ts b/packages/api/src/agents/guard.tsindex 51dab509d7..0f4ea3fc95 100644--- a/packages/api/src/agents/guard.ts+++ b/packages/api/src/agents/guard.ts@@ -51,6 +51,15 @@ interface ResolvedConversationRequest extends Request {_agentEventBindingTenantId?: string;}+/**+ * Brands the lineage-only conversation `isBoundEventContinuation` synthesizes: it stands in+ * for binding checks but carries none of the stored document's optional fields, so readers+ * of `req.resolvedConversation` must not treat its absent fields as authoritative.+ */+export const PARTIAL_RESOLVED_CONVERSATION: unique symbol = Symbol.for(+ 'librechat.resolvedConversation.partial',+);+function applyEventBindingContext(request: ResolvedConversationRequest,conversation: IConversation,@@ -102,6 +111,7 @@ async function isBoundEventContinuation(return null;}return {+ [PARTIAL_RESOLVED_CONVERSATION]: true,conversationId: binding.conversationId,agent_id: binding.agentId,...(binding.tenantId == null ? {} : { tenantId: binding.tenantId }),diff --git a/packages/api/src/agents/initialize.files.spec.ts b/packages/api/src/agents/initialize.files.spec.tsindex 9cf553641b..45045fb7b0 100644--- a/packages/api/src/agents/initialize.files.spec.ts+++ b/packages/api/src/agents/initialize.files.spec.ts@@ -1,4 +1,6 @@+import type { IConversation } from '@librechat/data-schemas';import { readResolvedConversationFiles } from './initialize';+import { PARTIAL_RESOLVED_CONVERSATION } from './guard';describe('readResolvedConversationFiles', () => {const conversationId = 'conversation-1';@@ -28,12 +30,23 @@ describe('readResolvedConversationFiles', () => {).toEqual([]);});- it('falls back to the database when the resolved document omits files or is another conversation', () => {+ it('treats a stored document without files as having none', () => {expect(readResolvedConversationFiles(- { resolvedConversation: { conversationId, agent_id: 'child-agent' } },+ { resolvedConversation: { conversationId, title: 'no uploads yet' } },conversationId,),+ ).toEqual([]);+ });++ it('falls back to the database for a branded lineage-only partial or another conversation', () => {+ const lineageOnly = {+ [PARTIAL_RESOLVED_CONVERSATION]: true,+ conversationId,+ agent_id: 'child-agent',+ } as unknown as IConversation;+ expect(+ readResolvedConversationFiles({ resolvedConversation: lineageOnly }, conversationId),).toBeUndefined();expect(readResolvedConversationFiles(diff --git a/packages/api/src/agents/initialize.ts b/packages/api/src/agents/initialize.tsindex c831f34e20..2a1fcdbdc9 100644--- a/packages/api/src/agents/initialize.ts+++ b/packages/api/src/agents/initialize.ts@@ -94,6 +94,7 @@ import { assertModelBoundContent } from '../middleware/modelBoundContent';import { registerMemoryTools, memoryToolUsageGuard } from './memory';import { applyIntentLabels, sanitizeIntentLabels } from './intent';import { ContentFilterError } from '../middleware/contentFilter';+import { PARTIAL_RESOLVED_CONVERSATION } from './guard';import { applyBackgroundToolCalls } from './background';import { filterFilesByEndpointConfig } from '~/files';import { generateArtifactsPrompt } from '~/prompts';@@ -190,8 +191,8 @@ function appendAdditionalInstructions(agent: Agent, text?: string | null): void/*** The request middleware already read this conversation once (`null` = looked up, absent).- * Only a resolved document that actually carries `files` can stand in for the database:- * bound agent-event continuations stash a partial document built from lineage alone.+ * A stored document without `files` genuinely has none; only the branded lineage-only+ * partial from a bound agent-event continuation cannot speak for the database.*/export function readResolvedConversationFiles(req: Pick<ServerRequest, 'resolvedConversation'>,@@ -207,7 +208,7 @@ export function readResolvedConversationFiles(if (resolved == null ||resolved.conversationId !== conversationId ||- !Object.prototype.hasOwnProperty.call(resolved, 'files')+ (resolved as Record<symbol, unknown>)[PARTIAL_RESOLVED_CONVERSATION] === true) {return undefined;}diff --git a/packages/data-schemas/src/methods/conversation.spec.ts b/packages/data-schemas/src/methods/conversation.spec.tsindex 637613aa88..6b05d1a1f8 100644--- a/packages/data-schemas/src/methods/conversation.spec.ts+++ b/packages/data-schemas/src/methods/conversation.spec.ts@@ -961,6 +961,85 @@ describe('Conversation Operations', () => {});});+ describe('saveConvo appendMessageIds', () => {+ const ctx = { userId: 'append-user' };+ const conversationId = 'append-conversation';++ beforeEach(async () => {+ await Conversation.deleteMany({ user: ctx.userId });+ getMessages.mockClear();+ });++ it('appends the provided ids without reading the messages collection', async () => {+ const seeded = [new mongoose.Types.ObjectId(), new mongoose.Types.ObjectId()];+ getMessages.mockResolvedValueOnce(seeded.map((_id) => ({ _id })));+ await saveConvo(ctx, { conversationId, title: 'seeded' });+ expect(getMessages).toHaveBeenCalledTimes(1);++ const appended = new mongoose.Types.ObjectId();+ const result = await saveConvo(+ ctx,+ { conversationId, title: 'appended' },+ { appendMessageIds: [appended] },+ );++ expect(getMessages).toHaveBeenCalledTimes(1);+ expect(result?.title).toBe('appended');+ const stored = await Conversation.findOne({ conversationId }).lean();+ expect(stored?.messages?.map(String)).toEqual([...seeded, appended].map(String));+ });++ it('does not duplicate an id that is already recorded', async () => {+ const id = new mongoose.Types.ObjectId();+ await saveConvo(ctx, { conversationId }, { appendMessageIds: [id] });+ await saveConvo(ctx, { conversationId }, { appendMessageIds: [id] });++ const stored = await Conversation.findOne({ conversationId }).lean();+ expect(stored?.messages?.map(String)).toEqual([String(id)]);+ expect(getMessages).not.toHaveBeenCalled();+ });++ it('creates the conversation with the appended id when it does not exist yet', async () => {+ const id = new mongoose.Types.ObjectId();+ const result = await saveConvo(+ ctx,+ { conversationId, title: 'first turn' },+ { appendMessageIds: [id] },+ );++ expect(result?.conversationId).toBe(conversationId);+ const stored = await Conversation.findOne({ conversationId }).lean();+ expect(stored?.messages?.map(String)).toEqual([String(id)]);+ expect(getMessages).not.toHaveBeenCalled();+ });++ it('ignores a caller-supplied messages field so $set cannot conflict with the append', async () => {+ const kept = new mongoose.Types.ObjectId();+ await saveConvo(ctx, { conversationId }, { appendMessageIds: [kept] });++ const appended = new mongoose.Types.ObjectId();+ await saveConvo(+ ctx,+ { conversationId, messages: [new mongoose.Types.ObjectId()] },+ { appendMessageIds: [appended] },+ );++ const stored = await Conversation.findOne({ conversationId }).lean();+ expect(stored?.messages?.map(String)).toEqual([kept, appended].map(String));+ });++ it('still rebuilds the array from the database when the option is absent', async () => {+ const rebuilt = [new mongoose.Types.ObjectId()];+ getMessages.mockResolvedValueOnce(rebuilt.map((_id) => ({ _id })));++ await saveConvo(ctx, { conversationId, title: 'rebuild' });++ expect(getMessages).toHaveBeenCalledWith({ conversationId, user: ctx.userId }, '_id');+ const stored = await Conversation.findOne({ conversationId }).lean();+ expect(stored?.messages?.map(String)).toEqual(rebuilt.map(String));+ });+ });+describe('isTemporary conversation handling', () => {it('should save a conversation with expiredAt when isTemporary is true', async () => {mockCtx.interfaceConfig = { temporaryChatRetention: 24 };diff --git a/packages/data-schemas/src/methods/conversation.ts b/packages/data-schemas/src/methods/conversation.tsindex f756075f80..f81e0737fc 100644--- a/packages/data-schemas/src/methods/conversation.ts+++ b/packages/data-schemas/src/methods/conversation.ts@@ -137,6 +137,10 @@ export interface ConversationMethods {noUpsert?: boolean;createdAtOnInsert?: Date;preserveUpdatedAt?: boolean;+ /** `_id`s of messages this save just wrote. When present, they are appended with+ * `$addToSet` and the O(n) read-and-rewrite of the `messages` array is skipped;+ * every save without this option still rebuilds the array from the database. */+ appendMessageIds?: Types.ObjectId[];},): Promise<IConversation | { message: string } | null>;setConvoPinned(@@ -649,6 +653,7 @@ export function createConversationMethods(noUpsert?: boolean;createdAtOnInsert?: Date;preserveUpdatedAt?: boolean;+ appendMessageIds?: Types.ObjectId[];},) {try {@@ -659,8 +664,13 @@ export function createConversationMethods(logger.debug(`[saveConvo] ${metadata.context}`);}- const messages = await getMessages({ conversationId, user: userId }, '_id');- const update: Record<string, unknown> = { ...convo, messages, user: userId };+ const appendMessageIds = metadata?.appendMessageIds;+ const update: Record<string, unknown> = { ...convo, user: userId };+ if (appendMessageIds == null) {+ update.messages = await getMessages({ conversationId, user: userId }, '_id');+ } else {+ delete update.messages;+ }const unsetFields: Record<string, number> = { ...(metadata?.unsetFields ?? {}) };if (Object.prototype.hasOwnProperty.call(update, 'chatProjectId') && update.chatProjectId) {@@ -750,6 +760,9 @@ export function createConversationMethods(const buildOperation = (setFields: Record<string, unknown>) => {const operation: Record<string, unknown> = { $set: setFields };+ if (appendMessageIds != null && appendMessageIds.length > 0) {+ operation.$addToSet = { messages: { $each: appendMessageIds } };+ }if (Object.keys(unsetFields).length > 0) {operation.$unset = unsetFields;}