feat(mongodb): auto append client metadata for mongodb (langchain-ai#8819)

Author: durran

.changeset/mighty-moments-know.md

@@ -0,0 +1,5 @@
+---
+"@langchain/mongodb": minor
+---
+
+Updates the mongodb vector search, memory, and chat history modules to append client metadata

examples/src/memory/mongodb.ts

@@ -4,9 +4,7 @@ import { ChatOpenAI } from "@langchain/openai";
 import { ConversationChain } from "langchain/chains";
 import { MongoDBChatMessageHistory } from "@langchain/mongodb";
 
-const client = new MongoClient(process.env.MONGODB_ATLAS_URI || "", {
-  driverInfo: { name: "langchainjs" },
-});
+const client = new MongoClient(process.env.MONGODB_ATLAS_URI || "");
 await client.connect();
 const collection = client.db("langchain").collection("memory");
 

libs/langchain-mongodb/package.json

@@ -32,7 +32,7 @@
   "author": "LangChain",
   "license": "MIT",
   "dependencies": {
-    "mongodb": "^6.17.0"
+    "mongodb": "^6.20.0"
   },
   "peerDependencies": {
     "@langchain/core": ">=0.2.21 <0.4.0"

libs/langchain-mongodb/src/chat_history.ts

@@ -40,6 +40,9 @@ export class MongoDBChatMessageHistory extends BaseListChatMessageHistory {
     super();
     this.collection = collection;
     this.sessionId = sessionId;
+    this.collection.db.client.appendMetadata({
+      name: "langchainjs_chat_history",
+    });
   }
 
   async getMessages(): Promise<BaseMessage[]> {

libs/langchain-mongodb/src/storage.ts

@@ -65,6 +65,9 @@ export class MongoDBStore extends BaseStore<string, Uint8Array> {
     this.yieldKeysScanBatchSize =
       fields.yieldKeysScanBatchSize ?? this.yieldKeysScanBatchSize;
     this.namespace = fields.namespace;
+    this.collection.db.client.appendMetadata({
+      name: "langchainjs_storage",
+    });
   }
 
   _getPrefixedKey(key: string) {

libs/langchain-mongodb/src/tests/chat_history.int.test.ts

@@ -1,5 +1,5 @@
 /* eslint-disable no-process-env */
-
+import { beforeAll, expect, test } from "@jest/globals";
 import { Collection, MongoClient, ObjectId } from "mongodb";
 import { AIMessage, HumanMessage } from "@langchain/core/messages";
 import { MongoDBChatMessageHistory } from "../chat_history.js";

libs/langchain-mongodb/src/tests/storage.int.test.ts

@@ -1,4 +1,5 @@
 /* eslint-disable no-process-env */
+import { beforeAll, expect, test } from "@jest/globals";
 import { v4 as uuidv4 } from "uuid";
 import { Collection, MongoClient, ServerApiVersion } from "mongodb";
 import { MongoDBStore } from "../storage.js";

libs/langchain-mongodb/src/tests/vectorstores.int.test.ts

@@ -113,6 +113,16 @@ function getEmbeddings() {
   return new OpenAIEmbeddings();
 }
 
+test("MongoDBStore sets client metadata", () => {
+  const spy = jest.spyOn(client, "appendMetadata");
+  // eslint-disable-next-line no-new
+  new PatchedVectorStore(getEmbeddings(), {
+    collection,
+  });
+  expect(spy).toHaveBeenCalledWith({ name: "langchainjs_vector" });
+  jest.clearAllMocks();
+});
+
 test("MongoDBAtlasVectorSearch with external ids", async () => {
   const vectorStore = new PatchedVectorStore(getEmbeddings(), {
     collection,

libs/langchain-mongodb/src/vectorstores.ts

@@ -79,6 +79,9 @@ export class MongoDBAtlasVectorSearch extends VectorStore {
     this.embeddingKey = args.embeddingKey ?? "embedding";
     this.primaryKey = args.primaryKey ?? "_id";
     this.caller = new AsyncCaller(args);
+    this.collection.db.client.appendMetadata({
+      name: "langchainjs_vector",
+    });
   }
 
   /**

libs/langchain-mongodb/tsconfig.json

@@ -15,6 +15,7 @@
     "noUnusedParameters": true,
     "useDefineForClassFields": true,
     "strictPropertyInitialization": false,
+    "resolveJsonModule": true,
     "allowJs": true,
     "strict": true
   },