juanfont/headscale

Evaluate ConnectRPC over gRPC + webgateway

Open

#2,305 opened on 2024年12月17日

GitHub で見る
 (10 comments) (0 reactions) (0 assignees)Go (38,374 stars) (2,104 forks)batch import
help wantedneeds investigationno-stale-botquestion

説明

We currently use plain gRPC and grpc-gateway (for our http+json) api, it has worked fine, but also there are a couple of drawbacks, and it kind of feels a bit hacky.

One of the drawbacks is that some parts of gRPC is unsupported by grpc-gateway, and it does not support OpenAPI 3.0. oneof is for example not supported https://github.com/juanfont/headscale/issues/2237.

ConnectRPC seem to be a rethinking of this, where the gRPC and the HTTP part is "equally" important. It might be better, it might be worse, they advertise with good client code generators so might be worth a look.

Initial thoughts:

  • Con: This will break current web UIs
  • Pro: they can use a generated client instead of handwriting API
  • Cant see any OpenAPI support, but if their code gen is good, then I dont think that matters
  • "If it aint broke, dont fix it"

I would value peoples views, particularly if you have experience using this.

コントリビューターガイド

技術スタック
gogrpcrest api
領域
apibackend
Issue 種別
research
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
4
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
over 1 week
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
active
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
mostly clear
前提条件
Go programminggRPCgrpc gatewayProtocol Buffers
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
15
調査方針
Investigate the current gRPC and grpc gateway setup in the repository, particularly the use of protobuf definitions and any known limitations such as the lack of oneof support (see issue #2237). Evaluate ConnectRPC's generated client code quality, OpenAPI support, and its impact on the existing web UI. Check the ConnectRPC documentation and community examples for migration patterns from grpc gateway. Discuss findings in the issue thread with maintainers to gauge acceptance criteria.