Files
payloadcms/test/fields/e2e.spec.ts
2024-04-09 09:34:11 -04:00

1377 lines
51 KiB
TypeScript

import type { Page } from '@playwright/test'
import { expect, test } from '@playwright/test'
import path from 'path'
import { wait } from 'payload/utilities'
import { fileURLToPath } from 'url'
import type { PayloadTestSDK } from '../helpers/sdk/index.js'
import type { Config, RelationshipField, TextField } from './payload-types.js'
import {
ensureAutoLoginAndCompilationIsDone,
exactText,
initPageConsoleErrorCatch,
saveDocAndAssert,
saveDocHotkeyAndAssert,
} from '../helpers.js'
import { AdminUrlUtil } from '../helpers/adminUrlUtil.js'
import { initPayloadE2ENoConfig } from '../helpers/initPayloadE2ENoConfig.js'
import { reInitializeDB } from '../helpers/reInit.js'
import { RESTClient } from '../helpers/rest.js'
import { POLL_TOPASS_TIMEOUT } from '../playwright.config.js'
import { jsonDoc } from './collections/JSON/shared.js'
import { numberDoc } from './collections/Number/shared.js'
import { textDoc } from './collections/Text/shared.js'
import {
collapsibleFieldsSlug,
pointFieldsSlug,
relationshipFieldsSlug,
tabsFieldsSlug,
textFieldsSlug,
} from './slugs.js'
const filename = fileURLToPath(import.meta.url)
const dirname = path.dirname(filename)
const { beforeAll, beforeEach, describe } = test
let payload: PayloadTestSDK<Config>
let client: RESTClient
let page: Page
let serverURL: string
// If we want to make this run in parallel: test.describe.configure({ mode: 'parallel' })
describe('fields', () => {
beforeAll(async ({ browser }, testInfo) => {
// const prebuild = Boolean(process.env.CI)
// if (prebuild) testInfo.setTimeout(testInfo.timeout * 3)
process.env.SEED_IN_CONFIG_ONINIT = 'false' // Makes it so the payload config onInit seed is not run. Otherwise, the seed would be run unnecessarily twice for the initial test run - once for beforeEach and once for onInit
;({ payload, serverURL } = await initPayloadE2ENoConfig({
dirname,
// prebuild,
}))
const context = await browser.newContext()
page = await context.newPage()
initPageConsoleErrorCatch(page)
})
beforeEach(async () => {
await reInitializeDB({
serverURL,
snapshotKey: 'fieldsTest',
uploadsDir: path.resolve(dirname, './collections/Upload/uploads'),
})
if (client) {
await client.logout()
}
client = new RESTClient(null, { defaultSlug: 'users', serverURL })
await client.login()
await ensureAutoLoginAndCompilationIsDone({ page, serverURL })
})
describe('text', () => {
let url: AdminUrlUtil
beforeAll(() => {
url = new AdminUrlUtil(serverURL, textFieldsSlug)
})
test('should display field in list view', async () => {
await page.goto(url.list)
const textCell = page.locator('.row-1 .cell-text')
await expect(textCell).toHaveText(textDoc.text)
})
test('should display i18n label in cells when missing field data', async () => {
await page.goto(url.list)
const textCell = page.locator('.row-1 .cell-i18nText')
await expect(textCell).toHaveText('<No Text en>')
})
test('should show i18n label', async () => {
await page.goto(url.create)
await expect(page.locator('label[for="field-i18nText"]')).toHaveText('Text en')
})
test('should show i18n placeholder', async () => {
await page.goto(url.create)
await expect(page.locator('#field-i18nText')).toHaveAttribute('placeholder', 'en placeholder')
})
test('should show i18n descriptions', async () => {
await page.goto(url.create)
const description = page.locator('.field-description-i18nText')
await expect(description).toHaveText('en description')
})
test('should render custom label', async () => {
await page.goto(url.create)
const label = page.locator('label.custom-label[for="field-customLabel"]')
await expect(label).toHaveText('#label')
})
test('should render custom error', async () => {
await page.goto(url.create)
const input = page.locator('input[id="field-customError"]')
await input.fill('ab')
await expect(input).toHaveValue('ab')
const error = page.locator('.custom-error:near(input[id="field-customError"])')
const submit = page.locator('button[type="button"][id="action-save"]')
await submit.click()
await expect(error).toHaveText('#custom-error')
})
test('should render beforeInput and afterInput', async () => {
await page.goto(url.create)
const input = page.locator('input[id="field-beforeAndAfterInput"]')
const prevSibling = await input.evaluateHandle((el) => {
return el.previousElementSibling
})
const prevSiblingText = await page.evaluate((el) => el.textContent, prevSibling)
expect(prevSiblingText).toEqual('#before-input')
const nextSibling = await input.evaluateHandle((el) => {
return el.nextElementSibling
})
const nextSiblingText = await page.evaluate((el) => el.textContent, nextSibling)
expect(nextSiblingText).toEqual('#after-input')
})
test('should create hasMany with multiple texts', async () => {
const input = 'five'
const furtherInput = 'six'
await page.goto(url.create)
const requiredField = page.locator('#field-text')
const field = page.locator('.field-hasMany')
await requiredField.fill(String(input))
await field.click()
await page.keyboard.type(input)
await page.keyboard.press('Enter')
await page.keyboard.type(furtherInput)
await page.keyboard.press('Enter')
await saveDocAndAssert(page)
await expect(field.locator('.rs__value-container')).toContainText(input)
await expect(field.locator('.rs__value-container')).toContainText(furtherInput)
})
})
describe('number', () => {
let url: AdminUrlUtil
beforeAll(() => {
url = new AdminUrlUtil(serverURL, 'number-fields')
})
test('should display field in list view', async () => {
await page.goto(url.list)
const textCell = page.locator('.row-1 .cell-number')
await expect(textCell).toHaveText(String(numberDoc.number))
})
test('should filter Number fields in the collection view - greaterThanOrEqual', async () => {
await page.goto(url.list)
// should have 3 entries
await expect(page.locator('table >> tbody >> tr')).toHaveCount(3)
// open the filter options
await page.locator('.list-controls__toggle-where').click()
await expect(page.locator('.list-controls__where.rah-static--height-auto')).toBeVisible()
await page.locator('.where-builder__add-first-filter').click()
const initialField = page.locator('.condition__field')
const operatorField = page.locator('.condition__operator')
const valueField = page.locator('.condition__value >> input')
// select Number field to filter on
await initialField.click()
const initialFieldOptions = initialField.locator('.rs__option')
await initialFieldOptions.locator('text=number').first().click()
await expect(initialField.locator('.rs__single-value')).toContainText('Number')
// select >= operator
await operatorField.click()
const operatorOptions = operatorField.locator('.rs__option')
await operatorOptions.last().click()
await expect(operatorField.locator('.rs__single-value')).toContainText(
'is greater than or equal to',
)
// enter value of 3
await valueField.fill('3')
await expect(valueField).toHaveValue('3')
await wait(300)
// should have 2 entries after filtering
await expect(page.locator('table >> tbody >> tr')).toHaveCount(2)
})
test('should create', async () => {
const input = 5
await page.goto(url.create)
const field = page.locator('#field-number')
await field.fill(String(input))
await saveDocAndAssert(page)
await expect(field).toHaveValue(String(input))
})
test('should create hasMany', async () => {
const input = 5
await page.goto(url.create)
const field = page.locator('.field-hasMany')
await field.click()
await page.keyboard.type(String(input))
await page.keyboard.press('Enter')
await saveDocAndAssert(page)
await expect(field.locator('.rs__value-container')).toContainText(String(input))
})
test('should bypass min rows validation when no rows present and field is not required', async () => {
await page.goto(url.create)
await saveDocAndAssert(page)
await expect(page.locator('.Toastify')).toContainText('successfully')
})
test('should fail min rows validation when rows are present', async () => {
const input = 5
await page.goto(url.create)
await page.locator('.field-withMinRows').click()
await page.keyboard.type(String(input))
await page.keyboard.press('Enter')
await page.click('#action-save', { delay: 100 })
await expect(page.locator('.Toastify')).toContainText(
'The following field is invalid: withMinRows',
)
})
})
describe('indexed', () => {
let url: AdminUrlUtil
beforeEach(() => {
url = new AdminUrlUtil(serverURL, 'indexed-fields')
})
// TODO - This test is flaky. Rarely, but sometimes it randomly fails.
test('should display unique constraint error in ui', async () => {
const uniqueText = 'uniqueText'
await payload.create({
collection: 'indexed-fields',
data: {
group: {
unique: uniqueText,
},
text: 'text',
uniqueRequiredText: 'text',
uniqueText,
},
})
await page.goto(url.create)
await page.waitForURL(url.create)
await page.locator('#field-text').fill('test')
await page.locator('#field-uniqueText').fill(uniqueText)
await page.locator('#field-localizedUniqueRequiredText').fill('localizedUniqueRequired2')
// attempt to save
await page.click('#action-save', { delay: 200 })
// toast error
await expect(page.locator('.Toastify')).toContainText(
'The following field is invalid: uniqueText',
)
await expect.poll(() => page.url(), { timeout: POLL_TOPASS_TIMEOUT }).toContain('create')
// field specific error
await expect(page.locator('.field-type.text.error #field-uniqueText')).toBeVisible()
// reset first unique field
await page.locator('#field-uniqueText').clear()
// nested in a group error
await page.locator('#field-group__unique').fill(uniqueText)
// attempt to save
await page.locator('#action-save').click()
// toast error
await expect(page.locator('.Toastify')).toContainText(
'The following field is invalid: group.unique',
)
await expect.poll(() => page.url(), { timeout: POLL_TOPASS_TIMEOUT }).toContain('create')
// field specific error inside group
await expect(page.locator('.field-type.text.error #field-group__unique')).toBeVisible()
})
})
describe('json', () => {
let url: AdminUrlUtil
beforeAll(() => {
url = new AdminUrlUtil(serverURL, 'json-fields')
})
test('should display field in list view', async () => {
await page.goto(url.list)
const jsonCell = page.locator('.row-1 .cell-json')
await expect(jsonCell).toHaveText(JSON.stringify(jsonDoc.json))
})
test('should create', async () => {
const input = '{"foo": "bar"}'
await page.goto(url.create)
const json = page.locator('.json-field .inputarea')
await json.fill(input)
await saveDocAndAssert(page, '.form-submit button')
await expect(page.locator('.json-field')).toContainText('"foo": "bar"')
})
})
describe('radio', () => {
let url: AdminUrlUtil
beforeAll(() => {
url = new AdminUrlUtil(serverURL, 'radio-fields')
})
test('should show i18n label in list', async () => {
await page.goto(url.list)
await expect(page.locator('.cell-radio')).toHaveText('Value One')
})
test('should show i18n label while editing', async () => {
await page.goto(url.create)
await expect(page.locator('label[for="field-radio"]')).toHaveText('Radio en')
})
test('should show i18n radio labels', async () => {
await page.goto(url.create)
await expect(page.locator('label[for="field-radio-one"] .radio-input__label')).toHaveText(
'Value One',
)
})
})
describe('select', () => {
let url: AdminUrlUtil
beforeAll(() => {
url = new AdminUrlUtil(serverURL, 'select-fields')
})
test('should use i18n option labels', async () => {
await page.goto(url.create)
const field = page.locator('#field-selectI18n')
await field.click({ delay: 100 })
const options = page.locator('.rs__option')
// Select an option
await options.locator('text=One').click()
await saveDocAndAssert(page)
await expect(field.locator('.rs__value-container')).toContainText('One')
})
})
describe('point', () => {
let url: AdminUrlUtil
let filledGroupPoint
let emptyGroupPoint
beforeEach(async () => {
url = new AdminUrlUtil(serverURL, pointFieldsSlug)
filledGroupPoint = await payload.create({
collection: pointFieldsSlug,
data: {
group: { point: [4, 2] },
localized: [4, 2],
point: [5, 5],
},
})
emptyGroupPoint = await payload.create({
collection: pointFieldsSlug,
data: {
group: {},
localized: [3, -2],
point: [5, 5],
},
})
})
test('should save point', async () => {
await page.goto(url.create)
const longField = page.locator('#field-longitude-point')
await longField.fill('9')
const latField = page.locator('#field-latitude-point')
await latField.fill('-2')
const localizedLongField = page.locator('#field-longitude-localized')
await localizedLongField.fill('1')
const localizedLatField = page.locator('#field-latitude-localized')
await localizedLatField.fill('-1')
const groupLongitude = page.locator('#field-longitude-group__point')
await groupLongitude.fill('3')
const groupLatField = page.locator('#field-latitude-group__point')
await groupLatField.fill('-8')
await saveDocAndAssert(page)
await expect(longField).toHaveAttribute('value', '9')
await expect(latField).toHaveAttribute('value', '-2')
await expect(localizedLongField).toHaveAttribute('value', '1')
await expect(localizedLatField).toHaveAttribute('value', '-1')
await expect(groupLongitude).toHaveAttribute('value', '3')
await expect(groupLatField).toHaveAttribute('value', '-8')
})
test('should update point', async () => {
await page.goto(url.edit(emptyGroupPoint.id))
await page.waitForURL(`**/${emptyGroupPoint.id}`)
const longField = page.locator('#field-longitude-point')
await longField.fill('9')
const latField = page.locator('#field-latitude-point')
await latField.fill('-2')
const localizedLongField = page.locator('#field-longitude-localized')
await localizedLongField.fill('2')
const localizedLatField = page.locator('#field-latitude-localized')
await localizedLatField.fill('-2')
const groupLongitude = page.locator('#field-longitude-group__point')
await groupLongitude.fill('3')
const groupLatField = page.locator('#field-latitude-group__point')
await groupLatField.fill('-8')
await saveDocAndAssert(page)
await expect(longField).toHaveAttribute('value', '9')
await expect(latField).toHaveAttribute('value', '-2')
await expect(localizedLongField).toHaveAttribute('value', '2')
await expect(localizedLatField).toHaveAttribute('value', '-2')
await expect(groupLongitude).toHaveAttribute('value', '3')
await expect(groupLatField).toHaveAttribute('value', '-8')
})
test('should be able to clear a value point', async () => {
await page.goto(url.edit(filledGroupPoint.id))
await page.waitForURL(`**/${filledGroupPoint.id}`)
const groupLongitude = page.locator('#field-longitude-group__point')
await groupLongitude.fill('')
const groupLatField = page.locator('#field-latitude-group__point')
await groupLatField.fill('')
await saveDocAndAssert(page)
await expect(groupLongitude).toHaveAttribute('value', '')
await expect(groupLatField).toHaveAttribute('value', '')
})
})
describe('collapsible', () => {
let url: AdminUrlUtil
beforeAll(() => {
url = new AdminUrlUtil(serverURL, collapsibleFieldsSlug)
})
test('should render collapsible as collapsed if initCollapsed is true', async () => {
await page.goto(url.create)
const collapsedCollapsible = page.locator(
'#field-collapsible-1 .collapsible__toggle--collapsed',
)
await expect(collapsedCollapsible).toBeVisible()
})
test('should render CollapsibleLabel using a function', async () => {
const label = 'custom row label'
await page.goto(url.create)
await page.locator('#field-collapsible-3__1 #field-nestedTitle').fill(label)
await wait(100)
const customCollapsibleLabel = page.locator(
`#field-collapsible-3__1 .collapsible-field__row-label-wrap :text("${label}")`,
)
await expect(customCollapsibleLabel).toContainText(label)
})
test('should render CollapsibleLabel using a component', async () => {
const label = 'custom row label as component'
await page.goto(url.create)
await page.locator('#field-arrayWithCollapsibles').scrollIntoViewIfNeeded()
const arrayWithCollapsibles = page.locator('#field-arrayWithCollapsibles')
await expect(arrayWithCollapsibles).toBeVisible()
await page.locator('#field-arrayWithCollapsibles >> .array-field__add-row').click()
await page
.locator(
'#arrayWithCollapsibles-row-0 #field-collapsible-4__0-arrayWithCollapsibles__0 #field-arrayWithCollapsibles__0__innerCollapsible',
)
.fill(label)
await wait(100)
const customCollapsibleLabel = page.locator(
`#field-arrayWithCollapsibles >> #arrayWithCollapsibles-row-0 >> .collapsible-field__row-label-wrap :text("${label}")`,
)
await expect(customCollapsibleLabel).toHaveCSS('text-transform', 'uppercase')
})
})
describe('tabs', () => {
let url: AdminUrlUtil
beforeAll(() => {
url = new AdminUrlUtil(serverURL, tabsFieldsSlug)
})
test('should fill and retain a new value within a tab while switching tabs', async () => {
const textInRowValue = 'hello'
const numberInRowValue = '23'
const jsonValue = '{ "foo": "bar"}'
await page.goto(url.create)
await wait(300)
await page.locator('.tabs-field__tab-button:has-text("Tab with Row")').click()
await page.locator('#field-textInRow').fill(textInRowValue)
await page.locator('#field-numberInRow').fill(numberInRowValue)
await page.locator('.json-field .inputarea').fill(jsonValue)
await wait(300)
await page.locator('.tabs-field__tab-button:has-text("Tab with Array")').click()
await page.locator('.tabs-field__tab-button:has-text("Tab with Row")').click()
await wait(100)
await expect(page.locator('#field-textInRow')).toHaveValue(textInRowValue)
await expect(page.locator('#field-numberInRow')).toHaveValue(numberInRowValue)
await expect(page.locator('.json-field .lines-content')).toContainText(jsonValue)
})
test('should retain updated values within tabs while switching between tabs', async () => {
const textInRowValue = 'new value'
const jsonValue = '{ "new": "value"}'
await page.goto(url.list)
await page.locator('.cell-id a').click()
await wait(300)
// Go to Row tab, update the value
await page.locator('.tabs-field__tab-button:has-text("Tab with Row")').click()
await page.locator('#field-textInRow').fill(textInRowValue)
await page.locator('.json-field .inputarea').fill(jsonValue)
await wait(250)
// Go to Array tab, then back to Row. Make sure new value is still there
await page.locator('.tabs-field__tab-button:has-text("Tab with Array")').click()
await page.locator('.tabs-field__tab-button:has-text("Tab with Row")').click()
await expect(page.locator('#field-textInRow')).toHaveValue(textInRowValue)
await expect(page.locator('.json-field .lines-content')).toContainText(jsonValue)
// Go to array tab, save the doc
await page.locator('.tabs-field__tab-button:has-text("Tab with Array")').click()
await page.click('#action-save', { delay: 100 })
await wait(250)
// Go back to row tab, make sure the new value is still present
await page.locator('.tabs-field__tab-button:has-text("Tab with Row")').click()
await expect(page.locator('#field-textInRow')).toHaveValue(textInRowValue)
})
test('should render array data within unnamed tabs', async () => {
await page.goto(url.list)
await page.locator('.cell-id a').click()
await page.locator('.tabs-field__tab-button:has-text("Tab with Array")').click()
await expect(page.locator('#field-array__0__text')).toHaveValue("Hello, I'm the first row")
})
test('should render array data within named tabs', async () => {
await page.goto(url.list)
await page.locator('.cell-id a').click()
await page.locator('.tabs-field__tab-button:nth-child(5)').click()
await expect(page.locator('#field-tab__array__0__text')).toHaveValue(
"Hello, I'm the first row, in a named tab",
)
})
})
describe('richText', () => {
async function navigateToRichTextFields() {
const url: AdminUrlUtil = new AdminUrlUtil(serverURL, 'rich-text-fields')
await page.goto(url.list)
await page.waitForURL(url.list)
await page.locator('.row-1 .cell-title a').click()
}
describe('cell', () => {
test('ensure cells are smaller than 300px in height', async () => {
const url: AdminUrlUtil = new AdminUrlUtil(serverURL, 'rich-text-fields')
await page.goto(url.list) // Navigate to rich-text list view
const table = page.locator('.list-controls ~ .table')
const lexicalCell = table.locator('.cell-lexicalCustomFields').first()
const lexicalHtmlCell = table.locator('.cell-lexicalCustomFields_html').first()
const entireRow = table.locator('.row-1').first()
// Make sure each of the 3 above are no larger than 300px in height:
expect((await lexicalCell.boundingBox()).height).toBeLessThanOrEqual(300)
expect((await lexicalHtmlCell.boundingBox()).height).toBeLessThanOrEqual(300)
expect((await entireRow.boundingBox()).height).toBeLessThanOrEqual(300)
})
})
describe('toolbar', () => {
test('should run url validation', async () => {
await navigateToRichTextFields()
// Open link drawer
await page.locator('.rich-text__toolbar button:not([disabled]) .link').first().click()
// find the drawer
const editLinkModal = page.locator('[id^=drawer_1_rich-text-link-]')
await expect(editLinkModal).toBeVisible()
// Fill values and click Confirm
await editLinkModal.locator('#field-text').fill('link text')
await editLinkModal.locator('label[for="field-linkType-custom"]').click()
await editLinkModal.locator('#field-url').fill('')
await wait(200)
await editLinkModal.locator('button[type="submit"]').click()
await wait(400)
const errorField = page.locator(
'[id^=drawer_1_rich-text-link-] .render-fields > :nth-child(3)',
)
const hasErrorClass = await errorField.evaluate((el) => el.classList.contains('error'))
expect(hasErrorClass).toBe(true)
})
test('should create new url custom link', async () => {
await navigateToRichTextFields()
// Open link drawer
await page.locator('.rich-text__toolbar button:not([disabled]) .link').first().click()
// find the drawer
const editLinkModal = page.locator('[id^=drawer_1_rich-text-link-]')
await expect(editLinkModal).toBeVisible()
await wait(400)
// Fill values and click Confirm
await editLinkModal.locator('#field-text').fill('link text')
await editLinkModal.locator('label[for="field-linkType-custom"]').click()
await editLinkModal.locator('#field-url').fill('https://payloadcms.com')
await editLinkModal.locator('button[type="submit"]').click()
await wait(400)
await saveDocAndAssert(page)
// Remove link from editor body
await page.locator('span >> text="link text"').click()
const popup = page.locator('.popup--active .rich-text-link__popup')
await expect(popup.locator('.rich-text-link__link-label')).toBeVisible()
await popup.locator('.rich-text-link__link-close').click()
await expect(page.locator('span >> text="link text"')).toHaveCount(0)
})
test('should create new internal link', async () => {
await navigateToRichTextFields()
// Open link drawer
await page.locator('.rich-text__toolbar button:not([disabled]) .link').first().click()
// find the drawer
const editLinkModal = page.locator('[id^=drawer_1_rich-text-link-]')
await expect(editLinkModal).toBeVisible()
await wait(400)
// Fill values and click Confirm
await editLinkModal.locator('#field-text').fill('link text')
await editLinkModal.locator('label[for="field-linkType-internal"]').click()
await editLinkModal.locator('#field-doc .rs__control').click()
await page.keyboard.type('dev@')
await editLinkModal
.locator('#field-doc .rs__menu .rs__option:has-text("dev@payloadcms.com")')
.click()
// await wait(200);
await editLinkModal.locator('button[type="submit"]').click()
await saveDocAndAssert(page)
})
test('should not create new url link when read only', async () => {
await navigateToRichTextFields()
// Attempt to open link popup
const modalTrigger = page.locator('.rich-text--read-only .rich-text__toolbar button .link')
await expect(modalTrigger).toBeDisabled()
})
test('should only list RTE enabled upload collections in drawer', async () => {
await navigateToRichTextFields()
// Open link drawer
await page
.locator('.rich-text__toolbar button:not([disabled]) .upload-rich-text-button')
.first()
.click()
// open the list select menu
await page.locator('.list-drawer__select-collection-wrap .rs__control').click()
const menu = page.locator('.list-drawer__select-collection-wrap .rs__menu')
// `uploads-3` has enableRichTextRelationship set to false
await expect(menu).not.toContainText('Uploads3')
})
// TODO: this test can't find the selector for the search filter, but functionality works.
// Need to debug
test.skip('should search correct useAsTitle field after toggling collection in list drawer', async () => {
await navigateToRichTextFields()
// open link drawer
const field = page.locator('#field-richText')
const button = field.locator(
'button.rich-text-relationship__list-drawer-toggler.list-drawer__toggler',
)
await button.click()
// check that the search is on the `name` field of the `text-fields` collection
const drawer = page.locator('[id^=list-drawer_1_]')
await expect(drawer.locator('.search-filter__input')).toHaveAttribute(
'placeholder',
'Search by Text',
)
// change the selected collection to `array-fields`
await page.locator('.list-drawer__select-collection-wrap .rs__control').click()
const menu = page.locator('.list-drawer__select-collection-wrap .rs__menu')
await menu.locator('.rs__option').getByText('Array Field').click()
// check that `id` is now the default search field
await expect(drawer.locator('.search-filter__input')).toHaveAttribute(
'placeholder',
'Search by ID',
)
})
test('should only list RTE enabled collections in link drawer', async () => {
await navigateToRichTextFields()
await page.locator('.rich-text__toolbar button:not([disabled]) .link').first().click()
const editLinkModal = page.locator('[id^=drawer_1_rich-text-link-]')
await expect(editLinkModal).toBeVisible()
await editLinkModal.locator('label[for="field-linkType-internal"]').click()
await editLinkModal.locator('.relationship__wrap .rs__control').click()
const menu = page.locator('.relationship__wrap .rs__menu')
// array-fields has enableRichTextLink set to false
await expect(menu).not.toContainText('Array Fields')
})
test('should only list non-upload collections in relationship drawer', async () => {
await navigateToRichTextFields()
// Open link drawer
await page
.locator('.rich-text__toolbar button:not([disabled]) .relationship-rich-text-button')
.first()
.click()
await wait(300)
// open the list select menu
await page.locator('.list-drawer__select-collection-wrap .rs__control').click()
const menu = page.locator('.list-drawer__select-collection-wrap .rs__menu')
await expect(menu).not.toContainText('Uploads')
})
test('should respect customizing the default fields', async () => {
const linkText = 'link'
const value = 'test value'
await navigateToRichTextFields()
const field = page.locator('.rich-text', {
has: page.locator('#field-richTextCustomFields'),
})
// open link drawer
const button = field.locator('button.rich-text__button.link')
await button.click()
// fill link fields
const linkDrawer = page.locator('[id^=drawer_1_rich-text-link-]')
const fields = linkDrawer.locator('.render-fields > .field-type')
await fields.locator('#field-text').fill(linkText)
await fields.locator('#field-url').fill('https://payloadcms.com')
const input = fields.locator('#field-fields__customLinkField')
await input.fill(value)
await wait(300)
// submit link closing drawer
await linkDrawer.locator('button[type="submit"]').click()
const linkInEditor = field.locator(`.rich-text-link >> text="${linkText}"`)
await saveDocAndAssert(page)
// open modal again
await linkInEditor.click()
const popup = page.locator('.popup--active .rich-text-link__popup')
await expect(popup).toBeVisible()
await popup.locator('.rich-text-link__link-edit').click()
const linkDrawer2 = page.locator('[id^=drawer_1_rich-text-link-]')
const fields2 = linkDrawer2.locator('.render-fields > .field-type')
const input2 = fields2.locator('#field-fields__customLinkField')
await expect(input2).toHaveValue(value)
})
})
describe('editor', () => {
test('should populate url link', async () => {
await navigateToRichTextFields()
// Open link popup
await page.locator('#field-richText span >> text="render links"').click()
const popup = page.locator('.popup--active .rich-text-link__popup')
await expect(popup).toBeVisible()
await expect(popup.locator('a')).toHaveAttribute('href', 'https://payloadcms.com')
// Open the drawer
await popup.locator('.rich-text-link__link-edit').click()
const editLinkModal = page.locator('[id^=drawer_1_rich-text-link-]')
await expect(editLinkModal).toBeVisible()
// Check the drawer values
const textField = editLinkModal.locator('#field-text')
await expect(textField).toHaveValue('render links')
// Close the drawer
await editLinkModal.locator('button[type="submit"]').click()
await expect(editLinkModal).toBeHidden()
})
test('should populate relationship link', async () => {
await navigateToRichTextFields()
// Open link popup
await page.locator('#field-richText span >> text="link to relationships"').click()
const popup = page.locator('.popup--active .rich-text-link__popup')
await expect(popup).toBeVisible()
await expect(popup.locator('a')).toHaveAttribute(
'href',
/\/admin\/collections\/array-fields\/.*/,
)
// Open the drawer
await popup.locator('.rich-text-link__link-edit').click()
const editLinkModal = page.locator('[id^=drawer_1_rich-text-link-]')
await expect(editLinkModal).toBeVisible()
// Check the drawer values
const textField = editLinkModal.locator('#field-text')
await expect(textField).toHaveValue('link to relationships')
})
test('should open upload drawer and render custom relationship fields', async () => {
await navigateToRichTextFields()
const field = page.locator('#field-richText')
const button = field.locator('button.rich-text-upload__upload-drawer-toggler')
await button.click()
const documentDrawer = page.locator('[id^=drawer_1_upload-drawer-]')
await expect(documentDrawer).toBeVisible()
const caption = documentDrawer.locator('#field-caption')
await expect(caption).toBeVisible()
})
test('should open upload document drawer from read-only field', async () => {
await navigateToRichTextFields()
const field = page.locator('#field-richTextReadOnly')
const button = field.locator(
'button.rich-text-upload__doc-drawer-toggler.doc-drawer__toggler',
)
await button.click()
const documentDrawer = page.locator('[id^=doc-drawer_uploads_1_]')
await expect(documentDrawer).toBeVisible()
})
test('should open relationship document drawer from read-only field', async () => {
await navigateToRichTextFields()
const field = page.locator('#field-richTextReadOnly')
const button = field.locator(
'button.rich-text-relationship__doc-drawer-toggler.doc-drawer__toggler',
)
await button.click()
const documentDrawer = page.locator('[id^=doc-drawer_text-fields_1_]')
await expect(documentDrawer).toBeVisible()
})
test('should populate new links', async () => {
await navigateToRichTextFields()
// Highlight existing text
const headingElement = page.locator(
'#field-richText h1 >> text="Hello, I\'m a rich text field."',
)
await headingElement.selectText()
// click the toolbar link button
await page.locator('.rich-text__toolbar button:not([disabled]) .link').first().click()
// find the drawer and confirm the values
const editLinkModal = page.locator('[id^=drawer_1_rich-text-link-]')
await expect(editLinkModal).toBeVisible()
const textField = editLinkModal.locator('#field-text')
await expect(textField).toHaveValue("Hello, I'm a rich text field.")
})
test('should not take value from previous block', async () => {
await navigateToRichTextFields()
// check first block value
const textField = page.locator('#field-blocks__0__text')
await expect(textField).toHaveValue('Regular text')
// remove the first block
const editBlock = page.locator('#blocks-row-0 .popup-button')
await editBlock.click()
const removeButton = page.locator('#blocks-row-0').getByRole('button', { name: 'Remove' })
await expect(removeButton).toBeVisible()
await removeButton.click()
// check new first block value
const richTextField = page.locator('#field-blocks__0__text')
const richTextValue = await richTextField.innerText()
expect(richTextValue).toContain('Rich text')
})
})
})
describe('date', () => {
let url: AdminUrlUtil
beforeAll(() => {
url = new AdminUrlUtil(serverURL, 'date-fields')
})
test('should display formatted date in list view table cell', async () => {
await page.goto(url.list)
const formattedDateCell = page.locator('.row-1 .cell-timeOnly')
await expect(formattedDateCell).toContainText(' Aug ')
const notFormattedDateCell = page.locator('.row-1 .cell-default')
await expect(notFormattedDateCell).toContainText('August')
})
test('should display formatted date in useAsTitle', async () => {
await page.goto(url.list)
await page.locator('.row-1 .cell-default a').click()
await expect(page.locator('.doc-header__title.render-title')).toContainText('August')
})
test('should clear date', async () => {
await page.goto(url.create)
const dateField = page.locator('#field-default input')
await expect(dateField).toBeVisible()
await dateField.fill('02/07/2023')
await expect(dateField).toHaveValue('02/07/2023')
await saveDocAndAssert(page)
const clearButton = page.locator('#field-default .date-time-picker__clear-button')
await expect(clearButton).toBeVisible()
await clearButton.click()
await expect(dateField).toHaveValue('')
})
describe('localized dates', () => {
describe('EST', () => {
test.use({
geolocation: {
latitude: 42.3314,
longitude: -83.0458,
},
timezoneId: 'America/Detroit',
})
test('create EST day only date', async () => {
await page.goto(url.create)
await page.waitForURL(`**/${url.create}`)
const dateField = page.locator('#field-default input')
// enter date in default date field
await dateField.fill('02/07/2023')
await saveDocAndAssert(page)
// get the ID of the doc
const routeSegments = page.url().split('/')
const id = routeSegments.pop()
// fetch the doc (need the date string from the DB)
const { doc } = await client.findByID({ id, auth: true, slug: 'date-fields' })
expect(doc.default).toEqual('2023-02-07T12:00:00.000Z')
})
})
describe('PST', () => {
test.use({
geolocation: {
latitude: 37.774929,
longitude: -122.419416,
},
timezoneId: 'America/Los_Angeles',
})
test('create PDT day only date', async () => {
await page.goto(url.create)
await page.waitForURL(`**/${url.create}`)
const dateField = page.locator('#field-default input')
// enter date in default date field
await dateField.fill('02/07/2023')
await page.locator('#action-save').click()
// wait for navigation to update route
await expect.poll(() => page.url(), { timeout: 1000 }).not.toContain('create')
// get the ID of the doc
const routeSegments = page.url().split('/')
const id = routeSegments.pop()
// fetch the doc (need the date string from the DB)
const { doc } = await client.findByID({ id, auth: true, slug: 'date-fields' })
expect(doc.default).toEqual('2023-02-07T12:00:00.000Z')
})
})
describe('ST', () => {
test.use({
geolocation: {
latitude: -14.5994,
longitude: -171.857,
},
timezoneId: 'Pacific/Apia',
})
test('create ST day only date', async () => {
await page.goto(url.create)
await page.waitForURL(`**/${url.create}`)
const dateField = page.locator('#field-default input')
// enter date in default date field
await dateField.fill('02/07/2023')
await saveDocAndAssert(page)
// get the ID of the doc
const routeSegments = page.url().split('/')
const id = routeSegments.pop()
// fetch the doc (need the date string from the DB)
const { doc } = await client.findByID({ id, auth: true, slug: 'date-fields' })
expect(doc.default).toEqual('2023-02-07T12:00:00.000Z')
})
})
})
})
describe('upload', () => {
let url: AdminUrlUtil
beforeAll(() => {
url = new AdminUrlUtil(serverURL, 'uploads')
})
async function uploadImage() {
await page.goto(url.create)
// create a jpg upload
await page
.locator('.file-field__upload input[type="file"]')
.setInputFiles(path.resolve(dirname, './collections/Upload/payload.jpg'))
await expect(page.locator('.file-field .file-field__filename')).toHaveValue('payload.jpg')
await page.locator('#action-save').click()
await expect(page.locator('.Toastify')).toContainText('successfully')
}
// eslint-disable-next-line playwright/expect-expect
test('should upload files', async () => {
await uploadImage()
})
// test that the image renders
test('should render uploaded image', async () => {
await uploadImage()
await expect(page.locator('.file-field .file-details img')).toHaveAttribute(
'src',
'/api/uploads/file/payload-1.jpg',
)
})
test('should upload using the document drawer', async () => {
await uploadImage()
await wait(500)
// Open the media drawer and create a png upload
await page.locator('.field-type.upload .upload__toggler.doc-drawer__toggler').click()
await wait(1000) // TODO: Fix this. Need to wait a bit until the form in the drawer mounted, otherwise values sometimes disappear. This is an issue for all drawers
await page
.locator('[id^=doc-drawer_uploads_1_] .file-field__upload input[type="file"]')
.setInputFiles(path.resolve(dirname, './uploads/payload.png'))
await expect(
page.locator('[id^=doc-drawer_uploads_1_] .file-field__upload .file-field__filename'),
).toHaveValue('payload.png')
await page.locator('[id^=doc-drawer_uploads_1_] #action-save').click()
await expect(page.locator('.Toastify')).toContainText('successfully')
// Assert that the media field has the png upload
await expect(
page.locator('.field-type.upload .file-details .file-meta__url a'),
).toHaveAttribute('href', '/api/uploads/file/payload-1.png')
await expect(
page.locator('.field-type.upload .file-details .file-meta__url a'),
).toContainText('payload-1.png')
await expect(page.locator('.field-type.upload .file-details img')).toHaveAttribute(
'src',
'/api/uploads/file/payload-1.png',
)
await saveDocAndAssert(page)
})
test('should clear selected upload', async () => {
await uploadImage()
await wait(1000) // TODO: Fix this. Need to wait a bit until the form in the drawer mounted, otherwise values sometimes disappear. This is an issue for all drawers
await page.locator('.field-type.upload .upload__toggler.doc-drawer__toggler').click()
await page
.locator('[id^=doc-drawer_uploads_1_] .file-field__upload input[type="file"]')
.setInputFiles(path.resolve(dirname, './uploads/payload.png'))
await expect(
page.locator('[id^=doc-drawer_uploads_1_] .file-field__upload .file-field__filename'),
).toHaveValue('payload.png')
await page.locator('[id^=doc-drawer_uploads_1_] #action-save').click()
await expect(page.locator('.Toastify')).toContainText('successfully')
await page.locator('.field-type.upload .file-details__remove').click()
})
test('should select using the list drawer and restrict mimetype based on filterOptions', async () => {
await uploadImage()
await page.locator('.field-type.upload .upload__toggler.list-drawer__toggler').click()
await wait(500) // TODO: Fix this. Need to wait a bit until the form in the drawer mounted, otherwise values sometimes disappear. This is an issue for all drawers
const jpgImages = page.locator('[id^=list-drawer_1_] .upload-gallery img[src$=".jpg"]')
await expect
.poll(async () => await jpgImages.count(), { timeout: POLL_TOPASS_TIMEOUT })
.toEqual(0)
})
test.skip('should show drawer for input field when enableRichText is false', async () => {
const uploads3URL = new AdminUrlUtil(serverURL, 'uploads3')
await page.goto(uploads3URL.create)
// create file in uploads 3 collection
await page
.locator('.file-field__upload input[type="file"]')
.setInputFiles(path.resolve(dirname, './collections/Upload/payload.jpg'))
await expect(page.locator('.file-field .file-field__filename')).toContainText('payload.jpg')
await page.locator('#action-save').click()
await wait(200)
// open drawer
await page.locator('.field-type.upload .list-drawer__toggler').click()
// check title
await expect(page.locator('.list-drawer__header-text')).toContainText('Uploads 3')
})
})
describe('row', () => {
let url: AdminUrlUtil
beforeAll(() => {
url = new AdminUrlUtil(serverURL, 'row-fields')
})
test('should show row fields as table columns', async () => {
await page.goto(url.create)
// fill the required fields, including the row field
const idInput = page.locator('input#field-id')
await idInput.fill('123')
const titleInput = page.locator('input#field-title')
await titleInput.fill('Row 123')
await page.locator('#action-save').click()
await wait(200)
await expect(page.locator('.Toastify')).toContainText('successfully')
// ensure the 'title' field is visible in the table header
await page.goto(url.list)
const titleHeading = page.locator('th#heading-title')
await expect(titleHeading).toBeVisible()
// ensure the 'title' field shows the correct value in the table cell
const titleCell = page.locator('.row-1 td.cell-title')
await expect(titleCell).toBeVisible()
await expect(titleCell).toContainText('Row 123')
})
test('should not show duplicative ID field', async () => {
await page.goto(url.create)
// fill the required fields, including the custom ID field
const idInput = page.locator('input#field-id')
await idInput.fill('456')
const titleInput = page.locator('input#field-title')
await titleInput.fill('Row 456')
await page.locator('#action-save').click()
await wait(200)
await expect(page.locator('.Toastify')).toContainText('successfully')
// ensure there are not two ID fields in the table header
await page.goto(url.list)
const idHeadings = page.locator('th#heading-id')
await expect(idHeadings).toBeVisible()
await expect(idHeadings).toHaveCount(1)
})
test('should render row fields inline and with explicit widths', async () => {
await page.goto(url.create)
const fieldA = page.locator('input#field-field_with_width_a')
await expect(fieldA).toBeVisible()
const fieldB = page.locator('input#field-field_with_width_b')
await expect(fieldB).toBeVisible()
const fieldABox = await fieldA.boundingBox()
const fieldBBox = await fieldB.boundingBox()
// Check that the top value of the fields are the same
// Give it some wiggle room of like 2px to account for differences in rendering
const tolerance = 2
expect(fieldABox.y).toBeLessThanOrEqual(fieldBBox.y + tolerance)
// Check that the widths of the fields are the same
const difference = Math.abs(fieldABox.width - fieldBBox.width)
expect(difference).toBeLessThanOrEqual(tolerance)
})
test('should render nested row fields in the correct position', async () => {
await page.goto(url.create)
// These fields are not given explicit `width` values
await page.goto(url.create)
const fieldA = page.locator('input#field-field_within_collapsible_a')
await expect(fieldA).toBeVisible()
const fieldB = page.locator('input#field-field_within_collapsible_b')
await expect(fieldB).toBeVisible()
const fieldABox = await fieldA.boundingBox()
const fieldBBox = await fieldB.boundingBox()
// Check that the top value of the fields are the same
// Give it some wiggle room of like 2px to account for differences in rendering
const tolerance = 2
expect(fieldABox.y).toBeLessThanOrEqual(fieldBBox.y + tolerance)
// Check that the widths of the fields are the same
const collapsibleDifference = Math.abs(fieldABox.width - fieldBBox.width)
expect(collapsibleDifference).toBeLessThanOrEqual(tolerance)
})
})
describe('conditional logic', () => {
let url: AdminUrlUtil
beforeAll(() => {
url = new AdminUrlUtil(serverURL, 'conditional-logic')
})
test('should toggle conditional field when data changes', async () => {
await page.goto(url.create)
const toggleField = page.locator('label[for=field-toggleField]')
await toggleField.click()
const fieldToToggle = page.locator('input#field-fieldToToggle')
await expect(fieldToToggle).toBeVisible()
})
test('should show conditional field based on user data', async () => {
await page.goto(url.create)
const userConditional = page.locator('input#field-userConditional')
await expect(userConditional).toBeVisible()
})
test('should show conditional field based on fields nested within data', async () => {
await page.goto(url.create)
const parentGroupFields = page.locator(
'div#field-parentGroup > .group-field__wrap > .render-fields',
)
await expect(parentGroupFields).toHaveCount(1)
const toggle = page.locator('label[for=field-parentGroup__enableParentGroupFields]')
await toggle.click()
const toggledField = page.locator('input#field-parentGroup__siblingField')
await expect(toggledField).toBeVisible()
})
test('should show conditional field based on fields nested within siblingData', async () => {
await page.goto(url.create)
const toggle = page.locator('label[for=field-parentGroup__enableParentGroupFields]')
await toggle.click()
const fieldRelyingOnSiblingData = page.locator('input#field-reliesOnParentGroup')
await expect(fieldRelyingOnSiblingData).toBeVisible()
})
})
})
async function createTextFieldDoc(overrides?: Partial<TextField>): Promise<TextField> {
return payload.create({
collection: 'text-fields',
data: {
text: 'some text',
localizedText: 'some localized text',
...overrides,
},
}) as unknown as Promise<TextField>
}
async function createRelationshipFieldDoc(
relationship: RelationshipField['relationship'],
overrides?: Partial<RelationshipField>,
): Promise<RelationshipField> {
return payload.create({
collection: 'relationship-fields',
data: {
relationship,
...overrides,
},
}) as unknown as Promise<RelationshipField>
}