Files
753bb6bf19 kv: harden in-process backend — atomic getdel, active expiry, multi-replica doc (#5)
Three RED-blessed non-blocking follow-ups on the KV-optional work.

1. Drop the non-atomic getdel() shim in lib/redis.ts. It shadowed BOTH backends'
   native atomic GETDEL with a get->del pipeline (other commands interleave
   between GET and DEL), reintroducing the one-time login-code double-use race
   that fetchAndDeleteLoginCodeData relies on GETDEL to prevent. ioredis maps
   getdel to the single-round-trip Redis GETDEL command; MemoryKV.getdel now
   reads+deletes in one un-yielded step (was `await this.get()` then delete — the
   await yielded the event loop, letting two racers both observe the value).

2. Bound MemoryKV growth. Lazy on-read eviction never fires for write-once-
   never-read keys (rl:<ip> rate-limit counters, one-shot tokens), so the map
   grew unbounded until the pod OOMKilled. Add sweepExpired() (one O(n) active-
   expire pass) run on an unref'd 60s timer, started by lib/redis.ts for the
   server singleton only (edge-gated; no test imports that module, so unit runs
   stay timer-free). MemoryKV stays pure (zero imports).

3. Document in .env.example that re-enabling multi-replica REQUIRES KV_URL
   (single-replica-by-construction otherwise: SQLite-on-RWO + in-process KV).
   The one-time non-silent in-process warning already exists in lib/kv/select.ts;
   no metrics surface exists, so log + doc is sufficient.

Tests: +3 cases (getdel atomicity under concurrent race; 100k-key sweep reclaims
to 0; sweep retains live/no-TTL keys). 28 pass, 3 skip (select.ts skips without
ioredis in a bare checkout), 0 fail.

Co-authored-by: Hanzo Dev <[email protected]>
2026-07-07 16:08:16 -07:00

139 lines
5.4 KiB
TypeScript

/**
* Hanzo KV client
*
* Pluggable KV backend, uniform with commerce (infra/kv.go):
* - KV_URL UNSET ⇒ in-process MemoryKV (the WITHOUT-KV mode; single-replica
* correct). dataroom boots and every KV feature works with no external
* datastore — no phantom `redis://localhost:6379` connect that hangs/retries.
* - KV_URL SET ⇒ external Hanzo KV over the RESP wire protocol via ioredis
* (the WITH-KV mode; multi-replica HA). A malformed KV_URL fails CLOSED
* (throws) — never a silent in-process fallback.
*
* The selected backend exposes an identical method surface, so the Upstash-compat
* shims below and every call site are backend-agnostic. See lib/kv/select.ts.
*
* Environment: KV_URL (e.g. kv://:password@hanzo-kv:6379 or a redis:// DSN).
*/
import { MemoryKV } from "./kv/memory-kv";
import { createKvClient } from "./kv/select";
export const redis = createKvClient();
export const lockerRedisClient = createKvClient();
// In-process backend (KV_URL unset): actively expire keys so write-once-never-read
// keys (rate-limit rl:<ip>, one-shot tokens) can't accrete to an OOM. Server runtime
// only — the edge runtime has no long-lived process to sweep, and active expiry is
// moot against the external ioredis client (Hanzo KV expires its own keys). The timer
// is unref'd (MemoryKV.startActiveExpiry) so it never holds the process open; no test
// imports this module, so unit runs stay timer-free.
if (process.env.NEXT_RUNTIME !== "edge") {
for (const client of [redis, lockerRedisClient]) {
if (client instanceof MemoryKV) client.startActiveExpiry();
}
}
// Upstash-compatible set() shim — translates options-object calls to ioredis positional args
const originalSet = redis.set.bind(redis);
(redis as any).set = async function (
key: string,
value: any,
opts?: { ex?: number; px?: number; pxat?: number; exat?: number; nx?: boolean },
) {
const val = typeof value === "object" ? JSON.stringify(value) : String(value);
if (!opts) return originalSet(key, val);
const args: any[] = [key, val];
if (opts.ex) { args.push("EX", opts.ex); }
else if (opts.px) { args.push("PX", opts.px); }
else if (opts.pxat) { args.push("PXAT", opts.pxat); }
else if (opts.exat) { args.push("EXAT", opts.exat); }
if (opts.nx) { args.push("NX"); }
return (redis as any).call("SET", ...args);
};
// Upstash-compatible zadd() shim — translates { score, member } to positional args
const originalZadd = redis.zadd.bind(redis);
(redis as any).zadd = async function (key: string, ...args: any[]) {
if (args.length === 1 && typeof args[0] === "object" && "score" in args[0]) {
const { score, member } = args[0];
return originalZadd(key, score, member);
}
return originalZadd(key, ...args);
};
// Upstash-compatible zrange() shim — translates { byScore, rev } options
const originalZrange = redis.zrange.bind(redis);
const originalZrevrange = redis.zrevrange.bind(redis);
const originalZrangebyscore = redis.zrangebyscore.bind(redis);
(redis as any).zrange = async function (key: string, start: number | string, stop: number | string, opts?: { byScore?: boolean; rev?: boolean }) {
if (opts?.rev) return originalZrevrange(key, start as number, stop as number);
if (opts?.byScore) return originalZrangebyscore(key, start, stop);
return originalZrange(key, start as number, stop as number);
};
// No getdel() shim: GETDEL is atomic natively on BOTH backends — ioredis maps it
// to the single-round-trip Redis GETDEL command, and MemoryKV.getdel reads+deletes
// in one un-yielded step. A get→del pipeline here would NOT be atomic (other
// commands interleave between GET and DEL) and would reintroduce the one-time
// login-code double-use race. Do not add one.
// Upstash-compatible get() shim — try to auto-parse JSON
const originalGet = redis.get.bind(redis);
(redis as any).get = async function (key: string) {
const val = await originalGet(key);
if (val === null) return null;
try { return JSON.parse(val); } catch { return val; }
};
// Upstash-compatible hincrby — already same signature in ioredis
// Simple sliding-window rate limiter using Hanzo KV
export function ratelimit(
requests: number = 10,
window:
| `${number} ms`
| `${number} s`
| `${number} m`
| `${number} h`
| `${number} d` = "10 s",
) {
const windowMs = parseWindow(window);
return {
limit: async (identifier: string) => {
const key = `rl:${identifier}`;
const now = Date.now();
const windowStart = now - windowMs;
const pipeline = redis.pipeline();
pipeline.zremrangebyscore(key, 0, windowStart);
pipeline.zadd(key, now, `${now}:${Math.random()}`);
pipeline.zcard(key);
pipeline.pexpire(key, windowMs);
const results = await pipeline.exec();
const count = (results?.[2]?.[1] as number) ?? 0;
return {
success: count <= requests,
remaining: Math.max(0, requests - count),
limit: requests,
reset: now + windowMs,
};
},
};
}
function parseWindow(window: string): number {
const match = window.match(/^(\d+)\s*(ms|s|m|h|d)$/);
if (!match) return 10000;
const [, num, unit] = match;
const n = parseInt(num!, 10);
switch (unit) {
case "ms": return n;
case "s": return n * 1000;
case "m": return n * 60 * 1000;
case "h": return n * 60 * 60 * 1000;
case "d": return n * 24 * 60 * 60 * 1000;
default: return 10000;
}
}