* feat(gui): show and filter usage for each API key * feat(gateway): issue per-user caller keys and attribute usage * feat(gui): manage gateway users and filter caller-key usage * test: verify caller-key failover and document user management * refactor(gateway): use named caller keys without user accounts * feat(gui): manage named caller keys with existing account styles * fix: remove user breakdown from CLI and leftover gateway styling * fix(usage): drop stale user field from request response * feat(gateway): authenticate LAN calls with named caller keys * fix(gateway): preserve LAN key rotation in the named caller store * fix(gui): retain native LAN key copy and rotation controls * fix(gui): inherit the global theme for API key inputs * fix(usage): show client API keys using the existing terminology * fix(gateway): rotate named keys without changing usage identity * fix(gui): unify gateway keys and selectable connection examples Keep sharing controls in Settings and manage credentials only in Gateway. Refresh the named-key list on navigation, ignore stale reads after key actions, and generate all API examples from the selected address and enabled key. * fix(gui): keep caller key names literal in connection menus * fix(access): use Magpie as default key and drop user migration * refactor(gui): name caller key source and tests consistently * refactor(usage): split provider-key accounting out of caller-key PR * fix(gateway): preserve LAN compatibility and add headless key management * fix(gui): clarify gateway keys and confirm destructive actions * test(gateway): guard caller attribution under 120 concurrent requests * fix(gateway): keep open access, tolerate migration errors and revoke legacy keys * fix(backup): preserve named gateway keys and honor no-keys restores * fix(gui): keep local API-key semantics and disambiguate shared credentials * docs(gateway): keep review scope focused and append browser test documentation * fix(backup): retain existing default keys when old backups lack their store * fix(gateway): attribute video creation usage to the caller key * fix(access): explain default key revocation blocked by read-only settings * test(usage): preserve provider and caller identities after rebase * test(gui): reconcile caller key fixtures with merged main * docs(usage): clarify caller coverage and independent provider accounting * fix(gui): initialize fast members for model-shortcut groups Latest main introduced fast-member arrays but omitted the model shortcut's draft. The existing unlisted-models browser regression fails unchanged on main. Initialize fast to an empty list and assert a standard-speed group is saved, without relaxing existing assertions. * fix(access): retain legacy LAN access when the key store cannot be created Allow only the configured legacy credential before either migration marker exists. Refuse revoked mirrors, disabled matches and unreadable stores; keep the fallback's caller identity stable when migration later succeeds. Cover read-only configuration directories, remote credential transports and revocation. * fix(backup): save settings before replacing gateway credentials Leave the key store untouched when settings validation or writes fail. Restore the previous settings association when the key store refuses its write, and report a rollback failure separately. Cover invalid settings and read-only settings/store failures. * fix(gui): reset missing caller filters and focus key controls without scrolling * test(provider): synchronize Zhipu quota fixture observations
378 lines
12 KiB
Go
378 lines
12 KiB
Go
package gui
|
|
|
|
import (
|
|
"bytes"
|
|
"context"
|
|
"encoding/json"
|
|
"fmt"
|
|
"net/http"
|
|
"net/url"
|
|
"os"
|
|
"path/filepath"
|
|
"strconv"
|
|
"time"
|
|
|
|
"github.com/yetone/magpie/internal/access"
|
|
"github.com/yetone/magpie/internal/agent"
|
|
"github.com/yetone/magpie/internal/edit"
|
|
"github.com/yetone/magpie/internal/provider"
|
|
"github.com/yetone/magpie/internal/sessions"
|
|
"github.com/yetone/magpie/internal/usage"
|
|
)
|
|
|
|
// usageGroup is a usage.Group with what the UI needs to draw it.
|
|
type usageGroup struct {
|
|
usage.Group
|
|
Name string `json:"name"`
|
|
Sub string `json:"sub,omitempty"` // models: the provider's name
|
|
Icon string `json:"icon,omitempty"` // a real logo, or "generic" for an unknown client
|
|
}
|
|
|
|
type usageJSON struct {
|
|
usage.Summary
|
|
Agents []usageGroup `json:"agents"`
|
|
Models []usageGroup `json:"models"`
|
|
CallerKeys []usageGroup `json:"callerKeys"`
|
|
Path string `json:"path"`
|
|
}
|
|
|
|
func usageState(p usage.Period) usageJSON {
|
|
s := usage.Summarize(p)
|
|
out := usageJSON{Summary: s, Agents: []usageGroup{}, Models: []usageGroup{}, Path: tilde(usage.Path())}
|
|
agents := map[string]*agent.Agent{}
|
|
for _, a := range agent.Clients() {
|
|
agents[a.ID] = a
|
|
}
|
|
for _, g := range s.Agents {
|
|
ug := usageGroup{Group: g, Name: g.ID, Icon: "generic"}
|
|
if a := agents[g.ID]; a != nil {
|
|
ug.Name, ug.Icon = a.Name, a.Icon
|
|
}
|
|
out.Agents = append(out.Agents, ug)
|
|
}
|
|
providers := map[string]provider.Provider{}
|
|
for _, p := range provider.All() {
|
|
providers[p.ID] = p
|
|
}
|
|
for _, g := range s.Models {
|
|
ug := usageGroup{Group: g, Name: g.Model, Sub: g.Provider, Icon: "generic"}
|
|
if p, ok := providers[g.Provider]; ok {
|
|
ug.Sub = p.Name
|
|
if p.Icon != "" {
|
|
ug.Icon = p.Icon
|
|
}
|
|
}
|
|
if g.Host != "" {
|
|
ug.Sub += " · " + g.Host
|
|
}
|
|
out.Models = append(out.Models, ug)
|
|
}
|
|
out.CallerKeys = callerUsageGroups(s)
|
|
return out
|
|
}
|
|
|
|
func callerUsageGroups(s usage.Summary) []usageGroup {
|
|
keys := []usageGroup{}
|
|
current, _ := access.List()
|
|
names := map[string]string{}
|
|
for _, k := range current {
|
|
names[k.ID] = k.Name
|
|
}
|
|
for _, g := range s.CallerKeys {
|
|
n := names[g.CallerKeyID]
|
|
if n == "" {
|
|
n = g.CallerKeyName
|
|
}
|
|
if n == "" {
|
|
n = g.CallerKeyID
|
|
}
|
|
keys = append(keys, usageGroup{Group: g, Name: n, Icon: "generic"})
|
|
}
|
|
return keys
|
|
}
|
|
|
|
func periodOf(s string) usage.Period {
|
|
switch p := usage.Period(s); p {
|
|
case usage.Today, usage.Week, usage.Month, usage.All:
|
|
return p
|
|
}
|
|
return usage.Month
|
|
}
|
|
|
|
func ledgerFilter(q url.Values) usage.Filter {
|
|
id, _ := strconv.ParseInt(q.Get("route"), 10, 64)
|
|
return usage.Filter{RouteID: id, Model: q.Get("model"), Agent: q.Get("agent"), Provider: q.Get("provider"), CallerKey: q.Get("callerKey"), Failed: q.Get("failed") == "1", Query: q.Get("q")}
|
|
}
|
|
|
|
// ledgerRow is a usage.Row with the names the page shows it by.
|
|
type ledgerRow struct {
|
|
usage.Row
|
|
CallerKeyLabel string `json:"callerKeyLabel,omitempty"`
|
|
AgentName string `json:"agentName"`
|
|
Icon string `json:"icon"` // the agent's
|
|
ProviderName string `json:"providerName"`
|
|
Access string `json:"access,omitempty"` // known account/route type, independent of model maker
|
|
PricingModel string `json:"pricing_model,omitempty"`
|
|
}
|
|
|
|
type ledgerJSON struct {
|
|
CallerKeys []usageGroup `json:"callerKeys"`
|
|
Period usage.Period `json:"period"`
|
|
Rows []ledgerRow `json:"rows"`
|
|
Offset int `json:"offset"`
|
|
Total int `json:"total"` // the rows the filter keeps, on every page
|
|
// Series: those rows by hour, day or week (Bucket), for the chart
|
|
Bucket string `json:"bucket"`
|
|
Series []usage.SeriesPoint `json:"series"`
|
|
// By: the rows told apart by provider, agent and model, the most tokens
|
|
// first. The one by a dimension the filter has picked is of the rows
|
|
// without that pick, so the others are still there to switch to.
|
|
By map[string][]ledgerShare `json:"by"`
|
|
usage.Totals
|
|
// Agents and Providers: those with calls in the period, for the filters
|
|
Agents []ledgerAgent `json:"agents"`
|
|
Providers []ledgerAgent `json:"providers"`
|
|
}
|
|
|
|
// ledgerShare is a usage.Share with the name and logo the page shows it by.
|
|
type ledgerShare struct {
|
|
usage.Share
|
|
Name string `json:"name"`
|
|
Icon string `json:"icon,omitempty"`
|
|
}
|
|
|
|
type ledgerAgent struct {
|
|
ID string `json:"id"`
|
|
Name string `json:"name"`
|
|
Icon string `json:"icon"`
|
|
}
|
|
|
|
// ledgerPage is one page of the ledger: limit rows (100 when none is
|
|
// given, 500 at most) from offset.
|
|
func ledgerPage(p usage.Period, f usage.Filter, offset, limit int) ledgerJSON {
|
|
l := usage.QueryPage(p, f, offset, limit)
|
|
offset = max(0, min(offset, l.Total))
|
|
page := l.Rows
|
|
agents := map[string]*agent.Agent{}
|
|
for _, a := range agent.Clients() {
|
|
agents[a.ID] = a
|
|
}
|
|
// A session file without route evidence is a local source, not a supplier.
|
|
names := map[string]string{usage.UnknownProvider: "Local session"}
|
|
icons := map[string]string{}
|
|
access := map[string]string{}
|
|
for _, pr := range provider.All() {
|
|
names[pr.ID], icons[pr.ID] = pr.Name, pr.Icon
|
|
if pr.Account != nil {
|
|
access[pr.ID] = "subscription"
|
|
} else if pr.Key != "" {
|
|
access[pr.ID] = "api"
|
|
}
|
|
}
|
|
who := func(id string) ledgerAgent {
|
|
if a := agents[id]; a != nil {
|
|
return ledgerAgent{ID: id, Name: a.Name, Icon: a.Icon}
|
|
}
|
|
return ledgerAgent{ID: id, Name: id, Icon: "generic"}
|
|
}
|
|
which := func(id string) ledgerAgent {
|
|
a := ledgerAgent{ID: id, Name: names[id], Icon: icons[id]}
|
|
if a.Name == "" {
|
|
a.Name = id
|
|
}
|
|
if a.Icon == "" {
|
|
a.Icon = "generic"
|
|
}
|
|
return a
|
|
}
|
|
out := ledgerJSON{Period: p, Rows: make([]ledgerRow, 0, len(page)), Offset: offset, Total: l.Total, Totals: l.Sum, Agents: []ledgerAgent{}, Providers: []ledgerAgent{}}
|
|
out.Bucket, out.Series = l.Bucket, l.Series
|
|
out.CallerKeys = callerUsageGroups(usage.Summary{CallerKeys: l.CallerKeys})
|
|
callerLabels := map[string]string{}
|
|
for _, g := range out.CallerKeys {
|
|
callerLabels[g.CallerKeyID] = g.Name
|
|
}
|
|
for _, r := range page {
|
|
a := who(r.Agent)
|
|
lr := ledgerRow{Row: r, AgentName: a.Name, Icon: a.Icon, ProviderName: names[r.Provider]}
|
|
if r.Source != "log" {
|
|
lr.Access = access[r.Provider]
|
|
}
|
|
if r.Priced {
|
|
if model := provider.PricedName(r.Model); model != r.Model {
|
|
lr.PricingModel = model
|
|
}
|
|
}
|
|
if lr.ProviderName == "" {
|
|
lr.ProviderName = r.Provider
|
|
}
|
|
lr.CallerKeyLabel = callerLabels[r.CallerKeyID]
|
|
out.Rows = append(out.Rows, lr)
|
|
}
|
|
for _, id := range l.Agents {
|
|
out.Agents = append(out.Agents, who(id))
|
|
}
|
|
for _, id := range l.Providers {
|
|
out.Providers = append(out.Providers, which(id))
|
|
}
|
|
// what each is of: the rows of the filter, or, for the dimension the
|
|
// filter has picked, of the rows without that pick
|
|
out.By = map[string][]ledgerShare{}
|
|
for _, d := range usage.Dimensions {
|
|
shares := []ledgerShare{}
|
|
for _, s := range l.By[d] {
|
|
ls := ledgerShare{Share: s, Name: s.ID}
|
|
switch d {
|
|
case "provider":
|
|
a := which(s.ID)
|
|
ls.Name, ls.Icon = a.Name, a.Icon
|
|
case "agent":
|
|
a := who(s.ID)
|
|
ls.Name, ls.Icon = a.Name, a.Icon
|
|
}
|
|
shares = append(shares, ls)
|
|
}
|
|
out.By[d] = shares
|
|
}
|
|
return out
|
|
}
|
|
|
|
// contentJSON is what was said in a request, or why it can't be told.
|
|
type contentJSON struct {
|
|
Found bool `json:"found"`
|
|
// Why not: "session" (the request named none), "agent" (magpie reads the session
|
|
// files of Claude Code, Claude Desktop and Codex only), "missing" (the files have no
|
|
// such call: deleted, moved, or not written yet) or "read" (the file wouldn't read)
|
|
Why string `json:"why,omitempty"`
|
|
Model string `json:"model,omitempty"`
|
|
sessions.Content
|
|
}
|
|
|
|
// requestContent finds the call a request is in its agent's session files and reads it.
|
|
func requestContent(agent, session string, from, to, at time.Time) contentJSON {
|
|
out := contentJSON{Content: sessions.Content{Input: []sessions.Part{}, Output: []sessions.Part{}}}
|
|
switch {
|
|
case session == "":
|
|
out.Why = "session"
|
|
case agent != "claude" && agent != "claude-desktop" && agent != "codex":
|
|
out.Why = "agent"
|
|
default:
|
|
c, ok := sessions.FindCall(session, from, to, at)
|
|
if !ok {
|
|
out.Why = "missing"
|
|
break
|
|
}
|
|
content, err := sessions.ContentOf(c)
|
|
if err != nil {
|
|
out.Why = "read"
|
|
break
|
|
}
|
|
out.Found, out.Model, out.Content = true, c.Model, content
|
|
}
|
|
return out
|
|
}
|
|
|
|
func usageRoutes(mux *http.ServeMux, w Windows) {
|
|
mux.HandleFunc("GET /api/usage", func(rw http.ResponseWriter, r *http.Request) {
|
|
p := usage.Period(r.URL.Query().Get("period"))
|
|
switch p {
|
|
case usage.Today, usage.Week, usage.Month, usage.All:
|
|
default:
|
|
p = usage.Month
|
|
}
|
|
writeJSON(rw, usageState(p))
|
|
})
|
|
// the ledger: the period's calls, newest first, a page at a time
|
|
mux.HandleFunc("GET /api/usage/requests", func(rw http.ResponseWriter, r *http.Request) {
|
|
q := r.URL.Query()
|
|
offset, _ := strconv.Atoi(q.Get("offset"))
|
|
limit, _ := strconv.Atoi(q.Get("limit"))
|
|
writeJSON(rw, ledgerPage(periodOf(q.Get("period")), ledgerFilter(q), offset, limit))
|
|
})
|
|
// what was said in one request, read from the agent's session file when the
|
|
// row is opened, between two times (the call's own, or a gateway request's
|
|
// span): magpie keeps no copy
|
|
mux.HandleFunc("GET /api/usage/requests/content", func(rw http.ResponseWriter, r *http.Request) {
|
|
q := r.URL.Query()
|
|
from, err1 := time.Parse(time.RFC3339Nano, q.Get("from"))
|
|
to, err2 := time.Parse(time.RFC3339Nano, q.Get("to"))
|
|
if err1 != nil || err2 != nil {
|
|
http.Error(rw, "from and to are times", http.StatusBadRequest)
|
|
return
|
|
}
|
|
// at: when the call should have ended (a gateway request's start and
|
|
// its time); none is the window's end
|
|
at, err := time.Parse(time.RFC3339Nano, q.Get("at"))
|
|
if err != nil {
|
|
at = to
|
|
}
|
|
writeJSON(rw, requestContent(q.Get("agent"), q.Get("session"), from, to, at))
|
|
})
|
|
// the same CSV to a browser (magpie web), which saves it itself
|
|
mux.HandleFunc("GET /api/usage/requests.csv", func(rw http.ResponseWriter, r *http.Request) {
|
|
q := r.URL.Query()
|
|
p := periodOf(q.Get("period"))
|
|
rows, _, _ := usage.Ledger(p, ledgerFilter(q))
|
|
rw.Header().Set("Content-Type", "text/csv; charset=utf-8")
|
|
rw.Header().Set("Content-Disposition", `attachment; filename="magpie-requests-`+string(p)+"-"+time.Now().Format("2006-01-02")+`.csv"`)
|
|
usage.WriteCSV(rw, rows)
|
|
})
|
|
// the rows the ledger shows, all its pages, as a CSV in Downloads
|
|
mux.HandleFunc("POST /api/usage/requests/export", func(rw http.ResponseWriter, r *http.Request) {
|
|
q := r.URL.Query()
|
|
p := periodOf(q.Get("period"))
|
|
rows, _, _ := usage.Ledger(p, ledgerFilter(q))
|
|
var b bytes.Buffer
|
|
if err := usage.WriteCSV(&b, rows); err != nil {
|
|
fail(rw, err)
|
|
return
|
|
}
|
|
dir := downloads()
|
|
stamp := "magpie-requests-" + string(p) + "-" + time.Now().Format("2006-01-02")
|
|
name := filepath.Join(dir, stamp+".csv")
|
|
for i := 2; ; i++ { // never over an earlier one
|
|
if _, err := os.Stat(name); err != nil {
|
|
break
|
|
}
|
|
name = filepath.Join(dir, fmt.Sprintf("%s-%d.csv", stamp, i))
|
|
}
|
|
if err := edit.WriteAtomic(name, b.Bytes()); err != nil {
|
|
fail(rw, err)
|
|
return
|
|
}
|
|
_ = w.OpenFolder(dir) // saved either way; the path is in the answer
|
|
writeJSON(rw, map[string]any{"path": tilde(name), "rows": len(rows)})
|
|
})
|
|
// The subscriptions' quotas, the plans' bought with a key, and the
|
|
// keys' balances come from the
|
|
// vendors, which can be slow or unreachable, so the page asks for them
|
|
// apart from the local log.
|
|
// ?asked=1 is the user opening or refreshing the page: Claude Code's
|
|
// own /usage is run at once (provider.AskClaudeUsage).
|
|
mux.HandleFunc("GET /api/usage/quotas", func(rw http.ResponseWriter, r *http.Request) {
|
|
if r.URL.Query().Get("asked") != "" {
|
|
provider.AskClaudeUsage()
|
|
}
|
|
ctx, cancel := context.WithTimeout(r.Context(), 12*time.Second)
|
|
defer cancel()
|
|
writeJSON(rw, provider.Quotas(ctx))
|
|
})
|
|
// spends one of a Codex account's rate-limit resets, which the page
|
|
// has asked the user about first; what it did comes back
|
|
mux.HandleFunc("POST /api/usage/codex-reset", func(rw http.ResponseWriter, r *http.Request) {
|
|
var in struct{ User string }
|
|
if err := json.NewDecoder(r.Body).Decode(&in); err != nil {
|
|
fail(rw, err)
|
|
return
|
|
}
|
|
ctx, cancel := context.WithTimeout(r.Context(), 20*time.Second)
|
|
defer cancel()
|
|
out, err := provider.UseCodexReset(ctx, in.User)
|
|
if err != nil {
|
|
fail(rw, err)
|
|
return
|
|
}
|
|
writeJSON(rw, out)
|
|
})
|
|
}
|