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
381 changes: 381 additions & 0 deletions integration/tests/react-router/machine.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,381 @@
import type { User } from '@clerk/backend';
import { createClerkClient } from '@clerk/backend';
import { TokenType } from '@clerk/backend/internal';
import { expect, test } from '@playwright/test';

import type { Application } from '../../models/application';
import { appConfigs } from '../../presets';
import { instanceKeys } from '../../presets/envs';
import type { FakeAPIKey, FakeMachineNetwork, FakeOAuthApp, FakeUser } from '../../testUtils';
import {
createFakeMachineNetwork,
createFakeOAuthApp,
createJwtM2MToken,
createTestUtils,
obtainOAuthAccessToken,
} from '../../testUtils';

test.describe('React Router machine authentication @machine', () => {
test.describe('API key auth', () => {
test.describe.configure({ mode: 'parallel' });
let app: Application;
let fakeUser: FakeUser;
let fakeBapiUser: User;
let fakeAPIKey: FakeAPIKey;

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

app = await appConfigs.reactRouter.reactRouterNode
.clone()
.addFile(
'app/routes/api/me.ts',
() => `
import { getAuth } from '@clerk/react-router/server';
import type { Route } from './+types/me';

export async function loader(args: Route.LoaderArgs) {
const { userId, tokenType } = await getAuth(args, { acceptsToken: 'api_key' });

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

return Response.json({ userId, tokenType });
}
`,
)
.addFile(
'app/routes.ts',
() => `
import { type RouteConfig, index, route } from '@react-router/dev/routes';

export default [
index('routes/home.tsx'),
route('sign-in/*', 'routes/sign-in.tsx'),
route('sign-up/*', 'routes/sign-up.tsx'),
route('protected', 'routes/protected.tsx'),
route('api/me', 'routes/api/me.ts'),
] satisfies RouteConfig;
`,
)
.commit();

await app.setup();
await app.withEnv(appConfigs.envs.withAPIKeys);
await app.dev();

const u = createTestUtils({ app });
fakeUser = u.services.users.createFakeUser();
fakeBapiUser = await u.services.users.createBapiUser(fakeUser);
fakeAPIKey = await u.services.users.createFakeAPIKey(fakeBapiUser.id);
});

test.afterAll(async () => {
await fakeAPIKey.revoke();
await fakeUser.deleteIfExists();
await app.teardown();
});

test('should return 401 if no API key is provided', async ({ request }) => {
const url = new URL('/api/me', app.serverUrl);
const res = await request.get(url.toString());
expect(res.status()).toBe(401);
});

test('should return 401 if API key is invalid', async ({ request }) => {
const url = new URL('/api/me', app.serverUrl);
const res = await request.get(url.toString(), {
headers: { Authorization: 'Bearer invalid_key' },
});
expect(res.status()).toBe(401);
});

test('should return 200 with auth object if API key is valid', async ({ request }) => {
const url = new URL('/api/me', app.serverUrl);
const res = await request.get(url.toString(), {
headers: {
Authorization: `Bearer ${fakeAPIKey.secret}`,
},
});
const apiKeyData = await res.json();
expect(res.status()).toBe(200);
expect(apiKeyData.userId).toBe(fakeBapiUser.id);
expect(apiKeyData.tokenType).toBe(TokenType.ApiKey);
});

for (const [tokenType, token] of [
['M2M', 'mt_test_mismatch'],
['OAuth', 'oat_test_mismatch'],
] as const) {
test(`rejects ${tokenType} token on API key route (token type mismatch)`, async ({ request }) => {
const url = new URL('/api/me', app.serverUrl);
const res = await request.get(url.toString(), {
headers: { Authorization: `Bearer ${token}` },
});
expect(res.status()).toBe(401);
});
}
});

test.describe('M2M auth', () => {
test.describe.configure({ mode: 'parallel' });
let app: Application;
let network: FakeMachineNetwork;

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

const client = createClerkClient({
secretKey: instanceKeys.get('with-api-keys').sk,
});
network = await createFakeMachineNetwork(client);

app = await appConfigs.reactRouter.reactRouterNode
.clone()
.addFile(
'app/routes/api/m2m.ts',
() => `
import { getAuth } from '@clerk/react-router/server';
import type { Route } from './+types/m2m';

export async function loader(args: Route.LoaderArgs) {
const { subject, tokenType, isAuthenticated } = await getAuth(args, { acceptsToken: 'm2m_token' });

if (!isAuthenticated) {
return Response.json({ error: 'Unauthorized' }, { status: 401 });
}

return Response.json({ subject, tokenType });
}
`,
)
.addFile(
'app/routes.ts',
() => `
import { type RouteConfig, index, route } from '@react-router/dev/routes';

export default [
index('routes/home.tsx'),
route('sign-in/*', 'routes/sign-in.tsx'),
route('sign-up/*', 'routes/sign-up.tsx'),
route('protected', 'routes/protected.tsx'),
route('api/m2m', 'routes/api/m2m.ts'),
] satisfies RouteConfig;
`,
)
.commit();

await app.setup();

const env = appConfigs.envs.withAPIKeys
.clone()
.setEnvVariable('private', 'CLERK_MACHINE_SECRET_KEY', network.primaryServer.secretKey);
await app.withEnv(env);
await app.dev();
});

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

test('rejects requests with invalid M2M tokens', async ({ request }) => {
const res = await request.get(app.serverUrl + '/api/m2m');
expect(res.status()).toBe(401);

const res2 = await request.get(app.serverUrl + '/api/m2m', {
headers: { Authorization: 'Bearer mt_xxx' },
});
expect(res2.status()).toBe(401);
});

test('rejects M2M requests when sender machine lacks access to receiver machine', async ({ request }) => {
const res = await request.get(app.serverUrl + '/api/m2m', {
headers: { Authorization: `Bearer ${network.unscopedSenderToken.token}` },
});
expect(res.status()).toBe(401);
});

test('authorizes M2M requests when sender machine has proper access', async ({ page, context }) => {
const u = createTestUtils({ app, page, context });

const res = await u.page.request.get(app.serverUrl + '/api/m2m', {
headers: { Authorization: `Bearer ${network.scopedSenderToken.token}` },
});
expect(res.status()).toBe(200);
const body = await res.json();
expect(body.subject).toBe(network.scopedSender.id);
expect(body.tokenType).toBe(TokenType.M2MToken);
});

test('authorizes after dynamically granting scope', async ({ page, context }) => {
const u = createTestUtils({ app, page, context });

await u.services.clerk.machines.createScope(network.unscopedSender.id, network.primaryServer.id);
const m2mToken = await u.services.clerk.m2m.createToken({
machineSecretKey: network.unscopedSender.secretKey,
secondsUntilExpiration: 60 * 30,
});

const res = await u.page.request.get(app.serverUrl + '/api/m2m', {
headers: { Authorization: `Bearer ${m2mToken.token}` },
});
expect(res.status()).toBe(200);
const body = await res.json();
expect(body.subject).toBe(network.unscopedSender.id);
expect(body.tokenType).toBe(TokenType.M2MToken);
await u.services.clerk.m2m.revokeToken({ m2mTokenId: m2mToken.id });
});

test('verifies JWT format M2M token via local verification', async ({ request }) => {
const client = createClerkClient({
secretKey: instanceKeys.get('with-api-keys').sk,
});
const jwtToken = await createJwtM2MToken(client, network.scopedSender.secretKey);

const res = await request.get(app.serverUrl + '/api/m2m', {
headers: { Authorization: `Bearer ${jwtToken.token}` },
});
expect(res.status()).toBe(200);
const body = await res.json();
expect(body.subject).toBe(network.scopedSender.id);
expect(body.tokenType).toBe(TokenType.M2MToken);
});

for (const [tokenType, token] of [
['API key', 'ak_test_mismatch'],
['OAuth', 'oat_test_mismatch'],
] as const) {
test(`rejects ${tokenType} token on M2M route (token type mismatch)`, async ({ request }) => {
const res = await request.get(app.serverUrl + '/api/m2m', {
headers: { Authorization: `Bearer ${token}` },
});
expect(res.status()).toBe(401);
});
}
});

test.describe('OAuth auth', () => {
test.describe.configure({ mode: 'parallel' });
let app: Application;
let fakeUser: FakeUser;
let fakeOAuth: FakeOAuthApp;

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

app = await appConfigs.reactRouter.reactRouterNode
.clone()
.addFile(
'app/routes/api/oauth-verify.ts',
() => `
import { getAuth } from '@clerk/react-router/server';
import type { Route } from './+types/oauth-verify';

export async function loader(args: Route.LoaderArgs) {
const { userId, tokenType } = await getAuth(args, { acceptsToken: 'oauth_token' });

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

return Response.json({ userId, tokenType });
}
`,
)
.addFile(
'app/routes/api/oauth-callback.ts',
() => `
export async function loader() {
return Response.json({ message: 'OAuth callback received' });
}
`,
)
.addFile(
'app/routes.ts',
() => `
import { type RouteConfig, index, route } from '@react-router/dev/routes';

export default [
index('routes/home.tsx'),
route('sign-in/*', 'routes/sign-in.tsx'),
route('sign-up/*', 'routes/sign-up.tsx'),
route('protected', 'routes/protected.tsx'),
route('api/oauth-verify', 'routes/api/oauth-verify.ts'),
route('api/oauth/callback', 'routes/api/oauth-callback.ts'),
] satisfies RouteConfig;
`,
)
.commit();

await app.setup();
await app.withEnv(appConfigs.envs.withAPIKeys);
await app.dev();

const u = createTestUtils({ app });
fakeUser = u.services.users.createFakeUser();
await u.services.users.createBapiUser(fakeUser);

const clerkClient = createClerkClient({
secretKey: app.env.privateVariables.get('CLERK_SECRET_KEY'),
publishableKey: app.env.publicVariables.get('CLERK_PUBLISHABLE_KEY'),
});

fakeOAuth = await createFakeOAuthApp(clerkClient, `${app.serverUrl}/api/oauth/callback`);
});

test.afterAll(async () => {
await fakeOAuth.cleanup();
await fakeUser.deleteIfExists();
await app.teardown();
});

test('verifies valid OAuth access token obtained through authorization flow', async ({ page, context }) => {
const u = createTestUtils({ app, page, context });

const accessToken = await obtainOAuthAccessToken({
page: u.page,
oAuthApp: fakeOAuth.oAuthApp,
redirectUri: `${app.serverUrl}/api/oauth/callback`,
fakeUser,
signIn: u.po.signIn,
});

const res = await u.page.request.get(new URL('/api/oauth-verify', app.serverUrl).toString(), {
headers: { Authorization: `Bearer ${accessToken}` },
});
expect(res.status()).toBe(200);
const authData = await res.json();
expect(authData.userId).toBeDefined();
expect(authData.tokenType).toBe(TokenType.OAuthToken);
});

test('rejects request without OAuth token', async ({ request }) => {
const url = new URL('/api/oauth-verify', app.serverUrl);
const res = await request.get(url.toString());
expect(res.status()).toBe(401);
});

test('rejects request with invalid OAuth token', async ({ request }) => {
const url = new URL('/api/oauth-verify', app.serverUrl);
const res = await request.get(url.toString(), {
headers: { Authorization: 'Bearer invalid_oauth_token' },
});
expect(res.status()).toBe(401);
});

for (const [tokenType, token] of [
['API key', 'ak_test_mismatch'],
['M2M', 'mt_test_mismatch'],
] as const) {
test(`rejects ${tokenType} token on OAuth route (token type mismatch)`, async ({ request }) => {
const url = new URL('/api/oauth-verify', app.serverUrl);
const res = await request.get(url.toString(), {
headers: { Authorization: `Bearer ${token}` },
});
expect(res.status()).toBe(401);
});
}
});
});
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
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;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} 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
381 changes: 381 additions & 0 deletions integration/tests/react-router/machine.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,381 @@
import type { User } from '@clerk/backend';
import { createClerkClient } from '@clerk/backend';
import { TokenType } from '@clerk/backend/internal';
import { expect, test } from '@playwright/test';

import type { Application } from '../../models/application';
import { appConfigs } from '../../presets';
import { instanceKeys } from '../../presets/envs';
import type { FakeAPIKey, FakeMachineNetwork, FakeOAuthApp, FakeUser } from '../../testUtils';
import {
createFakeMachineNetwork,
createFakeOAuthApp,
createJwtM2MToken,
createTestUtils,
obtainOAuthAccessToken,
} from '../../testUtils';

test.describe('React Router machine authentication @machine', () => {
test.describe('API key auth', () => {
test.describe.configure({ mode: 'parallel' });
let app: Application;
let fakeUser: FakeUser;
let fakeBapiUser: User;
let fakeAPIKey: FakeAPIKey;

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

app = await appConfigs.reactRouter.reactRouterNode
.clone()
.addFile(
'app/routes/api/me.ts',
() => `
import { getAuth } from '@clerk/react-router/server';
import type { Route } from './+types/me';

export async function loader(args: Route.LoaderArgs) {
const { userId, tokenType } = await getAuth(args, { acceptsToken: 'api_key' });

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

return Response.json({ userId, tokenType });
}
`,
)
.addFile(
'app/routes.ts',
() => `
import { type RouteConfig, index, route } from '@react-router/dev/routes';

export default [
index('routes/home.tsx'),
route('sign-in/*', 'routes/sign-in.tsx'),
route('sign-up/*', 'routes/sign-up.tsx'),
route('protected', 'routes/protected.tsx'),
route('api/me', 'routes/api/me.ts'),
] satisfies RouteConfig;
`,
)
.commit();

await app.setup();
await app.withEnv(appConfigs.envs.withAPIKeys);
await app.dev();

const u = createTestUtils({ app });
fakeUser = u.services.users.createFakeUser();
fakeBapiUser = await u.services.users.createBapiUser(fakeUser);
fakeAPIKey = await u.services.users.createFakeAPIKey(fakeBapiUser.id);
});

test.afterAll(async () => {
await fakeAPIKey.revoke();
await fakeUser.deleteIfExists();
await app.teardown();
});

test('should return 401 if no API key is provided', async ({ request }) => {
const url = new URL('/api/me', app.serverUrl);
const res = await request.get(url.toString());
expect(res.status()).toBe(401);
});

test('should return 401 if API key is invalid', async ({ request }) => {
const url = new URL('/api/me', app.serverUrl);
const res = await request.get(url.toString(), {
headers: { Authorization: 'Bearer invalid_key' },
});
expect(res.status()).toBe(401);
});

test('should return 200 with auth object if API key is valid', async ({ request }) => {
const url = new URL('/api/me', app.serverUrl);
const res = await request.get(url.toString(), {
headers: {
Authorization: `Bearer ${fakeAPIKey.secret}`,
},
});
const apiKeyData = await res.json();
expect(res.status()).toBe(200);
expect(apiKeyData.userId).toBe(fakeBapiUser.id);
expect(apiKeyData.tokenType).toBe(TokenType.ApiKey);
});

for (const [tokenType, token] of [
['M2M', 'mt_test_mismatch'],
['OAuth', 'oat_test_mismatch'],
] as const) {
test(`rejects ${tokenType} token on API key route (token type mismatch)`, async ({ request }) => {
const url = new URL('/api/me', app.serverUrl);
const res = await request.get(url.toString(), {
headers: { Authorization: `Bearer ${token}` },
});
expect(res.status()).toBe(401);
});
}
});

test.describe('M2M auth', () => {
test.describe.configure({ mode: 'parallel' });
let app: Application;
let network: FakeMachineNetwork;

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

const client = createClerkClient({
secretKey: instanceKeys.get('with-api-keys').sk,
});
network = await createFakeMachineNetwork(client);

app = await appConfigs.reactRouter.reactRouterNode
.clone()
.addFile(
'app/routes/api/m2m.ts',
() => `
import { getAuth } from '@clerk/react-router/server';
import type { Route } from './+types/m2m';

export async function loader(args: Route.LoaderArgs) {
const { subject, tokenType, isAuthenticated } = await getAuth(args, { acceptsToken: 'm2m_token' });

if (!isAuthenticated) {
return Response.json({ error: 'Unauthorized' }, { status: 401 });
}

return Response.json({ subject, tokenType });
}
`,
)
.addFile(
'app/routes.ts',
() => `
import { type RouteConfig, index, route } from '@react-router/dev/routes';

export default [
index('routes/home.tsx'),
route('sign-in/*', 'routes/sign-in.tsx'),
route('sign-up/*', 'routes/sign-up.tsx'),
route('protected', 'routes/protected.tsx'),
route('api/m2m', 'routes/api/m2m.ts'),
] satisfies RouteConfig;
`,
)
.commit();

await app.setup();

const env = appConfigs.envs.withAPIKeys
.clone()
.setEnvVariable('private', 'CLERK_MACHINE_SECRET_KEY', network.primaryServer.secretKey);
await app.withEnv(env);
await app.dev();
});

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

test('rejects requests with invalid M2M tokens', async ({ request }) => {
const res = await request.get(app.serverUrl + '/api/m2m');
expect(res.status()).toBe(401);

const res2 = await request.get(app.serverUrl + '/api/m2m', {
headers: { Authorization: 'Bearer mt_xxx' },
});
expect(res2.status()).toBe(401);
});

test('rejects M2M requests when sender machine lacks access to receiver machine', async ({ request }) => {
const res = await request.get(app.serverUrl + '/api/m2m', {
headers: { Authorization: `Bearer ${network.unscopedSenderToken.token}` },
});
expect(res.status()).toBe(401);
});

test('authorizes M2M requests when sender machine has proper access', async ({ page, context }) => {
const u = createTestUtils({ app, page, context });

const res = await u.page.request.get(app.serverUrl + '/api/m2m', {
headers: { Authorization: `Bearer ${network.scopedSenderToken.token}` },
});
expect(res.status()).toBe(200);
const body = await res.json();
expect(body.subject).toBe(network.scopedSender.id);
expect(body.tokenType).toBe(TokenType.M2MToken);
});

test('authorizes after dynamically granting scope', async ({ page, context }) => {
const u = createTestUtils({ app, page, context });

await u.services.clerk.machines.createScope(network.unscopedSender.id, network.primaryServer.id);
const m2mToken = await u.services.clerk.m2m.createToken({
machineSecretKey: network.unscopedSender.secretKey,
secondsUntilExpiration: 60 * 30,
});

const res = await u.page.request.get(app.serverUrl + '/api/m2m', {
headers: { Authorization: `Bearer ${m2mToken.token}` },
});
expect(res.status()).toBe(200);
const body = await res.json();
expect(body.subject).toBe(network.unscopedSender.id);
expect(body.tokenType).toBe(TokenType.M2MToken);
await u.services.clerk.m2m.revokeToken({ m2mTokenId: m2mToken.id });
});

test('verifies JWT format M2M token via local verification', async ({ request }) => {
const client = createClerkClient({
secretKey: instanceKeys.get('with-api-keys').sk,
});
const jwtToken = await createJwtM2MToken(client, network.scopedSender.secretKey);

const res = await request.get(app.serverUrl + '/api/m2m', {
headers: { Authorization: `Bearer ${jwtToken.token}` },
});
expect(res.status()).toBe(200);
const body = await res.json();
expect(body.subject).toBe(network.scopedSender.id);
expect(body.tokenType).toBe(TokenType.M2MToken);
});

for (const [tokenType, token] of [
['API key', 'ak_test_mismatch'],
['OAuth', 'oat_test_mismatch'],
] as const) {
test(`rejects ${tokenType} token on M2M route (token type mismatch)`, async ({ request }) => {
const res = await request.get(app.serverUrl + '/api/m2m', {
headers: { Authorization: `Bearer ${token}` },
});
expect(res.status()).toBe(401);
});
}
});

test.describe('OAuth auth', () => {
test.describe.configure({ mode: 'parallel' });
let app: Application;
let fakeUser: FakeUser;
let fakeOAuth: FakeOAuthApp;

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

app = await appConfigs.reactRouter.reactRouterNode
.clone()
.addFile(
'app/routes/api/oauth-verify.ts',
() => `
import { getAuth } from '@clerk/react-router/server';
import type { Route } from './+types/oauth-verify';

export async function loader(args: Route.LoaderArgs) {
const { userId, tokenType } = await getAuth(args, { acceptsToken: 'oauth_token' });

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

return Response.json({ userId, tokenType });
}
`,
)
.addFile(
'app/routes/api/oauth-callback.ts',
() => `
export async function loader() {
return Response.json({ message: 'OAuth callback received' });
}
`,
)
.addFile(
'app/routes.ts',
() => `
import { type RouteConfig, index, route } from '@react-router/dev/routes';

export default [
index('routes/home.tsx'),
route('sign-in/*', 'routes/sign-in.tsx'),
route('sign-up/*', 'routes/sign-up.tsx'),
route('protected', 'routes/protected.tsx'),
route('api/oauth-verify', 'routes/api/oauth-verify.ts'),
route('api/oauth/callback', 'routes/api/oauth-callback.ts'),
] satisfies RouteConfig;
`,
)
.commit();

await app.setup();
await app.withEnv(appConfigs.envs.withAPIKeys);
await app.dev();

const u = createTestUtils({ app });
fakeUser = u.services.users.createFakeUser();
await u.services.users.createBapiUser(fakeUser);

const clerkClient = createClerkClient({
secretKey: app.env.privateVariables.get('CLERK_SECRET_KEY'),
publishableKey: app.env.publicVariables.get('CLERK_PUBLISHABLE_KEY'),
});

fakeOAuth = await createFakeOAuthApp(clerkClient, `${app.serverUrl}/api/oauth/callback`);
});

test.afterAll(async () => {
await fakeOAuth.cleanup();
await fakeUser.deleteIfExists();
await app.teardown();
});

test('verifies valid OAuth access token obtained through authorization flow', async ({ page, context }) => {
const u = createTestUtils({ app, page, context });

const accessToken = await obtainOAuthAccessToken({
page: u.page,
oAuthApp: fakeOAuth.oAuthApp,
redirectUri: `${app.serverUrl}/api/oauth/callback`,
fakeUser,
signIn: u.po.signIn,
});

const res = await u.page.request.get(new URL('/api/oauth-verify', app.serverUrl).toString(), {
headers: { Authorization: `Bearer ${accessToken}` },
});
expect(res.status()).toBe(200);
const authData = await res.json();
expect(authData.userId).toBeDefined();
expect(authData.tokenType).toBe(TokenType.OAuthToken);
});

test('rejects request without OAuth token', async ({ request }) => {
const url = new URL('/api/oauth-verify', app.serverUrl);
const res = await request.get(url.toString());
expect(res.status()).toBe(401);
});

test('rejects request with invalid OAuth token', async ({ request }) => {
const url = new URL('/api/oauth-verify', app.serverUrl);
const res = await request.get(url.toString(), {
headers: { Authorization: 'Bearer invalid_oauth_token' },
});
expect(res.status()).toBe(401);
});

for (const [tokenType, token] of [
['API key', 'ak_test_mismatch'],
['M2M', 'mt_test_mismatch'],
] as const) {
test(`rejects ${tokenType} token on OAuth route (token type mismatch)`, async ({ request }) => {
const url = new URL('/api/oauth-verify', app.serverUrl);
const res = await request.get(url.toString(), {
headers: { Authorization: `Bearer ${token}` },
});
expect(res.status()).toBe(401);
});
}
});
});
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Force GitHub README to respect dark mode (function() { var style = document.createElement('style'); style.textContent = ' .markdown-body { color-scheme: dark light; } .markdown-body pre { background: #161b22 !important; } .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; } .markdown-body table th, .markdown-body table td { border-color: #30363d !important; } .markdown-body img { background: #0d1117; } .markdown-body blockquote { border-left-color: #8b949e; } .markdown-body hr { border-color: #30363d; } '; document.head.appendChild(style); })(); } } 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
381 changes: 381 additions & 0 deletions integration/tests/react-router/machine.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,381 @@
import type { User } from '@clerk/backend';
import { createClerkClient } from '@clerk/backend';
import { TokenType } from '@clerk/backend/internal';
import { expect, test } from '@playwright/test';

import type { Application } from '../../models/application';
import { appConfigs } from '../../presets';
import { instanceKeys } from '../../presets/envs';
import type { FakeAPIKey, FakeMachineNetwork, FakeOAuthApp, FakeUser } from '../../testUtils';
import {
createFakeMachineNetwork,
createFakeOAuthApp,
createJwtM2MToken,
createTestUtils,
obtainOAuthAccessToken,
} from '../../testUtils';

test.describe('React Router machine authentication @machine', () => {
test.describe('API key auth', () => {
test.describe.configure({ mode: 'parallel' });
let app: Application;
let fakeUser: FakeUser;
let fakeBapiUser: User;
let fakeAPIKey: FakeAPIKey;

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

app = await appConfigs.reactRouter.reactRouterNode
.clone()
.addFile(
'app/routes/api/me.ts',
() => `
import { getAuth } from '@clerk/react-router/server';
import type { Route } from './+types/me';

export async function loader(args: Route.LoaderArgs) {
const { userId, tokenType } = await getAuth(args, { acceptsToken: 'api_key' });

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

return Response.json({ userId, tokenType });
}
`,
)
.addFile(
'app/routes.ts',
() => `
import { type RouteConfig, index, route } from '@react-router/dev/routes';

export default [
index('routes/home.tsx'),
route('sign-in/*', 'routes/sign-in.tsx'),
route('sign-up/*', 'routes/sign-up.tsx'),
route('protected', 'routes/protected.tsx'),
route('api/me', 'routes/api/me.ts'),
] satisfies RouteConfig;
`,
)
.commit();

await app.setup();
await app.withEnv(appConfigs.envs.withAPIKeys);
await app.dev();

const u = createTestUtils({ app });
fakeUser = u.services.users.createFakeUser();
fakeBapiUser = await u.services.users.createBapiUser(fakeUser);
fakeAPIKey = await u.services.users.createFakeAPIKey(fakeBapiUser.id);
});

test.afterAll(async () => {
await fakeAPIKey.revoke();
await fakeUser.deleteIfExists();
await app.teardown();
});

test('should return 401 if no API key is provided', async ({ request }) => {
const url = new URL('/api/me', app.serverUrl);
const res = await request.get(url.toString());
expect(res.status()).toBe(401);
});

test('should return 401 if API key is invalid', async ({ request }) => {
const url = new URL('/api/me', app.serverUrl);
const res = await request.get(url.toString(), {
headers: { Authorization: 'Bearer invalid_key' },
});
expect(res.status()).toBe(401);
});

test('should return 200 with auth object if API key is valid', async ({ request }) => {
const url = new URL('/api/me', app.serverUrl);
const res = await request.get(url.toString(), {
headers: {
Authorization: `Bearer ${fakeAPIKey.secret}`,
},
});
const apiKeyData = await res.json();
expect(res.status()).toBe(200);
expect(apiKeyData.userId).toBe(fakeBapiUser.id);
expect(apiKeyData.tokenType).toBe(TokenType.ApiKey);
});

for (const [tokenType, token] of [
['M2M', 'mt_test_mismatch'],
['OAuth', 'oat_test_mismatch'],
] as const) {
test(`rejects ${tokenType} token on API key route (token type mismatch)`, async ({ request }) => {
const url = new URL('/api/me', app.serverUrl);
const res = await request.get(url.toString(), {
headers: { Authorization: `Bearer ${token}` },
});
expect(res.status()).toBe(401);
});
}
});

test.describe('M2M auth', () => {
test.describe.configure({ mode: 'parallel' });
let app: Application;
let network: FakeMachineNetwork;

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

const client = createClerkClient({
secretKey: instanceKeys.get('with-api-keys').sk,
});
network = await createFakeMachineNetwork(client);

app = await appConfigs.reactRouter.reactRouterNode
.clone()
.addFile(
'app/routes/api/m2m.ts',
() => `
import { getAuth } from '@clerk/react-router/server';
import type { Route } from './+types/m2m';

export async function loader(args: Route.LoaderArgs) {
const { subject, tokenType, isAuthenticated } = await getAuth(args, { acceptsToken: 'm2m_token' });

if (!isAuthenticated) {
return Response.json({ error: 'Unauthorized' }, { status: 401 });
}

return Response.json({ subject, tokenType });
}
`,
)
.addFile(
'app/routes.ts',
() => `
import { type RouteConfig, index, route } from '@react-router/dev/routes';

export default [
index('routes/home.tsx'),
route('sign-in/*', 'routes/sign-in.tsx'),
route('sign-up/*', 'routes/sign-up.tsx'),
route('protected', 'routes/protected.tsx'),
route('api/m2m', 'routes/api/m2m.ts'),
] satisfies RouteConfig;
`,
)
.commit();

await app.setup();

const env = appConfigs.envs.withAPIKeys
.clone()
.setEnvVariable('private', 'CLERK_MACHINE_SECRET_KEY', network.primaryServer.secretKey);
await app.withEnv(env);
await app.dev();
});

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

test('rejects requests with invalid M2M tokens', async ({ request }) => {
const res = await request.get(app.serverUrl + '/api/m2m');
expect(res.status()).toBe(401);

const res2 = await request.get(app.serverUrl + '/api/m2m', {
headers: { Authorization: 'Bearer mt_xxx' },
});
expect(res2.status()).toBe(401);
});

test('rejects M2M requests when sender machine lacks access to receiver machine', async ({ request }) => {
const res = await request.get(app.serverUrl + '/api/m2m', {
headers: { Authorization: `Bearer ${network.unscopedSenderToken.token}` },
});
expect(res.status()).toBe(401);
});

test('authorizes M2M requests when sender machine has proper access', async ({ page, context }) => {
const u = createTestUtils({ app, page, context });

const res = await u.page.request.get(app.serverUrl + '/api/m2m', {
headers: { Authorization: `Bearer ${network.scopedSenderToken.token}` },
});
expect(res.status()).toBe(200);
const body = await res.json();
expect(body.subject).toBe(network.scopedSender.id);
expect(body.tokenType).toBe(TokenType.M2MToken);
});

test('authorizes after dynamically granting scope', async ({ page, context }) => {
const u = createTestUtils({ app, page, context });

await u.services.clerk.machines.createScope(network.unscopedSender.id, network.primaryServer.id);
const m2mToken = await u.services.clerk.m2m.createToken({
machineSecretKey: network.unscopedSender.secretKey,
secondsUntilExpiration: 60 * 30,
});

const res = await u.page.request.get(app.serverUrl + '/api/m2m', {
headers: { Authorization: `Bearer ${m2mToken.token}` },
});
expect(res.status()).toBe(200);
const body = await res.json();
expect(body.subject).toBe(network.unscopedSender.id);
expect(body.tokenType).toBe(TokenType.M2MToken);
await u.services.clerk.m2m.revokeToken({ m2mTokenId: m2mToken.id });
});

test('verifies JWT format M2M token via local verification', async ({ request }) => {
const client = createClerkClient({
secretKey: instanceKeys.get('with-api-keys').sk,
});
const jwtToken = await createJwtM2MToken(client, network.scopedSender.secretKey);

const res = await request.get(app.serverUrl + '/api/m2m', {
headers: { Authorization: `Bearer ${jwtToken.token}` },
});
expect(res.status()).toBe(200);
const body = await res.json();
expect(body.subject).toBe(network.scopedSender.id);
expect(body.tokenType).toBe(TokenType.M2MToken);
});

for (const [tokenType, token] of [
['API key', 'ak_test_mismatch'],
['OAuth', 'oat_test_mismatch'],
] as const) {
test(`rejects ${tokenType} token on M2M route (token type mismatch)`, async ({ request }) => {
const res = await request.get(app.serverUrl + '/api/m2m', {
headers: { Authorization: `Bearer ${token}` },
});
expect(res.status()).toBe(401);
});
}
});

test.describe('OAuth auth', () => {
test.describe.configure({ mode: 'parallel' });
let app: Application;
let fakeUser: FakeUser;
let fakeOAuth: FakeOAuthApp;

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

app = await appConfigs.reactRouter.reactRouterNode
.clone()
.addFile(
'app/routes/api/oauth-verify.ts',
() => `
import { getAuth } from '@clerk/react-router/server';
import type { Route } from './+types/oauth-verify';

export async function loader(args: Route.LoaderArgs) {
const { userId, tokenType } = await getAuth(args, { acceptsToken: 'oauth_token' });

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

return Response.json({ userId, tokenType });
}
`,
)
.addFile(
'app/routes/api/oauth-callback.ts',
() => `
export async function loader() {
return Response.json({ message: 'OAuth callback received' });
}
`,
)
.addFile(
'app/routes.ts',
() => `
import { type RouteConfig, index, route } from '@react-router/dev/routes';

export default [
index('routes/home.tsx'),
route('sign-in/*', 'routes/sign-in.tsx'),
route('sign-up/*', 'routes/sign-up.tsx'),
route('protected', 'routes/protected.tsx'),
route('api/oauth-verify', 'routes/api/oauth-verify.ts'),
route('api/oauth/callback', 'routes/api/oauth-callback.ts'),
] satisfies RouteConfig;
`,
)
.commit();

await app.setup();
await app.withEnv(appConfigs.envs.withAPIKeys);
await app.dev();

const u = createTestUtils({ app });
fakeUser = u.services.users.createFakeUser();
await u.services.users.createBapiUser(fakeUser);

const clerkClient = createClerkClient({
secretKey: app.env.privateVariables.get('CLERK_SECRET_KEY'),
publishableKey: app.env.publicVariables.get('CLERK_PUBLISHABLE_KEY'),
});

fakeOAuth = await createFakeOAuthApp(clerkClient, `${app.serverUrl}/api/oauth/callback`);
});

test.afterAll(async () => {
await fakeOAuth.cleanup();
await fakeUser.deleteIfExists();
await app.teardown();
});

test('verifies valid OAuth access token obtained through authorization flow', async ({ page, context }) => {
const u = createTestUtils({ app, page, context });

const accessToken = await obtainOAuthAccessToken({
page: u.page,
oAuthApp: fakeOAuth.oAuthApp,
redirectUri: `${app.serverUrl}/api/oauth/callback`,
fakeUser,
signIn: u.po.signIn,
});

const res = await u.page.request.get(new URL('/api/oauth-verify', app.serverUrl).toString(), {
headers: { Authorization: `Bearer ${accessToken}` },
});
expect(res.status()).toBe(200);
const authData = await res.json();
expect(authData.userId).toBeDefined();
expect(authData.tokenType).toBe(TokenType.OAuthToken);
});

test('rejects request without OAuth token', async ({ request }) => {
const url = new URL('/api/oauth-verify', app.serverUrl);
const res = await request.get(url.toString());
expect(res.status()).toBe(401);
});

test('rejects request with invalid OAuth token', async ({ request }) => {
const url = new URL('/api/oauth-verify', app.serverUrl);
const res = await request.get(url.toString(), {
headers: { Authorization: 'Bearer invalid_oauth_token' },
});
expect(res.status()).toBe(401);
});

for (const [tokenType, token] of [
['API key', 'ak_test_mismatch'],
['M2M', 'mt_test_mismatch'],
] as const) {
test(`rejects ${tokenType} token on OAuth route (token type mismatch)`, async ({ request }) => {
const url = new URL('/api/oauth-verify', app.serverUrl);
const res = await request.get(url.toString(), {
headers: { Authorization: `Bearer ${token}` },
});
expect(res.status()).toBe(401);
});
}
});
});
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Highlight search terms from Google/DuckDuckGo/Bing referrer (function() { var ref = document.referrer; var terms = []; if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) { var url = new URL(ref); var q = url.searchParams.get('q') || url.searchParams.get('p'); if (q) { terms = q.split(/\s+/).filter(function(t) { return t.length > 2; }); } } if (terms.length === 0) return; var style = document.createElement('style'); style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }'; document.head.appendChild(style); function highlight(node) { if (node.nodeType === 3) { // text node var text = node.textContent; var found = false; terms.forEach(function(term) { var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } 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
381 changes: 381 additions & 0 deletions integration/tests/react-router/machine.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,381 @@
import type { User } from '@clerk/backend';
import { createClerkClient } from '@clerk/backend';
import { TokenType } from '@clerk/backend/internal';
import { expect, test } from '@playwright/test';

import type { Application } from '../../models/application';
import { appConfigs } from '../../presets';
import { instanceKeys } from '../../presets/envs';
import type { FakeAPIKey, FakeMachineNetwork, FakeOAuthApp, FakeUser } from '../../testUtils';
import {
createFakeMachineNetwork,
createFakeOAuthApp,
createJwtM2MToken,
createTestUtils,
obtainOAuthAccessToken,
} from '../../testUtils';

test.describe('React Router machine authentication @machine', () => {
test.describe('API key auth', () => {
test.describe.configure({ mode: 'parallel' });
let app: Application;
let fakeUser: FakeUser;
let fakeBapiUser: User;
let fakeAPIKey: FakeAPIKey;

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

app = await appConfigs.reactRouter.reactRouterNode
.clone()
.addFile(
'app/routes/api/me.ts',
() => `
import { getAuth } from '@clerk/react-router/server';
import type { Route } from './+types/me';

export async function loader(args: Route.LoaderArgs) {
const { userId, tokenType } = await getAuth(args, { acceptsToken: 'api_key' });

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

return Response.json({ userId, tokenType });
}
`,
)
.addFile(
'app/routes.ts',
() => `
import { type RouteConfig, index, route } from '@react-router/dev/routes';

export default [
index('routes/home.tsx'),
route('sign-in/*', 'routes/sign-in.tsx'),
route('sign-up/*', 'routes/sign-up.tsx'),
route('protected', 'routes/protected.tsx'),
route('api/me', 'routes/api/me.ts'),
] satisfies RouteConfig;
`,
)
.commit();

await app.setup();
await app.withEnv(appConfigs.envs.withAPIKeys);
await app.dev();

const u = createTestUtils({ app });
fakeUser = u.services.users.createFakeUser();
fakeBapiUser = await u.services.users.createBapiUser(fakeUser);
fakeAPIKey = await u.services.users.createFakeAPIKey(fakeBapiUser.id);
});

test.afterAll(async () => {
await fakeAPIKey.revoke();
await fakeUser.deleteIfExists();
await app.teardown();
});

test('should return 401 if no API key is provided', async ({ request }) => {
const url = new URL('/api/me', app.serverUrl);
const res = await request.get(url.toString());
expect(res.status()).toBe(401);
});

test('should return 401 if API key is invalid', async ({ request }) => {
const url = new URL('/api/me', app.serverUrl);
const res = await request.get(url.toString(), {
headers: { Authorization: 'Bearer invalid_key' },
});
expect(res.status()).toBe(401);
});

test('should return 200 with auth object if API key is valid', async ({ request }) => {
const url = new URL('/api/me', app.serverUrl);
const res = await request.get(url.toString(), {
headers: {
Authorization: `Bearer ${fakeAPIKey.secret}`,
},
});
const apiKeyData = await res.json();
expect(res.status()).toBe(200);
expect(apiKeyData.userId).toBe(fakeBapiUser.id);
expect(apiKeyData.tokenType).toBe(TokenType.ApiKey);
});

for (const [tokenType, token] of [
['M2M', 'mt_test_mismatch'],
['OAuth', 'oat_test_mismatch'],
] as const) {
test(`rejects ${tokenType} token on API key route (token type mismatch)`, async ({ request }) => {
const url = new URL('/api/me', app.serverUrl);
const res = await request.get(url.toString(), {
headers: { Authorization: `Bearer ${token}` },
});
expect(res.status()).toBe(401);
});
}
});

test.describe('M2M auth', () => {
test.describe.configure({ mode: 'parallel' });
let app: Application;
let network: FakeMachineNetwork;

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

const client = createClerkClient({
secretKey: instanceKeys.get('with-api-keys').sk,
});
network = await createFakeMachineNetwork(client);

app = await appConfigs.reactRouter.reactRouterNode
.clone()
.addFile(
'app/routes/api/m2m.ts',
() => `
import { getAuth } from '@clerk/react-router/server';
import type { Route } from './+types/m2m';

export async function loader(args: Route.LoaderArgs) {
const { subject, tokenType, isAuthenticated } = await getAuth(args, { acceptsToken: 'm2m_token' });

if (!isAuthenticated) {
return Response.json({ error: 'Unauthorized' }, { status: 401 });
}

return Response.json({ subject, tokenType });
}
`,
)
.addFile(
'app/routes.ts',
() => `
import { type RouteConfig, index, route } from '@react-router/dev/routes';

export default [
index('routes/home.tsx'),
route('sign-in/*', 'routes/sign-in.tsx'),
route('sign-up/*', 'routes/sign-up.tsx'),
route('protected', 'routes/protected.tsx'),
route('api/m2m', 'routes/api/m2m.ts'),
] satisfies RouteConfig;
`,
)
.commit();

await app.setup();

const env = appConfigs.envs.withAPIKeys
.clone()
.setEnvVariable('private', 'CLERK_MACHINE_SECRET_KEY', network.primaryServer.secretKey);
await app.withEnv(env);
await app.dev();
});

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

test('rejects requests with invalid M2M tokens', async ({ request }) => {
const res = await request.get(app.serverUrl + '/api/m2m');
expect(res.status()).toBe(401);

const res2 = await request.get(app.serverUrl + '/api/m2m', {
headers: { Authorization: 'Bearer mt_xxx' },
});
expect(res2.status()).toBe(401);
});

test('rejects M2M requests when sender machine lacks access to receiver machine', async ({ request }) => {
const res = await request.get(app.serverUrl + '/api/m2m', {
headers: { Authorization: `Bearer ${network.unscopedSenderToken.token}` },
});
expect(res.status()).toBe(401);
});

test('authorizes M2M requests when sender machine has proper access', async ({ page, context }) => {
const u = createTestUtils({ app, page, context });

const res = await u.page.request.get(app.serverUrl + '/api/m2m', {
headers: { Authorization: `Bearer ${network.scopedSenderToken.token}` },
});
expect(res.status()).toBe(200);
const body = await res.json();
expect(body.subject).toBe(network.scopedSender.id);
expect(body.tokenType).toBe(TokenType.M2MToken);
});

test('authorizes after dynamically granting scope', async ({ page, context }) => {
const u = createTestUtils({ app, page, context });

await u.services.clerk.machines.createScope(network.unscopedSender.id, network.primaryServer.id);
const m2mToken = await u.services.clerk.m2m.createToken({
machineSecretKey: network.unscopedSender.secretKey,
secondsUntilExpiration: 60 * 30,
});

const res = await u.page.request.get(app.serverUrl + '/api/m2m', {
headers: { Authorization: `Bearer ${m2mToken.token}` },
});
expect(res.status()).toBe(200);
const body = await res.json();
expect(body.subject).toBe(network.unscopedSender.id);
expect(body.tokenType).toBe(TokenType.M2MToken);
await u.services.clerk.m2m.revokeToken({ m2mTokenId: m2mToken.id });
});

test('verifies JWT format M2M token via local verification', async ({ request }) => {
const client = createClerkClient({
secretKey: instanceKeys.get('with-api-keys').sk,
});
const jwtToken = await createJwtM2MToken(client, network.scopedSender.secretKey);

const res = await request.get(app.serverUrl + '/api/m2m', {
headers: { Authorization: `Bearer ${jwtToken.token}` },
});
expect(res.status()).toBe(200);
const body = await res.json();
expect(body.subject).toBe(network.scopedSender.id);
expect(body.tokenType).toBe(TokenType.M2MToken);
});

for (const [tokenType, token] of [
['API key', 'ak_test_mismatch'],
['OAuth', 'oat_test_mismatch'],
] as const) {
test(`rejects ${tokenType} token on M2M route (token type mismatch)`, async ({ request }) => {
const res = await request.get(app.serverUrl + '/api/m2m', {
headers: { Authorization: `Bearer ${token}` },
});
expect(res.status()).toBe(401);
});
}
});

test.describe('OAuth auth', () => {
test.describe.configure({ mode: 'parallel' });
let app: Application;
let fakeUser: FakeUser;
let fakeOAuth: FakeOAuthApp;

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

app = await appConfigs.reactRouter.reactRouterNode
.clone()
.addFile(
'app/routes/api/oauth-verify.ts',
() => `
import { getAuth } from '@clerk/react-router/server';
import type { Route } from './+types/oauth-verify';

export async function loader(args: Route.LoaderArgs) {
const { userId, tokenType } = await getAuth(args, { acceptsToken: 'oauth_token' });

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

return Response.json({ userId, tokenType });
}
`,
)
.addFile(
'app/routes/api/oauth-callback.ts',
() => `
export async function loader() {
return Response.json({ message: 'OAuth callback received' });
}
`,
)
.addFile(
'app/routes.ts',
() => `
import { type RouteConfig, index, route } from '@react-router/dev/routes';

export default [
index('routes/home.tsx'),
route('sign-in/*', 'routes/sign-in.tsx'),
route('sign-up/*', 'routes/sign-up.tsx'),
route('protected', 'routes/protected.tsx'),
route('api/oauth-verify', 'routes/api/oauth-verify.ts'),
route('api/oauth/callback', 'routes/api/oauth-callback.ts'),
] satisfies RouteConfig;
`,
)
.commit();

await app.setup();
await app.withEnv(appConfigs.envs.withAPIKeys);
await app.dev();

const u = createTestUtils({ app });
fakeUser = u.services.users.createFakeUser();
await u.services.users.createBapiUser(fakeUser);

const clerkClient = createClerkClient({
secretKey: app.env.privateVariables.get('CLERK_SECRET_KEY'),
publishableKey: app.env.publicVariables.get('CLERK_PUBLISHABLE_KEY'),
});

fakeOAuth = await createFakeOAuthApp(clerkClient, `${app.serverUrl}/api/oauth/callback`);
});

test.afterAll(async () => {
await fakeOAuth.cleanup();
await fakeUser.deleteIfExists();
await app.teardown();
});

test('verifies valid OAuth access token obtained through authorization flow', async ({ page, context }) => {
const u = createTestUtils({ app, page, context });

const accessToken = await obtainOAuthAccessToken({
page: u.page,
oAuthApp: fakeOAuth.oAuthApp,
redirectUri: `${app.serverUrl}/api/oauth/callback`,
fakeUser,
signIn: u.po.signIn,
});

const res = await u.page.request.get(new URL('/api/oauth-verify', app.serverUrl).toString(), {
headers: { Authorization: `Bearer ${accessToken}` },
});
expect(res.status()).toBe(200);
const authData = await res.json();
expect(authData.userId).toBeDefined();
expect(authData.tokenType).toBe(TokenType.OAuthToken);
});

test('rejects request without OAuth token', async ({ request }) => {
const url = new URL('/api/oauth-verify', app.serverUrl);
const res = await request.get(url.toString());
expect(res.status()).toBe(401);
});

test('rejects request with invalid OAuth token', async ({ request }) => {
const url = new URL('/api/oauth-verify', app.serverUrl);
const res = await request.get(url.toString(), {
headers: { Authorization: 'Bearer invalid_oauth_token' },
});
expect(res.status()).toBe(401);
});

for (const [tokenType, token] of [
['API key', 'ak_test_mismatch'],
['M2M', 'mt_test_mismatch'],
] as const) {
test(`rejects ${tokenType} token on OAuth route (token type mismatch)`, async ({ request }) => {
const url = new URL('/api/oauth-verify', app.serverUrl);
const res = await request.get(url.toString(), {
headers: { Authorization: `Bearer ${token}` },
});
expect(res.status()).toBe(401);
});
}
});
});
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } 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
381 changes: 381 additions & 0 deletions integration/tests/react-router/machine.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,381 @@
import type { User } from '@clerk/backend';
import { createClerkClient } from '@clerk/backend';
import { TokenType } from '@clerk/backend/internal';
import { expect, test } from '@playwright/test';

import type { Application } from '../../models/application';
import { appConfigs } from '../../presets';
import { instanceKeys } from '../../presets/envs';
import type { FakeAPIKey, FakeMachineNetwork, FakeOAuthApp, FakeUser } from '../../testUtils';
import {
createFakeMachineNetwork,
createFakeOAuthApp,
createJwtM2MToken,
createTestUtils,
obtainOAuthAccessToken,
} from '../../testUtils';

test.describe('React Router machine authentication @machine', () => {
test.describe('API key auth', () => {
test.describe.configure({ mode: 'parallel' });
let app: Application;
let fakeUser: FakeUser;
let fakeBapiUser: User;
let fakeAPIKey: FakeAPIKey;

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

app = await appConfigs.reactRouter.reactRouterNode
.clone()
.addFile(
'app/routes/api/me.ts',
() => `
import { getAuth } from '@clerk/react-router/server';
import type { Route } from './+types/me';

export async function loader(args: Route.LoaderArgs) {
const { userId, tokenType } = await getAuth(args, { acceptsToken: 'api_key' });

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

return Response.json({ userId, tokenType });
}
`,
)
.addFile(
'app/routes.ts',
() => `
import { type RouteConfig, index, route } from '@react-router/dev/routes';

export default [
index('routes/home.tsx'),
route('sign-in/*', 'routes/sign-in.tsx'),
route('sign-up/*', 'routes/sign-up.tsx'),
route('protected', 'routes/protected.tsx'),
route('api/me', 'routes/api/me.ts'),
] satisfies RouteConfig;
`,
)
.commit();

await app.setup();
await app.withEnv(appConfigs.envs.withAPIKeys);
await app.dev();

const u = createTestUtils({ app });
fakeUser = u.services.users.createFakeUser();
fakeBapiUser = await u.services.users.createBapiUser(fakeUser);
fakeAPIKey = await u.services.users.createFakeAPIKey(fakeBapiUser.id);
});

test.afterAll(async () => {
await fakeAPIKey.revoke();
await fakeUser.deleteIfExists();
await app.teardown();
});

test('should return 401 if no API key is provided', async ({ request }) => {
const url = new URL('/api/me', app.serverUrl);
const res = await request.get(url.toString());
expect(res.status()).toBe(401);
});

test('should return 401 if API key is invalid', async ({ request }) => {
const url = new URL('/api/me', app.serverUrl);
const res = await request.get(url.toString(), {
headers: { Authorization: 'Bearer invalid_key' },
});
expect(res.status()).toBe(401);
});

test('should return 200 with auth object if API key is valid', async ({ request }) => {
const url = new URL('/api/me', app.serverUrl);
const res = await request.get(url.toString(), {
headers: {
Authorization: `Bearer ${fakeAPIKey.secret}`,
},
});
const apiKeyData = await res.json();
expect(res.status()).toBe(200);
expect(apiKeyData.userId).toBe(fakeBapiUser.id);
expect(apiKeyData.tokenType).toBe(TokenType.ApiKey);
});

for (const [tokenType, token] of [
['M2M', 'mt_test_mismatch'],
['OAuth', 'oat_test_mismatch'],
] as const) {
test(`rejects ${tokenType} token on API key route (token type mismatch)`, async ({ request }) => {
const url = new URL('/api/me', app.serverUrl);
const res = await request.get(url.toString(), {
headers: { Authorization: `Bearer ${token}` },
});
expect(res.status()).toBe(401);
});
}
});

test.describe('M2M auth', () => {
test.describe.configure({ mode: 'parallel' });
let app: Application;
let network: FakeMachineNetwork;

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

const client = createClerkClient({
secretKey: instanceKeys.get('with-api-keys').sk,
});
network = await createFakeMachineNetwork(client);

app = await appConfigs.reactRouter.reactRouterNode
.clone()
.addFile(
'app/routes/api/m2m.ts',
() => `
import { getAuth } from '@clerk/react-router/server';
import type { Route } from './+types/m2m';

export async function loader(args: Route.LoaderArgs) {
const { subject, tokenType, isAuthenticated } = await getAuth(args, { acceptsToken: 'm2m_token' });

if (!isAuthenticated) {
return Response.json({ error: 'Unauthorized' }, { status: 401 });
}

return Response.json({ subject, tokenType });
}
`,
)
.addFile(
'app/routes.ts',
() => `
import { type RouteConfig, index, route } from '@react-router/dev/routes';

export default [
index('routes/home.tsx'),
route('sign-in/*', 'routes/sign-in.tsx'),
route('sign-up/*', 'routes/sign-up.tsx'),
route('protected', 'routes/protected.tsx'),
route('api/m2m', 'routes/api/m2m.ts'),
] satisfies RouteConfig;
`,
)
.commit();

await app.setup();

const env = appConfigs.envs.withAPIKeys
.clone()
.setEnvVariable('private', 'CLERK_MACHINE_SECRET_KEY', network.primaryServer.secretKey);
await app.withEnv(env);
await app.dev();
});

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

test('rejects requests with invalid M2M tokens', async ({ request }) => {
const res = await request.get(app.serverUrl + '/api/m2m');
expect(res.status()).toBe(401);

const res2 = await request.get(app.serverUrl + '/api/m2m', {
headers: { Authorization: 'Bearer mt_xxx' },
});
expect(res2.status()).toBe(401);
});

test('rejects M2M requests when sender machine lacks access to receiver machine', async ({ request }) => {
const res = await request.get(app.serverUrl + '/api/m2m', {
headers: { Authorization: `Bearer ${network.unscopedSenderToken.token}` },
});
expect(res.status()).toBe(401);
});

test('authorizes M2M requests when sender machine has proper access', async ({ page, context }) => {
const u = createTestUtils({ app, page, context });

const res = await u.page.request.get(app.serverUrl + '/api/m2m', {
headers: { Authorization: `Bearer ${network.scopedSenderToken.token}` },
});
expect(res.status()).toBe(200);
const body = await res.json();
expect(body.subject).toBe(network.scopedSender.id);
expect(body.tokenType).toBe(TokenType.M2MToken);
});

test('authorizes after dynamically granting scope', async ({ page, context }) => {
const u = createTestUtils({ app, page, context });

await u.services.clerk.machines.createScope(network.unscopedSender.id, network.primaryServer.id);
const m2mToken = await u.services.clerk.m2m.createToken({
machineSecretKey: network.unscopedSender.secretKey,
secondsUntilExpiration: 60 * 30,
});

const res = await u.page.request.get(app.serverUrl + '/api/m2m', {
headers: { Authorization: `Bearer ${m2mToken.token}` },
});
expect(res.status()).toBe(200);
const body = await res.json();
expect(body.subject).toBe(network.unscopedSender.id);
expect(body.tokenType).toBe(TokenType.M2MToken);
await u.services.clerk.m2m.revokeToken({ m2mTokenId: m2mToken.id });
});

test('verifies JWT format M2M token via local verification', async ({ request }) => {
const client = createClerkClient({
secretKey: instanceKeys.get('with-api-keys').sk,
});
const jwtToken = await createJwtM2MToken(client, network.scopedSender.secretKey);

const res = await request.get(app.serverUrl + '/api/m2m', {
headers: { Authorization: `Bearer ${jwtToken.token}` },
});
expect(res.status()).toBe(200);
const body = await res.json();
expect(body.subject).toBe(network.scopedSender.id);
expect(body.tokenType).toBe(TokenType.M2MToken);
});

for (const [tokenType, token] of [
['API key', 'ak_test_mismatch'],
['OAuth', 'oat_test_mismatch'],
] as const) {
test(`rejects ${tokenType} token on M2M route (token type mismatch)`, async ({ request }) => {
const res = await request.get(app.serverUrl + '/api/m2m', {
headers: { Authorization: `Bearer ${token}` },
});
expect(res.status()).toBe(401);
});
}
});

test.describe('OAuth auth', () => {
test.describe.configure({ mode: 'parallel' });
let app: Application;
let fakeUser: FakeUser;
let fakeOAuth: FakeOAuthApp;

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

app = await appConfigs.reactRouter.reactRouterNode
.clone()
.addFile(
'app/routes/api/oauth-verify.ts',
() => `
import { getAuth } from '@clerk/react-router/server';
import type { Route } from './+types/oauth-verify';

export async function loader(args: Route.LoaderArgs) {
const { userId, tokenType } = await getAuth(args, { acceptsToken: 'oauth_token' });

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

return Response.json({ userId, tokenType });
}
`,
)
.addFile(
'app/routes/api/oauth-callback.ts',
() => `
export async function loader() {
return Response.json({ message: 'OAuth callback received' });
}
`,
)
.addFile(
'app/routes.ts',
() => `
import { type RouteConfig, index, route } from '@react-router/dev/routes';

export default [
index('routes/home.tsx'),
route('sign-in/*', 'routes/sign-in.tsx'),
route('sign-up/*', 'routes/sign-up.tsx'),
route('protected', 'routes/protected.tsx'),
route('api/oauth-verify', 'routes/api/oauth-verify.ts'),
route('api/oauth/callback', 'routes/api/oauth-callback.ts'),
] satisfies RouteConfig;
`,
)
.commit();

await app.setup();
await app.withEnv(appConfigs.envs.withAPIKeys);
await app.dev();

const u = createTestUtils({ app });
fakeUser = u.services.users.createFakeUser();
await u.services.users.createBapiUser(fakeUser);

const clerkClient = createClerkClient({
secretKey: app.env.privateVariables.get('CLERK_SECRET_KEY'),
publishableKey: app.env.publicVariables.get('CLERK_PUBLISHABLE_KEY'),
});

fakeOAuth = await createFakeOAuthApp(clerkClient, `${app.serverUrl}/api/oauth/callback`);
});

test.afterAll(async () => {
await fakeOAuth.cleanup();
await fakeUser.deleteIfExists();
await app.teardown();
});

test('verifies valid OAuth access token obtained through authorization flow', async ({ page, context }) => {
const u = createTestUtils({ app, page, context });

const accessToken = await obtainOAuthAccessToken({
page: u.page,
oAuthApp: fakeOAuth.oAuthApp,
redirectUri: `${app.serverUrl}/api/oauth/callback`,
fakeUser,
signIn: u.po.signIn,
});

const res = await u.page.request.get(new URL('/api/oauth-verify', app.serverUrl).toString(), {
headers: { Authorization: `Bearer ${accessToken}` },
});
expect(res.status()).toBe(200);
const authData = await res.json();
expect(authData.userId).toBeDefined();
expect(authData.tokenType).toBe(TokenType.OAuthToken);
});

test('rejects request without OAuth token', async ({ request }) => {
const url = new URL('/api/oauth-verify', app.serverUrl);
const res = await request.get(url.toString());
expect(res.status()).toBe(401);
});

test('rejects request with invalid OAuth token', async ({ request }) => {
const url = new URL('/api/oauth-verify', app.serverUrl);
const res = await request.get(url.toString(), {
headers: { Authorization: 'Bearer invalid_oauth_token' },
});
expect(res.status()).toBe(401);
});

for (const [tokenType, token] of [
['API key', 'ak_test_mismatch'],
['M2M', 'mt_test_mismatch'],
] as const) {
test(`rejects ${tokenType} token on OAuth route (token type mismatch)`, async ({ request }) => {
const url = new URL('/api/oauth-verify', app.serverUrl);
const res = await request.get(url.toString(), {
headers: { Authorization: `Bearer ${token}` },
});
expect(res.status()).toBe(401);
});
}
});
});
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } 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
381 changes: 381 additions & 0 deletions integration/tests/react-router/machine.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,381 @@
import type { User } from '@clerk/backend';
import { createClerkClient } from '@clerk/backend';
import { TokenType } from '@clerk/backend/internal';
import { expect, test } from '@playwright/test';

import type { Application } from '../../models/application';
import { appConfigs } from '../../presets';
import { instanceKeys } from '../../presets/envs';
import type { FakeAPIKey, FakeMachineNetwork, FakeOAuthApp, FakeUser } from '../../testUtils';
import {
createFakeMachineNetwork,
createFakeOAuthApp,
createJwtM2MToken,
createTestUtils,
obtainOAuthAccessToken,
} from '../../testUtils';

test.describe('React Router machine authentication @machine', () => {
test.describe('API key auth', () => {
test.describe.configure({ mode: 'parallel' });
let app: Application;
let fakeUser: FakeUser;
let fakeBapiUser: User;
let fakeAPIKey: FakeAPIKey;

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

app = await appConfigs.reactRouter.reactRouterNode
.clone()
.addFile(
'app/routes/api/me.ts',
() => `
import { getAuth } from '@clerk/react-router/server';
import type { Route } from './+types/me';

export async function loader(args: Route.LoaderArgs) {
const { userId, tokenType } = await getAuth(args, { acceptsToken: 'api_key' });

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

return Response.json({ userId, tokenType });
}
`,
)
.addFile(
'app/routes.ts',
() => `
import { type RouteConfig, index, route } from '@react-router/dev/routes';

export default [
index('routes/home.tsx'),
route('sign-in/*', 'routes/sign-in.tsx'),
route('sign-up/*', 'routes/sign-up.tsx'),
route('protected', 'routes/protected.tsx'),
route('api/me', 'routes/api/me.ts'),
] satisfies RouteConfig;
`,
)
.commit();

await app.setup();
await app.withEnv(appConfigs.envs.withAPIKeys);
await app.dev();

const u = createTestUtils({ app });
fakeUser = u.services.users.createFakeUser();
fakeBapiUser = await u.services.users.createBapiUser(fakeUser);
fakeAPIKey = await u.services.users.createFakeAPIKey(fakeBapiUser.id);
});

test.afterAll(async () => {
await fakeAPIKey.revoke();
await fakeUser.deleteIfExists();
await app.teardown();
});

test('should return 401 if no API key is provided', async ({ request }) => {
const url = new URL('/api/me', app.serverUrl);
const res = await request.get(url.toString());
expect(res.status()).toBe(401);
});

test('should return 401 if API key is invalid', async ({ request }) => {
const url = new URL('/api/me', app.serverUrl);
const res = await request.get(url.toString(), {
headers: { Authorization: 'Bearer invalid_key' },
});
expect(res.status()).toBe(401);
});

test('should return 200 with auth object if API key is valid', async ({ request }) => {
const url = new URL('/api/me', app.serverUrl);
const res = await request.get(url.toString(), {
headers: {
Authorization: `Bearer ${fakeAPIKey.secret}`,
},
});
const apiKeyData = await res.json();
expect(res.status()).toBe(200);
expect(apiKeyData.userId).toBe(fakeBapiUser.id);
expect(apiKeyData.tokenType).toBe(TokenType.ApiKey);
});

for (const [tokenType, token] of [
['M2M', 'mt_test_mismatch'],
['OAuth', 'oat_test_mismatch'],
] as const) {
test(`rejects ${tokenType} token on API key route (token type mismatch)`, async ({ request }) => {
const url = new URL('/api/me', app.serverUrl);
const res = await request.get(url.toString(), {
headers: { Authorization: `Bearer ${token}` },
});
expect(res.status()).toBe(401);
});
}
});

test.describe('M2M auth', () => {
test.describe.configure({ mode: 'parallel' });
let app: Application;
let network: FakeMachineNetwork;

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

const client = createClerkClient({
secretKey: instanceKeys.get('with-api-keys').sk,
});
network = await createFakeMachineNetwork(client);

app = await appConfigs.reactRouter.reactRouterNode
.clone()
.addFile(
'app/routes/api/m2m.ts',
() => `
import { getAuth } from '@clerk/react-router/server';
import type { Route } from './+types/m2m';

export async function loader(args: Route.LoaderArgs) {
const { subject, tokenType, isAuthenticated } = await getAuth(args, { acceptsToken: 'm2m_token' });

if (!isAuthenticated) {
return Response.json({ error: 'Unauthorized' }, { status: 401 });
}

return Response.json({ subject, tokenType });
}
`,
)
.addFile(
'app/routes.ts',
() => `
import { type RouteConfig, index, route } from '@react-router/dev/routes';

export default [
index('routes/home.tsx'),
route('sign-in/*', 'routes/sign-in.tsx'),
route('sign-up/*', 'routes/sign-up.tsx'),
route('protected', 'routes/protected.tsx'),
route('api/m2m', 'routes/api/m2m.ts'),
] satisfies RouteConfig;
`,
)
.commit();

await app.setup();

const env = appConfigs.envs.withAPIKeys
.clone()
.setEnvVariable('private', 'CLERK_MACHINE_SECRET_KEY', network.primaryServer.secretKey);
await app.withEnv(env);
await app.dev();
});

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

test('rejects requests with invalid M2M tokens', async ({ request }) => {
const res = await request.get(app.serverUrl + '/api/m2m');
expect(res.status()).toBe(401);

const res2 = await request.get(app.serverUrl + '/api/m2m', {
headers: { Authorization: 'Bearer mt_xxx' },
});
expect(res2.status()).toBe(401);
});

test('rejects M2M requests when sender machine lacks access to receiver machine', async ({ request }) => {
const res = await request.get(app.serverUrl + '/api/m2m', {
headers: { Authorization: `Bearer ${network.unscopedSenderToken.token}` },
});
expect(res.status()).toBe(401);
});

test('authorizes M2M requests when sender machine has proper access', async ({ page, context }) => {
const u = createTestUtils({ app, page, context });

const res = await u.page.request.get(app.serverUrl + '/api/m2m', {
headers: { Authorization: `Bearer ${network.scopedSenderToken.token}` },
});
expect(res.status()).toBe(200);
const body = await res.json();
expect(body.subject).toBe(network.scopedSender.id);
expect(body.tokenType).toBe(TokenType.M2MToken);
});

test('authorizes after dynamically granting scope', async ({ page, context }) => {
const u = createTestUtils({ app, page, context });

await u.services.clerk.machines.createScope(network.unscopedSender.id, network.primaryServer.id);
const m2mToken = await u.services.clerk.m2m.createToken({
machineSecretKey: network.unscopedSender.secretKey,
secondsUntilExpiration: 60 * 30,
});

const res = await u.page.request.get(app.serverUrl + '/api/m2m', {
headers: { Authorization: `Bearer ${m2mToken.token}` },
});
expect(res.status()).toBe(200);
const body = await res.json();
expect(body.subject).toBe(network.unscopedSender.id);
expect(body.tokenType).toBe(TokenType.M2MToken);
await u.services.clerk.m2m.revokeToken({ m2mTokenId: m2mToken.id });
});

test('verifies JWT format M2M token via local verification', async ({ request }) => {
const client = createClerkClient({
secretKey: instanceKeys.get('with-api-keys').sk,
});
const jwtToken = await createJwtM2MToken(client, network.scopedSender.secretKey);

const res = await request.get(app.serverUrl + '/api/m2m', {
headers: { Authorization: `Bearer ${jwtToken.token}` },
});
expect(res.status()).toBe(200);
const body = await res.json();
expect(body.subject).toBe(network.scopedSender.id);
expect(body.tokenType).toBe(TokenType.M2MToken);
});

for (const [tokenType, token] of [
['API key', 'ak_test_mismatch'],
['OAuth', 'oat_test_mismatch'],
] as const) {
test(`rejects ${tokenType} token on M2M route (token type mismatch)`, async ({ request }) => {
const res = await request.get(app.serverUrl + '/api/m2m', {
headers: { Authorization: `Bearer ${token}` },
});
expect(res.status()).toBe(401);
});
}
});

test.describe('OAuth auth', () => {
test.describe.configure({ mode: 'parallel' });
let app: Application;
let fakeUser: FakeUser;
let fakeOAuth: FakeOAuthApp;

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

app = await appConfigs.reactRouter.reactRouterNode
.clone()
.addFile(
'app/routes/api/oauth-verify.ts',
() => `
import { getAuth } from '@clerk/react-router/server';
import type { Route } from './+types/oauth-verify';

export async function loader(args: Route.LoaderArgs) {
const { userId, tokenType } = await getAuth(args, { acceptsToken: 'oauth_token' });

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

return Response.json({ userId, tokenType });
}
`,
)
.addFile(
'app/routes/api/oauth-callback.ts',
() => `
export async function loader() {
return Response.json({ message: 'OAuth callback received' });
}
`,
)
.addFile(
'app/routes.ts',
() => `
import { type RouteConfig, index, route } from '@react-router/dev/routes';

export default [
index('routes/home.tsx'),
route('sign-in/*', 'routes/sign-in.tsx'),
route('sign-up/*', 'routes/sign-up.tsx'),
route('protected', 'routes/protected.tsx'),
route('api/oauth-verify', 'routes/api/oauth-verify.ts'),
route('api/oauth/callback', 'routes/api/oauth-callback.ts'),
] satisfies RouteConfig;
`,
)
.commit();

await app.setup();
await app.withEnv(appConfigs.envs.withAPIKeys);
await app.dev();

const u = createTestUtils({ app });
fakeUser = u.services.users.createFakeUser();
await u.services.users.createBapiUser(fakeUser);

const clerkClient = createClerkClient({
secretKey: app.env.privateVariables.get('CLERK_SECRET_KEY'),
publishableKey: app.env.publicVariables.get('CLERK_PUBLISHABLE_KEY'),
});

fakeOAuth = await createFakeOAuthApp(clerkClient, `${app.serverUrl}/api/oauth/callback`);
});

test.afterAll(async () => {
await fakeOAuth.cleanup();
await fakeUser.deleteIfExists();
await app.teardown();
});

test('verifies valid OAuth access token obtained through authorization flow', async ({ page, context }) => {
const u = createTestUtils({ app, page, context });

const accessToken = await obtainOAuthAccessToken({
page: u.page,
oAuthApp: fakeOAuth.oAuthApp,
redirectUri: `${app.serverUrl}/api/oauth/callback`,
fakeUser,
signIn: u.po.signIn,
});

const res = await u.page.request.get(new URL('/api/oauth-verify', app.serverUrl).toString(), {
headers: { Authorization: `Bearer ${accessToken}` },
});
expect(res.status()).toBe(200);
const authData = await res.json();
expect(authData.userId).toBeDefined();
expect(authData.tokenType).toBe(TokenType.OAuthToken);
});

test('rejects request without OAuth token', async ({ request }) => {
const url = new URL('/api/oauth-verify', app.serverUrl);
const res = await request.get(url.toString());
expect(res.status()).toBe(401);
});

test('rejects request with invalid OAuth token', async ({ request }) => {
const url = new URL('/api/oauth-verify', app.serverUrl);
const res = await request.get(url.toString(), {
headers: { Authorization: 'Bearer invalid_oauth_token' },
});
expect(res.status()).toBe(401);
});

for (const [tokenType, token] of [
['API key', 'ak_test_mismatch'],
['M2M', 'mt_test_mismatch'],
] as const) {
test(`rejects ${tokenType} token on OAuth route (token type mismatch)`, async ({ request }) => {
const url = new URL('/api/oauth-verify', app.serverUrl);
const res = await request.get(url.toString(), {
headers: { Authorization: `Bearer ${token}` },
});
expect(res.status()).toBe(401);
});
}
});
});
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } 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
381 changes: 381 additions & 0 deletions integration/tests/react-router/machine.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,381 @@
import type { User } from '@clerk/backend';
import { createClerkClient } from '@clerk/backend';
import { TokenType } from '@clerk/backend/internal';
import { expect, test } from '@playwright/test';

import type { Application } from '../../models/application';
import { appConfigs } from '../../presets';
import { instanceKeys } from '../../presets/envs';
import type { FakeAPIKey, FakeMachineNetwork, FakeOAuthApp, FakeUser } from '../../testUtils';
import {
createFakeMachineNetwork,
createFakeOAuthApp,
createJwtM2MToken,
createTestUtils,
obtainOAuthAccessToken,
} from '../../testUtils';

test.describe('React Router machine authentication @machine', () => {
test.describe('API key auth', () => {
test.describe.configure({ mode: 'parallel' });
let app: Application;
let fakeUser: FakeUser;
let fakeBapiUser: User;
let fakeAPIKey: FakeAPIKey;

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

app = await appConfigs.reactRouter.reactRouterNode
.clone()
.addFile(
'app/routes/api/me.ts',
() => `
import { getAuth } from '@clerk/react-router/server';
import type { Route } from './+types/me';

export async function loader(args: Route.LoaderArgs) {
const { userId, tokenType } = await getAuth(args, { acceptsToken: 'api_key' });

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

return Response.json({ userId, tokenType });
}
`,
)
.addFile(
'app/routes.ts',
() => `
import { type RouteConfig, index, route } from '@react-router/dev/routes';

export default [
index('routes/home.tsx'),
route('sign-in/*', 'routes/sign-in.tsx'),
route('sign-up/*', 'routes/sign-up.tsx'),
route('protected', 'routes/protected.tsx'),
route('api/me', 'routes/api/me.ts'),
] satisfies RouteConfig;
`,
)
.commit();

await app.setup();
await app.withEnv(appConfigs.envs.withAPIKeys);
await app.dev();

const u = createTestUtils({ app });
fakeUser = u.services.users.createFakeUser();
fakeBapiUser = await u.services.users.createBapiUser(fakeUser);
fakeAPIKey = await u.services.users.createFakeAPIKey(fakeBapiUser.id);
});

test.afterAll(async () => {
await fakeAPIKey.revoke();
await fakeUser.deleteIfExists();
await app.teardown();
});

test('should return 401 if no API key is provided', async ({ request }) => {
const url = new URL('/api/me', app.serverUrl);
const res = await request.get(url.toString());
expect(res.status()).toBe(401);
});

test('should return 401 if API key is invalid', async ({ request }) => {
const url = new URL('/api/me', app.serverUrl);
const res = await request.get(url.toString(), {
headers: { Authorization: 'Bearer invalid_key' },
});
expect(res.status()).toBe(401);
});

test('should return 200 with auth object if API key is valid', async ({ request }) => {
const url = new URL('/api/me', app.serverUrl);
const res = await request.get(url.toString(), {
headers: {
Authorization: `Bearer ${fakeAPIKey.secret}`,
},
});
const apiKeyData = await res.json();
expect(res.status()).toBe(200);
expect(apiKeyData.userId).toBe(fakeBapiUser.id);
expect(apiKeyData.tokenType).toBe(TokenType.ApiKey);
});

for (const [tokenType, token] of [
['M2M', 'mt_test_mismatch'],
['OAuth', 'oat_test_mismatch'],
] as const) {
test(`rejects ${tokenType} token on API key route (token type mismatch)`, async ({ request }) => {
const url = new URL('/api/me', app.serverUrl);
const res = await request.get(url.toString(), {
headers: { Authorization: `Bearer ${token}` },
});
expect(res.status()).toBe(401);
});
}
});

test.describe('M2M auth', () => {
test.describe.configure({ mode: 'parallel' });
let app: Application;
let network: FakeMachineNetwork;

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

const client = createClerkClient({
secretKey: instanceKeys.get('with-api-keys').sk,
});
network = await createFakeMachineNetwork(client);

app = await appConfigs.reactRouter.reactRouterNode
.clone()
.addFile(
'app/routes/api/m2m.ts',
() => `
import { getAuth } from '@clerk/react-router/server';
import type { Route } from './+types/m2m';

export async function loader(args: Route.LoaderArgs) {
const { subject, tokenType, isAuthenticated } = await getAuth(args, { acceptsToken: 'm2m_token' });

if (!isAuthenticated) {
return Response.json({ error: 'Unauthorized' }, { status: 401 });
}

return Response.json({ subject, tokenType });
}
`,
)
.addFile(
'app/routes.ts',
() => `
import { type RouteConfig, index, route } from '@react-router/dev/routes';

export default [
index('routes/home.tsx'),
route('sign-in/*', 'routes/sign-in.tsx'),
route('sign-up/*', 'routes/sign-up.tsx'),
route('protected', 'routes/protected.tsx'),
route('api/m2m', 'routes/api/m2m.ts'),
] satisfies RouteConfig;
`,
)
.commit();

await app.setup();

const env = appConfigs.envs.withAPIKeys
.clone()
.setEnvVariable('private', 'CLERK_MACHINE_SECRET_KEY', network.primaryServer.secretKey);
await app.withEnv(env);
await app.dev();
});

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

test('rejects requests with invalid M2M tokens', async ({ request }) => {
const res = await request.get(app.serverUrl + '/api/m2m');
expect(res.status()).toBe(401);

const res2 = await request.get(app.serverUrl + '/api/m2m', {
headers: { Authorization: 'Bearer mt_xxx' },
});
expect(res2.status()).toBe(401);
});

test('rejects M2M requests when sender machine lacks access to receiver machine', async ({ request }) => {
const res = await request.get(app.serverUrl + '/api/m2m', {
headers: { Authorization: `Bearer ${network.unscopedSenderToken.token}` },
});
expect(res.status()).toBe(401);
});

test('authorizes M2M requests when sender machine has proper access', async ({ page, context }) => {
const u = createTestUtils({ app, page, context });

const res = await u.page.request.get(app.serverUrl + '/api/m2m', {
headers: { Authorization: `Bearer ${network.scopedSenderToken.token}` },
});
expect(res.status()).toBe(200);
const body = await res.json();
expect(body.subject).toBe(network.scopedSender.id);
expect(body.tokenType).toBe(TokenType.M2MToken);
});

test('authorizes after dynamically granting scope', async ({ page, context }) => {
const u = createTestUtils({ app, page, context });

await u.services.clerk.machines.createScope(network.unscopedSender.id, network.primaryServer.id);
const m2mToken = await u.services.clerk.m2m.createToken({
machineSecretKey: network.unscopedSender.secretKey,
secondsUntilExpiration: 60 * 30,
});

const res = await u.page.request.get(app.serverUrl + '/api/m2m', {
headers: { Authorization: `Bearer ${m2mToken.token}` },
});
expect(res.status()).toBe(200);
const body = await res.json();
expect(body.subject).toBe(network.unscopedSender.id);
expect(body.tokenType).toBe(TokenType.M2MToken);
await u.services.clerk.m2m.revokeToken({ m2mTokenId: m2mToken.id });
});

test('verifies JWT format M2M token via local verification', async ({ request }) => {
const client = createClerkClient({
secretKey: instanceKeys.get('with-api-keys').sk,
});
const jwtToken = await createJwtM2MToken(client, network.scopedSender.secretKey);

const res = await request.get(app.serverUrl + '/api/m2m', {
headers: { Authorization: `Bearer ${jwtToken.token}` },
});
expect(res.status()).toBe(200);
const body = await res.json();
expect(body.subject).toBe(network.scopedSender.id);
expect(body.tokenType).toBe(TokenType.M2MToken);
});

for (const [tokenType, token] of [
['API key', 'ak_test_mismatch'],
['OAuth', 'oat_test_mismatch'],
] as const) {
test(`rejects ${tokenType} token on M2M route (token type mismatch)`, async ({ request }) => {
const res = await request.get(app.serverUrl + '/api/m2m', {
headers: { Authorization: `Bearer ${token}` },
});
expect(res.status()).toBe(401);
});
}
});

test.describe('OAuth auth', () => {
test.describe.configure({ mode: 'parallel' });
let app: Application;
let fakeUser: FakeUser;
let fakeOAuth: FakeOAuthApp;

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

app = await appConfigs.reactRouter.reactRouterNode
.clone()
.addFile(
'app/routes/api/oauth-verify.ts',
() => `
import { getAuth } from '@clerk/react-router/server';
import type { Route } from './+types/oauth-verify';

export async function loader(args: Route.LoaderArgs) {
const { userId, tokenType } = await getAuth(args, { acceptsToken: 'oauth_token' });

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

return Response.json({ userId, tokenType });
}
`,
)
.addFile(
'app/routes/api/oauth-callback.ts',
() => `
export async function loader() {
return Response.json({ message: 'OAuth callback received' });
}
`,
)
.addFile(
'app/routes.ts',
() => `
import { type RouteConfig, index, route } from '@react-router/dev/routes';

export default [
index('routes/home.tsx'),
route('sign-in/*', 'routes/sign-in.tsx'),
route('sign-up/*', 'routes/sign-up.tsx'),
route('protected', 'routes/protected.tsx'),
route('api/oauth-verify', 'routes/api/oauth-verify.ts'),
route('api/oauth/callback', 'routes/api/oauth-callback.ts'),
] satisfies RouteConfig;
`,
)
.commit();

await app.setup();
await app.withEnv(appConfigs.envs.withAPIKeys);
await app.dev();

const u = createTestUtils({ app });
fakeUser = u.services.users.createFakeUser();
await u.services.users.createBapiUser(fakeUser);

const clerkClient = createClerkClient({
secretKey: app.env.privateVariables.get('CLERK_SECRET_KEY'),
publishableKey: app.env.publicVariables.get('CLERK_PUBLISHABLE_KEY'),
});

fakeOAuth = await createFakeOAuthApp(clerkClient, `${app.serverUrl}/api/oauth/callback`);
});

test.afterAll(async () => {
await fakeOAuth.cleanup();
await fakeUser.deleteIfExists();
await app.teardown();
});

test('verifies valid OAuth access token obtained through authorization flow', async ({ page, context }) => {
const u = createTestUtils({ app, page, context });

const accessToken = await obtainOAuthAccessToken({
page: u.page,
oAuthApp: fakeOAuth.oAuthApp,
redirectUri: `${app.serverUrl}/api/oauth/callback`,
fakeUser,
signIn: u.po.signIn,
});

const res = await u.page.request.get(new URL('/api/oauth-verify', app.serverUrl).toString(), {
headers: { Authorization: `Bearer ${accessToken}` },
});
expect(res.status()).toBe(200);
const authData = await res.json();
expect(authData.userId).toBeDefined();
expect(authData.tokenType).toBe(TokenType.OAuthToken);
});

test('rejects request without OAuth token', async ({ request }) => {
const url = new URL('/api/oauth-verify', app.serverUrl);
const res = await request.get(url.toString());
expect(res.status()).toBe(401);
});

test('rejects request with invalid OAuth token', async ({ request }) => {
const url = new URL('/api/oauth-verify', app.serverUrl);
const res = await request.get(url.toString(), {
headers: { Authorization: 'Bearer invalid_oauth_token' },
});
expect(res.status()).toBe(401);
});

for (const [tokenType, token] of [
['API key', 'ak_test_mismatch'],
['M2M', 'mt_test_mismatch'],
] as const) {
test(`rejects ${tokenType} token on OAuth route (token type mismatch)`, async ({ request }) => {
const url = new URL('/api/oauth-verify', app.serverUrl);
const res = await request.get(url.toString(), {
headers: { Authorization: `Bearer ${token}` },
});
expect(res.status()).toBe(401);
});
}
});
});
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Universal Dark Mode - works on any site (function() { var enabled = true; function applyDarkMode() { if (!enabled) return; // Create style element if it doesn't exist var style = document.getElementById('universal-dark-mode-style'); if (!style) { style = document.createElement('style'); style.id = 'universal-dark-mode-style'; document.head.appendChild(style); } // Dark mode CSS - inverts colors but preserves images/video style.textContent = ' /* Invert everything except media */ html { filter: invert(1) hue-rotate(180deg) !important; background: #1a1a2e !important; } /* Restore images, videos, iframes, canvas */ img, video, iframe, canvas, svg, picture, [style*="background-image"] { filter: invert(1) hue-rotate(180deg) !important; } /* Preserve specific elements that should not be inverted */ .no-dark-mode, .no-dark-mode *, [data-theme="light"], [data-theme="light"], .ace_editor, .ace_editor *, .CodeMirror, .CodeMirror *, .monaco-editor, .monaco-editor *, .markdown-body pre, .markdown-body pre *, .highlight, .highlight *, pre code, pre code * { filter: none !important; } /* Fix common UI elements */ .modal, .popup, .dropdown-menu, .tooltip, .popover { filter: invert(1) hue-rotate(180deg) !important; background: #2d2d44 !important; border-color: #444 !important; } /* Scrollbars */ ::-webkit-scrollbar { background: #1a1a2e !important; } ::-webkit-scrollbar-thumb { background: #444 !important; } ::-webkit-scrollbar-thumb:hover { background: #555 !important; } /* Selection */ ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; } ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; } '; } function removeDarkMode() { var style = document.getElementById('universal-dark-mode-style'); if (style) style.remove(); } // Toggle with Alt+Shift+D document.addEventListener('keydown', function(e) { if (e.altKey && e.shiftKey && e.key === 'D') { e.preventDefault(); enabled = !enabled; if (enabled) { applyDarkMode(); console.log('[Universal Dark Mode] Enabled'); } else { removeDarkMode(); console.log('[Universal Dark Mode] Disabled'); } } }); // Apply on load applyDarkMode(); // Re-apply on dynamic content var observer = new MutationObserver(function(mutations) { if (enabled && !document.getElementById('universal-dark-mode-style')) { applyDarkMode(); } }); observer.observe(document.head, { childList: true }); console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle'); })(); } } 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
381 changes: 381 additions & 0 deletions integration/tests/react-router/machine.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,381 @@
import type { User } from '@clerk/backend';
import { createClerkClient } from '@clerk/backend';
import { TokenType } from '@clerk/backend/internal';
import { expect, test } from '@playwright/test';

import type { Application } from '../../models/application';
import { appConfigs } from '../../presets';
import { instanceKeys } from '../../presets/envs';
import type { FakeAPIKey, FakeMachineNetwork, FakeOAuthApp, FakeUser } from '../../testUtils';
import {
createFakeMachineNetwork,
createFakeOAuthApp,
createJwtM2MToken,
createTestUtils,
obtainOAuthAccessToken,
} from '../../testUtils';

test.describe('React Router machine authentication @machine', () => {
test.describe('API key auth', () => {
test.describe.configure({ mode: 'parallel' });
let app: Application;
let fakeUser: FakeUser;
let fakeBapiUser: User;
let fakeAPIKey: FakeAPIKey;

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

app = await appConfigs.reactRouter.reactRouterNode
.clone()
.addFile(
'app/routes/api/me.ts',
() => `
import { getAuth } from '@clerk/react-router/server';
import type { Route } from './+types/me';

export async function loader(args: Route.LoaderArgs) {
const { userId, tokenType } = await getAuth(args, { acceptsToken: 'api_key' });

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

return Response.json({ userId, tokenType });
}
`,
)
.addFile(
'app/routes.ts',
() => `
import { type RouteConfig, index, route } from '@react-router/dev/routes';

export default [
index('routes/home.tsx'),
route('sign-in/*', 'routes/sign-in.tsx'),
route('sign-up/*', 'routes/sign-up.tsx'),
route('protected', 'routes/protected.tsx'),
route('api/me', 'routes/api/me.ts'),
] satisfies RouteConfig;
`,
)
.commit();

await app.setup();
await app.withEnv(appConfigs.envs.withAPIKeys);
await app.dev();

const u = createTestUtils({ app });
fakeUser = u.services.users.createFakeUser();
fakeBapiUser = await u.services.users.createBapiUser(fakeUser);
fakeAPIKey = await u.services.users.createFakeAPIKey(fakeBapiUser.id);
});

test.afterAll(async () => {
await fakeAPIKey.revoke();
await fakeUser.deleteIfExists();
await app.teardown();
});

test('should return 401 if no API key is provided', async ({ request }) => {
const url = new URL('/api/me', app.serverUrl);
const res = await request.get(url.toString());
expect(res.status()).toBe(401);
});

test('should return 401 if API key is invalid', async ({ request }) => {
const url = new URL('/api/me', app.serverUrl);
const res = await request.get(url.toString(), {
headers: { Authorization: 'Bearer invalid_key' },
});
expect(res.status()).toBe(401);
});

test('should return 200 with auth object if API key is valid', async ({ request }) => {
const url = new URL('/api/me', app.serverUrl);
const res = await request.get(url.toString(), {
headers: {
Authorization: `Bearer ${fakeAPIKey.secret}`,
},
});
const apiKeyData = await res.json();
expect(res.status()).toBe(200);
expect(apiKeyData.userId).toBe(fakeBapiUser.id);
expect(apiKeyData.tokenType).toBe(TokenType.ApiKey);
});

for (const [tokenType, token] of [
['M2M', 'mt_test_mismatch'],
['OAuth', 'oat_test_mismatch'],
] as const) {
test(`rejects ${tokenType} token on API key route (token type mismatch)`, async ({ request }) => {
const url = new URL('/api/me', app.serverUrl);
const res = await request.get(url.toString(), {
headers: { Authorization: `Bearer ${token}` },
});
expect(res.status()).toBe(401);
});
}
});

test.describe('M2M auth', () => {
test.describe.configure({ mode: 'parallel' });
let app: Application;
let network: FakeMachineNetwork;

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

const client = createClerkClient({
secretKey: instanceKeys.get('with-api-keys').sk,
});
network = await createFakeMachineNetwork(client);

app = await appConfigs.reactRouter.reactRouterNode
.clone()
.addFile(
'app/routes/api/m2m.ts',
() => `
import { getAuth } from '@clerk/react-router/server';
import type { Route } from './+types/m2m';

export async function loader(args: Route.LoaderArgs) {
const { subject, tokenType, isAuthenticated } = await getAuth(args, { acceptsToken: 'm2m_token' });

if (!isAuthenticated) {
return Response.json({ error: 'Unauthorized' }, { status: 401 });
}

return Response.json({ subject, tokenType });
}
`,
)
.addFile(
'app/routes.ts',
() => `
import { type RouteConfig, index, route } from '@react-router/dev/routes';

export default [
index('routes/home.tsx'),
route('sign-in/*', 'routes/sign-in.tsx'),
route('sign-up/*', 'routes/sign-up.tsx'),
route('protected', 'routes/protected.tsx'),
route('api/m2m', 'routes/api/m2m.ts'),
] satisfies RouteConfig;
`,
)
.commit();

await app.setup();

const env = appConfigs.envs.withAPIKeys
.clone()
.setEnvVariable('private', 'CLERK_MACHINE_SECRET_KEY', network.primaryServer.secretKey);
await app.withEnv(env);
await app.dev();
});

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

test('rejects requests with invalid M2M tokens', async ({ request }) => {
const res = await request.get(app.serverUrl + '/api/m2m');
expect(res.status()).toBe(401);

const res2 = await request.get(app.serverUrl + '/api/m2m', {
headers: { Authorization: 'Bearer mt_xxx' },
});
expect(res2.status()).toBe(401);
});

test('rejects M2M requests when sender machine lacks access to receiver machine', async ({ request }) => {
const res = await request.get(app.serverUrl + '/api/m2m', {
headers: { Authorization: `Bearer ${network.unscopedSenderToken.token}` },
});
expect(res.status()).toBe(401);
});

test('authorizes M2M requests when sender machine has proper access', async ({ page, context }) => {
const u = createTestUtils({ app, page, context });

const res = await u.page.request.get(app.serverUrl + '/api/m2m', {
headers: { Authorization: `Bearer ${network.scopedSenderToken.token}` },
});
expect(res.status()).toBe(200);
const body = await res.json();
expect(body.subject).toBe(network.scopedSender.id);
expect(body.tokenType).toBe(TokenType.M2MToken);
});

test('authorizes after dynamically granting scope', async ({ page, context }) => {
const u = createTestUtils({ app, page, context });

await u.services.clerk.machines.createScope(network.unscopedSender.id, network.primaryServer.id);
const m2mToken = await u.services.clerk.m2m.createToken({
machineSecretKey: network.unscopedSender.secretKey,
secondsUntilExpiration: 60 * 30,
});

const res = await u.page.request.get(app.serverUrl + '/api/m2m', {
headers: { Authorization: `Bearer ${m2mToken.token}` },
});
expect(res.status()).toBe(200);
const body = await res.json();
expect(body.subject).toBe(network.unscopedSender.id);
expect(body.tokenType).toBe(TokenType.M2MToken);
await u.services.clerk.m2m.revokeToken({ m2mTokenId: m2mToken.id });
});

test('verifies JWT format M2M token via local verification', async ({ request }) => {
const client = createClerkClient({
secretKey: instanceKeys.get('with-api-keys').sk,
});
const jwtToken = await createJwtM2MToken(client, network.scopedSender.secretKey);

const res = await request.get(app.serverUrl + '/api/m2m', {
headers: { Authorization: `Bearer ${jwtToken.token}` },
});
expect(res.status()).toBe(200);
const body = await res.json();
expect(body.subject).toBe(network.scopedSender.id);
expect(body.tokenType).toBe(TokenType.M2MToken);
});

for (const [tokenType, token] of [
['API key', 'ak_test_mismatch'],
['OAuth', 'oat_test_mismatch'],
] as const) {
test(`rejects ${tokenType} token on M2M route (token type mismatch)`, async ({ request }) => {
const res = await request.get(app.serverUrl + '/api/m2m', {
headers: { Authorization: `Bearer ${token}` },
});
expect(res.status()).toBe(401);
});
}
});

test.describe('OAuth auth', () => {
test.describe.configure({ mode: 'parallel' });
let app: Application;
let fakeUser: FakeUser;
let fakeOAuth: FakeOAuthApp;

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

app = await appConfigs.reactRouter.reactRouterNode
.clone()
.addFile(
'app/routes/api/oauth-verify.ts',
() => `
import { getAuth } from '@clerk/react-router/server';
import type { Route } from './+types/oauth-verify';

export async function loader(args: Route.LoaderArgs) {
const { userId, tokenType } = await getAuth(args, { acceptsToken: 'oauth_token' });

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

return Response.json({ userId, tokenType });
}
`,
)
.addFile(
'app/routes/api/oauth-callback.ts',
() => `
export async function loader() {
return Response.json({ message: 'OAuth callback received' });
}
`,
)
.addFile(
'app/routes.ts',
() => `
import { type RouteConfig, index, route } from '@react-router/dev/routes';

export default [
index('routes/home.tsx'),
route('sign-in/*', 'routes/sign-in.tsx'),
route('sign-up/*', 'routes/sign-up.tsx'),
route('protected', 'routes/protected.tsx'),
route('api/oauth-verify', 'routes/api/oauth-verify.ts'),
route('api/oauth/callback', 'routes/api/oauth-callback.ts'),
] satisfies RouteConfig;
`,
)
.commit();

await app.setup();
await app.withEnv(appConfigs.envs.withAPIKeys);
await app.dev();

const u = createTestUtils({ app });
fakeUser = u.services.users.createFakeUser();
await u.services.users.createBapiUser(fakeUser);

const clerkClient = createClerkClient({
secretKey: app.env.privateVariables.get('CLERK_SECRET_KEY'),
publishableKey: app.env.publicVariables.get('CLERK_PUBLISHABLE_KEY'),
});

fakeOAuth = await createFakeOAuthApp(clerkClient, `${app.serverUrl}/api/oauth/callback`);
});

test.afterAll(async () => {
await fakeOAuth.cleanup();
await fakeUser.deleteIfExists();
await app.teardown();
});

test('verifies valid OAuth access token obtained through authorization flow', async ({ page, context }) => {
const u = createTestUtils({ app, page, context });

const accessToken = await obtainOAuthAccessToken({
page: u.page,
oAuthApp: fakeOAuth.oAuthApp,
redirectUri: `${app.serverUrl}/api/oauth/callback`,
fakeUser,
signIn: u.po.signIn,
});

const res = await u.page.request.get(new URL('/api/oauth-verify', app.serverUrl).toString(), {
headers: { Authorization: `Bearer ${accessToken}` },
});
expect(res.status()).toBe(200);
const authData = await res.json();
expect(authData.userId).toBeDefined();
expect(authData.tokenType).toBe(TokenType.OAuthToken);
});

test('rejects request without OAuth token', async ({ request }) => {
const url = new URL('/api/oauth-verify', app.serverUrl);
const res = await request.get(url.toString());
expect(res.status()).toBe(401);
});

test('rejects request with invalid OAuth token', async ({ request }) => {
const url = new URL('/api/oauth-verify', app.serverUrl);
const res = await request.get(url.toString(), {
headers: { Authorization: 'Bearer invalid_oauth_token' },
});
expect(res.status()).toBe(401);
});

for (const [tokenType, token] of [
['API key', 'ak_test_mismatch'],
['M2M', 'mt_test_mismatch'],
] as const) {
test(`rejects ${tokenType} token on OAuth route (token type mismatch)`, async ({ request }) => {
const url = new URL('/api/oauth-verify', app.serverUrl);
const res = await request.get(url.toString(), {
headers: { Authorization: `Bearer ${token}` },
});
expect(res.status()).toBe(401);
});
}
});
});
Loading
Loading