Skip to content

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

🔎 fix: Specify Explicit Primary Key for Meilisearch Document Operations (#12542)

Danny Avila33ee7dea1e48
diff --git a/packages/data-schemas/src/models/plugins/mongoMeili.spec.ts b/packages/data-schemas/src/models/plugins/mongoMeili.spec.ts
index b1d3e24129..1d341a7939 100644
--- a/packages/data-schemas/src/models/plugins/mongoMeili.spec.ts
+++ b/packages/data-schemas/src/models/plugins/mongoMeili.spec.ts
@@ -73,7 +73,10 @@ describe('Meilisearch Mongoose plugin', () => {
title: 'Test Conversation',
endpoint: EModelEndpoint.openAI,
});
- expect(mockAddDocuments).toHaveBeenCalled();
+ expect(mockAddDocuments).toHaveBeenCalledWith(
+ [expect.objectContaining({ conversationId: expect.anything() })],
+ { primaryKey: 'conversationId' },
+ );
});
test('saving conversation indexes with expiredAt=null w/ meilisearch', async () => {
@@ -105,7 +108,10 @@ describe('Meilisearch Mongoose plugin', () => {
user: new mongoose.Types.ObjectId(),
isCreatedByUser: true,
});
- expect(mockAddDocuments).toHaveBeenCalled();
+ expect(mockAddDocuments).toHaveBeenCalledWith(
+ [expect.objectContaining({ messageId: expect.anything() })],
+ { primaryKey: 'messageId' },
+ );
});
test('saving messages with expiredAt=null indexes w/ meilisearch', async () => {
@@ -130,6 +136,87 @@ describe('Meilisearch Mongoose plugin', () => {
expect(mockAddDocuments).not.toHaveBeenCalled();
});
+ test('updating an indexed conversation calls updateDocuments with primaryKey', async () => {
+ const conversationModel = createConversationModel(mongoose);
+ const convo = await conversationModel.create({
+ conversationId: new mongoose.Types.ObjectId().toString(),
+ user: new mongoose.Types.ObjectId(),
+ title: 'Original Title',
+ endpoint: EModelEndpoint.openAI,
+ });
+ mockUpdateDocuments.mockClear();
+
+ convo._meiliIndex = true;
+ convo.title = 'Updated Title';
+ await convo.save();
+
+ expect(mockUpdateDocuments).toHaveBeenCalledWith(
+ [expect.objectContaining({ conversationId: expect.anything() })],
+ { primaryKey: 'conversationId' },
+ );
+ });
+
+ test('updating an indexed message calls updateDocuments with primaryKey: messageId', async () => {
+ const messageModel = createMessageModel(mongoose);
+ const msg = await messageModel.create({
+ messageId: new mongoose.Types.ObjectId().toString(),
+ conversationId: new mongoose.Types.ObjectId(),
+ user: new mongoose.Types.ObjectId(),
+ isCreatedByUser: true,
+ });
+ mockUpdateDocuments.mockClear();
+
+ msg._meiliIndex = true;
+ msg.text = 'Updated text';
+ await msg.save();
+
+ expect(mockUpdateDocuments).toHaveBeenCalledWith(
+ [expect.objectContaining({ messageId: expect.anything() })],
+ { primaryKey: 'messageId' },
+ );
+ });
+
+ test('deleteObjectFromMeili calls deleteDocument with messageId, not _id', async () => {
+ const messageModel = createMessageModel(mongoose);
+ const msgId = new mongoose.Types.ObjectId().toString();
+ const msg = await messageModel.create({
+ messageId: msgId,
+ conversationId: new mongoose.Types.ObjectId(),
+ user: new mongoose.Types.ObjectId(),
+ isCreatedByUser: true,
+ });
+ mockDeleteDocument.mockClear();
+
+ const typedMsg = msg as unknown as import('./mongoMeili').DocumentWithMeiliIndex;
+ await new Promise<void>((resolve, reject) => {
+ typedMsg.deleteObjectFromMeili!((err) => (err ? reject(err) : resolve()));
+ });
+
+ expect(mockDeleteDocument).toHaveBeenCalledWith(msgId);
+ expect(mockDeleteDocument).not.toHaveBeenCalledWith(String(msg._id));
+ });
+
+ test('updateDocuments receives preprocessed data with primaryKey', async () => {
+ const conversationModel = createConversationModel(mongoose);
+ const conversationId = 'abc|def|ghi';
+ const convo = await conversationModel.create({
+ conversationId,
+ user: new mongoose.Types.ObjectId(),
+ title: 'Pipe Test',
+ endpoint: EModelEndpoint.openAI,
+ });
+ mockUpdateDocuments.mockClear();
+
+ convo._meiliIndex = true;
+ convo.title = 'Updated Pipe Test';
+ await convo.save();
+
+ expect(mockUpdateDocuments).toHaveBeenCalledWith(
+ [expect.objectContaining({ conversationId: 'abc--def--ghi' })],
+ { primaryKey: 'conversationId' },
+ );
+ });
+
test('sync w/ meili does not include TTL documents', async () => {
const conversationModel = createConversationModel(mongoose) as SchemaWithMeiliMethods;
await conversationModel.create({
@@ -299,8 +386,10 @@ describe('Meilisearch Mongoose plugin', () => {
// Run sync which should call processSyncBatch internally
await conversationModel.syncWithMeili();
- // Verify addDocumentsInBatches was called (new batch method)
- expect(mockAddDocumentsInBatches).toHaveBeenCalled();
+ // Verify addDocumentsInBatches was called with explicit primaryKey
+ expect(mockAddDocumentsInBatches).toHaveBeenCalledWith(expect.any(Array), undefined, {
+ primaryKey: 'conversationId',
+ });
});
test('addObjectToMeili retries on failure', async () => {
diff --git a/packages/data-schemas/src/models/plugins/mongoMeili.ts b/packages/data-schemas/src/models/plugins/mongoMeili.ts
index cc01dbb6c7..125e7bab71 100644
--- a/packages/data-schemas/src/models/plugins/mongoMeili.ts
+++ b/packages/data-schemas/src/models/plugins/mongoMeili.ts
@@ -94,7 +94,7 @@ const getSyncConfig = () => ({
* Validates the required options for configuring the mongoMeili plugin.
*/
const validateOptions = (options: Partial<MongoMeiliOptions>): void => {
- const requiredKeys: (keyof MongoMeiliOptions)[] = ['host', 'apiKey', 'indexName'];
+ const requiredKeys: (keyof MongoMeiliOptions)[] = ['host', 'apiKey', 'indexName', 'primaryKey'];
requiredKeys.forEach((key) => {
if (!options[key]) {
throw new Error(`Missing mongoMeili Option: ${key}`);
@@ -130,19 +130,21 @@ const processBatch = async <T>(
* @param config - Configuration object.
* @param config.index - The MeiliSearch index object.
* @param config.attributesToIndex - List of attributes to index.
+ * @param config.primaryKey - The primary key field for MeiliSearch document operations.
* @param config.syncOptions - Sync configuration options.
* @returns A class definition that will be loaded into the Mongoose schema.
*/
const createMeiliMongooseModel = ({
index,
attributesToIndex,
+ primaryKey,
syncOptions,
}: {
index: Index<MeiliIndexable>;
attributesToIndex: string[];
+ primaryKey: string;
syncOptions: { batchSize: number; delayMs: number };
}) => {
- const primaryKey = attributesToIndex[0];
const syncConfig = { ...getSyncConfig(), ...syncOptions };
class MeiliMongooseModel {
@@ -255,7 +257,7 @@ const createMeiliMongooseModel = ({
try {
// Add documents to MeiliSearch
- await index.addDocumentsInBatches(formattedDocs);
+ await index.addDocumentsInBatches(formattedDocs, undefined, { primaryKey });
// Update MongoDB to mark documents as indexed.
// { timestamps: false } prevents Mongoose from touching updatedAt, preserving
@@ -422,7 +424,7 @@ const createMeiliMongooseModel = ({
while (retryCount < maxRetries) {
try {
- await index.addDocuments([object]);
+ await index.addDocuments([object], { primaryKey });
break;
} catch (error) {
retryCount++;
@@ -436,7 +438,8 @@ const createMeiliMongooseModel = ({
}
try {
- await this.collection.updateMany(
+ // eslint-disable-next-line no-restricted-syntax -- _meiliIndex is an internal bookkeeping flag, not tenant-scoped data
+ await this.collection.updateOne(
{ _id: this._id as Types.ObjectId },
{ $set: { _meiliIndex: true } },
);
@@ -456,10 +459,8 @@ const createMeiliMongooseModel = ({
next: CallbackWithoutResultAndOptionalError,
): Promise<void> {
try {
- const object = _.omitBy(_.pick(this.toJSON(), attributesToIndex), (v, k) =>
- k.startsWith('$'),
- );
- await index.updateDocuments([object]);
+ const object = this.preprocessObjectForIndex!();
+ await index.updateDocuments([object], { primaryKey });
next();
} catch (error) {
logger.error('[updateObjectToMeili] Error updating document in Meili:', error);
@@ -477,7 +478,7 @@ const createMeiliMongooseModel = ({
next: CallbackWithoutResultAndOptionalError,
): Promise<void> {
try {
- await index.deleteDocument(this._id as string);
+ await index.deleteDocument(String(this[primaryKey as keyof DocumentWithMeiliIndex]));
next();
} catch (error) {
logger.error('[deleteObjectFromMeili] Error deleting document from Meili:', error);
@@ -643,7 +644,7 @@ export default function mongoMeili(schema: Schema, options: MongoMeiliOptions):
logger.debug(`[mongoMeili] Added 'user' field to ${indexName} index attributes`);
}
- schema.loadClass(createMeiliMongooseModel({ index, attributesToIndex, syncOptions }));
+ schema.loadClass(createMeiliMongooseModel({ index, attributesToIndex, primaryKey, syncOptions }));
// Register Mongoose hooks
schema.post('save', function (doc: DocumentWithMeiliIndex, next) {