app/lib/rate-limit.mjs

Functions

Imports

It imports no other module of this repo. Imported by app/lib/carrel/site-api.server.ts, app/lib/operator/auth.server.ts, app/lib/preview-links.server.ts, app/lib/search/ask-guard.server.ts, app/lib/smoke.server.ts, app/routes/api.csp-report.ts, app/routes/api.health.ts, app/routes/webmention.ts.

Source

1import { limit } from "@dustinedwards/site-runtime/rate-limit";
2
3/**
4 * One use of a fixed-window limit keyed by `key`, counted exactly by the ASK_BUDGET namespace, which
5 * is the whole site's limiter. This site refuses when the counter is unavailable, on every call: a
6 * guard that passes silently when its counter is gone is never noticed. The verdict carries the time
7 * left in the window (`retryAfterSeconds`), which is what a refusal sends as Retry-After.
8 *
9 * @param {Env} env
10 * @param {string} key
11 * @param {number} maxHits
12 * @param {number} windowSeconds
13 * @returns {ReturnType<typeof limit>}
14 */
15export function limitHit(env, key, maxHits, windowSeconds) {
16  return limit(env.ASK_BUDGET, key, [{ limit: maxHits, windowSeconds }], { onUnavailable: "refuse" });
17}