Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
106 changes: 78 additions & 28 deletions README.md

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,7 @@
"scripts": {
"benchmark:request-local": "pnpm build && node scripts/benchmark-request-local.mjs",
"benchmark:redis-write": "pnpm build && node scripts/benchmark-redis-write.mjs",
"benchmark:stale-on-error": "pnpm build && node scripts/benchmark-stale-on-error.mjs",
"build": "tsup src/index.ts src/datadog.ts src/node-redis.ts src/prometheus.ts src/redis-protocol.ts src/valkey-glide.ts --format esm,cjs --dts --clean",
"check": "pnpm typecheck && pnpm test && pnpm build && pnpm test:package",
"typecheck": "tsc --noEmit",
Expand Down
25 changes: 18 additions & 7 deletions scripts/benchmark-request-local.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -244,11 +244,12 @@ async function benchmarkRedisReadDeadlineCoalescing(fanout) {
const originalSetTimeout = globalThis.setTimeout;
const originalClearTimeout = globalThis.clearTimeout;
const redisClient = {
async read() {
enforcesMaxAge: true,
async read({ maxAgeMs }) {
redisReadCalls += 1;
started.resolve();
await gate.promise;
return JSON.stringify("shared");
return freshFrame(JSON.stringify("shared"), maxAgeMs);
},
async write() {
return true;
Expand Down Expand Up @@ -319,10 +320,11 @@ async function benchmarkSequentialTrackedRedisHits(iterations, { scenario, useCa
let redisWriteCalls = 0;
let redisInvalidationCalls = 0;
const redisClient = {
async read({ watermarkKey }) {
enforcesMaxAge: true,
async read({ watermarkKey, maxAgeMs }) {
assert.equal(typeof watermarkKey, "string", "the benchmark must exercise tracked Redis reads");
redisReadCalls += 1;
return JSON.stringify("shared");
return freshFrame(JSON.stringify("shared"), maxAgeMs);
},
async write() {
redisWriteCalls += 1;
Expand Down Expand Up @@ -392,10 +394,11 @@ async function benchmarkDarkShadowDetachment() {
const cachedValue = { source: "redis" };
const sourceValue = { source: "truth" };
const redisClient = {
async read({ watermarkKey }) {
enforcesMaxAge: true,
async read({ watermarkKey, maxAgeMs }) {
assert.equal(typeof watermarkKey, "string", "dark shadow reads must remain tracked");
redisReadCalls += 1;
return await readGate.promise;
return freshFrame(await readGate.promise, maxAgeMs);
},
async write() {
redisWriteCalls += 1;
Expand Down Expand Up @@ -476,8 +479,10 @@ async function benchmarkDarkShadowFillDetachment() {
let redisWriteCalls = 0;
const sourceValue = { source: "truth" };
const redisClient = {
async read({ watermarkKey }) {
enforcesMaxAge: true,
async read({ watermarkKey, maxAgeMs }) {
assert.equal(typeof watermarkKey, "string", "dark shadow reads must remain tracked");
assert(Number.isSafeInteger(maxAgeMs) && maxAgeMs > 0, "reads must request a positive max age");
redisReadCalls += 1;
return null;
},
Expand Down Expand Up @@ -558,6 +563,12 @@ function deferred() {
return { promise, resolve };
}

function freshFrame(payload, maxAgeMs) {
assert(Number.isSafeInteger(maxAgeMs) && maxAgeMs > 0, "reads must request a positive max age");
const createdAtMs = Date.now();
return Date.now() - createdAtMs < maxAgeMs ? { payload, createdAtMs } : null;
}

function readPositiveInteger(name, fallback) {
const raw = process.env[name];
if (raw === undefined) {
Expand Down
Loading
Loading