Skip to content

fix(nextjs): Comply with Server Actions async requirement #7445

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
wobsoriano merged 2 commits into from
Dec 12, 2025
Merged

fix(nextjs): Comply with Server Actions async requirement #7445

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
31bc775
fix(nextjs): Make formatMetadataHeaders async to comply with Server A…
wobsoriano Dec 12, 2025
36ca0d5
chore: add changeset
wobsoriano Dec 12, 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
5 changes: 5 additions & 0 deletions .changeset/pretty-crabs-scream.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@clerk/nextjs": patch
---

Mark internal keyless header function async to comply with Server Actions async requirements
18 changes: 9 additions & 9 deletions packages/nextjs/src/__tests__/keyless-custom-headers.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ describe('keyless-custom-headers', () => {
});

describe('formatMetadataHeaders', () => {
it('should format complete metadata object with all fields present', () => {
it('should format complete metadata object with all fields present', async () => {
const metadata = {
nodeVersion: 'v18.17.0',
nextVersion: 'next-server (v15.4.5)',
Expand All @@ -181,7 +181,7 @@ describe('keyless-custom-headers', () => {
isCI: false,
};

const result = formatMetadataHeaders(metadata);
const result = await formatMetadataHeaders(metadata);

// Test exact header casing and values
expect(result.get('Clerk-Node-Version')).toBe('v18.17.0');
Expand All @@ -196,7 +196,7 @@ describe('keyless-custom-headers', () => {
expect(result.get('Clerk-Auth-Status')).toBe('signed-out');
});

it('should handle missing optional fields gracefully', () => {
it('should handle missing optional fields gracefully', async () => {
const metadata = {
userAgent: 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7)',
host: 'localhost:3000',
Expand All @@ -208,7 +208,7 @@ describe('keyless-custom-headers', () => {
// Missing: nodeVersion, nextVersion, npmConfigUserAgent, port
};

const result = formatMetadataHeaders(metadata);
const result = await formatMetadataHeaders(metadata);

// Test that only present fields are set
expect(result.get('Clerk-Client-User-Agent')).toBe('Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7)');
Expand All @@ -225,7 +225,7 @@ describe('keyless-custom-headers', () => {
expect(result.get('Clerk-Node-Port')).toBeNull();
});

it('should handle undefined values for optional fields', () => {
it('should handle undefined values for optional fields', async () => {
const metadata = {
nodeVersion: undefined,
nextVersion: undefined,
Expand All @@ -240,7 +240,7 @@ describe('keyless-custom-headers', () => {
isCI: false,
};

const result = formatMetadataHeaders(metadata);
const result = await formatMetadataHeaders(metadata);

// Test that undefined fields are not set
expect(result.get('Clerk-Node-Version')).toBeNull();
Expand All @@ -257,7 +257,7 @@ describe('keyless-custom-headers', () => {
expect(result.get('Clerk-Auth-Status')).toBe('test-auth-status');
});

it('should handle empty string values', () => {
it('should handle empty string values', async () => {
const metadata = {
nodeVersion: '',
nextVersion: '',
Expand All @@ -272,7 +272,7 @@ describe('keyless-custom-headers', () => {
isCI: false,
};

const result = formatMetadataHeaders(metadata);
const result = await formatMetadataHeaders(metadata);

// Empty strings should not be set as headers
expect(result.get('Clerk-Node-Version')).toBeNull();
Expand Down Expand Up @@ -513,7 +513,7 @@ describe('keyless-custom-headers', () => {

// Collect metadata and format headers
const metadata = await collectKeylessMetadata();
const headers = formatMetadataHeaders(metadata);
const headers = await formatMetadataHeaders(metadata);

// Verify the full pipeline works correctly
expect(headers.get('Clerk-Client-User-Agent')).toBe('Integration-Test-Agent');
Expand Down
4 changes: 2 additions & 2 deletions packages/nextjs/src/server/keyless-custom-headers.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ interface MetadataHeaders {
* Collects metadata from the environment and request headers
*/
export async function collectKeylessMetadata(): Promise<MetadataHeaders> {
const headerStore = await headers(); // eslint-disable-line
const headerStore = await headers();

return {
nodeVersion: process.version,
Expand Down Expand Up @@ -99,7 +99,7 @@ function getNextVersion(): string | undefined {
/**
* Converts metadata to HTTP headers
*/
export function formatMetadataHeaders(metadata: MetadataHeaders): Headers {
export async function formatMetadataHeaders(metadata: MetadataHeaders): Promise<Headers> {
const headers = new Headers();

if (metadata.nodeVersion) {
Expand Down