chore(repo,testing): Add API keys component e2e tests#6192

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
wobsoriano merged 9 commits into from
Jun 25, 2025
Merged

chore(repo,testing): Add API keys component e2e tests #6192

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
de41798
chore: initialize api keys component test
wobsoriano Jun 25, 2025
ddbe826
Merge remote-tracking branch 'origin/main' into rob/user-2238-api-key…
wobsoriano Jun 25, 2025
b07a364
chore: introduce more tests
wobsoriano Jun 25, 2025
0abde17
Update integration/tests/machine-auth/component.test.ts
wobsoriano Jun 25, 2025
738804a
Merge branch 'main' into rob/user-2238-api-keys-e2e
wobsoriano Jun 25, 2025
45262f1
chore: add changeset
wobsoriano Jun 25, 2025
d13bf48
chore: simplify menu button click
wobsoriano Jun 25, 2025
be7ca1b
chore: remove global permission
wobsoriano Jun 25, 2025
45f8084
chore: add api key secret visibility toggling test
wobsoriano Jun 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/shiny-candles-sneeze.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
"@clerk/testing": minor
---

Add API keys component testing helpers
5 changes: 5 additions & 0 deletions integration/templates/next-app-router/src/app/api-keys/page.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
import { APIKeys } from '@clerk/nextjs';

export default function Page() {
return <APIKeys />;
}
172 changes: 172 additions & 0 deletions integration/tests/machine-auth/component.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,172 @@
import { expect, test } from '@playwright/test';

import { appConfigs } from '../../presets';
import type { FakeUser } from '../../testUtils';
import { createTestUtils, testAgainstRunningApps } from '../../testUtils';

testAgainstRunningApps({ withEnv: [appConfigs.envs.withAPIKeys] })('api keys @generic', ({ app }) => {
test.describe.configure({ mode: 'serial' });

let fakeUser: FakeUser;

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

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

test('can create api keys', async ({ page, context }) => {
const u = createTestUtils({ app, page, context });
await u.po.signIn.goTo();
await u.po.signIn.waitForMounted();
await u.po.signIn.signInWithEmailAndInstantPassword({ email: fakeUser.email, password: fakeUser.password });
await u.po.expect.toBeSignedIn();

await u.po.page.goToRelative('/api-keys');
await u.po.apiKeys.waitForMounted();

// Create API key 1
await u.po.apiKeys.clickAddButton();
await u.po.apiKeys.waitForFormOpened();
await u.po.apiKeys.typeName(`${fakeUser.firstName}-api-key-1`);
await u.po.apiKeys.selectExpiration('1d');
await u.po.apiKeys.clickSaveButton();

await u.po.apiKeys.waitForFormClosed();

// Create API key 2
await u.po.apiKeys.clickAddButton();
await u.po.apiKeys.waitForFormOpened();
await u.po.apiKeys.typeName(`${fakeUser.firstName}-api-key-2`);
await u.po.apiKeys.selectExpiration('7d');
await u.po.apiKeys.clickSaveButton();

// Check if both API keys are created
await expect(u.page.locator('.cl-apiKeysTable .cl-tableRow')).toHaveCount(2);
});

test('can revoke api keys', async ({ page, context }) => {
const u = createTestUtils({ app, page, context });
await u.po.signIn.goTo();
await u.po.signIn.waitForMounted();
await u.po.signIn.signInWithEmailAndInstantPassword({ email: fakeUser.email, password: fakeUser.password });
await u.po.expect.toBeSignedIn();

await u.po.page.goToRelative('/api-keys');
await u.po.apiKeys.waitForMounted();

const apiKeyName = `${fakeUser.firstName}-${Date.now()}`;

// Create API key
await u.po.apiKeys.clickAddButton();
await u.po.apiKeys.waitForFormOpened();
await u.po.apiKeys.typeName(apiKeyName);
await u.po.apiKeys.selectExpiration('1d');
await u.po.apiKeys.clickSaveButton();
await u.po.apiKeys.waitForFormClosed();

// Retrieve API key
const table = u.page.locator('.cl-apiKeysTable');
const row = table.locator('.cl-tableRow', { hasText: apiKeyName });
await row.waitFor({ state: 'attached' });

// Revoke API key
await row.locator('.cl-menuButton').click();
const revokeButton = u.page.getByRole('menuitem', { name: 'Revoke key' });
await revokeButton.waitFor({ state: 'attached' });
await revokeButton.click();

// Wait for revoke modal and confirm revocation
await u.po.apiKeys.waitForRevokeModalOpened();
await u.po.apiKeys.typeRevokeConfirmation('Revoke');
await u.po.apiKeys.clickConfirmRevokeButton();
await u.po.apiKeys.waitForRevokeModalClosed();

// Check if record is removed from the table
await expect(table.locator('.cl-tableRow', { hasText: apiKeyName })).toHaveCount(0);
});

test('can copy api key secret', async ({ page, context }) => {
const u = createTestUtils({ app, page, context });
await u.po.signIn.goTo();
await u.po.signIn.waitForMounted();
await u.po.signIn.signInWithEmailAndInstantPassword({ email: fakeUser.email, password: fakeUser.password });
await u.po.expect.toBeSignedIn();

await u.po.page.goToRelative('/api-keys');
await u.po.apiKeys.waitForMounted();

const apiKeyName = `${fakeUser.firstName}-${Date.now()}`;

// Create API key
await u.po.apiKeys.clickAddButton();
await u.po.apiKeys.waitForFormOpened();
await u.po.apiKeys.typeName(apiKeyName);
await u.po.apiKeys.selectExpiration('1d');
await u.po.apiKeys.clickSaveButton();
await u.po.apiKeys.waitForFormClosed();

const responsePromise = page.waitForResponse(
response => response.url().includes('/secret') && response.request().method() === 'GET',
);

// Copy API key
const table = u.page.locator('.cl-apiKeysTable');
const row = table.locator('.cl-tableRow', { hasText: apiKeyName });
await row.waitFor({ state: 'attached' });
await row.locator('.cl-apiKeysCopyButton').click();

// Read clipboard contents
const data = await (await responsePromise).json();
await context.grantPermissions(['clipboard-read']);
const clipboardText = await page.evaluate('navigator.clipboard.readText()');
await context.clearPermissions();
expect(clipboardText).toBe(data.secret);
});

test('can toggle api key secret visibility', async ({ page, context }) => {
const u = createTestUtils({ app, page, context });
await u.po.signIn.goTo();
await u.po.signIn.waitForMounted();
await u.po.signIn.signInWithEmailAndInstantPassword({ email: fakeUser.email, password: fakeUser.password });
await u.po.expect.toBeSignedIn();

await u.po.page.goToRelative('/api-keys');
await u.po.apiKeys.waitForMounted();

const apiKeyName = `${fakeUser.firstName}-${Date.now()}`;

// Create API key
await u.po.apiKeys.clickAddButton();
await u.po.apiKeys.waitForFormOpened();
await u.po.apiKeys.typeName(apiKeyName);
await u.po.apiKeys.selectExpiration('1d');
await u.po.apiKeys.clickSaveButton();
await u.po.apiKeys.waitForFormClosed();

const responsePromise = page.waitForResponse(
response => response.url().includes('/secret') && response.request().method() === 'GET',
);

// Toggle API key secret visibility
const table = u.page.locator('.cl-apiKeysTable');
const row = table.locator('.cl-tableRow', { hasText: apiKeyName });
await row.waitFor({ state: 'attached' });
await expect(row.locator('input')).toHaveAttribute('type', 'password');
await row.locator('.cl-apiKeysRevealButton').click();

// Verify if secret matches the input value
const data = await (await responsePromise).json();
await expect(row.locator('input')).toHaveAttribute('type', 'text');
await expect(row.locator('input')).toHaveValue(data.secret);

// Toggle visibility off
await row.locator('.cl-apiKeysRevealButton').click();
await expect(row.locator('input')).toHaveAttribute('type', 'password');
});
});
59 changes: 59 additions & 0 deletions packages/testing/src/playwright/unstable/page-objects/apiKeys.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
import type { EnhancedPage } from './app';
import { common } from './common';

export const createAPIKeysComponentPageObject = (testArgs: { page: EnhancedPage }) => {
const { page } = testArgs;

const expirationOptions = {
never: 'Never',
'1d': '1 Day',
'7d': '7 Days',
'30d': '30 Days',
'60d': '60 Days',
'90d': '90 Days',
'180d': '180 Days',
'1y': '1 Year',
} as const;

const self = {
...common(testArgs),
waitForMounted: () => {
return page.waitForSelector('.cl-apiKeys-root', { state: 'attached' });
},
clickAddButton: () => {
return page.getByText(/Add new key/i).click();
},
waitForFormOpened: () => {
return page.waitForSelector('.cl-apiKeysCreateForm', { state: 'attached' });
},
waitForFormClosed: () => {
return page.waitForSelector('.cl-apiKeysCreateForm', { state: 'detached' });
},
waitForRevokeModalOpened: () => {
return page.waitForSelector('.cl-apiKeysRevokeModal', { state: 'attached' });
},
waitForRevokeModalClosed: () => {
return page.waitForSelector('.cl-apiKeysRevokeModal', { state: 'detached' });
},
typeName: (value: string) => {
return page.getByLabel(/Secret key name/i).fill(value);
},
typeDescription: (value: string) => {
return page.getByLabel(/Description/i).fill(value);
},
selectExpiration: async (value?: keyof typeof expirationOptions) => {
await page.getByRole('button', { name: /Select date/i }).click();
return page.getByText(expirationOptions[value ?? 'never'], { exact: true }).click();
},
clickSaveButton: () => {
return page.getByText(/Create key/i).click();
},
typeRevokeConfirmation: (value: string) => {
return page.getByLabel(/Type "Revoke" to confirm/i).fill(value);
},
clickConfirmRevokeButton: () => {
return page.getByText(/Revoke key/i).click();
},
};
return self;
};
2 changes: 2 additions & 0 deletions packages/testing/src/playwright/unstable/page-objects/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
import type { Page } from '@playwright/test';

import { createAPIKeysComponentPageObject } from './apiKeys';
import { createAppPageObject } from './app';
import { createCheckoutPageObject } from './checkout';
import { createClerkPageObject } from './clerk';
Expand DownExpand Up@@ -46,5 +47,6 @@ export const createPageObjects = ({
userProfile: createUserProfileComponentPageObject(testArgs),
userVerification: createUserVerificationComponentPageObject(testArgs),
waitlist: createWaitlistComponentPageObject(testArgs),
apiKeys: createAPIKeysComponentPageObject(testArgs),
};
};
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
chore(repo,testing): Add API keys component e2e tests#6192

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

wobsoriano
merged 9 commits into

from

Jun 25, 2025
 Merged


chore(repo,testing): Add API keys component e2e tests
#6192
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
de41798

chore: initialize api keys component test


wobsoriano Jun 25, 2025
ddbe826

Merge remote-tracking branch 'origin/main' into rob/user-2238-api-key…


wobsoriano Jun 25, 2025
b07a364

chore: introduce more tests


wobsoriano Jun 25, 2025
0abde17

Update integration/tests/machine-auth/component.test.ts


wobsoriano Jun 25, 2025
738804a

Merge branch 'main' into rob/user-2238-api-keys-e2e


wobsoriano Jun 25, 2025
45262f1

chore: add changeset


wobsoriano Jun 25, 2025
d13bf48

chore: simplify menu button click


wobsoriano Jun 25, 2025
be7ca1b

chore: remove global permission


wobsoriano Jun 25, 2025
45f8084

chore: add api key secret visibility toggling test


wobsoriano Jun 25, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
.changeset/shiny-candles-sneeze.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
"@clerk/testing": minor
---

Add API keys component testing helpers

5 changes: 5 additions & 0 deletions
integration/templates/next-app-router/src/app/api-keys/page.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
import { APIKeys } from '@clerk/nextjs';

export default function Page() {
 return <APIKeys />;
}

172 changes: 172 additions & 0 deletions
integration/tests/machine-auth/component.test.ts

View file


Open in desktop

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

import { appConfigs } from '../../presets';
import type { FakeUser } from '../../testUtils';
import { createTestUtils, testAgainstRunningApps } from '../../testUtils';

testAgainstRunningApps({ withEnv: [appConfigs.envs.withAPIKeys] })('api keys @generic', ({ app }) => {
 test.describe.configure({ mode: 'serial' });

 let fakeUser: FakeUser;

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

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

 test('can create api keys', async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });
 await u.po.signIn.goTo();
 await u.po.signIn.waitForMounted();
 await u.po.signIn.signInWithEmailAndInstantPassword({ email: fakeUser.email, password: fakeUser.password });
 await u.po.expect.toBeSignedIn();

 await u.po.page.goToRelative('/api-keys');
 await u.po.apiKeys.waitForMounted();

 // Create API key 1
 await u.po.apiKeys.clickAddButton();
 await u.po.apiKeys.waitForFormOpened();
 await u.po.apiKeys.typeName(`${fakeUser.firstName}-api-key-1`);
 await u.po.apiKeys.selectExpiration('1d');
 await u.po.apiKeys.clickSaveButton();

 await u.po.apiKeys.waitForFormClosed();

 // Create API key 2
 await u.po.apiKeys.clickAddButton();
 await u.po.apiKeys.waitForFormOpened();
 await u.po.apiKeys.typeName(`${fakeUser.firstName}-api-key-2`);
 await u.po.apiKeys.selectExpiration('7d');
 await u.po.apiKeys.clickSaveButton();

 // Check if both API keys are created
 await expect(u.page.locator('.cl-apiKeysTable .cl-tableRow')).toHaveCount(2);
 });

 test('can revoke api keys', async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });
 await u.po.signIn.goTo();
 await u.po.signIn.waitForMounted();
 await u.po.signIn.signInWithEmailAndInstantPassword({ email: fakeUser.email, password: fakeUser.password });
 await u.po.expect.toBeSignedIn();

 await u.po.page.goToRelative('/api-keys');
 await u.po.apiKeys.waitForMounted();

 const apiKeyName = `${fakeUser.firstName}-${Date.now()}`;

 // Create API key
 await u.po.apiKeys.clickAddButton();
 await u.po.apiKeys.waitForFormOpened();
 await u.po.apiKeys.typeName(apiKeyName);
 await u.po.apiKeys.selectExpiration('1d');
 await u.po.apiKeys.clickSaveButton();
 await u.po.apiKeys.waitForFormClosed();

 // Retrieve API key
 const table = u.page.locator('.cl-apiKeysTable');
 const row = table.locator('.cl-tableRow', { hasText: apiKeyName });
 await row.waitFor({ state: 'attached' });

 // Revoke API key
 await row.locator('.cl-menuButton').click();
 const revokeButton = u.page.getByRole('menuitem', { name: 'Revoke key' });
 await revokeButton.waitFor({ state: 'attached' });
 await revokeButton.click();

 // Wait for revoke modal and confirm revocation
 await u.po.apiKeys.waitForRevokeModalOpened();
 await u.po.apiKeys.typeRevokeConfirmation('Revoke');
 await u.po.apiKeys.clickConfirmRevokeButton();
 await u.po.apiKeys.waitForRevokeModalClosed();

 // Check if record is removed from the table
 await expect(table.locator('.cl-tableRow', { hasText: apiKeyName })).toHaveCount(0);
 });

 test('can copy api key secret', async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });
 await u.po.signIn.goTo();
 await u.po.signIn.waitForMounted();
 await u.po.signIn.signInWithEmailAndInstantPassword({ email: fakeUser.email, password: fakeUser.password });
 await u.po.expect.toBeSignedIn();

 await u.po.page.goToRelative('/api-keys');
 await u.po.apiKeys.waitForMounted();

 const apiKeyName = `${fakeUser.firstName}-${Date.now()}`;

 // Create API key
 await u.po.apiKeys.clickAddButton();
 await u.po.apiKeys.waitForFormOpened();
 await u.po.apiKeys.typeName(apiKeyName);
 await u.po.apiKeys.selectExpiration('1d');
 await u.po.apiKeys.clickSaveButton();
 await u.po.apiKeys.waitForFormClosed();

 const responsePromise = page.waitForResponse(
 response => response.url().includes('/secret') && response.request().method() === 'GET',
 );

 // Copy API key
 const table = u.page.locator('.cl-apiKeysTable');
 const row = table.locator('.cl-tableRow', { hasText: apiKeyName });
 await row.waitFor({ state: 'attached' });
 await row.locator('.cl-apiKeysCopyButton').click();

 // Read clipboard contents
 const data = await (await responsePromise).json();
 await context.grantPermissions(['clipboard-read']);
 const clipboardText = await page.evaluate('navigator.clipboard.readText()');
 await context.clearPermissions();
 expect(clipboardText).toBe(data.secret);
 });

 test('can toggle api key secret visibility', async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });
 await u.po.signIn.goTo();
 await u.po.signIn.waitForMounted();
 await u.po.signIn.signInWithEmailAndInstantPassword({ email: fakeUser.email, password: fakeUser.password });
 await u.po.expect.toBeSignedIn();

 await u.po.page.goToRelative('/api-keys');
 await u.po.apiKeys.waitForMounted();

 const apiKeyName = `${fakeUser.firstName}-${Date.now()}`;

 // Create API key
 await u.po.apiKeys.clickAddButton();
 await u.po.apiKeys.waitForFormOpened();
 await u.po.apiKeys.typeName(apiKeyName);
 await u.po.apiKeys.selectExpiration('1d');
 await u.po.apiKeys.clickSaveButton();
 await u.po.apiKeys.waitForFormClosed();

 const responsePromise = page.waitForResponse(
 response => response.url().includes('/secret') && response.request().method() === 'GET',
 );

 // Toggle API key secret visibility
 const table = u.page.locator('.cl-apiKeysTable');
 const row = table.locator('.cl-tableRow', { hasText: apiKeyName });
 await row.waitFor({ state: 'attached' });
 await expect(row.locator('input')).toHaveAttribute('type', 'password');
 await row.locator('.cl-apiKeysRevealButton').click();

 // Verify if secret matches the input value
 const data = await (await responsePromise).json();
 await expect(row.locator('input')).toHaveAttribute('type', 'text');
 await expect(row.locator('input')).toHaveValue(data.secret);

 // Toggle visibility off
 await row.locator('.cl-apiKeysRevealButton').click();
 await expect(row.locator('input')).toHaveAttribute('type', 'password');
 });
});

59 changes: 59 additions & 0 deletions
packages/testing/src/playwright/unstable/page-objects/apiKeys.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
import type { EnhancedPage } from './app';
import { common } from './common';

export const createAPIKeysComponentPageObject = (testArgs: { page: EnhancedPage }) => {
 const { page } = testArgs;

 const expirationOptions = {
 never: 'Never',
 '1d': '1 Day',
 '7d': '7 Days',
 '30d': '30 Days',
 '60d': '60 Days',
 '90d': '90 Days',
 '180d': '180 Days',
 '1y': '1 Year',
 } as const;

 const self = {
 ...common(testArgs),
 waitForMounted: () => {
 return page.waitForSelector('.cl-apiKeys-root', { state: 'attached' });
 },
 clickAddButton: () => {
 return page.getByText(/Add new key/i).click();
 },
 waitForFormOpened: () => {
 return page.waitForSelector('.cl-apiKeysCreateForm', { state: 'attached' });
 },
 waitForFormClosed: () => {
 return page.waitForSelector('.cl-apiKeysCreateForm', { state: 'detached' });
 },
 waitForRevokeModalOpened: () => {
 return page.waitForSelector('.cl-apiKeysRevokeModal', { state: 'attached' });
 },
 waitForRevokeModalClosed: () => {
 return page.waitForSelector('.cl-apiKeysRevokeModal', { state: 'detached' });
 },
 typeName: (value: string) => {
 return page.getByLabel(/Secret key name/i).fill(value);
 },
 typeDescription: (value: string) => {
 return page.getByLabel(/Description/i).fill(value);
 },
 selectExpiration: async (value?: keyof typeof expirationOptions) => {
 await page.getByRole('button', { name: /Select date/i }).click();
 return page.getByText(expirationOptions[value ?? 'never'], { exact: true }).click();
 },
 clickSaveButton: () => {
 return page.getByText(/Create key/i).click();
 },
 typeRevokeConfirmation: (value: string) => {
 return page.getByLabel(/Type "Revoke" to confirm/i).fill(value);
 },
 clickConfirmRevokeButton: () => {
 return page.getByText(/Revoke key/i).click();
 },
 };
 return self;
};

2 changes: 2 additions & 0 deletions
packages/testing/src/playwright/unstable/page-objects/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
import type { Page } from '@playwright/test';

import { createAPIKeysComponentPageObject } from './apiKeys';
import { createAppPageObject } from './app';
import { createCheckoutPageObject } from './checkout';
import { createClerkPageObject } from './clerk';
Expand DownExpand Up@@ -46,5 +47,6 @@ export const createPageObjects = ({
 userProfile: createUserProfileComponentPageObject(testArgs),
 userVerification: createUserVerificationComponentPageObject(testArgs),
 waitlist: createWaitlistComponentPageObject(testArgs),
 apiKeys: createAPIKeysComponentPageObject(testArgs),
 };
};

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
chore(repo,testing): Add API keys component e2e tests#6192

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

wobsoriano
merged 9 commits into

from

Jun 25, 2025
 Merged


chore(repo,testing): Add API keys component e2e tests
#6192
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
de41798

chore: initialize api keys component test


wobsoriano Jun 25, 2025
ddbe826

Merge remote-tracking branch 'origin/main' into rob/user-2238-api-key…


wobsoriano Jun 25, 2025
b07a364

chore: introduce more tests


wobsoriano Jun 25, 2025
0abde17

Update integration/tests/machine-auth/component.test.ts


wobsoriano Jun 25, 2025
738804a

Merge branch 'main' into rob/user-2238-api-keys-e2e


wobsoriano Jun 25, 2025
45262f1

chore: add changeset


wobsoriano Jun 25, 2025
d13bf48

chore: simplify menu button click


wobsoriano Jun 25, 2025
be7ca1b

chore: remove global permission


wobsoriano Jun 25, 2025
45f8084

chore: add api key secret visibility toggling test


wobsoriano Jun 25, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
.changeset/shiny-candles-sneeze.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
"@clerk/testing": minor
---

Add API keys component testing helpers

5 changes: 5 additions & 0 deletions
integration/templates/next-app-router/src/app/api-keys/page.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
import { APIKeys } from '@clerk/nextjs';

export default function Page() {
 return <APIKeys />;
}

172 changes: 172 additions & 0 deletions
integration/tests/machine-auth/component.test.ts

View file


Open in desktop

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

import { appConfigs } from '../../presets';
import type { FakeUser } from '../../testUtils';
import { createTestUtils, testAgainstRunningApps } from '../../testUtils';

testAgainstRunningApps({ withEnv: [appConfigs.envs.withAPIKeys] })('api keys @generic', ({ app }) => {
 test.describe.configure({ mode: 'serial' });

 let fakeUser: FakeUser;

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

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

 test('can create api keys', async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });
 await u.po.signIn.goTo();
 await u.po.signIn.waitForMounted();
 await u.po.signIn.signInWithEmailAndInstantPassword({ email: fakeUser.email, password: fakeUser.password });
 await u.po.expect.toBeSignedIn();

 await u.po.page.goToRelative('/api-keys');
 await u.po.apiKeys.waitForMounted();

 // Create API key 1
 await u.po.apiKeys.clickAddButton();
 await u.po.apiKeys.waitForFormOpened();
 await u.po.apiKeys.typeName(`${fakeUser.firstName}-api-key-1`);
 await u.po.apiKeys.selectExpiration('1d');
 await u.po.apiKeys.clickSaveButton();

 await u.po.apiKeys.waitForFormClosed();

 // Create API key 2
 await u.po.apiKeys.clickAddButton();
 await u.po.apiKeys.waitForFormOpened();
 await u.po.apiKeys.typeName(`${fakeUser.firstName}-api-key-2`);
 await u.po.apiKeys.selectExpiration('7d');
 await u.po.apiKeys.clickSaveButton();

 // Check if both API keys are created
 await expect(u.page.locator('.cl-apiKeysTable .cl-tableRow')).toHaveCount(2);
 });

 test('can revoke api keys', async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });
 await u.po.signIn.goTo();
 await u.po.signIn.waitForMounted();
 await u.po.signIn.signInWithEmailAndInstantPassword({ email: fakeUser.email, password: fakeUser.password });
 await u.po.expect.toBeSignedIn();

 await u.po.page.goToRelative('/api-keys');
 await u.po.apiKeys.waitForMounted();

 const apiKeyName = `${fakeUser.firstName}-${Date.now()}`;

 // Create API key
 await u.po.apiKeys.clickAddButton();
 await u.po.apiKeys.waitForFormOpened();
 await u.po.apiKeys.typeName(apiKeyName);
 await u.po.apiKeys.selectExpiration('1d');
 await u.po.apiKeys.clickSaveButton();
 await u.po.apiKeys.waitForFormClosed();

 // Retrieve API key
 const table = u.page.locator('.cl-apiKeysTable');
 const row = table.locator('.cl-tableRow', { hasText: apiKeyName });
 await row.waitFor({ state: 'attached' });

 // Revoke API key
 await row.locator('.cl-menuButton').click();
 const revokeButton = u.page.getByRole('menuitem', { name: 'Revoke key' });
 await revokeButton.waitFor({ state: 'attached' });
 await revokeButton.click();

 // Wait for revoke modal and confirm revocation
 await u.po.apiKeys.waitForRevokeModalOpened();
 await u.po.apiKeys.typeRevokeConfirmation('Revoke');
 await u.po.apiKeys.clickConfirmRevokeButton();
 await u.po.apiKeys.waitForRevokeModalClosed();

 // Check if record is removed from the table
 await expect(table.locator('.cl-tableRow', { hasText: apiKeyName })).toHaveCount(0);
 });

 test('can copy api key secret', async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });
 await u.po.signIn.goTo();
 await u.po.signIn.waitForMounted();
 await u.po.signIn.signInWithEmailAndInstantPassword({ email: fakeUser.email, password: fakeUser.password });
 await u.po.expect.toBeSignedIn();

 await u.po.page.goToRelative('/api-keys');
 await u.po.apiKeys.waitForMounted();

 const apiKeyName = `${fakeUser.firstName}-${Date.now()}`;

 // Create API key
 await u.po.apiKeys.clickAddButton();
 await u.po.apiKeys.waitForFormOpened();
 await u.po.apiKeys.typeName(apiKeyName);
 await u.po.apiKeys.selectExpiration('1d');
 await u.po.apiKeys.clickSaveButton();
 await u.po.apiKeys.waitForFormClosed();

 const responsePromise = page.waitForResponse(
 response => response.url().includes('/secret') && response.request().method() === 'GET',
 );

 // Copy API key
 const table = u.page.locator('.cl-apiKeysTable');
 const row = table.locator('.cl-tableRow', { hasText: apiKeyName });
 await row.waitFor({ state: 'attached' });
 await row.locator('.cl-apiKeysCopyButton').click();

 // Read clipboard contents
 const data = await (await responsePromise).json();
 await context.grantPermissions(['clipboard-read']);
 const clipboardText = await page.evaluate('navigator.clipboard.readText()');
 await context.clearPermissions();
 expect(clipboardText).toBe(data.secret);
 });

 test('can toggle api key secret visibility', async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });
 await u.po.signIn.goTo();
 await u.po.signIn.waitForMounted();
 await u.po.signIn.signInWithEmailAndInstantPassword({ email: fakeUser.email, password: fakeUser.password });
 await u.po.expect.toBeSignedIn();

 await u.po.page.goToRelative('/api-keys');
 await u.po.apiKeys.waitForMounted();

 const apiKeyName = `${fakeUser.firstName}-${Date.now()}`;

 // Create API key
 await u.po.apiKeys.clickAddButton();
 await u.po.apiKeys.waitForFormOpened();
 await u.po.apiKeys.typeName(apiKeyName);
 await u.po.apiKeys.selectExpiration('1d');
 await u.po.apiKeys.clickSaveButton();
 await u.po.apiKeys.waitForFormClosed();

 const responsePromise = page.waitForResponse(
 response => response.url().includes('/secret') && response.request().method() === 'GET',
 );

 // Toggle API key secret visibility
 const table = u.page.locator('.cl-apiKeysTable');
 const row = table.locator('.cl-tableRow', { hasText: apiKeyName });
 await row.waitFor({ state: 'attached' });
 await expect(row.locator('input')).toHaveAttribute('type', 'password');
 await row.locator('.cl-apiKeysRevealButton').click();

 // Verify if secret matches the input value
 const data = await (await responsePromise).json();
 await expect(row.locator('input')).toHaveAttribute('type', 'text');
 await expect(row.locator('input')).toHaveValue(data.secret);

 // Toggle visibility off
 await row.locator('.cl-apiKeysRevealButton').click();
 await expect(row.locator('input')).toHaveAttribute('type', 'password');
 });
});

59 changes: 59 additions & 0 deletions
packages/testing/src/playwright/unstable/page-objects/apiKeys.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
import type { EnhancedPage } from './app';
import { common } from './common';

export const createAPIKeysComponentPageObject = (testArgs: { page: EnhancedPage }) => {
 const { page } = testArgs;

 const expirationOptions = {
 never: 'Never',
 '1d': '1 Day',
 '7d': '7 Days',
 '30d': '30 Days',
 '60d': '60 Days',
 '90d': '90 Days',
 '180d': '180 Days',
 '1y': '1 Year',
 } as const;

 const self = {
 ...common(testArgs),
 waitForMounted: () => {
 return page.waitForSelector('.cl-apiKeys-root', { state: 'attached' });
 },
 clickAddButton: () => {
 return page.getByText(/Add new key/i).click();
 },
 waitForFormOpened: () => {
 return page.waitForSelector('.cl-apiKeysCreateForm', { state: 'attached' });
 },
 waitForFormClosed: () => {
 return page.waitForSelector('.cl-apiKeysCreateForm', { state: 'detached' });
 },
 waitForRevokeModalOpened: () => {
 return page.waitForSelector('.cl-apiKeysRevokeModal', { state: 'attached' });
 },
 waitForRevokeModalClosed: () => {
 return page.waitForSelector('.cl-apiKeysRevokeModal', { state: 'detached' });
 },
 typeName: (value: string) => {
 return page.getByLabel(/Secret key name/i).fill(value);
 },
 typeDescription: (value: string) => {
 return page.getByLabel(/Description/i).fill(value);
 },
 selectExpiration: async (value?: keyof typeof expirationOptions) => {
 await page.getByRole('button', { name: /Select date/i }).click();
 return page.getByText(expirationOptions[value ?? 'never'], { exact: true }).click();
 },
 clickSaveButton: () => {
 return page.getByText(/Create key/i).click();
 },
 typeRevokeConfirmation: (value: string) => {
 return page.getByLabel(/Type "Revoke" to confirm/i).fill(value);
 },
 clickConfirmRevokeButton: () => {
 return page.getByText(/Revoke key/i).click();
 },
 };
 return self;
};

2 changes: 2 additions & 0 deletions
packages/testing/src/playwright/unstable/page-objects/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
import type { Page } from '@playwright/test';

import { createAPIKeysComponentPageObject } from './apiKeys';
import { createAppPageObject } from './app';
import { createCheckoutPageObject } from './checkout';
import { createClerkPageObject } from './clerk';
Expand DownExpand Up@@ -46,5 +47,6 @@ export const createPageObjects = ({
 userProfile: createUserProfileComponentPageObject(testArgs),
 userVerification: createUserVerificationComponentPageObject(testArgs),
 waitlist: createWaitlistComponentPageObject(testArgs),
 apiKeys: createAPIKeysComponentPageObject(testArgs),
 };
};

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
chore(repo,testing): Add API keys component e2e tests#6192

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

wobsoriano
merged 9 commits into

from

Jun 25, 2025
 Merged


chore(repo,testing): Add API keys component e2e tests
#6192
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
de41798

chore: initialize api keys component test


wobsoriano Jun 25, 2025
ddbe826

Merge remote-tracking branch 'origin/main' into rob/user-2238-api-key…


wobsoriano Jun 25, 2025
b07a364

chore: introduce more tests


wobsoriano Jun 25, 2025
0abde17

Update integration/tests/machine-auth/component.test.ts


wobsoriano Jun 25, 2025
738804a

Merge branch 'main' into rob/user-2238-api-keys-e2e


wobsoriano Jun 25, 2025
45262f1

chore: add changeset


wobsoriano Jun 25, 2025
d13bf48

chore: simplify menu button click


wobsoriano Jun 25, 2025
be7ca1b

chore: remove global permission


wobsoriano Jun 25, 2025
45f8084

chore: add api key secret visibility toggling test


wobsoriano Jun 25, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
.changeset/shiny-candles-sneeze.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
"@clerk/testing": minor
---

Add API keys component testing helpers

5 changes: 5 additions & 0 deletions
integration/templates/next-app-router/src/app/api-keys/page.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
import { APIKeys } from '@clerk/nextjs';

export default function Page() {
 return <APIKeys />;
}

172 changes: 172 additions & 0 deletions
integration/tests/machine-auth/component.test.ts

View file


Open in desktop

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

import { appConfigs } from '../../presets';
import type { FakeUser } from '../../testUtils';
import { createTestUtils, testAgainstRunningApps } from '../../testUtils';

testAgainstRunningApps({ withEnv: [appConfigs.envs.withAPIKeys] })('api keys @generic', ({ app }) => {
 test.describe.configure({ mode: 'serial' });

 let fakeUser: FakeUser;

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

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

 test('can create api keys', async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });
 await u.po.signIn.goTo();
 await u.po.signIn.waitForMounted();
 await u.po.signIn.signInWithEmailAndInstantPassword({ email: fakeUser.email, password: fakeUser.password });
 await u.po.expect.toBeSignedIn();

 await u.po.page.goToRelative('/api-keys');
 await u.po.apiKeys.waitForMounted();

 // Create API key 1
 await u.po.apiKeys.clickAddButton();
 await u.po.apiKeys.waitForFormOpened();
 await u.po.apiKeys.typeName(`${fakeUser.firstName}-api-key-1`);
 await u.po.apiKeys.selectExpiration('1d');
 await u.po.apiKeys.clickSaveButton();

 await u.po.apiKeys.waitForFormClosed();

 // Create API key 2
 await u.po.apiKeys.clickAddButton();
 await u.po.apiKeys.waitForFormOpened();
 await u.po.apiKeys.typeName(`${fakeUser.firstName}-api-key-2`);
 await u.po.apiKeys.selectExpiration('7d');
 await u.po.apiKeys.clickSaveButton();

 // Check if both API keys are created
 await expect(u.page.locator('.cl-apiKeysTable .cl-tableRow')).toHaveCount(2);
 });

 test('can revoke api keys', async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });
 await u.po.signIn.goTo();
 await u.po.signIn.waitForMounted();
 await u.po.signIn.signInWithEmailAndInstantPassword({ email: fakeUser.email, password: fakeUser.password });
 await u.po.expect.toBeSignedIn();

 await u.po.page.goToRelative('/api-keys');
 await u.po.apiKeys.waitForMounted();

 const apiKeyName = `${fakeUser.firstName}-${Date.now()}`;

 // Create API key
 await u.po.apiKeys.clickAddButton();
 await u.po.apiKeys.waitForFormOpened();
 await u.po.apiKeys.typeName(apiKeyName);
 await u.po.apiKeys.selectExpiration('1d');
 await u.po.apiKeys.clickSaveButton();
 await u.po.apiKeys.waitForFormClosed();

 // Retrieve API key
 const table = u.page.locator('.cl-apiKeysTable');
 const row = table.locator('.cl-tableRow', { hasText: apiKeyName });
 await row.waitFor({ state: 'attached' });

 // Revoke API key
 await row.locator('.cl-menuButton').click();
 const revokeButton = u.page.getByRole('menuitem', { name: 'Revoke key' });
 await revokeButton.waitFor({ state: 'attached' });
 await revokeButton.click();

 // Wait for revoke modal and confirm revocation
 await u.po.apiKeys.waitForRevokeModalOpened();
 await u.po.apiKeys.typeRevokeConfirmation('Revoke');
 await u.po.apiKeys.clickConfirmRevokeButton();
 await u.po.apiKeys.waitForRevokeModalClosed();

 // Check if record is removed from the table
 await expect(table.locator('.cl-tableRow', { hasText: apiKeyName })).toHaveCount(0);
 });

 test('can copy api key secret', async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });
 await u.po.signIn.goTo();
 await u.po.signIn.waitForMounted();
 await u.po.signIn.signInWithEmailAndInstantPassword({ email: fakeUser.email, password: fakeUser.password });
 await u.po.expect.toBeSignedIn();

 await u.po.page.goToRelative('/api-keys');
 await u.po.apiKeys.waitForMounted();

 const apiKeyName = `${fakeUser.firstName}-${Date.now()}`;

 // Create API key
 await u.po.apiKeys.clickAddButton();
 await u.po.apiKeys.waitForFormOpened();
 await u.po.apiKeys.typeName(apiKeyName);
 await u.po.apiKeys.selectExpiration('1d');
 await u.po.apiKeys.clickSaveButton();
 await u.po.apiKeys.waitForFormClosed();

 const responsePromise = page.waitForResponse(
 response => response.url().includes('/secret') && response.request().method() === 'GET',
 );

 // Copy API key
 const table = u.page.locator('.cl-apiKeysTable');
 const row = table.locator('.cl-tableRow', { hasText: apiKeyName });
 await row.waitFor({ state: 'attached' });
 await row.locator('.cl-apiKeysCopyButton').click();

 // Read clipboard contents
 const data = await (await responsePromise).json();
 await context.grantPermissions(['clipboard-read']);
 const clipboardText = await page.evaluate('navigator.clipboard.readText()');
 await context.clearPermissions();
 expect(clipboardText).toBe(data.secret);
 });

 test('can toggle api key secret visibility', async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });
 await u.po.signIn.goTo();
 await u.po.signIn.waitForMounted();
 await u.po.signIn.signInWithEmailAndInstantPassword({ email: fakeUser.email, password: fakeUser.password });
 await u.po.expect.toBeSignedIn();

 await u.po.page.goToRelative('/api-keys');
 await u.po.apiKeys.waitForMounted();

 const apiKeyName = `${fakeUser.firstName}-${Date.now()}`;

 // Create API key
 await u.po.apiKeys.clickAddButton();
 await u.po.apiKeys.waitForFormOpened();
 await u.po.apiKeys.typeName(apiKeyName);
 await u.po.apiKeys.selectExpiration('1d');
 await u.po.apiKeys.clickSaveButton();
 await u.po.apiKeys.waitForFormClosed();

 const responsePromise = page.waitForResponse(
 response => response.url().includes('/secret') && response.request().method() === 'GET',
 );

 // Toggle API key secret visibility
 const table = u.page.locator('.cl-apiKeysTable');
 const row = table.locator('.cl-tableRow', { hasText: apiKeyName });
 await row.waitFor({ state: 'attached' });
 await expect(row.locator('input')).toHaveAttribute('type', 'password');
 await row.locator('.cl-apiKeysRevealButton').click();

 // Verify if secret matches the input value
 const data = await (await responsePromise).json();
 await expect(row.locator('input')).toHaveAttribute('type', 'text');
 await expect(row.locator('input')).toHaveValue(data.secret);

 // Toggle visibility off
 await row.locator('.cl-apiKeysRevealButton').click();
 await expect(row.locator('input')).toHaveAttribute('type', 'password');
 });
});

59 changes: 59 additions & 0 deletions
packages/testing/src/playwright/unstable/page-objects/apiKeys.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
import type { EnhancedPage } from './app';
import { common } from './common';

export const createAPIKeysComponentPageObject = (testArgs: { page: EnhancedPage }) => {
 const { page } = testArgs;

 const expirationOptions = {
 never: 'Never',
 '1d': '1 Day',
 '7d': '7 Days',
 '30d': '30 Days',
 '60d': '60 Days',
 '90d': '90 Days',
 '180d': '180 Days',
 '1y': '1 Year',
 } as const;

 const self = {
 ...common(testArgs),
 waitForMounted: () => {
 return page.waitForSelector('.cl-apiKeys-root', { state: 'attached' });
 },
 clickAddButton: () => {
 return page.getByText(/Add new key/i).click();
 },
 waitForFormOpened: () => {
 return page.waitForSelector('.cl-apiKeysCreateForm', { state: 'attached' });
 },
 waitForFormClosed: () => {
 return page.waitForSelector('.cl-apiKeysCreateForm', { state: 'detached' });
 },
 waitForRevokeModalOpened: () => {
 return page.waitForSelector('.cl-apiKeysRevokeModal', { state: 'attached' });
 },
 waitForRevokeModalClosed: () => {
 return page.waitForSelector('.cl-apiKeysRevokeModal', { state: 'detached' });
 },
 typeName: (value: string) => {
 return page.getByLabel(/Secret key name/i).fill(value);
 },
 typeDescription: (value: string) => {
 return page.getByLabel(/Description/i).fill(value);
 },
 selectExpiration: async (value?: keyof typeof expirationOptions) => {
 await page.getByRole('button', { name: /Select date/i }).click();
 return page.getByText(expirationOptions[value ?? 'never'], { exact: true }).click();
 },
 clickSaveButton: () => {
 return page.getByText(/Create key/i).click();
 },
 typeRevokeConfirmation: (value: string) => {
 return page.getByLabel(/Type "Revoke" to confirm/i).fill(value);
 },
 clickConfirmRevokeButton: () => {
 return page.getByText(/Revoke key/i).click();
 },
 };
 return self;
};

2 changes: 2 additions & 0 deletions
packages/testing/src/playwright/unstable/page-objects/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
import type { Page } from '@playwright/test';

import { createAPIKeysComponentPageObject } from './apiKeys';
import { createAppPageObject } from './app';
import { createCheckoutPageObject } from './checkout';
import { createClerkPageObject } from './clerk';
Expand DownExpand Up@@ -46,5 +47,6 @@ export const createPageObjects = ({
 userProfile: createUserProfileComponentPageObject(testArgs),
 userVerification: createUserVerificationComponentPageObject(testArgs),
 waitlist: createWaitlistComponentPageObject(testArgs),
 apiKeys: createAPIKeysComponentPageObject(testArgs),
 };
};

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
chore(repo,testing): Add API keys component e2e tests#6192

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

wobsoriano
merged 9 commits into

from

Jun 25, 2025
 Merged


chore(repo,testing): Add API keys component e2e tests
#6192
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
de41798

chore: initialize api keys component test


wobsoriano Jun 25, 2025
ddbe826

Merge remote-tracking branch 'origin/main' into rob/user-2238-api-key…


wobsoriano Jun 25, 2025
b07a364

chore: introduce more tests


wobsoriano Jun 25, 2025
0abde17

Update integration/tests/machine-auth/component.test.ts


wobsoriano Jun 25, 2025
738804a

Merge branch 'main' into rob/user-2238-api-keys-e2e


wobsoriano Jun 25, 2025
45262f1

chore: add changeset


wobsoriano Jun 25, 2025
d13bf48

chore: simplify menu button click


wobsoriano Jun 25, 2025
be7ca1b

chore: remove global permission


wobsoriano Jun 25, 2025
45f8084

chore: add api key secret visibility toggling test


wobsoriano Jun 25, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
.changeset/shiny-candles-sneeze.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
"@clerk/testing": minor
---

Add API keys component testing helpers

5 changes: 5 additions & 0 deletions
integration/templates/next-app-router/src/app/api-keys/page.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
import { APIKeys } from '@clerk/nextjs';

export default function Page() {
 return <APIKeys />;
}

172 changes: 172 additions & 0 deletions
integration/tests/machine-auth/component.test.ts

View file


Open in desktop

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

import { appConfigs } from '../../presets';
import type { FakeUser } from '../../testUtils';
import { createTestUtils, testAgainstRunningApps } from '../../testUtils';

testAgainstRunningApps({ withEnv: [appConfigs.envs.withAPIKeys] })('api keys @generic', ({ app }) => {
 test.describe.configure({ mode: 'serial' });

 let fakeUser: FakeUser;

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

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

 test('can create api keys', async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });
 await u.po.signIn.goTo();
 await u.po.signIn.waitForMounted();
 await u.po.signIn.signInWithEmailAndInstantPassword({ email: fakeUser.email, password: fakeUser.password });
 await u.po.expect.toBeSignedIn();

 await u.po.page.goToRelative('/api-keys');
 await u.po.apiKeys.waitForMounted();

 // Create API key 1
 await u.po.apiKeys.clickAddButton();
 await u.po.apiKeys.waitForFormOpened();
 await u.po.apiKeys.typeName(`${fakeUser.firstName}-api-key-1`);
 await u.po.apiKeys.selectExpiration('1d');
 await u.po.apiKeys.clickSaveButton();

 await u.po.apiKeys.waitForFormClosed();

 // Create API key 2
 await u.po.apiKeys.clickAddButton();
 await u.po.apiKeys.waitForFormOpened();
 await u.po.apiKeys.typeName(`${fakeUser.firstName}-api-key-2`);
 await u.po.apiKeys.selectExpiration('7d');
 await u.po.apiKeys.clickSaveButton();

 // Check if both API keys are created
 await expect(u.page.locator('.cl-apiKeysTable .cl-tableRow')).toHaveCount(2);
 });

 test('can revoke api keys', async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });
 await u.po.signIn.goTo();
 await u.po.signIn.waitForMounted();
 await u.po.signIn.signInWithEmailAndInstantPassword({ email: fakeUser.email, password: fakeUser.password });
 await u.po.expect.toBeSignedIn();

 await u.po.page.goToRelative('/api-keys');
 await u.po.apiKeys.waitForMounted();

 const apiKeyName = `${fakeUser.firstName}-${Date.now()}`;

 // Create API key
 await u.po.apiKeys.clickAddButton();
 await u.po.apiKeys.waitForFormOpened();
 await u.po.apiKeys.typeName(apiKeyName);
 await u.po.apiKeys.selectExpiration('1d');
 await u.po.apiKeys.clickSaveButton();
 await u.po.apiKeys.waitForFormClosed();

 // Retrieve API key
 const table = u.page.locator('.cl-apiKeysTable');
 const row = table.locator('.cl-tableRow', { hasText: apiKeyName });
 await row.waitFor({ state: 'attached' });

 // Revoke API key
 await row.locator('.cl-menuButton').click();
 const revokeButton = u.page.getByRole('menuitem', { name: 'Revoke key' });
 await revokeButton.waitFor({ state: 'attached' });
 await revokeButton.click();

 // Wait for revoke modal and confirm revocation
 await u.po.apiKeys.waitForRevokeModalOpened();
 await u.po.apiKeys.typeRevokeConfirmation('Revoke');
 await u.po.apiKeys.clickConfirmRevokeButton();
 await u.po.apiKeys.waitForRevokeModalClosed();

 // Check if record is removed from the table
 await expect(table.locator('.cl-tableRow', { hasText: apiKeyName })).toHaveCount(0);
 });

 test('can copy api key secret', async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });
 await u.po.signIn.goTo();
 await u.po.signIn.waitForMounted();
 await u.po.signIn.signInWithEmailAndInstantPassword({ email: fakeUser.email, password: fakeUser.password });
 await u.po.expect.toBeSignedIn();

 await u.po.page.goToRelative('/api-keys');
 await u.po.apiKeys.waitForMounted();

 const apiKeyName = `${fakeUser.firstName}-${Date.now()}`;

 // Create API key
 await u.po.apiKeys.clickAddButton();
 await u.po.apiKeys.waitForFormOpened();
 await u.po.apiKeys.typeName(apiKeyName);
 await u.po.apiKeys.selectExpiration('1d');
 await u.po.apiKeys.clickSaveButton();
 await u.po.apiKeys.waitForFormClosed();

 const responsePromise = page.waitForResponse(
 response => response.url().includes('/secret') && response.request().method() === 'GET',
 );

 // Copy API key
 const table = u.page.locator('.cl-apiKeysTable');
 const row = table.locator('.cl-tableRow', { hasText: apiKeyName });
 await row.waitFor({ state: 'attached' });
 await row.locator('.cl-apiKeysCopyButton').click();

 // Read clipboard contents
 const data = await (await responsePromise).json();
 await context.grantPermissions(['clipboard-read']);
 const clipboardText = await page.evaluate('navigator.clipboard.readText()');
 await context.clearPermissions();
 expect(clipboardText).toBe(data.secret);
 });

 test('can toggle api key secret visibility', async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });
 await u.po.signIn.goTo();
 await u.po.signIn.waitForMounted();
 await u.po.signIn.signInWithEmailAndInstantPassword({ email: fakeUser.email, password: fakeUser.password });
 await u.po.expect.toBeSignedIn();

 await u.po.page.goToRelative('/api-keys');
 await u.po.apiKeys.waitForMounted();

 const apiKeyName = `${fakeUser.firstName}-${Date.now()}`;

 // Create API key
 await u.po.apiKeys.clickAddButton();
 await u.po.apiKeys.waitForFormOpened();
 await u.po.apiKeys.typeName(apiKeyName);
 await u.po.apiKeys.selectExpiration('1d');
 await u.po.apiKeys.clickSaveButton();
 await u.po.apiKeys.waitForFormClosed();

 const responsePromise = page.waitForResponse(
 response => response.url().includes('/secret') && response.request().method() === 'GET',
 );

 // Toggle API key secret visibility
 const table = u.page.locator('.cl-apiKeysTable');
 const row = table.locator('.cl-tableRow', { hasText: apiKeyName });
 await row.waitFor({ state: 'attached' });
 await expect(row.locator('input')).toHaveAttribute('type', 'password');
 await row.locator('.cl-apiKeysRevealButton').click();

 // Verify if secret matches the input value
 const data = await (await responsePromise).json();
 await expect(row.locator('input')).toHaveAttribute('type', 'text');
 await expect(row.locator('input')).toHaveValue(data.secret);

 // Toggle visibility off
 await row.locator('.cl-apiKeysRevealButton').click();
 await expect(row.locator('input')).toHaveAttribute('type', 'password');
 });
});

59 changes: 59 additions & 0 deletions
packages/testing/src/playwright/unstable/page-objects/apiKeys.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
import type { EnhancedPage } from './app';
import { common } from './common';

export const createAPIKeysComponentPageObject = (testArgs: { page: EnhancedPage }) => {
 const { page } = testArgs;

 const expirationOptions = {
 never: 'Never',
 '1d': '1 Day',
 '7d': '7 Days',
 '30d': '30 Days',
 '60d': '60 Days',
 '90d': '90 Days',
 '180d': '180 Days',
 '1y': '1 Year',
 } as const;

 const self = {
 ...common(testArgs),
 waitForMounted: () => {
 return page.waitForSelector('.cl-apiKeys-root', { state: 'attached' });
 },
 clickAddButton: () => {
 return page.getByText(/Add new key/i).click();
 },
 waitForFormOpened: () => {
 return page.waitForSelector('.cl-apiKeysCreateForm', { state: 'attached' });
 },
 waitForFormClosed: () => {
 return page.waitForSelector('.cl-apiKeysCreateForm', { state: 'detached' });
 },
 waitForRevokeModalOpened: () => {
 return page.waitForSelector('.cl-apiKeysRevokeModal', { state: 'attached' });
 },
 waitForRevokeModalClosed: () => {
 return page.waitForSelector('.cl-apiKeysRevokeModal', { state: 'detached' });
 },
 typeName: (value: string) => {
 return page.getByLabel(/Secret key name/i).fill(value);
 },
 typeDescription: (value: string) => {
 return page.getByLabel(/Description/i).fill(value);
 },
 selectExpiration: async (value?: keyof typeof expirationOptions) => {
 await page.getByRole('button', { name: /Select date/i }).click();
 return page.getByText(expirationOptions[value ?? 'never'], { exact: true }).click();
 },
 clickSaveButton: () => {
 return page.getByText(/Create key/i).click();
 },
 typeRevokeConfirmation: (value: string) => {
 return page.getByLabel(/Type "Revoke" to confirm/i).fill(value);
 },
 clickConfirmRevokeButton: () => {
 return page.getByText(/Revoke key/i).click();
 },
 };
 return self;
};

2 changes: 2 additions & 0 deletions
packages/testing/src/playwright/unstable/page-objects/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
import type { Page } from '@playwright/test';

import { createAPIKeysComponentPageObject } from './apiKeys';
import { createAppPageObject } from './app';
import { createCheckoutPageObject } from './checkout';
import { createClerkPageObject } from './clerk';
Expand DownExpand Up@@ -46,5 +47,6 @@ export const createPageObjects = ({
 userProfile: createUserProfileComponentPageObject(testArgs),
 userVerification: createUserVerificationComponentPageObject(testArgs),
 waitlist: createWaitlistComponentPageObject(testArgs),
 apiKeys: createAPIKeysComponentPageObject(testArgs),
 };
};

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
chore(repo,testing): Add API keys component e2e tests#6192

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

wobsoriano
merged 9 commits into

from

Jun 25, 2025
 Merged


chore(repo,testing): Add API keys component e2e tests
#6192
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
de41798

chore: initialize api keys component test


wobsoriano Jun 25, 2025
ddbe826

Merge remote-tracking branch 'origin/main' into rob/user-2238-api-key…


wobsoriano Jun 25, 2025
b07a364

chore: introduce more tests


wobsoriano Jun 25, 2025
0abde17

Update integration/tests/machine-auth/component.test.ts


wobsoriano Jun 25, 2025
738804a

Merge branch 'main' into rob/user-2238-api-keys-e2e


wobsoriano Jun 25, 2025
45262f1

chore: add changeset


wobsoriano Jun 25, 2025
d13bf48

chore: simplify menu button click


wobsoriano Jun 25, 2025
be7ca1b

chore: remove global permission


wobsoriano Jun 25, 2025
45f8084

chore: add api key secret visibility toggling test


wobsoriano Jun 25, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
.changeset/shiny-candles-sneeze.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
"@clerk/testing": minor
---

Add API keys component testing helpers

5 changes: 5 additions & 0 deletions
integration/templates/next-app-router/src/app/api-keys/page.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
import { APIKeys } from '@clerk/nextjs';

export default function Page() {
 return <APIKeys />;
}

172 changes: 172 additions & 0 deletions
integration/tests/machine-auth/component.test.ts

View file


Open in desktop

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

import { appConfigs } from '../../presets';
import type { FakeUser } from '../../testUtils';
import { createTestUtils, testAgainstRunningApps } from '../../testUtils';

testAgainstRunningApps({ withEnv: [appConfigs.envs.withAPIKeys] })('api keys @generic', ({ app }) => {
 test.describe.configure({ mode: 'serial' });

 let fakeUser: FakeUser;

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

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

 test('can create api keys', async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });
 await u.po.signIn.goTo();
 await u.po.signIn.waitForMounted();
 await u.po.signIn.signInWithEmailAndInstantPassword({ email: fakeUser.email, password: fakeUser.password });
 await u.po.expect.toBeSignedIn();

 await u.po.page.goToRelative('/api-keys');
 await u.po.apiKeys.waitForMounted();

 // Create API key 1
 await u.po.apiKeys.clickAddButton();
 await u.po.apiKeys.waitForFormOpened();
 await u.po.apiKeys.typeName(`${fakeUser.firstName}-api-key-1`);
 await u.po.apiKeys.selectExpiration('1d');
 await u.po.apiKeys.clickSaveButton();

 await u.po.apiKeys.waitForFormClosed();

 // Create API key 2
 await u.po.apiKeys.clickAddButton();
 await u.po.apiKeys.waitForFormOpened();
 await u.po.apiKeys.typeName(`${fakeUser.firstName}-api-key-2`);
 await u.po.apiKeys.selectExpiration('7d');
 await u.po.apiKeys.clickSaveButton();

 // Check if both API keys are created
 await expect(u.page.locator('.cl-apiKeysTable .cl-tableRow')).toHaveCount(2);
 });

 test('can revoke api keys', async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });
 await u.po.signIn.goTo();
 await u.po.signIn.waitForMounted();
 await u.po.signIn.signInWithEmailAndInstantPassword({ email: fakeUser.email, password: fakeUser.password });
 await u.po.expect.toBeSignedIn();

 await u.po.page.goToRelative('/api-keys');
 await u.po.apiKeys.waitForMounted();

 const apiKeyName = `${fakeUser.firstName}-${Date.now()}`;

 // Create API key
 await u.po.apiKeys.clickAddButton();
 await u.po.apiKeys.waitForFormOpened();
 await u.po.apiKeys.typeName(apiKeyName);
 await u.po.apiKeys.selectExpiration('1d');
 await u.po.apiKeys.clickSaveButton();
 await u.po.apiKeys.waitForFormClosed();

 // Retrieve API key
 const table = u.page.locator('.cl-apiKeysTable');
 const row = table.locator('.cl-tableRow', { hasText: apiKeyName });
 await row.waitFor({ state: 'attached' });

 // Revoke API key
 await row.locator('.cl-menuButton').click();
 const revokeButton = u.page.getByRole('menuitem', { name: 'Revoke key' });
 await revokeButton.waitFor({ state: 'attached' });
 await revokeButton.click();

 // Wait for revoke modal and confirm revocation
 await u.po.apiKeys.waitForRevokeModalOpened();
 await u.po.apiKeys.typeRevokeConfirmation('Revoke');
 await u.po.apiKeys.clickConfirmRevokeButton();
 await u.po.apiKeys.waitForRevokeModalClosed();

 // Check if record is removed from the table
 await expect(table.locator('.cl-tableRow', { hasText: apiKeyName })).toHaveCount(0);
 });

 test('can copy api key secret', async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });
 await u.po.signIn.goTo();
 await u.po.signIn.waitForMounted();
 await u.po.signIn.signInWithEmailAndInstantPassword({ email: fakeUser.email, password: fakeUser.password });
 await u.po.expect.toBeSignedIn();

 await u.po.page.goToRelative('/api-keys');
 await u.po.apiKeys.waitForMounted();

 const apiKeyName = `${fakeUser.firstName}-${Date.now()}`;

 // Create API key
 await u.po.apiKeys.clickAddButton();
 await u.po.apiKeys.waitForFormOpened();
 await u.po.apiKeys.typeName(apiKeyName);
 await u.po.apiKeys.selectExpiration('1d');
 await u.po.apiKeys.clickSaveButton();
 await u.po.apiKeys.waitForFormClosed();

 const responsePromise = page.waitForResponse(
 response => response.url().includes('/secret') && response.request().method() === 'GET',
 );

 // Copy API key
 const table = u.page.locator('.cl-apiKeysTable');
 const row = table.locator('.cl-tableRow', { hasText: apiKeyName });
 await row.waitFor({ state: 'attached' });
 await row.locator('.cl-apiKeysCopyButton').click();

 // Read clipboard contents
 const data = await (await responsePromise).json();
 await context.grantPermissions(['clipboard-read']);
 const clipboardText = await page.evaluate('navigator.clipboard.readText()');
 await context.clearPermissions();
 expect(clipboardText).toBe(data.secret);
 });

 test('can toggle api key secret visibility', async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });
 await u.po.signIn.goTo();
 await u.po.signIn.waitForMounted();
 await u.po.signIn.signInWithEmailAndInstantPassword({ email: fakeUser.email, password: fakeUser.password });
 await u.po.expect.toBeSignedIn();

 await u.po.page.goToRelative('/api-keys');
 await u.po.apiKeys.waitForMounted();

 const apiKeyName = `${fakeUser.firstName}-${Date.now()}`;

 // Create API key
 await u.po.apiKeys.clickAddButton();
 await u.po.apiKeys.waitForFormOpened();
 await u.po.apiKeys.typeName(apiKeyName);
 await u.po.apiKeys.selectExpiration('1d');
 await u.po.apiKeys.clickSaveButton();
 await u.po.apiKeys.waitForFormClosed();

 const responsePromise = page.waitForResponse(
 response => response.url().includes('/secret') && response.request().method() === 'GET',
 );

 // Toggle API key secret visibility
 const table = u.page.locator('.cl-apiKeysTable');
 const row = table.locator('.cl-tableRow', { hasText: apiKeyName });
 await row.waitFor({ state: 'attached' });
 await expect(row.locator('input')).toHaveAttribute('type', 'password');
 await row.locator('.cl-apiKeysRevealButton').click();

 // Verify if secret matches the input value
 const data = await (await responsePromise).json();
 await expect(row.locator('input')).toHaveAttribute('type', 'text');
 await expect(row.locator('input')).toHaveValue(data.secret);

 // Toggle visibility off
 await row.locator('.cl-apiKeysRevealButton').click();
 await expect(row.locator('input')).toHaveAttribute('type', 'password');
 });
});

59 changes: 59 additions & 0 deletions
packages/testing/src/playwright/unstable/page-objects/apiKeys.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
import type { EnhancedPage } from './app';
import { common } from './common';

export const createAPIKeysComponentPageObject = (testArgs: { page: EnhancedPage }) => {
 const { page } = testArgs;

 const expirationOptions = {
 never: 'Never',
 '1d': '1 Day',
 '7d': '7 Days',
 '30d': '30 Days',
 '60d': '60 Days',
 '90d': '90 Days',
 '180d': '180 Days',
 '1y': '1 Year',
 } as const;

 const self = {
 ...common(testArgs),
 waitForMounted: () => {
 return page.waitForSelector('.cl-apiKeys-root', { state: 'attached' });
 },
 clickAddButton: () => {
 return page.getByText(/Add new key/i).click();
 },
 waitForFormOpened: () => {
 return page.waitForSelector('.cl-apiKeysCreateForm', { state: 'attached' });
 },
 waitForFormClosed: () => {
 return page.waitForSelector('.cl-apiKeysCreateForm', { state: 'detached' });
 },
 waitForRevokeModalOpened: () => {
 return page.waitForSelector('.cl-apiKeysRevokeModal', { state: 'attached' });
 },
 waitForRevokeModalClosed: () => {
 return page.waitForSelector('.cl-apiKeysRevokeModal', { state: 'detached' });
 },
 typeName: (value: string) => {
 return page.getByLabel(/Secret key name/i).fill(value);
 },
 typeDescription: (value: string) => {
 return page.getByLabel(/Description/i).fill(value);
 },
 selectExpiration: async (value?: keyof typeof expirationOptions) => {
 await page.getByRole('button', { name: /Select date/i }).click();
 return page.getByText(expirationOptions[value ?? 'never'], { exact: true }).click();
 },
 clickSaveButton: () => {
 return page.getByText(/Create key/i).click();
 },
 typeRevokeConfirmation: (value: string) => {
 return page.getByLabel(/Type "Revoke" to confirm/i).fill(value);
 },
 clickConfirmRevokeButton: () => {
 return page.getByText(/Revoke key/i).click();
 },
 };
 return self;
};

2 changes: 2 additions & 0 deletions
packages/testing/src/playwright/unstable/page-objects/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
import type { Page } from '@playwright/test';

import { createAPIKeysComponentPageObject } from './apiKeys';
import { createAppPageObject } from './app';
import { createCheckoutPageObject } from './checkout';
import { createClerkPageObject } from './clerk';
Expand DownExpand Up@@ -46,5 +47,6 @@ export const createPageObjects = ({
 userProfile: createUserProfileComponentPageObject(testArgs),
 userVerification: createUserVerificationComponentPageObject(testArgs),
 waitlist: createWaitlistComponentPageObject(testArgs),
 apiKeys: createAPIKeysComponentPageObject(testArgs),
 };
};

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
chore(repo,testing): Add API keys component e2e tests#6192

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

wobsoriano
merged 9 commits into

from

Jun 25, 2025
 Merged


chore(repo,testing): Add API keys component e2e tests
#6192
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
de41798

chore: initialize api keys component test


wobsoriano Jun 25, 2025
ddbe826

Merge remote-tracking branch 'origin/main' into rob/user-2238-api-key…


wobsoriano Jun 25, 2025
b07a364

chore: introduce more tests


wobsoriano Jun 25, 2025
0abde17

Update integration/tests/machine-auth/component.test.ts


wobsoriano Jun 25, 2025
738804a

Merge branch 'main' into rob/user-2238-api-keys-e2e


wobsoriano Jun 25, 2025
45262f1

chore: add changeset


wobsoriano Jun 25, 2025
d13bf48

chore: simplify menu button click


wobsoriano Jun 25, 2025
be7ca1b

chore: remove global permission


wobsoriano Jun 25, 2025
45f8084

chore: add api key secret visibility toggling test


wobsoriano Jun 25, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
.changeset/shiny-candles-sneeze.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
"@clerk/testing": minor
---

Add API keys component testing helpers

5 changes: 5 additions & 0 deletions
integration/templates/next-app-router/src/app/api-keys/page.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
import { APIKeys } from '@clerk/nextjs';

export default function Page() {
 return <APIKeys />;
}

172 changes: 172 additions & 0 deletions
integration/tests/machine-auth/component.test.ts

View file


Open in desktop

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

import { appConfigs } from '../../presets';
import type { FakeUser } from '../../testUtils';
import { createTestUtils, testAgainstRunningApps } from '../../testUtils';

testAgainstRunningApps({ withEnv: [appConfigs.envs.withAPIKeys] })('api keys @generic', ({ app }) => {
 test.describe.configure({ mode: 'serial' });

 let fakeUser: FakeUser;

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

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

 test('can create api keys', async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });
 await u.po.signIn.goTo();
 await u.po.signIn.waitForMounted();
 await u.po.signIn.signInWithEmailAndInstantPassword({ email: fakeUser.email, password: fakeUser.password });
 await u.po.expect.toBeSignedIn();

 await u.po.page.goToRelative('/api-keys');
 await u.po.apiKeys.waitForMounted();

 // Create API key 1
 await u.po.apiKeys.clickAddButton();
 await u.po.apiKeys.waitForFormOpened();
 await u.po.apiKeys.typeName(`${fakeUser.firstName}-api-key-1`);
 await u.po.apiKeys.selectExpiration('1d');
 await u.po.apiKeys.clickSaveButton();

 await u.po.apiKeys.waitForFormClosed();

 // Create API key 2
 await u.po.apiKeys.clickAddButton();
 await u.po.apiKeys.waitForFormOpened();
 await u.po.apiKeys.typeName(`${fakeUser.firstName}-api-key-2`);
 await u.po.apiKeys.selectExpiration('7d');
 await u.po.apiKeys.clickSaveButton();

 // Check if both API keys are created
 await expect(u.page.locator('.cl-apiKeysTable .cl-tableRow')).toHaveCount(2);
 });

 test('can revoke api keys', async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });
 await u.po.signIn.goTo();
 await u.po.signIn.waitForMounted();
 await u.po.signIn.signInWithEmailAndInstantPassword({ email: fakeUser.email, password: fakeUser.password });
 await u.po.expect.toBeSignedIn();

 await u.po.page.goToRelative('/api-keys');
 await u.po.apiKeys.waitForMounted();

 const apiKeyName = `${fakeUser.firstName}-${Date.now()}`;

 // Create API key
 await u.po.apiKeys.clickAddButton();
 await u.po.apiKeys.waitForFormOpened();
 await u.po.apiKeys.typeName(apiKeyName);
 await u.po.apiKeys.selectExpiration('1d');
 await u.po.apiKeys.clickSaveButton();
 await u.po.apiKeys.waitForFormClosed();

 // Retrieve API key
 const table = u.page.locator('.cl-apiKeysTable');
 const row = table.locator('.cl-tableRow', { hasText: apiKeyName });
 await row.waitFor({ state: 'attached' });

 // Revoke API key
 await row.locator('.cl-menuButton').click();
 const revokeButton = u.page.getByRole('menuitem', { name: 'Revoke key' });
 await revokeButton.waitFor({ state: 'attached' });
 await revokeButton.click();

 // Wait for revoke modal and confirm revocation
 await u.po.apiKeys.waitForRevokeModalOpened();
 await u.po.apiKeys.typeRevokeConfirmation('Revoke');
 await u.po.apiKeys.clickConfirmRevokeButton();
 await u.po.apiKeys.waitForRevokeModalClosed();

 // Check if record is removed from the table
 await expect(table.locator('.cl-tableRow', { hasText: apiKeyName })).toHaveCount(0);
 });

 test('can copy api key secret', async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });
 await u.po.signIn.goTo();
 await u.po.signIn.waitForMounted();
 await u.po.signIn.signInWithEmailAndInstantPassword({ email: fakeUser.email, password: fakeUser.password });
 await u.po.expect.toBeSignedIn();

 await u.po.page.goToRelative('/api-keys');
 await u.po.apiKeys.waitForMounted();

 const apiKeyName = `${fakeUser.firstName}-${Date.now()}`;

 // Create API key
 await u.po.apiKeys.clickAddButton();
 await u.po.apiKeys.waitForFormOpened();
 await u.po.apiKeys.typeName(apiKeyName);
 await u.po.apiKeys.selectExpiration('1d');
 await u.po.apiKeys.clickSaveButton();
 await u.po.apiKeys.waitForFormClosed();

 const responsePromise = page.waitForResponse(
 response => response.url().includes('/secret') && response.request().method() === 'GET',
 );

 // Copy API key
 const table = u.page.locator('.cl-apiKeysTable');
 const row = table.locator('.cl-tableRow', { hasText: apiKeyName });
 await row.waitFor({ state: 'attached' });
 await row.locator('.cl-apiKeysCopyButton').click();

 // Read clipboard contents
 const data = await (await responsePromise).json();
 await context.grantPermissions(['clipboard-read']);
 const clipboardText = await page.evaluate('navigator.clipboard.readText()');
 await context.clearPermissions();
 expect(clipboardText).toBe(data.secret);
 });

 test('can toggle api key secret visibility', async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });
 await u.po.signIn.goTo();
 await u.po.signIn.waitForMounted();
 await u.po.signIn.signInWithEmailAndInstantPassword({ email: fakeUser.email, password: fakeUser.password });
 await u.po.expect.toBeSignedIn();

 await u.po.page.goToRelative('/api-keys');
 await u.po.apiKeys.waitForMounted();

 const apiKeyName = `${fakeUser.firstName}-${Date.now()}`;

 // Create API key
 await u.po.apiKeys.clickAddButton();
 await u.po.apiKeys.waitForFormOpened();
 await u.po.apiKeys.typeName(apiKeyName);
 await u.po.apiKeys.selectExpiration('1d');
 await u.po.apiKeys.clickSaveButton();
 await u.po.apiKeys.waitForFormClosed();

 const responsePromise = page.waitForResponse(
 response => response.url().includes('/secret') && response.request().method() === 'GET',
 );

 // Toggle API key secret visibility
 const table = u.page.locator('.cl-apiKeysTable');
 const row = table.locator('.cl-tableRow', { hasText: apiKeyName });
 await row.waitFor({ state: 'attached' });
 await expect(row.locator('input')).toHaveAttribute('type', 'password');
 await row.locator('.cl-apiKeysRevealButton').click();

 // Verify if secret matches the input value
 const data = await (await responsePromise).json();
 await expect(row.locator('input')).toHaveAttribute('type', 'text');
 await expect(row.locator('input')).toHaveValue(data.secret);

 // Toggle visibility off
 await row.locator('.cl-apiKeysRevealButton').click();
 await expect(row.locator('input')).toHaveAttribute('type', 'password');
 });
});

59 changes: 59 additions & 0 deletions
packages/testing/src/playwright/unstable/page-objects/apiKeys.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
import type { EnhancedPage } from './app';
import { common } from './common';

export const createAPIKeysComponentPageObject = (testArgs: { page: EnhancedPage }) => {
 const { page } = testArgs;

 const expirationOptions = {
 never: 'Never',
 '1d': '1 Day',
 '7d': '7 Days',
 '30d': '30 Days',
 '60d': '60 Days',
 '90d': '90 Days',
 '180d': '180 Days',
 '1y': '1 Year',
 } as const;

 const self = {
 ...common(testArgs),
 waitForMounted: () => {
 return page.waitForSelector('.cl-apiKeys-root', { state: 'attached' });
 },
 clickAddButton: () => {
 return page.getByText(/Add new key/i).click();
 },
 waitForFormOpened: () => {
 return page.waitForSelector('.cl-apiKeysCreateForm', { state: 'attached' });
 },
 waitForFormClosed: () => {
 return page.waitForSelector('.cl-apiKeysCreateForm', { state: 'detached' });
 },
 waitForRevokeModalOpened: () => {
 return page.waitForSelector('.cl-apiKeysRevokeModal', { state: 'attached' });
 },
 waitForRevokeModalClosed: () => {
 return page.waitForSelector('.cl-apiKeysRevokeModal', { state: 'detached' });
 },
 typeName: (value: string) => {
 return page.getByLabel(/Secret key name/i).fill(value);
 },
 typeDescription: (value: string) => {
 return page.getByLabel(/Description/i).fill(value);
 },
 selectExpiration: async (value?: keyof typeof expirationOptions) => {
 await page.getByRole('button', { name: /Select date/i }).click();
 return page.getByText(expirationOptions[value ?? 'never'], { exact: true }).click();
 },
 clickSaveButton: () => {
 return page.getByText(/Create key/i).click();
 },
 typeRevokeConfirmation: (value: string) => {
 return page.getByLabel(/Type "Revoke" to confirm/i).fill(value);
 },
 clickConfirmRevokeButton: () => {
 return page.getByText(/Revoke key/i).click();
 },
 };
 return self;
};

2 changes: 2 additions & 0 deletions
packages/testing/src/playwright/unstable/page-objects/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
import type { Page } from '@playwright/test';

import { createAPIKeysComponentPageObject } from './apiKeys';
import { createAppPageObject } from './app';
import { createCheckoutPageObject } from './checkout';
import { createClerkPageObject } from './clerk';
Expand DownExpand Up@@ -46,5 +47,6 @@ export const createPageObjects = ({
 userProfile: createUserProfileComponentPageObject(testArgs),
 userVerification: createUserVerificationComponentPageObject(testArgs),
 waitlist: createWaitlistComponentPageObject(testArgs),
 apiKeys: createAPIKeysComponentPageObject(testArgs),
 };
};

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

Skip to content
chore(repo,testing): Add API keys component e2e tests#6192

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

wobsoriano
merged 9 commits into

from

Jun 25, 2025
 Merged


chore(repo,testing): Add API keys component e2e tests
#6192
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
de41798

chore: initialize api keys component test


wobsoriano Jun 25, 2025
ddbe826

Merge remote-tracking branch 'origin/main' into rob/user-2238-api-key…


wobsoriano Jun 25, 2025
b07a364

chore: introduce more tests


wobsoriano Jun 25, 2025
0abde17

Update integration/tests/machine-auth/component.test.ts


wobsoriano Jun 25, 2025
738804a

Merge branch 'main' into rob/user-2238-api-keys-e2e


wobsoriano Jun 25, 2025
45262f1

chore: add changeset


wobsoriano Jun 25, 2025
d13bf48

chore: simplify menu button click


wobsoriano Jun 25, 2025
be7ca1b

chore: remove global permission


wobsoriano Jun 25, 2025
45f8084

chore: add api key secret visibility toggling test


wobsoriano Jun 25, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
.changeset/shiny-candles-sneeze.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
"@clerk/testing": minor
---

Add API keys component testing helpers

5 changes: 5 additions & 0 deletions
integration/templates/next-app-router/src/app/api-keys/page.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
import { APIKeys } from '@clerk/nextjs';

export default function Page() {
 return <APIKeys />;
}

172 changes: 172 additions & 0 deletions
integration/tests/machine-auth/component.test.ts

View file


Open in desktop

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

import { appConfigs } from '../../presets';
import type { FakeUser } from '../../testUtils';
import { createTestUtils, testAgainstRunningApps } from '../../testUtils';

testAgainstRunningApps({ withEnv: [appConfigs.envs.withAPIKeys] })('api keys @generic', ({ app }) => {
 test.describe.configure({ mode: 'serial' });

 let fakeUser: FakeUser;

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

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

 test('can create api keys', async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });
 await u.po.signIn.goTo();
 await u.po.signIn.waitForMounted();
 await u.po.signIn.signInWithEmailAndInstantPassword({ email: fakeUser.email, password: fakeUser.password });
 await u.po.expect.toBeSignedIn();

 await u.po.page.goToRelative('/api-keys');
 await u.po.apiKeys.waitForMounted();

 // Create API key 1
 await u.po.apiKeys.clickAddButton();
 await u.po.apiKeys.waitForFormOpened();
 await u.po.apiKeys.typeName(`${fakeUser.firstName}-api-key-1`);
 await u.po.apiKeys.selectExpiration('1d');
 await u.po.apiKeys.clickSaveButton();

 await u.po.apiKeys.waitForFormClosed();

 // Create API key 2
 await u.po.apiKeys.clickAddButton();
 await u.po.apiKeys.waitForFormOpened();
 await u.po.apiKeys.typeName(`${fakeUser.firstName}-api-key-2`);
 await u.po.apiKeys.selectExpiration('7d');
 await u.po.apiKeys.clickSaveButton();

 // Check if both API keys are created
 await expect(u.page.locator('.cl-apiKeysTable .cl-tableRow')).toHaveCount(2);
 });

 test('can revoke api keys', async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });
 await u.po.signIn.goTo();
 await u.po.signIn.waitForMounted();
 await u.po.signIn.signInWithEmailAndInstantPassword({ email: fakeUser.email, password: fakeUser.password });
 await u.po.expect.toBeSignedIn();

 await u.po.page.goToRelative('/api-keys');
 await u.po.apiKeys.waitForMounted();

 const apiKeyName = `${fakeUser.firstName}-${Date.now()}`;

 // Create API key
 await u.po.apiKeys.clickAddButton();
 await u.po.apiKeys.waitForFormOpened();
 await u.po.apiKeys.typeName(apiKeyName);
 await u.po.apiKeys.selectExpiration('1d');
 await u.po.apiKeys.clickSaveButton();
 await u.po.apiKeys.waitForFormClosed();

 // Retrieve API key
 const table = u.page.locator('.cl-apiKeysTable');
 const row = table.locator('.cl-tableRow', { hasText: apiKeyName });
 await row.waitFor({ state: 'attached' });

 // Revoke API key
 await row.locator('.cl-menuButton').click();
 const revokeButton = u.page.getByRole('menuitem', { name: 'Revoke key' });
 await revokeButton.waitFor({ state: 'attached' });
 await revokeButton.click();

 // Wait for revoke modal and confirm revocation
 await u.po.apiKeys.waitForRevokeModalOpened();
 await u.po.apiKeys.typeRevokeConfirmation('Revoke');
 await u.po.apiKeys.clickConfirmRevokeButton();
 await u.po.apiKeys.waitForRevokeModalClosed();

 // Check if record is removed from the table
 await expect(table.locator('.cl-tableRow', { hasText: apiKeyName })).toHaveCount(0);
 });

 test('can copy api key secret', async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });
 await u.po.signIn.goTo();
 await u.po.signIn.waitForMounted();
 await u.po.signIn.signInWithEmailAndInstantPassword({ email: fakeUser.email, password: fakeUser.password });
 await u.po.expect.toBeSignedIn();

 await u.po.page.goToRelative('/api-keys');
 await u.po.apiKeys.waitForMounted();

 const apiKeyName = `${fakeUser.firstName}-${Date.now()}`;

 // Create API key
 await u.po.apiKeys.clickAddButton();
 await u.po.apiKeys.waitForFormOpened();
 await u.po.apiKeys.typeName(apiKeyName);
 await u.po.apiKeys.selectExpiration('1d');
 await u.po.apiKeys.clickSaveButton();
 await u.po.apiKeys.waitForFormClosed();

 const responsePromise = page.waitForResponse(
 response => response.url().includes('/secret') && response.request().method() === 'GET',
 );

 // Copy API key
 const table = u.page.locator('.cl-apiKeysTable');
 const row = table.locator('.cl-tableRow', { hasText: apiKeyName });
 await row.waitFor({ state: 'attached' });
 await row.locator('.cl-apiKeysCopyButton').click();

 // Read clipboard contents
 const data = await (await responsePromise).json();
 await context.grantPermissions(['clipboard-read']);
 const clipboardText = await page.evaluate('navigator.clipboard.readText()');
 await context.clearPermissions();
 expect(clipboardText).toBe(data.secret);
 });

 test('can toggle api key secret visibility', async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });
 await u.po.signIn.goTo();
 await u.po.signIn.waitForMounted();
 await u.po.signIn.signInWithEmailAndInstantPassword({ email: fakeUser.email, password: fakeUser.password });
 await u.po.expect.toBeSignedIn();

 await u.po.page.goToRelative('/api-keys');
 await u.po.apiKeys.waitForMounted();

 const apiKeyName = `${fakeUser.firstName}-${Date.now()}`;

 // Create API key
 await u.po.apiKeys.clickAddButton();
 await u.po.apiKeys.waitForFormOpened();
 await u.po.apiKeys.typeName(apiKeyName);
 await u.po.apiKeys.selectExpiration('1d');
 await u.po.apiKeys.clickSaveButton();
 await u.po.apiKeys.waitForFormClosed();

 const responsePromise = page.waitForResponse(
 response => response.url().includes('/secret') && response.request().method() === 'GET',
 );

 // Toggle API key secret visibility
 const table = u.page.locator('.cl-apiKeysTable');
 const row = table.locator('.cl-tableRow', { hasText: apiKeyName });
 await row.waitFor({ state: 'attached' });
 await expect(row.locator('input')).toHaveAttribute('type', 'password');
 await row.locator('.cl-apiKeysRevealButton').click();

 // Verify if secret matches the input value
 const data = await (await responsePromise).json();
 await expect(row.locator('input')).toHaveAttribute('type', 'text');
 await expect(row.locator('input')).toHaveValue(data.secret);

 // Toggle visibility off
 await row.locator('.cl-apiKeysRevealButton').click();
 await expect(row.locator('input')).toHaveAttribute('type', 'password');
 });
});

59 changes: 59 additions & 0 deletions
packages/testing/src/playwright/unstable/page-objects/apiKeys.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
import type { EnhancedPage } from './app';
import { common } from './common';

export const createAPIKeysComponentPageObject = (testArgs: { page: EnhancedPage }) => {
 const { page } = testArgs;

 const expirationOptions = {
 never: 'Never',
 '1d': '1 Day',
 '7d': '7 Days',
 '30d': '30 Days',
 '60d': '60 Days',
 '90d': '90 Days',
 '180d': '180 Days',
 '1y': '1 Year',
 } as const;

 const self = {
 ...common(testArgs),
 waitForMounted: () => {
 return page.waitForSelector('.cl-apiKeys-root', { state: 'attached' });
 },
 clickAddButton: () => {
 return page.getByText(/Add new key/i).click();
 },
 waitForFormOpened: () => {
 return page.waitForSelector('.cl-apiKeysCreateForm', { state: 'attached' });
 },
 waitForFormClosed: () => {
 return page.waitForSelector('.cl-apiKeysCreateForm', { state: 'detached' });
 },
 waitForRevokeModalOpened: () => {
 return page.waitForSelector('.cl-apiKeysRevokeModal', { state: 'attached' });
 },
 waitForRevokeModalClosed: () => {
 return page.waitForSelector('.cl-apiKeysRevokeModal', { state: 'detached' });
 },
 typeName: (value: string) => {
 return page.getByLabel(/Secret key name/i).fill(value);
 },
 typeDescription: (value: string) => {
 return page.getByLabel(/Description/i).fill(value);
 },
 selectExpiration: async (value?: keyof typeof expirationOptions) => {
 await page.getByRole('button', { name: /Select date/i }).click();
 return page.getByText(expirationOptions[value ?? 'never'], { exact: true }).click();
 },
 clickSaveButton: () => {
 return page.getByText(/Create key/i).click();
 },
 typeRevokeConfirmation: (value: string) => {
 return page.getByLabel(/Type "Revoke" to confirm/i).fill(value);
 },
 clickConfirmRevokeButton: () => {
 return page.getByText(/Revoke key/i).click();
 },
 };
 return self;
};

2 changes: 2 additions & 0 deletions
packages/testing/src/playwright/unstable/page-objects/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
import type { Page } from '@playwright/test';

import { createAPIKeysComponentPageObject } from './apiKeys';
import { createAppPageObject } from './app';
import { createCheckoutPageObject } from './checkout';
import { createClerkPageObject } from './clerk';
Expand DownExpand Up@@ -46,5 +47,6 @@ export const createPageObjects = ({
 userProfile: createUserProfileComponentPageObject(testArgs),
 userVerification: createUserVerificationComponentPageObject(testArgs),
 waitlist: createWaitlistComponentPageObject(testArgs),
 apiKeys: createAPIKeysComponentPageObject(testArgs),
 };
};