Build the rate limiter on the new CounterStore, so limits hold across server instances
Los mantenedores suelen responder en 1 día
Evaluación
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Aptitud para principiantes
- 83/100
- Tipo de issue
- Nueva funcionalidad
- Claridad
- Bien especificado
- Estado de actividad
- Activo
- Stack tecnológico
- node.js, typescript
Línea de trabajo
Read packages/core/src/storage/types.ts for the CounterStore contract, then review packages/server/src/rate-limit.ts and its tests for existing behavior. Implement the algorithm in packages/core/src/limits/rate-limit.ts and add fake-clock and concurrency coverage in packages/core/tests/limits/rate-limit.test.ts, using the in-memory counter store. Done means the listed acceptance criteria pass and the core package exports the limiter with a minor changeset.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
The server's rate limiter keeps its counts in a Map in the process (packages/server/src/rate-limit.ts). On Vercel or Workers every instance has its own map, so a visitor spread over five instances gets five times the limit. It also needs a setInterval for cleanup (packages/server/src/handler.ts, line 35), and Workers don't allow timers at global scope.
@chatcops/core now has a CounterStore interface (packages/core/src/storage/types.ts): atomic counters that reset after a while, backed by Redis, Postgres and so on. This issue is the rate limit algorithm on top of it. Wiring it into the server comes in a later PR.
What to do
Create packages/core/src/limits/rate-limit.ts:
export interface RateLimitRule {
limit: number; // requests allowed per window
windowMs: number;
}
export interface RateLimitResult {
allowed: boolean;
/** Requests left in the current window, never below 0. */
remaining: number;
/** When denied: how long until a request would be allowed again. */
retryAfterMs?: number;
}
export function createRateLimiter(counters: CounterStore, rule: RateLimitRule, options?: { prefix?: string; now?: () => number }): {
check(key: string): Promise<RateLimitResult>;
};
Use a sliding window built from two fixed windows. It's smooth at window edges (no burst of 2x the limit at the boundary) and needs only two counters:
- The window index is
Math.floor(now / windowMs). Count this request withcounters.increment(${prefix}:${key}:${index}, 1, 2 * windowMs), and read the previous window's counter withget. - The estimated count is
previous * (1 - elapsedInWindow / windowMs) + current. Allow the request when it's at mostlimit. - Denied requests still count, so a client that keeps hammering stays limited.
retryAfterMsis an estimate: the time until the estimate drops back under the limit, at least 1 ms and at mostwindowMs. Explain the formula in a comment.prefixdefaults to'rl'. Validatelimit > 0andwindowMs > 0likeRateLimiterdoes.
Where to look
packages/server/src/rate-limit.ts(today's limiter and its tests inpackages/server/tests/rate-limit.test.ts)packages/core/src/storage/memory.ts(memoryStorage().counters, use it in the tests with a fakenow)- Cloudflare's write-up of the same sliding window idea
Acceptance criteria
- New
packages/core/src/limits/rate-limit.tsandpackages/core/tests/limits/rate-limit.test.ts, exported from@chatcops/core - Tests with a fake clock: the first
limitrequests pass and the next one doesn't; the count decays across the window boundary (half the previous window still counts at the midpoint); keys don't affect each other;retryAfterMsis set when denied and within bounds - A test with 30 concurrent
check()calls against a limit of 10 allows exactly 10 - Changeset for
@chatcops/core(minor) -
pnpm test:coverageandpnpm lintpass
Want to work on this? Comment below and I'll assign it to you. Please take one issue at a time, branch off dev, and open your PR against dev with Closes #<this issue number>. Setup notes (pnpm, build before test) are in CONTRIBUTING.md.
- Lenguaje dominante
- TypeScript
- Estrellas
- 13
- Forks
- 7
- Merge medio
- 3 h 41 min
- PR fusionados (30 d)
- 155
Preparar el entorno
- Sin Dockerfile ni archivo de Docker Compose
- Tiene una plantilla de pull request
- Leer la guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de codercops/chatcops
-
Document the pre-chat formPosiblemente ocupada @masyarakatai la tomó hace 5 días. Abiertodocumentation good first issue hacktoberfest widget
Dificultad 2/5 1-3 horas Aptitud para principiantes 88/100
codercops/chatcops#70 · 5 comentarios ·
Los mantenedores suelen responder en 1 día
-
docs: update the providers page for openai-compatible, registerProvider and provider importsPosiblemente ocupada @prakashNalla la tomó hoy. Abiertodocumentation good first issue hacktoberfest website
Dificultad 3/5 1-2 días Aptitud para principiantes 76/100
codercops/chatcops#291 · 1 comentario ·
Los mantenedores suelen responder en 1 día
-
docs: add a protocol reference page for custom clientsPosiblemente ocupada @kachamsiddarth la tomó hoy. Abiertodocumentation good first issue hacktoberfest website
codercops/chatcops#286 · 2 comentarios · 1 asignado ·
Los mantenedores suelen responder en 1 día
-
Create @chatcops/store-cloudflare (D1, KV and a Durable Object counter)Posiblemente ocupada @bhushan4work la tomó hoy. Abiertoenhancement hacktoberfest help wanted server
Dificultad 5/5 Más de una semana Aptitud para principiantes 25/100
codercops/chatcops#249 · 2 comentarios · 1 asignado ·
Los mantenedores suelen responder en 1 día
-
Create @chatcops/store-sqlite, a store for single-server setupsPosiblemente ocupada @srikar-naidu la tomó hoy. Abiertoenhancement hacktoberfest help wanted server
Dificultad 5/5 Más de una semana Aptitud para principiantes 35/100
codercops/chatcops#247 · 3 comentarios · 1 asignado ·
Los mantenedores suelen responder en 1 día
Todos los issues de codercops/chatcops
Issues similares
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
chaitin/MonkeyCode#1437 ·
Los mantenedores suelen responder en 1 día
-
rtdb-info-connected-order test: unhandled 'connection is closed' rejection fails the CLI suiteAbierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 69/100
carbon-design-system/carbon-ai-chat#2615 ·
Los mantenedores suelen responder en 1 día
-
e2e-failure ready-to-code
Dificultad 2/5 1-3 horas Aptitud para principiantes 76/100
redhat-developer/rhdh-plugin-export-overlays#4486 · 1 comentario ·
Los mantenedores suelen responder en 1 día
-
[Bug]: fileUploadMatrix.test.ts URL case does a real DNS lookup and fails offlinePosiblemente ocupada @r2jaff la tomó hoy. Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
ComposioHQ/composio#5054 ·
Los mantenedores suelen responder en 1 día