Every agent's model. One place. Codex on DeepSeek, Claude Code on Kimi, from the menu bar.
provider: partners.json keeps when the list was last tried and how it ended (#3362)
JoeyWu-techa2cef8bf4f8b
diff --git a/docs/subsystems/providers-accounts.md b/docs/subsystems/providers-accounts.mdindex 3d5c1cbf5..08f36608d 100644--- a/docs/subsystems/providers-accounts.md+++ b/docs/subsystems/providers-accounts.md@@ -51,7 +51,7 @@ keys and accounts per request is in [Gateway routing and fallback](gateway-routi| A key's own windows | A sub2api key given a spending limit per 5 hours, day or 7 days answers its `/v1/usage` with `rate_limits` and no `remaining` (`readSub2APIKeyLimits`). With the Balance URL set to it, the key's card shows them as the windows *5 hours*, *1 day*, *7 days*, in USD, beside a balance field the user wrote; *Check balance* and `magpie provider show` give what its fullest window has left (`Balance`). A Balance URL at an account query left without its token (a sub2api panel's `/api/v1/user/profile`, new-api's `/api/user/self`, after the token was removed) asks the same panel's query for the key instead, the saved URL untouched (`keyQueryOf`, `BalanceQuery`), unless the user's Headers carry an Authorization or Cookie of their own. A Balance URL of the user's own is asked with GET, or with POST and no body when the provider's `BalanceMethod` says so (#2368: an endpoint that answers only a POST; the editor's GET/POST beside the URL, `balance.method=` on the command line); any other method is refused before anything is sent (`balanceMethodOf`). `KeyAllowance` gives routing the same windows: never waited for, read in the background at most once a minute, a failed read keeping the last, and seeded from the card's last reading (`quotas.json`) after a restart. A key bought as a plan (Kimi Code, GLM Coding Plan and Z.ai, MiniMax Coding Plan, OpenCode Go, Command Code, Ollama Cloud: `planQuotaSourceOf`) gives routing its card's windows the same way (`planKeyWindows`, Zhipu's team quota behind a key with none of its own); the Usage page's read of its card is taken at once (`noteKeyAllowance`), and a key there that turns out pay-as-you-go, with no windows, is asked again only every 30 minutes (`keyNoWindowsAge`). A Command Code plan's key has its month of credits as a *Credits* window beside the 5-hour and weekly ones, as the signed-in subscription's card has (`cmdKeyWindows`, #2451): billing/credits leaves the plan out, so it is the key's billing/subscriptions plan, asked at most every ten minutes and the last one kept while it can't be read; a key whose plan was never read has its two windows alone. Ollama Cloud's `ollama.com/api/balance` (#1888, `readOllamaPlan`) tells the plan's included allowance as one window in USD, *Month* when its period is a month long, renewing at `period.until`, and Aside while credits bought on top are left; those credits are the key's balance card (`readOllamaCredits`), and a reply that names none has no balance card rather than $0. StepFun's Step Plan is read through a platform sign-in, not the key, and isn't one of them: the sign-in is the provider's own, kept by provider id in `stepfun-auth.json` (two StepFun providers on one site can be two accounts, #2384), one card per signed-in provider; a file from before that, kept by site, is given on read to the StepFun providers on that site (`stepfunBySite`), and copies of one sign-in are renewed together. Nor are Volcengine Ark's Coding Plan and Agent Plan (#1427): their 5-hour, weekly and monthly windows are told only to the account's access key (`AccessKeyID`, `SecretAccessKey`), asked of `open.volcengineapi.com` (`GetCodingPlanUsage`, `GetAFPUsage`) and signed as Volcengine's own SDK signs (`volcSign`), so they are cards on the Usage page (`volcPlanQuotas` in `PlanQuotas`), never routing's windows. Nor is Tencent Cloud's Token Plan 企业版 (#1574): what a team plan has used of its cycle's credits (专业套餐) or tokens (轻享套餐) is told only to the account's SecretId and SecretKey (kept as `AccessKeyID`, `SecretAccessKey`), asked of `tokenhub.tencentcloudapi.com` (`DescribeTokenPlanList`, `DescribeTokenPlan`, version 2026-03-22) and signed TC3-HMAC-SHA256 (`tc3Sign`), one card per team plan (`tencentPlanQuotas`). | [`sub2api_usage.go`](../../internal/provider/sub2api_usage.go), [`key_allowance.go`](../../internal/provider/key_allowance.go), [`volcengine_usage.go`](../../internal/provider/volcengine_usage.go), [`tencent_usage.go`](../../internal/provider/tencent_usage.go) || Account names and seats | `AccountNames` (by the account, in lower case, like `AccountCaps`) are names the user gives accounts, set by `SetAccountName` (GUI `provider/accountname`, `magpie accounts alias`); they live in providers.json only, never in a vendor's or plugin's sign-in. A GLM Coding Plan read with a key (`glmPlan`) and a ZCode account (built-in or `zcode-plugin`) whose windows' resets agree are one seat (`seatMatch`, #90/#953), shown once, on the account's card (`seatCards`, used by `quotas`, `Allotted` and `CachedCards`). A match is remembered in `seats.json` beside `quotas.json`: a failed read or a window with no reset yet is unknown and keeps the key's card off while the account is signed in; windows that disagree forget it (#1515). Cards carry `Seat` (the key provider's name, and the key's when it has several) and `Alias` (the user's name, else `Seat`), as `/v1/magpie/quotas`, `magpie quota` and `magpie accounts` do. Records (a trace's `who`, usage's `ProviderAccount`) keep the vendor's name, the key the user's name is kept by, and every list of them looks the name up as it is shown (`AccountShown`, `AccountShownOf`, `AccountRef.Shown`), so a request from before a rename reads by the new name too: the Routing page's accounts and requests (`userShown` in `plugins/routing/client.js`, from `/api/providers`' `accountNames`), its Several accounts pools (`onOf`), the Usage page's Accounts and the request log's Account filter (`usageapi`), `magpie usage`, and a gateway key's accounts (`AccountNames`, `/api/caller-keys`). Before plugins#310 (a renamed Kiro account read by its old name on every request after) those showed the vendor's name. | [`account_names.go`](../../internal/provider/account_names.go), [`account_seats.go`](../../internal/provider/account_seats.go) || Last served | `served.json` records when each account, plan or key last answered, shown as `lastServedAt` (#570) on `/v1/magpie/quotas` and on the Usage page's own cards (`Quotas` → `cardsServed`, this computer's cards only, the caches left alone). The Usage page and the tray panel show the last-answered account in full, and a menu bar card that follows the account in use (`codex|*`) takes the one that answered within the last hour, else `InUseLogin`'s guess, else the one that answered last at all (a plugin's accounts, #1516) (`trayInUseCard`; okingkee on X: A spent, B answering, the menu bar stayed on A). `NoteServed` calls `OnServedMoved` when a provider's answers move to another account or key, and `SwitchLogin` after a switch, so the menu bar reads its cards again at once. | [`served.go`](../../internal/provider/served.go), [`trayusage.go`](../../internal/gui/trayusage.go) |-| Partners | Services that pay to be listed first in the add sheet, under a heading of their own ("Partners · magpie's sponsors"). The list is `site/partners.js`, served at `usemagpie.ai/api/partners`: a change reaches users with a deploy, not a release. `Partners` never waits: it returns what was fetched last and fetches again behind the call every 6 hours (10 minutes after a failure), keeping the list in `partners.json` in the cache folder. Each entry is checked again on every read (`validPartners`): its own id, never a built-in preset's, a name, an endpoint, https only, at most 12; what only magpie's presets may set (a decision API, no key, a user endpoint) is cleared. Its logo is fetched through `FetchIcon` and kept as an uploaded icon, used as it is while its `iconUrl` stays the same; the prune after a save of `providers.json` (`pruneIcons`) leaves the logos of the partners listed now (`keptPartnerIcons`), as it leaves a plugin's. A partner is a preset to the rest of magpie (`Preset`, `FromPreset`, the editor), and one no longer listed still is to the providers added from it (`Seen`), without the sponsored mark. The window lists a partner in the languages it names (`langs`) only and shows its tagline in the page's language (`notes`, else `en`). `MAGPIE_PARTNERS` points it elsewhere, `off` lists none; tests list none unless they name a list. How often each listed partner was shown, opened (its row, its key page) and added is counted per UTC day (`CountPartner`, capped at 20 of each and 5 adds, kept in `partner-counts.json` in the cache folder) and sent with the next day's stats event as `magpie partner` events (`internal/stats`); nothing is counted with the stats or their usage part off. A listed partner the add sheet (or the TUI's, or `magpie providers presets`) hasn't shown yet is new (`NoticePartners` keeps those shown, as `noticed` in `partners.json`, whatever the stats); the window's add button carries a small dot for it, with its name in the title, until the sheet shows it. | [`partners.go`](../../internal/provider/partners.go), [`partner_events.go`](../../internal/provider/partner_events.go), [`site/partners.js`](../../site/partners.js) |+| Partners | Services that pay to be listed first in the add sheet, under a heading of their own ("Partners · magpie's sponsors"). The list is `site/partners.js`, served at `usemagpie.ai/api/partners`: a change reaches users with a deploy, not a release. `Partners` never waits: it returns what was fetched last and fetches again behind the call every 6 hours (10 minutes after a failure), keeping the list in `partners.json` in the cache folder. The file also says when the last fetch started (`tried`) and, when it failed, why (`error`, logged once until a fetch gets the list again), so a list that stops changing tells a fetch that fails from one that never came back (`tried` after `at`, no error) and from none asked (#3362). Each entry is checked again on every read (`validPartners`): its own id, never a built-in preset's, a name, an endpoint, https only, at most 12; what only magpie's presets may set (a decision API, no key, a user endpoint) is cleared. Its logo is fetched through `FetchIcon` and kept as an uploaded icon, used as it is while its `iconUrl` stays the same; the prune after a save of `providers.json` (`pruneIcons`) leaves the logos of the partners listed now (`keptPartnerIcons`), as it leaves a plugin's. A partner is a preset to the rest of magpie (`Preset`, `FromPreset`, the editor), and one no longer listed still is to the providers added from it (`Seen`), without the sponsored mark. The window lists a partner in the languages it names (`langs`) only and shows its tagline in the page's language (`notes`, else `en`). `MAGPIE_PARTNERS` points it elsewhere, `off` lists none; tests list none unless they name a list. How often each listed partner was shown, opened (its row, its key page) and added is counted per UTC day (`CountPartner`, capped at 20 of each and 5 adds, kept in `partner-counts.json` in the cache folder) and sent with the next day's stats event as `magpie partner` events (`internal/stats`); nothing is counted with the stats or their usage part off. A listed partner the add sheet (or the TUI's, or `magpie providers presets`) hasn't shown yet is new (`NoticePartners` keeps those shown, as `noticed` in `partners.json`, whatever the stats); the window's add button carries a small dot for it, with its name in the title, until the sheet shows it. | [`partners.go`](../../internal/provider/partners.go), [`partner_events.go`](../../internal/provider/partner_events.go), [`site/partners.js`](../../site/partners.js) || Local servers | A preset of `KindLocal` (Ollama, LM Studio, oMLX, MLX-Serve) is at its server's default port on this machine. Another address — a port, or another computer — is given in the window's editor, under Server address, or in the TUI (asked on adding, `w` after); on the command line the URLs themselves (`url=`, `anthropic=`, `responses=`). `AtAddress` replaces only each URL's scheme, host and port, each API keeping its path; `AddressOf` is the address an editor starts from. The window sends the URLs moved only when the address was changed, so a Save doesn't move URLs set apart (another app's import). A provider of the user's own (no preset) has `w` in the TUI too: each base URL it has is asked in turn, typed in as it is, Enter alone keeping one (`customURLsAsk`). | [`local_address.go`](../../internal/provider/local_address.go) || Protocol detection | Works out which of Chat, Responses, Anthropic Messages and Gemini generateContent a base URL speaks when a provider is added. Each is asked at the URL as it takes it (`DetectBase`); Gemini's at the `…/v1beta` beside a typed `…/v1` or bare host, a Gemini model from the list picked for it, with the key in `x-goog-api-key` (#1346). Detection, endpoint tests and model tests share `probe`, which adds `anthropic-version` only for Anthropic Messages; OpenAI probes omit that default so a relay that refuses it can answer. User-supplied headers still apply through `Sign`. The editor asks with the form as it stands, before any Save (#1545): the URL, key and models typed (`picked`, else the saved picks, else the vendor list); a key not typed again is the saved provider's, or for an unsaved copy the copied one's (`copyOf`). The probe writes nothing and adds no provider, and the route stays behind `magpie web`'s key. | [`detect.go`](../../internal/provider/detect.go), [`test.go`](../../internal/provider/test.go) || A pasted curl command | A curl command from a vendor's docs pasted into a custom provider's Base URL or API key fills the editor in (@mark_li21 on X). `curlOf` reads it as a shell would (lines joined by `\`, cmd's `^` or PowerShell's backtick; `curl.exe`; quotes and escapes), and takes: the API its URL's endpoint names (`…/chat/completions` Chat, `…/messages` Anthropic Messages, `…/responses` Responses) with the base URL before it, spelled as that API wants it (`respellURL`: Anthropic at its root, `/v1` after a bare host); the key from `Authorization: Bearer`, `x-api-key` or `api-key`, unless it only stands for one (`$OPENAI_API_KEY`, `${X}`, `%X%`, `<token>`, `YOUR_API_KEY`), when the key's box is left empty and focused; and the `model` of its JSON body, added to a new provider's models (a saved one's picks are left alone, since adding to none would narrow what it serves). A preset's editor takes only the key. A note (`editorError`, kind `note`) says what was taken, a placeholder like `{WorkspaceId}` left in the URL, and a URL with no known endpoint. Text that isn't a curl command pastes as before, several keys included. Tested on the docs' own examples (`fixtures/curl`). | [`app.js`](../../internal/gui/assets/app.js) (`curlOf`, `fromCurl`), [`provider-curl-paste.test.cjs`](../../internal/gui/tests/provider-curl-paste.test.cjs) |diff --git a/internal/provider/partners.go b/internal/provider/partners.goindex a5200e26b..e69bff9c0 100644--- a/internal/provider/partners.go+++ b/internal/provider/partners.go@@ -6,6 +6,7 @@ import ("errors""fmt""io"+ "log""net/http""net/url""os"@@ -68,9 +69,17 @@ type partnerFeed struct {// partner ever listed, so a provider added from one that has since left// still finds its preset (its endpoints, regions and key page).type partnerCache struct {- At time.Time `json:"at"`- Partners []Partner `json:"partners"`- Seen map[string]Partner `json:"seen,omitempty"`+ At time.Time `json:"at"`+ Partners []Partner `json:"partners"`+ // Tried is when the last fetch started, and Error how it ended, ""+ // once it got the list (At is then its time) or while it is still+ // out. So the file tells a fetch that failed (Error) from one that+ // never came back (Tried after At, no Error) and from none asked+ // (Tried old): an app that kept an old list for days left nothing to+ // tell them apart (#3362).+ Tried time.Time `json:"tried,omitzero"`+ Error string `json:"error,omitempty"`+ Seen map[string]Partner `json:"seen,omitempty"`// Noticed are the partners the add sheet has listed to the user; one// listed since is new, and the add button says so (NoticePartners).Noticed []string `json:"noticed,omitempty"`@@ -81,6 +90,7 @@ var (partnerState *partnerCache // nil until read from diskpartnerNext time.Time // the next fetch, when none is runningpartnerFetches bool+ partnerLogged string // the failure logged last, so a long one is logged once)// A list is fetched again after partnerEvery, so a partner added reaches@@ -227,11 +237,19 @@ func loadPartners() {}// refreshPartners fetches the list and keeps it; on a failure the list-// held stays, and it is tried again in ten minutes.+// held stays, and it is tried again in ten minutes. When it started and+// how it ended are kept with the list (Tried, Error), and a failure is+// logged once until the list is fetched again.func refreshPartners() {+ partnerMu.Lock()+ loadPartners()+ partnerState.Tried, partnerState.Error = time.Now(), ""+ savePartners()+ partnerMu.Unlock()ctx, cancel := context.WithTimeout(context.Background(), 20*time.Second)defer cancel()- list, err := fetchPartners(ctx, partnersSource())+ src := partnersSource()+ list, err := fetchPartners(ctx, src)if err == nil {for i := range list {list[i].Icon = partnerIcon(ctx, list[i])@@ -243,8 +261,18 @@ func refreshPartners() {loadPartners()if err != nil {partnerNext = time.Now().Add(partnerRetry)+ partnerState.Error = partnerError(err)+ savePartners()+ if partnerState.Error != partnerLogged {+ partnerLogged = partnerState.Error+ log.Printf("partners: the list couldn't be fetched from %s, asked again in %s: %s", src, partnerRetry, partnerLogged)+ }return}+ if partnerLogged != "" {+ partnerLogged = ""+ log.Printf("partners: the list is fetched again from %s", src)+ }now := time.Now()partnerState.At, partnerState.Partners = now, listfor _, p := range list {@@ -254,6 +282,16 @@ func refreshPartners() {savePartners()}+// partnerError is err as the list keeps it: its text, cut to a size+// that stays readable in the file.+func partnerError(err error) string {+ msg := strings.Join(strings.Fields(err.Error()), " ")+ if r := []rune(msg); len(r) > 500 {+ msg = string(r[:500]) + "…"+ }+ return msg+}+// savePartners writes what is held to disk; partnerMu held.func savePartners() {b, err := json.Marshal(partnerState)@@ -467,7 +505,7 @@ func partnerPreset(id string) *PresetDef {// so it is waited for first.func resetPartners() {claimPartnerFetch()- partnerState, partnerNext, partnerFetches = nil, time.Time{}, false+ partnerState, partnerNext, partnerFetches, partnerLogged = nil, time.Time{}, false, ""partnerMu.Unlock()}diff --git a/internal/provider/partners_test.go b/internal/provider/partners_test.goindex b955aa171..bb5292ad6 100644--- a/internal/provider/partners_test.go+++ b/internal/provider/partners_test.go@@ -1,8 +1,10 @@package providerimport (+ "bytes""context""encoding/json"+ "log""net/http""net/http/httptest""os"@@ -496,3 +498,105 @@ func TestPartnerLogoOutlivesAProvidersSave(t *testing.T) {t.Errorf("the logo was downloaded %d times, want once", n)}}++// partners.json says when the list was last tried and how that ended. An+// app that kept a list from 10-20 for three days left a file that+// couldn't tell a fetch failing every time from one that never came back,+// or from none asked (#3362). Now a failure keeps its error until a fetch+// gets the list, a fetch still out shows as a try after the list's time+// with no error, and a failure is logged once, however often it is+// tried again.+func TestPartnersKeepTheirLastTry(t *testing.T) {+ t.Setenv("XDG_CACHE_HOME", t.TempDir())+ resetPartners()+ t.Cleanup(resetPartners)+ var logged bytes.Buffer+ was := log.Writer()+ log.SetOutput(&logged)+ t.Cleanup(func() { log.SetOutput(was) })+ var fail, hold atomic.Bool+ fail.Store(true)+ var asked atomic.Int32+ release := make(chan struct{})+ srv := httptest.NewServer(http.HandlerFunc(func(rw http.ResponseWriter, r *http.Request) {+ asked.Add(1)+ if hold.Load() {+ <-release+ }+ if fail.Load() {+ http.Error(rw, "down for maintenance", http.StatusServiceUnavailable)+ return+ }+ _, _ = rw.Write([]byte(`{"partners":[{"id":"acme","name":"Acme","chat":"https://a.example/v1"}]}`))+ }))+ t.Cleanup(srv.Close)+ // runs before srv.Close, which waits for a held fetch (#1808)+ let := sync.OnceFunc(func() { close(release) })+ t.Cleanup(let)+ t.Setenv("MAGPIE_PARTNERS", srv.URL)++ // what the file says, read as written, not through partnerCache+ type kept struct {+ at, tried time.Time+ err string+ partners string+ }+ read := func() kept {+ t.Helper()+ b, err := os.ReadFile(partnerCacheFile())+ if err != nil {+ t.Fatal(err)+ }+ var raw map[string]json.RawMessage+ if err := json.Unmarshal(b, &raw); err != nil {+ t.Fatal(err)+ }+ var k kept+ _ = json.Unmarshal(raw["at"], &k.at)+ _ = json.Unmarshal(raw["tried"], &k.tried)+ _ = json.Unmarshal(raw["error"], &k.err)+ var ps []Partner+ _ = json.Unmarshal(raw["partners"], &ps)+ k.partners = partnerIDs(ps)+ return k+ }++ start := time.Now()+ fetchPartnersNow()+ k := read()+ if k.tried.Before(start) || !strings.Contains(k.err, "503") || !k.at.IsZero() {+ t.Fatalf("after a failed fetch the file says tried %v, error %q, at %v; want a try since %v, the 503, no list", k.tried, k.err, k.at, start)+ }+ fetchPartnersNow()+ fetchPartnersNow()+ if n := strings.Count(logged.String(), "couldn't be fetched"); n != 1 {+ t.Fatalf("three failed fetches logged %d times, want once:\n%s", n, logged.String())+ }++ // a fetch still out: tried after the list's time, no error+ fail.Store(false)+ hold.Store(true)+ before, out := asked.Load(), time.Now()+ done := make(chan struct{})+ go func() { fetchPartnersNow(); close(done) }()+ for deadline := time.Now().Add(5 * time.Second); asked.Load() == before; {+ if time.Now().After(deadline) {+ t.Fatal("the fetch never asked")+ }+ time.Sleep(5 * time.Millisecond)+ }+ k = read()+ if k.tried.Before(out) || k.err != "" || !k.at.Before(k.tried) {+ t.Fatalf("while a fetch is out the file says tried %v, error %q, at %v; want a try since %v after the list's time, no error", k.tried, k.err, k.at, out)+ }++ let()+ <-done+ k = read()+ if k.err != "" || k.at.Before(k.tried) || k.partners != "acme" {+ t.Fatalf("after the fetch got the list the file says tried %v, error %q, at %v, partners %q", k.tried, k.err, k.at, k.partners)+ }+ if !strings.Contains(logged.String(), "fetched again") {+ t.Fatalf("the list fetched again after a failure wasn't logged:\n%s", logged.String())+ }+}