fix(cursor): merge SKU catalog under ACP lock and refcount agent guard (#835)

Fixes incomplete cliModelSkus while agent acp holds the CLI lock (#831) and
replace single-pid ACP lock with cross-process refcount (#832). Web picker
merges machine/session catalogs and waits for SKU readiness before showing
variant labels.

Fixes #831
Fixes #832

Co-authored-by: Cursor <cursoragent@cursor.com>
This commit is contained in:
SSU-WEI HUANG
2026-06-08 13:30:43 +08:00
committed by GitHub
co-authored by Cursor
parent 6d2d0d4707
commit ad038bbf2e
15 changed files with 891 additions and 65 deletions
+144
View File
@@ -34,6 +34,7 @@ import {
} from './cursorModelsSharedCache';
import {
_resetCursorModelsCacheForTests,
buildCursorModelsSeedPayload,
listCursorModels,
parseCursorModelsOutput,
seedCursorModelsCache
@@ -48,6 +49,33 @@ afterEach(() => {
acpProbeMock.runCursorAcpModelProbe.mockReset()
})
describe('buildCursorModelsSeedPayload', () => {
test('inherits cliModelSkus from shared cache when ACP snapshot has none', () => {
writeSharedCursorModelsCache({
success: true,
availableModels: [{ modelId: 'gpt-5.5[context=272k,reasoning=medium,fast=false]', name: 'gpt-5.5' }],
currentModelId: 'gpt-5.5[context=272k,reasoning=medium,fast=false]',
cliModelSkus: [
{ modelId: 'gpt-5.5-medium', name: 'GPT-5.5 1M' },
{ modelId: 'gpt-5.5-high', name: 'GPT-5.5 High' }
]
})
const seeded = buildCursorModelsSeedPayload(
{
availableModels: [{ modelId: 'gpt-5.5[context=272k,reasoning=medium,fast=false]', name: 'gpt-5.5' }],
currentModelId: 'gpt-5.5[context=272k,reasoning=medium,fast=false]'
},
readSharedCursorModelsCache()
)
expect(seeded.cliModelSkus?.map((row) => row.modelId)).toEqual([
'gpt-5.5-medium',
'gpt-5.5-high'
])
})
})
describe('parseCursorModelsOutput', () => {
test('parses Cursor agent model list output', () => {
const result = parseCursorModelsOutput(`
@@ -153,6 +181,107 @@ describe('listCursorModels', () => {
expect(readSharedCursorModelsCache()?.currentModelId).toBe('composer-2.5[fast=true]')
})
test('unions partial response cliModelSkus with fuller shared cache while lock is active', async () => {
vi.mocked(isAgentAcpTransportActive).mockReturnValue(true)
setCursorAcpModelsSnapshot({
availableModels: [{ modelId: 'gpt-5.5[context=272k,reasoning=medium,fast=false]', name: 'gpt-5.5' }],
currentModelId: 'gpt-5.5[context=272k,reasoning=medium,fast=false]',
cliModelSkus: [
{ modelId: 'gpt-5.5-high-fast', name: 'GPT-5.5 High Fast' },
{ modelId: 'gpt-5.5-low', name: 'GPT-5.5 1M Low' }
]
} as never)
writeSharedCursorModelsCache({
success: true,
availableModels: [{ modelId: 'gpt-5.5[context=272k,reasoning=medium,fast=false]', name: 'gpt-5.5' }],
currentModelId: 'gpt-5.5[context=272k,reasoning=medium,fast=false]',
cliModelSkus: [
{ modelId: 'gpt-5.5-high-fast', name: 'GPT-5.5 High Fast' },
{ modelId: 'gpt-5.5-low', name: 'GPT-5.5 1M Low' },
{ modelId: 'gpt-5.5-medium', name: 'GPT-5.5 1M' },
{ modelId: 'gpt-5.5-high', name: 'GPT-5.5 High' }
]
})
const result = await listCursorModels()
expect(result.cliModelSkus?.map((row) => row.modelId)).toEqual([
'gpt-5.5-high-fast',
'gpt-5.5-low',
'gpt-5.5-medium',
'gpt-5.5-high'
])
expect(spawnMock).not.toHaveBeenCalled()
})
test('enriches live ACP snapshot with fuller shared cliModelSkus while lock is active', async () => {
vi.mocked(isAgentAcpTransportActive).mockReturnValue(true)
setCursorAcpModelsSnapshot({
availableModels: [{ modelId: 'gpt-5.5[context=272k,reasoning=medium,fast=false]', name: 'gpt-5.5' }],
currentModelId: 'gpt-5.5[context=272k,reasoning=medium,fast=false]'
})
writeSharedCursorModelsCache({
success: true,
availableModels: [{ modelId: 'gpt-5.5[context=272k,reasoning=medium,fast=false]', name: 'gpt-5.5' }],
currentModelId: 'gpt-5.5[context=272k,reasoning=medium,fast=false]',
cliModelSkus: [
{ modelId: 'gpt-5.5-high-fast', name: 'GPT-5.5 High Fast' },
{ modelId: 'gpt-5.5-low', name: 'GPT-5.5 1M Low' },
{ modelId: 'gpt-5.5-medium', name: 'GPT-5.5 1M' },
{ modelId: 'gpt-5.5-high', name: 'GPT-5.5 High' }
]
})
const result = await listCursorModels()
expect(result.cliModelSkus?.map((row) => row.modelId)).toEqual([
'gpt-5.5-high-fast',
'gpt-5.5-low',
'gpt-5.5-medium',
'gpt-5.5-high'
])
expect(spawnMock).not.toHaveBeenCalled()
})
test('unions shared partial cliModelSkus with probe results when lock is inactive', async () => {
writeSharedCursorModelsCache({
success: true,
availableModels: [{ modelId: 'gpt-5.5[context=272k,reasoning=medium,fast=false]', name: 'gpt-5.5' }],
currentModelId: 'gpt-5.5[context=272k,reasoning=medium,fast=false]',
cliModelSkus: [
{ modelId: 'gpt-5.5-medium', name: 'GPT-5.5 1M' }
]
})
spawnMock.mockImplementation(() => ({
stdout: {
on: vi.fn((event: string, handler: (chunk: Buffer) => void) => {
if (event === 'data') {
handler(Buffer.from(
'gpt-5.5-high-fast - GPT-5.5 High Fast\n'
+ 'gpt-5.5-high - GPT-5.5 High\n'
));
}
})
},
stderr: { on: vi.fn() },
on: vi.fn((event: string, handler: (code: number) => void) => {
if (event === 'exit') {
setTimeout(() => handler(0), 0);
}
}),
kill: vi.fn()
}));
const result = await listCursorModels();
expect(result.cliModelSkus?.map((row) => row.modelId)).toEqual([
'gpt-5.5-medium',
'gpt-5.5-high-fast',
'gpt-5.5-high'
]);
expect(spawnMock).toHaveBeenCalled();
});
test('prefers ACP wire probe over CLI slug probe when cache is empty', async () => {
acpProbeMock.runCursorAcpModelProbe.mockResolvedValue({
success: true,
@@ -216,6 +345,21 @@ describe('listCursorModels', () => {
});
});
test('skips CLI slug probe when ACP lock is active after ACP probe', async () => {
vi.mocked(isAgentAcpTransportActive)
.mockReturnValueOnce(false)
.mockReturnValueOnce(true);
acpProbeMock.runCursorAcpModelProbe.mockResolvedValue({
success: false,
error: 'no wires'
});
const result = await listCursorModels();
expect(spawnMock).not.toHaveBeenCalled();
expect(result).toEqual({ success: false, error: 'no wires' });
});
test('prefers live ACP snapshot over cache while ACP transport is active', async () => {
vi.mocked(isAgentAcpTransportActive).mockReturnValue(true)
seedCursorModelsCache({
+80 -25
View File
@@ -18,6 +18,44 @@ import {
runCursorAcpModelProbe
} from './cursorAcpModelProbe';
export function buildCursorModelsSeedPayload(
snapshot: {
availableModels: CursorModelSummary[];
currentModelId: string | null;
cliModelSkus?: readonly CursorModelSummary[];
},
shared?: CursorModelsResponse | null
): ListCursorModelsResponse {
const cliModelSkus = mergeCliModelSkus(
snapshot.cliModelSkus ?? [],
shared?.cliModelSkus ?? []
);
return {
success: true,
availableModels: snapshot.availableModels,
currentModelId: snapshot.currentModelId,
...(cliModelSkus.length > 0 ? { cliModelSkus } : {})
};
}
export function mergeCliModelSkus(
...lists: readonly (readonly CursorModelSummary[])[]
): CursorModelSummary[] {
const merged = new Map<string, CursorModelSummary>();
for (const list of lists) {
for (const entry of list) {
const modelId = entry.modelId.trim();
if (!modelId) {
continue;
}
if (!merged.has(modelId)) {
merged.set(modelId, entry);
}
}
}
return [...merged.values()];
}
function filterCliSkusForWireBases(
cliSkus: CursorModelSummary[],
wires: CursorModelSummary[]
@@ -39,44 +77,47 @@ function attachCliSkusToResponse(
response: ListCursorModelsResponse,
cliSkus: readonly CursorModelSummary[]
): ListCursorModelsResponse {
if ((response.cliModelSkus?.length ?? 0) > 0) {
return response;
}
const wires = (response.availableModels ?? []).filter((entry) => isCursorAcpWireModelId(entry.modelId));
const filtered = filterCliSkusForWireBases([...cliSkus], wires);
return filtered.length > 0 ? { ...response, cliModelSkus: filtered } : response;
const merged = mergeCliModelSkus(response.cliModelSkus ?? [], filtered);
if (merged.length === 0) {
return response;
}
if (merged.length === (response.cliModelSkus?.length ?? 0)) {
return response;
}
return { ...response, cliModelSkus: merged };
}
async function enrichCursorModelsWithCliSkus(
response: ListCursorModelsResponse
): Promise<ListCursorModelsResponse> {
if ((response.cliModelSkus?.length ?? 0) > 0) {
return response;
}
const wires = (response.availableModels ?? []).filter((entry) => isCursorAcpWireModelId(entry.modelId));
if (wires.length === 0) {
return response;
}
const candidates: CursorModelSummary[] = [];
const shared = readSharedCursorModelsCache();
if (shared?.cliModelSkus?.length) {
return attachCliSkusToResponse(response, shared.cliModelSkus);
candidates.push(...shared.cliModelSkus);
}
// Never spawn `agent --list-models` while an ACP session holds the CLI lock.
if (isAgentAcpTransportActive()) {
if (!isAgentAcpTransportActive()) {
try {
const probe = await runCursorModelProbe();
candidates.push(...(probe.availableModels ?? []));
} catch {
// Keep partial candidates from shared cache.
}
}
if (candidates.length === 0) {
return response;
}
try {
const probe = await runCursorModelProbe();
const cliSkus = filterCliSkusForWireBases(probe.availableModels ?? [], wires);
return cliSkus.length > 0 ? { ...response, cliModelSkus: cliSkus } : response;
} catch {
return response;
}
return attachCliSkusToResponse(response, candidates);
}
export type ListCursorModelsResponse = CursorModelsResponse;
@@ -134,6 +175,10 @@ export function parseCursorModelsOutput(output: string): {
}
async function runCursorModelProbe(): Promise<ListCursorModelsResponse> {
if (isAgentAcpTransportActive()) {
throw new Error('Cursor ACP transport is active');
}
return await new Promise((resolve, reject) => {
const child = spawn('agent', ['--list-models'], {
env: process.env,
@@ -204,7 +249,10 @@ async function listCursorModelsWhileAcpActive(): Promise<ListCursorModelsRespons
}
if (cache.expiresAt > Date.now() && (cache.response.availableModels?.length ?? 0) > 0) {
const shared = readSharedCursorModelsCache();
const cachedSkus = cache.response.cliModelSkus ?? shared?.cliModelSkus ?? [];
const cachedSkus = mergeCliModelSkus(
cache.response.cliModelSkus ?? [],
shared?.cliModelSkus ?? []
);
return attachCliSkusToResponse(cache.response, cachedSkus);
}
return { success: true, availableModels: [], currentModelId: null };
@@ -240,9 +288,12 @@ export async function listCursorModels(): Promise<ListCursorModelsResponse> {
return applyInMemoryCache(acpResponse);
}
const probeResponse = await runCursorModelProbe();
if (cursorProbeResponseHasWireCatalog(probeResponse)) {
return applyInMemoryCache(probeResponse);
let probeResponse: ListCursorModelsResponse | null = null;
if (!isAgentAcpTransportActive()) {
probeResponse = await runCursorModelProbe();
if (cursorProbeResponseHasWireCatalog(probeResponse)) {
return applyInMemoryCache(probeResponse);
}
}
// CLI `--list-models` returns slug ids without bracket params; never cache
@@ -250,9 +301,10 @@ export async function listCursorModels(): Promise<ListCursorModelsResponse> {
if (acpResponse.success) {
return acpResponse;
}
return probeResponse.success
? { success: true, availableModels: [], currentModelId: null }
: probeResponse;
if (probeResponse?.success) {
return { success: true, availableModels: [], currentModelId: null };
}
return probeResponse ?? acpResponse;
} catch (error) {
return {
success: false,
@@ -267,6 +319,9 @@ export async function listCursorModels(): Promise<ListCursorModelsResponse> {
}
export function seedCursorModelsCache(response: ListCursorModelsResponse): void {
if ((response.availableModels?.length ?? 0) > 0) {
writeSharedCursorModelsCache(response);
}
void applyInMemoryCache(response);
}
@@ -0,0 +1,39 @@
import { afterEach, describe, expect, test, vi } from 'vitest';
const listCursorModelsMock = vi.hoisted(() => vi.fn());
vi.mock('./cursorModels', () => ({
listCursorModels: listCursorModelsMock
}));
import { scheduleCursorModelsPrewarm } from './cursorModelsPrewarm';
afterEach(() => {
listCursorModelsMock.mockReset();
});
describe('scheduleCursorModelsPrewarm', () => {
test('starts a background listCursorModels call', async () => {
listCursorModelsMock.mockResolvedValue({
success: true,
availableModels: [],
currentModelId: null
});
scheduleCursorModelsPrewarm();
await Promise.resolve();
expect(listCursorModelsMock).toHaveBeenCalledTimes(1);
});
test('swallows listCursorModels failures', async () => {
listCursorModelsMock.mockRejectedValue(new Error('agent missing'));
scheduleCursorModelsPrewarm();
await Promise.resolve();
expect(listCursorModelsMock).toHaveBeenCalledTimes(1);
});
});
@@ -0,0 +1,9 @@
import { logger } from '@/ui/logger';
import { listCursorModels } from './cursorModels';
/** Background fill of shared cursor-models cache; does not block runner startup. */
export function scheduleCursorModelsPrewarm(): void {
void listCursorModels().catch((error) => {
logger.debug('[RUNNER RUN] Cursor model pre-warm failed', error);
});
}
@@ -26,4 +26,19 @@ describe('cursorModelsSharedCache', () => {
writeSharedCursorModelsCache({ success: true, availableModels: [], currentModelId: null });
expect(readSharedCursorModelsCache()).toBeNull();
});
test('round-trips cliModelSkus with wire catalog', () => {
const payload = {
success: true as const,
availableModels: [{ modelId: 'gpt-5.5[context=272k,reasoning=medium,fast=false]', name: 'gpt-5.5' }],
currentModelId: 'gpt-5.5[context=272k,reasoning=medium,fast=false]',
cliModelSkus: [
{ modelId: 'gpt-5.5-medium', name: 'GPT-5.5 1M' }
]
};
writeSharedCursorModelsCache(payload);
expect(readSharedCursorModelsCache()?.cliModelSkus).toEqual(payload.cliModelSkus);
});
});