@crvouga/mockingbird-service-redis 0.1.0

package/README.md

@@ -0,0 +1,59 @@
+# @crvouga/mockingbird-service-redis
+
+> Familiar calls. Faithful echoes. Part of [Mockingbird](https://github.com/crvouga/mockingbird).
+
+In-process Redis for tests. `createRedis()` is a pure TypeScript RESP store: call commands on
+`redis.client()`, or speak RESP to the TCP server (`mockingbird-redis`, or `serve` from
+`@crvouga/mockingbird-service-redis/server`). It is not an HTTP API mock and has no `createRuntime`.
+`./server` also exports `serveTarget`, so `serve --config` can boot it: `GET /health` reports
+`service: redis`, and RESP listens on an ephemeral `redis://127.0.0.1:<port>` printed at startup.
+`mockingbird-redis` still binds `6379` unless `--port` is set.
+
+Replies follow the Redis command reference for a single standalone node and were spot-checked
+against Redis 8.4.0. The advertised version is Redis 7.2.4 so clients do not probe Redis 8 modules.
+This package is a work in progress.
+
+## Install
+
+```bash
+npm install -D @crvouga/mockingbird-service-redis
+```
+
+## Usage
+
+```ts
+import { createRedis, manualClock } from "@crvouga/mockingbird-service-redis"
+
+const clock = manualClock(1_700_000_000_000)
+const redis = createRedis({ clock })
+const client = redis.client()
+const set = await client.call("SET", "lock", "token", "PX", 1000)
+console.log(set)
+redis.advance(1000)
+```
+
+Two `createRedis()` instances never share keys. `SELECT` isolates logical databases 0–15 inside
+one instance. `redis.advance(ms)` moves an injected clock. `redis.inspect()`, `redis.fault()`,
+`redis.pauseConsumers()`, `redis.reset()`, and `redis.waiterCount()` are the test controls.
+
+`ioredis` can connect to the TCP server unchanged. Cluster `MOVED` / `ASK` is not implemented:
+`CLUSTER` and `READONLY` answer that cluster support is disabled.
+
+## API
+
+- `createRedis(options?)` returns a `Redis` instance.
+- `Redis` holds the store, the clock, and the test controls (`client`, `advance`, `fault`, `inspect`, `pauseConsumers`, `reset`, `waiterCount`, `close`).
+- `RedisClient` is one connection: `call`, `raw`, `pipeline`, `quit`, `onPush`, and `protocol`.
+- `RedisPipeline` queues `call`s and runs them in `exec`.
+- `RedisConnectionError` is a dropped connection, a timeout fault, or a closed server.
+- `RedisReplyError` is a Redis error reply raised by `call`.
+- `manualClock(start)` moves only when `advance` is called. `wallClock` follows `Date.now()`.
+- `encodeReply(reply, protocol)` writes a RESP2 or RESP3 frame.
+
+## Deliberately not modelled
+
+- Cluster redirects (`MOVED`, `ASK`) and replica replication. `ROLE` stays `master`.
+- Redis 8 modules, and the full Redis command set.
+- Full Lua 5.1, `cmsgpack`, and BullMQ beyond the script subset (`cjson`, `redis.call` / `pcall`).
+- `XADD` / `XTRIM` `MAXLEN ~` trims exactly.
+- Set members are returned in byte order so results stay deterministic.

package/SUPPORT.md

@@ -0,0 +1,23 @@
+# Redis (Mockingbird subset) — command support
+
+Work in progress. Replies are checked against the Redis command reference and local Redis 8.4.0
+spot checks. The server reports `redis_version` 7.2.4 and `redis_mode:standalone`.
+
+| area | commands | notes |
+| --- | --- | --- |
+| connection | `AUTH`, `HELLO`, `PING`, `QUIT`, `RESET`, `SELECT`, `CLIENT`, `INFO`, `ECHO` | RESP2 and RESP3. `HELLO 3` switches before its map reply. |
+| strings | `GET`, `SET`, `MGET`, `MSET`, `INCR`, `DECR`, `APPEND`, `GETSET`, `GETDEL`, `GETEX` | `NX` `XX` `EX` `PX` `EXAT` `PXAT` `KEEPTTL` `GET`. |
+| expiration | `EXPIRE`, `PEXPIRE`, `EXPIREAT`, `PEXPIREAT`, `TTL`, `PTTL`, `PERSIST` | Injected clock. Negative `EXPIRE` deletes an existing key. |
+| keys | `DEL`, `EXISTS`, `TYPE`, `SCAN`, `KEYS`, `RENAME`, `FLUSHDB`, `FLUSHALL` | `SCAN` cursor is a bulk string. |
+| hashes | `HSET`, `HGET`, `HMGET`, `HGETALL`, `HDEL`, `HINCRBY` | |
+| lists | `LPUSH`, `RPUSH`, `LPOP`, `RPOP`, `LRANGE`, `LMOVE`, `BLPOP`, `BRPOP` | Blocking waits release the command queue. |
+| sets | `SADD`, `SREM`, `SMEMBERS`, `SISMEMBER`, `SPOP` | Members are ordered bytewise. |
+| sorted sets | `ZADD`, `ZRANGE`, `ZPOPMIN`, `BZPOPMIN`, `ZINCRBY` | Integer scores encode without a trailing `.0`. |
+| streams | `XADD`, `XREAD`, `XGROUP`, `XREADGROUP`, `XACK`, `XPENDING`, `XCLAIM`, `XAUTOCLAIM` | Consumer-group pending entries and claim. |
+| transactions | `MULTI`, `EXEC`, `DISCARD`, `WATCH`, `UNWATCH` | A watched key change makes `EXEC` a null array. |
+| pub/sub | `SUBSCRIBE`, `UNSUBSCRIBE`, `PSUBSCRIBE`, `PUBLISH`, `PUBSUB` | |
+| scripts | `EVAL`, `EVALSHA`, `SCRIPT LOAD`, `SCRIPT EXISTS`, `SCRIPT FLUSH` | Lua subset plus `cjson`. No `cmsgpack`. |
+| cluster | `CLUSTER`, `READONLY`, `ASKING` | Single node: cluster support disabled. |
+
+Out of scope for this pass: Redis Cluster, Redis 8 modules, a complete Lua 5.1 runtime, and full
+BullMQ compatibility.