Skip to content

Commit e223404

Browse files
TylerLeonhardtTylerLeonhardt
committed
Let the setup banner reload an agent's configuration
A user who finishes setup outside the app — `claude login` in a terminal, an exported key — leaves no signal the app can see, so the banner kept asking them to sign in to something they had already signed in to. Give them a way to say "look again", and rename the docs link to "learn more" now that it is one of two links rather than the only one. The re-look is the tail of a download promoted to its own gesture: restart chat discovery, then refresh models. `AgentSdkSetupChannel` grows a second request key rather than per-agent code, so agent #3 still needs no edit here — one consumed nonce per key, cleared as it is claimed, so a repeat press still lands. The reload clause folds into each of the four `noAccount` sentences rather than trailing them: it is unconditional, so the table stays at four branches and no localized string is assembled from fragments.
1 parent 97a9b4a commit e223404

7 files changed

Lines changed: 206 additions & 46 deletions

File tree

‎src/vs/platform/agentHost/common/agentSdkSetup.ts‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,12 @@ const AGENT_SDK_SETUP_STATUS_KEY_PREFIX = 'vscode.agentSdkSetup.status.';
1818

1919
export const AGENT_SDK_SETUP_DOWNLOAD_REQUEST_KEY = 'vscode.agentSdkSetup.downloadRequest';
2020

21+
/**
22+
* Ask an agent to look again at a setup the user completed outside the app
23+
* (`claude login`, an exported key) — the only completion signal there is.
24+
*/
25+
export const AGENT_SDK_SETUP_RELOAD_REQUEST_KEY = 'vscode.agentSdkSetup.reloadRequest';
26+
2127
export function agentSdkSetupStatusKey(agent: string): string {
2228
return `${AGENT_SDK_SETUP_STATUS_KEY_PREFIX}${agent}`;
2329
}

‎src/vs/platform/agentHost/node/agentSdkSetupChannel.ts‎

Lines changed: 38 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
import { Disposable } from '../../../base/common/lifecycle.js';
77
import { ILogService } from '../../log/common/log.js';
8-
import { AGENT_SDK_SETUP_DOWNLOAD_REQUEST_KEY, AgentSdkDownloadStatus, IAgentSdkSetupInfo, agentSdkSetupStatusKey, isAgentSdkSetupRequestFor } from '../common/agentSdkSetup.js';
8+
import { AGENT_SDK_SETUP_DOWNLOAD_REQUEST_KEY, AGENT_SDK_SETUP_RELOAD_REQUEST_KEY, AgentSdkDownloadStatus, IAgentSdkSetupInfo, agentSdkSetupStatusKey, isAgentSdkSetupRequestFor } from '../common/agentSdkSetup.js';
99
import { IAgentConfigurationService } from './agentConfigurationService.js';
1010
import { IAgentSdkDownloader, IAgentSdkPackage } from './agentSdkDownloader.js';
1111

@@ -33,14 +33,14 @@ export interface IAgentSdkSetupChannelAgent {
3333

3434
/**
3535
* One agent's side of the SDK setup channel: publishes whether its SDK is on
36-
* disk, and performs the download the workbench asks for. Every agent needs the
37-
* same nonce handling, latching and publish ordering, so only the calls in
38-
* {@link IAgentSdkSetupChannelAgent} differ.
36+
* disk, performs the download the workbench asks for, and looks again when it
37+
* asks for that. Every agent needs the same nonce handling, latching and publish
38+
* ordering, so only the calls in {@link IAgentSdkSetupChannelAgent} differ.
3939
*/
4040
export class AgentSdkSetupChannel extends Disposable {
4141

42-
/** Consumed request nonce, so a root-config change we caused isn't re-handled. */
43-
private _lastRequest: string | undefined;
42+
/** Consumed request nonce per request key, so a root-config change we caused isn't re-handled. */
43+
private readonly _lastRequests = new Map<string, string>();
4444

4545
/**
4646
* Latched while the *explicit* download runs. {@link IAgentSdkSetupChannelAgent.isSdkLocal}
@@ -80,13 +80,27 @@ export class AgentSdkSetupChannel extends Disposable {
8080
}
8181

8282
private _handleRequest(): void {
83-
const request = this._configurationService.getRootConfigValues?.()[AGENT_SDK_SETUP_DOWNLOAD_REQUEST_KEY];
84-
if (!isAgentSdkSetupRequestFor(request, this._agent.id) || request.request === this._lastRequest) {
85-
return;
83+
const values = this._configurationService.getRootConfigValues?.() ?? {};
84+
if (this._takeRequest(values, AGENT_SDK_SETUP_DOWNLOAD_REQUEST_KEY)) {
85+
void this._download();
86+
}
87+
if (this._takeRequest(values, AGENT_SDK_SETUP_RELOAD_REQUEST_KEY)) {
88+
this._logService.info(`[AgentSdkSetup] ${this._agent.id}: reloading the agent's configuration at the user's request`);
89+
// Nothing to publish: the SDK is already on disk either way, and what the
90+
// banner reads is the catalog the re-look republishes.
91+
void this._lookAgain();
92+
}
93+
}
94+
95+
/** Claim one request addressed to this agent, clearing the key so a repeat press still lands. */
96+
private _takeRequest(values: Readonly<Record<string, unknown>>, key: string): boolean {
97+
const request = values[key];
98+
if (!isAgentSdkSetupRequestFor(request, this._agent.id) || request.request === this._lastRequests.get(key)) {
99+
return false;
86100
}
87-
this._lastRequest = request.request;
88-
this._configurationService.updateRootConfig({ [AGENT_SDK_SETUP_DOWNLOAD_REQUEST_KEY]: undefined });
89-
void this._download();
101+
this._lastRequests.set(key, request.request);
102+
this._configurationService.updateRootConfig({ [key]: undefined });
103+
return true;
90104
}
91105

92106
/**
@@ -110,12 +124,21 @@ export class AgentSdkSetupChannel extends Disposable {
110124
this._downloadInFlight = false;
111125
progressInterest.dispose();
112126
}
127+
await this._lookAgain();
128+
}
129+
130+
/**
131+
* Re-read the world: the tail of a download, and the whole of a reload. Both
132+
* gestures change exactly what these two calls see — one puts the SDK on disk,
133+
* the other follows a `claude login` the app could not observe.
134+
*/
135+
private async _lookAgain(): Promise<void> {
113136
// Chat discovery deferred itself while there was no SDK to read the catalog
114137
// from; this is the one moment that can change.
115138
this._agent.restartChatDiscovery();
116-
// Second, not first: the refresh is what asks the fresh SDK about the account,
117-
// so announcing `ready` ahead of it would show "no account found" to a user
118-
// who has one for as long as enumeration takes.
139+
// Second, not first: the refresh is what asks the SDK about the account, so
140+
// announcing `ready` ahead of it would show "no account found" to a user who
141+
// has one for as long as enumeration takes.
119142
await this._agent.refreshModels();
120143
}
121144
}

‎src/vs/platform/agentHost/test/node/claudeAgent.test.ts‎

Lines changed: 52 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ import { createClaudeInternalMcpServerCustomization } from '../../node/claude/cu
7777
import { ClaudeSessionMetadataStore } from '../../node/claude/claudeSessionMetadataStore.js';
7878
import { ClaudeSessionConfigKey } from '../../common/claudeSessionConfigKeys.js';
7979
import { ClaudeAgentSdkService, IClaudeAgentSdkService, IClaudeSdkBindings } from '../../node/claude/claudeAgentSdkService.js';
80-
import { AGENT_SDK_SETUP_DOWNLOAD_REQUEST_KEY, readAgentSdkSetupInfos } from '../../common/agentSdkSetup.js';
80+
import { AGENT_SDK_SETUP_DOWNLOAD_REQUEST_KEY, AGENT_SDK_SETUP_RELOAD_REQUEST_KEY, readAgentSdkSetupInfos } from '../../common/agentSdkSetup.js';
8181
import { IAgentSdkDownloader } from '../../node/agentSdkDownloader.js';
8282
import { RecordingAgentSdkDownloader } from './testAgentSdkDownloader.js';
8383
import { PendingRequestRegistry } from '../../common/pendingRequestRegistry.js';
@@ -6073,6 +6073,11 @@ suite('ClaudeAgent — agent SDK setup channel', () => {
60736073
ctx.configService.updateRootConfig({ [AGENT_SDK_SETUP_DOWNLOAD_REQUEST_KEY]: { agent, request } });
60746074
}
60756075

6076+
/** Addresses a reload request the same way, as the banner's link does. */
6077+
function dispatchReload(ctx: ITestContext, agent = 'claude', request = 'req-1'): void {
6078+
ctx.configService.updateRootConfig({ [AGENT_SDK_SETUP_RELOAD_REQUEST_KEY]: { agent, request } });
6079+
}
6080+
60766081
/** Waits for the ctor's queued publish (and any refresh it chains) to settle. */
60776082
async function settle(): Promise<void> {
60786083
for (let i = 0; i < 20; i++) {
@@ -6264,6 +6269,52 @@ suite('ClaudeAgent — agent SDK setup channel', () => {
62646269
migratable: [],
62656270
});
62666271
});
6272+
6273+
test('a reload re-asks the SDK for the account the user set up elsewhere, fetching nothing', async () => {
6274+
// Setup happens outside the app, so nothing fires when it finishes — a fresh
6275+
// `accountInfo()` is the only way to see it, and the SDK is already on disk.
6276+
const ctx = createTestContext(disposables);
6277+
await settle();
6278+
const before = ctx.sdk.accountInfoCallCount;
6279+
ctx.sdk.accountInfoResult = NATIVE_ACCOUNT;
6280+
ctx.sdk.supportedModelsResult = [
6281+
{ value: 'claude-sonnet-4-5-20250929', displayName: 'Claude Sonnet 4.5', description: '', supportedEffortLevels: ['high'] },
6282+
];
6283+
6284+
dispatchReload(ctx);
6285+
await settle();
6286+
6287+
assert.deepStrictEqual({
6288+
asked: ctx.sdk.accountInfoCallCount > before,
6289+
fetches: ctx.sdk.ensureAvailableCalls,
6290+
models: ctx.agent.models.get().map(model => model.name),
6291+
// Consumed like the download key, so pressing the link twice is two reloads.
6292+
key: ctx.configService.getRootConfigValues()[AGENT_SDK_SETUP_RELOAD_REQUEST_KEY],
6293+
}, {
6294+
asked: true,
6295+
fetches: 0,
6296+
models: ['Claude Sonnet 4.5'],
6297+
key: undefined,
6298+
});
6299+
});
6300+
6301+
test('a reload addressed to another agent is ignored', async () => {
6302+
const ctx = createTestContext(disposables);
6303+
await settle();
6304+
const before = ctx.sdk.accountInfoCallCount;
6305+
6306+
dispatchReload(ctx, 'codex');
6307+
await settle();
6308+
6309+
assert.deepStrictEqual({
6310+
asked: ctx.sdk.accountInfoCallCount > before,
6311+
// Left in place for the agent it names, rather than consumed by this one.
6312+
key: ctx.configService.getRootConfigValues()[AGENT_SDK_SETUP_RELOAD_REQUEST_KEY],
6313+
}, {
6314+
asked: false,
6315+
key: { agent: 'codex', request: 'req-1' },
6316+
});
6317+
});
62676318
});
62686319

62696320
suite('ClaudeAgent — per-session provider', () => {

‎src/vs/platform/agentHost/test/node/codex/codexModelRefresh.test.ts‎

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ import { IAgentHostSessionTitleSignal } from '../../../node/agentHostSessionTitl
2121
import { IAgentSdkDownloader } from '../../../node/agentSdkDownloader.js';
2222
import { RecordingAgentSdkDownloader } from '../testAgentSdkDownloader.js';
2323
import { IAgentHostCheckpointService, NULL_CHECKPOINT_SERVICE } from '../../../common/agentHostCheckpointService.js';
24-
import { AGENT_SDK_SETUP_DOWNLOAD_REQUEST_KEY, readAgentSdkSetupInfos } from '../../../common/agentSdkSetup.js';
24+
import { AGENT_SDK_SETUP_DOWNLOAD_REQUEST_KEY, AGENT_SDK_SETUP_RELOAD_REQUEST_KEY, readAgentSdkSetupInfos } from '../../../common/agentSdkSetup.js';
2525
import { CodexAgent, toCodexModelSelectionId } from '../../../node/codex/codexAgent.js';
2626
import { ICodexProxyService } from '../../../node/codex/codexProxyService.js';
2727
import { ICopilotApiService } from '../../../node/shared/copilotApiService.js';
@@ -681,6 +681,11 @@ suite('CodexAgent — agent SDK setup channel', () => {
681681
ctx.configurationService.updateRootConfig({ [AGENT_SDK_SETUP_DOWNLOAD_REQUEST_KEY]: { agent, request } });
682682
}
683683

684+
/** Addresses a reload request the same way, as the banner's link does. */
685+
function dispatchReload(ctx: ITestAgentContext, agent = 'codex', request = 'req-1'): void {
686+
ctx.configurationService.updateRootConfig({ [AGENT_SDK_SETUP_RELOAD_REQUEST_KEY]: { agent, request } });
687+
}
688+
684689
/** Waits for the ctor's queued publish (and any refresh it chains) to settle. */
685690
async function settle(): Promise<void> {
686691
for (let i = 0; i < 20; i++) {
@@ -840,4 +845,22 @@ suite('CodexAgent — agent SDK setup channel', () => {
840845
held: 0,
841846
});
842847
});
848+
849+
test('a reload is claimed here too, since the request handling is the shared channel and not per-agent code', async () => {
850+
const ctx = createAgentContext(disposables, async () => []);
851+
ctx.agent['_ensureConnection'] = async () => { throw new Error('offline'); };
852+
await settle();
853+
854+
dispatchReload(ctx);
855+
await settle();
856+
857+
assert.deepStrictEqual({
858+
key: ctx.configurationService.getRootConfigValues()[AGENT_SDK_SETUP_RELOAD_REQUEST_KEY],
859+
// Reload only re-reads what is already there; nothing is ever fetched.
860+
interests: ctx.sdkDownloader.progressInterests,
861+
}, {
862+
key: undefined,
863+
interests: [],
864+
});
865+
});
843866
});

‎src/vs/workbench/contrib/chat/browser/agentSessions/agentHost/agentHostSdkSetupNotification.ts‎

Lines changed: 30 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55

66
import { Disposable, DisposableStore } from '../../../../../../base/common/lifecycle.js';
77
import { Event } from '../../../../../../base/common/event.js';
8+
import { IMarkdownString, MarkdownString } from '../../../../../../base/common/htmlContent.js';
89
import { localize } from '../../../../../../nls.js';
910
import { AgentHostAllowSignedOutWhenUsableSettingId, IAgentHostService } from '../../../../../../platform/agentHost/common/agentService.js';
1011
import { LOCAL_AGENT_HOST_SCHEME_PREFIX } from '../../../../../../platform/agentHost/common/agentHostConnectionsService.js';
@@ -84,25 +85,45 @@ export function getAgentSdkSetupStateToReport(previous: AgentSdkSetupState | und
8485

8586
// #region Banner
8687

88+
/**
89+
* A `command:` href carrying the agent id, so a link in the copy takes the same
90+
* route a button would — funnel step and URL validation included.
91+
*/
92+
function setupCommandLink(commandId: string, agent: string): string {
93+
return `command:${commandId}?${encodeURIComponent(JSON.stringify(agent))}`;
94+
}
95+
96+
/** Trusted for the commands its links address, and nothing else. */
97+
function setupMarkdown(value: string): MarkdownString {
98+
return new MarkdownString(value, { isTrusted: { enabledCommands: [AGENT_SDK_SETUP_OPEN_DOCS_COMMAND_ID, AGENT_SDK_SETUP_RELOAD_COMMAND_ID] } });
99+
}
100+
87101
/**
88102
* The "no account" second line: one whole sentence per combination of routes,
89103
* never assembled from localized fragments, because clause order is not stable
90104
* across languages. The GitHub clause is unconditional — every agent behind this
91105
* banner reaches models through our Copilot proxy once signed in, which is
92106
* workbench knowledge rather than something an agent could declare.
107+
*
108+
* Reload leads every variant: setup finished in a terminal has no completion
109+
* signal, so the user who has already done it should not read the routes at all.
110+
* Docs are a link inside the sentence that already explains them rather than a
111+
* third button competing with the two routes that actually sign you in.
93112
*/
94-
function noAccountDescription(setup: IAgentSdkSetupInfo, displayName: string): string {
113+
function noAccountDescription(setup: IAgentSdkSetupInfo, displayName: string): IMarkdownString {
95114
const provider = setup.signInProviderName;
96-
if (provider && setup.setupDocsUrl) {
97-
return localize('agentHost.sdkSetup.noAccountDescription.all', "Sign in to GitHub to use GitHub Copilot models, sign in to {0} to use your {0} subscription, or read the instructions for other ways to set up {1}.", provider, displayName);
115+
const reload = setupCommandLink(AGENT_SDK_SETUP_RELOAD_COMMAND_ID, setup.agent);
116+
const docs = setup.setupDocsUrl ? setupCommandLink(AGENT_SDK_SETUP_OPEN_DOCS_COMMAND_ID, setup.agent) : undefined;
117+
if (provider && docs) {
118+
return setupMarkdown(localize('agentHost.sdkSetup.noAccountDescription.all', "If you already set up {0} elsewhere, [reload {0} configuration]({1}). Sign in to GitHub to use GitHub Copilot models, sign in to {2} to use your {2} subscription, or [learn more]({3}) for other ways to set up {0}.", displayName, reload, provider, docs));
98119
}
99120
if (provider) {
100-
return localize('agentHost.sdkSetup.noAccountDescription.signIn', "Sign in to GitHub to use GitHub Copilot models, or sign in to {0} to use your {0} subscription.", provider);
121+
return setupMarkdown(localize('agentHost.sdkSetup.noAccountDescription.signIn', "If you already set up {0} elsewhere, [reload {0} configuration]({1}). Sign in to GitHub to use GitHub Copilot models, or sign in to {2} to use your {2} subscription.", displayName, reload, provider));
101122
}
102-
if (setup.setupDocsUrl) {
103-
return localize('agentHost.sdkSetup.noAccountDescription.docs', "Sign in to GitHub to use GitHub Copilot models, or read the instructions for other ways to set up {0}.", displayName);
123+
if (docs) {
124+
return setupMarkdown(localize('agentHost.sdkSetup.noAccountDescription.docs', "If you already set up {0} elsewhere, [reload {0} configuration]({1}). Sign in to GitHub to use GitHub Copilot models, or [learn more]({2}) for other ways to set up {0}.", displayName, reload, docs));
104125
}
105-
return localize('agentHost.sdkSetup.noAccountDescription', "Sign in to GitHub to use GitHub Copilot models.");
126+
return setupMarkdown(localize('agentHost.sdkSetup.noAccountDescription', "If you already set up {0} elsewhere, [reload {0} configuration]({1}). Sign in to GitHub to use GitHub Copilot models.", displayName, reload));
106127
}
107128

108129
/**
@@ -197,9 +218,6 @@ export function createAgentSdkSetupNotification(setup: IAgentSdkSetupInfo, displ
197218
};
198219
}
199220
const actions: IChatInputNotificationAction[] = [];
200-
if (setup.setupDocsUrl) {
201-
actions.push(action(localize('agentHost.sdkSetup.docsAction', "Setup Instructions"), AGENT_SDK_SETUP_OPEN_DOCS_COMMAND_ID));
202-
}
203221
if (setup.signInProviderName) {
204222
actions.push(action(localize('agentHost.sdkSetup.signInAction', "Sign in to {0}", setup.signInProviderName), AGENT_SDK_SETUP_SIGN_IN_COMMAND_ID));
205223
}
@@ -220,6 +238,7 @@ export function createAgentSdkSetupNotification(setup: IAgentSdkSetupInfo, displ
220238

221239
export const AGENT_SDK_SETUP_DOWNLOAD_COMMAND_ID = 'workbench.action.chat.agentHost.downloadAgentSdk';
222240
export const AGENT_SDK_SETUP_OPEN_DOCS_COMMAND_ID = 'workbench.action.chat.agentHost.openAgentSetupDocs';
241+
export const AGENT_SDK_SETUP_RELOAD_COMMAND_ID = 'workbench.action.chat.agentHost.reloadAgentConfiguration';
223242
export const AGENT_SDK_SETUP_GITHUB_SIGN_IN_COMMAND_ID = 'workbench.action.chat.agentHost.signInToGitHubForAgent';
224243
export const AGENT_SDK_SETUP_SIGN_IN_COMMAND_ID = 'workbench.action.chat.agentHost.signInToAgent';
225244

@@ -239,6 +258,7 @@ function registerAgentSdkSetupCommand(id: string, run: (setupService: IAgentSdkS
239258

240259
registerAgentSdkSetupCommand(AGENT_SDK_SETUP_DOWNLOAD_COMMAND_ID, (setupService, agent) => setupService.requestDownload(agent));
241260
registerAgentSdkSetupCommand(AGENT_SDK_SETUP_OPEN_DOCS_COMMAND_ID, (setupService, agent) => setupService.openSetupDocs(agent));
261+
registerAgentSdkSetupCommand(AGENT_SDK_SETUP_RELOAD_COMMAND_ID, (setupService, agent) => setupService.requestReload(agent));
242262
registerAgentSdkSetupCommand(AGENT_SDK_SETUP_GITHUB_SIGN_IN_COMMAND_ID, (setupService, agent) => setupService.signInToGitHub(agent));
243263
registerAgentSdkSetupCommand(AGENT_SDK_SETUP_SIGN_IN_COMMAND_ID, (setupService, agent) => setupService.signIn(agent));
244264

0 commit comments

Comments
 (0)