Files
multica/packages/core/runtimes/models.test.ts
Multica Eve c25a82eee0 perf(agents): fast model discovery on runtime switch (MUL-5444) (#6098)
* perf(agents): make runtime model discovery fast on runtime switch (MUL-5444)

Switching runtime in the agent creation form left the model picker
spinning for ~8-20s. Two costs stacked up:

- the list-models request sat in the store until the daemon's next
  scheduled heartbeat (0-15s, avg 7.5s of pure dead wait), and
- the daemon then enumerated the catalog locally (static for claude,
  but a CLI/ACP round trip up to ~15s for everyone else).

Both are addressed with the two standard techniques for a slow,
low-frequency, read-only operation: push instead of poll, and
stale-while-revalidate.

Push (removes the heartbeat wait):
- new additive `daemon:pending_work` hint, runtime-scoped, delivered
  through the existing daemon WS hub and the Redis relay so the API node
  holding the socket does the delivery.
- the daemon answers a hint with ONE immediate heartbeat and dispatches
  what it claimed. The hint deliberately carries no work, so nothing has
  to be un-claimed when delivery fails and a duplicate hint cannot
  duplicate work - PopPending stays the atomic claim.
- per-runtime coalescing plus a 1s floor keeps a caller-triggered hint
  from becoming a heartbeat amplifier.

Cache (removes the discovery wait on repeat opens):
- server-side per-runtime catalog cache (in-memory single-node, Redis
  multi-node) written on every successful report.
- a snapshot younger than 15min answers the POST immediately as an
  already-completed request; older than 60s it also enqueues a
  background refresh that only warms the cache.
- only supported, non-empty catalogs are cached; a completed-but-empty
  report invalidates instead, while a failed report keeps serving the
  last known good list.

Frontend: staleTime 60s -> 5min and gcTime 30min, so a runtime revisited
in the same session renders from cache and revalidates in the background
instead of showing the spinner again.

Compatibility: every wire change is additive. Old daemons ignore the
unknown hint type and keep using the scheduled heartbeat; new daemons
against an old server simply never receive one. The cached response is
shaped exactly like a completed live discovery apart from the optional
`cached` / `cached_at` markers.

Co-authored-by: multica-agent <github@multica.ai>

* fix(agents): address review on model discovery SWR (MUL-5444)

Sol-Boy's review on #6098 found the client cache could outlive the
server's own staleness promise, and that the two changed endpoints were
still cast rather than validated.

Must-fix 1 — client freshness now derives from the served answer.
`staleTime` was a flat 5min, so a 14-minute-old snapshot (which the
server returns while queueing its own refresh) was held as fresh for
another 5min: observable staleness became server window + client window,
and the refreshed catalog never reached the tab that triggered the
refresh. `staleTime` is now a function of the query data: a `cached`
answer is stale on arrival (bound stays the server's window alone, and
the next mount/focus picks up the refreshed snapshot), while a live
discovery — which just measured the truth — is trusted for the full 5min
so a cold runtime is never re-enumerated inside one form session.
`gcTime` stays 30min, so a revisited runtime still renders from cache and
revalidates in the background; the pickers gate their spinner on
`isLoading`, which stays false throughout.

Must-fix 2 — both model-discovery responses go through a zod schema.
`POST /api/runtimes/{id}/models` and its poll companion were casting
network JSON to `RuntimeModelListRequest`, which the root CLAUDE.md
API-compatibility rules forbid. Added a lenient schema (`status` stays
`z.string()`, `supported` defaults to true, `.loose()` keeps unknown
fields) plus a fallback record whose `status` is `failed`: a malformed
body now surfaces "discovery failed" with manual entry still usable
instead of a fabricated empty catalog or an endless spinner.
`resolveRuntimeModels` was tightened to match — only an explicit
`completed` is a catalog, so an unrecognised status is an error rather
than a silent empty list, and `supported` can no longer be `undefined`.

Nit — the in-memory catalog cache now deep-copies each entry's
`Thinking` (and its level slice) and `ServiceTiers`, so it delivers the
independent value its comment promises and matches the Redis backend's
JSON round-trip semantics.

Tests: staleTime policy for cached/live/no-data; a QueryObserver test
proving the refreshed catalog reaches the same client with no blank
loading state; unknown-status and omitted-`supported` handling; schema
tests for live, cached, old-backend and nine malformed shapes; client
tests that both endpoints degrade to an explicit failure; nested-field
mutation isolation for the cache.

Co-authored-by: multica-agent <github@multica.ai>

---------

Co-authored-by: Eve <eve@multica-ai.local>
Co-authored-by: multica-agent <github@multica.ai>
2026-07-29 16:03:26 +08:00

252 lines
8.7 KiB
TypeScript

import { beforeEach, describe, expect, it, vi } from "vitest";
import { QueryClient, QueryObserver } from "@tanstack/react-query";
import {
LIVE_MODELS_STALE_TIME_MS,
resolveRuntimeModels,
runtimeModelsKeys,
runtimeModelsOptions,
staleTimeFor,
} from "./models";
import type { RuntimeModelListRequest, RuntimeModelsResult } from "../types/agent";
const initiateListModels = vi.fn();
const getListModelsResult = vi.fn();
vi.mock("../api", () => ({
api: {
initiateListModels: (runtimeId: string) => initiateListModels(runtimeId),
getListModelsResult: (runtimeId: string, requestId: string) =>
getListModelsResult(runtimeId, requestId),
},
}));
const catalog = [{ id: "claude-sonnet-4-6", label: "Claude Sonnet 4.6" }];
const refreshedCatalog = [{ id: "claude-opus-5", label: "Claude Opus 5" }];
function request(
overrides: Partial<RuntimeModelListRequest>,
): RuntimeModelListRequest {
return {
id: "req-1",
runtime_id: "rt-1",
status: "pending",
supported: true,
created_at: "2026-07-29T00:00:00Z",
updated_at: "2026-07-29T00:00:00Z",
...overrides,
};
}
function cachedResponse(
models: RuntimeModelListRequest["models"],
cachedAt: string,
): RuntimeModelListRequest {
return request({
status: "completed",
models,
cached: true,
cached_at: cachedAt,
});
}
beforeEach(() => {
initiateListModels.mockReset();
getListModelsResult.mockReset();
});
describe("resolveRuntimeModels", () => {
// The server answers a warm runtime straight from its catalog cache
// (MUL-5444). That response is already terminal, so discovery must resolve on
// the POST alone — one round trip, no polling, no spinner.
it("resolves from a cached completed response without polling", async () => {
initiateListModels.mockResolvedValue(
cachedResponse(catalog, "2026-07-29T00:00:00Z"),
);
const result = await resolveRuntimeModels("rt-1");
expect(result).toEqual({
models: catalog,
supported: true,
cached: true,
cachedAt: "2026-07-29T00:00:00Z",
});
expect(getListModelsResult).not.toHaveBeenCalled();
});
it("marks a live discovery as not cached", async () => {
initiateListModels.mockResolvedValue(
request({ status: "completed", models: catalog }),
);
const result = await resolveRuntimeModels("rt-1");
expect(result.cached).toBe(false);
expect(result.cachedAt).toBeUndefined();
});
it("still polls a pending response until the daemon reports back", async () => {
initiateListModels.mockResolvedValue(request({ status: "pending" }));
getListModelsResult
.mockResolvedValueOnce(request({ status: "running" }))
.mockResolvedValueOnce(request({ status: "completed", models: catalog }));
const result = await resolveRuntimeModels("rt-1");
expect(result.models).toEqual(catalog);
expect(result.supported).toBe(true);
expect(getListModelsResult).toHaveBeenCalledTimes(2);
expect(getListModelsResult).toHaveBeenLastCalledWith("rt-1", "req-1");
});
it("surfaces a failed discovery as an error", async () => {
initiateListModels.mockResolvedValue(
request({ status: "failed", error: "claude not installed" }),
);
await expect(resolveRuntimeModels("rt-1")).rejects.toThrow(
"claude not installed",
);
});
// A status this client does not know (newer server, or the malformed-response
// fallback record) must NOT read as "completed with no models" — that renders
// an authoritative-looking empty dropdown. The schema keeps `status` lenient,
// so such a value really can reach this code at runtime even though the TS
// union does not admit it.
it("treats an unrecognised status as an explicit failure", async () => {
initiateListModels.mockResolvedValue({
...request({}),
status: "superseded" as RuntimeModelListRequest["status"],
});
await expect(resolveRuntimeModels("rt-1")).rejects.toThrow(
/status: superseded/,
);
});
it("defaults supported to true when the server omits it", async () => {
initiateListModels.mockResolvedValue({
...request({ status: "completed", models: catalog }),
supported: undefined as unknown as boolean,
});
const result = await resolveRuntimeModels("rt-1");
expect(result.supported).toBe(true);
});
});
describe("staleTimeFor", () => {
// The server may serve a snapshot up to its own serve window old and refresh
// it in the background. If the client also held that response as fresh, the
// observable staleness would be server window + client window. Zero keeps the
// bound at the server's window alone.
it("treats a cached answer as immediately revalidatable", () => {
expect(staleTimeFor({ models: catalog, supported: true, cached: true })).toBe(0);
});
it("trusts a live answer for the full window", () => {
expect(staleTimeFor({ models: catalog, supported: true, cached: false })).toBe(
LIVE_MODELS_STALE_TIME_MS,
);
expect(staleTimeFor({ models: catalog, supported: true })).toBe(
LIVE_MODELS_STALE_TIME_MS,
);
});
it("has nothing to trust without data", () => {
expect(staleTimeFor(undefined)).toBe(0);
});
});
describe("runtimeModelsOptions", () => {
it("keeps unused entries long enough to render instantly on return", () => {
const options = runtimeModelsOptions("rt-1");
expect(options.gcTime).toBeGreaterThanOrEqual(LIVE_MODELS_STALE_TIME_MS);
expect(options.queryKey).toEqual(["runtimes", "models", "rt-1"]);
expect(options.enabled).toBe(true);
});
it("resolves freshness from the served answer, not a fixed window", () => {
const options = runtimeModelsOptions("rt-1");
expect(typeof options.staleTime).toBe("function");
const staleTime = options.staleTime as (query: {
state: { data?: { models: []; supported: boolean; cached?: boolean } };
}) => number;
expect(
staleTime({ state: { data: { models: [], supported: true, cached: true } } }),
).toBe(0);
expect(
staleTime({ state: { data: { models: [], supported: true, cached: false } } }),
).toBe(LIVE_MODELS_STALE_TIME_MS);
});
it("stays disabled without a runtime", () => {
expect(runtimeModelsOptions(null).enabled).toBe(false);
});
// The regression Sol-Boy flagged on PR #6098: a stale-but-served snapshot must
// reach the SAME client once the server-side refresh lands, and the picker
// must not blink an empty loading state while that happens.
it("picks up the refreshed catalog on revisit without a blank loading state", async () => {
initiateListModels
// First open: server hands back a 14-minute-old snapshot and queues its
// own background refresh.
.mockResolvedValueOnce(cachedResponse(catalog, "2026-07-29T00:00:00Z"))
// Revisit: the refresh has landed, so the same endpoint now serves the
// new catalog.
.mockResolvedValueOnce(
cachedResponse(refreshedCatalog, "2026-07-29T00:14:00Z"),
);
const client = new QueryClient({
defaultOptions: { queries: { retry: false } },
});
const options = runtimeModelsOptions("rt-1");
await client.fetchQuery(options);
expect(
client.getQueryData(runtimeModelsKeys.forRuntime("rt-1")),
).toMatchObject({ models: catalog, cached: true });
// A cached answer is stale on arrival, so remounting the picker revalidates.
const query = client
.getQueryCache()
.find<RuntimeModelsResult>({
queryKey: runtimeModelsKeys.forRuntime("rt-1"),
})!;
expect(query.isStaleByTime(staleTimeFor(query.state.data))).toBe(true);
const observer = new QueryObserver(client, options);
const emissions: { isLoading: boolean; ids: string[] }[] = [];
const unsubscribe = observer.subscribe((result) => {
emissions.push({
isLoading: result.isLoading,
ids: (result.data?.models ?? []).map((m) => m.id),
});
});
try {
await vi.waitFor(() => {
const last = emissions.at(-1);
expect(last?.ids).toEqual(refreshedCatalog.map((m) => m.id));
});
} finally {
unsubscribe();
client.clear();
}
// Every emission during the background revalidation kept a rendered
// catalog: the pickers gate their spinner on `isLoading`, so this is what
// "no blank loading state" means concretely.
expect(emissions.every((e) => e.isLoading === false)).toBe(true);
expect(emissions.every((e) => e.ids.length > 0)).toBe(true);
// The first emission is the stale snapshot still on screen while the
// revalidation runs — proof the new catalog arrived by replacing rendered
// data, not after a gap.
expect(emissions[0]?.ids).toEqual(catalog.map((m) => m.id));
expect(initiateListModels).toHaveBeenCalledTimes(2);
});
});