Warp/server/internal/setup/routes.go

package setup

import (
	"maps"
	"net/http"
	"time"

	"github.com/dariuszjaniak/warp/server/internal/buildinfo"
	"github.com/dariuszjaniak/warp/server/internal/clientapi"
	"github.com/dariuszjaniak/warp/server/internal/httputil"
	"github.com/dariuszjaniak/warp/server/internal/tracing"
)

// SpecVersions is what GET /_matrix/client/versions reports.
//
// Keep it honest: a version belongs here once the endpoints a client
// actually uses from it work. Accounts, sessions, devices, profiles,
// account data, rooms, the event stream, media (Phase 6), end-to-end
// encryption (Phase 7) and push (Phase 8) all do, which is enough for a
// client to be used. Advertising v1.11 or later is also what makes a client
// use the authenticated media endpoints, the only download endpoints Warp
// serves by default.
//
// The earlier v1.x versions are listed too: each is a subset of the
// later ones, and clients test for the exact version a feature came in.
// matrix-js-sdk only turns on threads (v1.3), unread counts per thread
// (v1.4), recursive relations (v1.10) and intentional mentions (v1.7)
// when that version is in the list.
var SpecVersions = []string{
	"v1.1", "v1.2", "v1.3", "v1.4", "v1.5", "v1.6", "v1.7",
	"v1.8", "v1.9", "v1.10", "v1.11", "v1.12", "v1.13", "v1.14",
}

// UnstableFeatures advertises MSC support. Simplified Sliding Sync
// (MSC4186) is how Element X and the matrix-rust-sdk find out they can
// skip /sync.
var UnstableFeatures = map[string]bool{
	"org.matrix.simplified_msc3575": true,
}

type versionsResponse struct {
	Versions         []string        `json:"versions"`
	UnstableFeatures map[string]bool `json:"unstable_features,omitempty"`
}

// unstableDelayedEvents is the MSC4140 feature flag. It is advertised only
// while delayed events are switched on, because a MatrixRTC client checks
// it before scheduling its delayed leave.
const unstableDelayedEvents = "org.matrix.msc4140"

// wellKnownClient is the /.well-known/matrix/client document.
type wellKnownClient struct {
	Homeserver     wellKnownBaseURL  `json:"m.homeserver"`
	IdentityServer *wellKnownBaseURL `json:"m.identity_server,omitempty"`

	// RTCFoci are the MatrixRTC backends (MSC4143) a client may use for a
	// group call it starts.
	RTCFoci []clientapi.RTCTransport `json:"org.matrix.msc4143.rtc_foci,omitempty"`
}

type wellKnownBaseURL struct {
	BaseURL string `json:"base_url"`
}

type wellKnownServer struct {
	Server string `json:"m.server"`
}

type healthResponse struct {
	Status   string `json:"status"`
	Version  string `json:"version"`
	Database string `json:"database"`
	Error    string `json:"error,omitempty"`
}

// routes registers every endpoint this server serves.
func (s *Server) routes() *httputil.Router {
	// Every route is counted and traced under its pattern. The span is
	// inside the metrics wrapper so that what the histogram times is what
	// the trace shows.
	r := httputil.NewRouter(func(route string, h http.Handler) http.Handler {
		return s.metrics.Instrument(route, tracing.Instrument(route, h))
	})

	r.HandleFunc("GET /_matrix/client/versions", s.handleVersions)
	r.HandleFunc("GET /.well-known/matrix/client", s.handleWellKnownClient)

	// The server-side delegation document is part of the federation
	// surface, so it goes through the gate and disappears with it.
	r.Handle("GET /.well-known/matrix/server", s.federation.ProtectFunc(s.handleWellKnownServer))

	s.clientAPI.RegisterRoutes(r)
	if s.fedAPI != nil {
		s.fedAPI.RegisterRoutes(r)
	}
	s.adminAPI.RegisterRoutes(r)

	r.HandleFunc("GET /healthz", s.handleHealth)
	if s.cfg.Metrics.Enabled {
		r.Handle("GET "+s.cfg.Metrics.Path, s.metrics.Handler())
	}
	return r
}

// handleVersions implements GET /_matrix/client/versions.
func (s *Server) handleVersions(w http.ResponseWriter, _ *http.Request) error {
	features := maps.Clone(UnstableFeatures)
	if s.delayed.Enabled() {
		features[unstableDelayedEvents] = true
	}
	httputil.CacheFor(w, time.Hour)
	httputil.WriteJSON(w, http.StatusOK, versionsResponse{
		Versions:         SpecVersions,
		UnstableFeatures: features,
	})
	return nil
}

// handleWellKnownClient implements GET /.well-known/matrix/client, the
// document a client fetches to turn "@me:warp.example" into an API URL.
func (s *Server) handleWellKnownClient(w http.ResponseWriter, _ *http.Request) error {
	doc := wellKnownClient{
		Homeserver: wellKnownBaseURL{BaseURL: s.cfg.ClientBaseURL()},
	}
	if url := s.cfg.Global.WellKnown.IdentityServerBaseURL; url != "" {
		doc.IdentityServer = &wellKnownBaseURL{BaseURL: url}
	}
	doc.RTCFoci = clientapi.RTCTransports(s.cfg.ClientAPI.RTC.LiveKitServiceURL)
	httputil.CacheFor(w, time.Hour)
	httputil.WriteJSON(w, http.StatusOK, doc)
	return nil
}

// handleWellKnownServer implements GET /.well-known/matrix/server. With no
// address configured there is nothing to delegate and the right answer is
// 404: other servers then fall back to SRV and A record resolution.
func (s *Server) handleWellKnownServer(w http.ResponseWriter, _ *http.Request) error {
	address := s.cfg.Global.WellKnown.ServerAddress
	if address == "" {
		return httputil.NotFound("No server delegation is configured")
	}
	httputil.CacheFor(w, time.Hour)
	httputil.WriteJSON(w, http.StatusOK, wellKnownServer{Server: address})
	return nil
}

// handleHealth implements GET /healthz: a liveness and readiness check in
// one. It reports 503 when the database is unreachable, which is what a
// load balancer needs to stop sending traffic here.
func (s *Server) handleHealth(w http.ResponseWriter, r *http.Request) error {
	resp := healthResponse{
		Status:   "ok",
		Version:  buildinfo.Version,
		Database: s.db.Driver(),
	}
	status := http.StatusOK

	ctx, cancel := contextWithTimeout(r.Context(), 2*time.Second)
	defer cancel()
	if err := s.db.Ping(ctx); err != nil {
		resp.Status = "unavailable"
		resp.Error = "database unreachable"
		status = http.StatusServiceUnavailable
		httputil.LoggerFrom(r.Context()).Error("health check failed", "error", err)
	}

	httputil.NoCache(w)
	httputil.WriteJSON(w, status, resp)
	return nil
}