The load-shedding list names routes that do not exist and misses the heavy ones

Abierto Apto para principiantes
#663 1 comentario 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 3 días

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
72/100
Tipo de issue
Nueva funcionalidad
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
node.js, postgresql, typescript
Área
api, backend, testing

Línea de trabajo

Lee src/middleware/globalRateLimit.ts y src/__tests__/globalRateLimit.test.ts; después, inspecciona el registro de rutas y la opción onRoute en src/app.ts. Actualiza los prefijos de las rutas costosas y añade pruebas que los comparen con las rutas registradas, prueben al menos dos rutas pesadas recién incluidas y mantengan las excepciones para las rutas de salud y los umbrales existentes. El trabajo estará terminado cuando esas comprobaciones se superen y npm test pase.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

area:reliability difficulty:easy help wanted points:100 Stellar Wave
Background

When the instance is close to its request ceiling, src/middleware/globalRateLimit.ts sheds "expensive" routes first. It decides by the first path segment (line 52) against EXPENSIVE_ROUTE_PREFIXES (lines 5 to 24).

Three entries match no route: route, history and oracle. (The real paths are /price/:assetA/:assetB/route, /prices/history and /compare/:asset, whose first segments are price, prices and compare.)

And several routes that do run large queries are missing: /tvl, /movers, /correlation, /pegs, /impact/..., /dispersion, /snapshot, /coverage, /rates. Under load these keep being served while cheap price reads are shed.

Nothing ties the list to the real routes, so it drifts every time a route is added.

What to build
  • Remove the dead entries and add the heavy routes. Give a short reason for each group.
  • Add a test that boots the real app, collects the registered routes, and fails if an entry in the list matches no route.
  • Keep the ceiling, the 80% threshold and the health-path exemption exactly as they are.
Where to look
  • src/middleware/globalRateLimit.ts, src/__tests__/globalRateLimit.test.ts
  • src/app.ts for the route list and the onRoute option
Done when
  • Every entry in the list matches at least one registered route, proved by a test
  • The heavy routes named above are shed at the expensive threshold, with a test for at least two of them
  • /status, /live and /ready are still never shed
  • No limit was loosened and npm test passes

Drips Wave · Complexity: Easy · 100 points


Repo: Divinity-Labs/Lens. Install with npm ci, typecheck with npx tsc --noEmit, test with npm test. Tests are vitest. Do not run jest: it reports zero tests and proves nothing.

You cannot reach the production service. Prove your change with local tests and fixtures. Mock the database (pgPool, prisma) the way the existing tests in src/__tests__/ and tests/ do.

Generated files are checked byte for byte by CI. If you add or change a route, edit openapi.yaml by hand and then regenerate the generated files and commit them: npm run openapi:gen (writes openapi.json and the README sections), npm run client:gen (the TypeScript client schema) and, if you touched the GraphQL schema, npm run graphql:schema:gen (writes schema.graphql). The full list is in the scripts section of package.json; also read CONTRIBUTING.md. If a check fails and the diff looks empty, it is line endings: commit with LF.

Prices are high-precision decimals. Do not add a new place where a price or amount goes through parseFloat, Number() or ::float before it reaches the caller.

MCP tools must return exactly the fields the matching REST route returns (tests/mcp-lens.test.ts asserts equality), and the MCP tool modules must not import the database driver directly. Reads are injected.

Do not remove or loosen an existing API-key scope, CORS rule or rate limit, and do not replace src/app.ts wholesale. Past pull requests did both by accident.

Do not weaken a test to make it pass. No real user data, wallet addresses of real users, keys, tokens or connection strings in code, tests or fixtures. Never shorten a Stellar address or contract id; copy it in full from the file that defines it.



Required: Before submitting, join the contributor Telegram so your work can be tracked and counted toward the Stellar Wave: https://t.me/+fxHXq8f1SwlkZDBk

Lenguaje dominante
TypeScript
Estrellas
4
Forks
71
Merge medio
2 d 6 h
PR fusionados (30 d)
24

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de Divinity-Labs/Lens

Todos los issues de Divinity-Labs/Lens

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.