juanfont/headscale

Evaluate ConnectRPC over gRPC + webgateway

Closed

#2,305 opened on Dec 17, 2024

View on GitHubContributor guide
 (11 comments) (0 reactions) (0 assignees)Go (2,104 forks)batch import
help wantedneeds investigationno-stale-botquestion

Repository metrics

Stars
 (38,374 stars)
PR merge metrics
 (Avg merge 1d 11h) (33 merged PRs in 30d)

Description

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.

Contributor guide

Research direction
Evaluate the feasibility of replacing gRPC + grpc gateway with ConnectRPC, focusing on API compatibility, client generation, and community support. Compare pros and cons, and consider impact on existing web UIs.
Tech stack
gogrpc
Domain
backendapi
Issue type
Research
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50