6 Commits

Author SHA1 Message Date
1ff4d219af v5.0.0
Some checks failed
Default (tags) / security (push) Successful in 43s
Default (tags) / test (push) Failing after 4m2s
Default (tags) / release (push) Has been skipped
Default (tags) / metadata (push) Has been skipped
2026-02-03 16:42:49 +00:00
09f60de56f BREAKING CHANGE(localtsmdb): add Unix socket support and change LocalTsmDb API to return connection info instead of a MongoClient 2026-02-03 16:42:49 +00:00
e6a36ecb5f v4.3.0
Some checks failed
Default (tags) / security (push) Successful in 41s
Default (tags) / test (push) Failing after 4m0s
Default (tags) / release (push) Has been skipped
Default (tags) / metadata (push) Has been skipped
2026-02-03 08:14:58 +00:00
6a37a773ea feat(docs): add LocalTsmDb documentation and examples; update README code samples and imports; correct examples and variable names; update package author 2026-02-03 08:14:58 +00:00
1fff277698 v4.2.1
Some checks failed
Default (tags) / security (push) Successful in 44s
Default (tags) / test (push) Failing after 4m1s
Default (tags) / release (push) Has been skipped
Default (tags) / metadata (push) Has been skipped
2026-02-03 07:29:20 +00:00
0ad7f316c4 fix(package.json): replace main and typings with exports field pointing to ./dist_ts/index.js 2026-02-03 07:29:20 +00:00
8 changed files with 326 additions and 118 deletions

View File

@@ -1,5 +1,32 @@
# Changelog # Changelog
## 2026-02-03 - 5.0.0 - BREAKING CHANGE(localtsmdb)
add Unix socket support and change LocalTsmDb API to return connection info instead of a MongoClient
- LocalTsmDb.start() now returns ILocalTsmDbConnectionInfo { socketPath, connectionUri } instead of a connected MongoClient
- Removed internal MongoClient management: consumers must create/connect/close their own MongoClient using the returned connectionUri (close client before calling db.stop())
- Added ILocalTsmDbConnectionInfo type and getConnectionInfo() (replaces getClient())
- TsmdbServer: added socketPath option to listen on Unix sockets, cleans up stale socket files on start/stop, and encodes socket paths in getConnectionUri()
- LocalTsmDb can auto-generate socket paths in the OS temp dir; LocalTsmDb no longer depends on the mongodb package internally (lightweight Unix socket wrapper)
- Updated docs and tests to use MongoClient externally and to demonstrate socketPath/connectionUri workflow
- ts_local plugins no longer export net (net usage moved to server implementation)
## 2026-02-03 - 4.3.0 - feat(docs)
add LocalTsmDb documentation and examples; update README code samples and imports; correct examples and variable names; update package author
- Introduce LocalTsmDb: zero-config local database with automatic persistence, auto port discovery, and pre-connected client (added Quick Start, API, Features, and testing examples).
- Expand comparison table to include LocalTsmDb alongside SmartMongo and TsmDB.
- Update README examples: new LocalTsmDb usage, reorder options (LocalTsmDb, TsmDB, SmartMongo), rename test DB variable (db -> testDb), and adjust test snippets for Jest/Mocha and tap.
- Adjust code snippets and API notes: switch some example imports to use tsmdb, replace FileStorageAdapter references, change planner.createPlan to await planner.plan, and use wal.getEntriesAfter(...) without awaiting.
- Update package.json author from 'Lossless GmbH' to 'Task Venture Capital GmbH'.
## 2026-02-03 - 4.2.1 - fix(package.json)
replace main and typings with exports field pointing to ./dist_ts/index.js
- Added package.json exports field mapping "." to ./dist_ts/index.js to declare the package entrypoint.
- Removed main (dist_ts/index.js) and typings (dist_ts/index.d.ts) entries.
- Note: switching to exports improves Node resolution but removing the typings entry may affect TypeScript consumers expecting index.d.ts.
## 2026-02-01 - 4.2.0 - feat(tsmdb) ## 2026-02-01 - 4.2.0 - feat(tsmdb)
implement TsmDB Mongo-wire-compatible server, add storage/engine modules and reorganize exports implement TsmDB Mongo-wire-compatible server, add storage/engine modules and reorganize exports

View File

@@ -1,12 +1,13 @@
{ {
"name": "@push.rocks/smartmongo", "name": "@push.rocks/smartmongo",
"version": "4.2.0", "version": "5.0.0",
"private": false, "private": false,
"description": "A module for creating and managing a local MongoDB instance for testing purposes.", "description": "A module for creating and managing a local MongoDB instance for testing purposes.",
"main": "dist_ts/index.js", "exports": {
"typings": "dist_ts/index.d.ts", ".": "./dist_ts/index.js"
},
"type": "module", "type": "module",
"author": "Lossless GmbH", "author": "Task Venture Capital GmbH",
"license": "MIT", "license": "MIT",
"scripts": { "scripts": {
"test": "(tstest test/. --verbose --logfile --timeout 60)", "test": "(tstest test/. --verbose --logfile --timeout 60)",

235
readme.md
View File

@@ -1,6 +1,6 @@
# @push.rocks/smartmongo # @push.rocks/smartmongo
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 (**TsmDB**). 🚀 A powerful MongoDB toolkit for testing and development — featuring a real MongoDB memory server (**SmartMongo**), an ultra-fast wire-protocol-compatible in-memory database server (**TsmDB**), and a zero-config local database (**LocalTsmDb**). 🚀
## Install ## Install
@@ -16,21 +16,87 @@ For reporting bugs, issues, or security vulnerabilities, please visit [community
## Overview ## Overview
`@push.rocks/smartmongo` provides two powerful approaches for MongoDB in testing and development: `@push.rocks/smartmongo` provides three powerful approaches for MongoDB in testing and development:
| Feature | SmartMongo | TsmDB | | Feature | SmartMongo | TsmDB | LocalTsmDb |
|---------|------------|---------| |---------|------------|-------|------------|
| **Type** | Real MongoDB (memory server) | Pure TypeScript wire protocol server | | **Type** | Real MongoDB (memory server) | Wire protocol server | Zero-config local DB |
| **Speed** | ~2-5s startup | ⚡ Instant startup (~5ms) | | **Speed** | ~2-5s startup | ⚡ Instant (~5ms) | ⚡ Instant (Unix socket) |
| **Compatibility** | 100% MongoDB | MongoDB driver compatible | | **Compatibility** | 100% MongoDB | MongoDB driver compatible | MongoDB driver compatible |
| **Dependencies** | Downloads MongoDB binary | Zero external dependencies | | **Dependencies** | Downloads MongoDB binary | Zero external deps | Zero external deps (no MongoDB driver!) |
| **Replication** | ✅ Full replica set support | Single node emulation | | **Replication** | ✅ Full replica set | Single node | Single node |
| **Use Case** | Integration testing | Unit testing, CI/CD | | **Persistence** | Dump to directory | Memory or file | File-based (automatic) |
| **Persistence** | Dump to directory | Optional file/memory persistence | | **Use Case** | Integration testing | Unit testing, CI/CD | Quick prototyping, local dev |
## 🚀 Quick Start ## 🚀 Quick Start
### Option 1: SmartMongo (Real MongoDB) ### Option 1: LocalTsmDb (Zero-Config Local Database) ⭐ NEW
The easiest way to get started — just point it at a folder and you have a persistent MongoDB-compatible database using Unix sockets. No port conflicts, no MongoDB driver dependency in LocalTsmDb!
```typescript
import { LocalTsmDb } from '@push.rocks/smartmongo';
import { MongoClient } from 'mongodb';
// Create a local database backed by files
const db = new LocalTsmDb({ folderPath: './my-data' });
// Start and get connection info (Unix socket path + connection URI)
const { connectionUri } = await db.start();
// Connect with your own MongoDB client
const client = new MongoClient(connectionUri, { directConnection: true });
await client.connect();
// Use exactly like MongoDB
const users = client.db('myapp').collection('users');
await users.insertOne({ name: 'Alice', email: 'alice@example.com' });
const user = await users.findOne({ name: 'Alice' });
console.log(user); // { _id: ObjectId(...), name: 'Alice', email: 'alice@example.com' }
// Data persists to disk automatically!
await client.close();
await db.stop();
// Later... data is still there
const db2 = new LocalTsmDb({ folderPath: './my-data' });
const { connectionUri: uri2 } = await db2.start();
const client2 = new MongoClient(uri2, { directConnection: true });
await client2.connect();
const savedUser = await client2.db('myapp').collection('users').findOne({ name: 'Alice' });
// savedUser exists!
```
### Option 2: TsmDB (Wire Protocol Server)
A lightweight, pure TypeScript MongoDB-compatible server — use the official `mongodb` driver directly!
```typescript
import { tsmdb } from '@push.rocks/smartmongo';
import { MongoClient } from 'mongodb';
// Start TsmDB server
const server = new tsmdb.TsmdbServer({ port: 27017 });
await server.start();
// Connect with the official MongoDB driver
const client = new MongoClient('mongodb://127.0.0.1:27017');
await client.connect();
// 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();
```
### Option 3: SmartMongo (Real MongoDB)
Spin up a real MongoDB replica set in memory — perfect for integration tests that need full MongoDB compatibility. Spin up a real MongoDB replica set in memory — perfect for integration tests that need full MongoDB compatibility.
@@ -51,34 +117,54 @@ console.log(descriptor.mongoDbUrl); // mongodb://127.0.0.1:xxxxx/...
await mongo.stop(); await mongo.stop();
``` ```
### Option 2: TsmDB (Wire Protocol Server) ## 📖 LocalTsmDb API
A lightweight, pure TypeScript MongoDB-compatible server that speaks the wire protocol — use the official `mongodb` driver directly! The simplest option for local development and prototyping — lightweight, Unix socket-based, and automatic persistence.
### Basic Usage
```typescript ```typescript
import { tsmdb } from '@push.rocks/smartmongo'; import { LocalTsmDb } from '@push.rocks/smartmongo';
import { MongoClient } from 'mongodb'; import { MongoClient } from 'mongodb';
// Start TsmDB server const db = new LocalTsmDb({
const server = new tsmdb.TsmdbServer({ port: 27017 }); folderPath: './data', // Required: where to store data
await server.start(); socketPath: '/tmp/my.sock', // Optional: custom socket path (default: auto-generated)
});
// Connect with the official MongoDB driver! // Start and get connection info
const client = new MongoClient('mongodb://127.0.0.1:27017'); const { socketPath, connectionUri } = await db.start();
console.log(socketPath); // /tmp/smartmongo-abc123.sock (auto-generated)
console.log(connectionUri); // mongodb://%2Ftmp%2Fsmartmongo-abc123.sock
// Connect with your own MongoDB client
const client = new MongoClient(connectionUri, { directConnection: true });
await client.connect(); await client.connect();
// Use exactly like real MongoDB // Use the client
const db = client.db('myapp'); const users = client.db('mydb').collection('users');
await db.collection('users').insertOne({ name: 'Alice', age: 30 }); await users.insertOne({ name: 'Alice' });
const user = await db.collection('users').findOne({ name: 'Alice' }); // Access the underlying server if needed
console.log(user); // { _id: ObjectId(...), name: 'Alice', age: 30 } const server = db.getServer();
const uri = db.getConnectionUri();
// Clean up // Check status
console.log(db.running); // true
// Stop when done (close your client first!)
await client.close(); await client.close();
await server.stop(); await db.stop();
``` ```
### Features
- 🔌 **Unix Sockets** — No port conflicts, faster IPC than TCP
- 💾 **Automatic Persistence** — Data saved to files, survives restarts
- 🪶 **Lightweight** — No MongoDB driver dependency in LocalTsmDb itself
- 🎯 **Zero Config** — Just specify a folder path and you're good to go
- 🔗 **Connection URI** — Ready-to-use URI for your own MongoClient
## 📖 SmartMongo API ## 📖 SmartMongo API
### Creating an Instance ### Creating an Instance
@@ -293,11 +379,11 @@ const server = new tsmdb.TsmdbServer({
}); });
// File-based - persistent storage with optional checksums // File-based - persistent storage with optional checksums
import { FileStorageAdapter } from '@push.rocks/smartmongo/tsmdb'; import { tsmdb } from '@push.rocks/smartmongo';
const adapter = new FileStorageAdapter('./data/tsmdb', { const server = new tsmdb.TsmdbServer({
enableChecksums: true, // CRC32 checksums for data integrity storage: 'file',
strictChecksums: false // Log warnings vs throw on mismatch storagePath: './data/tsmdb'
}); });
``` ```
@@ -331,14 +417,14 @@ import { tsmdb } from '@push.rocks/smartmongo';
// For debugging, you can access the query planner // For debugging, you can access the query planner
const planner = new tsmdb.QueryPlanner(indexEngine); const planner = new tsmdb.QueryPlanner(indexEngine);
const plan = planner.createPlan(filter); const plan = await planner.plan(filter);
console.log(plan); console.log(plan);
// { // {
// type: 'IXSCAN', // or 'IXSCAN_RANGE', 'COLLSCAN' // type: 'IXSCAN', // or 'IXSCAN_RANGE', 'COLLSCAN'
// indexName: 'email_1', // indexName: 'email_1',
// estimatedCost: 1, // selectivity: 0.01,
// selectivity: 0.001 // indexCovering: true
// } // }
``` ```
@@ -357,10 +443,10 @@ await wal.initialize();
// - Timestamp // - Timestamp
// - Operation type (insert, update, delete, checkpoint) // - Operation type (insert, update, delete, checkpoint)
// - Document data (BSON serialized) // - Document data (BSON serialized)
// - CRC32 checksum // - CRC32 checksum for integrity
// Recovery support // Recovery support
const entries = await wal.getEntriesAfter(lastCheckpointLsn); const entries = wal.getEntriesAfter(lastCheckpointLsn);
``` ```
### 🔐 Session Management ### 🔐 Session Management
@@ -393,15 +479,10 @@ try {
File-based storage supports CRC32 checksums to detect corruption: File-based storage supports CRC32 checksums to detect corruption:
```typescript ```typescript
import { FileStorageAdapter } from '@push.rocks/smartmongo/tsmdb'; import { tsmdb } from '@push.rocks/smartmongo';
const adapter = new FileStorageAdapter('./data', {
enableChecksums: true,
strictChecksums: true // Throw error on corruption (vs warning)
});
// Checksums are used internally for WAL and data integrity
// Documents are checksummed on write, verified on read // Documents are checksummed on write, verified on read
// Checksums are automatically stripped before returning to client
``` ```
### 📋 Supported Wire Protocol Commands ### 📋 Supported Wire Protocol Commands
@@ -420,6 +501,41 @@ TsmDB supports MongoDB wire protocol versions 0-21, compatible with MongoDB 3.6
## 🧪 Testing Examples ## 🧪 Testing Examples
### Jest/Mocha with LocalTsmDb
```typescript
import { LocalTsmDb } from '@push.rocks/smartmongo';
import { MongoClient, Db } from 'mongodb';
let db: LocalTsmDb;
let client: MongoClient;
beforeAll(async () => {
db = new LocalTsmDb({ folderPath: './test-data' });
const { connectionUri } = await db.start();
client = new MongoClient(connectionUri, { directConnection: true });
await client.connect();
});
afterAll(async () => {
await client.close();
await db.stop();
});
beforeEach(async () => {
// Clean slate for each test
await client.db('test').dropDatabase();
});
test('should insert and find user', async () => {
const users = client.db('test').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');
});
```
### Jest/Mocha with TsmDB ### Jest/Mocha with TsmDB
```typescript ```typescript
@@ -428,7 +544,7 @@ import { MongoClient, Db } from 'mongodb';
let server: tsmdb.TsmdbServer; let server: tsmdb.TsmdbServer;
let client: MongoClient; let client: MongoClient;
let db: Db; let testDb: Db;
beforeAll(async () => { beforeAll(async () => {
server = new tsmdb.TsmdbServer({ port: 27117 }); server = new tsmdb.TsmdbServer({ port: 27117 });
@@ -436,7 +552,7 @@ beforeAll(async () => {
client = new MongoClient('mongodb://127.0.0.1:27117'); client = new MongoClient('mongodb://127.0.0.1:27117');
await client.connect(); await client.connect();
db = client.db('test'); testDb = client.db('test');
}); });
afterAll(async () => { afterAll(async () => {
@@ -445,12 +561,11 @@ afterAll(async () => {
}); });
beforeEach(async () => { beforeEach(async () => {
// Clean slate for each test await testDb.dropDatabase();
await db.dropDatabase();
}); });
test('should insert and find user', async () => { test('should insert and find user', async () => {
const users = db.collection('users'); const users = testDb.collection('users');
await users.insertOne({ name: 'Alice', email: 'alice@example.com' }); await users.insertOne({ name: 'Alice', email: 'alice@example.com' });
const user = await users.findOne({ name: 'Alice' }); const user = await users.findOne({ name: 'Alice' });
@@ -462,22 +577,21 @@ test('should insert and find user', async () => {
```typescript ```typescript
import { expect, tap } from '@git.zone/tstest/tapbundle'; import { expect, tap } from '@git.zone/tstest/tapbundle';
import { tsmdb } from '@push.rocks/smartmongo'; import { LocalTsmDb } from '@push.rocks/smartmongo';
import { MongoClient } from 'mongodb'; import { MongoClient } from 'mongodb';
let server: tsmdb.TsmdbServer; let db: LocalTsmDb;
let client: MongoClient; let client: MongoClient;
tap.test('setup', async () => { tap.test('setup', async () => {
server = new tsmdb.TsmdbServer({ port: 27117 }); db = new LocalTsmDb({ folderPath: './test-data' });
await server.start(); const { connectionUri } = await db.start();
client = new MongoClient('mongodb://127.0.0.1:27117'); client = new MongoClient(connectionUri, { directConnection: true });
await client.connect(); await client.connect();
}); });
tap.test('should perform CRUD operations', async () => { tap.test('should perform CRUD operations', async () => {
const db = client.db('test'); const col = client.db('test').collection('items');
const col = db.collection('items');
// Create // Create
const result = await col.insertOne({ name: 'Widget', price: 9.99 }); const result = await col.insertOne({ name: 'Widget', price: 9.99 });
@@ -500,7 +614,7 @@ tap.test('should perform CRUD operations', async () => {
tap.test('teardown', async () => { tap.test('teardown', async () => {
await client.close(); await client.close();
await server.stop(); await db.stop();
}); });
export default tap.start(); export default tap.start();
@@ -508,6 +622,15 @@ export default tap.start();
## 🏗️ Architecture ## 🏗️ Architecture
### Module Structure
```
@push.rocks/smartmongo
├── SmartMongo → Real MongoDB memory server (mongodb-memory-server wrapper)
├── tsmdb → Wire protocol server with full engine stack
└── LocalTsmDb → Lightweight Unix socket wrapper (no MongoDB driver dependency)
```
### TsmDB Wire Protocol Stack ### TsmDB Wire Protocol Stack
``` ```

View File

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

View File

@@ -1,98 +1,106 @@
import * as plugins from './plugins.js'; import * as plugins from './plugins.js';
import * as crypto from 'crypto';
import * as path from 'path';
import * as os from 'os';
import { TsmdbServer } from '../ts_tsmdb/index.js'; import { TsmdbServer } from '../ts_tsmdb/index.js';
import type { MongoClient } from 'mongodb';
/**
* Connection information returned by LocalTsmDb.start()
*/
export interface ILocalTsmDbConnectionInfo {
/** The Unix socket file path */
socketPath: string;
/** MongoDB connection URI ready for MongoClient */
connectionUri: string;
}
export interface ILocalTsmDbOptions { export interface ILocalTsmDbOptions {
/** Required: where to store data */
folderPath: string; folderPath: string;
port?: number; /** Optional: custom socket path (default: auto-generated in /tmp) */
host?: string; socketPath?: string;
} }
/** /**
* LocalTsmDb - Convenience class for local MongoDB-compatible database * LocalTsmDb - Lightweight local MongoDB-compatible database using Unix sockets
* *
* This class wraps TsmdbServer and provides a simple interface for * This class wraps TsmdbServer and provides a simple interface for
* starting a local file-based MongoDB-compatible server and connecting to it. * starting a local file-based MongoDB-compatible server. Returns connection
* info that you can use with your own MongoDB driver instance.
* *
* @example * @example
* ```typescript * ```typescript
* import { LocalTsmDb } from '@push.rocks/smartmongo'; * import { LocalTsmDb } from '@push.rocks/smartmongo';
* import { MongoClient } from 'mongodb';
* *
* const db = new LocalTsmDb({ folderPath: './data' }); * const db = new LocalTsmDb({ folderPath: './data' });
* const client = await db.start(); * const { connectionUri } = await db.start();
*
* // Connect with your own MongoDB client
* const client = new MongoClient(connectionUri, { directConnection: true });
* await client.connect();
* *
* // Use the MongoDB client * // Use the MongoDB client
* const collection = client.db('mydb').collection('users'); * const collection = client.db('mydb').collection('users');
* await collection.insertOne({ name: 'Alice' }); * await collection.insertOne({ name: 'Alice' });
* *
* // When done * // When done
* await client.close();
* await db.stop(); * await db.stop();
* ``` * ```
*/ */
export class LocalTsmDb { export class LocalTsmDb {
private options: ILocalTsmDbOptions; private options: ILocalTsmDbOptions;
private server: TsmdbServer | null = null; private server: TsmdbServer | null = null;
private client: MongoClient | null = null; private generatedSocketPath: string | null = null;
constructor(options: ILocalTsmDbOptions) { constructor(options: ILocalTsmDbOptions) {
this.options = options; this.options = options;
} }
/** /**
* Find an available port starting from the given port * Generate a unique socket path in /tmp
*/ */
private async findAvailablePort(startPort = 27017): Promise<number> { private generateSocketPath(): string {
return new Promise((resolve, reject) => { const randomId = crypto.randomBytes(8).toString('hex');
const server = plugins.net.createServer(); return path.join(os.tmpdir(), `smartmongo-${randomId}.sock`);
server.listen(startPort, '127.0.0.1', () => {
const addr = server.address();
const port = typeof addr === 'object' && addr ? addr.port : startPort;
server.close(() => resolve(port));
});
server.on('error', () => {
this.findAvailablePort(startPort + 1).then(resolve).catch(reject);
});
});
} }
/** /**
* Start the local TsmDB server and return a connected MongoDB client * Start the local TsmDB server and return connection info
*/ */
async start(): Promise<MongoClient> { async start(): Promise<ILocalTsmDbConnectionInfo> {
if (this.server && this.client) { if (this.server) {
throw new Error('LocalTsmDb is already running'); throw new Error('LocalTsmDb is already running');
} }
const port = this.options.port ?? await this.findAvailablePort(); // Use provided socket path or generate one
const host = this.options.host ?? '127.0.0.1'; this.generatedSocketPath = this.options.socketPath ?? this.generateSocketPath();
this.server = new TsmdbServer({ this.server = new TsmdbServer({
port, socketPath: this.generatedSocketPath,
host,
storage: 'file', storage: 'file',
storagePath: this.options.folderPath, storagePath: this.options.folderPath,
}); });
await this.server.start(); await this.server.start();
// Dynamically import mongodb to avoid requiring it as a hard dependency return {
const mongodb = await import('mongodb'); socketPath: this.generatedSocketPath,
this.client = new mongodb.MongoClient(this.server.getConnectionUri(), { connectionUri: this.server.getConnectionUri(),
directConnection: true, };
serverSelectionTimeoutMS: 5000,
});
await this.client.connect();
return this.client;
} }
/** /**
* Get the MongoDB client (throws if not started) * Get connection info (throws if not started)
*/ */
getClient(): MongoClient { getConnectionInfo(): ILocalTsmDbConnectionInfo {
if (!this.client) { if (!this.server || !this.generatedSocketPath) {
throw new Error('LocalTsmDb is not running. Call start() first.'); throw new Error('LocalTsmDb is not running. Call start() first.');
} }
return this.client; return {
socketPath: this.generatedSocketPath,
connectionUri: this.server.getConnectionUri(),
};
} }
/** /**
@@ -123,16 +131,13 @@ export class LocalTsmDb {
} }
/** /**
* Stop the local TsmDB server and close the client connection * Stop the local TsmDB server
*/ */
async stop(): Promise<void> { async stop(): Promise<void> {
if (this.client) {
await this.client.close();
this.client = null;
}
if (this.server) { if (this.server) {
await this.server.stop(); await this.server.stop();
this.server = null; this.server = null;
this.generatedSocketPath = null;
} }
} }
} }

View File

@@ -1,2 +1,2 @@
export { LocalTsmDb } from './classes.localtsmdb.js'; export { LocalTsmDb } from './classes.localtsmdb.js';
export type { ILocalTsmDbOptions } from './classes.localtsmdb.js'; export type { ILocalTsmDbOptions, ILocalTsmDbConnectionInfo } from './classes.localtsmdb.js';

View File

@@ -1,4 +1,3 @@
import * as smartpromise from '@push.rocks/smartpromise'; import * as smartpromise from '@push.rocks/smartpromise';
import * as net from 'net';
export { smartpromise, net }; export { smartpromise };

View File

@@ -1,4 +1,5 @@
import * as net from 'net'; import * as net from 'net';
import * as fs from 'fs/promises';
import * as plugins from '../plugins.js'; import * as plugins from '../plugins.js';
import { WireProtocol, OP_QUERY } from './WireProtocol.js'; import { WireProtocol, OP_QUERY } from './WireProtocol.js';
import { CommandRouter } from './CommandRouter.js'; import { CommandRouter } from './CommandRouter.js';
@@ -10,10 +11,12 @@ import type { IStorageAdapter } from '../storage/IStorageAdapter.js';
* Server configuration options * Server configuration options
*/ */
export interface ITsmdbServerOptions { export interface ITsmdbServerOptions {
/** Port to listen on (default: 27017) */ /** Port to listen on (default: 27017) - ignored if socketPath is set */
port?: number; port?: number;
/** Host to bind to (default: 127.0.0.1) */ /** Host to bind to (default: 127.0.0.1) - ignored if socketPath is set */
host?: string; host?: string;
/** Unix socket path - if set, server listens on socket instead of TCP */
socketPath?: string;
/** Storage type: 'memory' or 'file' (default: 'memory') */ /** Storage type: 'memory' or 'file' (default: 'memory') */
storage?: 'memory' | 'file'; storage?: 'memory' | 'file';
/** Path for file storage (required if storage is 'file') */ /** Path for file storage (required if storage is 'file') */
@@ -54,7 +57,7 @@ interface IConnectionState {
* ``` * ```
*/ */
export class TsmdbServer { export class TsmdbServer {
private options: Required<ITsmdbServerOptions>; private options: Required<Omit<ITsmdbServerOptions, 'socketPath'>> & { socketPath: string };
private server: net.Server | null = null; private server: net.Server | null = null;
private storage: IStorageAdapter; private storage: IStorageAdapter;
private commandRouter: CommandRouter; private commandRouter: CommandRouter;
@@ -62,11 +65,14 @@ export class TsmdbServer {
private connectionIdCounter = 0; private connectionIdCounter = 0;
private isRunning = false; private isRunning = false;
private startTime: Date = new Date(); private startTime: Date = new Date();
private useSocket: boolean;
constructor(options: ITsmdbServerOptions = {}) { constructor(options: ITsmdbServerOptions = {}) {
this.useSocket = !!options.socketPath;
this.options = { this.options = {
port: options.port ?? 27017, port: options.port ?? 27017,
host: options.host ?? '127.0.0.1', host: options.host ?? '127.0.0.1',
socketPath: options.socketPath ?? '',
storage: options.storage ?? 'memory', storage: options.storage ?? 'memory',
storagePath: options.storagePath ?? './data', storagePath: options.storagePath ?? './data',
persistPath: options.persistPath ?? '', persistPath: options.persistPath ?? '',
@@ -119,6 +125,18 @@ export class TsmdbServer {
// Initialize storage // Initialize storage
await this.storage.initialize(); await this.storage.initialize();
// Clean up stale socket file if using Unix socket
if (this.useSocket && this.options.socketPath) {
try {
await fs.unlink(this.options.socketPath);
} catch (err: any) {
// Ignore ENOENT (file doesn't exist)
if (err.code !== 'ENOENT') {
throw err;
}
}
}
return new Promise((resolve, reject) => { return new Promise((resolve, reject) => {
this.server = net.createServer((socket) => { this.server = net.createServer((socket) => {
this.handleConnection(socket); this.handleConnection(socket);
@@ -132,11 +150,21 @@ export class TsmdbServer {
} }
}); });
if (this.useSocket && this.options.socketPath) {
// Listen on Unix socket
this.server.listen(this.options.socketPath, () => {
this.isRunning = true;
this.startTime = new Date();
resolve();
});
} else {
// Listen on TCP
this.server.listen(this.options.port, this.options.host, () => { this.server.listen(this.options.port, this.options.host, () => {
this.isRunning = true; this.isRunning = true;
this.startTime = new Date(); this.startTime = new Date();
resolve(); resolve();
}); });
}
}); });
} }
@@ -161,9 +189,22 @@ export class TsmdbServer {
await this.storage.close(); await this.storage.close();
return new Promise((resolve) => { return new Promise((resolve) => {
this.server!.close(() => { this.server!.close(async () => {
this.isRunning = false; this.isRunning = false;
this.server = null; this.server = null;
// Clean up socket file if using Unix socket
if (this.useSocket && this.options.socketPath) {
try {
await fs.unlink(this.options.socketPath);
} catch (err: any) {
// Ignore ENOENT (file doesn't exist)
if (err.code !== 'ENOENT') {
console.error('Failed to remove socket file:', err);
}
}
}
resolve(); resolve();
}); });
}); });
@@ -275,9 +316,21 @@ export class TsmdbServer {
* Get the connection URI for this server * Get the connection URI for this server
*/ */
getConnectionUri(): string { getConnectionUri(): string {
if (this.useSocket && this.options.socketPath) {
// URL-encode the socket path (replace / with %2F)
const encodedPath = encodeURIComponent(this.options.socketPath);
return `mongodb://${encodedPath}`;
}
return `mongodb://${this.options.host}:${this.options.port}`; return `mongodb://${this.options.host}:${this.options.port}`;
} }
/**
* Get the socket path (if using Unix socket mode)
*/
get socketPath(): string | undefined {
return this.useSocket ? this.options.socketPath : undefined;
}
/** /**
* Check if the server is running * Check if the server is running
*/ */