cli: generalize the experts cell-target resolver to cell_target.go · Entire

cli: generalize the experts cell-target resolver to cell_target.go

574c5e4→main·

Soph·1w ago·7 files·+391 added/-392 removed

resolveExpertsCellTarget was experts-named but nothing in it is experts-specific: it maps any repo (ULID or owner/repo) to the entire-api cell hosting it, exactly what every future repo-scoped or fan-out command needs (code search is next, PR #1616). Rename the file and identifiers — resolveRepoCellTarget, cellCoreClient, newCellCoreClient, cellResolveTimeout — and keep experts as the documented example consumer. Mechanical rename; no behavior change.

Co-Authored-By: Claude Fable 5 noreply@anthropic.com

Sessions

89b4d13bd2b0View transcript

Changes

7

59 unmodified lines

// failure yields a nil target and NewEntireAPICellClient falls back to // home-jurisdiction routing, so the common same-region case never regresses. func NewAuthenticatedEntireAPICellClient(ctx context.Context, insecureHTTP bool, fullName, ulid string) (*api.Client, error) { target := resolveExpertsCellTarget(ctx, fullName, ulid) target := resolveRepoCellTarget(ctx, fullName, ulid) // NewEntireAPICellClient already returns user-facing, context-rich errors // (login hint, discovery-unavailable, region guidance); re-wrapping here // would bury them, so surface them verbatim. }

Mcmd/entire/cli/api_client.go+1/-1

568 unmodified lines

// cluster first). It hand-parses GET /api/v1/clusters rather than reusing the // generated coreapi.ListClusters() because coreapi imports this (auth) package, // so auth cannot import coreapi without a cycle — the repo-scoped path avoids // this by resolving the cell in the cli layer (see resolveExpertsCellTarget). // this by resolving the cell in the cli layer (see resolveRepoCellTarget). func resolveCellAPIBaseURL(ctx context.Context, coreURL, loginJWT, jurisdiction string, httpClient *http.Client) (string, error) { req, err := http.NewRequestWithContext(ctx, http.MethodGet, strings.TrimRight(coreURL, "/") + clustersAPIPath, nil) if err != nil { }

Mcmd/entire/cli/auth/cell_data_api.go+1/-1

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183

package cli

import (
    "context"
    "strings"
    "time"

"github.com/entireio/cli/cmd/entire/cli/auth"
    "github.com/entireio/cli/cmd/entire/cli/logging"
    "github.com/entireio/cli/internal/coreapi"
)

// cellResolveTimeout bounds the best-effort control-plane lookups that
// pick a repo's cell. Without it, a reachable-but-hung control plane would block
// the calling command (experts, and any future cell-routed command) instead of
// degrading to home-jurisdiction routing — the "any failure falls back" contract
// must hold for slow cores, not just erroring ones.
const cellResolveTimeout = 5 * time.Second

// cellCoreClient is the control-plane surface the cell-target resolver needs.
// An interface (with a swappable constructor) so the resolver is unit-testable
// against a fake control plane; *coreapi.Client satisfies it.
type cellCoreClient interface {
    GetRepo(ctx context.Context, params coreapi.GetRepoParams) (*coreapi.Repo, error)
    ListClusters(ctx context.Context) (*coreapi.ListClustersOutputBody, error)
    ListMirrors(ctx context.Context, params coreapi.ListMirrorsParams) (*coreapi.ListMirrorsOutputBody, error)
}

// newCellCoreClient builds the control-plane client used for cell resolution.
// Swapped in tests.
var newCellCoreClient = func() (cellCoreClient, error) { return coreapi.New() }

// resolveRepoCellTarget resolves the entire-api cell that HOSTS the given
// repo, plus that cell's jurisdiction, so a repo-scoped call (experts today)
// reaches the region that owns the repo — mirroring how the entire.io BFF
// selects a cell per repo (resolve-cluster-host.ts / repos-stream.ts) rather
// than using the caller's home cell.
//
// It is deliberately best-effort: ANY failure (not logged in, control-plane
// error or timeout, unknown/ambiguous placement, missing apiUrl) returns nil,
// and the auth-layer client falls back to home-jurisdiction routing. That
// fallback is exactly the previous behaviour, so this can never regress the
// common same-region case (where the repo's jurisdiction equals the caller's
// home). A short deadline keeps a slow control plane from stalling the command.
//
// Placement source:
//   - ulid form: coreapi.GetRepo(ulid) -> Repo.ClusterHost;
//   - owner/repo form: coreapi mirrors filtered to this repo -> ClusterHost.
//
// The cluster host is then mapped to a cell apiUrl + jurisdiction via the
// coreapi cluster catalog (ListClusters), the authoritative source for a
// jurisdiction's cell URL.
func resolveRepoCellTarget(ctx context.Context, fullName, ulid string) *auth.CellTarget {
    ctx, cancel := context.WithTimeout(ctx, cellResolveTimeout)
    defer cancel()

c, err := newCellCoreClient()
    if err != nil {
        logging.Debug(ctx, "cell target: core client unavailable, using home-jurisdiction routing", "error", err.Error())
        return nil
    }

clusterHost, ok := resolveRepoClusterHost(ctx, c, fullName, ulid)
    if !ok || clusterHost == "" {
        return nil
    }

clusters, err := c.ListClusters(ctx)
    if err != nil {
        logging.Debug(ctx, "cell target: list clusters failed, using home-jurisdiction routing", "error", err.Error())
        return nil
    }
    cluster, ok := matchClusterByHost(clusters.Clusters, clusterHost)
    if !ok {
        logging.Debug(ctx, "cell target: no cluster matched repo host, using home-jurisdiction routing", "cluster_host", clusterHost)
        return nil
    }
    apiURL := strings.TrimRight(strings.TrimSpace(cluster.ApiUrl.Or("")), "/")
    // DNS is case-insensitive; normalise the catalog jurisdiction so a
    // non-lowercase value still passes the auth layer's strict label check
    // instead of hard-failing the target path.
    jurisdiction := strings.ToLower(strings.TrimSpace(cluster.Jurisdiction))
    if apiURL == "" || jurisdiction == "" {
        logging.Debug(ctx, "cell target: matched cluster missing apiUrl/jurisdiction, using home-jurisdiction routing", "cluster_host", clusterHost)
        return nil
    }
    return &auth.CellTarget{BaseURL: apiURL, Jurisdiction: jurisdiction}
}

// resolveRepoClusterHost finds the public cluster host that owns the repo. It
// returns ok=false to signal "fall back to home-jurisdiction routing" for every
// unresolved or ambiguous case, never an error.
func resolveRepoClusterHost(ctx context.Context, c cellCoreClient, fullName, ulid string) (string, bool) {
    if strings.TrimSpace(ulid) != "" {
        repo, err := c.GetRepo(ctx, coreapi.GetRepoParams{RepoId: ulid})
        if err != nil {
            logging.Debug(ctx, "cell target: GetRepo failed, using home-jurisdiction routing", "error", err.Error())
            return "", false
        }
        return strings.TrimSpace(repo.ClusterHost.Or("")), true
    }

owner, repo, ok := strings.Cut(strings.TrimSpace(fullName), "/")
    if !ok || owner == "" || repo == "" {
        return "", false
    }
    mirrors, err := listMirrorsForRepo(ctx, c, mirrorCloneProviderGitHub, strings.ToLower(owner), strings.ToLower(repo))
    if err != nil {
        logging.Debug(ctx, "cell target: list mirrors failed, using home-jurisdiction routing", "error", err.Error())
        return "", false
    }
    hosts := distinctActiveClusterHosts(mirrors)
    if len(hosts) != 1 {
        // Zero placements (not mirrored / unknown) or multiple regions
        // (ambiguous which cell holds the repo-scoped data): fall back rather than
        // guess a region.
        if len(hosts) > 1 {
            logging.Debug(ctx, "cell target: repo mirrored in multiple regions, using home-jurisdiction routing", "count", len(hosts))
        }
        return "", false
    }
    return hosts[0], true
}

// isActiveMirror reports whether a mirror placement can currently serve the
// repo: not archived, and not in a failed/suspended clone state. An unset status
// is treated as active (older data). Shared by every caller that must ignore
// placements a cell can't answer for.
func isActiveMirror(m coreapi.Mirror) bool {
    if m.IsArchived.Or(false) {
        return false
    }
    st := m.Status.Or(coreapi.MirrorStatusReady)
    return st != coreapi.MirrorStatusFailed && st != coreapi.MirrorStatusSuspended
}

// distinctActiveClusterHosts returns the set of cluster hosts a repo is actively
// serviced on: excluding archived placements and unhealthy ones (failed /
// suspended clone status), since those cells can't answer for the repo.
// A failed/suspended placement must neither manufacture false cross-region
// ambiguity nor become a sole "active" host. Case-folded to match DNS
// semantics; order is unimportant (callers only use a single-member set).
func distinctActiveClusterHosts(mirrors []coreapi.Mirror) []string {
    seen := make(map[string]string, len(mirrors))
    for _, m := range mirrors {
        if !isActiveMirror(m) {
            continue
        }
        host := strings.TrimSpace(m.ClusterHost)
        if host == "" {
            continue
        }
        key := strings.ToLower(host)
        if _, ok := seen[key]; !ok {
            seen[key] = host
        }
    }
    out := make([]string, 0, len(seen))
    for _, host := range seen {
        out = append(out, host)
    }
    return out
}

// matchClusterByHost finds the catalog cluster whose public host equals
// clusterHost (case-insensitive). The cluster's apiUrl + jurisdiction are the
// authoritative cell coordinates.
func matchClusterByHost(clusters []coreapi.Cluster, clusterHost string) (coreapi.Cluster, bool) {
    want := strings.ToLower(strings.TrimSpace(clusterHost))
    if want == "" {
        return coreapi.Cluster{}, false
    }
    for _, cl := range clusters {
        host, err := hostFromPublicURL(cl.PublicUrl)
        if err != nil {
            continue
        }
        if strings.EqualFold(strings.TrimSpace(host), want) {
            return cl, true
        }
    }
    return coreapi.Cluster{}, false
}