File size: 8,658 Bytes
4e23b01 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 | // src/server.ts
//
// A minimal RESP (REdis Serialization Protocol) TCP front-end for MiniDb, so
// existing Redis clients (redis-cli, ioredis, ...) can talk to it.
import net from 'node:net';
import type { Socket } from 'node:net';
import { MiniDb } from './index.js';
const CRLF = '\r\n';
const NIL = `$-1${CRLF}`;
const reply = {
ok: () => `+OK${CRLF}`,
pong: () => `+PONG${CRLF}`,
int: (n: number) => `:${n}${CRLF}`,
err: (m: string) => `-ERR ${m}${CRLF}`,
// Bulk replies carry raw bytes. Build a Buffer so non-ASCII / binary values
// are written verbatim instead of being re-encoded as UTF-8 (which corrupted
// them and desynced the protocol when `socket.write(string)` defaulted to
// utf8).
bulk: (v: unknown): Buffer => {
if (v === undefined || v === null) return Buffer.from(NIL);
const b = Buffer.isBuffer(v) ? v : Buffer.from(String(v as string));
return Buffer.concat([Buffer.from(`$${b.length}${CRLF}`), b, Buffer.from(CRLF)]);
},
array: (items: unknown[]): Buffer => {
const parts: Buffer[] = [Buffer.from(`*${items.length}${CRLF}`)];
for (const it of items) parts.push(reply.bulk(it));
return Buffer.concat(parts);
},
};
class RespParser {
private buf: Buffer = Buffer.alloc(0);
private readonly maxBuf: number;
constructor({ maxBuf = 64 * 1024 * 1024 }: { maxBuf?: number } = {}) {
this.maxBuf = maxBuf;
}
*feed(chunk: Buffer): Generator<Buffer[]> {
this.buf = this.buf.length ? Buffer.concat([this.buf, chunk]) : chunk;
if (this.buf.length > this.maxBuf) {
// Drop the buffered oversized request before reporting: without the
// reset every later chunk would fail with the same error and the giant
// buffer would be retained for the life of the connection.
this.buf = Buffer.alloc(0);
throw new Error(`RESP request too large (>${this.maxBuf} bytes)`);
}
while (this.buf.length) {
const parsed = this.tryParse();
if (!parsed) break;
yield parsed;
}
}
private tryParse(): Buffer[] | null {
if (this.buf[0] !== 0x2a /* '*' */) {
const idx = this.buf.indexOf(CRLF);
if (idx === -1) return null;
const line = this.buf.subarray(0, idx).toString();
this.buf = this.buf.subarray(idx + 2);
return line.split(' ').filter(Boolean).map((s) => Buffer.from(s));
}
let pos = 1;
let end = this.buf.indexOf(CRLF, pos);
if (end === -1) return null;
const argc = Number(this.buf.subarray(pos, end).toString());
pos = end + 2;
const args: Buffer[] = [];
for (let i = 0; i < argc; i++) {
if (pos >= this.buf.length || this.buf[pos] !== 0x24 /* '$' */) return null;
pos++;
end = this.buf.indexOf(CRLF, pos);
if (end === -1) return null;
const len = Number(this.buf.subarray(pos, end).toString());
pos = end + 2;
if (this.buf.length - pos < len + 2) return null;
args.push(this.buf.subarray(pos, pos + len));
pos += len + 2;
}
this.buf = this.buf.subarray(pos);
return args;
}
}
async function handle(db: MiniDb<string>, args: Buffer[]): Promise<string | Buffer | null> {
const cmd = args[0]!.toString().toUpperCase();
const S = (i: number): string | undefined => (args[i] === undefined ? undefined : args[i]!.toString());
switch (cmd) {
case 'PING':
return args[1] ? reply.bulk(S(1)) : reply.pong();
case 'ECHO':
return reply.bulk(S(1));
case 'GET': {
const v = db.get(S(1)!);
return reply.bulk(v === undefined ? null : v);
}
case 'SET': {
const key = S(1)!;
const val = S(2)!;
let ttl: number | undefined;
for (let i = 3; i < args.length; i++) {
const opt = S(i)!.toUpperCase();
if (opt === 'EX') ttl = Number(S(++i)) * 1000;
else if (opt === 'PX') ttl = Number(S(++i));
}
await db.set(key, val, ttl ? { ttl } : {});
return reply.ok();
}
case 'DEL': {
let n = 0;
for (let i = 1; i < args.length; i++) if (await db.del(S(i)!)) n++;
return reply.int(n);
}
case 'EXISTS':
return reply.int(db.has(S(1)!) ? 1 : 0);
case 'MGET': {
const out: unknown[] = [];
for (let i = 1; i < args.length; i++) {
const v = db.get(S(i)!);
out.push(v === undefined ? null : v);
}
return reply.array(out);
}
case 'MSET': {
const entries: (readonly [string, string])[] = [];
for (let i = 1; i + 1 < args.length; i += 2) entries.push([S(i)!, S(i + 1)!]);
await db.mset(entries); // atomic batch (single WAL frame), like Redis MSET
return reply.ok();
}
case 'TTL':
return reply.int(Math.trunc(db.ttl(S(1)!) / 1000));
case 'DBSIZE':
return reply.int(db.size);
case 'COMPACT':
await db.compact();
return reply.ok();
case 'INFO':
return reply.bulk(`minidb_version:0.0.1${CRLF}keys:${db.size}${CRLF}compactions:${db.stats.compactions}${CRLF}`);
case 'QUIT':
return null;
default:
return reply.err(`unknown command '${cmd}'`);
}
}
export interface ServerOptions {
dir: string;
port?: number;
host?: string;
fsyncPolicy?: 'always' | 'everysec' | 'no';
}
export interface ServerHandle {
server: net.Server;
db: MiniDb<string>;
close: () => Promise<void>;
port: number;
host: string;
}
export async function startServer({ dir, port = 6379, host = '127.0.0.1', fsyncPolicy = 'everysec' }: ServerOptions): Promise<ServerHandle> {
const db = (await MiniDb.open({ dir, valueCodec: 'string', fsyncPolicy })) as MiniDb<string>;
const server = net.createServer((socket: Socket) => {
const parser = new RespParser();
// Serialize per-connection processing: a new chunk's commands are queued
// behind the previous chunk's in-flight work, so replies always leave in
// request order. Without this, a slow command in one packet (e.g. SET with
// fsync 'always') let replies from the next packet overtake it, breaking
// pipelined clients.
let queue: Promise<void> = Promise.resolve();
// A client that resets the connection while a large reply is being written
// makes the next write fail with EPIPE/ECONNRESET. Without an 'error'
// listener that event becomes an uncaught exception and takes the whole
// process down, so swallow it: the connection is dead either way, and the
// queued work below skips further writes to it.
socket.on('error', () => {});
// Never write to a destroyed socket: write-after-destroy would just
// surface as another 'error' event on the dead connection.
const send = (res: string | Buffer): void => {
if (!socket.destroyed) socket.write(res);
};
socket.on('data', (chunk: Buffer) => {
queue = queue.then(async () => {
try {
for (const args of parser.feed(chunk)) {
if (socket.destroyed) return;
let res: string | Buffer | null;
try {
res = await handle(db, args);
} catch (e) {
// One failing command must not starve the replies of the
// commands already parsed from the same chunk.
res = reply.err((e as Error).message);
}
if (res === null) {
socket.end();
return;
}
send(res);
}
} catch (e) {
// Parser-level failure (e.g. oversized request): feed() has already
// reset its buffer, so the connection can keep serving new commands.
send(reply.err((e as Error).message));
}
});
});
});
await new Promise<void>((resolve) => server.listen(port, host, resolve));
const actualPort = (server.address() as net.AddressInfo).port;
const close = async (): Promise<void> => {
server.close();
await db.close();
};
process.on('SIGINT', () => {
void close().then(() => process.exit(0));
});
return { server, db, close, port: actualPort, host };
}
// Run directly: node --import tsx src/server.ts --dir ./data --port 6379
if (import.meta.url === `file://${process.argv[1]}`) {
const argv = process.argv.slice(2);
const arg = (name: string, def: string): string => {
const i = argv.indexOf(`--${name}`);
return i === -1 ? def : argv[i + 1]!;
};
const dir = arg('dir', './data');
const port = Number(arg('port', '6379'));
const fsyncPolicy = arg('fsync', 'everysec') as 'always' | 'everysec' | 'no';
const { host, port: p } = await startServer({ dir, port, fsyncPolicy });
console.log(`minidb RESP server listening on ${host}:${p} (dir=${dir}, fsync=${fsyncPolicy})`);
}
|