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
5 changes: 5 additions & 0 deletions .changeset/floppy-buckets-help.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
"@clerk/astro": major
---

Add support for Astro 7 and drop support for Astro 4. If you are still on Astro 4, follow the [Astro upgrade guide](https://docs.astro.build/en/guides/upgrade-to/v6/) to upgrade your project before updating `@clerk/astro`.
43 changes: 43 additions & 0 deletions .changeset/major-astro-remove-route-matcher.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
---
'@clerk/astro': major
---

Remove `createRouteMatcher` from `@clerk/astro/server`. Use resource-based auth checks instead: move auth checks into each Astro page, API route, or server-side handler that accesses protected data. Middleware-based auth checks rely on path matching, which can diverge from how Astro routes requests and leave protected resources reachable.

```ts
import type { APIRoute } from 'astro';

export const GET: APIRoute = ({ locals }) => {
const { userId } = locals.auth();

if (!userId) {
return new Response('Unauthorized', { status: 401 });
}

return Response.json({ userId });
};
```

If you want to hand this work to a coding agent, use this migration prompt:

```md
Migrate my Astro project away from Clerk's removed `createRouteMatcher` API.

1. Open `src/middleware.ts` (or `src/middleware.js`) and find every matcher created
with `createRouteMatcher` from `@clerk/astro/server`, along with the middleware
logic that uses it (returning 401s, calling `auth().redirectToSignIn()`, etc.).
2. For every route those matchers protected, move the auth check into the resource itself:
- In `.astro` pages, add this to the frontmatter:
const { userId, redirectToSignIn } = Astro.locals.auth();
if (!userId) return redirectToSignIn();
- In API routes and server handlers, add this at the top of the handler:
const { userId } = locals.auth();
if (!userId) return new Response('Unauthorized', { status: 401 });
- Keep any role or permission checks (`auth().has(...)`) with the resource as well.
3. Remove the `createRouteMatcher` import and calls from the middleware. Keep
`clerkMiddleware()` itself. Middleware logic unrelated to auth protection
(locale redirects, headers, etc.) may stay, using plain `URL`/pathname checks.
4. Make sure every page and endpoint previously covered by a matcher pattern
(including glob patterns like `/dashboard(.*)`) now has its own check, then
verify the project builds.
```
3 changes: 0 additions & 3 deletions integration/templates/astro-node/astro.config.mjs

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

dont need tailwind in this...

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,8 +3,6 @@ import node from '@astrojs/node';
import clerk from '@clerk/astro';
import react from '@astrojs/react';

import tailwind from '@astrojs/tailwind';

export default defineConfig({
output: 'server',
adapter: node({
Expand All@@ -19,7 +17,6 @@ export default defineConfig({
},
}),
react(),
tailwind(),
],
server: {
port: process.env.PORT ? Number(process.env.PORT) : undefined,
Expand Down
10 changes: 4 additions & 6 deletions integration/templates/astro-node/package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,16 +10,14 @@
"start": "astro dev --port $PORT"
},
"dependencies": {
"@astrojs/check": "^0.9.4",
"@astrojs/node": "^9.0.0",
"@astrojs/react": "^4.0.0",
"@astrojs/tailwind": "^5.1.3",
"@astrojs/check": "^0.9.9",
"@astrojs/node": "^11.0.0",
"@astrojs/react": "^6.0.0",
"@types/react": "18.3.7",
"@types/react-dom": "18.3.0",
"astro": "^5.15.9",
"astro": "^7.0.2",
"react": "18.3.1",
"react-dom": "18.3.1",
"tailwindcss": "^3.4.17",
"typescript": "^5.7.3"
}
}
30 changes: 2 additions & 28 deletions integration/templates/astro-node/src/middleware.ts
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,9 @@
import { clerkMiddleware, createRouteMatcher } from '@clerk/astro/server';

const unautorized = () =>
new Response(JSON.stringify({ error: 'unathorized access' }), {
status: 401,
});

/**
* 3. Support handler
*/
const isProtectedPage = createRouteMatcher(['/user(.*)', '/discover(.*)']);

const isProtectedApiRoute = createRouteMatcher(['/api/protected(.*)']);
import { clerkMiddleware } from '@clerk/astro/server';

export const onRequest = clerkMiddleware((auth, context, next) => {
const requestURL = new URL(context.request.url);
if (['/sign-in', '/', '/sign-up'].includes(requestURL.pathname)) {
return next();
}

if (isProtectedApiRoute(context.request) && !auth().userId) {
return unautorized();
}

if (isProtectedPage(context.request) && !auth().userId) {
return auth().redirectToSignIn();
}

if (!auth().orgId && requestURL.pathname !== '/discover' && requestURL.pathname === '/organization') {
if (!auth().userId) {
return next();
}
if (requestURL.pathname === '/organization' && auth().userId && !auth().orgId) {
const searchParams = new URLSearchParams({
redirectUrl: requestURL.href,
});
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,13 @@
import type { APIRoute } from 'astro';
import { clerkClient } from '@clerk/astro/server';

const empty = () => new Response(null);

export const GET: APIRoute = async context => {
const { locals } = context;
const { userId, orgId } = locals.auth();
if (!userId) {
// We are handling this at the middleware level
return empty();
return new Response(JSON.stringify({ error: 'unauthorized access' }), {
status: 401,
});
}

if (!orgId) {
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,12 @@ export const GET: APIRoute = async context => {
const { locals } = context;
const { auth } = locals;

if (!auth().userId) {
return new Response(JSON.stringify({ error: 'unauthorized access' }), {
status: 401,
});
}

if (auth().has({ role: 'org:admin' })) {
return new Response(
JSON.stringify(
Expand Down
6 changes: 6 additions & 0 deletions integration/templates/astro-node/src/pages/discover.astro
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
---
import { OrganizationList } from '@clerk/astro/components';
import Layout from '../layouts/Layout.astro';

const { userId, redirectToSignIn } = Astro.locals.auth();

if (!userId) {
return redirectToSignIn();
}
Comment thread
coderabbitai[bot] marked this conversation as resolved.
---

<Layout title='Welcome to Astro.'>
Expand Down
6 changes: 6 additions & 0 deletions integration/templates/astro-node/src/pages/user.astro
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,12 @@
import { UserProfile } from '@clerk/astro/components';
import Layout from '../layouts/Layout.astro';
import StreamUser from '../components/StreamUser.astro';

const { userId, redirectToSignIn } = Astro.locals.auth();

if (!userId) {
return redirectToSignIn();
}
---

<Layout title='Welcome to Astro.'>
Expand Down
38 changes: 0 additions & 38 deletions integration/templates/astro-node/tailwind.config.cjs

This file was deleted.

7 changes: 5 additions & 2 deletions integration/testUtils/machineAuthHelpers.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -262,6 +262,7 @@ export const registerApiKeyAuthTests = (adapter: MachineAuthTestAdapter): void =
test('should handle multiple token types', async ({ page, context }) => {
const u = createTestUtils({ app, page, context });
const url = new URL(adapter.apiKey.path, app.serverUrl).toString();
const origin = new URL(app.serverUrl).origin;

await u.po.signIn.goTo();
await u.po.signIn.waitForMounted();
Expand All@@ -271,14 +272,16 @@ export const registerApiKeyAuthTests = (adapter: MachineAuthTestAdapter): void =
const getRes = await u.page.request.get(url);
expect(getRes.status()).toBe(401);

const postWithSessionRes = await u.page.request.post(url);
const postWithSessionRes = await u.page.request.post(url, {
headers: { Origin: origin },
});
const sessionData = await postWithSessionRes.json();
expect(postWithSessionRes.status()).toBe(200);
expect(sessionData.userId).toBe(fakeBapiUser.id);
expect(sessionData.tokenType).toBe(TokenType.SessionToken);
Comment on lines +275 to 281

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🩺 Stability & Availability | 🟡 Minor | ⚡ Quick win

Assert response status before parsing JSON bodies in POST branches.

json() can throw on non-JSON error responses before the status assertion runs, which obscures the real failure. Assert status first, then parse.

Suggested patch
 const postWithSessionRes = await u.page.request.post(url, {
headers: { Origin: origin },
});
- const sessionData = await postWithSessionRes.json();
expect(postWithSessionRes.status()).toBe(200);
+ const sessionData = await postWithSessionRes.json();
expect(sessionData.userId).toBe(fakeBapiUser.id);
expect(sessionData.tokenType).toBe(TokenType.SessionToken);
const postWithApiKeyRes = await u.page.request.post(url, {
headers: { Authorization: `Bearer ${fakeAPIKey.secret}`, Origin: origin },
});
- const apiKeyData = await postWithApiKeyRes.json();
expect(postWithApiKeyRes.status()).toBe(200);
+ const apiKeyData = await postWithApiKeyRes.json();
expect(apiKeyData.userId).toBe(fakeBapiUser.id);
expect(apiKeyData.tokenType).toBe(TokenType.ApiKey);

Also applies to: 283-285

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@integration/testUtils/machineAuthHelpers.ts` around lines 275 - 281, In the
POST request handling blocks, the status assertion must be moved before the JSON
parsing. Currently, the code calls postWithSessionRes.json() before checking
postWithSessionRes.status(), which means if the response is an error, the json()
call may fail before the status assertion runs, obscuring the actual failure.
Reorder the statements so that expect(postWithSessionRes.status()).toBe(200) is
called immediately after the post request completes, before calling await
postWithSessionRes.json(). Apply this same fix to both the postWithSessionRes
block and the similar block referenced in the "Also applies to" comment.


const postWithApiKeyRes = await u.page.request.post(url, {
headers: { Authorization: `Bearer ${fakeAPIKey.secret}` },
headers: { Authorization: `Bearer ${fakeAPIKey.secret}`, Origin: origin },
});
const apiKeyData = await postWithApiKeyRes.json();
expect(postWithApiKeyRes.status()).toBe(200);
Expand Down
36 changes: 36 additions & 0 deletions integration/tests/astro/compatibility.test.ts

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Astro v6 compatibility smoke test

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
import { expect, test } from '@playwright/test';

import type { Application } from '../../models/application';
import { appConfigs } from '../../presets';

test.describe('Astro version compatibility @astro', () => {
test.describe.configure({ mode: 'serial' });

let app: Application;

test.beforeAll(async () => {
test.setTimeout(120_000);

app = await appConfigs.astro.node
.clone()
.setName('astro-node-v6-smoke')
.addDependency('astro', '^6.4.8')
.addDependency('@astrojs/node', '^10.1.4')
.addDependency('@astrojs/react', '^5.0.7')
.commit();

await app.setup();
await app.withEnv(appConfigs.envs.withCustomRoles);
});

test.afterAll(async () => {
await app.teardown();
});

test('builds with Astro 6 and custom UserButton menu items', async () => {
await app.build();

expect(app.buildOutput).not.toHaveLength(0);
expect(app.buildOutput).not.toContain('Illegal return statement');
});
});
9 changes: 8 additions & 1 deletion integration/tests/astro/components.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -416,7 +416,7 @@ testAgainstRunningApps({ withPattern: ['astro.node.withCustomRoles'] })('basic f
});

// ----- redirect
test('redirects to sign-in when unauthenticated (middleware)', async ({ page, context }) => {
test('redirects to sign-in when unauthenticated (user page)', async ({ page, context }) => {
const u = createTestUtils({ app, page, context });
await u.page.goToAppHome();
await u.page.getByRole('link', { name: 'User', exact: true }).click();
Expand All@@ -432,6 +432,13 @@ testAgainstRunningApps({ withPattern: ['astro.node.withCustomRoles'] })('basic f
);
});

test('redirects to sign-in when unauthenticated (discover page)', async ({ page, context }) => {
const u = createTestUtils({ app, page, context });
await u.page.goToRelative('/discover');
await u.page.waitForURL(`${app.serverUrl}/sign-in?redirect_url=${encodeURIComponent(`${app.serverUrl}/discover`)}`);
await u.po.signIn.waitForMounted();
});

// ---- protect
test('only admin', async ({ page, context }) => {
const u = createTestUtils({ app, page, context });
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
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
5 changes: 5 additions & 0 deletions .changeset/floppy-buckets-help.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
"@clerk/astro": major
---

Add support for Astro 7 and drop support for Astro 4. If you are still on Astro 4, follow the [Astro upgrade guide](https://docs.astro.build/en/guides/upgrade-to/v6/) to upgrade your project before updating `@clerk/astro`.
43 changes: 43 additions & 0 deletions .changeset/major-astro-remove-route-matcher.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
---
'@clerk/astro': major
---

Remove `createRouteMatcher` from `@clerk/astro/server`. Use resource-based auth checks instead: move auth checks into each Astro page, API route, or server-side handler that accesses protected data. Middleware-based auth checks rely on path matching, which can diverge from how Astro routes requests and leave protected resources reachable.

```ts
import type { APIRoute } from 'astro';

export const GET: APIRoute = ({ locals }) => {
const { userId } = locals.auth();

if (!userId) {
return new Response('Unauthorized', { status: 401 });
}

return Response.json({ userId });
};
```

If you want to hand this work to a coding agent, use this migration prompt:

```md
Migrate my Astro project away from Clerk's removed `createRouteMatcher` API.

1. Open `src/middleware.ts` (or `src/middleware.js`) and find every matcher created
with `createRouteMatcher` from `@clerk/astro/server`, along with the middleware
logic that uses it (returning 401s, calling `auth().redirectToSignIn()`, etc.).
2. For every route those matchers protected, move the auth check into the resource itself:
- In `.astro` pages, add this to the frontmatter:
const { userId, redirectToSignIn } = Astro.locals.auth();
if (!userId) return redirectToSignIn();
- In API routes and server handlers, add this at the top of the handler:
const { userId } = locals.auth();
if (!userId) return new Response('Unauthorized', { status: 401 });
- Keep any role or permission checks (`auth().has(...)`) with the resource as well.
3. Remove the `createRouteMatcher` import and calls from the middleware. Keep
`clerkMiddleware()` itself. Middleware logic unrelated to auth protection
(locale redirects, headers, etc.) may stay, using plain `URL`/pathname checks.
4. Make sure every page and endpoint previously covered by a matcher pattern
(including glob patterns like `/dashboard(.*)`) now has its own check, then
verify the project builds.
```
3 changes: 0 additions & 3 deletions integration/templates/astro-node/astro.config.mjs

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

dont need tailwind in this...

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,8 +3,6 @@ import node from '@astrojs/node';
import clerk from '@clerk/astro';
import react from '@astrojs/react';

import tailwind from '@astrojs/tailwind';

export default defineConfig({
output: 'server',
adapter: node({
Expand All@@ -19,7 +17,6 @@ export default defineConfig({
},
}),
react(),
tailwind(),
],
server: {
port: process.env.PORT ? Number(process.env.PORT) : undefined,
Expand Down
10 changes: 4 additions & 6 deletions integration/templates/astro-node/package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,16 +10,14 @@
"start": "astro dev --port $PORT"
},
"dependencies": {
"@astrojs/check": "^0.9.4",
"@astrojs/node": "^9.0.0",
"@astrojs/react": "^4.0.0",
"@astrojs/tailwind": "^5.1.3",
"@astrojs/check": "^0.9.9",
"@astrojs/node": "^11.0.0",
"@astrojs/react": "^6.0.0",
"@types/react": "18.3.7",
"@types/react-dom": "18.3.0",
"astro": "^5.15.9",
"astro": "^7.0.2",
"react": "18.3.1",
"react-dom": "18.3.1",
"tailwindcss": "^3.4.17",
"typescript": "^5.7.3"
}
}
30 changes: 2 additions & 28 deletions integration/templates/astro-node/src/middleware.ts
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,9 @@
import { clerkMiddleware, createRouteMatcher } from '@clerk/astro/server';

const unautorized = () =>
new Response(JSON.stringify({ error: 'unathorized access' }), {
status: 401,
});

/**
* 3. Support handler
*/
const isProtectedPage = createRouteMatcher(['/user(.*)', '/discover(.*)']);

const isProtectedApiRoute = createRouteMatcher(['/api/protected(.*)']);
import { clerkMiddleware } from '@clerk/astro/server';

export const onRequest = clerkMiddleware((auth, context, next) => {
const requestURL = new URL(context.request.url);
if (['/sign-in', '/', '/sign-up'].includes(requestURL.pathname)) {
return next();
}

if (isProtectedApiRoute(context.request) && !auth().userId) {
return unautorized();
}

if (isProtectedPage(context.request) && !auth().userId) {
return auth().redirectToSignIn();
}

if (!auth().orgId && requestURL.pathname !== '/discover' && requestURL.pathname === '/organization') {
if (!auth().userId) {
return next();
}
if (requestURL.pathname === '/organization' && auth().userId && !auth().orgId) {
const searchParams = new URLSearchParams({
redirectUrl: requestURL.href,
});
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,13 @@
import type { APIRoute } from 'astro';
import { clerkClient } from '@clerk/astro/server';

const empty = () => new Response(null);

export const GET: APIRoute = async context => {
const { locals } = context;
const { userId, orgId } = locals.auth();
if (!userId) {
// We are handling this at the middleware level
return empty();
return new Response(JSON.stringify({ error: 'unauthorized access' }), {
status: 401,
});
}

if (!orgId) {
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,12 @@ export const GET: APIRoute = async context => {
const { locals } = context;
const { auth } = locals;

if (!auth().userId) {
return new Response(JSON.stringify({ error: 'unauthorized access' }), {
status: 401,
});
}

if (auth().has({ role: 'org:admin' })) {
return new Response(
JSON.stringify(
Expand Down
6 changes: 6 additions & 0 deletions integration/templates/astro-node/src/pages/discover.astro
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
---
import { OrganizationList } from '@clerk/astro/components';
import Layout from '../layouts/Layout.astro';

const { userId, redirectToSignIn } = Astro.locals.auth();

if (!userId) {
return redirectToSignIn();
}
Comment thread
coderabbitai[bot] marked this conversation as resolved.
---

<Layout title='Welcome to Astro.'>
Expand Down
6 changes: 6 additions & 0 deletions integration/templates/astro-node/src/pages/user.astro
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,12 @@
import { UserProfile } from '@clerk/astro/components';
import Layout from '../layouts/Layout.astro';
import StreamUser from '../components/StreamUser.astro';

const { userId, redirectToSignIn } = Astro.locals.auth();

if (!userId) {
return redirectToSignIn();
}
---

<Layout title='Welcome to Astro.'>
Expand Down
38 changes: 0 additions & 38 deletions integration/templates/astro-node/tailwind.config.cjs

This file was deleted.

7 changes: 5 additions & 2 deletions integration/testUtils/machineAuthHelpers.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -262,6 +262,7 @@ export const registerApiKeyAuthTests = (adapter: MachineAuthTestAdapter): void =
test('should handle multiple token types', async ({ page, context }) => {
const u = createTestUtils({ app, page, context });
const url = new URL(adapter.apiKey.path, app.serverUrl).toString();
const origin = new URL(app.serverUrl).origin;

await u.po.signIn.goTo();
await u.po.signIn.waitForMounted();
Expand All@@ -271,14 +272,16 @@ export const registerApiKeyAuthTests = (adapter: MachineAuthTestAdapter): void =
const getRes = await u.page.request.get(url);
expect(getRes.status()).toBe(401);

const postWithSessionRes = await u.page.request.post(url);
const postWithSessionRes = await u.page.request.post(url, {
headers: { Origin: origin },
});
const sessionData = await postWithSessionRes.json();
expect(postWithSessionRes.status()).toBe(200);
expect(sessionData.userId).toBe(fakeBapiUser.id);
expect(sessionData.tokenType).toBe(TokenType.SessionToken);
Comment on lines +275 to 281

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🩺 Stability & Availability | 🟡 Minor | ⚡ Quick win

Assert response status before parsing JSON bodies in POST branches.

json() can throw on non-JSON error responses before the status assertion runs, which obscures the real failure. Assert status first, then parse.

Suggested patch
 const postWithSessionRes = await u.page.request.post(url, {
headers: { Origin: origin },
});
- const sessionData = await postWithSessionRes.json();
expect(postWithSessionRes.status()).toBe(200);
+ const sessionData = await postWithSessionRes.json();
expect(sessionData.userId).toBe(fakeBapiUser.id);
expect(sessionData.tokenType).toBe(TokenType.SessionToken);
const postWithApiKeyRes = await u.page.request.post(url, {
headers: { Authorization: `Bearer ${fakeAPIKey.secret}`, Origin: origin },
});
- const apiKeyData = await postWithApiKeyRes.json();
expect(postWithApiKeyRes.status()).toBe(200);
+ const apiKeyData = await postWithApiKeyRes.json();
expect(apiKeyData.userId).toBe(fakeBapiUser.id);
expect(apiKeyData.tokenType).toBe(TokenType.ApiKey);

Also applies to: 283-285

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@integration/testUtils/machineAuthHelpers.ts` around lines 275 - 281, In the
POST request handling blocks, the status assertion must be moved before the JSON
parsing. Currently, the code calls postWithSessionRes.json() before checking
postWithSessionRes.status(), which means if the response is an error, the json()
call may fail before the status assertion runs, obscuring the actual failure.
Reorder the statements so that expect(postWithSessionRes.status()).toBe(200) is
called immediately after the post request completes, before calling await
postWithSessionRes.json(). Apply this same fix to both the postWithSessionRes
block and the similar block referenced in the "Also applies to" comment.


const postWithApiKeyRes = await u.page.request.post(url, {
headers: { Authorization: `Bearer ${fakeAPIKey.secret}` },
headers: { Authorization: `Bearer ${fakeAPIKey.secret}`, Origin: origin },
});
const apiKeyData = await postWithApiKeyRes.json();
expect(postWithApiKeyRes.status()).toBe(200);
Expand Down
36 changes: 36 additions & 0 deletions integration/tests/astro/compatibility.test.ts

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Astro v6 compatibility smoke test

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
import { expect, test } from '@playwright/test';

import type { Application } from '../../models/application';
import { appConfigs } from '../../presets';

test.describe('Astro version compatibility @astro', () => {
test.describe.configure({ mode: 'serial' });

let app: Application;

test.beforeAll(async () => {
test.setTimeout(120_000);

app = await appConfigs.astro.node
.clone()
.setName('astro-node-v6-smoke')
.addDependency('astro', '^6.4.8')
.addDependency('@astrojs/node', '^10.1.4')
.addDependency('@astrojs/react', '^5.0.7')
.commit();

await app.setup();
await app.withEnv(appConfigs.envs.withCustomRoles);
});

test.afterAll(async () => {
await app.teardown();
});

test('builds with Astro 6 and custom UserButton menu items', async () => {
await app.build();

expect(app.buildOutput).not.toHaveLength(0);
expect(app.buildOutput).not.toContain('Illegal return statement');
});
});
9 changes: 8 additions & 1 deletion integration/tests/astro/components.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -416,7 +416,7 @@ testAgainstRunningApps({ withPattern: ['astro.node.withCustomRoles'] })('basic f
});

// ----- redirect
test('redirects to sign-in when unauthenticated (middleware)', async ({ page, context }) => {
test('redirects to sign-in when unauthenticated (user page)', async ({ page, context }) => {
const u = createTestUtils({ app, page, context });
await u.page.goToAppHome();
await u.page.getByRole('link', { name: 'User', exact: true }).click();
Expand All@@ -432,6 +432,13 @@ testAgainstRunningApps({ withPattern: ['astro.node.withCustomRoles'] })('basic f
);
});

test('redirects to sign-in when unauthenticated (discover page)', async ({ page, context }) => {
const u = createTestUtils({ app, page, context });
await u.page.goToRelative('/discover');
await u.page.waitForURL(`${app.serverUrl}/sign-in?redirect_url=${encodeURIComponent(`${app.serverUrl}/discover`)}`);
await u.po.signIn.waitForMounted();
});

// ---- protect
test('only admin', async ({ page, context }) => {
const u = createTestUtils({ app, page, context });
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
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
5 changes: 5 additions & 0 deletions .changeset/floppy-buckets-help.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
"@clerk/astro": major
---

Add support for Astro 7 and drop support for Astro 4. If you are still on Astro 4, follow the [Astro upgrade guide](https://docs.astro.build/en/guides/upgrade-to/v6/) to upgrade your project before updating `@clerk/astro`.
43 changes: 43 additions & 0 deletions .changeset/major-astro-remove-route-matcher.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
---
'@clerk/astro': major
---

Remove `createRouteMatcher` from `@clerk/astro/server`. Use resource-based auth checks instead: move auth checks into each Astro page, API route, or server-side handler that accesses protected data. Middleware-based auth checks rely on path matching, which can diverge from how Astro routes requests and leave protected resources reachable.

```ts
import type { APIRoute } from 'astro';

export const GET: APIRoute = ({ locals }) => {
const { userId } = locals.auth();

if (!userId) {
return new Response('Unauthorized', { status: 401 });
}

return Response.json({ userId });
};
```

If you want to hand this work to a coding agent, use this migration prompt:

```md
Migrate my Astro project away from Clerk's removed `createRouteMatcher` API.

1. Open `src/middleware.ts` (or `src/middleware.js`) and find every matcher created
with `createRouteMatcher` from `@clerk/astro/server`, along with the middleware
logic that uses it (returning 401s, calling `auth().redirectToSignIn()`, etc.).
2. For every route those matchers protected, move the auth check into the resource itself:
- In `.astro` pages, add this to the frontmatter:
const { userId, redirectToSignIn } = Astro.locals.auth();
if (!userId) return redirectToSignIn();
- In API routes and server handlers, add this at the top of the handler:
const { userId } = locals.auth();
if (!userId) return new Response('Unauthorized', { status: 401 });
- Keep any role or permission checks (`auth().has(...)`) with the resource as well.
3. Remove the `createRouteMatcher` import and calls from the middleware. Keep
`clerkMiddleware()` itself. Middleware logic unrelated to auth protection
(locale redirects, headers, etc.) may stay, using plain `URL`/pathname checks.
4. Make sure every page and endpoint previously covered by a matcher pattern
(including glob patterns like `/dashboard(.*)`) now has its own check, then
verify the project builds.
```
3 changes: 0 additions & 3 deletions integration/templates/astro-node/astro.config.mjs

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

dont need tailwind in this...

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,8 +3,6 @@ import node from '@astrojs/node';
import clerk from '@clerk/astro';
import react from '@astrojs/react';

import tailwind from '@astrojs/tailwind';

export default defineConfig({
output: 'server',
adapter: node({
Expand All@@ -19,7 +17,6 @@ export default defineConfig({
},
}),
react(),
tailwind(),
],
server: {
port: process.env.PORT ? Number(process.env.PORT) : undefined,
Expand Down
10 changes: 4 additions & 6 deletions integration/templates/astro-node/package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,16 +10,14 @@
"start": "astro dev --port $PORT"
},
"dependencies": {
"@astrojs/check": "^0.9.4",
"@astrojs/node": "^9.0.0",
"@astrojs/react": "^4.0.0",
"@astrojs/tailwind": "^5.1.3",
"@astrojs/check": "^0.9.9",
"@astrojs/node": "^11.0.0",
"@astrojs/react": "^6.0.0",
"@types/react": "18.3.7",
"@types/react-dom": "18.3.0",
"astro": "^5.15.9",
"astro": "^7.0.2",
"react": "18.3.1",
"react-dom": "18.3.1",
"tailwindcss": "^3.4.17",
"typescript": "^5.7.3"
}
}
30 changes: 2 additions & 28 deletions integration/templates/astro-node/src/middleware.ts
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,9 @@
import { clerkMiddleware, createRouteMatcher } from '@clerk/astro/server';

const unautorized = () =>
new Response(JSON.stringify({ error: 'unathorized access' }), {
status: 401,
});

/**
* 3. Support handler
*/
const isProtectedPage = createRouteMatcher(['/user(.*)', '/discover(.*)']);

const isProtectedApiRoute = createRouteMatcher(['/api/protected(.*)']);
import { clerkMiddleware } from '@clerk/astro/server';

export const onRequest = clerkMiddleware((auth, context, next) => {
const requestURL = new URL(context.request.url);
if (['/sign-in', '/', '/sign-up'].includes(requestURL.pathname)) {
return next();
}

if (isProtectedApiRoute(context.request) && !auth().userId) {
return unautorized();
}

if (isProtectedPage(context.request) && !auth().userId) {
return auth().redirectToSignIn();
}

if (!auth().orgId && requestURL.pathname !== '/discover' && requestURL.pathname === '/organization') {
if (!auth().userId) {
return next();
}
if (requestURL.pathname === '/organization' && auth().userId && !auth().orgId) {
const searchParams = new URLSearchParams({
redirectUrl: requestURL.href,
});
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,13 @@
import type { APIRoute } from 'astro';
import { clerkClient } from '@clerk/astro/server';

const empty = () => new Response(null);

export const GET: APIRoute = async context => {
const { locals } = context;
const { userId, orgId } = locals.auth();
if (!userId) {
// We are handling this at the middleware level
return empty();
return new Response(JSON.stringify({ error: 'unauthorized access' }), {
status: 401,
});
}

if (!orgId) {
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,12 @@ export const GET: APIRoute = async context => {
const { locals } = context;
const { auth } = locals;

if (!auth().userId) {
return new Response(JSON.stringify({ error: 'unauthorized access' }), {
status: 401,
});
}

if (auth().has({ role: 'org:admin' })) {
return new Response(
JSON.stringify(
Expand Down
6 changes: 6 additions & 0 deletions integration/templates/astro-node/src/pages/discover.astro
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
---
import { OrganizationList } from '@clerk/astro/components';
import Layout from '../layouts/Layout.astro';

const { userId, redirectToSignIn } = Astro.locals.auth();

if (!userId) {
return redirectToSignIn();
}
Comment thread
coderabbitai[bot] marked this conversation as resolved.
---

<Layout title='Welcome to Astro.'>
Expand Down
6 changes: 6 additions & 0 deletions integration/templates/astro-node/src/pages/user.astro
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,12 @@
import { UserProfile } from '@clerk/astro/components';
import Layout from '../layouts/Layout.astro';
import StreamUser from '../components/StreamUser.astro';

const { userId, redirectToSignIn } = Astro.locals.auth();

if (!userId) {
return redirectToSignIn();
}
---

<Layout title='Welcome to Astro.'>
Expand Down
38 changes: 0 additions & 38 deletions integration/templates/astro-node/tailwind.config.cjs

This file was deleted.

7 changes: 5 additions & 2 deletions integration/testUtils/machineAuthHelpers.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -262,6 +262,7 @@ export const registerApiKeyAuthTests = (adapter: MachineAuthTestAdapter): void =
test('should handle multiple token types', async ({ page, context }) => {
const u = createTestUtils({ app, page, context });
const url = new URL(adapter.apiKey.path, app.serverUrl).toString();
const origin = new URL(app.serverUrl).origin;

await u.po.signIn.goTo();
await u.po.signIn.waitForMounted();
Expand All@@ -271,14 +272,16 @@ export const registerApiKeyAuthTests = (adapter: MachineAuthTestAdapter): void =
const getRes = await u.page.request.get(url);
expect(getRes.status()).toBe(401);

const postWithSessionRes = await u.page.request.post(url);
const postWithSessionRes = await u.page.request.post(url, {
headers: { Origin: origin },
});
const sessionData = await postWithSessionRes.json();
expect(postWithSessionRes.status()).toBe(200);
expect(sessionData.userId).toBe(fakeBapiUser.id);
expect(sessionData.tokenType).toBe(TokenType.SessionToken);
Comment on lines +275 to 281

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🩺 Stability & Availability | 🟡 Minor | ⚡ Quick win

Assert response status before parsing JSON bodies in POST branches.

json() can throw on non-JSON error responses before the status assertion runs, which obscures the real failure. Assert status first, then parse.

Suggested patch
 const postWithSessionRes = await u.page.request.post(url, {
headers: { Origin: origin },
});
- const sessionData = await postWithSessionRes.json();
expect(postWithSessionRes.status()).toBe(200);
+ const sessionData = await postWithSessionRes.json();
expect(sessionData.userId).toBe(fakeBapiUser.id);
expect(sessionData.tokenType).toBe(TokenType.SessionToken);
const postWithApiKeyRes = await u.page.request.post(url, {
headers: { Authorization: `Bearer ${fakeAPIKey.secret}`, Origin: origin },
});
- const apiKeyData = await postWithApiKeyRes.json();
expect(postWithApiKeyRes.status()).toBe(200);
+ const apiKeyData = await postWithApiKeyRes.json();
expect(apiKeyData.userId).toBe(fakeBapiUser.id);
expect(apiKeyData.tokenType).toBe(TokenType.ApiKey);

Also applies to: 283-285

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@integration/testUtils/machineAuthHelpers.ts` around lines 275 - 281, In the
POST request handling blocks, the status assertion must be moved before the JSON
parsing. Currently, the code calls postWithSessionRes.json() before checking
postWithSessionRes.status(), which means if the response is an error, the json()
call may fail before the status assertion runs, obscuring the actual failure.
Reorder the statements so that expect(postWithSessionRes.status()).toBe(200) is
called immediately after the post request completes, before calling await
postWithSessionRes.json(). Apply this same fix to both the postWithSessionRes
block and the similar block referenced in the "Also applies to" comment.


const postWithApiKeyRes = await u.page.request.post(url, {
headers: { Authorization: `Bearer ${fakeAPIKey.secret}` },
headers: { Authorization: `Bearer ${fakeAPIKey.secret}`, Origin: origin },
});
const apiKeyData = await postWithApiKeyRes.json();
expect(postWithApiKeyRes.status()).toBe(200);
Expand Down
36 changes: 36 additions & 0 deletions integration/tests/astro/compatibility.test.ts

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Astro v6 compatibility smoke test

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
import { expect, test } from '@playwright/test';

import type { Application } from '../../models/application';
import { appConfigs } from '../../presets';

test.describe('Astro version compatibility @astro', () => {
test.describe.configure({ mode: 'serial' });

let app: Application;

test.beforeAll(async () => {
test.setTimeout(120_000);

app = await appConfigs.astro.node
.clone()
.setName('astro-node-v6-smoke')
.addDependency('astro', '^6.4.8')
.addDependency('@astrojs/node', '^10.1.4')
.addDependency('@astrojs/react', '^5.0.7')
.commit();

await app.setup();
await app.withEnv(appConfigs.envs.withCustomRoles);
});

test.afterAll(async () => {
await app.teardown();
});

test('builds with Astro 6 and custom UserButton menu items', async () => {
await app.build();

expect(app.buildOutput).not.toHaveLength(0);
expect(app.buildOutput).not.toContain('Illegal return statement');
});
});
9 changes: 8 additions & 1 deletion integration/tests/astro/components.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -416,7 +416,7 @@ testAgainstRunningApps({ withPattern: ['astro.node.withCustomRoles'] })('basic f
});

// ----- redirect
test('redirects to sign-in when unauthenticated (middleware)', async ({ page, context }) => {
test('redirects to sign-in when unauthenticated (user page)', async ({ page, context }) => {
const u = createTestUtils({ app, page, context });
await u.page.goToAppHome();
await u.page.getByRole('link', { name: 'User', exact: true }).click();
Expand All@@ -432,6 +432,13 @@ testAgainstRunningApps({ withPattern: ['astro.node.withCustomRoles'] })('basic f
);
});

test('redirects to sign-in when unauthenticated (discover page)', async ({ page, context }) => {
const u = createTestUtils({ app, page, context });
await u.page.goToRelative('/discover');
await u.page.waitForURL(`${app.serverUrl}/sign-in?redirect_url=${encodeURIComponent(`${app.serverUrl}/discover`)}`);
await u.po.signIn.waitForMounted();
});

// ---- protect
test('only admin', async ({ page, context }) => {
const u = createTestUtils({ app, page, context });
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
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
5 changes: 5 additions & 0 deletions .changeset/floppy-buckets-help.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
"@clerk/astro": major
---

Add support for Astro 7 and drop support for Astro 4. If you are still on Astro 4, follow the [Astro upgrade guide](https://docs.astro.build/en/guides/upgrade-to/v6/) to upgrade your project before updating `@clerk/astro`.
43 changes: 43 additions & 0 deletions .changeset/major-astro-remove-route-matcher.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
---
'@clerk/astro': major
---

Remove `createRouteMatcher` from `@clerk/astro/server`. Use resource-based auth checks instead: move auth checks into each Astro page, API route, or server-side handler that accesses protected data. Middleware-based auth checks rely on path matching, which can diverge from how Astro routes requests and leave protected resources reachable.

```ts
import type { APIRoute } from 'astro';

export const GET: APIRoute = ({ locals }) => {
const { userId } = locals.auth();

if (!userId) {
return new Response('Unauthorized', { status: 401 });
}

return Response.json({ userId });
};
```

If you want to hand this work to a coding agent, use this migration prompt:

```md
Migrate my Astro project away from Clerk's removed `createRouteMatcher` API.

1. Open `src/middleware.ts` (or `src/middleware.js`) and find every matcher created
with `createRouteMatcher` from `@clerk/astro/server`, along with the middleware
logic that uses it (returning 401s, calling `auth().redirectToSignIn()`, etc.).
2. For every route those matchers protected, move the auth check into the resource itself:
- In `.astro` pages, add this to the frontmatter:
const { userId, redirectToSignIn } = Astro.locals.auth();
if (!userId) return redirectToSignIn();
- In API routes and server handlers, add this at the top of the handler:
const { userId } = locals.auth();
if (!userId) return new Response('Unauthorized', { status: 401 });
- Keep any role or permission checks (`auth().has(...)`) with the resource as well.
3. Remove the `createRouteMatcher` import and calls from the middleware. Keep
`clerkMiddleware()` itself. Middleware logic unrelated to auth protection
(locale redirects, headers, etc.) may stay, using plain `URL`/pathname checks.
4. Make sure every page and endpoint previously covered by a matcher pattern
(including glob patterns like `/dashboard(.*)`) now has its own check, then
verify the project builds.
```
3 changes: 0 additions & 3 deletions integration/templates/astro-node/astro.config.mjs

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

dont need tailwind in this...

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,8 +3,6 @@ import node from '@astrojs/node';
import clerk from '@clerk/astro';
import react from '@astrojs/react';

import tailwind from '@astrojs/tailwind';

export default defineConfig({
output: 'server',
adapter: node({
Expand All@@ -19,7 +17,6 @@ export default defineConfig({
},
}),
react(),
tailwind(),
],
server: {
port: process.env.PORT ? Number(process.env.PORT) : undefined,
Expand Down
10 changes: 4 additions & 6 deletions integration/templates/astro-node/package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,16 +10,14 @@
"start": "astro dev --port $PORT"
},
"dependencies": {
"@astrojs/check": "^0.9.4",
"@astrojs/node": "^9.0.0",
"@astrojs/react": "^4.0.0",
"@astrojs/tailwind": "^5.1.3",
"@astrojs/check": "^0.9.9",
"@astrojs/node": "^11.0.0",
"@astrojs/react": "^6.0.0",
"@types/react": "18.3.7",
"@types/react-dom": "18.3.0",
"astro": "^5.15.9",
"astro": "^7.0.2",
"react": "18.3.1",
"react-dom": "18.3.1",
"tailwindcss": "^3.4.17",
"typescript": "^5.7.3"
}
}
30 changes: 2 additions & 28 deletions integration/templates/astro-node/src/middleware.ts
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,9 @@
import { clerkMiddleware, createRouteMatcher } from '@clerk/astro/server';

const unautorized = () =>
new Response(JSON.stringify({ error: 'unathorized access' }), {
status: 401,
});

/**
* 3. Support handler
*/
const isProtectedPage = createRouteMatcher(['/user(.*)', '/discover(.*)']);

const isProtectedApiRoute = createRouteMatcher(['/api/protected(.*)']);
import { clerkMiddleware } from '@clerk/astro/server';

export const onRequest = clerkMiddleware((auth, context, next) => {
const requestURL = new URL(context.request.url);
if (['/sign-in', '/', '/sign-up'].includes(requestURL.pathname)) {
return next();
}

if (isProtectedApiRoute(context.request) && !auth().userId) {
return unautorized();
}

if (isProtectedPage(context.request) && !auth().userId) {
return auth().redirectToSignIn();
}

if (!auth().orgId && requestURL.pathname !== '/discover' && requestURL.pathname === '/organization') {
if (!auth().userId) {
return next();
}
if (requestURL.pathname === '/organization' && auth().userId && !auth().orgId) {
const searchParams = new URLSearchParams({
redirectUrl: requestURL.href,
});
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,13 @@
import type { APIRoute } from 'astro';
import { clerkClient } from '@clerk/astro/server';

const empty = () => new Response(null);

export const GET: APIRoute = async context => {
const { locals } = context;
const { userId, orgId } = locals.auth();
if (!userId) {
// We are handling this at the middleware level
return empty();
return new Response(JSON.stringify({ error: 'unauthorized access' }), {
status: 401,
});
}

if (!orgId) {
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,12 @@ export const GET: APIRoute = async context => {
const { locals } = context;
const { auth } = locals;

if (!auth().userId) {
return new Response(JSON.stringify({ error: 'unauthorized access' }), {
status: 401,
});
}

if (auth().has({ role: 'org:admin' })) {
return new Response(
JSON.stringify(
Expand Down
6 changes: 6 additions & 0 deletions integration/templates/astro-node/src/pages/discover.astro
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
---
import { OrganizationList } from '@clerk/astro/components';
import Layout from '../layouts/Layout.astro';

const { userId, redirectToSignIn } = Astro.locals.auth();

if (!userId) {
return redirectToSignIn();
}
Comment thread
coderabbitai[bot] marked this conversation as resolved.
---

<Layout title='Welcome to Astro.'>
Expand Down
6 changes: 6 additions & 0 deletions integration/templates/astro-node/src/pages/user.astro
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,12 @@
import { UserProfile } from '@clerk/astro/components';
import Layout from '../layouts/Layout.astro';
import StreamUser from '../components/StreamUser.astro';

const { userId, redirectToSignIn } = Astro.locals.auth();

if (!userId) {
return redirectToSignIn();
}
---

<Layout title='Welcome to Astro.'>
Expand Down
38 changes: 0 additions & 38 deletions integration/templates/astro-node/tailwind.config.cjs

This file was deleted.

7 changes: 5 additions & 2 deletions integration/testUtils/machineAuthHelpers.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -262,6 +262,7 @@ export const registerApiKeyAuthTests = (adapter: MachineAuthTestAdapter): void =
test('should handle multiple token types', async ({ page, context }) => {
const u = createTestUtils({ app, page, context });
const url = new URL(adapter.apiKey.path, app.serverUrl).toString();
const origin = new URL(app.serverUrl).origin;

await u.po.signIn.goTo();
await u.po.signIn.waitForMounted();
Expand All@@ -271,14 +272,16 @@ export const registerApiKeyAuthTests = (adapter: MachineAuthTestAdapter): void =
const getRes = await u.page.request.get(url);
expect(getRes.status()).toBe(401);

const postWithSessionRes = await u.page.request.post(url);
const postWithSessionRes = await u.page.request.post(url, {
headers: { Origin: origin },
});
const sessionData = await postWithSessionRes.json();
expect(postWithSessionRes.status()).toBe(200);
expect(sessionData.userId).toBe(fakeBapiUser.id);
expect(sessionData.tokenType).toBe(TokenType.SessionToken);
Comment on lines +275 to 281

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🩺 Stability & Availability | 🟡 Minor | ⚡ Quick win

Assert response status before parsing JSON bodies in POST branches.

json() can throw on non-JSON error responses before the status assertion runs, which obscures the real failure. Assert status first, then parse.

Suggested patch
 const postWithSessionRes = await u.page.request.post(url, {
headers: { Origin: origin },
});
- const sessionData = await postWithSessionRes.json();
expect(postWithSessionRes.status()).toBe(200);
+ const sessionData = await postWithSessionRes.json();
expect(sessionData.userId).toBe(fakeBapiUser.id);
expect(sessionData.tokenType).toBe(TokenType.SessionToken);
const postWithApiKeyRes = await u.page.request.post(url, {
headers: { Authorization: `Bearer ${fakeAPIKey.secret}`, Origin: origin },
});
- const apiKeyData = await postWithApiKeyRes.json();
expect(postWithApiKeyRes.status()).toBe(200);
+ const apiKeyData = await postWithApiKeyRes.json();
expect(apiKeyData.userId).toBe(fakeBapiUser.id);
expect(apiKeyData.tokenType).toBe(TokenType.ApiKey);

Also applies to: 283-285

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@integration/testUtils/machineAuthHelpers.ts` around lines 275 - 281, In the
POST request handling blocks, the status assertion must be moved before the JSON
parsing. Currently, the code calls postWithSessionRes.json() before checking
postWithSessionRes.status(), which means if the response is an error, the json()
call may fail before the status assertion runs, obscuring the actual failure.
Reorder the statements so that expect(postWithSessionRes.status()).toBe(200) is
called immediately after the post request completes, before calling await
postWithSessionRes.json(). Apply this same fix to both the postWithSessionRes
block and the similar block referenced in the "Also applies to" comment.


const postWithApiKeyRes = await u.page.request.post(url, {
headers: { Authorization: `Bearer ${fakeAPIKey.secret}` },
headers: { Authorization: `Bearer ${fakeAPIKey.secret}`, Origin: origin },
});
const apiKeyData = await postWithApiKeyRes.json();
expect(postWithApiKeyRes.status()).toBe(200);
Expand Down
36 changes: 36 additions & 0 deletions integration/tests/astro/compatibility.test.ts

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Astro v6 compatibility smoke test

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
import { expect, test } from '@playwright/test';

import type { Application } from '../../models/application';
import { appConfigs } from '../../presets';

test.describe('Astro version compatibility @astro', () => {
test.describe.configure({ mode: 'serial' });

let app: Application;

test.beforeAll(async () => {
test.setTimeout(120_000);

app = await appConfigs.astro.node
.clone()
.setName('astro-node-v6-smoke')
.addDependency('astro', '^6.4.8')
.addDependency('@astrojs/node', '^10.1.4')
.addDependency('@astrojs/react', '^5.0.7')
.commit();

await app.setup();
await app.withEnv(appConfigs.envs.withCustomRoles);
});

test.afterAll(async () => {
await app.teardown();
});

test('builds with Astro 6 and custom UserButton menu items', async () => {
await app.build();

expect(app.buildOutput).not.toHaveLength(0);
expect(app.buildOutput).not.toContain('Illegal return statement');
});
});
9 changes: 8 additions & 1 deletion integration/tests/astro/components.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -416,7 +416,7 @@ testAgainstRunningApps({ withPattern: ['astro.node.withCustomRoles'] })('basic f
});

// ----- redirect
test('redirects to sign-in when unauthenticated (middleware)', async ({ page, context }) => {
test('redirects to sign-in when unauthenticated (user page)', async ({ page, context }) => {
const u = createTestUtils({ app, page, context });
await u.page.goToAppHome();
await u.page.getByRole('link', { name: 'User', exact: true }).click();
Expand All@@ -432,6 +432,13 @@ testAgainstRunningApps({ withPattern: ['astro.node.withCustomRoles'] })('basic f
);
});

test('redirects to sign-in when unauthenticated (discover page)', async ({ page, context }) => {
const u = createTestUtils({ app, page, context });
await u.page.goToRelative('/discover');
await u.page.waitForURL(`${app.serverUrl}/sign-in?redirect_url=${encodeURIComponent(`${app.serverUrl}/discover`)}`);
await u.po.signIn.waitForMounted();
});

// ---- protect
test('only admin', async ({ page, context }) => {
const u = createTestUtils({ app, page, context });
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
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
5 changes: 5 additions & 0 deletions .changeset/floppy-buckets-help.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
"@clerk/astro": major
---

Add support for Astro 7 and drop support for Astro 4. If you are still on Astro 4, follow the [Astro upgrade guide](https://docs.astro.build/en/guides/upgrade-to/v6/) to upgrade your project before updating `@clerk/astro`.
43 changes: 43 additions & 0 deletions .changeset/major-astro-remove-route-matcher.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
---
'@clerk/astro': major
---

Remove `createRouteMatcher` from `@clerk/astro/server`. Use resource-based auth checks instead: move auth checks into each Astro page, API route, or server-side handler that accesses protected data. Middleware-based auth checks rely on path matching, which can diverge from how Astro routes requests and leave protected resources reachable.

```ts
import type { APIRoute } from 'astro';

export const GET: APIRoute = ({ locals }) => {
const { userId } = locals.auth();

if (!userId) {
return new Response('Unauthorized', { status: 401 });
}

return Response.json({ userId });
};
```

If you want to hand this work to a coding agent, use this migration prompt:

```md
Migrate my Astro project away from Clerk's removed `createRouteMatcher` API.

1. Open `src/middleware.ts` (or `src/middleware.js`) and find every matcher created
with `createRouteMatcher` from `@clerk/astro/server`, along with the middleware
logic that uses it (returning 401s, calling `auth().redirectToSignIn()`, etc.).
2. For every route those matchers protected, move the auth check into the resource itself:
- In `.astro` pages, add this to the frontmatter:
const { userId, redirectToSignIn } = Astro.locals.auth();
if (!userId) return redirectToSignIn();
- In API routes and server handlers, add this at the top of the handler:
const { userId } = locals.auth();
if (!userId) return new Response('Unauthorized', { status: 401 });
- Keep any role or permission checks (`auth().has(...)`) with the resource as well.
3. Remove the `createRouteMatcher` import and calls from the middleware. Keep
`clerkMiddleware()` itself. Middleware logic unrelated to auth protection
(locale redirects, headers, etc.) may stay, using plain `URL`/pathname checks.
4. Make sure every page and endpoint previously covered by a matcher pattern
(including glob patterns like `/dashboard(.*)`) now has its own check, then
verify the project builds.
```
3 changes: 0 additions & 3 deletions integration/templates/astro-node/astro.config.mjs

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

dont need tailwind in this...

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,8 +3,6 @@ import node from '@astrojs/node';
import clerk from '@clerk/astro';
import react from '@astrojs/react';

import tailwind from '@astrojs/tailwind';

export default defineConfig({
output: 'server',
adapter: node({
Expand All@@ -19,7 +17,6 @@ export default defineConfig({
},
}),
react(),
tailwind(),
],
server: {
port: process.env.PORT ? Number(process.env.PORT) : undefined,
Expand Down
10 changes: 4 additions & 6 deletions integration/templates/astro-node/package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,16 +10,14 @@
"start": "astro dev --port $PORT"
},
"dependencies": {
"@astrojs/check": "^0.9.4",
"@astrojs/node": "^9.0.0",
"@astrojs/react": "^4.0.0",
"@astrojs/tailwind": "^5.1.3",
"@astrojs/check": "^0.9.9",
"@astrojs/node": "^11.0.0",
"@astrojs/react": "^6.0.0",
"@types/react": "18.3.7",
"@types/react-dom": "18.3.0",
"astro": "^5.15.9",
"astro": "^7.0.2",
"react": "18.3.1",
"react-dom": "18.3.1",
"tailwindcss": "^3.4.17",
"typescript": "^5.7.3"
}
}
30 changes: 2 additions & 28 deletions integration/templates/astro-node/src/middleware.ts
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,9 @@
import { clerkMiddleware, createRouteMatcher } from '@clerk/astro/server';

const unautorized = () =>
new Response(JSON.stringify({ error: 'unathorized access' }), {
status: 401,
});

/**
* 3. Support handler
*/
const isProtectedPage = createRouteMatcher(['/user(.*)', '/discover(.*)']);

const isProtectedApiRoute = createRouteMatcher(['/api/protected(.*)']);
import { clerkMiddleware } from '@clerk/astro/server';

export const onRequest = clerkMiddleware((auth, context, next) => {
const requestURL = new URL(context.request.url);
if (['/sign-in', '/', '/sign-up'].includes(requestURL.pathname)) {
return next();
}

if (isProtectedApiRoute(context.request) && !auth().userId) {
return unautorized();
}

if (isProtectedPage(context.request) && !auth().userId) {
return auth().redirectToSignIn();
}

if (!auth().orgId && requestURL.pathname !== '/discover' && requestURL.pathname === '/organization') {
if (!auth().userId) {
return next();
}
if (requestURL.pathname === '/organization' && auth().userId && !auth().orgId) {
const searchParams = new URLSearchParams({
redirectUrl: requestURL.href,
});
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,13 @@
import type { APIRoute } from 'astro';
import { clerkClient } from '@clerk/astro/server';

const empty = () => new Response(null);

export const GET: APIRoute = async context => {
const { locals } = context;
const { userId, orgId } = locals.auth();
if (!userId) {
// We are handling this at the middleware level
return empty();
return new Response(JSON.stringify({ error: 'unauthorized access' }), {
status: 401,
});
}

if (!orgId) {
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,12 @@ export const GET: APIRoute = async context => {
const { locals } = context;
const { auth } = locals;

if (!auth().userId) {
return new Response(JSON.stringify({ error: 'unauthorized access' }), {
status: 401,
});
}

if (auth().has({ role: 'org:admin' })) {
return new Response(
JSON.stringify(
Expand Down
6 changes: 6 additions & 0 deletions integration/templates/astro-node/src/pages/discover.astro
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
---
import { OrganizationList } from '@clerk/astro/components';
import Layout from '../layouts/Layout.astro';

const { userId, redirectToSignIn } = Astro.locals.auth();

if (!userId) {
return redirectToSignIn();
}
Comment thread
coderabbitai[bot] marked this conversation as resolved.
---

<Layout title='Welcome to Astro.'>
Expand Down
6 changes: 6 additions & 0 deletions integration/templates/astro-node/src/pages/user.astro
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,12 @@
import { UserProfile } from '@clerk/astro/components';
import Layout from '../layouts/Layout.astro';
import StreamUser from '../components/StreamUser.astro';

const { userId, redirectToSignIn } = Astro.locals.auth();

if (!userId) {
return redirectToSignIn();
}
---

<Layout title='Welcome to Astro.'>
Expand Down
38 changes: 0 additions & 38 deletions integration/templates/astro-node/tailwind.config.cjs

This file was deleted.

7 changes: 5 additions & 2 deletions integration/testUtils/machineAuthHelpers.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -262,6 +262,7 @@ export const registerApiKeyAuthTests = (adapter: MachineAuthTestAdapter): void =
test('should handle multiple token types', async ({ page, context }) => {
const u = createTestUtils({ app, page, context });
const url = new URL(adapter.apiKey.path, app.serverUrl).toString();
const origin = new URL(app.serverUrl).origin;

await u.po.signIn.goTo();
await u.po.signIn.waitForMounted();
Expand All@@ -271,14 +272,16 @@ export const registerApiKeyAuthTests = (adapter: MachineAuthTestAdapter): void =
const getRes = await u.page.request.get(url);
expect(getRes.status()).toBe(401);

const postWithSessionRes = await u.page.request.post(url);
const postWithSessionRes = await u.page.request.post(url, {
headers: { Origin: origin },
});
const sessionData = await postWithSessionRes.json();
expect(postWithSessionRes.status()).toBe(200);
expect(sessionData.userId).toBe(fakeBapiUser.id);
expect(sessionData.tokenType).toBe(TokenType.SessionToken);
Comment on lines +275 to 281

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🩺 Stability & Availability | 🟡 Minor | ⚡ Quick win

Assert response status before parsing JSON bodies in POST branches.

json() can throw on non-JSON error responses before the status assertion runs, which obscures the real failure. Assert status first, then parse.

Suggested patch
 const postWithSessionRes = await u.page.request.post(url, {
headers: { Origin: origin },
});
- const sessionData = await postWithSessionRes.json();
expect(postWithSessionRes.status()).toBe(200);
+ const sessionData = await postWithSessionRes.json();
expect(sessionData.userId).toBe(fakeBapiUser.id);
expect(sessionData.tokenType).toBe(TokenType.SessionToken);
const postWithApiKeyRes = await u.page.request.post(url, {
headers: { Authorization: `Bearer ${fakeAPIKey.secret}`, Origin: origin },
});
- const apiKeyData = await postWithApiKeyRes.json();
expect(postWithApiKeyRes.status()).toBe(200);
+ const apiKeyData = await postWithApiKeyRes.json();
expect(apiKeyData.userId).toBe(fakeBapiUser.id);
expect(apiKeyData.tokenType).toBe(TokenType.ApiKey);

Also applies to: 283-285

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@integration/testUtils/machineAuthHelpers.ts` around lines 275 - 281, In the
POST request handling blocks, the status assertion must be moved before the JSON
parsing. Currently, the code calls postWithSessionRes.json() before checking
postWithSessionRes.status(), which means if the response is an error, the json()
call may fail before the status assertion runs, obscuring the actual failure.
Reorder the statements so that expect(postWithSessionRes.status()).toBe(200) is
called immediately after the post request completes, before calling await
postWithSessionRes.json(). Apply this same fix to both the postWithSessionRes
block and the similar block referenced in the "Also applies to" comment.


const postWithApiKeyRes = await u.page.request.post(url, {
headers: { Authorization: `Bearer ${fakeAPIKey.secret}` },
headers: { Authorization: `Bearer ${fakeAPIKey.secret}`, Origin: origin },
});
const apiKeyData = await postWithApiKeyRes.json();
expect(postWithApiKeyRes.status()).toBe(200);
Expand Down
36 changes: 36 additions & 0 deletions integration/tests/astro/compatibility.test.ts

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Astro v6 compatibility smoke test

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
import { expect, test } from '@playwright/test';

import type { Application } from '../../models/application';
import { appConfigs } from '../../presets';

test.describe('Astro version compatibility @astro', () => {
test.describe.configure({ mode: 'serial' });

let app: Application;

test.beforeAll(async () => {
test.setTimeout(120_000);

app = await appConfigs.astro.node
.clone()
.setName('astro-node-v6-smoke')
.addDependency('astro', '^6.4.8')
.addDependency('@astrojs/node', '^10.1.4')
.addDependency('@astrojs/react', '^5.0.7')
.commit();

await app.setup();
await app.withEnv(appConfigs.envs.withCustomRoles);
});

test.afterAll(async () => {
await app.teardown();
});

test('builds with Astro 6 and custom UserButton menu items', async () => {
await app.build();

expect(app.buildOutput).not.toHaveLength(0);
expect(app.buildOutput).not.toContain('Illegal return statement');
});
});
9 changes: 8 additions & 1 deletion integration/tests/astro/components.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -416,7 +416,7 @@ testAgainstRunningApps({ withPattern: ['astro.node.withCustomRoles'] })('basic f
});

// ----- redirect
test('redirects to sign-in when unauthenticated (middleware)', async ({ page, context }) => {
test('redirects to sign-in when unauthenticated (user page)', async ({ page, context }) => {
const u = createTestUtils({ app, page, context });
await u.page.goToAppHome();
await u.page.getByRole('link', { name: 'User', exact: true }).click();
Expand All@@ -432,6 +432,13 @@ testAgainstRunningApps({ withPattern: ['astro.node.withCustomRoles'] })('basic f
);
});

test('redirects to sign-in when unauthenticated (discover page)', async ({ page, context }) => {
const u = createTestUtils({ app, page, context });
await u.page.goToRelative('/discover');
await u.page.waitForURL(`${app.serverUrl}/sign-in?redirect_url=${encodeURIComponent(`${app.serverUrl}/discover`)}`);
await u.po.signIn.waitForMounted();
});

// ---- protect
test('only admin', async ({ page, context }) => {
const u = createTestUtils({ app, page, context });
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
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
5 changes: 5 additions & 0 deletions .changeset/floppy-buckets-help.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
"@clerk/astro": major
---

Add support for Astro 7 and drop support for Astro 4. If you are still on Astro 4, follow the [Astro upgrade guide](https://docs.astro.build/en/guides/upgrade-to/v6/) to upgrade your project before updating `@clerk/astro`.
43 changes: 43 additions & 0 deletions .changeset/major-astro-remove-route-matcher.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
---
'@clerk/astro': major
---

Remove `createRouteMatcher` from `@clerk/astro/server`. Use resource-based auth checks instead: move auth checks into each Astro page, API route, or server-side handler that accesses protected data. Middleware-based auth checks rely on path matching, which can diverge from how Astro routes requests and leave protected resources reachable.

```ts
import type { APIRoute } from 'astro';

export const GET: APIRoute = ({ locals }) => {
const { userId } = locals.auth();

if (!userId) {
return new Response('Unauthorized', { status: 401 });
}

return Response.json({ userId });
};
```

If you want to hand this work to a coding agent, use this migration prompt:

```md
Migrate my Astro project away from Clerk's removed `createRouteMatcher` API.

1. Open `src/middleware.ts` (or `src/middleware.js`) and find every matcher created
with `createRouteMatcher` from `@clerk/astro/server`, along with the middleware
logic that uses it (returning 401s, calling `auth().redirectToSignIn()`, etc.).
2. For every route those matchers protected, move the auth check into the resource itself:
- In `.astro` pages, add this to the frontmatter:
const { userId, redirectToSignIn } = Astro.locals.auth();
if (!userId) return redirectToSignIn();
- In API routes and server handlers, add this at the top of the handler:
const { userId } = locals.auth();
if (!userId) return new Response('Unauthorized', { status: 401 });
- Keep any role or permission checks (`auth().has(...)`) with the resource as well.
3. Remove the `createRouteMatcher` import and calls from the middleware. Keep
`clerkMiddleware()` itself. Middleware logic unrelated to auth protection
(locale redirects, headers, etc.) may stay, using plain `URL`/pathname checks.
4. Make sure every page and endpoint previously covered by a matcher pattern
(including glob patterns like `/dashboard(.*)`) now has its own check, then
verify the project builds.
```
3 changes: 0 additions & 3 deletions integration/templates/astro-node/astro.config.mjs

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

dont need tailwind in this...

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,8 +3,6 @@ import node from '@astrojs/node';
import clerk from '@clerk/astro';
import react from '@astrojs/react';

import tailwind from '@astrojs/tailwind';

export default defineConfig({
output: 'server',
adapter: node({
Expand All@@ -19,7 +17,6 @@ export default defineConfig({
},
}),
react(),
tailwind(),
],
server: {
port: process.env.PORT ? Number(process.env.PORT) : undefined,
Expand Down
10 changes: 4 additions & 6 deletions integration/templates/astro-node/package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,16 +10,14 @@
"start": "astro dev --port $PORT"
},
"dependencies": {
"@astrojs/check": "^0.9.4",
"@astrojs/node": "^9.0.0",
"@astrojs/react": "^4.0.0",
"@astrojs/tailwind": "^5.1.3",
"@astrojs/check": "^0.9.9",
"@astrojs/node": "^11.0.0",
"@astrojs/react": "^6.0.0",
"@types/react": "18.3.7",
"@types/react-dom": "18.3.0",
"astro": "^5.15.9",
"astro": "^7.0.2",
"react": "18.3.1",
"react-dom": "18.3.1",
"tailwindcss": "^3.4.17",
"typescript": "^5.7.3"
}
}
30 changes: 2 additions & 28 deletions integration/templates/astro-node/src/middleware.ts
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,9 @@
import { clerkMiddleware, createRouteMatcher } from '@clerk/astro/server';

const unautorized = () =>
new Response(JSON.stringify({ error: 'unathorized access' }), {
status: 401,
});

/**
* 3. Support handler
*/
const isProtectedPage = createRouteMatcher(['/user(.*)', '/discover(.*)']);

const isProtectedApiRoute = createRouteMatcher(['/api/protected(.*)']);
import { clerkMiddleware } from '@clerk/astro/server';

export const onRequest = clerkMiddleware((auth, context, next) => {
const requestURL = new URL(context.request.url);
if (['/sign-in', '/', '/sign-up'].includes(requestURL.pathname)) {
return next();
}

if (isProtectedApiRoute(context.request) && !auth().userId) {
return unautorized();
}

if (isProtectedPage(context.request) && !auth().userId) {
return auth().redirectToSignIn();
}

if (!auth().orgId && requestURL.pathname !== '/discover' && requestURL.pathname === '/organization') {
if (!auth().userId) {
return next();
}
if (requestURL.pathname === '/organization' && auth().userId && !auth().orgId) {
const searchParams = new URLSearchParams({
redirectUrl: requestURL.href,
});
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,13 @@
import type { APIRoute } from 'astro';
import { clerkClient } from '@clerk/astro/server';

const empty = () => new Response(null);

export const GET: APIRoute = async context => {
const { locals } = context;
const { userId, orgId } = locals.auth();
if (!userId) {
// We are handling this at the middleware level
return empty();
return new Response(JSON.stringify({ error: 'unauthorized access' }), {
status: 401,
});
}

if (!orgId) {
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,12 @@ export const GET: APIRoute = async context => {
const { locals } = context;
const { auth } = locals;

if (!auth().userId) {
return new Response(JSON.stringify({ error: 'unauthorized access' }), {
status: 401,
});
}

if (auth().has({ role: 'org:admin' })) {
return new Response(
JSON.stringify(
Expand Down
6 changes: 6 additions & 0 deletions integration/templates/astro-node/src/pages/discover.astro
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
---
import { OrganizationList } from '@clerk/astro/components';
import Layout from '../layouts/Layout.astro';

const { userId, redirectToSignIn } = Astro.locals.auth();

if (!userId) {
return redirectToSignIn();
}
Comment thread
coderabbitai[bot] marked this conversation as resolved.
---

<Layout title='Welcome to Astro.'>
Expand Down
6 changes: 6 additions & 0 deletions integration/templates/astro-node/src/pages/user.astro
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,12 @@
import { UserProfile } from '@clerk/astro/components';
import Layout from '../layouts/Layout.astro';
import StreamUser from '../components/StreamUser.astro';

const { userId, redirectToSignIn } = Astro.locals.auth();

if (!userId) {
return redirectToSignIn();
}
---

<Layout title='Welcome to Astro.'>
Expand Down
38 changes: 0 additions & 38 deletions integration/templates/astro-node/tailwind.config.cjs

This file was deleted.

7 changes: 5 additions & 2 deletions integration/testUtils/machineAuthHelpers.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -262,6 +262,7 @@ export const registerApiKeyAuthTests = (adapter: MachineAuthTestAdapter): void =
test('should handle multiple token types', async ({ page, context }) => {
const u = createTestUtils({ app, page, context });
const url = new URL(adapter.apiKey.path, app.serverUrl).toString();
const origin = new URL(app.serverUrl).origin;

await u.po.signIn.goTo();
await u.po.signIn.waitForMounted();
Expand All@@ -271,14 +272,16 @@ export const registerApiKeyAuthTests = (adapter: MachineAuthTestAdapter): void =
const getRes = await u.page.request.get(url);
expect(getRes.status()).toBe(401);

const postWithSessionRes = await u.page.request.post(url);
const postWithSessionRes = await u.page.request.post(url, {
headers: { Origin: origin },
});
const sessionData = await postWithSessionRes.json();
expect(postWithSessionRes.status()).toBe(200);
expect(sessionData.userId).toBe(fakeBapiUser.id);
expect(sessionData.tokenType).toBe(TokenType.SessionToken);
Comment on lines +275 to 281

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🩺 Stability & Availability | 🟡 Minor | ⚡ Quick win

Assert response status before parsing JSON bodies in POST branches.

json() can throw on non-JSON error responses before the status assertion runs, which obscures the real failure. Assert status first, then parse.

Suggested patch
 const postWithSessionRes = await u.page.request.post(url, {
headers: { Origin: origin },
});
- const sessionData = await postWithSessionRes.json();
expect(postWithSessionRes.status()).toBe(200);
+ const sessionData = await postWithSessionRes.json();
expect(sessionData.userId).toBe(fakeBapiUser.id);
expect(sessionData.tokenType).toBe(TokenType.SessionToken);
const postWithApiKeyRes = await u.page.request.post(url, {
headers: { Authorization: `Bearer ${fakeAPIKey.secret}`, Origin: origin },
});
- const apiKeyData = await postWithApiKeyRes.json();
expect(postWithApiKeyRes.status()).toBe(200);
+ const apiKeyData = await postWithApiKeyRes.json();
expect(apiKeyData.userId).toBe(fakeBapiUser.id);
expect(apiKeyData.tokenType).toBe(TokenType.ApiKey);

Also applies to: 283-285

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@integration/testUtils/machineAuthHelpers.ts` around lines 275 - 281, In the
POST request handling blocks, the status assertion must be moved before the JSON
parsing. Currently, the code calls postWithSessionRes.json() before checking
postWithSessionRes.status(), which means if the response is an error, the json()
call may fail before the status assertion runs, obscuring the actual failure.
Reorder the statements so that expect(postWithSessionRes.status()).toBe(200) is
called immediately after the post request completes, before calling await
postWithSessionRes.json(). Apply this same fix to both the postWithSessionRes
block and the similar block referenced in the "Also applies to" comment.


const postWithApiKeyRes = await u.page.request.post(url, {
headers: { Authorization: `Bearer ${fakeAPIKey.secret}` },
headers: { Authorization: `Bearer ${fakeAPIKey.secret}`, Origin: origin },
});
const apiKeyData = await postWithApiKeyRes.json();
expect(postWithApiKeyRes.status()).toBe(200);
Expand Down
36 changes: 36 additions & 0 deletions integration/tests/astro/compatibility.test.ts

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Astro v6 compatibility smoke test

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
import { expect, test } from '@playwright/test';

import type { Application } from '../../models/application';
import { appConfigs } from '../../presets';

test.describe('Astro version compatibility @astro', () => {
test.describe.configure({ mode: 'serial' });

let app: Application;

test.beforeAll(async () => {
test.setTimeout(120_000);

app = await appConfigs.astro.node
.clone()
.setName('astro-node-v6-smoke')
.addDependency('astro', '^6.4.8')
.addDependency('@astrojs/node', '^10.1.4')
.addDependency('@astrojs/react', '^5.0.7')
.commit();

await app.setup();
await app.withEnv(appConfigs.envs.withCustomRoles);
});

test.afterAll(async () => {
await app.teardown();
});

test('builds with Astro 6 and custom UserButton menu items', async () => {
await app.build();

expect(app.buildOutput).not.toHaveLength(0);
expect(app.buildOutput).not.toContain('Illegal return statement');
});
});
9 changes: 8 additions & 1 deletion integration/tests/astro/components.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -416,7 +416,7 @@ testAgainstRunningApps({ withPattern: ['astro.node.withCustomRoles'] })('basic f
});

// ----- redirect
test('redirects to sign-in when unauthenticated (middleware)', async ({ page, context }) => {
test('redirects to sign-in when unauthenticated (user page)', async ({ page, context }) => {
const u = createTestUtils({ app, page, context });
await u.page.goToAppHome();
await u.page.getByRole('link', { name: 'User', exact: true }).click();
Expand All@@ -432,6 +432,13 @@ testAgainstRunningApps({ withPattern: ['astro.node.withCustomRoles'] })('basic f
);
});

test('redirects to sign-in when unauthenticated (discover page)', async ({ page, context }) => {
const u = createTestUtils({ app, page, context });
await u.page.goToRelative('/discover');
await u.page.waitForURL(`${app.serverUrl}/sign-in?redirect_url=${encodeURIComponent(`${app.serverUrl}/discover`)}`);
await u.po.signIn.waitForMounted();
});

// ---- protect
test('only admin', async ({ page, context }) => {
const u = createTestUtils({ app, page, context });
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
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
5 changes: 5 additions & 0 deletions .changeset/floppy-buckets-help.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
"@clerk/astro": major
---

Add support for Astro 7 and drop support for Astro 4. If you are still on Astro 4, follow the [Astro upgrade guide](https://docs.astro.build/en/guides/upgrade-to/v6/) to upgrade your project before updating `@clerk/astro`.
43 changes: 43 additions & 0 deletions .changeset/major-astro-remove-route-matcher.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
---
'@clerk/astro': major
---

Remove `createRouteMatcher` from `@clerk/astro/server`. Use resource-based auth checks instead: move auth checks into each Astro page, API route, or server-side handler that accesses protected data. Middleware-based auth checks rely on path matching, which can diverge from how Astro routes requests and leave protected resources reachable.

```ts
import type { APIRoute } from 'astro';

export const GET: APIRoute = ({ locals }) => {
const { userId } = locals.auth();

if (!userId) {
return new Response('Unauthorized', { status: 401 });
}

return Response.json({ userId });
};
```

If you want to hand this work to a coding agent, use this migration prompt:

```md
Migrate my Astro project away from Clerk's removed `createRouteMatcher` API.

1. Open `src/middleware.ts` (or `src/middleware.js`) and find every matcher created
with `createRouteMatcher` from `@clerk/astro/server`, along with the middleware
logic that uses it (returning 401s, calling `auth().redirectToSignIn()`, etc.).
2. For every route those matchers protected, move the auth check into the resource itself:
- In `.astro` pages, add this to the frontmatter:
const { userId, redirectToSignIn } = Astro.locals.auth();
if (!userId) return redirectToSignIn();
- In API routes and server handlers, add this at the top of the handler:
const { userId } = locals.auth();
if (!userId) return new Response('Unauthorized', { status: 401 });
- Keep any role or permission checks (`auth().has(...)`) with the resource as well.
3. Remove the `createRouteMatcher` import and calls from the middleware. Keep
`clerkMiddleware()` itself. Middleware logic unrelated to auth protection
(locale redirects, headers, etc.) may stay, using plain `URL`/pathname checks.
4. Make sure every page and endpoint previously covered by a matcher pattern
(including glob patterns like `/dashboard(.*)`) now has its own check, then
verify the project builds.
```
3 changes: 0 additions & 3 deletions integration/templates/astro-node/astro.config.mjs

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

dont need tailwind in this...

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,8 +3,6 @@ import node from '@astrojs/node';
import clerk from '@clerk/astro';
import react from '@astrojs/react';

import tailwind from '@astrojs/tailwind';

export default defineConfig({
output: 'server',
adapter: node({
Expand All@@ -19,7 +17,6 @@ export default defineConfig({
},
}),
react(),
tailwind(),
],
server: {
port: process.env.PORT ? Number(process.env.PORT) : undefined,
Expand Down
10 changes: 4 additions & 6 deletions integration/templates/astro-node/package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,16 +10,14 @@
"start": "astro dev --port $PORT"
},
"dependencies": {
"@astrojs/check": "^0.9.4",
"@astrojs/node": "^9.0.0",
"@astrojs/react": "^4.0.0",
"@astrojs/tailwind": "^5.1.3",
"@astrojs/check": "^0.9.9",
"@astrojs/node": "^11.0.0",
"@astrojs/react": "^6.0.0",
"@types/react": "18.3.7",
"@types/react-dom": "18.3.0",
"astro": "^5.15.9",
"astro": "^7.0.2",
"react": "18.3.1",
"react-dom": "18.3.1",
"tailwindcss": "^3.4.17",
"typescript": "^5.7.3"
}
}
30 changes: 2 additions & 28 deletions integration/templates/astro-node/src/middleware.ts
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,9 @@
import { clerkMiddleware, createRouteMatcher } from '@clerk/astro/server';

const unautorized = () =>
new Response(JSON.stringify({ error: 'unathorized access' }), {
status: 401,
});

/**
* 3. Support handler
*/
const isProtectedPage = createRouteMatcher(['/user(.*)', '/discover(.*)']);

const isProtectedApiRoute = createRouteMatcher(['/api/protected(.*)']);
import { clerkMiddleware } from '@clerk/astro/server';

export const onRequest = clerkMiddleware((auth, context, next) => {
const requestURL = new URL(context.request.url);
if (['/sign-in', '/', '/sign-up'].includes(requestURL.pathname)) {
return next();
}

if (isProtectedApiRoute(context.request) && !auth().userId) {
return unautorized();
}

if (isProtectedPage(context.request) && !auth().userId) {
return auth().redirectToSignIn();
}

if (!auth().orgId && requestURL.pathname !== '/discover' && requestURL.pathname === '/organization') {
if (!auth().userId) {
return next();
}
if (requestURL.pathname === '/organization' && auth().userId && !auth().orgId) {
const searchParams = new URLSearchParams({
redirectUrl: requestURL.href,
});
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,13 @@
import type { APIRoute } from 'astro';
import { clerkClient } from '@clerk/astro/server';

const empty = () => new Response(null);

export const GET: APIRoute = async context => {
const { locals } = context;
const { userId, orgId } = locals.auth();
if (!userId) {
// We are handling this at the middleware level
return empty();
return new Response(JSON.stringify({ error: 'unauthorized access' }), {
status: 401,
});
}

if (!orgId) {
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,12 @@ export const GET: APIRoute = async context => {
const { locals } = context;
const { auth } = locals;

if (!auth().userId) {
return new Response(JSON.stringify({ error: 'unauthorized access' }), {
status: 401,
});
}

if (auth().has({ role: 'org:admin' })) {
return new Response(
JSON.stringify(
Expand Down
6 changes: 6 additions & 0 deletions integration/templates/astro-node/src/pages/discover.astro
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
---
import { OrganizationList } from '@clerk/astro/components';
import Layout from '../layouts/Layout.astro';

const { userId, redirectToSignIn } = Astro.locals.auth();

if (!userId) {
return redirectToSignIn();
}
Comment thread
coderabbitai[bot] marked this conversation as resolved.
---

<Layout title='Welcome to Astro.'>
Expand Down
6 changes: 6 additions & 0 deletions integration/templates/astro-node/src/pages/user.astro
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,12 @@
import { UserProfile } from '@clerk/astro/components';
import Layout from '../layouts/Layout.astro';
import StreamUser from '../components/StreamUser.astro';

const { userId, redirectToSignIn } = Astro.locals.auth();

if (!userId) {
return redirectToSignIn();
}
---

<Layout title='Welcome to Astro.'>
Expand Down
38 changes: 0 additions & 38 deletions integration/templates/astro-node/tailwind.config.cjs

This file was deleted.

7 changes: 5 additions & 2 deletions integration/testUtils/machineAuthHelpers.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -262,6 +262,7 @@ export const registerApiKeyAuthTests = (adapter: MachineAuthTestAdapter): void =
test('should handle multiple token types', async ({ page, context }) => {
const u = createTestUtils({ app, page, context });
const url = new URL(adapter.apiKey.path, app.serverUrl).toString();
const origin = new URL(app.serverUrl).origin;

await u.po.signIn.goTo();
await u.po.signIn.waitForMounted();
Expand All@@ -271,14 +272,16 @@ export const registerApiKeyAuthTests = (adapter: MachineAuthTestAdapter): void =
const getRes = await u.page.request.get(url);
expect(getRes.status()).toBe(401);

const postWithSessionRes = await u.page.request.post(url);
const postWithSessionRes = await u.page.request.post(url, {
headers: { Origin: origin },
});
const sessionData = await postWithSessionRes.json();
expect(postWithSessionRes.status()).toBe(200);
expect(sessionData.userId).toBe(fakeBapiUser.id);
expect(sessionData.tokenType).toBe(TokenType.SessionToken);
Comment on lines +275 to 281

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🩺 Stability & Availability | 🟡 Minor | ⚡ Quick win

Assert response status before parsing JSON bodies in POST branches.

json() can throw on non-JSON error responses before the status assertion runs, which obscures the real failure. Assert status first, then parse.

Suggested patch
 const postWithSessionRes = await u.page.request.post(url, {
headers: { Origin: origin },
});
- const sessionData = await postWithSessionRes.json();
expect(postWithSessionRes.status()).toBe(200);
+ const sessionData = await postWithSessionRes.json();
expect(sessionData.userId).toBe(fakeBapiUser.id);
expect(sessionData.tokenType).toBe(TokenType.SessionToken);
const postWithApiKeyRes = await u.page.request.post(url, {
headers: { Authorization: `Bearer ${fakeAPIKey.secret}`, Origin: origin },
});
- const apiKeyData = await postWithApiKeyRes.json();
expect(postWithApiKeyRes.status()).toBe(200);
+ const apiKeyData = await postWithApiKeyRes.json();
expect(apiKeyData.userId).toBe(fakeBapiUser.id);
expect(apiKeyData.tokenType).toBe(TokenType.ApiKey);

Also applies to: 283-285

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@integration/testUtils/machineAuthHelpers.ts` around lines 275 - 281, In the
POST request handling blocks, the status assertion must be moved before the JSON
parsing. Currently, the code calls postWithSessionRes.json() before checking
postWithSessionRes.status(), which means if the response is an error, the json()
call may fail before the status assertion runs, obscuring the actual failure.
Reorder the statements so that expect(postWithSessionRes.status()).toBe(200) is
called immediately after the post request completes, before calling await
postWithSessionRes.json(). Apply this same fix to both the postWithSessionRes
block and the similar block referenced in the "Also applies to" comment.


const postWithApiKeyRes = await u.page.request.post(url, {
headers: { Authorization: `Bearer ${fakeAPIKey.secret}` },
headers: { Authorization: `Bearer ${fakeAPIKey.secret}`, Origin: origin },
});
const apiKeyData = await postWithApiKeyRes.json();
expect(postWithApiKeyRes.status()).toBe(200);
Expand Down
36 changes: 36 additions & 0 deletions integration/tests/astro/compatibility.test.ts

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Astro v6 compatibility smoke test

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
import { expect, test } from '@playwright/test';

import type { Application } from '../../models/application';
import { appConfigs } from '../../presets';

test.describe('Astro version compatibility @astro', () => {
test.describe.configure({ mode: 'serial' });

let app: Application;

test.beforeAll(async () => {
test.setTimeout(120_000);

app = await appConfigs.astro.node
.clone()
.setName('astro-node-v6-smoke')
.addDependency('astro', '^6.4.8')
.addDependency('@astrojs/node', '^10.1.4')
.addDependency('@astrojs/react', '^5.0.7')
.commit();

await app.setup();
await app.withEnv(appConfigs.envs.withCustomRoles);
});

test.afterAll(async () => {
await app.teardown();
});

test('builds with Astro 6 and custom UserButton menu items', async () => {
await app.build();

expect(app.buildOutput).not.toHaveLength(0);
expect(app.buildOutput).not.toContain('Illegal return statement');
});
});
9 changes: 8 additions & 1 deletion integration/tests/astro/components.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -416,7 +416,7 @@ testAgainstRunningApps({ withPattern: ['astro.node.withCustomRoles'] })('basic f
});

// ----- redirect
test('redirects to sign-in when unauthenticated (middleware)', async ({ page, context }) => {
test('redirects to sign-in when unauthenticated (user page)', async ({ page, context }) => {
const u = createTestUtils({ app, page, context });
await u.page.goToAppHome();
await u.page.getByRole('link', { name: 'User', exact: true }).click();
Expand All@@ -432,6 +432,13 @@ testAgainstRunningApps({ withPattern: ['astro.node.withCustomRoles'] })('basic f
);
});

test('redirects to sign-in when unauthenticated (discover page)', async ({ page, context }) => {
const u = createTestUtils({ app, page, context });
await u.page.goToRelative('/discover');
await u.page.waitForURL(`${app.serverUrl}/sign-in?redirect_url=${encodeURIComponent(`${app.serverUrl}/discover`)}`);
await u.po.signIn.waitForMounted();
});

// ---- protect
test('only admin', async ({ page, context }) => {
const u = createTestUtils({ app, page, context });
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
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
5 changes: 5 additions & 0 deletions .changeset/floppy-buckets-help.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
"@clerk/astro": major
---

Add support for Astro 7 and drop support for Astro 4. If you are still on Astro 4, follow the [Astro upgrade guide](https://docs.astro.build/en/guides/upgrade-to/v6/) to upgrade your project before updating `@clerk/astro`.
43 changes: 43 additions & 0 deletions .changeset/major-astro-remove-route-matcher.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
---
'@clerk/astro': major
---

Remove `createRouteMatcher` from `@clerk/astro/server`. Use resource-based auth checks instead: move auth checks into each Astro page, API route, or server-side handler that accesses protected data. Middleware-based auth checks rely on path matching, which can diverge from how Astro routes requests and leave protected resources reachable.

```ts
import type { APIRoute } from 'astro';

export const GET: APIRoute = ({ locals }) => {
const { userId } = locals.auth();

if (!userId) {
return new Response('Unauthorized', { status: 401 });
}

return Response.json({ userId });
};
```

If you want to hand this work to a coding agent, use this migration prompt:

```md
Migrate my Astro project away from Clerk's removed `createRouteMatcher` API.

1. Open `src/middleware.ts` (or `src/middleware.js`) and find every matcher created
with `createRouteMatcher` from `@clerk/astro/server`, along with the middleware
logic that uses it (returning 401s, calling `auth().redirectToSignIn()`, etc.).
2. For every route those matchers protected, move the auth check into the resource itself:
- In `.astro` pages, add this to the frontmatter:
const { userId, redirectToSignIn } = Astro.locals.auth();
if (!userId) return redirectToSignIn();
- In API routes and server handlers, add this at the top of the handler:
const { userId } = locals.auth();
if (!userId) return new Response('Unauthorized', { status: 401 });
- Keep any role or permission checks (`auth().has(...)`) with the resource as well.
3. Remove the `createRouteMatcher` import and calls from the middleware. Keep
`clerkMiddleware()` itself. Middleware logic unrelated to auth protection
(locale redirects, headers, etc.) may stay, using plain `URL`/pathname checks.
4. Make sure every page and endpoint previously covered by a matcher pattern
(including glob patterns like `/dashboard(.*)`) now has its own check, then
verify the project builds.
```
3 changes: 0 additions & 3 deletions integration/templates/astro-node/astro.config.mjs

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

dont need tailwind in this...

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,8 +3,6 @@ import node from '@astrojs/node';
import clerk from '@clerk/astro';
import react from '@astrojs/react';

import tailwind from '@astrojs/tailwind';

export default defineConfig({
output: 'server',
adapter: node({
Expand All@@ -19,7 +17,6 @@ export default defineConfig({
},
}),
react(),
tailwind(),
],
server: {
port: process.env.PORT ? Number(process.env.PORT) : undefined,
Expand Down
10 changes: 4 additions & 6 deletions integration/templates/astro-node/package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,16 +10,14 @@
"start": "astro dev --port $PORT"
},
"dependencies": {
"@astrojs/check": "^0.9.4",
"@astrojs/node": "^9.0.0",
"@astrojs/react": "^4.0.0",
"@astrojs/tailwind": "^5.1.3",
"@astrojs/check": "^0.9.9",
"@astrojs/node": "^11.0.0",
"@astrojs/react": "^6.0.0",
"@types/react": "18.3.7",
"@types/react-dom": "18.3.0",
"astro": "^5.15.9",
"astro": "^7.0.2",
"react": "18.3.1",
"react-dom": "18.3.1",
"tailwindcss": "^3.4.17",
"typescript": "^5.7.3"
}
}
30 changes: 2 additions & 28 deletions integration/templates/astro-node/src/middleware.ts
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,9 @@
import { clerkMiddleware, createRouteMatcher } from '@clerk/astro/server';

const unautorized = () =>
new Response(JSON.stringify({ error: 'unathorized access' }), {
status: 401,
});

/**
* 3. Support handler
*/
const isProtectedPage = createRouteMatcher(['/user(.*)', '/discover(.*)']);

const isProtectedApiRoute = createRouteMatcher(['/api/protected(.*)']);
import { clerkMiddleware } from '@clerk/astro/server';

export const onRequest = clerkMiddleware((auth, context, next) => {
const requestURL = new URL(context.request.url);
if (['/sign-in', '/', '/sign-up'].includes(requestURL.pathname)) {
return next();
}

if (isProtectedApiRoute(context.request) && !auth().userId) {
return unautorized();
}

if (isProtectedPage(context.request) && !auth().userId) {
return auth().redirectToSignIn();
}

if (!auth().orgId && requestURL.pathname !== '/discover' && requestURL.pathname === '/organization') {
if (!auth().userId) {
return next();
}
if (requestURL.pathname === '/organization' && auth().userId && !auth().orgId) {
const searchParams = new URLSearchParams({
redirectUrl: requestURL.href,
});
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,13 @@
import type { APIRoute } from 'astro';
import { clerkClient } from '@clerk/astro/server';

const empty = () => new Response(null);

export const GET: APIRoute = async context => {
const { locals } = context;
const { userId, orgId } = locals.auth();
if (!userId) {
// We are handling this at the middleware level
return empty();
return new Response(JSON.stringify({ error: 'unauthorized access' }), {
status: 401,
});
}

if (!orgId) {
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,12 @@ export const GET: APIRoute = async context => {
const { locals } = context;
const { auth } = locals;

if (!auth().userId) {
return new Response(JSON.stringify({ error: 'unauthorized access' }), {
status: 401,
});
}

if (auth().has({ role: 'org:admin' })) {
return new Response(
JSON.stringify(
Expand Down
6 changes: 6 additions & 0 deletions integration/templates/astro-node/src/pages/discover.astro
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
---
import { OrganizationList } from '@clerk/astro/components';
import Layout from '../layouts/Layout.astro';

const { userId, redirectToSignIn } = Astro.locals.auth();

if (!userId) {
return redirectToSignIn();
}
Comment thread
coderabbitai[bot] marked this conversation as resolved.
---

<Layout title='Welcome to Astro.'>
Expand Down
6 changes: 6 additions & 0 deletions integration/templates/astro-node/src/pages/user.astro
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,12 @@
import { UserProfile } from '@clerk/astro/components';
import Layout from '../layouts/Layout.astro';
import StreamUser from '../components/StreamUser.astro';

const { userId, redirectToSignIn } = Astro.locals.auth();

if (!userId) {
return redirectToSignIn();
}
---

<Layout title='Welcome to Astro.'>
Expand Down
38 changes: 0 additions & 38 deletions integration/templates/astro-node/tailwind.config.cjs

This file was deleted.

7 changes: 5 additions & 2 deletions integration/testUtils/machineAuthHelpers.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -262,6 +262,7 @@ export const registerApiKeyAuthTests = (adapter: MachineAuthTestAdapter): void =
test('should handle multiple token types', async ({ page, context }) => {
const u = createTestUtils({ app, page, context });
const url = new URL(adapter.apiKey.path, app.serverUrl).toString();
const origin = new URL(app.serverUrl).origin;

await u.po.signIn.goTo();
await u.po.signIn.waitForMounted();
Expand All@@ -271,14 +272,16 @@ export const registerApiKeyAuthTests = (adapter: MachineAuthTestAdapter): void =
const getRes = await u.page.request.get(url);
expect(getRes.status()).toBe(401);

const postWithSessionRes = await u.page.request.post(url);
const postWithSessionRes = await u.page.request.post(url, {
headers: { Origin: origin },
});
const sessionData = await postWithSessionRes.json();
expect(postWithSessionRes.status()).toBe(200);
expect(sessionData.userId).toBe(fakeBapiUser.id);
expect(sessionData.tokenType).toBe(TokenType.SessionToken);
Comment on lines +275 to 281

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🩺 Stability & Availability | 🟡 Minor | ⚡ Quick win

Assert response status before parsing JSON bodies in POST branches.

json() can throw on non-JSON error responses before the status assertion runs, which obscures the real failure. Assert status first, then parse.

Suggested patch
 const postWithSessionRes = await u.page.request.post(url, {
headers: { Origin: origin },
});
- const sessionData = await postWithSessionRes.json();
expect(postWithSessionRes.status()).toBe(200);
+ const sessionData = await postWithSessionRes.json();
expect(sessionData.userId).toBe(fakeBapiUser.id);
expect(sessionData.tokenType).toBe(TokenType.SessionToken);
const postWithApiKeyRes = await u.page.request.post(url, {
headers: { Authorization: `Bearer ${fakeAPIKey.secret}`, Origin: origin },
});
- const apiKeyData = await postWithApiKeyRes.json();
expect(postWithApiKeyRes.status()).toBe(200);
+ const apiKeyData = await postWithApiKeyRes.json();
expect(apiKeyData.userId).toBe(fakeBapiUser.id);
expect(apiKeyData.tokenType).toBe(TokenType.ApiKey);

Also applies to: 283-285

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@integration/testUtils/machineAuthHelpers.ts` around lines 275 - 281, In the
POST request handling blocks, the status assertion must be moved before the JSON
parsing. Currently, the code calls postWithSessionRes.json() before checking
postWithSessionRes.status(), which means if the response is an error, the json()
call may fail before the status assertion runs, obscuring the actual failure.
Reorder the statements so that expect(postWithSessionRes.status()).toBe(200) is
called immediately after the post request completes, before calling await
postWithSessionRes.json(). Apply this same fix to both the postWithSessionRes
block and the similar block referenced in the "Also applies to" comment.


const postWithApiKeyRes = await u.page.request.post(url, {
headers: { Authorization: `Bearer ${fakeAPIKey.secret}` },
headers: { Authorization: `Bearer ${fakeAPIKey.secret}`, Origin: origin },
});
const apiKeyData = await postWithApiKeyRes.json();
expect(postWithApiKeyRes.status()).toBe(200);
Expand Down
36 changes: 36 additions & 0 deletions integration/tests/astro/compatibility.test.ts

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Astro v6 compatibility smoke test

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
import { expect, test } from '@playwright/test';

import type { Application } from '../../models/application';
import { appConfigs } from '../../presets';

test.describe('Astro version compatibility @astro', () => {
test.describe.configure({ mode: 'serial' });

let app: Application;

test.beforeAll(async () => {
test.setTimeout(120_000);

app = await appConfigs.astro.node
.clone()
.setName('astro-node-v6-smoke')
.addDependency('astro', '^6.4.8')
.addDependency('@astrojs/node', '^10.1.4')
.addDependency('@astrojs/react', '^5.0.7')
.commit();

await app.setup();
await app.withEnv(appConfigs.envs.withCustomRoles);
});

test.afterAll(async () => {
await app.teardown();
});

test('builds with Astro 6 and custom UserButton menu items', async () => {
await app.build();

expect(app.buildOutput).not.toHaveLength(0);
expect(app.buildOutput).not.toContain('Illegal return statement');
});
});
9 changes: 8 additions & 1 deletion integration/tests/astro/components.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -416,7 +416,7 @@ testAgainstRunningApps({ withPattern: ['astro.node.withCustomRoles'] })('basic f
});

// ----- redirect
test('redirects to sign-in when unauthenticated (middleware)', async ({ page, context }) => {
test('redirects to sign-in when unauthenticated (user page)', async ({ page, context }) => {
const u = createTestUtils({ app, page, context });
await u.page.goToAppHome();
await u.page.getByRole('link', { name: 'User', exact: true }).click();
Expand All@@ -432,6 +432,13 @@ testAgainstRunningApps({ withPattern: ['astro.node.withCustomRoles'] })('basic f
);
});

test('redirects to sign-in when unauthenticated (discover page)', async ({ page, context }) => {
const u = createTestUtils({ app, page, context });
await u.page.goToRelative('/discover');
await u.page.waitForURL(`${app.serverUrl}/sign-in?redirect_url=${encodeURIComponent(`${app.serverUrl}/discover`)}`);
await u.po.signIn.waitForMounted();
});

// ---- protect
test('only admin', async ({ page, context }) => {
const u = createTestUtils({ app, page, context });
Expand Down
Loading
Loading