Skip to content

Commit d601847

Browse files
authored
fix: send the product User-Agent on provider registry and catalog fetches (#1597)
* fix: send the product User-Agent on provider registry and catalog fetches Registry (api.json) and models.dev catalog fetches only carried the runtime default User-Agent while every other outbound request sends kimi-code-cli/<version>. Thread an optional userAgent through fetchCustomRegistry / fetchCatalog and the shared refresh host, pass the product UA from the CLI, TUI, and both daemons, and seed a default product UA in kap-server that hosts can override via opts.seeds. * refactor: use options for registry fetches
1 parent 5502b90 commit d601847

20 files changed

Lines changed: 274 additions & 25 deletions

File tree

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"@moonshot-ai/kimi-code": patch
3+
---
4+
5+
Send the kimi-code-cli User-Agent on provider registry (api.json) and model catalog fetches, so registries can identify the client version.

‎apps/kimi-code/src/cli/sub/provider.ts‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ import {
3535
} from '@moonshot-ai/kimi-code-sdk';
3636
import type { Command } from 'commander';
3737

38-
import { createKimiCodeHostIdentity } from '#/cli/version';
38+
import { createKimiCodeHostIdentity, createKimiCodeUserAgent } from '#/cli/version';
3939

4040
interface WritableLike {
4141
write(chunk: string): boolean;
@@ -99,7 +99,7 @@ export async function handleProviderAdd(
9999

100100
let entries: Awaited<ReturnType<typeof fetchCustomRegistry>>;
101101
try {
102-
entries = await fetchCustomRegistry(source);
102+
entries = await fetchCustomRegistry(source, { userAgent: createKimiCodeUserAgent() });
103103
} catch (error) {
104104
const suffix = error instanceof CustomRegistryApiError ? ` (HTTP ${String(error.status)})` : '';
105105
deps.stderr.write(`Failed to fetch registry${suffix}: ${errorMessage(error)}\n`);
@@ -398,7 +398,7 @@ export async function handleCatalogAdd(
398398

399399
async function loadCatalogOrExit(deps: ProviderDeps, url: string): Promise<Catalog> {
400400
try {
401-
return await fetchCatalog(url);
401+
return await fetchCatalog(url, { userAgent: createKimiCodeUserAgent() });
402402
} catch (error) {
403403
const suffix = error instanceof CatalogFetchError ? ` (HTTP ${String(error.status)})` : '';
404404
deps.stderr.write(`Failed to fetch catalog from ${url}${suffix}: ${errorMessage(error)}\n`);

‎apps/kimi-code/src/cli/version.ts‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
import { existsSync, readFileSync } from 'node:fs';
88
import { dirname, resolve } from 'node:path';
99

10-
import { createKimiDefaultHeaders, type KimiHostIdentity } from '@moonshot-ai/kimi-code-oauth';
10+
import { createKimiDefaultHeaders, createKimiUserAgent, type KimiHostIdentity } from '@moonshot-ai/kimi-code-oauth';
1111

1212
import { CLI_USER_AGENT_PRODUCT } from '#/constant/app';
1313

@@ -55,6 +55,14 @@ export function createKimiCodeHostIdentity(version = getVersion()): KimiHostIden
5555
};
5656
}
5757

58+
/**
59+
* Product User-Agent (`kimi-code-cli/<version>`) for ad-hoc outbound fetches
60+
* that don't go through the provider pipeline (registry / catalog imports).
61+
*/
62+
export function createKimiCodeUserAgent(version = getVersion()): string {
63+
return createKimiUserAgent(createKimiCodeHostIdentity(version));
64+
}
65+
5866
export function buildKimiDefaultHeaders(version: string): Record<string, string> {
5967
return createKimiDefaultHeaders({
6068
homeDir: getDataDir(),

‎apps/kimi-code/src/tui/commands/provider.ts‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ import {
1616
type ThinkingEffort,
1717
} from '@moonshot-ai/kimi-code-sdk';
1818

19+
import { createKimiCodeUserAgent } from '#/cli/version';
1920
import { ChoicePickerComponent } from '../components/dialogs/choice-picker';
2021
import {
2122
CustomRegistryImportDialogComponent,
@@ -160,7 +161,10 @@ async function handleCatalogProviderAdd(host: SlashCommandHost): Promise<void> {
160161
const spinner = host.showLoginProgressSpinner(`Fetching catalog from ${DEFAULT_CATALOG_URL}`);
161162
let catalog: Catalog | undefined;
162163
try {
163-
catalog = await fetchCatalog(DEFAULT_CATALOG_URL, controller.signal);
164+
catalog = await fetchCatalog(DEFAULT_CATALOG_URL, {
165+
signal: controller.signal,
166+
userAgent: createKimiCodeUserAgent(),
167+
});
164168
spinner.stop({ ok: true, label: 'Catalog loaded.' });
165169
} catch (error) {
166170
if (controller.signal.aborted) {
@@ -276,7 +280,7 @@ async function handleCustomRegistryAddViaDialog(host: SlashCommandHost): Promise
276280

277281
let entries: Awaited<ReturnType<typeof fetchCustomRegistry>>;
278282
try {
279-
entries = await fetchCustomRegistry(source);
283+
entries = await fetchCustomRegistry(source, { userAgent: createKimiCodeUserAgent() });
280284
} catch (error) {
281285
host.showError(`Failed to import registry: ${formatErrorMessage(error)}`);
282286
return false;

‎apps/kimi-code/src/tui/controllers/auth-flow.ts‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
11
import type { CreateSessionOptions, KimiHarness, Session } from '@moonshot-ai/kimi-code-sdk';
2+
3+
import { createKimiCodeUserAgent } from '#/cli/version';
4+
25
import type { SkillListSession } from '../commands';
36

47
import { OAUTH_LOGIN_REQUIRED_STARTUP_NOTICE } from '../constant/kimi-tui';
@@ -173,6 +176,7 @@ export class AuthFlowController {
173176
const tokenProvider = host.harness.auth.resolveOAuthTokenProvider(providerName, oauthRef);
174177
return tokenProvider.getAccessToken();
175178
},
179+
userAgent: createKimiCodeUserAgent(),
176180
},
177181
{ scope },
178182
);

‎apps/kimi-code/src/tui/utils/refresh-providers.ts‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@ export interface RefreshProviderHost {
1717
removeProvider(providerId: string): Promise<KimiConfig>;
1818
setConfig(patch: KimiConfigPatch): Promise<KimiConfig>;
1919
resolveOAuthToken(providerName: string, oauthRef?: OAuthRef): Promise<string>;
20+
/** Product User-Agent sent on custom-registry (api.json) fetches. */
21+
readonly userAgent?: string;
2022
}
2123

2224
export type { ProviderChange, RefreshProviderOptions, RefreshProviderScope, RefreshResult };
@@ -37,6 +39,7 @@ export async function refreshAllProviderModels(
3739
setConfig: (patch) => host.setConfig(patch as unknown as KimiConfigPatch),
3840
resolveOAuthToken: (providerName, oauthRef) =>
3941
host.resolveOAuthToken(providerName, oauthRef as unknown as OAuthRef),
42+
userAgent: host.userAgent,
4043
},
4144
options,
4245
);

‎apps/kimi-code/test/cli/version.test.ts‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ import { describe, expect, it } from 'vitest';
55

66
import {
77
buildKimiDefaultHeaders,
8+
createKimiCodeUserAgent,
89
getHostPackageJsonPath,
910
getHostPackageRoot,
1011
getVersion,
@@ -25,4 +26,8 @@ describe('cli version helpers', () => {
2526

2627
expect(headers['User-Agent']).toBe('kimi-code-cli/1.2.3');
2728
});
29+
30+
it('builds the product user-agent for ad-hoc fetches', () => {
31+
expect(createKimiCodeUserAgent('1.2.3')).toBe('kimi-code-cli/1.2.3');
32+
});
2833
});

‎packages/agent-core-v2/src/app/modelCatalog/modelCatalogService.ts‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ import { IConfigService } from '#/app/config/config';
3232
import { ErrorCodes, Error2 } from '#/errors';
3333
import { IEventService } from '#/app/event/event';
3434
import { IModelService, MODELS_SECTION, type ModelAlias } from '#/app/model/model';
35+
import { IHostRequestHeaders } from '#/app/model/hostRequestHeaders';
3536
import {
3637
IProviderService,
3738
type OAuthRef,
@@ -66,6 +67,7 @@ export class ModelCatalogService implements IModelCatalogService {
6667
@IConfigService private readonly config: IConfigService,
6768
@IOAuthService private readonly oauth: IOAuthService,
6869
@IEventService private readonly events: IEventService,
70+
@IHostRequestHeaders private readonly hostRequestHeaders: IHostRequestHeaders,
6971
) {}
7072

7173
async listModels(): Promise<readonly ModelCatalogItem[]> {
@@ -151,6 +153,9 @@ export class ModelCatalogService implements IModelCatalogService {
151153
removeProvider: (providerId) => this.removeProviderForRefresh(providerId),
152154
setConfig: (patch) => this.applyRefreshPatch(patch),
153155
resolveOAuthToken: (providerName, oauthRef) => this.resolveOAuthToken(providerName, oauthRef),
156+
// Mirrors ModelResolverService: only the User-Agent leaves the host, so
157+
// device identity never reaches third-party registry endpoints.
158+
userAgent: this.hostRequestHeaders.headers['User-Agent'],
154159
};
155160
}
156161

‎packages/agent-core-v2/test/app/modelCatalog/modelCatalog.test.ts‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ import { MODEL_CATALOG_SECTION } from '#/app/modelCatalog/configSection';
2222
import { IModelCatalogService } from '#/app/modelCatalog/modelCatalog';
2323
import { ModelCatalogService } from '#/app/modelCatalog/modelCatalogService';
2424
import { IModelService, type ModelAlias } from '#/app/model/model';
25+
import { HostRequestHeaders, IHostRequestHeaders } from '#/app/model/hostRequestHeaders';
2526
import { ModelService } from '#/app/model/modelService';
2627
import { IProviderService, type ProviderConfig } from '#/app/provider/provider';
2728
import { ProviderService } from '#/app/provider/providerService';
@@ -118,6 +119,10 @@ describe('ModelCatalogService', () => {
118119
reg.define(IModelService, ModelService);
119120
reg.define(IProviderService, ProviderService);
120121
reg.define(IModelCatalogService, ModelCatalogService);
122+
reg.defineInstance(
123+
IHostRequestHeaders,
124+
new HostRequestHeaders({ 'User-Agent': 'kimi-code-cli/test' }),
125+
);
121126
},
122127
});
123128
});
@@ -314,4 +319,43 @@ describe('ModelCatalogService', () => {
314319
expect(maxInFlight).toBe(1);
315320
expect(fetchMock).toHaveBeenCalledTimes(2);
316321
});
322+
323+
it('refreshProviderModels sends the host User-Agent on custom-registry fetches', async () => {
324+
backing.providers = {
325+
acme: {
326+
type: 'openai',
327+
apiKey: 'sk-acme',
328+
source: {
329+
kind: 'apiJson',
330+
url: 'https://registry.example.test/api.json',
331+
apiKey: 'sk-registry',
332+
},
333+
},
334+
};
335+
const fetchMock = vi.fn(
336+
async () =>
337+
new Response(
338+
JSON.stringify({
339+
acme: {
340+
id: 'acme',
341+
name: 'Acme',
342+
api: 'https://acme.example.test/v1',
343+
type: 'openai',
344+
models: { m1: { id: 'm1', name: 'M1' } },
345+
},
346+
}),
347+
{ headers: { 'Content-Type': 'application/json' } },
348+
),
349+
);
350+
vi.stubGlobal('fetch', fetchMock);
351+
352+
await catalog().refreshProviderModels({ scope: 'all' });
353+
354+
expect(fetchMock).toHaveBeenCalledWith(
355+
'https://registry.example.test/api.json',
356+
expect.objectContaining({
357+
headers: expect.objectContaining({ 'User-Agent': 'kimi-code-cli/test' }),
358+
}),
359+
);
360+
});
317361
});

‎packages/agent-core/src/services/modelCatalog/modelCatalogService.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -150,6 +150,7 @@ export class ModelCatalogService
150150
setConfig: (patch) => this.core.rpc.setKimiConfig(patch as Record<string, unknown>),
151151
resolveOAuthToken: (providerName, oauthRef) =>
152152
this._resolveOAuthToken(providerName, oauthRef),
153+
userAgent: this.core.kimiRequestHeaders?.['User-Agent'],
153154
};
154155
}
155156

0 commit comments

Comments
 (0)