@push.rocks/smartmongo 2.1.0 → 2.2.0

package/dist_ts/00_commitinfo_data.js

@@ -3,7 +3,7 @@
  */
 export const commitinfo = {
     name: '@push.rocks/smartmongo',
-    version: '2.1.0',
+    version: '2.2.0',
     description: 'A module for creating and managing a local MongoDB instance for testing purposes.'
 };
 //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiMDBfY29tbWl0aW5mb19kYXRhLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvMDBfY29tbWl0aW5mb19kYXRhLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBOztHQUVHO0FBQ0gsTUFBTSxDQUFDLE1BQU0sVUFBVSxHQUFHO0lBQ3hCLElBQUksRUFBRSx3QkFBd0I7SUFDOUIsT0FBTyxFQUFFLE9BQU87SUFDaEIsV0FBVyxFQUFFLG1GQUFtRjtDQUNqRyxDQUFBIn0=

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@push.rocks/smartmongo",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "private": false,
   "description": "A module for creating and managing a local MongoDB instance for testing purposes.",
   "main": "dist_ts/index.js",

package/readme.md

@@ -1,104 +1,458 @@
 # @push.rocks/smartmongo
 
-create a local mongodb for testing
+A powerful MongoDB toolkit for testing and development — featuring both a real MongoDB memory server (**SmartMongo**) and an ultra-fast, lightweight wire-protocol-compatible in-memory database server (**CongoDB**). 🚀
 
 ## Install
 
-To start using @push.rocks/smartmongo in your project, you first need to install it via npm. You can do this by running the following command in your terminal:
-
 ```bash
 npm install @push.rocks/smartmongo --save-dev
+# or
+pnpm add -D @push.rocks/smartmongo
+```
+
+## Issue Reporting and Security
+
+For reporting bugs, issues, or security vulnerabilities, please visit [community.foss.global/](https://community.foss.global/). This is the central community hub for all issue reporting. Developers who sign and comply with our contribution agreement and go through identification can also get a [code.foss.global/](https://code.foss.global/) account to submit Pull Requests directly.
+
+## Overview
+
+`@push.rocks/smartmongo` provides two powerful approaches for MongoDB in testing and development:
+
+| Feature | SmartMongo | CongoDB |
+|---------|------------|---------|
+| **Type** | Real MongoDB (memory server) | Pure TypeScript wire protocol server |
+| **Speed** | ~2-5s startup | ⚡ Instant startup (~5ms) |
+| **Compatibility** | 100% MongoDB | MongoDB driver compatible |
+| **Dependencies** | Downloads MongoDB binary | Zero external dependencies |
+| **Replication** | ✅ Full replica set support | Single node emulation |
+| **Use Case** | Integration testing | Unit testing, CI/CD |
+| **Persistence** | Dump to directory | Optional file/memory persistence |
+
+## 🚀 Quick Start
+
+### Option 1: SmartMongo (Real MongoDB)
+
+Spin up a real MongoDB replica set in memory — perfect for integration tests that need full MongoDB compatibility.
+
+```typescript
+import { SmartMongo } from '@push.rocks/smartmongo';
+
+// Start a MongoDB replica set
+const mongo = await SmartMongo.createAndStart();
+
+// Get connection details
+const descriptor = await mongo.getMongoDescriptor();
+console.log(descriptor.mongoDbUrl); // mongodb://127.0.0.1:xxxxx/...
+
+// Use with your MongoDB client or ORM
+// ... run your tests ...
+
+// Clean up
+await mongo.stop();
 ```
 
-This will add `@push.rocks/smartmongo` as a development dependency to your project because it's typically used for testing purposes.
+### Option 2: CongoDB (Wire Protocol Server)
+
+A lightweight, pure TypeScript MongoDB-compatible server that speaks the wire protocol — use the official `mongodb` driver directly!
 
-## Usage
+```typescript
+import { congodb } from '@push.rocks/smartmongo';
+import { MongoClient } from 'mongodb';
+
+// Start CongoDB server
+const server = new congodb.CongoServer({ port: 27017 });
+await server.start();
+
+// Connect with the official MongoDB driver!
+const client = new MongoClient('mongodb://127.0.0.1:27017');
+await client.connect();
 
-The `@push.rocks/smartmongo` package provides a convenient way to spin up a local MongoDB instance, primarily for testing purposes. It's designed to simplify the process of configuring and managing a MongoDB replica set during development or in CI/CD pipelines. Below, we present a comprehensive guide on how to utilize the full feature set of this module, employing ESM syntax and TypeScript.
+// Use exactly like real MongoDB
+const db = client.db('myapp');
+await db.collection('users').insertOne({ name: 'Alice', age: 30 });
+
+const user = await db.collection('users').findOne({ name: 'Alice' });
+console.log(user); // { _id: ObjectId(...), name: 'Alice', age: 30 }
+
+// Clean up
+await client.close();
+await server.stop();
+```
 
-### Setting Up
+## 📖 SmartMongo API
 
-To get started, you must first import the `SmartMongo` class from the package. This class is responsible for handling the MongoDB instances.
+### Creating an Instance
 
 ```typescript
 import { SmartMongo } from '@push.rocks/smartmongo';
+
+// Default: single replica
+const mongo = await SmartMongo.createAndStart();
+
+// Multiple replicas for testing replication
+const mongo = await SmartMongo.createAndStart(3);
+```
+
+### Getting Connection Details
+
+```typescript
+const descriptor = await mongo.getMongoDescriptor();
+// {
+//   mongoDbName: 'smartmongo_testdatabase',
+//   mongoDbUrl: 'mongodb://127.0.0.1:xxxxx/?replicaSet=testset'
+// }
+```
+
+### Stopping & Cleanup
+
+```typescript
+// Simple stop (data discarded)
+await mongo.stop();
+
+// Stop and dump data to disk for inspection
+await mongo.stopAndDumpToDir('./test-data');
+
+// With custom file naming
+await mongo.stopAndDumpToDir('./test-data', (doc) => `${doc.collection}-${doc._id}.bson`);
+```
+
+## 🔧 CongoDB API
+
+### Server Configuration
+
+```typescript
+import { congodb } from '@push.rocks/smartmongo';
+
+const server = new congodb.CongoServer({
+  port: 27017,           // Default MongoDB port
+  host: '127.0.0.1',     // Bind address
+  storage: 'memory',     // 'memory' or 'file'
+  storagePath: './data', // For file-based storage
+});
+
+await server.start();
+console.log(server.getConnectionUri()); // mongodb://127.0.0.1:27017
+
+// Server properties
+console.log(server.running);           // true
+console.log(server.getUptime());       // seconds
+console.log(server.getConnectionCount()); // active connections
+
+await server.stop();
+```
+
+### Supported MongoDB Operations
+
+CongoDB supports the core MongoDB operations via the wire protocol:
+
+#### 🔹 CRUD Operations
+```typescript
+// Insert
+await collection.insertOne({ name: 'Bob' });
+await collection.insertMany([{ a: 1 }, { a: 2 }]);
+
+// Find
+const doc = await collection.findOne({ name: 'Bob' });
+const docs = await collection.find({ age: { $gte: 18 } }).toArray();
+
+// Update
+await collection.updateOne({ name: 'Bob' }, { $set: { age: 25 } });
+await collection.updateMany({ active: false }, { $set: { archived: true } });
+
+// Delete
+await collection.deleteOne({ name: 'Bob' });
+await collection.deleteMany({ archived: true });
+
+// Replace
+await collection.replaceOne({ _id: id }, { name: 'New Bob', age: 30 });
+
+// Find and Modify
+const result = await collection.findOneAndUpdate(
+  { name: 'Bob' },
+  { $inc: { visits: 1 } },
+  { returnDocument: 'after' }
+);
 ```
 
-### Creating and Starting a MongoDB Instance
+#### 🔹 Query Operators
+```typescript
+// Comparison
+{ age: { $eq: 25 } }
+{ age: { $ne: 25 } }
+{ age: { $gt: 18, $lt: 65 } }
+{ age: { $gte: 18, $lte: 65 } }
+{ status: { $in: ['active', 'pending'] } }
+{ status: { $nin: ['deleted'] } }
+
+// Logical
+{ $and: [{ age: { $gte: 18 } }, { active: true }] }
+{ $or: [{ status: 'active' }, { admin: true }] }
+{ $not: { status: 'deleted' } }
+
+// Element
+{ email: { $exists: true } }
+{ type: { $type: 'string' } }
+
+// Array
+{ tags: { $all: ['mongodb', 'database'] } }
+{ scores: { $elemMatch: { $gte: 80, $lt: 90 } } }
+{ tags: { $size: 3 } }
+```
 
-With `SmartMongo`, you can easily create and start a MongoDB replica set. You can specify the number of replica instances; however, if not specified, it defaults to 1.
+#### 🔹 Update Operators
+```typescript
+{ $set: { name: 'New Name' } }
+{ $unset: { tempField: '' } }
+{ $inc: { count: 1 } }
+{ $mul: { price: 1.1 } }
+{ $min: { lowScore: 50 } }
+{ $max: { highScore: 100 } }
+{ $push: { tags: 'new-tag' } }
+{ $pull: { tags: 'old-tag' } }
+{ $addToSet: { tags: 'unique-tag' } }
+{ $pop: { queue: 1 } }  // Remove last
+{ $pop: { queue: -1 } } // Remove first
+```
 
+#### 🔹 Aggregation Pipeline
 ```typescript
-async function setupMongoDB() {
-  const smartMongoInstance = await SmartMongo.createAndStart(1); // Number of replicas is optional
-  return smartMongoInstance;
-}
+const results = await collection.aggregate([
+  { $match: { status: 'active' } },
+  { $group: { _id: '$category', total: { $sum: '$amount' } } },
+  { $sort: { total: -1 } },
+  { $limit: 10 },
+  { $project: { category: '$_id', total: 1, _id: 0 } }
+]).toArray();
+```
 
-const myDbInstance = await setupMongoDB();
+Supported stages: `$match`, `$project`, `$group`, `$sort`, `$limit`, `$skip`, `$unwind`, `$lookup`, `$addFields`, `$count`, `$facet`, and more.
+
+#### 🔹 Index Operations
+```typescript
+await collection.createIndex({ email: 1 }, { unique: true });
+await collection.createIndex({ name: 1, age: -1 });
+const indexes = await collection.listIndexes().toArray();
+await collection.dropIndex('email_1');
 ```
 
-After invoking `createAndStart`, an instance of MongoDB is spun up and is ready for use. The `createAndStart` function returns a `SmartMongo` instance which can be interacted with for further operations.
+#### 🔹 Database Operations
+```typescript
+// List databases
+const dbs = await client.db().admin().listDatabases();
+
+// List collections
+const collections = await db.listCollections().toArray();
 
-### Accessing MongoDB Connection Information
+// Create/drop collections
+await db.createCollection('newcollection');
+await db.dropCollection('oldcollection');
 
-After instantiation, you might want to connect your application or test suite to the MongoDB instance. The `getMongoDescriptor` method facilitates this by providing essential connection details.
+// Drop database
+await db.dropDatabase();
+```
 
+#### 🔹 Count & Distinct
 ```typescript
-const mongoDescriptor = await myDbInstance.getMongoDescriptor();
-console.log(mongoDescriptor.mongoDbUrl); // Use this URL to connect with Mongoose or MongoDB clients.
+// Count documents
+const total = await collection.countDocuments({});
+const active = await collection.countDocuments({ status: 'active' });
+const estimated = await collection.estimatedDocumentCount();
+
+// Distinct values
+const departments = await collection.distinct('department');
+const activeDepts = await collection.distinct('department', { status: 'active' });
 ```
 
-### Stopping and Cleaning Up
+#### 🔹 Bulk Operations
+```typescript
+const result = await collection.bulkWrite([
+  { insertOne: { document: { name: 'Bulk1' } } },
+  { updateOne: { filter: { name: 'John' }, update: { $set: { bulk: true } } } },
+  { deleteOne: { filter: { name: 'Expired' } } },
+  { replaceOne: { filter: { _id: id }, replacement: { name: 'Replaced' } } }
+]);
+
+console.log(result.insertedCount);  // 1
+console.log(result.modifiedCount);  // 1
+console.log(result.deletedCount);   // 1
+```
 
-Once your tests have completed or you're done using the MongoDB instance, it’s crucial to properly stop and clean up the resources. `@push.rocks/smartmongo` provides two methods for this purpose:
+### Storage Adapters
 
-1. **stop()**: Stops the MongoDB instance without persisting any data.
+CongoDB supports pluggable storage:
 
-   ```typescript
-   await myDbInstance.stop();
-   ```
+```typescript
+// In-memory (default) - fast, data lost on stop
+const server = new congodb.CongoServer({ storage: 'memory' });
+
+// In-memory with persistence - periodic snapshots to disk
+const server = new congodb.CongoServer({
+  storage: 'memory',
+  persistPath: './data/snapshot.json',
+  persistIntervalMs: 30000  // Save every 30 seconds
+});
 
-2. **stopAndDumpToDir(dirPath)**: Stops the MongoDB instance and persists the data to the specified directory. This is useful if you need to examine the data post-test or reuse it in subsequent runs.
+// File-based - persistent storage
+const server = new congodb.CongoServer({
+  storage: 'file',
+  storagePath: './data/congodb'
+});
+```
 
-   ```typescript
-   await myDbInstance.stopAndDumpToDir('./path/to/dump');
-   ```
+### 📋 Supported Wire Protocol Commands
 
-### Advanced Usage
+| Category | Commands |
+|----------|----------|
+| **Handshake** | `hello`, `isMaster` |
+| **CRUD** | `find`, `insert`, `update`, `delete`, `findAndModify`, `getMore`, `killCursors` |
+| **Aggregation** | `aggregate`, `count`, `distinct` |
+| **Indexes** | `createIndexes`, `dropIndexes`, `listIndexes` |
+| **Admin** | `ping`, `listDatabases`, `listCollections`, `drop`, `dropDatabase`, `create`, `serverStatus`, `buildInfo` |
 
-`@push.rocks/smartmongo` also provides advanced features for dumping the database and configuring MongoDB replica sets. These features can be particularly useful for complex testing scenarios or when specific MongoDB behaviors need to be emulated.
+CongoDB supports MongoDB wire protocol versions 0-21, compatible with MongoDB 3.6 through 7.0 drivers.
 
-#### Dumping Data
+## 🧪 Testing Examples
 
-To dump the MongoDB data for inspection or backup purposes, use the `stopAndDumpToDir` method. This method optionally takes a function to customize the naming scheme of the dumped files based on the document content.
+### Jest/Mocha with CongoDB
 
 ```typescript
-await myDbInstance.stopAndDumpToDir('./path/to/dump', (doc) => {
-  return `customNameBasedOnDoc-${doc._id}.bson`;
+import { congodb } from '@push.rocks/smartmongo';
+import { MongoClient } from 'mongodb';
+
+let server: congodb.CongoServer;
+let client: MongoClient;
+let db: Db;
+
+beforeAll(async () => {
+  server = new congodb.CongoServer({ port: 27117 });
+  await server.start();
+
+  client = new MongoClient('mongodb://127.0.0.1:27117');
+  await client.connect();
+  db = client.db('test');
+});
+
+afterAll(async () => {
+  await client.close();
+  await server.stop();
+});
+
+beforeEach(async () => {
+  // Clean slate for each test
+  await db.dropDatabase();
+});
+
+test('should insert and find user', async () => {
+  const users = db.collection('users');
+  await users.insertOne({ name: 'Alice', email: 'alice@example.com' });
+
+  const user = await users.findOne({ name: 'Alice' });
+  expect(user?.email).toBe('alice@example.com');
 });
 ```
 
-Using `@push.rocks/smartmongo` significantly simplifies the process of managing MongoDB instances for local testing environments. It abstracts away the complexity of starting, operating, and tearing down MongoDB replica sets, allowing developers to focus on building and testing their applications.
+### With @push.rocks/tapbundle
 
-### Conclusion
+```typescript
+import { expect, tap } from '@git.zone/tstest/tapbundle';
+import { congodb } from '@push.rocks/smartmongo';
+import { MongoClient } from 'mongodb';
+
+let server: congodb.CongoServer;
+let client: MongoClient;
+
+tap.test('setup', async () => {
+  server = new congodb.CongoServer({ port: 27117 });
+  await server.start();
+  client = new MongoClient('mongodb://127.0.0.1:27117');
+  await client.connect();
+});
+
+tap.test('should perform CRUD operations', async () => {
+  const db = client.db('test');
+  const col = db.collection('items');
 
-`@push.rocks/smartmongo` serves as a powerful tool in a developer's arsenal for efficiently configuring, running, and managing MongoDB instances in testing scenarios. By following the above guide, developers can leverage MongoDB in their projects with minimal setup and gain valuable insights into their applications' data interactions in a controlled and reproducible environment.
+  // Create
+  const result = await col.insertOne({ name: 'Widget', price: 9.99 });
+  expect(result.insertedId).toBeTruthy();
+
+  // Read
+  const item = await col.findOne({ name: 'Widget' });
+  expect(item?.price).toEqual(9.99);
+
+  // Update
+  await col.updateOne({ name: 'Widget' }, { $set: { price: 12.99 } });
+  const updated = await col.findOne({ name: 'Widget' });
+  expect(updated?.price).toEqual(12.99);
+
+  // Delete
+  await col.deleteOne({ name: 'Widget' });
+  const deleted = await col.findOne({ name: 'Widget' });
+  expect(deleted).toBeNull();
+});
+
+tap.test('teardown', async () => {
+  await client.close();
+  await server.stop();
+});
+
+export default tap.start();
+```
+
+## 🏗️ Architecture
+
+### CongoDB Wire Protocol Stack
+
+```
+┌─────────────────────────────────────────────────────────────┐
+│                   Official MongoDB Driver                    │
+│                      (mongodb npm)                          │
+└─────────────────────────┬───────────────────────────────────┘
+                          │ TCP + OP_MSG/BSON
+                          ▼
+┌─────────────────────────────────────────────────────────────┐
+│                      CongoServer                            │
+│  ┌──────────────┐  ┌──────────────┐  ┌──────────────────┐  │
+│  │ WireProtocol │→ │CommandRouter │→ │     Handlers     │  │
+│  │  (OP_MSG)    │  │              │  │ (Find, Insert..) │  │
+│  └──────────────┘  └──────────────┘  └──────────────────┘  │
+└─────────────────────────┬───────────────────────────────────┘
+                          │
+                          ▼
+┌─────────────────────────────────────────────────────────────┐
+│                       Engines                               │
+│  ┌───────────┐ ┌────────────┐ ┌────────────┐ ┌───────────┐ │
+│  │  Query    │ │   Update   │ │Aggregation │ │   Index   │ │
+│  │  Engine   │ │   Engine   │ │  Engine    │ │  Engine   │ │
+│  └───────────┘ └────────────┘ └────────────┘ └───────────┘ │
+└─────────────────────────┬───────────────────────────────────┘
+                          │
+                          ▼
+┌─────────────────────────────────────────────────────────────┐
+│                   Storage Adapters                          │
+│       ┌──────────────────┐  ┌──────────────────┐           │
+│       │  MemoryStorage   │  │   FileStorage    │           │
+│       └──────────────────┘  └──────────────────┘           │
+└─────────────────────────────────────────────────────────────┘
+```
 
 ## License and Legal Information
 
-This repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository.
+This repository contains open-source code licensed under the MIT License. A copy of the license can be found in the [LICENSE](./LICENSE) file.
 
 **Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.
 
 ### Trademarks
 
-This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.
+This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH or third parties, and are not included within the scope of the MIT license granted herein.
+
+Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines or the guidelines of the respective third-party owners, and any usage must be approved in writing. Third-party trademarks used herein are the property of their respective owners and used only in a descriptive manner, e.g. for an implementation of an API or similar.
 
 ### Company Information
 
-Task Venture Capital GmbH  
-Registered at District court Bremen HRB 35230 HB, Germany
+Task Venture Capital GmbH
+Registered at District Court Bremen HRB 35230 HB, Germany
 
-For any legal inquiries or if you require further information, please contact us via email at hello@task.vc.
+For any legal inquiries or further information, please contact us via email at hello@task.vc.
 
 By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.

package/ts/00_commitinfo_data.ts

@@ -3,6 +3,6 @@
  */
 export const commitinfo = {
   name: '@push.rocks/smartmongo',
-  version: '2.1.0',
+  version: '2.2.0',
   description: 'A module for creating and managing a local MongoDB instance for testing purposes.'
 }