feat(server): add tenant management, health checks, and database export/import APIs
This commit is contained in:
@@ -21,4 +21,14 @@ export type {
|
||||
ICollectionInfo,
|
||||
IDocumentsResult,
|
||||
ISmartDbMetrics,
|
||||
ISmartDbHealth,
|
||||
ISmartDbDatabaseTenantInput,
|
||||
ISmartDbDeleteDatabaseTenantInput,
|
||||
ISmartDbRotateDatabaseTenantPasswordInput,
|
||||
ISmartDbDatabaseTenantDescriptor,
|
||||
ISmartDbDeleteDatabaseTenantResult,
|
||||
ISmartDbDatabaseExportCollection,
|
||||
ISmartDbDatabaseExport,
|
||||
ISmartDbImportDatabaseInput,
|
||||
ISmartDbImportDatabaseResult,
|
||||
} from './rust-db-bridge.js';
|
||||
|
||||
@@ -83,6 +83,73 @@ export interface ISmartDbMetrics {
|
||||
uptimeSeconds: number;
|
||||
}
|
||||
|
||||
export interface ISmartDbHealth {
|
||||
running: boolean;
|
||||
storage?: 'memory' | 'file';
|
||||
storagePath?: string;
|
||||
authEnabled?: boolean;
|
||||
authUsers?: number;
|
||||
usersPathConfigured?: boolean;
|
||||
databaseCount: number;
|
||||
collectionCount: number;
|
||||
uptimeSeconds?: number;
|
||||
}
|
||||
|
||||
export interface ISmartDbDatabaseTenantInput {
|
||||
databaseName: string;
|
||||
username: string;
|
||||
password: string;
|
||||
roles?: string[];
|
||||
}
|
||||
|
||||
export interface ISmartDbDeleteDatabaseTenantInput {
|
||||
databaseName: string;
|
||||
username?: string;
|
||||
}
|
||||
|
||||
export interface ISmartDbRotateDatabaseTenantPasswordInput {
|
||||
username: string;
|
||||
password: string;
|
||||
}
|
||||
|
||||
export interface ISmartDbDatabaseTenantDescriptor {
|
||||
databaseName: string;
|
||||
username: string;
|
||||
roles: string[];
|
||||
authSource: string;
|
||||
mongodbUri?: string;
|
||||
}
|
||||
|
||||
export interface ISmartDbDeleteDatabaseTenantResult {
|
||||
databaseName: string;
|
||||
deletedUsers: number;
|
||||
databaseDropped: boolean;
|
||||
}
|
||||
|
||||
export interface ISmartDbDatabaseExportCollection {
|
||||
name: string;
|
||||
documents: Record<string, any>[];
|
||||
indexes: Record<string, any>[];
|
||||
}
|
||||
|
||||
export interface ISmartDbDatabaseExport {
|
||||
format: 'smartdb.database.export.v1';
|
||||
databaseName: string;
|
||||
exportedAtMs: number;
|
||||
collections: ISmartDbDatabaseExportCollection[];
|
||||
}
|
||||
|
||||
export interface ISmartDbImportDatabaseInput {
|
||||
databaseName: string;
|
||||
source: ISmartDbDatabaseExport;
|
||||
}
|
||||
|
||||
export interface ISmartDbImportDatabaseResult {
|
||||
databaseName: string;
|
||||
collections: number;
|
||||
documents: number;
|
||||
}
|
||||
|
||||
/**
|
||||
* Type-safe command definitions for the RustDb IPC protocol.
|
||||
*/
|
||||
@@ -90,7 +157,36 @@ type TSmartDbCommands = {
|
||||
start: { params: { config: ISmartDbRustConfig }; result: { connectionUri: string } };
|
||||
stop: { params: Record<string, never>; result: void };
|
||||
getStatus: { params: Record<string, never>; result: { running: boolean } };
|
||||
getHealth: { params: Record<string, never>; result: ISmartDbHealth };
|
||||
getMetrics: { params: Record<string, never>; result: ISmartDbMetrics };
|
||||
createDatabaseTenant: {
|
||||
params: ISmartDbDatabaseTenantInput;
|
||||
result: ISmartDbDatabaseTenantDescriptor;
|
||||
};
|
||||
deleteDatabaseTenant: {
|
||||
params: ISmartDbDeleteDatabaseTenantInput;
|
||||
result: ISmartDbDeleteDatabaseTenantResult;
|
||||
};
|
||||
rotateDatabaseTenantPassword: {
|
||||
params: ISmartDbRotateDatabaseTenantPasswordInput;
|
||||
result: ISmartDbDatabaseTenantDescriptor;
|
||||
};
|
||||
listDatabaseTenants: {
|
||||
params: Record<string, never>;
|
||||
result: { tenants: ISmartDbDatabaseTenantDescriptor[] };
|
||||
};
|
||||
getDatabaseTenantDescriptor: {
|
||||
params: { databaseName: string; username: string };
|
||||
result: ISmartDbDatabaseTenantDescriptor;
|
||||
};
|
||||
exportDatabase: {
|
||||
params: { databaseName: string };
|
||||
result: ISmartDbDatabaseExport;
|
||||
};
|
||||
importDatabase: {
|
||||
params: ISmartDbImportDatabaseInput;
|
||||
result: ISmartDbImportDatabaseResult;
|
||||
};
|
||||
getOpLog: {
|
||||
params: { sinceSeq?: number; limit?: number; db?: string; collection?: string };
|
||||
result: IOpLogResult;
|
||||
@@ -202,7 +298,7 @@ export class RustDbBridge extends EventEmitter {
|
||||
envVarName: 'SMARTDB_RUST_BINARY',
|
||||
platformPackagePrefix: '@push.rocks/smartdb',
|
||||
localPaths: buildLocalPaths(),
|
||||
maxPayloadSize: 10 * 1024 * 1024, // 10 MB
|
||||
maxPayloadSize: 100 * 1024 * 1024, // database exports/imports can be larger than command replies
|
||||
});
|
||||
|
||||
// Forward events from the inner bridge
|
||||
@@ -251,6 +347,48 @@ export class RustDbBridge extends EventEmitter {
|
||||
return this.bridge.sendCommand('getMetrics', {} as Record<string, never>) as Promise<ISmartDbMetrics>;
|
||||
}
|
||||
|
||||
public async getHealth(): Promise<ISmartDbHealth> {
|
||||
return this.bridge.sendCommand('getHealth', {} as Record<string, never>) as Promise<ISmartDbHealth>;
|
||||
}
|
||||
|
||||
public async createDatabaseTenant(
|
||||
params: ISmartDbDatabaseTenantInput,
|
||||
): Promise<ISmartDbDatabaseTenantDescriptor> {
|
||||
return this.bridge.sendCommand('createDatabaseTenant', params) as Promise<ISmartDbDatabaseTenantDescriptor>;
|
||||
}
|
||||
|
||||
public async deleteDatabaseTenant(
|
||||
params: ISmartDbDeleteDatabaseTenantInput,
|
||||
): Promise<ISmartDbDeleteDatabaseTenantResult> {
|
||||
return this.bridge.sendCommand('deleteDatabaseTenant', params) as Promise<ISmartDbDeleteDatabaseTenantResult>;
|
||||
}
|
||||
|
||||
public async rotateDatabaseTenantPassword(
|
||||
params: ISmartDbRotateDatabaseTenantPasswordInput,
|
||||
): Promise<ISmartDbDatabaseTenantDescriptor> {
|
||||
return this.bridge.sendCommand('rotateDatabaseTenantPassword', params) as Promise<ISmartDbDatabaseTenantDescriptor>;
|
||||
}
|
||||
|
||||
public async listDatabaseTenants(): Promise<ISmartDbDatabaseTenantDescriptor[]> {
|
||||
const result = await this.bridge.sendCommand('listDatabaseTenants', {} as Record<string, never>) as { tenants: ISmartDbDatabaseTenantDescriptor[] };
|
||||
return result.tenants;
|
||||
}
|
||||
|
||||
public async getDatabaseTenantDescriptor(params: {
|
||||
databaseName: string;
|
||||
username: string;
|
||||
}): Promise<ISmartDbDatabaseTenantDescriptor> {
|
||||
return this.bridge.sendCommand('getDatabaseTenantDescriptor', params) as Promise<ISmartDbDatabaseTenantDescriptor>;
|
||||
}
|
||||
|
||||
public async exportDatabase(params: { databaseName: string }): Promise<ISmartDbDatabaseExport> {
|
||||
return this.bridge.sendCommand('exportDatabase', params) as Promise<ISmartDbDatabaseExport>;
|
||||
}
|
||||
|
||||
public async importDatabase(params: ISmartDbImportDatabaseInput): Promise<ISmartDbImportDatabaseResult> {
|
||||
return this.bridge.sendCommand('importDatabase', params) as Promise<ISmartDbImportDatabaseResult>;
|
||||
}
|
||||
|
||||
public async getOpLog(params: {
|
||||
sinceSeq?: number;
|
||||
limit?: number;
|
||||
|
||||
@@ -8,6 +8,15 @@ import type {
|
||||
ICollectionInfo,
|
||||
IDocumentsResult,
|
||||
ISmartDbMetrics,
|
||||
ISmartDbHealth,
|
||||
ISmartDbDatabaseTenantInput,
|
||||
ISmartDbDeleteDatabaseTenantInput,
|
||||
ISmartDbRotateDatabaseTenantPasswordInput,
|
||||
ISmartDbDatabaseTenantDescriptor,
|
||||
ISmartDbDeleteDatabaseTenantResult,
|
||||
ISmartDbDatabaseExport,
|
||||
ISmartDbImportDatabaseInput,
|
||||
ISmartDbImportDatabaseResult,
|
||||
} from '../rust-db-bridge.js';
|
||||
|
||||
/**
|
||||
@@ -204,6 +213,85 @@ export class SmartdbServer {
|
||||
return this.options.host ?? '127.0.0.1';
|
||||
}
|
||||
|
||||
/**
|
||||
* Create an isolated database/user pair for an application tenant.
|
||||
*/
|
||||
async createDatabaseTenant(
|
||||
params: ISmartDbDatabaseTenantInput,
|
||||
): Promise<ISmartDbDatabaseTenantDescriptor> {
|
||||
const descriptor = await this.bridge.createDatabaseTenant(params);
|
||||
return this.withTenantMongoUri(descriptor, params.password);
|
||||
}
|
||||
|
||||
/**
|
||||
* Delete a tenant database and its tenant user(s).
|
||||
*/
|
||||
async deleteDatabaseTenant(
|
||||
params: ISmartDbDeleteDatabaseTenantInput,
|
||||
): Promise<ISmartDbDeleteDatabaseTenantResult> {
|
||||
return this.bridge.deleteDatabaseTenant(params);
|
||||
}
|
||||
|
||||
/**
|
||||
* Rotate a tenant user's password without restarting the server.
|
||||
*/
|
||||
async rotateDatabaseTenantPassword(
|
||||
params: ISmartDbRotateDatabaseTenantPasswordInput,
|
||||
): Promise<ISmartDbDatabaseTenantDescriptor> {
|
||||
const descriptor = await this.bridge.rotateDatabaseTenantPassword(params);
|
||||
return this.withTenantMongoUri(descriptor, params.password);
|
||||
}
|
||||
|
||||
/**
|
||||
* List known database tenants.
|
||||
*/
|
||||
async listDatabaseTenants(): Promise<ISmartDbDatabaseTenantDescriptor[]> {
|
||||
return this.bridge.listDatabaseTenants();
|
||||
}
|
||||
|
||||
/**
|
||||
* Get a tenant descriptor without exposing a password.
|
||||
*/
|
||||
async getDatabaseTenantDescriptor(params: {
|
||||
databaseName: string;
|
||||
username: string;
|
||||
}): Promise<ISmartDbDatabaseTenantDescriptor> {
|
||||
return this.bridge.getDatabaseTenantDescriptor(params);
|
||||
}
|
||||
|
||||
/**
|
||||
* Export one database as an Extended JSON snapshot.
|
||||
*/
|
||||
async exportDatabase(params: { databaseName: string }): Promise<ISmartDbDatabaseExport> {
|
||||
return this.bridge.exportDatabase(params);
|
||||
}
|
||||
|
||||
/**
|
||||
* Replace one database with a previously exported snapshot.
|
||||
*/
|
||||
async importDatabase(params: ISmartDbImportDatabaseInput): Promise<ISmartDbImportDatabaseResult> {
|
||||
return this.bridge.importDatabase(params);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get readiness/health details for long-running service use.
|
||||
*/
|
||||
async getHealth(): Promise<ISmartDbHealth> {
|
||||
if (!this.isRunning) {
|
||||
return {
|
||||
running: false,
|
||||
storage: this.options.storage,
|
||||
storagePath: this.options.storage === 'file' ? this.options.storagePath : this.options.persistPath,
|
||||
authEnabled: Boolean(this.options.auth?.enabled),
|
||||
authUsers: this.options.auth?.users?.length ?? 0,
|
||||
usersPathConfigured: Boolean(this.options.auth?.usersPath),
|
||||
databaseCount: 0,
|
||||
collectionCount: 0,
|
||||
};
|
||||
}
|
||||
return this.bridge.getHealth();
|
||||
}
|
||||
|
||||
// --- OpLog / Debug API ---
|
||||
|
||||
/**
|
||||
@@ -258,4 +346,26 @@ export class SmartdbServer {
|
||||
async getMetrics(): Promise<ISmartDbMetrics> {
|
||||
return this.bridge.getMetrics();
|
||||
}
|
||||
|
||||
private withTenantMongoUri(
|
||||
descriptor: ISmartDbDatabaseTenantDescriptor,
|
||||
password: string,
|
||||
): ISmartDbDatabaseTenantDescriptor {
|
||||
return {
|
||||
...descriptor,
|
||||
mongodbUri: this.buildTenantMongoUri(descriptor.databaseName, descriptor.username, password),
|
||||
};
|
||||
}
|
||||
|
||||
private buildTenantMongoUri(databaseName: string, username: string, password: string): string {
|
||||
const host = this.options.socketPath
|
||||
? encodeURIComponent(this.options.socketPath)
|
||||
: `${this.options.host ?? '127.0.0.1'}:${this.options.port ?? 27017}`;
|
||||
const auth = `${encodeURIComponent(username)}:${encodeURIComponent(password)}@`;
|
||||
const query = new URLSearchParams({ authSource: databaseName });
|
||||
if (this.options.tls?.enabled) {
|
||||
query.set('tls', 'true');
|
||||
}
|
||||
return `mongodb://${auth}${host}/${encodeURIComponent(databaseName)}?${query.toString()}`;
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user