server: generate reports

オープン
#533 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

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

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
45/100
issue の種類
機能追加
明瞭さ
おおむね明確
活発さ
静か
技術スタック
rust
領域
api, backend

調査の方向性

まず既存の JSON-RPC サーバーと SSE ストリームをホストする REST サーバーをたどり、次にセッションデータベースとレポートが現在どのように扱われているかを調べます。レポート形式、レポートリンクを含む非同期レスポンス、レポートのホスティングパス、一時ディレクトリのクリーンアップ、シャットダウン時の動作が issue の要件に沿っていることを確認します。

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

説明

enhancement

Is your feature request related to a problem? Please describe.

I can't generate a report from a spam run via the JSON-RPC API, but I reeeeeallly want to.

Describe the solution you'd like

  • add an endpoint to the RPC server: report({session_id, format}) that generates a report spanning every run_id in the session's DB
    • acceptable format: "json" and "html"
    • the endpoint should start generating the report, then return immediately with the link to the report (e.g. "http://localhost:3000/report/321123.json")
    • reports are saved to a temp directory when completed
  • add an endpoint to the REST server (the same one that hosts the SSE streams) to host the reports: /report/{session_id}.{suffix}
  • delete the temp directory before shutting down the server
主要言語
Rust
スター
144
フォーク
58
PR マージ指標
30日以内にマージされた PR はありません

環境構築

はじめの一歩

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

flashbots/contender のほかの issue

flashbots/contender の issue をすべて見る

似ている issue

Rust の issue をもっと見る

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

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