supabase / supavisor / 39951659296

83%

Build Type

push

github

Committed by web-flow

Commit Message

List tenant's pools (#1237)

# List a tenant's pools

Adds a Supavisor API to list all pools of a tenant across the cluster.
Killing a pool (DELETE) is a follow-up PR.

## What's included

- **`GET /api/tenants/:external_id/pools`** — lists every pool of a
tenant across all
nodes. Per pool: id fields, an opaque `token`, node, upstream host/port,
connected
  client count, and backend connection counts (idle / checked_out).
- **`Supavisor.Ops`** — transport-agnostic domain layer: `list_pools/1`
fans out via
`:erpc` (tolerating unreachable nodes), `list_pools_local/1` reads the
per-node
  registries. `Supavisor.Manager.client_count/1` added.
- **`SupavisorWeb.PoolId`** — external representation: `id_to_map/1`
plus a reversible,
opaque `encode_token/1` / `decode_token/1` (validated via an embedded
`Ecto.Schema`)
  that the client echoes back to target a pool in the kill endpoint.

## API

```
GET /api/tenants/:external_id/pools
Authorization: Bearer <api jwt>
```

```json
{
  "pools": [
    {
      "id": {"type":"single","tenant":"dev_tenant","user":"postgres","mode":"transaction",
             "database":"postgres","search_path":null,"upstream_tls":false},
      "token": "eyJ0eXBlIjoic2luZ2xlIn0…",
      "node": "node1@127.0.0.1",
      "host": "localhost", "port": 6432,
      "clients": 1,
      "connections": {"idle": 1, "checked_out": 0}
    }
  ],
  "errors": {"node2@127.0.0.1": "unreachable"}
}
```

Partial-success: a node that fails to respond is reported under `errors`
as
`"unreachable"` (the real `:erpc` reason is logged server-side, not
returned);
the rest of the cluster's pools are still listed.

## Open question

Where should maintenance/ops endpoints live? We're going to add more
operator commands.
Options: a dedicated `OpsController` (+ `/api/ops/...` path
and/or a dedicated, swappable auth pipeline) vs. keeping them in
`PoolController`/`:api`.
The domain lives in `Supavisor.Ops`, so re-homing the endpoints later is
cheap.
Current PR keeps t... (continued)

Coverage Stats

48 of 55 new or added lines in 6 files covered. (87.27%)

4 existing lines in 4 files now uncovered.

3374 of 4105 relevant lines covered (82.19%)

45060.37 hits per line