Files
payload/test/server-functions/e2e.spec.ts
Jessica Chowdhury 6b349378e0 feat: adds and exports reusable auth server functions (#11900)
### What
Adds exportable server functions for `login`, `logout` and `refresh`
that are fully typed and ready to use.

### Why
Creating server functions for these auth operations require the
developer to manually set and handle the cookies / auth JWT. This can be
a complex and involved process - instead we want to provide an option
that will handle the cookies internally and simplify the process for the
user.

### How
Three re-usable functions can be exported from
`@payload/next/server-functions`:
- login
- logout
- refresh

Examples of how to use these functions will be added to the docs
shortly, along with more in-depth info on server functions.
2025-04-14 09:47:08 +01:00

98 lines
3.3 KiB
TypeScript

import type { Page } from '@playwright/test'
import { expect, test } from '@playwright/test'
import { devUser } from 'credentials.js'
import path from 'path'
import { fileURLToPath } from 'url'
import type { PayloadTestSDK } from '../helpers/sdk/index.js'
import type { Config } from './payload-types.js'
import { ensureCompilationIsDone, initPageConsoleErrorCatch } from '../helpers.js'
import { AdminUrlUtil } from '../helpers/adminUrlUtil.js'
import { initPayloadE2ENoConfig } from '../helpers/initPayloadE2ENoConfig.js'
import { TEST_TIMEOUT_LONG } from '../playwright.config.js'
const filename = fileURLToPath(import.meta.url)
const dirname = path.dirname(filename)
let payload: PayloadTestSDK<Config>
const { beforeAll, describe } = test
describe('Server Functions', () => {
let page: Page
let url: AdminUrlUtil
let serverURL: string
beforeAll(async ({ browser }, testInfo) => {
testInfo.setTimeout(TEST_TIMEOUT_LONG)
;({ payload, serverURL } = await initPayloadE2ENoConfig<Config>({ dirname }))
url = new AdminUrlUtil(serverURL, 'users')
const context = await browser.newContext()
page = await context.newPage()
initPageConsoleErrorCatch(page)
await ensureCompilationIsDone({
page,
serverURL,
noAutoLogin: true,
})
})
describe('Auth functions', () => {
test('should log user in from login server function', async () => {
await page.goto(`${serverURL}/admin`)
// Expect email and password fields to be visible
await expect(page.locator('#email')).toBeVisible()
await expect(page.locator('#password')).toBeVisible()
await page.fill('#email', devUser.email)
await page.fill('#password', devUser.password)
const loginButton = page.locator('text=Custom Login')
await expect(loginButton).toBeVisible()
await loginButton.click()
await page.waitForTimeout(1000)
await page.reload()
await page.goto(`${serverURL}/admin/account`)
await expect(page.locator('h1[title="dev@payloadcms.com"]')).toBeVisible()
})
test('should refresh user from refresh server function', async () => {
await page.goto(`${serverURL}/admin`)
const initialCookie = await page.context().cookies()
const payloadToken = initialCookie.find((cookie) => cookie.name === 'payload-token')
expect(payloadToken).toBeDefined()
const initialExpiry = payloadToken?.expires
const refreshButton = page.locator('text=Custom Refresh')
await expect(refreshButton).toBeVisible()
await refreshButton.click()
await page.waitForTimeout(1000)
const updatedCookie = await page.context().cookies()
const updatedPayloadToken = updatedCookie.find((cookie) => cookie.name === 'payload-token')
expect(updatedPayloadToken).toBeDefined()
expect(updatedPayloadToken?.expires).not.toBe(initialExpiry)
})
test('should log user out from logout server function', async () => {
await page.goto(`${serverURL}/admin`)
const logoutButton = page.locator('text=Custom Logout')
await expect(logoutButton).toBeVisible()
await logoutButton.click()
await page.waitForTimeout(1000)
await page.reload()
await page.goto(`${serverURL}/admin`)
await expect(page.locator('#email')).toBeVisible()
await expect(page.locator('#password')).toBeVisible()
})
})
})