Skip to content

fix(openapi-fetch): prevent body parsing for HEAD requests regardless of Content-Length #2205

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
drwpow merged 2 commits into from
Mar 18, 2025
Merged

fix(openapi-fetch): prevent body parsing for HEAD requests regardless of Content-Length #2205

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
357526d
fix(openapi-fetch): prevent body parsing for HEAD requests regardless…
live-small Mar 17, 2025
dabe0b5
chore: add changeset for HEAD method fix
live-small Mar 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/openapi-fetch/src/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -209,7 +209,7 @@ export default function createClient(clientOptions) {
}

// handle empty content
if (response.status === 204 || response.headers.get("Content-Length") === "0") {
if (response.status === 204 || request.method === "HEAD" || response.headers.get("Content-Length") === "0") {
return response.ok ? { data: undefined, response } : { error: undefined, response };
}

Expand Down
12 changes: 12 additions & 0 deletions packages/openapi-fetch/test/http-methods/head.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,16 @@ describe("HEAD", () => {
await client.HEAD("/resources/{id}", { params: { path: { id: 123 } } });
expect(method).toBe("HEAD");
});

test("handles HEAD requests with non-zero Content-Length without parsing the body", async () => {
Copy link
Copy Markdown
Contributor

@drwpow drwpow Mar 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great test!

const client = createObservedClient<paths>({}, async () => {
return new Response(null, {
headers: { "Content-Length": "42", "Content-Type": "application/json" },
status: 200,
});
});
const result = await client.HEAD("/resources/{id}", { params: { path: { id: 123 } } });
expect(result.data).toBeUndefined();
expect(result.response.ok).toBe(true);
});
});