diff --git a/.github/workflows/playwright.yml b/.github/workflows/playwright.yml
new file mode 100644
index 000000000..81162484a
--- /dev/null
+++ b/.github/workflows/playwright.yml
@@ -0,0 +1,27 @@
+name: Playwright Tests
+on:
+ push:
+ branches: [ main, master ]
+ pull_request:
+ branches: [ main, master ]
+jobs:
+ test:
+ timeout-minutes: 60
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v4
+ - uses: actions/setup-node@v4
+ with:
+ node-version: lts/*
+ - name: Install dependencies
+ run: npm install -g pnpm && pnpm install
+ - name: Install Playwright Browsers
+ run: pnpm exec playwright install --with-deps
+ - name: Run Playwright tests
+ run: pnpm exec playwright test
+ - uses: actions/upload-artifact@v4
+ if: ${{ !cancelled() }}
+ with:
+ name: playwright-report
+ path: playwright-report/
+ retention-days: 30
diff --git a/.gitignore b/.gitignore
index 6a7d6d8ef..316040812 100644
--- a/.gitignore
+++ b/.gitignore
@@ -127,4 +127,8 @@ dist
.yarn/unplugged
.yarn/build-state.yml
.yarn/install-state.gz
-.pnp.*
\ No newline at end of file
+.pnp.*
+/test-results/
+/playwright-report/
+/blob-report/
+/playwright/.cache/
diff --git a/README.md b/README.md
index b98557203..4810cdc71 100644
--- a/README.md
+++ b/README.md
@@ -5,7 +5,7 @@
### 1. Install the SDK
```shell
-npm i @auth0/nextjs-auth0
+npm i @auth0/nextjs-auth0@4.0.0-beta.4
```
### 2. Add the environment variables
diff --git a/e2e/app-router.spec.ts b/e2e/app-router.spec.ts
new file mode 100644
index 000000000..d9ee53ebd
--- /dev/null
+++ b/e2e/app-router.spec.ts
@@ -0,0 +1,103 @@
+import { expect, test } from "@playwright/test"
+
+test("getSession()", async ({ page }) => {
+ await page.goto("/auth/login?returnTo=/app-router/server")
+
+ // fill out Auth0 form
+ await page.fill('input[id="username"]', "test@example.com")
+ await page.fill('input[id="password"]', process.env.TEST_USER_PASSWORD!)
+ await page.getByText("Continue", { exact: true }).click()
+
+ // check that the page says "Welcome, test@example.com!"
+ expect(await page.getByRole("heading", { level: 1 }).textContent()).toBe(
+ "Welcome, test@example.com!"
+ )
+
+ // ensure we're redirected back to the home page on logout
+ await page.goto("/auth/logout")
+ expect(await page.getByRole("heading", { level: 1 }).textContent()).toBe(
+ "Home"
+ )
+
+ // check that `getSession()` returns null after logging out
+ await page.goto("/app-router/server")
+ expect(page.getByRole("link", { name: "Log in" })).toBeVisible()
+})
+
+test("useUser()", async ({ page }) => {
+ await page.goto("/auth/login?returnTo=/app-router/client")
+
+ // fill out Auth0 form
+ await page.fill('input[id="username"]', "test@example.com")
+ await page.fill('input[id="password"]', process.env.TEST_USER_PASSWORD!)
+ await page.getByText("Continue", { exact: true }).click()
+
+ // check that the page says "Welcome, test@example.com!"
+ expect(await page.getByRole("heading", { level: 1 }).textContent()).toBe(
+ "Welcome, test@example.com!"
+ )
+
+ // ensure we're redirected back to the home page on logout
+ await page.goto("/auth/logout")
+ expect(await page.getByRole("heading", { level: 1 }).textContent()).toBe(
+ "Home"
+ )
+
+ // check that `getSession()` returns null after logging out
+ await page.goto("/app-router/client")
+ expect(page.getByRole("link", { name: "Log in" })).toBeVisible()
+})
+
+test("getAccessToken()", async ({ page }) => {
+ await page.goto("/auth/login?returnTo=/app-router/client")
+
+ // fill out Auth0 form
+ await page.fill('input[id="username"]', "test@example.com")
+ await page.fill('input[id="password"]', process.env.TEST_USER_PASSWORD!)
+ await page.getByText("Continue", { exact: true }).click()
+
+ // fetch a token
+ const requestPromise = page.waitForRequest("/auth/access-token")
+ await page.getByText("Get token").click()
+ const request = await requestPromise
+ const tokenRequest = await (await request.response())?.json()
+ expect(tokenRequest).toHaveProperty("token")
+ expect(tokenRequest).toHaveProperty("expires_at")
+})
+
+test("protected server route", async ({ page, request, context }) => {
+ // before establishing a session, we should receive a 401
+ const unauthedRes = await context.request.fetch("/app-router/api/test")
+ expect(unauthedRes.status()).toBe(401)
+
+ await page.goto("/auth/login?returnTo=/app-router/server")
+
+ // fill out Auth0 form
+ await page.fill('input[id="username"]', "test@example.com")
+ await page.fill('input[id="password"]', process.env.TEST_USER_PASSWORD!)
+ await page.getByText("Continue", { exact: true }).click()
+
+ // after establishing a session, we should receive a 200
+ const authedRes = await context.request.fetch("/app-router/api/test")
+ expect(authedRes.status()).toBe(200)
+ expect(await authedRes.json()).toEqual({ email: "test@example.com" })
+})
+
+test("protected server action", async ({ page }) => {
+ await page.goto("/app-router/action")
+
+ // call protected server action
+ await page.getByText("Call server action").click()
+ await expect(page.locator("#status")).toHaveValue("unauthenticated")
+
+ await page.goto("/auth/login?returnTo=/app-router/action")
+
+ // fill out Auth0 form
+ await page.fill('input[id="username"]', "test@example.com")
+ await page.fill('input[id="password"]', process.env.TEST_USER_PASSWORD!)
+ await page.getByText("Continue", { exact: true }).click()
+
+ // call protected server action, now authenticated
+ await page.getByText("Call server action").click()
+ await expect(page.locator("#status")).toHaveValue("authenticated")
+})
diff --git a/e2e/pages-router.spec.ts b/e2e/pages-router.spec.ts
new file mode 100644
index 000000000..3deaef2f9
--- /dev/null
+++ b/e2e/pages-router.spec.ts
@@ -0,0 +1,84 @@
+import { expect, test } from "@playwright/test"
+
+test("getSession()", async ({ page }) => {
+ await page.goto("/auth/login?returnTo=/pages-router/server")
+
+ // fill out Auth0 form
+ await page.fill('input[id="username"]', "test@example.com")
+ await page.fill('input[id="password"]', process.env.TEST_USER_PASSWORD!)
+ await page.getByText("Continue", { exact: true }).click()
+
+ // check that the page says "Welcome, test@example.com!"
+ expect(await page.getByRole("heading", { level: 1 }).textContent()).toBe(
+ "Welcome, test@example.com!"
+ )
+
+ // ensure we're redirected back to the home page on logout
+ await page.goto("/auth/logout")
+ expect(await page.getByRole("heading", { level: 1 }).textContent()).toBe(
+ "Home"
+ )
+
+ // check that `getSession()` returns null after logging out
+ await page.goto("/pages-router/server")
+ expect(page.getByRole("link", { name: "Log in" })).toBeVisible()
+})
+
+test("useUser()", async ({ page }) => {
+ await page.goto("/auth/login?returnTo=/pages-router/client")
+
+ // fill out Auth0 form
+ await page.fill('input[id="username"]', "test@example.com")
+ await page.fill('input[id="password"]', process.env.TEST_USER_PASSWORD!)
+ await page.getByText("Continue", { exact: true }).click()
+
+ // check that the page says "Welcome, test@example.com!"
+ expect(await page.getByRole("heading", { level: 1 }).textContent()).toBe(
+ "Welcome, test@example.com!"
+ )
+
+ // ensure we're redirected back to the home page on logout
+ await page.goto("/auth/logout")
+ expect(await page.getByRole("heading", { level: 1 }).textContent()).toBe(
+ "Home"
+ )
+
+ // check that `getSession()` returns null after logging out
+ await page.goto("/pages-router/client")
+ expect(page.getByRole("link", { name: "Log in" })).toBeVisible()
+})
+
+test("getAccessToken()", async ({ page }) => {
+ await page.goto("/auth/login?returnTo=/pages-router/client")
+
+ // fill out Auth0 form
+ await page.fill('input[id="username"]', "test@example.com")
+ await page.fill('input[id="password"]', process.env.TEST_USER_PASSWORD!)
+ await page.getByText("Continue", { exact: true }).click()
+
+ // fetch a token
+ const requestPromise = page.waitForRequest("/auth/access-token")
+ await page.getByText("Get token").click()
+ const request = await requestPromise
+ const tokenRequest = await (await request.response())?.json()
+ expect(tokenRequest).toHaveProperty("token")
+ expect(tokenRequest).toHaveProperty("expires_at")
+})
+
+test("protected API route", async ({ page, request, context }) => {
+ // before establishing a session, we should receive a 401
+ const unauthedRes = await context.request.fetch("/api/pages-router/test")
+ expect(unauthedRes.status()).toBe(401)
+
+ await page.goto("/auth/login?returnTo=/pages-router/server")
+
+ // fill out Auth0 form
+ await page.fill('input[id="username"]', "test@example.com")
+ await page.fill('input[id="password"]', process.env.TEST_USER_PASSWORD!)
+ await page.getByText("Continue", { exact: true }).click()
+
+ // after establishing a session, we should receive a 200
+ const authedRes = await context.request.fetch("/api/pages-router/test")
+ expect(authedRes.status()).toBe(200)
+ expect(await authedRes.json()).toEqual({ email: "test@example.com" })
+})
diff --git a/e2e/test-app/.eslintrc.json b/e2e/test-app/.eslintrc.json
new file mode 100644
index 000000000..372241854
--- /dev/null
+++ b/e2e/test-app/.eslintrc.json
@@ -0,0 +1,3 @@
+{
+ "extends": ["next/core-web-vitals", "next/typescript"]
+}
diff --git a/e2e/test-app/.gitignore b/e2e/test-app/.gitignore
new file mode 100644
index 000000000..d32cc78b8
--- /dev/null
+++ b/e2e/test-app/.gitignore
@@ -0,0 +1,40 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.*
+.yarn/*
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/versions
+
+# testing
+/coverage
+
+# next.js
+/.next/
+/out/
+
+# production
+/build
+
+# misc
+.DS_Store
+*.pem
+
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# env files (can opt-in for committing if needed)
+.env*
+
+# vercel
+.vercel
+
+# typescript
+*.tsbuildinfo
+next-env.d.ts
diff --git a/e2e/test-app/README.md b/e2e/test-app/README.md
new file mode 100644
index 000000000..e215bc4cc
--- /dev/null
+++ b/e2e/test-app/README.md
@@ -0,0 +1,36 @@
+This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app).
+
+## Getting Started
+
+First, run the development server:
+
+```bash
+npm run dev
+# or
+yarn dev
+# or
+pnpm dev
+# or
+bun dev
+```
+
+Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
+
+You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
+
+This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel.
+
+## Learn More
+
+To learn more about Next.js, take a look at the following resources:
+
+- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
+- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
+
+You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome!
+
+## Deploy on Vercel
+
+The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
+
+Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details.
diff --git a/e2e/test-app/app/app-router/action/action.ts b/e2e/test-app/app/app-router/action/action.ts
new file mode 100644
index 000000000..cdcf82dac
--- /dev/null
+++ b/e2e/test-app/app/app-router/action/action.ts
@@ -0,0 +1,15 @@
+"use server"
+
+import { auth0 } from "@/lib/auth0"
+
+export async function testServerAction() {
+ const session = await auth0.getSession()
+
+ if (!session) {
+ return { status: "unauthenticated" }
+ }
+
+ return {
+ status: "authenticated",
+ }
+}
diff --git a/e2e/test-app/app/app-router/action/page.tsx b/e2e/test-app/app/app-router/action/page.tsx
new file mode 100644
index 000000000..11f98a3c9
--- /dev/null
+++ b/e2e/test-app/app/app-router/action/page.tsx
@@ -0,0 +1,27 @@
+"use client"
+
+import { useState } from "react"
+
+import { testServerAction } from "./action"
+
+export default function Profile() {
+ const [status, setStatus] = useState("")
+
+ return (
+
+ setStatus(e.target.value)}
+ >
+
+
+ )
+}
diff --git a/e2e/test-app/app/app-router/api/test/route.ts b/e2e/test-app/app/app-router/api/test/route.ts
new file mode 100644
index 000000000..33895f9f3
--- /dev/null
+++ b/e2e/test-app/app/app-router/api/test/route.ts
@@ -0,0 +1,13 @@
+import { NextResponse } from "next/server"
+
+import { auth0 } from "@/lib/auth0"
+
+export async function GET() {
+ const session = await auth0.getSession()
+
+ if (!session) {
+ return NextResponse.json({ error: "Unauthorized" }, { status: 401 })
+ }
+
+ return NextResponse.json({ email: session.user.email }, { status: 200 })
+}
diff --git a/e2e/test-app/app/app-router/client/page.tsx b/e2e/test-app/app/app-router/client/page.tsx
new file mode 100644
index 000000000..5b7a8e734
--- /dev/null
+++ b/e2e/test-app/app/app-router/client/page.tsx
@@ -0,0 +1,36 @@
+"use client"
+
+import { getAccessToken, useUser } from "@auth0/nextjs-auth0"
+
+export default function Profile() {
+ const { user, isLoading } = useUser()
+
+ if (isLoading) {
+ return (
+
+ Loading...
+
+ )
+ }
+
+ if (!user) {
+ return (
+
+ Log in
+
+ )
+ }
+
+ return (
+
+ Welcome, {user?.email}!
+
+
+ )
+}
diff --git a/e2e/test-app/app/app-router/server/page.tsx b/e2e/test-app/app/app-router/server/page.tsx
new file mode 100644
index 000000000..feae9c573
--- /dev/null
+++ b/e2e/test-app/app/app-router/server/page.tsx
@@ -0,0 +1,20 @@
+import { auth0 } from "@/lib/auth0"
+
+export default async function Home() {
+ const session = await auth0.getSession()
+
+ if (!session) {
+ return (
+
+ Sign up
+ Log in
+
+ )
+ }
+
+ return (
+
+ Welcome, {session.user.email}!
+
+ )
+}
diff --git a/e2e/test-app/app/favicon.ico b/e2e/test-app/app/favicon.ico
new file mode 100644
index 000000000..718d6fea4
Binary files /dev/null and b/e2e/test-app/app/favicon.ico differ
diff --git a/e2e/test-app/app/fonts/GeistMonoVF.woff b/e2e/test-app/app/fonts/GeistMonoVF.woff
new file mode 100644
index 000000000..f2ae185cb
Binary files /dev/null and b/e2e/test-app/app/fonts/GeistMonoVF.woff differ
diff --git a/e2e/test-app/app/fonts/GeistVF.woff b/e2e/test-app/app/fonts/GeistVF.woff
new file mode 100644
index 000000000..1b62daacf
Binary files /dev/null and b/e2e/test-app/app/fonts/GeistVF.woff differ
diff --git a/e2e/test-app/app/globals.css b/e2e/test-app/app/globals.css
new file mode 100644
index 000000000..6b717ad34
--- /dev/null
+++ b/e2e/test-app/app/globals.css
@@ -0,0 +1,21 @@
+@tailwind base;
+@tailwind components;
+@tailwind utilities;
+
+:root {
+ --background: #ffffff;
+ --foreground: #171717;
+}
+
+@media (prefers-color-scheme: dark) {
+ :root {
+ --background: #0a0a0a;
+ --foreground: #ededed;
+ }
+}
+
+body {
+ color: var(--foreground);
+ background: var(--background);
+ font-family: Arial, Helvetica, sans-serif;
+}
diff --git a/e2e/test-app/app/layout.tsx b/e2e/test-app/app/layout.tsx
new file mode 100644
index 000000000..a36cde01c
--- /dev/null
+++ b/e2e/test-app/app/layout.tsx
@@ -0,0 +1,35 @@
+import type { Metadata } from "next";
+import localFont from "next/font/local";
+import "./globals.css";
+
+const geistSans = localFont({
+ src: "./fonts/GeistVF.woff",
+ variable: "--font-geist-sans",
+ weight: "100 900",
+});
+const geistMono = localFont({
+ src: "./fonts/GeistMonoVF.woff",
+ variable: "--font-geist-mono",
+ weight: "100 900",
+});
+
+export const metadata: Metadata = {
+ title: "Create Next App",
+ description: "Generated by create next app",
+};
+
+export default function RootLayout({
+ children,
+}: Readonly<{
+ children: React.ReactNode;
+}>) {
+ return (
+
+
+ {children}
+
+
+ );
+}
diff --git a/e2e/test-app/app/page.tsx b/e2e/test-app/app/page.tsx
new file mode 100644
index 000000000..18c7f91be
--- /dev/null
+++ b/e2e/test-app/app/page.tsx
@@ -0,0 +1,3 @@
+export default async function Home() {
+ return Home
+}
diff --git a/e2e/test-app/lib/auth0.ts b/e2e/test-app/lib/auth0.ts
new file mode 100644
index 000000000..3d784ce17
--- /dev/null
+++ b/e2e/test-app/lib/auth0.ts
@@ -0,0 +1,3 @@
+import { Auth0Client } from "@auth0/nextjs-auth0/server"
+
+export const auth0 = new Auth0Client()
diff --git a/e2e/test-app/middleware.ts b/e2e/test-app/middleware.ts
new file mode 100644
index 000000000..f732b64a6
--- /dev/null
+++ b/e2e/test-app/middleware.ts
@@ -0,0 +1,19 @@
+import type { NextRequest } from "next/server"
+
+import { auth0 } from "./lib/auth0"
+
+export async function middleware(request: NextRequest) {
+ return await auth0.middleware(request)
+}
+
+export const config = {
+ matcher: [
+ /*
+ * Match all request paths except for the ones starting with:
+ * - _next/static (static files)
+ * - _next/image (image optimization files)
+ * - favicon.ico, sitemap.xml, robots.txt (metadata files)
+ */
+ "/((?!_next/static|_next/image|favicon.ico|sitemap.xml|robots.txt).*)",
+ ],
+}
diff --git a/e2e/test-app/next.config.ts b/e2e/test-app/next.config.ts
new file mode 100644
index 000000000..e9ffa3083
--- /dev/null
+++ b/e2e/test-app/next.config.ts
@@ -0,0 +1,7 @@
+import type { NextConfig } from "next";
+
+const nextConfig: NextConfig = {
+ /* config options here */
+};
+
+export default nextConfig;
diff --git a/e2e/test-app/package.json b/e2e/test-app/package.json
new file mode 100644
index 000000000..fef7b8b5d
--- /dev/null
+++ b/e2e/test-app/package.json
@@ -0,0 +1,27 @@
+{
+ "name": "test-app",
+ "version": "0.1.0",
+ "private": true,
+ "scripts": {
+ "dev": "next dev --turbopack",
+ "build": "next build",
+ "start": "next start",
+ "lint": "next lint"
+ },
+ "dependencies": {
+ "next": "file:../../node_modules/next",
+ "react": "file:../../node_modules/react",
+ "react-dom": "file:../../node_modules/react-dom",
+ "@auth0/nextjs-auth0": "file:../../"
+ },
+ "devDependencies": {
+ "typescript": "^5",
+ "@types/node": "file:../../node_modules/@types/node",
+ "@types/react": "file:../../node_modules/@types/react",
+ "@types/react-dom": "file:../../node_modules/@types/react-dom",
+ "postcss": "^8",
+ "tailwindcss": "^3.4.1",
+ "eslint": "^8",
+ "eslint-config-next": "15.0.3"
+ }
+}
diff --git a/e2e/test-app/pages/_app.tsx b/e2e/test-app/pages/_app.tsx
new file mode 100644
index 000000000..09e304a14
--- /dev/null
+++ b/e2e/test-app/pages/_app.tsx
@@ -0,0 +1,7 @@
+import "./globals.css"
+
+import type { AppProps } from "next/app"
+
+export default function App({ Component, pageProps }: AppProps) {
+ return
+}
diff --git a/e2e/test-app/pages/_document.tsx b/e2e/test-app/pages/_document.tsx
new file mode 100644
index 000000000..628a7334c
--- /dev/null
+++ b/e2e/test-app/pages/_document.tsx
@@ -0,0 +1,13 @@
+import { Html, Head, Main, NextScript } from "next/document";
+
+export default function Document() {
+ return (
+
+
+