When server rendering custom components within form state, those components receive a path that is correct at render time, but potentially stale after manipulating array and blocks rows. This causes the field to briefly render incorrect values while the form state request is in flight. The reason for this is that paths are passed as a prop statically into those components. Then when we manipulate rows, form state is modified, potentially changing field paths. The component's `path` prop, however, hasn't changed. This means it temporarily points to the wrong field in form state, rendering the data of another row until the server responds with a freshly rendered component. This is not an issue with default Payload fields as they are rendered on the client and can be passed dynamic props. This is only an issue within custom server components, including rich text fields which are treated as custom components. Since they are rendered on the server and passed to the client, props are inaccessible after render. The fix for this is to provide paths dynamically through context. This way as we make changes to form state, there is a mechanism in which server components can receive the updated path without waiting on its props to update.
128 lines
4.9 KiB
TypeScript
128 lines
4.9 KiB
TypeScript
import type { Page } from '@playwright/test'
|
|
|
|
import { expect, test } from '@playwright/test'
|
|
import { AdminUrlUtil } from 'helpers/adminUrlUtil.js'
|
|
import path from 'path'
|
|
import { wait } from 'payload/shared'
|
|
import { fileURLToPath } from 'url'
|
|
|
|
import { ensureCompilationIsDone, initPageConsoleErrorCatch, saveDocAndAssert } from '../helpers.js'
|
|
import { initPayloadE2ENoConfig } from '../helpers/initPayloadE2ENoConfig.js'
|
|
import { TEST_TIMEOUT_LONG } from '../playwright.config.js'
|
|
import { collectionSlugs } from './shared.js'
|
|
|
|
const { beforeAll, describe } = test
|
|
const filename = fileURLToPath(import.meta.url)
|
|
const dirname = path.dirname(filename)
|
|
|
|
describe('Field Error States', () => {
|
|
let serverURL: string
|
|
let page: Page
|
|
let validateDraftsOff: AdminUrlUtil
|
|
let validateDraftsOn: AdminUrlUtil
|
|
let validateDraftsOnAutosave: AdminUrlUtil
|
|
let prevValue: AdminUrlUtil
|
|
let prevValueRelation: AdminUrlUtil
|
|
|
|
beforeAll(async ({ browser }, testInfo) => {
|
|
testInfo.setTimeout(TEST_TIMEOUT_LONG)
|
|
;({ serverURL } = await initPayloadE2ENoConfig({ dirname }))
|
|
validateDraftsOff = new AdminUrlUtil(serverURL, collectionSlugs.validateDraftsOff)
|
|
validateDraftsOn = new AdminUrlUtil(serverURL, collectionSlugs.validateDraftsOn)
|
|
validateDraftsOnAutosave = new AdminUrlUtil(serverURL, collectionSlugs.validateDraftsOnAutosave)
|
|
prevValue = new AdminUrlUtil(serverURL, collectionSlugs.prevValue)
|
|
prevValueRelation = new AdminUrlUtil(serverURL, collectionSlugs.prevValueRelation)
|
|
const context = await browser.newContext()
|
|
page = await context.newPage()
|
|
initPageConsoleErrorCatch(page)
|
|
|
|
await ensureCompilationIsDone({ page, serverURL })
|
|
})
|
|
|
|
test('Remove row should remove error states from parent fields', async () => {
|
|
await page.goto(`${serverURL}/admin/collections/error-fields/create`)
|
|
|
|
// add parent array
|
|
await page.locator('#field-parentArray > .array-field__add-row').click()
|
|
|
|
// add first child array
|
|
await page.locator('#parentArray-row-0 .collapsible__content .array-field__add-row').click()
|
|
await page.locator('#field-parentArray__0__childArray__0__childArrayText').focus()
|
|
await page.keyboard.type('T1')
|
|
|
|
// add second child array
|
|
await page.locator('#parentArray-row-0 .collapsible__content .array-field__add-row').click()
|
|
await page.locator('#field-parentArray__0__childArray__1__childArrayText').focus()
|
|
await page.keyboard.type('T2')
|
|
|
|
// add third child array
|
|
await page.locator('#parentArray-row-0 .collapsible__content .array-field__add-row').click()
|
|
|
|
// remove the row
|
|
await page.locator('#parentArray-0-childArray-row-2 .array-actions__button').click()
|
|
|
|
await page
|
|
.locator('#parentArray-0-childArray-row-2 .array-actions__action.array-actions__remove')
|
|
.click()
|
|
|
|
await page.locator('#action-save').click()
|
|
|
|
const errorPill = await page.waitForSelector(
|
|
'#parentArray-row-0 > .collapsible > .collapsible__toggle-wrap .array-field__row-error-pill',
|
|
{ state: 'hidden', timeout: 500 },
|
|
)
|
|
|
|
expect(errorPill).toBeNull()
|
|
})
|
|
|
|
describe('draft validations', () => {
|
|
test('should not validate drafts by default', async () => {
|
|
await page.goto(validateDraftsOff.create)
|
|
await saveDocAndAssert(page, '#action-save-draft')
|
|
})
|
|
|
|
test('should validate drafts when enabled', async () => {
|
|
await page.goto(validateDraftsOn.create)
|
|
await saveDocAndAssert(page, '#action-save-draft', 'error')
|
|
})
|
|
|
|
test('should show validation errors when validate and autosave are enabled', async () => {
|
|
await page.goto(validateDraftsOnAutosave.create)
|
|
await page.locator('#field-title').fill('valid')
|
|
await saveDocAndAssert(page)
|
|
await page.locator('#field-title').fill('')
|
|
await saveDocAndAssert(page, '#action-save', 'error')
|
|
})
|
|
})
|
|
|
|
describe('previous values', () => {
|
|
test('should pass previous value into validate function', async () => {
|
|
// save original
|
|
await page.goto(prevValue.create)
|
|
await page.locator('#field-title').fill('original value')
|
|
await saveDocAndAssert(page)
|
|
await page.locator('#field-title').fill('original value 2')
|
|
await saveDocAndAssert(page)
|
|
await wait(500)
|
|
|
|
// create relation to doc
|
|
await page.goto(prevValueRelation.create)
|
|
await page.locator('#field-previousValueRelation .react-select').click()
|
|
await page.locator('#field-previousValueRelation .rs__option').first().click()
|
|
await saveDocAndAssert(page)
|
|
|
|
// go back to doc
|
|
await page.goto(prevValue.list)
|
|
await page.locator('.row-1 a').click()
|
|
await page.locator('#field-description').fill('some description')
|
|
await saveDocAndAssert(page)
|
|
await page.locator('#field-title').fill('changed')
|
|
await saveDocAndAssert(page, '#action-save', 'error')
|
|
|
|
// ensure value is the value before relationship association
|
|
await page.reload()
|
|
await expect(page.locator('#field-title')).toHaveValue('original value 2')
|
|
})
|
|
})
|
|
})
|