Files
fn_registry/functions/infra/rate_limiter_check.md
egutierrez 036c0a8d63 feat(infra): rate limiter token-bucket in-memory + tipos y core funcs
Implementa fase 1 del issue 0016:
- Tipos RateLimiter, RateLimitConfig y RateLimitResult en types/infra/
- rate_limiter_new: constructor con validacion rate/burst > 0
- rate_limiter_check: evalua token bucket por key, calcula Allowed/Remaining/ResetAt/RetryAfter
- rate_limit_headers (pure): construye headers IETF X-RateLimit-* y Retry-After
- rate_limiter_cleanup: goroutine GC de entries inactivas con stop idempotente

Sin dependencias externas (no Redis). sync.Mutex + map. Algoritmo token bucket
estandar con recarga lineal proporcional al tiempo transcurrido.
2026-04-18 17:11:22 +02:00

43 lines
1.8 KiB
Markdown

---
name: rate_limiter_check
kind: function
lang: go
domain: infra
version: "1.0.0"
purity: impure
signature: "func RateLimiterCheck(rl *RateLimiter, key string) RateLimitResult"
description: "Evalua un request del cliente identificado por key contra el token bucket. Recarga tokens segun el tiempo transcurrido y consume uno si esta permitido. Seguro para uso concurrente (mutex interno)."
tags: [rate_limit, http, middleware, token_bucket, check, infra]
uses_functions: []
uses_types: [RateLimiter_go_infra, RateLimitResult_go_infra]
returns: [RateLimitResult_go_infra]
returns_optional: false
error_type: "error_go_core"
imports: [math, time]
params:
- name: rl
desc: "puntero al RateLimiter creado con RateLimiterNew"
- name: key
desc: "identificador del cliente (IP, API key, user ID, etc.)"
output: "RateLimitResult con Allowed, Remaining, ResetAt y RetryAfter calculados a partir del estado del bucket"
tested: true
tests: ["primer request siempre allowed con burst-1 remaining", "consumir todos los tokens bloquea siguiente request", "los tokens se recargan con el paso del tiempo", "retryAfter es positivo cuando se rechaza", "keys distintas tienen buckets independientes"]
test_file_path: "functions/infra/rate_limiter_check_test.go"
file_path: "functions/infra/rate_limiter_check.go"
---
## Ejemplo
```go
rl := RateLimiterNew(10, 20)
result := RateLimiterCheck(rl, "192.168.1.1")
if !result.Allowed {
// sleep(result.RetryAfter * time.Second) o 429
}
```
## Notas
Funcion impura porque depende de tiempo wall-clock (`time.Now`) y muta el estado del limiter. Algoritmo token bucket clasico: cada bucket se recarga linealmente a `rate` tokens/segundo hasta `burst`. Un request consume 1 token. La primera vez que aparece una key se crea el bucket lleno (descontando ya el primer token). El mutex asegura uso seguro desde multiples goroutines.