Files
OmniRoute/tests/unit/rate-limiter-redis-optional.test.ts
Reza Rezaei 7360ca4242 feat(redis): add configurable key namespace prefix (#11042)
Validated on the combined board over tip 80d931ae: quota-redis-store (incl. the KEY_PREFIX derivation test), local-redis-status and rate-limiter-redis-optional green, typecheck:core clean. One pre-merge fix pushed to the branch: docs/reference/ENVIRONMENT.md gained the REDIS_KEY_PREFIX row (env-doc-sync gate requires every .env.example var documented). Board note: the redis tests leave an ioredis retry handle open and hang the runner exit locally — assertions all pass; pre-existing pattern, not from this PR. Thank you @MeRezaRezaei!
2026-08-22 18:56:45 -03:00

55 lines
2.1 KiB
TypeScript

/**
* Issue #2357 - Redis is optional. When `REDIS_URL` is unset, the rate
* limiter must use the in-memory store instead of probing localhost.
*
* `ioredis` has a packaging quirk (`@ioredis/commands/built/commands.json`
* is actually JS, not JSON) that prevents `node:test` from importing it
* cleanly, so we verify the contract at the source level instead.
*/
import test from "node:test";
import assert from "node:assert/strict";
import fs from "node:fs";
import path from "node:path";
import { fileURLToPath } from "node:url";
const __dirname = path.dirname(fileURLToPath(import.meta.url));
const RATE_LIMITER_SRC = path.resolve(__dirname, "../../src/shared/utils/rateLimiter.ts");
const src = fs.readFileSync(RATE_LIMITER_SRC, "utf8");
test("#2357 REDIS_URL no longer falls back to localhost:6379 silently", () => {
assert.ok(
!src.includes('process.env.REDIS_URL || "redis://localhost:6379"'),
"rateLimiter must not default REDIS_URL to localhost"
);
assert.ok(
src.includes('const REDIS_URL = process.env.REDIS_URL?.trim() || "";'),
"rateLimiter must only use Redis when REDIS_URL is explicitly configured"
);
});
test("#2357 getRedisClient is strict when REDIS_URL is not set", () => {
assert.ok(
src.includes('throw new Error("Redis is not configured");'),
"getRedisClient must throw when Redis is not configured"
);
});
test("#2357 checkRateLimit falls back when REDIS_URL is unset", () => {
assert.ok(
src.includes("if (!isRedisConfigured())") &&
src.includes("return checkInMemoryRateLimit(FALLBACK_MEMORY_STORE, keyId, rules);"),
"checkRateLimit must route to the in-memory fallback when Redis is disabled"
);
});
test("redis namespace prefix: rate limiter + auth cache keys are namespaced", () => {
assert.ok(
src.includes('process.env.REDIS_KEY_PREFIX?.trim() || "omniroute:"'),
"rateLimiter must read REDIS_KEY_PREFIX with an omniroute: default"
);
assert.ok(
src.includes("keyPrefix: REDIS_KEY_PREFIX"),
"rateLimiter must pass the prefix as the ioredis keyPrefix so all keys are namespaced"
);
});