1
>
/*---------------------------------------------------------------------------------------------
copilotApiService.ts
2
>
* Copyright (c) Microsoft Corporation. All rights reserved.
3
>
* Licensed under the MIT License. See License.txt in the project root for license information.
4
>
*--------------------------------------------------------------------------------------------*/
5
>
6
>
import type Anthropic from '@anthropic-ai/sdk';
7
>
import { CAPIClient, RequestType, type CCAModel, type IExtensionInformation } from '@vscode/copilot-api';
8
>
import { generateUuid } from '../../../../base/common/uuid.js';
9
>
import { getDevDeviceId, getMachineId } from '../../../../base/node/id.js';
10
>
import { createDecorator } from '../../../instantiation/common/instantiation.js';
11
>
import { IAgentHostGitHubEndpointService } from '../agentHostGitHubEndpointService.js';
12
>
import { ILogService } from '../../../log/common/log.js';
13
>
import { IProductService } from '../../../product/common/productService.js';
14
>
import { COPILOT_LICENSE_AGREEMENT } from '../../../endpoint/common/licenseAgreement.js';
15
>
import { parseCopilotTokenFields } from '../copilot/copilotTokenFields.js';
16
>
17
>
// #region Types
18
>
19
>
/**
20
>
* Per-call transport options for all {@link ICopilotApiService} methods.
21
>
*
22
>
* `headers` are merged into the outgoing CAPI request before security-
23
>
* sensitive headers (`Authorization`, `Content-Type`, `X-Request-Id`,
24
>
* `OpenAI-Intent`), so callers cannot override those.
25
>
*
26
>
* `signal` propagates to the outgoing API request but **not** to the
27
>
* shared token mint. The mint is deduped across concurrent callers, so
28
>
* a single caller's abort must not cancel it for everyone.
29
>
*/
30
>
export interface ICopilotApiServiceRequestOptions {
31
>
readonly headers?: Readonly<Record<string, string>>;
32
>
readonly signal?: AbortSignal;
33
>
34
>
/**
35
>
* Suppress the `Copilot-Integration-Id` header on this request.
36
>
*
37
>
* When unset, `@vscode/copilot-api` derives the integration id from the
38
>
* discovered Copilot SKU: a `no_auth_limited_copilot` SKU maps to
39
>
* `vscode-nl`, which the CAPI backend treats as the limited/no-auth
40
>
* integration and refuses premium models such as `claude-opus-4.7`.
41
>
* Setting this to `true` omits the header so CAPI authorizes against the
42
>
* token's real entitlement. Mirrors the Copilot Chat extension's
43
>
* `ClaudeStreamingPassThroughEndpoint.getEndpointFetchOptions()`.
44
>
*/
45
>
readonly suppressIntegrationId?: boolean;
46
>
}
47
>
48
>
/**
49
>
* One chat message in a {@link ICopilotUtilityChatCompletionRequest}.
50
>
* Mirrors the OpenAI Chat Completions message shape CAPI accepts.
51
>
*/
52
>
export interface ICopilotUtilityChatMessage {
53
>
readonly role: 'system' | 'user' | 'assistant';
54
>
readonly content: string;
55
>
}
56
>
57
>
/**
58
>
* Inputs for {@link ICopilotApiService.utilityChatCompletion}.
59
>
*
60
>
* Callers own prompt construction — typically a `'system'` rules message
61
>
* followed by one or more `'user'` messages, matching the Copilot Chat
62
>
* extension's `copilot-utility-small` prompts (see
63
>
* `GitCommitMessagePrompt`'s `SystemMessage` + `UserMessage` pair). This
64
>
* service forwards the messages and returns the assistant text.
65
>
*
66
>
* `temperature` defaults to `0.1` (matching the Copilot Chat extension's
67
>
* default `IConversationOptions.temperature`). All other parameters
68
>
* (`top_p`, model family) are fixed defaults inside the service — callers
69
>
* should not need to tune them for utility flows. `max_tokens` is left
70
>
* unset so CAPI applies its per-model default, matching what the
71
>
* extension's `copilot-utility-small` endpoint sends today.
72
>
*/
73
>
export interface ICopilotUtilityChatCompletionRequest {
74
>
readonly messages: readonly ICopilotUtilityChatMessage[];
75
>
readonly temperature?: number;
76
>
}
77
>
78
>
/**
79
>
* Subset of the GitHub `copilot_internal/user` response we care about.
80
>
* The full payload carries entitlement info; we only need `endpoints` (for
81
>
* routing CAPI requests) and `access_type_sku` (which `CAPIClient.updateDomains`
82
>
* stamps onto requests).
83
>
*/
84
>
interface ICopilotUserResponse {
85
>
readonly login?: string;
86
>
readonly copilotignore_enabled?: boolean;
87
>
readonly endpoints?: {
88
>
readonly api?: string;
89
>
readonly telemetry?: string;
90
>
readonly proxy?: string;
91
>
readonly 'origin-tracker'?: string;
92
>
};
93
>
readonly access_type_sku?: string;
94
>
}
95
>
96
>
interface ICachedClient {
97
>
readonly capiClient: CAPIClient;
98
>
readonly expiresAt: number;
99
>
/** GitHub login returned by `/copilot_internal/user`, when present. */
100
>
readonly login?: string;
101
>
/** The CAPI `endpoints.telemetry` base URL discovered for this token, if any. */
102
>
readonly telemetryEndpoint?: string;
103
>
/** The CAPI `endpoints.api` base URL discovered (or overridden) for this token, if any. */
104
>
readonly apiEndpoint?: string;
105
>
readonly copilotIgnoreEnabled?: boolean;
106
>
}
107
>
108
>
/**
109
>
* Subset of the `RequestType.CopilotToken` mint response we care about.
110
>
*/
111
>
interface ICopilotTokenEnvelope {
112
>
readonly token?: unknown;
113
>
readonly expires_at?: unknown;
114
>
readonly refresh_in?: unknown;
115
>
readonly organization_list?: unknown;
116
>
}
117
>
118
>
/**
119
>
* Per-GitHub-token Copilot session token cache entry, plus a per-family
120
>
* resolved utility model id. The model id is bound to the same lifetime as
121
>
* the Copilot token so the entry can be evicted atomically on 401/403.
122
>
*/
123
>
interface ICachedCopilotToken {
124
>
readonly token: string;
125
>
readonly expiresAt: number;
126
>
readonly modelIdsByFamily: Map<string, string>;
127
>
readonly isInternal: boolean;
128
>
readonly isVscodeTeamMember: boolean;
129
>
}
130
>
131
>
/**
132
>
* Memoized parts of `CAPIClient` construction that don't depend on the user
133
>
* token. Built once and reused by every per-token client.
134
>
*/
135
>
interface ICapiBase {
136
>
readonly extensionInfo: IExtensionInformation;
137
>
readonly userUrl: string;
138
>
}
139
>
140
>
// #endregion
141
>
142
>
// #region Constants
143
>
144
>
/**
145
>
* Sentinel {@link CopilotApiError.status} used when the error came from a
146
>
* mid-stream SSE `event: error` frame rather than an HTTP non-2xx response.
147
>
* The upstream HTTP status was 200 (the stream had already started); the
148
>
* real HTTP status is no longer meaningful, so consumers that need an HTTP
149
>
* status code (e.g. when re-emitting before headers are sent) should not
150
>
* trust this value. Use `envelope.error.type` instead.
151
>
*/
152
>
export const COPILOT_API_ERROR_STATUS_STREAMING = 520;
153
>
154
>
/**
155
>
* Re-resolve the CAPI endpoint discovery this many seconds before the cache
156
>
* entry's notional expiry. The `/copilot_internal/user` response itself
157
>
* carries no expiry, so we apply a fixed TTL and refresh ahead of it.
158
>
*/
159
>
const CAPI_CONTEXT_REFRESH_BUFFER_SECONDS = 5 * 60;
160
>
161
>
/** Conservative TTL for the `/copilot_internal/user` discovery result. */
162
>
const CAPI_CONTEXT_TTL_SECONDS = 30 * 60;
163
>
164
>
const USER_API_VERSION = '2025-04-01';
165
>
166
>
/**
167
>
* Test/debug override for the CAPI base URL. When set to a **loopback** URL,
168
>
* {@link CopilotApiService} skips the `api.github.com/copilot_internal/user`
169
>
* endpoint-discovery round-trip (which requires a real GitHub token) and routes
170
>
* every CAPI request — `models`, `responses`, `messages` — straight at this URL
171
>
* instead. Only ever set by the smoke-test harness (see `setupAgentHostSuite`)
172
>
* so the agent host's shared CAPI client can talk to the mock LLM server; never
173
>
* set in production, so normal per-token discovery is unchanged.
174
>
*
175
>
* The override is restricted to loopback hosts, plus the reserved
176
>
* `vscode-smoke.test` host when the smoke proxy marker is present. Subsequent
177
>
* CAPI calls carry the user's GitHub bearer token, so every other non-loopback
178
>
* or unparseable value is ignored to prevent token exfiltration.
179
>
*/
180
>
const CAPI_URL_OVERRIDE_ENV = 'VSCODE_AGENT_HOST_CAPI_URL_OVERRIDE';
181
>
const CAPI_URL_OVERRIDE_SMOKE_TEST_HOST = 'vscode-smoke.test';
182
>
const CAPI_URL_OVERRIDE_SMOKE_TEST_ENV = 'VSCODE_SMOKE_TEST_PROXY_HEADER';
183
>
184
>
/** True iff `url` parses and its host is a loopback address (localhost / 127.0.0.0/8 / ::1). */
185
function isLoopbackUrl(url: string): boolean {
186
let hostname: string;