feat(new-adapter): mongo-db adaptor #1427
Conversation
Added an adaptor which connects to mongo db atlas. Allowing you to store agent data in the cloud. If you have the appropriate tier you can also take advantage of their vector search functionaility.
|
Warning There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure. 🔧 eslint
agent/src/index.tsOops! Something went wrong! :( ESLint: 9.19.0 ESLint couldn't find an eslint.config.(js|mjs|cjs) file. From ESLint v9.0.0, the default configuration file is now eslint.config.js. https://eslint.org/docs/latest/use/configure/migration-guide If you still have problems after following the migration guide, please stop by WalkthroughThis pull request introduces MongoDB as a new database option for the project, adding a comprehensive MongoDB adapter and updating configuration files. The changes include a new Changes
Sequence DiagramsequenceDiagram
participant App as Application
participant Adapter as MongoDB Adapter
participant MongoDB as MongoDB Database
App->>Adapter: Initialize Database
Adapter->>MongoDB: Establish Connection
MongoDB-->>Adapter: Connection Confirmed
Adapter-->>App: Ready for Operations
App->>Adapter: Perform CRUD Operations
Adapter->>MongoDB: Execute Database Commands
MongoDB-->>Adapter: Return Results
Possibly related PRs
Poem
✨ Finishing Touches
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 5
🧹 Nitpick comments (4)
packages/adapter-mongodb/src/index.ts (2)
20-20: Specify a concrete type for 'database' instead of 'any'Using
anydefeats the purpose of TypeScript's type safety. Specify a more precise type fordatabaseto improve type safety and code maintainability.For example:
import { Db } from 'mongodb'; private database: Db;
589-624: Use a standard library for Levenshtein distance calculationImplementing custom algorithms can introduce unnecessary complexity and potential bugs. Using a well-tested library for Levenshtein distance can improve code readability and maintainability.
For example, you can use the
fast-levenshteinpackage:import levenshtein from 'fast-levenshtein'; private calculateLevenshteinDistanceOptimized(str1: string, str2: string): number { return levenshtein.get(str1, str2); }.env.example (2)
413-414: Enhance MongoDB configuration documentation.Add more descriptive comments to guide users:
-MONGODB_CONNECTION_STRING= #mongodb connection string -MONGODB_DATABASE= #name of the database in mongoDB atlas +MONGODB_CONNECTION_STRING= # MongoDB Atlas connection string (format: mongodb+srv://<username>:<password>@<cluster>.mongodb.net) +MONGODB_DATABASE= # Name of the database in MongoDB Atlas (e.g., agent_data)
413-413: Add security note for MongoDB connection string.The connection string contains sensitive credentials. Consider adding a comment about security best practices.
-MONGODB_CONNECTION_STRING= #mongodb connection string +# WARNING: Connection string contains credentials. Never commit actual values to version control. +MONGODB_CONNECTION_STRING= # MongoDB Atlas connection string
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (14)
.env.example(2 hunks).idea/.gitignore(1 hunks).idea/eliza.iml(1 hunks).idea/inspectionProfiles/Project_Default.xml(1 hunks).idea/modules.xml(1 hunks).idea/prettier.xml(1 hunks).idea/vcs.xml(1 hunks)agent/src/index.ts(1 hunks)packages/adapter-mongodb/.npmignore(1 hunks)packages/adapter-mongodb/eslint.config.mjs(1 hunks)packages/adapter-mongodb/package.json(1 hunks)packages/adapter-mongodb/src/index.ts(1 hunks)packages/adapter-mongodb/tsconfig.json(1 hunks)packages/adapter-mongodb/tsup.config.ts(1 hunks)
✅ Files skipped from review due to trivial changes (10)
- .idea/prettier.xml
- .idea/eliza.iml
- packages/adapter-mongodb/.npmignore
- packages/adapter-mongodb/eslint.config.mjs
- .idea/modules.xml
- packages/adapter-mongodb/tsconfig.json
- packages/adapter-mongodb/tsup.config.ts
- .idea/.gitignore
- .idea/vcs.xml
- packages/adapter-mongodb/package.json
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: integration-tests
🔇 Additional comments (1)
packages/adapter-mongodb/src/index.ts (1)
66-66:⚠️ Potential issueCorrect 'expireAfterSeconds' value in TTL index
Setting
expireAfterSeconds: 0in the TTL index may not function as intended, as MongoDB requires a positive integer value. To ensure documents expire correctly based on theexpiresAtfield, you can omitexpireAfterSecondsor set it to a positive integer.Apply this diff to fix the issue:
{ key: { expiresAt: 1 }, options: { - expireAfterSeconds: 0 } }Likely invalid or redundant comment.
|
@coderabbitai review |
✅ Actions performedReview triggered.
|
There was a problem hiding this comment.
Actionable comments posted: 3
♻️ Duplicate comments (1)
packages/adapter-mongodb/src/index.ts (1)
474-481:⚠️ Potential issuePrevent division by zero in
cosineSimilarity
This code can returnInfinityorNaNwhenmagnitudeAormagnitudeBis zero. A guard clause can prevent unexpected runtime errors.const magnitudeA = Math.sqrt(aArr.reduce((sum, val) => sum + val * val, 0)); const magnitudeB = Math.sqrt(bArr.reduce((sum, val) => sum + val * val, 0)); + if (magnitudeA === 0 || magnitudeB === 0) { + return 0; // Or any fallback + } return dotProduct / (magnitudeA * magnitudeB);
🧹 Nitpick comments (6)
packages/adapter-mongodb/src/__tests__/docker-compose.test.yml (2)
12-16: Enhance health check robustness.Consider adding authentication to the health check command to verify the MongoDB credentials are working.
- test: ["CMD", "mongosh", "--eval", "db.adminCommand('ping')"] + test: ["CMD", "mongosh", "--username", "mongodb", "--password", "mongodb", "--eval", "db.adminCommand('ping')"]🧰 Tools
🪛 yamllint (1.35.1)
[error] 16-16: no new line character at the end of file
(new-line-at-end-of-file)
16-16: Add newline at end of file.Add a newline character at the end of the file to comply with POSIX standards and fix the linting error.
🧰 Tools
🪛 yamllint (1.35.1)
[error] 16-16: no new line character at the end of file
(new-line-at-end-of-file)
packages/adapter-mongodb/src/index.ts (1)
42-42: Consider using stronger typings instead ofany.
Definingprivate database: Db(frommongodblibrary) or a more specific interface can improve maintainability.packages/adapter-mongodb/package.json (2)
10-10: Pin the MongoDB driver version.Using
^6.3.0allows minor version updates which could introduce breaking changes. Consider pinning to exact version.- "mongodb": "^6.3.0", + "mongodb": "6.3.0",
26-26: Add coverage threshold to test script.The test script doesn't enforce minimum test coverage requirements.
- "test": "cd src/__tests__ && ./run_tests.sh", + "test": "cd src/__tests__ && ./run_tests.sh --coverage --coverageThreshold='{ \"global\": { \"branches\": 80, \"functions\": 80, \"lines\": 80, \"statements\": 80 } }'",.env.example (1)
19-20: Enhance MongoDB configuration documentation.The MongoDB configuration entries need better documentation of required format and options.
-MONGODB_CONNECTION_STRING= #mongodb connection string -MONGODB_DATABASE= #name of the database in mongoDB atlas #default: 'elizaAgent' +MONGODB_CONNECTION_STRING= # MongoDB connection string (format: mongodb+srv://<username>:<password>@<cluster>.mongodb.net) +MONGODB_DATABASE= # Name of the database in MongoDB Atlas (default: 'elizaAgent'). Must be alphanumeric and start with a letter.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (13)
.env.example(4 hunks).gitignore(1 hunks).vscode/launch.json(0 hunks).vscode/settings.json(0 hunks).vscode/tasks.json(0 hunks)agent/package.json(1 hunks)agent/src/index.ts(4 hunks)packages/adapter-mongodb/package.json(1 hunks)packages/adapter-mongodb/src/__tests__/docker-compose.test.yml(1 hunks)packages/adapter-mongodb/src/__tests__/mongodb-adapter.test.ts(1 hunks)packages/adapter-mongodb/src/__tests__/run_tests.sh(1 hunks)packages/adapter-mongodb/src/index.ts(1 hunks)packages/adapter-mongodb/tsconfig.json(1 hunks)
💤 Files with no reviewable changes (3)
- .vscode/tasks.json
- .vscode/launch.json
- .vscode/settings.json
✅ Files skipped from review due to trivial changes (1)
- .gitignore
🧰 Additional context used
🪛 Biome (1.9.4)
packages/adapter-mongodb/src/index.ts
[error] 1284-1284: Do not add then to an object.
(lint/suspicious/noThenProperty)
[error] 1335-1335: Do not add then to an object.
(lint/suspicious/noThenProperty)
[error] 1342-1342: Do not add then to an object.
(lint/suspicious/noThenProperty)
[error] 1346-1346: Do not add then to an object.
(lint/suspicious/noThenProperty)
🪛 yamllint (1.35.1)
packages/adapter-mongodb/src/__tests__/docker-compose.test.yml
[error] 16-16: no new line character at the end of file
(new-line-at-end-of-file)
⏰ Context from checks skipped due to timeout of 90000ms (2)
- GitHub Check: smoke-tests
- GitHub Check: integration-tests
🔇 Additional comments (6)
packages/adapter-mongodb/src/__tests__/docker-compose.test.yml (1)
1-2: LGTM! Good use of schema validation.The schema validation and Docker Compose version selection are appropriate.
packages/adapter-mongodb/src/index.ts (1)
1283-1350: Ignore thenoThenPropertylint errors on$cond.
These aggregator expressions use MongoDB’s$condsyntax, which legitimately includesthenandelse. Those lint errors are false positives.🧰 Tools
🪛 Biome (1.9.4)
[error] 1284-1284: Do not add then to an object.
(lint/suspicious/noThenProperty)
[error] 1335-1335: Do not add then to an object.
(lint/suspicious/noThenProperty)
[error] 1342-1342: Do not add then to an object.
(lint/suspicious/noThenProperty)
[error] 1346-1346: Do not add then to an object.
(lint/suspicious/noThenProperty)
packages/adapter-mongodb/src/__tests__/mongodb-adapter.test.ts (1)
6-133: Great test coverage.
These tests validate key features of the MongoDB adapter, ensuring knowledge and cache operations work as intended.packages/adapter-mongodb/tsconfig.json (1)
1-24: Configuration looks good.
Makes sense to extend the base config, enforcing strict type checks and ES2021 features for this package.agent/package.json (1)
27-27: LGTM!The MongoDB adapter dependency is correctly added and follows the workspace pattern.
agent/src/index.ts (1)
516-546:⚠️ Potential issueImprove MongoDB initialization and error handling.
The MongoDB initialization has several issues:
- The connection is not properly awaited
- The error handling could be improved
- The connection options should be documented
Apply this diff to fix the issues:
if (process.env.MONGODB_CONNECTION_STRING) { elizaLogger.log("Initializing database on MongoDB Atlas"); const client = new MongoClient(process.env.MONGODB_CONNECTION_STRING, { + // Connection pool settings maxPoolSize: 100, minPoolSize: 5, maxIdleTimeMS: 60000, + // Timeout settings connectTimeoutMS: 10000, serverSelectionTimeoutMS: 5000, socketTimeoutMS: 45000, + // Performance settings compressors: ['zlib'], retryWrites: true, retryReads: true }); const dbName = process.env.MONGODB_DATABASE || 'elizaAgent'; const db = new MongoDBDatabaseAdapter(client, dbName); - // Test the connection - db.init() - .then(() => { - elizaLogger.success( - "Successfully connected to MongoDB Atlas" - ); - }) - .catch((error) => { - elizaLogger.error("Failed to connect to MongoDB Atlas:", error); - throw error; // Re-throw to handle it in the calling code - }); + try { + // Test the connection + await db.init(); + elizaLogger.success("Successfully connected to MongoDB Atlas"); + } catch (error) { + elizaLogger.error("Failed to connect to MongoDB Atlas:", error); + // Close the client on error + await client.close(); + throw error; + } return db;Likely invalid or redundant comment.
Added an adaptor which connects to mongo db atlas. Allowing you to store agent data in the cloud. If you have the appropriate tier you can also take advantage of their vector search functionality.
It should have all the same functionality as the other database adaptors.
Relates to:
Adding the option of using MongoDB in the cloud to store you agents data
Risks
Low, adds additional options for database usage
Background
What does this PR do?
Adds the option to store your agents data in MongoDB Atlas, and take advantage of their vector search. I have also updated the .env.example to include the additional variables for the mongo connection. And added to the agent index with functionality to initialise this database if required.
What kind of change is this?
Adding an additional feature
Why are we doing this? Any context or related work?
In my day job we exclusively use mongoDB for our database needs, for commercials and performance reasons. As we want to develop AI Agents, we need to have the mongoDB adaptor. IN the sprit of OpenSource I wanted to make sure it was available for the whole community to use as well.
Documentation changes needed?
A small additional input to the documentation is required to make users aware of the additional functionality and how it can be actioned.
Similar to the Postgres set up just adding in the appropriate connection string to the .env file will action he change to start using MongoDB as the database.
Testing
Where should a reviewer start?
The reviewer will need to have a least a free account with mongoDB atlas, then add the connection string and a Database name to the .env file. After that the agent should run as expected, saving memories as before. The reviewer can verify the saved data inside the MongoDB interface.
Detailed testing steps
Summary by CodeRabbit
Release Notes
New Features
Configuration Updates
Development Improvements
@elizaos/adapter-mongodbChores