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

オープン 初心者向け
#663 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 3 日以内に返信

まだ誰も着手していません。

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
72/100
issue の種類
機能追加
明瞭さ
明確に書かれている
活発さ
活発
技術スタック
node.js, postgresql, typescript
領域
api, backend, testing

調査の方向性

src/middleware/globalRateLimit.ts と src/__tests__/globalRateLimit.test.ts を読み、次に src/app.ts のルート登録と onRoute オプションを調べてください。負荷の高いルートのプレフィックスを更新し、登録済みルートとの比較、新たに追加した負荷の高いルートを少なくとも2つ使ったテスト、ヘルスチェックパスの除外と既存のしきい値の維持を確認するテストを追加してください。これらの確認と npm test が通れば完了です。

索引モデルが issue の本文から書いたものです。

説明

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

主要言語
TypeScript
スター
4
フォーク
71
平均マージ
2日 6時間
マージ済み PR(30日)
24

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

Divinity-Labs/Lens のほかの issue

Divinity-Labs/Lens の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。