Skip to content

Add structured logs and metrics for distributed request throttling and headers in src/middleware/rate-limit.ts #340

Description

@Jagadeeshftw

Description

The code path does not expose enough telemetry to diagnose production failures quickly. src/middleware/rate-limit.ts owns distributed request throttling and headers, but the current behavior does not yet define the contract tightly enough for safe maintenance. Design the change so the runtime path, tests, and docs all describe the same behavior.

Requirements and context

  • Keep the contract specific to src/middleware/rate-limit.ts and its existing callers.
  • Add coverage for the success path and the failure or boundary path relevant to this issue.
  • Preserve compatibility where older callers or existing tests already rely on the current shape.
  • Keep the change easy to review and small enough for one focused PR.

Suggested execution

Fork the repo and create a branch

git checkout -b rate-limit-distributed-observability-154

Implement changes

  • Update/Write: src/middleware/rate-limit.ts
  • Write comprehensive tests: src/middleware/rate-limit.test.ts
  • Add documentation: docs/middleware/rate-limit.md
  • Keep any new helper names consistent with the rest of src/

Test and commit

  • Run pnpm test
  • Run pnpm lint
  • Add a note for any edge cases that are intentionally out of scope

Example commit message

feat: add observability for backend path

Guidelines

  • WCAG 2.1 AA is not relevant here; keep the focus on correctness and maintainability.
  • Prefer a narrow, well-documented fix over a broad refactor.
  • Timeframe: 96 hours

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions