[Repo Assist] fix: expose HTTP response headers via LastResponseHeaders (closes #179) by github-actions[bot] · Pull Request #385 · fsprojects/SwaggerProvider

github-actions · 2026-04-16T22:18:26Z

🤖 This PR was created by Repo Assist, an automated AI assistant.

Summary

Fixes #179 — declared response headers from OpenAPI specs were silently discarded because ProvidedApiClientBase.CallAsync returned Task<HttpContent>, throwing away the HttpResponseMessage and all its headers.

Root Cause

// Before: HttpResponseMessage is disposed, headers lost
member _.CallAsync(...) : Task<HttpContent> = task {
    let! response = httpClient.SendAsync(...)
    return response.Content   // headers gone
}

Fix

Change CallAsync return type to Task<HttpResponseMessage> — the full response object is now returned.
Add LastResponseHeaders property — a mutable instance field on ProvidedApiClientBase that is populated after each CallAsync. Users can read client.LastResponseHeaders to access response headers immediately after any API call.
Update OperationCompiler — the generated task { } quotation bodies now call response.Content where content was used directly before.
Add collectResponseHeaders helper to RuntimeHelpers for converting HttpResponseHeaders to a flat IReadOnlyDictionary<string, string>.

Usage (after fix)

let! result = client.SomeOperation(...)
let headers = client.LastResponseHeaders
// headers["X-Custom-Header"] etc.

Trade-offs

CallAsync return type is a technically breaking change for any code that calls it directly (rare; it's a protected base-class method). Generated client code is updated accordingly.
LastResponseHeaders is per-instance and not thread-safe for concurrent calls on the same client instance — consistent with the general HttpClient usage pattern.

Test Status

✅ Build succeeded (dotnet build SwaggerProvider.sln -c Release)
✅ 284 tests, 0 failures, 0 errors (SwaggerProvider.Tests.dll)
✅ 4 new unit tests added for LastResponseHeaders
✅ Format check passed (dotnet fantomas --check)

Generated by 🌈 Repo Assist, see workflow run. Learn more.

To install this agentic workflow, run
gh aw add githubnext/agentics/workflows/repo-assist.md@97143ac59cb3a13ef2a77581f929f06719c7402a

- Change CallAsync to return Task<HttpResponseMessage> instead of Task<HttpContent> - Add mutable LastResponseHeaders property to ProvidedApiClientBase so callers can inspect response headers after each operation call - Add collectResponseHeaders helper to RuntimeHelpers - Update OperationCompiler quotations to use response.Content where content was previously used directly - Add 4 new unit tests for LastResponseHeaders behaviour Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Agent-Logs-Url: https://github.com/fsprojects/SwaggerProvider/sessions/7b6606ed-f420-4df8-9e59-bbfd17333974 Co-authored-by: sergey-tihon <1197905+sergey-tihon@users.noreply.github.com>

Copilot · 2026-04-17T07:45:36Z

Just as a heads up, I was blocked by some firewall rules while working on your feedback. Expand below for details.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

petstore.swagger.io
- Triggering command: /usr/share/dotnet/dotnet /usr/share/dotnet/dotnet /usr/share/dotnet/sdk/10.0.201/FSharp/fsc.dll @/tmp/MSBuildTemp9njDv6/tmp8298d22cba2b4ea088d4acf53975e208.rsp (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Configure Actions setup steps to set up my environment, which run before the firewall is enabled
Add the appropriate URLs or hosts to the custom allowlist in this repository's Copilot coding agent settings (admins only)

Copilot

Pull request overview

This PR aims to fix #179 by preserving HTTP response metadata (especially headers) that was previously lost when ProvidedApiClientBase.CallAsync returned only HttpContent instead of the full HttpResponseMessage.

Changes:

Updated ProvidedApiClientBase.CallAsync to return Task<HttpResponseMessage> instead of Task<HttpContent>.
Updated generated operation quotations to read from response.Content (since the call now returns the response message).
Updated an existing unit test to match the new CallAsync return type.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.

File	Description
`src/SwaggerProvider.Runtime/ProvidedApiClientBase.fs`	Changes `CallAsync` to return `HttpResponseMessage` so headers are not discarded.
`src/SwaggerProvider.DesignTime/OperationCompiler.fs`	Adjusts generated code to use `response.Content` when reading body content.
`tests/SwaggerProvider.Tests/RuntimeHelpersTests.fs`	Updates a test to read the body via `response.Content` after the signature change.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-04-17T08:01:08Z

    member this.CallAsync
        (request: HttpRequestMessage, errorCodes: string[], errorDescriptions: string[], cancellationToken: System.Threading.CancellationToken)
-        : Task<HttpContent> =
+        : Task<HttpResponseMessage> =
        task {
            let! response = this.HttpClient.SendAsync(request, cancellationToken)

            if response.IsSuccessStatusCode then
-                return response.Content
+                return response
            else


The PR description/issue resolution relies on exposing response headers (e.g., via a LastResponseHeaders property or similar), but this change only switches CallAsync to return HttpResponseMessage. As-is, generated client methods still deserialize/return only the body and do not surface headers to consumers, and there is no LastResponseHeaders implementation in this type. Please implement the promised header exposure (and populate it inside CallAsync) or adjust the generated API surface to return headers with results so #179 is actually fixed.

Copilot · 2026-04-17T08:01:09Z

                                task {
                                    let! response = x
-                                    let! content = RuntimeHelpers.readContentAsString response ct
+                                    let! content = RuntimeHelpers.readContentAsString response.Content ct
                                    return (%this).Deserialize(content, innerReturnType)
                                }


CallAsync now returns HttpResponseMessage, but the generated code reads from response.Content without disposing the response afterward. For non-stream return paths (string/object), this can keep the response (and underlying connection/resources) alive longer than necessary. Consider disposing the HttpResponseMessage after fully reading/deserializing the body (e.g., via a use/use! binding or try/finally) while keeping the stream-return case handled separately.

Copilot · 2026-04-17T08:01:09Z

            use request = new HttpRequestMessage(HttpMethod.Get, "http://stub/pets/1")
-            let! content = client.CallAsync(request, [||], [||], CancellationToken.None)
-            let! body = content.ReadAsStringAsync()
+            let! response = client.CallAsync(request, [||], [||], CancellationToken.None)


This test now keeps the returned HttpResponseMessage undisposed. Since CallAsync returns HttpResponseMessage, it should be disposed in the success path (e.g., use! response = ...) to match typical HttpClient usage and avoid resource leaks in the test suite.

Suggested change

let! response = client.CallAsync(request, [||], [||], CancellationToken.None)

use! response = client.CallAsync(request, [||], [||], CancellationToken.None)

github-actions bot added automation bug repo-assist labels Apr 16, 2026

ci: trigger checks

c623874

sergey-tihon reviewed Apr 17, 2026

View reviewed changes

Comment thread src/SwaggerProvider.Runtime/ProvidedApiClientBase.fs Outdated

Copilot started work on behalf of sergey-tihon April 17, 2026 07:36 View session

fix: remove LastResponseHeaders and keep CallAsync response return

fb3b1b7

Agent-Logs-Url: https://github.com/fsprojects/SwaggerProvider/sessions/7b6606ed-f420-4df8-9e59-bbfd17333974 Co-authored-by: sergey-tihon <1197905+sergey-tihon@users.noreply.github.com>

Copilot finished work on behalf of sergey-tihon April 17, 2026 07:45

Copilot AI requested a review from sergey-tihon April 17, 2026 07:45

sergey-tihon marked this pull request as ready for review April 17, 2026 07:57

Copilot AI review requested due to automatic review settings April 17, 2026 07:57

Copilot started reviewing on behalf of sergey-tihon April 17, 2026 07:57 View session

Copilot AI reviewed Apr 17, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Repo Assist] fix: expose HTTP response headers via LastResponseHeaders (closes #179)#385

[Repo Assist] fix: expose HTTP response headers via LastResponseHeaders (closes #179)#385
github-actions[bot] wants to merge 3 commits intomasterfrom
repo-assist/fix-issue-179-expose-response-headers-20260416-9baf94860486c219

github-actions bot commented Apr 16, 2026

Uh oh!

Uh oh!

Copilot AI commented Apr 17, 2026

I tried to connect to the following addresses, but was blocked by firewall rules:

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Apr 17, 2026

Uh oh!

Copilot AI Apr 17, 2026

Uh oh!

Copilot AI Apr 17, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	let! response = client.CallAsync(request, [\|\|], [\|\|], CancellationToken.None)
	use! response = client.CallAsync(request, [\|\|], [\|\|], CancellationToken.None)

Conversation

github-actions bot commented Apr 16, 2026

Summary

Root Cause

Fix

Usage (after fix)

Trade-offs

Test Status

Uh oh!

Uh oh!

Copilot AI commented Apr 17, 2026

I tried to connect to the following addresses, but was blocked by firewall rules:

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Apr 17, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 17, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 17, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants