mirror of
https://github.com/diegosouzapw/OmniRoute.git
synced 2026-08-23 15:42:12 +03:00
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!
This commit is contained in:
38
tests/unit/local-redis-status.test.ts
Normal file
38
tests/unit/local-redis-status.test.ts
Normal file
@@ -0,0 +1,38 @@
|
||||
/**
|
||||
* tests/unit/local-redis-status.test.ts
|
||||
*
|
||||
* Coverage for src/app/api/local/redis/status/route.ts:
|
||||
* - The status endpoint must report OmniRoute as "connected" whenever the
|
||||
* native REDIS_URL is reachable — not only when a Docker/Podman container
|
||||
* is present. This is the production path used by this instance
|
||||
* (redis on 127.0.0.1:6379, no container).
|
||||
*
|
||||
* Verified at the source-contract level (the route imports Next.js + the route
|
||||
* guard, which is heavy to import in the native runner and would make the test
|
||||
* environment-dependent on a live container runtime).
|
||||
*/
|
||||
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 STATUS_SRC = path.resolve(__dirname, "../../src/app/api/local/redis/status/route.ts");
|
||||
const src = fs.readFileSync(STATUS_SRC, "utf8");
|
||||
|
||||
test("redis status: reports running via REDIS_URL reachability, not only Docker", () => {
|
||||
assert.ok(src.includes("parseRedisUrl"), "status route must parse REDIS_URL");
|
||||
assert.ok(
|
||||
src.includes("redisUrlReachable"),
|
||||
"status route must probe REDIS_URL reachability"
|
||||
);
|
||||
assert.ok(
|
||||
src.includes("redisUrlConfigured"),
|
||||
"status route must report whether REDIS_URL is configured"
|
||||
);
|
||||
assert.ok(
|
||||
src.includes("const running = container.running || redisUrlReachable;"),
|
||||
"status route must treat a reachable native REDIS_URL as a connected state"
|
||||
);
|
||||
});
|
||||
@@ -20,6 +20,9 @@ import assert from "node:assert/strict";
|
||||
import fs from "node:fs";
|
||||
import os from "node:os";
|
||||
import path from "node:path";
|
||||
import { fileURLToPath } from "node:url";
|
||||
|
||||
const __dirname = path.dirname(fileURLToPath(import.meta.url));
|
||||
|
||||
const TEST_DATA_DIR = fs.mkdtempSync(path.join(os.tmpdir(), "omniroute-redis-store-"));
|
||||
process.env.DATA_DIR = TEST_DATA_DIR;
|
||||
@@ -282,3 +285,16 @@ test("redisQuotaStore: resetRedisQuotaStore resets the store singleton", async (
|
||||
// After reset, a new instance is created
|
||||
assert.ok(store2, "Should create new instance after reset");
|
||||
});
|
||||
|
||||
test("redis namespace prefix: quota store KEY_PREFIX derives from REDIS_KEY_PREFIX", () => {
|
||||
const quotaSrc = fs.readFileSync(
|
||||
path.resolve(__dirname, "../../src/lib/quota/redisQuotaStore.ts"),
|
||||
"utf8"
|
||||
);
|
||||
assert.ok(
|
||||
quotaSrc.includes('process.env.REDIS_KEY_PREFIX?.trim() || "omniroute:"') &&
|
||||
quotaSrc.includes("const KEY_PREFIX = `") &&
|
||||
quotaSrc.includes("quota`"),
|
||||
"redisQuotaStore KEY_PREFIX must derive from REDIS_KEY_PREFIX env, defaulting to omniroute:quota"
|
||||
);
|
||||
});
|
||||
|
||||
@@ -41,3 +41,14 @@ test("#2357 checkRateLimit falls back when REDIS_URL is unset", () => {
|
||||
"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"
|
||||
);
|
||||
});
|
||||
|
||||
Reference in New Issue
Block a user