WebSocket request/response headers

Author: chrmarti

chat-lib/package-lock.json

@@ -16,7 +16,7 @@
 	"dependencies": {
 		"@microsoft/tiktokenizer": "^1.0.10",
 		"@sinclair/typebox": "^0.34.41",
-		"@vscode/copilot-api": "^0.2.12",
+		"@vscode/copilot-api": "0.2.12-websocket.1",
 		"@vscode/l10n": "^0.0.18",
 		"@vscode/prompt-tsx": "^0.4.0-alpha.6",
 		"@vscode/tree-sitter-wasm": "0.0.5-php.2",

chat-lib/package.json

@@ -5939,7 +5939,7 @@
 		"@microsoft/tiktokenizer": "^1.0.10",
 		"@modelcontextprotocol/sdk": "^1.25.2",
 		"@sinclair/typebox": "^0.34.41",
-		"@vscode/copilot-api": "^0.2.12",
+		"@vscode/copilot-api": "0.2.12-websocket.1",
 		"@vscode/extension-telemetry": "^1.5.0",
 		"@vscode/l10n": "^0.0.18",
 		"@vscode/prompt-tsx": "^0.4.0-alpha.6",

package-lock.json

@@ -5,7 +5,7 @@
 
 import * as fs from 'fs/promises';
 import path from 'path';
-import { FetchOptions, IAbortController, IFetcherService, PaginationOptions, Response } from '../../../../platform/networking/common/fetcherService';
+import { FetchOptions, IAbortController, IFetcherService, PaginationOptions, Response, WebSocketConnection } from '../../../../platform/networking/common/fetcherService';
 import { CancellationToken } from '../../../../util/vs/base/common/cancellation';
 import { Event } from '../../../../util/vs/base/common/event';
 import { ICommandExecutor } from '../../vscode-node/util';
@@ -104,6 +104,7 @@ export class FixtureFetcherService implements IFetcherService {
 	_serviceBrand: undefined;
 	readonly onDidFetch = Event.None;
 	getUserAgentLibrary(): string { throw new Error('Method not implemented.'); }
+	createWebSocket(_url: string): WebSocketConnection { throw new Error('Method not implemented.'); }
 	disconnectAll(): Promise<unknown> { throw new Error('Method not implemented.'); }
 	makeAbortController(): IAbortController { throw new Error('Method not implemented.'); }
 	isAbortError(e: any): boolean { throw new Error('Method not implemented.'); }

package.json

@@ -764,7 +764,9 @@ export class ChatMLFetcherImpl extends AbstractChatMLFetcher {
 				turnId,
 				conversationId,
 				cancellationToken,
+				userInitiatedRequest,
 				telemetryProperties,
+				requestKindOptions,
 			);
 		}
 
@@ -801,9 +803,33 @@ export class ChatMLFetcherImpl extends AbstractChatMLFetcher {
 		turnId: string,
 		conversationId: string,
 		cancellationToken: CancellationToken,
+		userInitiatedRequest: boolean | undefined,
 		telemetryProperties: TelemetryProperties | undefined,
+		requestKindOptions: IBackgroundRequestOptions | ISubagentRequestOptions | undefined,
 	): Promise<{ result: ChatResults | ChatRequestFailed | ChatRequestCanceled }> {
-		const connection = await this._webSocketManager.getOrCreateConnection(conversationId, turnId, secretKey);
+		const intent = locationToIntent(location);
+		const agentInteractionType = requestKindOptions?.kind === 'subagent' ?
+			'conversation-subagent' :
+			requestKindOptions?.kind === 'background' ?
+				'conversation-background' :
+				intent === 'conversation-agent' ? intent : undefined;
+		const additionalHeaders: Record<string, string> = {
+			'Authorization': `Bearer ${secretKey}`,
+			'X-Request-Id': ourRequestId,
+			'OpenAI-Intent': intent,
+			'X-GitHub-Api-Version': '2025-05-01',
+			'X-Interaction-Id': this._interactionService.interactionId,
+			'X-Initiator': userInitiatedRequest ? 'user' : 'agent',
+			...(chatEndpointInfo.getExtraHeaders ? chatEndpointInfo.getExtraHeaders(location) : {}),
+		};
+		if (agentInteractionType) {
+			additionalHeaders['X-Interaction-Type'] = agentInteractionType;
+			additionalHeaders['X-Agent-Task-Id'] = ourRequestId;
+		}
+		if (request.messages?.some((m: CAPIChatMessage) => Array.isArray(m.content) ? m.content.some(c => 'image_url' in c) : false) && chatEndpointInfo.supportsVision) {
+			additionalHeaders['Copilot-Vision-Request'] = 'true';
+		}
+		const connection = await this._webSocketManager.getOrCreateConnection(conversationId, turnId, additionalHeaders);
 
 		// Generate unique ID to link input and output messages
 		const modelCallId = generateUuid();
@@ -818,6 +844,9 @@ export class ChatMLFetcherImpl extends AbstractChatMLFetcher {
 			maxTokenWindow: chatEndpointInfo.modelMaxPromptTokens
 		});
 
+		const modelRequestId = getRequestId(connection.responseHeaders);
+		telemetryData.extendWithRequestId(modelRequestId);
+
 		for (const [key, value] of Object.entries(request)) {
 			if (key === 'messages' || key === 'input') {
 				continue;
@@ -832,7 +861,7 @@ export class ChatMLFetcherImpl extends AbstractChatMLFetcher {
 		const handle = connection.sendRequest(request as Record<string, unknown>, cancellationToken);
 
 		const extendedBaseTelemetryData = baseTelemetryData.extendedBy({ modelCallId });
-		const processor = this._instantiationService.createInstance(OpenAIResponsesProcessor, extendedBaseTelemetryData, ourRequestId, '');
+		const processor = this._instantiationService.createInstance(OpenAIResponsesProcessor, extendedBaseTelemetryData, modelRequestId.headerRequestId, modelRequestId.gitHubRequestId);
 
 		const chatCompletions = new AsyncIterableObject<ChatCompletion>(async emitter => {
 			try {
@@ -846,6 +875,7 @@ export class ChatMLFetcherImpl extends AbstractChatMLFetcher {
 					});
 
 					handle.onError(error => {
+						(error as any).gitHubRequestId = modelRequestId.gitHubRequestId;
 						if (isCancellationError(error)) {
 							reject(error);
 							return;

src/extension/mcp/test/vscode-node/util.ts

@@ -96,7 +96,7 @@ import { TestLanguageDiagnosticsService } from '../../platform/languages/common/
 import { ConsoleLog, ILogService, LogLevel as InternalLogLevel, LogServiceImpl } from '../../platform/log/common/logService';
 import { ICompletionsFetchService } from '../../platform/nesFetch/common/completionsFetchService';
 import { CompletionsFetchService } from '../../platform/nesFetch/node/completionsFetchServiceImpl';
-import { FetchOptions, IAbortController, IFetcherService, PaginationOptions } from '../../platform/networking/common/fetcherService';
+import { FetchOptions, HeadersImpl, IAbortController, IFetcherService, PaginationOptions, WebSocketConnection, WebSocketConnectOptions } from '../../platform/networking/common/fetcherService';
 import { IFetcher } from '../../platform/networking/common/networking';
 import { IChatWebSocketManager, NullChatWebSocketManager } from '../../platform/networking/node/chatWebSocketManager';
 import { IProxyModelsService } from '../../platform/proxyModels/common/proxyModelsService';
@@ -479,6 +479,9 @@ class SingleFetcherService implements IFetcherService {
 	fetch(url: string, options: FetchOptions) {
 		return this._fetcher.fetch(url, options);
 	}
+	createWebSocket(url: string, options?: WebSocketConnectOptions): WebSocketConnection {
+		return { webSocket: new WebSocket(url, options), responseHeaders: new HeadersImpl({}) };
+	}
 	disconnectAll(): Promise<unknown> {
 		return this._fetcher.disconnectAll();
 	}

src/extension/prompt/node/chatMLFetcher.ts

@@ -13,7 +13,7 @@ import { IDomainService } from '../../../endpoint/common/domainService';
 import { IEnvService } from '../../../env/common/envService';
 import { NullBaseOctoKitService } from '../../../github/common/nullOctokitServiceImpl';
 import { ILogService } from '../../../log/common/logService';
-import { FetchOptions, IAbortController, IFetcherService, PaginationOptions, Response } from '../../../networking/common/fetcherService';
+import { FetchOptions, IAbortController, IFetcherService, PaginationOptions, Response, WebSocketConnection } from '../../../networking/common/fetcherService';
 import { ITelemetryService } from '../../../telemetry/common/telemetry';
 import { createFakeResponse } from '../../../test/node/fetcher';
 import { createPlatformServices, ITestingServicesAccessor } from '../../../test/node/services';
@@ -642,6 +642,9 @@ class StaticFetcherService implements IFetcherService {
 		}
 		return createFakeResponse(404, '');
 	}
+	createWebSocket(_url: string): WebSocketConnection {
+		throw new Error('Method not implemented.');
+	}
 	disconnectAll(): Promise<unknown> {
 		throw new Error('Method not implemented.');
 	}

src/lib/node/chatLibMain.ts

@@ -5,16 +5,16 @@
 
 import { beforeEach, describe, expect, it, vi } from 'vitest';
 import { Event } from '../../../../util/vs/base/common/event';
+import { IAuthenticationService } from '../../../authentication/common/authentication';
 import { ConfigKey, IConfigurationService } from '../../../configuration/common/configurationService';
 import { DefaultsOnlyConfigurationService } from '../../../configuration/common/defaultsOnlyConfigurationService';
 import { InMemoryConfigurationService } from '../../../configuration/test/common/inMemoryConfigurationService';
 import { ILogService } from '../../../log/common/logService';
-import { IAbortController, IFetcherService, PaginationOptions } from '../../../networking/common/fetcherService';
+import { IAbortController, IFetcherService, PaginationOptions, WebSocketConnection } from '../../../networking/common/fetcherService';
 import { IExperimentationService, NullExperimentationService } from '../../../telemetry/common/nullExperimentationService';
 import { NullTelemetryService } from '../../../telemetry/common/nullTelemetryService';
 import { ITelemetryService } from '../../../telemetry/common/telemetry';
 import { createFakeResponse } from '../../../test/node/fetcher';
-import { IAuthenticationService } from '../../../authentication/common/authentication';
 import { RouterDecisionFetcher } from '../routerDecisionFetcher';
 
 const createValidRouterResponse = (chosenModel = 'gpt-4o') => ({
@@ -45,6 +45,9 @@ describe('RouterDecisionFetcher', () => {
 			_serviceBrand: undefined,
 			onDidFetch: Event.None,
 			fetch: mockFetch,
+			createWebSocket(_url: string): WebSocketConnection {
+				throw new Error('Method not implemented.');
+			},
 			fetchWithPagination<T>(_baseUrl: string, _options: PaginationOptions<T>): Promise<T[]> {
 				throw new Error('Method not implemented.');
 			},

src/platform/authentication/test/node/copilotToken.spec.ts

@@ -13,6 +13,7 @@ export interface IFetcherService {
 	readonly onDidFetch: Event<FetchEvent>;
 	getUserAgentLibrary(): string;
 	fetch(url: string, options: FetchOptions): Promise<Response>;
+	createWebSocket(url: string, options?: WebSocketConnectOptions): WebSocketConnection;
 	disconnectAll(): Promise<unknown>;
 	makeAbortController(): IAbortController;
 	isAbortError(e: any): boolean;
@@ -163,6 +164,15 @@ export interface PaginationOptions<T> extends FetchOptions {
 	buildUrl: (baseUrl: string, pageSize: number, page: number) => string;
 }
 
+export interface WebSocketConnectOptions {
+	headers?: { [name: string]: string };
+}
+
+export interface WebSocketConnection {
+	readonly webSocket: WebSocket;
+	readonly responseHeaders: IHeaders;
+}
+
 export interface IAbortSignal {
 	readonly aborted: boolean;
 	addEventListener(type: 'abort', listener: (this: AbortSignal) => void): void;
@@ -178,6 +188,33 @@ export interface IHeaders extends Iterable<[string, string]> {
 	get(name: string): string | null;
 }
 
+export class HeadersImpl implements IHeaders {
+	constructor(private readonly _record: Readonly<Record<string, string | string[] | undefined>>) { }
+
+	static fromMap(map: ReadonlyMap<string, string>): HeadersImpl {
+		return new HeadersImpl(Object.fromEntries(map));
+	}
+
+	get(name: string): string | null {
+		const result = this._record[name];
+		return Array.isArray(result) ? result[0] : result ?? null;
+	}
+
+	[Symbol.iterator](): Iterator<[string, string]> {
+		const keys = Object.keys(this._record);
+		let index = 0;
+		return {
+			next: (): IteratorResult<[string, string]> => {
+				if (index >= keys.length) {
+					return { done: true, value: undefined };
+				}
+				const key = keys[index++];
+				return { done: false, value: [key, this.get(key)!] };
+			}
+		};
+	}
+}
+
 /**
  * Wraps a ReadableStream to allow cancellation even while a `for await` loop
  * holds the stream locked. Use `destroy()` to safely cancel from an external