Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
10 changes: 10 additions & 0 deletions .changeset/fix-csrf-fetch-request-headers.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
"@csrf-armor/nextjs": patch
"@csrf-armor/nuxt": patch
---

fix(client): preserve headers when `csrfFetch` is called with a `Request` object

`csrfFetch` previously only read headers from the `init` argument, so when it was called with a full `Request` object (e.g. `csrfFetch(new Request(url, { headers }))`), the Request's headers were stripped. It now merges headers from the Request, then the `init` argument, then the CSRF headers (CSRF headers always take precedence), making `csrfFetch` a drop-in replacement for `fetch`.

Fixes #49
11 changes: 7 additions & 4 deletions packages/nextjs/src/client/client.ts
Original file line number Diff line number Diff line change
Expand Up @@ -149,10 +149,13 @@ export function csrfFetch(
init?: RequestInit,
config?: CsrfClientConfig
): Promise<Response> {
const headers = new Headers(init?.headers);
const csrfHeaders = createCsrfHeaders(config);

for (const [key, value] of Object.entries(csrfHeaders)) {
const headers = new Headers(
input instanceof Request ? input.headers : undefined
);
for (const [key, value] of new Headers(init?.headers)) {
headers.set(key, value);
}
for (const [key, value] of Object.entries(createCsrfHeaders(config))) {
headers.set(key, value);
}

Expand Down
34 changes: 34 additions & 0 deletions packages/nextjs/tests/client.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,40 @@ describe('Client utilities', () => {
expect(headers.get('Content-Type')).toBe('application/json');
});

it('should preserve headers when input is a Request object', async () => {
document.cookie = 'csrf-token=req-token';
const req = new Request('https://example.com/api/data', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
'X-Custom': 'keep-me',
},
});
await csrfFetch(req);

const callArgs = (globalThis.fetch as ReturnType<typeof vi.fn>).mock
.calls[0];
const headers = callArgs[1].headers as Headers;
expect(headers.get('x-csrf-token')).toBe('req-token');
expect(headers.get('Content-Type')).toBe('application/json');
expect(headers.get('X-Custom')).toBe('keep-me');
});

it('should let init headers override Request headers', async () => {
document.cookie = 'csrf-token=override-token';
const req = new Request('https://example.com/api/data', {
method: 'POST',
headers: { 'X-Custom': 'original' },
});
await csrfFetch(req, { headers: { 'X-Custom': 'overridden' } });

const callArgs = (globalThis.fetch as ReturnType<typeof vi.fn>).mock
.calls[0];
const headers = callArgs[1].headers as Headers;
expect(headers.get('X-Custom')).toBe('overridden');
expect(headers.get('x-csrf-token')).toBe('override-token');
});

it('should work without a token', async () => {
await csrfFetch('/api/data');

Expand Down
11 changes: 7 additions & 4 deletions packages/nuxt/src/runtime/utils/client.ts
Original file line number Diff line number Diff line change
Expand Up @@ -67,10 +67,13 @@ export function csrfFetch(
init?: RequestInit,
config?: CsrfClientConfig
): Promise<Response> {
const headers = new Headers(init?.headers);
const csrfHeaders = createCsrfHeaders(config);

for (const [key, value] of Object.entries(csrfHeaders)) {
const headers = new Headers(
input instanceof Request ? input.headers : undefined
);
for (const [key, value] of new Headers(init?.headers)) {
headers.set(key, value);
}
for (const [key, value] of Object.entries(createCsrfHeaders(config))) {
headers.set(key, value);
}

Expand Down
68 changes: 68 additions & 0 deletions packages/nuxt/test/client.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
/**
* @vitest-environment jsdom
*
* Note: `getCsrfToken` returns null in this test environment because
* `import.meta.client` is only defined by Nuxt at build time, so the CSRF
* header is not injected. These tests cover the Request/init header merge
* behavior that issue #49 exposed. The CSRF-precedence assertion is
* covered by the Next.js client tests, which exercise the same merge logic.
*/
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';

import { csrfFetch } from '../src/runtime/utils/client';

describe('csrfFetch (nuxt)', () => {
beforeEach(() => {
vi.spyOn(globalThis, 'fetch').mockResolvedValue(
new Response('ok', { status: 200 })
);
});

afterEach(() => {
vi.restoreAllMocks();
});

it('preserves headers when input is a Request object', async () => {
const req = new Request('https://example.com/api/data', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
'X-Custom': 'keep-me',
},
});
await csrfFetch(req);

const callArgs = (globalThis.fetch as ReturnType<typeof vi.fn>).mock
.calls[0];
const headers = callArgs[1].headers as Headers;
expect(headers.get('Content-Type')).toBe('application/json');
expect(headers.get('X-Custom')).toBe('keep-me');
});

it('lets init headers override Request headers', async () => {
const req = new Request('https://example.com/api/data', {
method: 'POST',
headers: { 'X-Custom': 'original' },
});
await csrfFetch(req, { headers: { 'X-Custom': 'overridden' } });

const callArgs = (globalThis.fetch as ReturnType<typeof vi.fn>).mock
.calls[0];
const headers = callArgs[1].headers as Headers;
expect(headers.get('X-Custom')).toBe('overridden');
});

it('merges init headers alongside Request headers', async () => {
const req = new Request('https://example.com/api/data', {
method: 'POST',
headers: { 'X-From-Request': 'req' },
});
await csrfFetch(req, { headers: { 'X-From-Init': 'init' } });

const callArgs = (globalThis.fetch as ReturnType<typeof vi.fn>).mock
.calls[0];
const headers = callArgs[1].headers as Headers;
expect(headers.get('X-From-Request')).toBe('req');
expect(headers.get('X-From-Init')).toBe('init');
});
});
Loading