Skip to content

Commit 96ddf11

Browse files
nikospapcomnikospapcom
authored
chore(e2e): Add tests for restricted sign-up mode (#4246)
1 parent ea8cd9b commit 96ddf11

File tree

5 files changed

+158
-0
lines changed

5 files changed

+158
-0
lines changed

‎.changeset/sharp-glasses-clap.md

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
---
2+
---

‎integration/presets/envs.ts

+7
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,12 @@ const withDynamicKeys = withEmailCodes
8888
.setEnvVariable('private', 'CLERK_SECRET_KEY', '')
8989
.setEnvVariable('private', 'CLERK_DYNAMIC_SECRET_KEY', instanceKeys.get('with-email-codes').sk);
9090

91+
const withRestrictedMode = withEmailCodes
92+
.clone()
93+
.setId('withRestrictedMode')
94+
.setEnvVariable('private', 'CLERK_SECRET_KEY', instanceKeys.get('with-restricted-mode').sk)
95+
.setEnvVariable('public', 'CLERK_PUBLISHABLE_KEY', instanceKeys.get('with-restricted-mode').pk);
96+
9197
export const envs = {
9298
base,
9399
withEmailCodes,
@@ -100,4 +106,5 @@ export const envs = {
100106
withAPCore2ClerkLatest,
101107
withAPCore2ClerkV4,
102108
withDynamicKeys,
109+
withRestrictedMode,
103110
} as const;

‎integration/testUtils/index.ts

+2
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ import { expect } from '@playwright/test';
55
import type { Application } from '../models/application';
66
import { createAppPageObject } from './appPageObject';
77
import { createEmailService } from './emailService';
8+
import { createInvitationService } from './invitationsService';
89
import { createOrganizationSwitcherComponentPageObject } from './organizationSwitcherPageObject';
910
import type { EnchancedPage, TestArgs } from './signInPageObject';
1011
import { createSignInComponentPageObject } from './signInPageObject';
@@ -73,6 +74,7 @@ export const createTestUtils = <
7374
const services = {
7475
email: createEmailService(),
7576
users: createUserService(clerkClient),
77+
invitations: createInvitationService(clerkClient),
7678
clerk: clerkClient,
7779
};
7880

‎integration/testUtils/invitationsService.ts

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
import type { ClerkClient, Invitation } from '@clerk/backend';
2+
3+
export type InvitationService = {
4+
createBapiInvitation: (emailAddress: string) => Promise<Invitation>;
5+
};
6+
export const createInvitationService = (clerkClient: ClerkClient) => {
7+
const self: InvitationService = {
8+
createBapiInvitation: async emailAddress => {
9+
return await clerkClient.invitations.createInvitation({
10+
emailAddress,
11+
});
12+
},
13+
};
14+
15+
return self;
16+
};

‎integration/tests/restricted-mode.test.ts

+131
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,131 @@
1+
import { expect, test } from '@playwright/test';
2+
3+
import type { Application } from '../models/application';
4+
import { appConfigs } from '../presets';
5+
import type { FakeUser } from '../testUtils';
6+
import { createTestUtils } from '../testUtils';
7+
8+
test.describe('Sign-up restricted mode', () => {
9+
test.describe.configure({ mode: 'serial' });
10+
let app: Application;
11+
let fakeUser: FakeUser;
12+
13+
test.beforeAll(async () => {
14+
app = await appConfigs.next.appRouter
15+
.clone()
16+
.addFile(
17+
'src/app/provider.tsx',
18+
() => `'use client'
19+
import { ClerkProvider } from "@clerk/nextjs";
20+
21+
export function Provider({ children }: { children: any }) {
22+
return (
23+
<ClerkProvider>
24+
{children}
25+
</ClerkProvider>
26+
)
27+
}`,
28+
)
29+
.addFile(
30+
'src/app/layout.tsx',
31+
() => `import './globals.css';
32+
import { Inter } from 'next/font/google';
33+
import { Provider } from './provider';
34+
35+
const inter = Inter({ subsets: ['latin'] });
36+
37+
export const metadata = {
38+
title: 'Create Next App',
39+
description: 'Generated by create next app',
40+
};
41+
42+
export default function RootLayout({ children }: { children: React.ReactNode }) {
43+
return (
44+
<Provider>
45+
<html lang='en'>
46+
<body className={inter.className}>{children}</body>
47+
</html>
48+
</Provider>
49+
);
50+
}`,
51+
)
52+
.addFile(
53+
'src/app/hash/user/page.tsx',
54+
() => `
55+
import { UserProfile, UserButton } from '@clerk/nextjs';
56+
57+
export default function Page() {
58+
return (
59+
<div>
60+
<UserButton />
61+
<UserProfile routing="hash" />
62+
</div>
63+
);
64+
}`,
65+
)
66+
.commit();
67+
await app.setup();
68+
await app.withEnv(appConfigs.envs.withRestrictedMode);
69+
await app.dev();
70+
71+
const m = createTestUtils({ app });
72+
fakeUser = m.services.users.createFakeUser({
73+
withUsername: true,
74+
fictionalEmail: true,
75+
withPhoneNumber: true,
76+
});
77+
await m.services.users.createBapiUser({
78+
...fakeUser,
79+
username: undefined,
80+
phoneNumber: undefined,
81+
});
82+
});
83+
84+
test.afterAll(async () => {
85+
await fakeUser.deleteIfExists();
86+
await app.teardown();
87+
});
88+
89+
test('Existing user signs in succesfull', async ({ page, context }) => {
90+
const u = createTestUtils({ app, page, context });
91+
await u.po.signIn.goTo();
92+
await u.po.signIn.waitForMounted();
93+
await u.po.signIn.signInWithEmailAndInstantPassword({ email: fakeUser.email, password: fakeUser.password });
94+
await u.po.expect.toBeSignedIn();
95+
96+
await u.po.userProfile.goTo();
97+
await u.po.userProfile.waitForMounted();
98+
});
99+
100+
test('Sign up page return restricted and click Back to sign in', async ({ page, context }) => {
101+
const u = createTestUtils({ app, page, context });
102+
await u.po.signUp.goTo();
103+
await u.po.signUp.waitForMounted();
104+
105+
await expect(u.page.getByText(/Restricted access/i).first()).toBeVisible();
106+
const backToSignIn = u.page.getByRole('link', { name: /Back to sign in/i });
107+
await backToSignIn.click();
108+
109+
await u.po.signUp.waitForMounted();
110+
await u.page.waitForAppUrl('/sign-up');
111+
});
112+
113+
test('Sign up page with invitation render correctly and sign up', async ({ page, context }) => {
114+
const u = createTestUtils({ app, page, context });
115+
const invitedUser = u.services.users.createFakeUser();
116+
117+
const invitation = await u.services.invitations.createBapiInvitation(invitedUser.email);
118+
119+
await u.page.goto(invitation.url);
120+
await u.po.signUp.waitForMounted();
121+
await expect(u.page.getByText(/Create your account/i).first()).toBeVisible();
122+
123+
await u.po.signUp.signUp({
124+
password: invitedUser.password,
125+
});
126+
127+
await u.po.expect.toBeSignedIn();
128+
129+
await invitedUser.deleteIfExists();
130+
});
131+
});

0 commit comments

Comments
 (0)