Clean up HTTP passthrough API (#1784)

SteveSandersonMS · web-flow · commit a8255cb3518c · 2026-06-24T13:07:03.000+01:00
diff --git a/dotnet/src/CopilotRequestHandler.cs b/dotnet/src/CopilotRequestHandler.cs
@@ -41,20 +41,40 @@ public enum CopilotRequestTransport
 [Experimental(Diagnostics.Experimental)]
 public sealed class CopilotRequestContext
 {
+    /// <summary>
+    /// Creates an instance of <see cref="CopilotRequestContext"/> by copying the values from another instance.
+    /// </summary>
+    /// <param name="original">A <see cref="CopilotRequestContext"/> instance to copy values from.</param>
+    public CopilotRequestContext(CopilotRequestContext original)
+        : this(original.RequestId, original.Url, original.Headers)
+    {
+        SessionId = original.SessionId;
+        Transport = original.Transport;
+        CancellationToken = original.CancellationToken;
+        WebSocketResponse = original.WebSocketResponse;
+    }
+
+    internal CopilotRequestContext(string requestId, string url, IReadOnlyDictionary<string, IReadOnlyList<string>> headers)
+    {
+        RequestId = requestId;
+        Url = url;
+        Headers = headers;
+    }
+
     /// <summary>Opaque runtime-minted id, stable across the request lifecycle.</summary>
-    public required string RequestId { get; init; }
+    public string RequestId { get; init; }
 
     /// <summary>Runtime session id that triggered the request, if any.</summary>
     public string? SessionId { get; init; }
 
     /// <summary>Transport the runtime would otherwise use.</summary>
     public CopilotRequestTransport Transport { get; init; }
 
-    /// <summary>Original request URL.</summary>
-    public required string Url { get; init; }
+    /// <summary>Request URL.</summary>
+    public string Url { get; init; }
 
-    /// <summary>Original request headers.</summary>
-    public required IReadOnlyDictionary<string, IReadOnlyList<string>> Headers { get; init; }
+    /// <summary>Request headers.</summary>
+    public IReadOnlyDictionary<string, IReadOnlyList<string>> Headers { get; init; }
 
     /// <summary>
     /// Cancelled when the runtime aborts this in-flight request. Subclasses that
@@ -199,25 +219,17 @@ public virtual async ValueTask DisposeAsync()
 [Experimental(Diagnostics.Experimental)]
 public class CopilotWebSocketForwarder : CopilotWebSocketHandler
 {
-    private readonly string _url;
-    private readonly IReadOnlyDictionary<string, IReadOnlyList<string>> _headers;
     private WebSocket? _upstream;
     private CancellationTokenSource? _pumpCts;
     private Task? _responsePump;
 
     /// <summary>
     /// Initializes a forwarding handler that will open the upstream socket on
-    /// demand using the supplied URL/headers (or the values from
-    /// <paramref name="context"/> when omitted).
+    /// demand using the supplied URL/headers from <paramref name="context"/>.
     /// </summary>
-    public CopilotWebSocketForwarder(
-        CopilotRequestContext context,
-        string? url = null,
-        IReadOnlyDictionary<string, IReadOnlyList<string>>? headers = null)
+    public CopilotWebSocketForwarder(CopilotRequestContext context)
         : base(context)
     {
-        _url = url ?? context.Url;
-        _headers = headers ?? context.Headers;
     }
 
     /// <summary>
@@ -231,7 +243,7 @@ internal override async Task OpenAsync()
         }
 
         var socket = new ClientWebSocket();
-        foreach (var (name, values) in _headers)
+        foreach (var (name, values) in Context.Headers)
         {
             if (LlmInferenceHeaders.Forbidden.Contains(name))
             {
@@ -248,7 +260,7 @@ internal override async Task OpenAsync()
             }
         }
 
-        await socket.ConnectAsync(ToWebSocketUri(_url), Context.CancellationToken).ConfigureAwait(false);
+        await socket.ConnectAsync(ToWebSocketUri(Context.Url), Context.CancellationToken).ConfigureAwait(false);
         _upstream = socket;
         _pumpCts = CancellationTokenSource.CreateLinkedTokenSource(Context.CancellationToken);
 
@@ -855,13 +867,10 @@ public Task<LlmInferenceHttpRequestStartResult> HttpRequestStartAsync(LlmInferen
         // dropping those frames and hanging the body drain.
         var exchange = _pending.GetOrAdd(request.RequestId, id => new LlmInferenceExchange(id, _getServerRpc));
         exchange.Method = request.Method;
-        exchange.Context = new CopilotRequestContext
+        exchange.Context = new CopilotRequestContext(request.RequestId, request.Url, ToReadOnlyHeaders(request.Headers))
         {
-            RequestId = request.RequestId,
             SessionId = request.SessionId,
             Transport = transport,
-            Url = request.Url,
-            Headers = ToReadOnlyHeaders(request.Headers),
             CancellationToken = exchange.Abort.Token,
         };
 
diff --git a/dotnet/test/E2E/CopilotRequestWebSocketE2ETests.cs b/dotnet/test/E2E/CopilotRequestWebSocketE2ETests.cs
@@ -116,8 +116,8 @@ protected override Task<HttpResponseMessage> SendRequestAsync(HttpRequestMessage
 
     protected override Task<CopilotWebSocketHandler> OpenWebSocketAsync(CopilotRequestContext ctx)
     {
-        var wsUrl = Rewrite(new Uri(ctx.Url)).ToString();
-        return Task.FromResult<CopilotWebSocketHandler>(new CountingForwardingWebSocketHandler(ctx, wsUrl, counters));
+        ctx = new CopilotRequestContext(ctx) { Url = Rewrite(new Uri(ctx.Url)).ToString() };
+        return Task.FromResult<CopilotWebSocketHandler>(new CountingForwardingWebSocketHandler(ctx, counters));
     }
 
     private Uri Rewrite(Uri original) => new UriBuilder(original)
@@ -133,9 +133,8 @@ protected override Task<CopilotWebSocketHandler> OpenWebSocketAsync(CopilotReque
 /// </summary>
 internal sealed class CountingForwardingWebSocketHandler(
     CopilotRequestContext context,
-    string url,
     HandlerCounters counters)
-    : CopilotWebSocketForwarder(context, url)
+    : CopilotWebSocketForwarder(context)
 {
     public override Task SendRequestMessageAsync(CopilotWebSocketMessage message)
     {
diff --git a/java/src/main/java/com/github/copilot/CopilotRequestContext.java b/java/src/main/java/com/github/copilot/CopilotRequestContext.java
@@ -39,6 +39,13 @@ public final class CopilotRequestContext {
         this.cancellation = cancellation;
     }
 
+    private CopilotRequestContext(String requestId, @Nullable String sessionId, CopilotRequestTransport transport,
+            String url, Map<String, List<String>> headers, CompletableFuture<Void> cancellation,
+            LlmWebSocketResponseBridge webSocketResponse) {
+        this(requestId, sessionId, transport, url, headers, cancellation);
+        this.webSocketResponse = webSocketResponse;
+    }
+
     /**
      * Gets the opaque runtime-minted request id, stable across the request
      * lifecycle.
@@ -88,6 +95,30 @@ public Map<String, List<String>> headers() {
         return headers;
     }
 
+    /**
+     * Returns a copy of this context with a different request URL.
+     *
+     * @param url
+     *            the replacement request URL
+     * @return the copied context
+     */
+    public CopilotRequestContext withUrl(String url) {
+        return new CopilotRequestContext(requestId, sessionId, transport, url, headers, cancellation,
+                webSocketResponse);
+    }
+
+    /**
+     * Returns a copy of this context with different request headers.
+     *
+     * @param headers
+     *            the replacement request headers
+     * @return the copied context
+     */
+    public CopilotRequestContext withHeaders(Map<String, List<String>> headers) {
+        return new CopilotRequestContext(requestId, sessionId, transport, url, headers, cancellation,
+                webSocketResponse);
+    }
+
     /**
      * A future that completes when the runtime cancels this in-flight request (for
      * example because the agent turn was aborted upstream). Subclasses that issue
diff --git a/java/src/main/java/com/github/copilot/CopilotWebSocketForwarder.java b/java/src/main/java/com/github/copilot/CopilotWebSocketForwarder.java
@@ -27,9 +27,6 @@
  */
 public class CopilotWebSocketForwarder extends CopilotWebSocketHandler {
 
-    private final String url;
-    private final Map<String, List<String>> headers;
-
     private volatile WebSocket webSocket;
 
     /**
@@ -40,37 +37,7 @@ public class CopilotWebSocketForwarder extends CopilotWebSocketHandler {
      *            the per-request context
      */
     public CopilotWebSocketForwarder(CopilotRequestContext context) {
-        this(context, context.url(), context.headers());
-    }
-
-    /**
-     * Creates a forwarding handler targeting {@code url} with the handshake headers
-     * from {@code context}.
-     *
-     * @param context
-     *            the per-request context
-     * @param url
-     *            the upstream WebSocket URL
-     */
-    public CopilotWebSocketForwarder(CopilotRequestContext context, String url) {
-        this(context, url, context.headers());
-    }
-
-    /**
-     * Creates a forwarding handler targeting {@code url} with the given handshake
-     * headers.
-     *
-     * @param context
-     *            the per-request context
-     * @param url
-     *            the upstream WebSocket URL
-     * @param headers
-     *            the handshake headers, multi-valued
-     */
-    public CopilotWebSocketForwarder(CopilotRequestContext context, String url, Map<String, List<String>> headers) {
         super(context);
-        this.url = url;
-        this.headers = headers;
     }
 
     @Override
@@ -79,6 +46,7 @@ void open() throws Exception {
             return;
         }
         WebSocket.Builder builder = HttpClient.newHttpClient().newWebSocketBuilder();
+        Map<String, List<String>> headers = context.headers();
         if (headers != null) {
             for (Map.Entry<String, List<String>> entry : headers.entrySet()) {
                 if (CopilotRequestHandler.isForbiddenRequestHeader(entry.getKey()) || entry.getValue() == null) {
@@ -90,8 +58,8 @@ void open() throws Exception {
             }
         }
         try {
-            this.webSocket = builder.buildAsync(URI.create(normalizeWebSocketScheme(url)), new ForwardingListener())
-                    .join();
+            this.webSocket = builder
+                    .buildAsync(URI.create(normalizeWebSocketScheme(context.url())), new ForwardingListener()).join();
         } catch (Exception e) {
             throw unwrap(e);
         }
diff --git a/java/src/test/java/com/github/copilot/CopilotRequestHandlerE2ETest.java b/java/src/test/java/com/github/copilot/CopilotRequestHandlerE2ETest.java
@@ -123,8 +123,7 @@ protected HttpResponse<InputStream> sendRequest(HttpRequest request, CopilotRequ
 
                 @Override
                 protected CopilotWebSocketHandler openWebSocket(CopilotRequestContext rctx) {
-                    String rewritten = rewriteHost(wsBase, URI.create(rctx.url()));
-                    return new CopilotWebSocketForwarder(rctx, rewritten) {
+                    return new CopilotWebSocketForwarder(rctx.withUrl(rewriteHost(wsBase, URI.create(rctx.url())))) {
                         @Override
                         public void sendRequestMessage(CopilotWebSocketMessage message) throws Exception {
                             wsRequestMessages.incrementAndGet();
diff --git a/nodejs/src/copilotRequestHandler.ts b/nodejs/src/copilotRequestHandler.ts
@@ -34,8 +34,8 @@ export interface CopilotRequestContext {
     readonly requestId: string;
     readonly sessionId?: string;
     readonly transport: "http" | "websocket";
-    readonly url: string;
-    readonly headers: LlmInferenceHeaders;
+    url: string;
+    headers: LlmInferenceHeaders;
     readonly signal: AbortSignal;
 }
 
@@ -139,12 +139,10 @@ export abstract class CopilotWebSocketHandler implements AsyncDisposable {
  * @experimental
  */
 export class CopilotWebSocketForwarder extends CopilotWebSocketHandler {
-    readonly #url: string;
     #upstream: WebSocket | null = null;
 
-    constructor(context: CopilotRequestContext, url = context.url) {
+    constructor(context: CopilotRequestContext) {
         super(context);
-        this.#url = url;
     }
 
     override sendRequestMessage(data: string | Uint8Array): void {
@@ -159,7 +157,7 @@ export class CopilotWebSocketForwarder extends CopilotWebSocketHandler {
         if (this.#upstream) {
             return;
         }
-        const upstream = new WebSocket(this.#url);
+        const upstream = new WebSocket(this.context.url);
         upstream.binaryType = "arraybuffer";
         this.#upstream = upstream;
         upstream.addEventListener("message", (event) => {
diff --git a/nodejs/test/e2e/copilot_request_handler.e2e.test.ts b/nodejs/test/e2e/copilot_request_handler.e2e.test.ts
diff --git a/python/copilot/copilot_request_handler.py b/python/copilot/copilot_request_handler.py
diff --git a/python/e2e/test_copilot_request_handler_e2e.py b/python/e2e/test_copilot_request_handler_e2e.py

Original file line number	Diff line number	Diff line change
`@@ -116,8 +116,8 @@ protected override Task<HttpResponseMessage> SendRequestAsync(HttpRequestMessage`
`116`	`116`
`117`	`117`	`protected override Task<CopilotWebSocketHandler> OpenWebSocketAsync(CopilotRequestContext ctx)`
`118`	`118`	`{`
`119`		`- var wsUrl = Rewrite(new Uri(ctx.Url)).ToString();`
`120`		`- return Task.FromResult<CopilotWebSocketHandler>(new CountingForwardingWebSocketHandler(ctx, wsUrl, counters));`
	`119`	`+ ctx = new CopilotRequestContext(ctx) { Url = Rewrite(new Uri(ctx.Url)).ToString() };`
	`120`	`+ return Task.FromResult<CopilotWebSocketHandler>(new CountingForwardingWebSocketHandler(ctx, counters));`
`121`	`121`	`}`
`122`	`122`
`123`	`123`	`private Uri Rewrite(Uri original) => new UriBuilder(original)`
`@@ -133,9 +133,8 @@ protected override Task<CopilotWebSocketHandler> OpenWebSocketAsync(CopilotReque`
`133`	`133`	`/// </summary>`
`134`	`134`	`internal sealed class CountingForwardingWebSocketHandler(`
`135`	`135`	`CopilotRequestContext context,`
`136`		`- string url,`
`137`	`136`	`HandlerCounters counters)`
`138`		`- : CopilotWebSocketForwarder(context, url)`
	`137`	`+ : CopilotWebSocketForwarder(context)`
`139`	`138`	`{`
`140`	`139`	`public override Task SendRequestMessageAsync(CopilotWebSocketMessage message)`
`141`	`140`	`{`