feat(nextjs): Support async headers() #4278

jacekradko · 2024-10-03T15:26:08Z

Description

Related #4245

Tested the codemod in dashboard: https://github.com/clerk/dashboard/pull/3886

Checklist

npm test runs as expected.
npm run build runs as expected.
(If applicable) JSDoc comments have been added or updated for any package exports
(If applicable) Documentation has been updated

Type of change

changeset-bot · 2024-10-03T15:26:13Z

🦋 Changeset detected

Latest commit: ee76c39

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 2 packages

Name	Type
@clerk/nextjs	Major
@clerk/upgrade	Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

packages/nextjs/tsconfig.declarations.json

packages/nextjs/src/server/clerkMiddleware.ts

.changeset/grumpy-hairs-remember.md

integration/templates/next-app-router/src/middleware.ts

.changeset/grumpy-hairs-remember.md

packages/nextjs/src/server/clerkClient.ts

jacekradko · 2024-10-17T20:03:47Z

!snapshot

jacekradko · 2024-10-17T21:22:06Z

!snapshot

clerk-cookie · 2024-10-17T21:26:36Z

Hey @jacekradko - the snapshot version command generated the following package versions:

Package	Version
@clerk/astro	1.3.17-snapshot.vb87a27f
@clerk/backend	1.14.2-snapshot.vb87a27f
@clerk/chrome-extension	1.3.21-snapshot.vb87a27f
@clerk/clerk-js	5.28.0-snapshot.vb87a27f
@clerk/elements	0.17.0-snapshot.vb87a27f
@clerk/clerk-expo	2.2.27-snapshot.vb87a27f
@clerk/express	1.3.2-snapshot.vb87a27f
@clerk/fastify	2.0.4-snapshot.vb87a27f
@clerk/localizations	3.3.1-snapshot.vb87a27f
@clerk/nextjs	6.0.0-snapshot.vb87a27f
@clerk/clerk-react	5.12.1-snapshot.vb87a27f
@clerk/remix	4.2.40-snapshot.vb87a27f
@clerk/clerk-sdk-node	5.0.53-snapshot.vb87a27f
@clerk/shared	2.10.0-snapshot.vb87a27f
@clerk/tanstack-start	0.4.16-snapshot.vb87a27f
@clerk/testing	1.3.14-snapshot.vb87a27f
@clerk/themes	2.1.38-snapshot.vb87a27f
@clerk/types	4.27.0-snapshot.vb87a27f
@clerk/upgrade	1.1.0-snapshot.vb87a27f

Tip: Use the snippet copy button below to quickly install the required packages.
@clerk/astro

npm i @clerk/astro@1.3.17-snapshot.vb87a27f --save-exact

@clerk/backend

npm i @clerk/backend@1.14.2-snapshot.vb87a27f --save-exact

@clerk/chrome-extension

npm i @clerk/chrome-extension@1.3.21-snapshot.vb87a27f --save-exact

@clerk/clerk-js

npm i @clerk/clerk-js@5.28.0-snapshot.vb87a27f --save-exact

@clerk/elements

npm i @clerk/elements@0.17.0-snapshot.vb87a27f --save-exact

@clerk/clerk-expo

npm i @clerk/clerk-expo@2.2.27-snapshot.vb87a27f --save-exact

@clerk/express

npm i @clerk/express@1.3.2-snapshot.vb87a27f --save-exact

@clerk/fastify

npm i @clerk/fastify@2.0.4-snapshot.vb87a27f --save-exact

@clerk/localizations

npm i @clerk/localizations@3.3.1-snapshot.vb87a27f --save-exact

@clerk/nextjs

npm i @clerk/nextjs@6.0.0-snapshot.vb87a27f --save-exact

@clerk/clerk-react

npm i @clerk/clerk-react@5.12.1-snapshot.vb87a27f --save-exact

@clerk/remix

npm i @clerk/remix@4.2.40-snapshot.vb87a27f --save-exact

@clerk/clerk-sdk-node

npm i @clerk/clerk-sdk-node@5.0.53-snapshot.vb87a27f --save-exact

@clerk/shared

npm i @clerk/shared@2.10.0-snapshot.vb87a27f --save-exact

@clerk/tanstack-start

npm i @clerk/tanstack-start@0.4.16-snapshot.vb87a27f --save-exact

@clerk/testing

npm i @clerk/testing@1.3.14-snapshot.vb87a27f --save-exact

@clerk/themes

npm i @clerk/themes@2.1.38-snapshot.vb87a27f --save-exact

@clerk/types

npm i @clerk/types@4.27.0-snapshot.vb87a27f --save-exact

@clerk/upgrade

npm i @clerk/upgrade@1.1.0-snapshot.vb87a27f --save-exact

packages/upgrade/src/constants/versions.js

jacekradko · 2024-10-18T01:21:23Z

!snapshot

clerk-cookie · 2024-10-18T01:30:56Z

Hey @jacekradko - the snapshot version command generated the following package versions:

Package	Version
@clerk/astro	1.3.17-snapshot.v49b6f8d
@clerk/backend	1.14.2-snapshot.v49b6f8d
@clerk/chrome-extension	1.3.21-snapshot.v49b6f8d
@clerk/clerk-js	5.28.0-snapshot.v49b6f8d
@clerk/elements	0.17.0-snapshot.v49b6f8d
@clerk/clerk-expo	2.2.27-snapshot.v49b6f8d
@clerk/express	1.3.2-snapshot.v49b6f8d
@clerk/fastify	2.0.4-snapshot.v49b6f8d
@clerk/localizations	3.3.1-snapshot.v49b6f8d
@clerk/nextjs	6.0.0-snapshot.v49b6f8d
@clerk/clerk-react	5.12.1-snapshot.v49b6f8d
@clerk/remix	4.2.40-snapshot.v49b6f8d
@clerk/clerk-sdk-node	5.0.53-snapshot.v49b6f8d
@clerk/shared	2.10.0-snapshot.v49b6f8d
@clerk/tanstack-start	0.4.16-snapshot.v49b6f8d
@clerk/testing	1.3.14-snapshot.v49b6f8d
@clerk/themes	2.1.38-snapshot.v49b6f8d
@clerk/types	4.27.0-snapshot.v49b6f8d
@clerk/upgrade	1.1.0-snapshot.v49b6f8d

Tip: Use the snippet copy button below to quickly install the required packages.
@clerk/astro

npm i @clerk/astro@1.3.17-snapshot.v49b6f8d --save-exact

@clerk/backend

npm i @clerk/backend@1.14.2-snapshot.v49b6f8d --save-exact

@clerk/chrome-extension

npm i @clerk/chrome-extension@1.3.21-snapshot.v49b6f8d --save-exact

@clerk/clerk-js

npm i @clerk/clerk-js@5.28.0-snapshot.v49b6f8d --save-exact

@clerk/elements

npm i @clerk/elements@0.17.0-snapshot.v49b6f8d --save-exact

@clerk/clerk-expo

npm i @clerk/clerk-expo@2.2.27-snapshot.v49b6f8d --save-exact

@clerk/express

npm i @clerk/express@1.3.2-snapshot.v49b6f8d --save-exact

@clerk/fastify

npm i @clerk/fastify@2.0.4-snapshot.v49b6f8d --save-exact

@clerk/localizations

npm i @clerk/localizations@3.3.1-snapshot.v49b6f8d --save-exact

@clerk/nextjs

npm i @clerk/nextjs@6.0.0-snapshot.v49b6f8d --save-exact

@clerk/clerk-react

npm i @clerk/clerk-react@5.12.1-snapshot.v49b6f8d --save-exact

@clerk/remix

npm i @clerk/remix@4.2.40-snapshot.v49b6f8d --save-exact

@clerk/clerk-sdk-node

npm i @clerk/clerk-sdk-node@5.0.53-snapshot.v49b6f8d --save-exact

@clerk/shared

npm i @clerk/shared@2.10.0-snapshot.v49b6f8d --save-exact

@clerk/tanstack-start

npm i @clerk/tanstack-start@0.4.16-snapshot.v49b6f8d --save-exact

@clerk/testing

npm i @clerk/testing@1.3.14-snapshot.v49b6f8d --save-exact

@clerk/themes

npm i @clerk/themes@2.1.38-snapshot.v49b6f8d --save-exact

@clerk/types

npm i @clerk/types@4.27.0-snapshot.v49b6f8d --save-exact

@clerk/upgrade

npm i @clerk/upgrade@1.1.0-snapshot.v49b6f8d --save-exact

jacekradko · 2024-10-18T23:01:39Z

!snapshot

clerk-cookie · 2024-10-18T23:06:13Z

Hey @jacekradko - the snapshot version command generated the following package versions:

Package	Version
@clerk/astro	1.4.0-snapshot.vfbd7c17
@clerk/backend	1.14.2-snapshot.vfbd7c17
@clerk/chrome-extension	1.3.21-snapshot.vfbd7c17
@clerk/clerk-js	5.28.0-snapshot.vfbd7c17
@clerk/elements	0.17.0-snapshot.vfbd7c17
@clerk/clerk-expo	2.2.27-snapshot.vfbd7c17
@clerk/express	1.3.2-snapshot.vfbd7c17
@clerk/fastify	2.0.4-snapshot.vfbd7c17
@clerk/localizations	3.3.1-snapshot.vfbd7c17
@clerk/nextjs	6.0.0-snapshot.vfbd7c17
@clerk/clerk-react	5.12.1-snapshot.vfbd7c17
@clerk/remix	4.2.40-snapshot.vfbd7c17
@clerk/clerk-sdk-node	5.0.53-snapshot.vfbd7c17
@clerk/shared	2.10.0-snapshot.vfbd7c17
@clerk/tanstack-start	0.4.16-snapshot.vfbd7c17
@clerk/testing	1.3.14-snapshot.vfbd7c17
@clerk/themes	2.1.38-snapshot.vfbd7c17
@clerk/types	4.27.0-snapshot.vfbd7c17
@clerk/upgrade	1.1.0-snapshot.vfbd7c17

Tip: Use the snippet copy button below to quickly install the required packages.
@clerk/astro

npm i @clerk/astro@1.4.0-snapshot.vfbd7c17 --save-exact

@clerk/backend

npm i @clerk/backend@1.14.2-snapshot.vfbd7c17 --save-exact

@clerk/chrome-extension

npm i @clerk/chrome-extension@1.3.21-snapshot.vfbd7c17 --save-exact

@clerk/clerk-js

npm i @clerk/clerk-js@5.28.0-snapshot.vfbd7c17 --save-exact

@clerk/elements

npm i @clerk/elements@0.17.0-snapshot.vfbd7c17 --save-exact

@clerk/clerk-expo

npm i @clerk/clerk-expo@2.2.27-snapshot.vfbd7c17 --save-exact

@clerk/express

npm i @clerk/express@1.3.2-snapshot.vfbd7c17 --save-exact

@clerk/fastify

npm i @clerk/fastify@2.0.4-snapshot.vfbd7c17 --save-exact

@clerk/localizations

npm i @clerk/localizations@3.3.1-snapshot.vfbd7c17 --save-exact

@clerk/nextjs

npm i @clerk/nextjs@6.0.0-snapshot.vfbd7c17 --save-exact

@clerk/clerk-react

npm i @clerk/clerk-react@5.12.1-snapshot.vfbd7c17 --save-exact

@clerk/remix

npm i @clerk/remix@4.2.40-snapshot.vfbd7c17 --save-exact

@clerk/clerk-sdk-node

npm i @clerk/clerk-sdk-node@5.0.53-snapshot.vfbd7c17 --save-exact

@clerk/shared

npm i @clerk/shared@2.10.0-snapshot.vfbd7c17 --save-exact

@clerk/tanstack-start

npm i @clerk/tanstack-start@0.4.16-snapshot.vfbd7c17 --save-exact

@clerk/testing

npm i @clerk/testing@1.3.14-snapshot.vfbd7c17 --save-exact

@clerk/themes

npm i @clerk/themes@2.1.38-snapshot.vfbd7c17 --save-exact

@clerk/types

npm i @clerk/types@4.27.0-snapshot.vfbd7c17 --save-exact

@clerk/upgrade

npm i @clerk/upgrade@1.1.0-snapshot.vfbd7c17 --save-exact

t3dotgg · 2024-10-19T06:16:36Z

👀

brkalow

Looking good! Left some minor comments. Let's get it merged into the 15 branch 🚢

packages/upgrade/src/components/SDKWorkflow.js

brkalow · 2024-10-19T03:21:58Z

packages/upgrade/src/codemods/index.js

+
+const __dirname = dirname(fileURLToPath(import.meta.url));
+
+export async function runCodemod(transform = 'transform-async-request', glob, options) {


[nit] Do we need to make this the default value for transform? Feels a bit odd with the thought that we'll be adding more down the line.

brkalow · 2024-10-19T03:22:16Z

packages/upgrade/src/codemods/__tests__/transform-async-request.test.js

+import transformer from '../transform-async-request.cjs';
+import { fixtures } from './__fixtures__/transform-async-request.fixtures';
+
+describe('transform-async-request', () => {


packages/nextjs/MIGRATION.md

packages/upgrade/src/app.js

Co-authored-by: Bryce Kalow <bryce@clerk.dev>

clerk-cookie added nextjs playground integration labels Oct 3, 2024

jacekradko commented Oct 3, 2024

View reviewed changes

packages/nextjs/tsconfig.declarations.json Show resolved Hide resolved

brkalow reviewed Oct 3, 2024

View reviewed changes

packages/nextjs/src/server/clerkMiddleware.ts Outdated Show resolved Hide resolved

jacekradko force-pushed the jacek/async-headers branch from 4f0263d to 6c0eaa7 Compare October 4, 2024 14:42

jacekradko changed the title ~~feat: async headers~~ feat(nextjs): async headers Oct 4, 2024

jacekradko changed the title ~~feat(nextjs): async headers~~ feat(nextjs): support async headers() Oct 4, 2024

jacekradko commented Oct 4, 2024

View reviewed changes

.changeset/grumpy-hairs-remember.md Outdated Show resolved Hide resolved

jacekradko changed the title ~~feat(nextjs): support async headers()~~ feat(nextjs): Support async headers() Oct 4, 2024

tmilewski assigned jacekradko Oct 4, 2024

jacekradko commented Oct 7, 2024

View reviewed changes

integration/templates/next-app-router/src/middleware.ts Outdated Show resolved Hide resolved

jacekradko commented Oct 7, 2024

View reviewed changes

.changeset/grumpy-hairs-remember.md Outdated Show resolved Hide resolved

jacekradko commented Oct 15, 2024

View reviewed changes

packages/nextjs/src/server/clerkClient.ts Show resolved Hide resolved

feat: support async request methods

11c15f3

jacekradko force-pushed the jacek/async-headers branch from de0f2d2 to 11c15f3 Compare October 17, 2024 17:31

clerk-cookie added types clerk-js react remix backend fastify localizations sdk-node expo chrome-extension themes elements express labels Oct 17, 2024

clerk-cookie removed the tanstack label Oct 17, 2024

run codemod through cli

f165207

jacekradko added 2 commits October 17, 2024 15:04

Merge branch 'main' into jacek/async-headers

ffbc661

Merge branch 'main' into jacek/async-headers

b87a27f

WIP

56307be

jacekradko added 2 commits October 17, 2024 20:10

fix edge case in codemod

c23e478

tabs to spaces

a4f987b

jacekradko commented Oct 18, 2024

View reviewed changes

packages/upgrade/src/constants/versions.js Outdated Show resolved Hide resolved

Update packages/upgrade/src/constants/versions.js

49b6f8d

jacekradko and others added 3 commits October 18, 2024 09:10

Merge branch 'main' into jacek/async-headers

ca8e468

clerkMiddleware auth.protect()

87f266f

WIP

d5390be

jacekradko changed the base branch from main to feat/nextjs-15-compat October 18, 2024 17:00

Merge branch 'feat/nextjs-15-compat' into jacek/async-headers

fbd7c17

jacekradko marked this pull request as ready for review October 18, 2024 17:00

CLI polish

44ecba8

brkalow approved these changes Oct 19, 2024

View reviewed changes

jacekradko and others added 3 commits October 20, 2024 21:55

Apply suggestions from code review

2f36da1

Co-authored-by: Bryce Kalow <bryce@clerk.dev>

Check for next.js SDK

20384b1

do not fallback transform

ee76c39

jacekradko merged commit 81e2d7f into feat/nextjs-15-compat Oct 21, 2024
2 of 3 checks passed

jacekradko deleted the jacek/async-headers branch October 21, 2024 17:43


		const __dirname = dirname(fileURLToPath(import.meta.url));

		export async function runCodemod(transform = 'transform-async-request', glob, options) {

feat(nextjs): Support async headers() #4278

feat(nextjs): Support async headers() #4278

Uh oh!

Conversation

jacekradko commented Oct 3, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist

Type of change

Uh oh!

changeset-bot bot commented Oct 3, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jacekradko commented Oct 17, 2024

Uh oh!

jacekradko commented Oct 17, 2024

Uh oh!

clerk-cookie commented Oct 17, 2024

Uh oh!

Uh oh!

jacekradko commented Oct 18, 2024

Uh oh!

clerk-cookie commented Oct 18, 2024

Uh oh!

jacekradko commented Oct 18, 2024

Uh oh!

clerk-cookie commented Oct 18, 2024

Uh oh!

t3dotgg commented Oct 19, 2024

Uh oh!

brkalow left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

brkalow Oct 19, 2024

Choose a reason for hiding this comment

Uh oh!

brkalow Oct 19, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

jacekradko commented Oct 3, 2024 •

edited

Loading

changeset-bot bot commented Oct 3, 2024 •

edited

Loading