|
| 1 | +import type { BrowserContext } from '@playwright/test'; |
| 2 | +import { expect, test } from '@playwright/test'; |
| 3 | + |
| 4 | +import { appConfigs } from '../presets'; |
| 5 | +import type { FakeUser } from '../testUtils'; |
| 6 | +import { createTestUtils, testAgainstRunningApps } from '../testUtils'; |
| 7 | + |
| 8 | +const ORIGIN_OUTAGE_MODE_OPT_IN_HEADER = 'X-Clerk-Origin-Outage-Mode-Opt-In'; |
| 9 | + |
| 10 | +const OPT_IN_HEADER_SECRET = process.env.ORIGIN_OUTAGE_MODE_OPT_IN_SECRET; |
| 11 | + |
| 12 | +function isEdgeGeneratedToken(token: string): boolean { |
| 13 | + const payload = JSON.parse(Buffer.from(token.split('.')[1], 'base64').toString()); |
| 14 | + return payload._cs === 'e'; |
| 15 | +} |
| 16 | + |
| 17 | +/** |
| 18 | + * Clear cookies to trigger handshake flow. |
| 19 | + * |
| 20 | + * In DEVELOPMENT mode (pk_test_* keys), we need to clear: |
| 21 | + * - __client_uat, __client_uat_{suffix} |
| 22 | + * - __refresh_{suffix} |
| 23 | + * |
| 24 | + * In PRODUCTION mode, we would clear: |
| 25 | + * - __client_uat, __client_uat_{suffix} |
| 26 | + * - __session, __session_{suffix} |
| 27 | + * - __refresh_{suffix} |
| 28 | + * |
| 29 | + * Since integration tests run against dev instances, we use the dev mode approach. |
| 30 | + */ |
| 31 | +async function clearCookiesForHandshake(context: BrowserContext): Promise<void> { |
| 32 | + const cookies = await context.cookies(); |
| 33 | + let suffix = null; |
| 34 | + |
| 35 | + ['__client_uat', '__refresh', '__session'].forEach(cookieName => { |
| 36 | + const cookie = cookies.find(cookie => cookie.name === cookieName); |
| 37 | + if (cookie) { |
| 38 | + suffix = cookie.name.match(new RegExp(`^${cookieName}_(.+)$`))?.[1] || null; |
| 39 | + } |
| 40 | + }); |
| 41 | + |
| 42 | + await context.clearCookies({ name: '__client_uat' }); |
| 43 | + |
| 44 | + if (suffix) { |
| 45 | + await context.clearCookies({ name: `__client_uat_${suffix}` }); |
| 46 | + await context.clearCookies({ name: `__refresh_${suffix}` }); |
| 47 | + } |
| 48 | +} |
| 49 | + |
| 50 | +testAgainstRunningApps({ |
| 51 | + withEnv: [appConfigs.envs.withOutageMode], |
| 52 | +})('Handshake Flow (Outage Mode) @outage-mode', ({ app }) => { |
| 53 | + test.describe.configure({ mode: 'parallel' }); |
| 54 | + |
| 55 | + let fakeUser: FakeUser; |
| 56 | + |
| 57 | + test.beforeAll(async () => { |
| 58 | + const u = createTestUtils({ app }); |
| 59 | + fakeUser = u.services.users.createFakeUser({ |
| 60 | + fictionalEmail: true, |
| 61 | + withPassword: true, |
| 62 | + }); |
| 63 | + await u.services.users.createBapiUser(fakeUser); |
| 64 | + }); |
| 65 | + |
| 66 | + test.afterAll(async () => { |
| 67 | + await fakeUser?.deleteIfExists(); |
| 68 | + }); |
| 69 | + |
| 70 | + test('handshake: should recover session via origin in normal mode', async ({ page, context }) => { |
| 71 | + const u = createTestUtils({ app, page, context }); |
| 72 | + |
| 73 | + await u.po.signIn.goTo(); |
| 74 | + await u.po.signIn.signInWithEmailAndInstantPassword({ |
| 75 | + email: fakeUser.email, |
| 76 | + password: fakeUser.password, |
| 77 | + }); |
| 78 | + await u.po.expect.toBeSignedIn(); |
| 79 | + |
| 80 | + const initialSessionId = await page.evaluate(() => { |
| 81 | + return (window as any).Clerk?.session?.id; |
| 82 | + }); |
| 83 | + |
| 84 | + await clearCookiesForHandshake(context); |
| 85 | + await u.page.goToAppHome(); |
| 86 | + await u.page.waitForClerkJsLoaded(); |
| 87 | + |
| 88 | + const sessionToken = await page.evaluate(() => { |
| 89 | + return (window as any).Clerk?.session?.lastActiveToken?.getRawString(); |
| 90 | + }); |
| 91 | + |
| 92 | + const sessionId = await page.evaluate(() => { |
| 93 | + return (window as any).Clerk?.session?.id; |
| 94 | + }); |
| 95 | + |
| 96 | + await u.po.expect.toBeSignedIn(); |
| 97 | + expect(sessionToken).toBeTruthy(); |
| 98 | + expect(isEdgeGeneratedToken(sessionToken as string)).toBe(false); |
| 99 | + expect(sessionId).toBe(initialSessionId); |
| 100 | + }); |
| 101 | + |
| 102 | + test('handshake: should recover session via proxy with opt-in header', async ({ page, context }) => { |
| 103 | + const u = createTestUtils({ app, page, context }); |
| 104 | + |
| 105 | + await u.po.signIn.goTo(); |
| 106 | + await u.po.signIn.signInWithEmailAndInstantPassword({ |
| 107 | + email: fakeUser.email, |
| 108 | + password: fakeUser.password, |
| 109 | + }); |
| 110 | + await u.po.expect.toBeSignedIn(); |
| 111 | + |
| 112 | + const initialSessionId = await page.evaluate(() => { |
| 113 | + return (window as any).Clerk?.session?.id; |
| 114 | + }); |
| 115 | + |
| 116 | + await clearCookiesForHandshake(context); |
| 117 | + |
| 118 | + await page.route('**/*', async (route, request) => { |
| 119 | + const headers = { |
| 120 | + ...request.headers(), |
| 121 | + [ORIGIN_OUTAGE_MODE_OPT_IN_HEADER]: OPT_IN_HEADER_SECRET, |
| 122 | + }; |
| 123 | + await route.continue({ headers }); |
| 124 | + }); |
| 125 | + |
| 126 | + await u.page.goToAppHome(); |
| 127 | + await u.page.waitForClerkJsLoaded(); |
| 128 | + |
| 129 | + await page.unroute('**/*'); |
| 130 | + |
| 131 | + const sessionToken = await page.evaluate(() => { |
| 132 | + return (window as any).Clerk?.session?.lastActiveToken?.getRawString(); |
| 133 | + }); |
| 134 | + |
| 135 | + const sessionId = await page.evaluate(() => { |
| 136 | + return (window as any).Clerk?.session?.id; |
| 137 | + }); |
| 138 | + |
| 139 | + await u.po.expect.toBeSignedIn(); |
| 140 | + expect(sessionToken).toBeTruthy(); |
| 141 | + expect(isEdgeGeneratedToken(sessionToken as string)).toBe(true); |
| 142 | + expect(sessionId).toBe(initialSessionId); |
| 143 | + }); |
| 144 | +}); |
0 commit comments