Files
payload/test/fields/collections/Point/e2e.spec.ts
Jacob Fletcher c96fa613bc feat!: on demand rsc (#8364)
Currently, Payload renders all custom components on initial compile of
the admin panel. This is problematic for two key reasons:
1. Custom components do not receive contextual data, i.e. fields do not
receive their field data, edit views do not receive their document data,
etc.
2. Components are unnecessarily rendered before they are used

This was initially required to support React Server Components within
the Payload Admin Panel for two key reasons:
1. Fields can be dynamically rendered within arrays, blocks, etc.
2. Documents can be recursively rendered within a "drawer" UI, i.e.
relationship fields
3. Payload supports server/client component composition 

In order to achieve this, components need to be rendered on the server
and passed as "slots" to the client. Currently, the pattern for this is
to render custom server components in the "client config". Then when a
view or field is needed to be rendered, we first check the client config
for a "pre-rendered" component, otherwise render our client-side
fallback component.

But for the reasons listed above, this pattern doesn't exactly make
custom server components very useful within the Payload Admin Panel,
which is where this PR comes in. Now, instead of pre-rendering all
components on initial compile, we're able to render custom components
_on demand_, only as they are needed.

To achieve this, we've established [this
pattern](https://github.com/payloadcms/payload/pull/8481) of React
Server Functions in the Payload Admin Panel. With Server Functions, we
can iterate the Payload Config and return JSX through React's
`text/x-component` content-type. This means we're able to pass
contextual props to custom components, such as data for fields and
views.

## Breaking Changes

1. Add the following to your root layout file, typically located at
`(app)/(payload)/layout.tsx`:

    ```diff
    /* THIS FILE WAS GENERATED AUTOMATICALLY BY PAYLOAD. */
    /* DO NOT MODIFY IT BECAUSE IT COULD BE REWRITTEN AT ANY TIME. */
    + import type { ServerFunctionClient } from 'payload'

    import config from '@payload-config'
    import { RootLayout } from '@payloadcms/next/layouts'
    import { handleServerFunctions } from '@payloadcms/next/utilities'
    import React from 'react'

    import { importMap } from './admin/importMap.js'
    import './custom.scss'

    type Args = {
      children: React.ReactNode
    }

+ const serverFunctions: ServerFunctionClient = async function (args) {
    +  'use server'
    +  return handleServerFunctions({
    +    ...args,
    +    config,
    +    importMap,
    +  })
    + }

    const Layout = ({ children }: Args) => (
      <RootLayout
        config={config}
        importMap={importMap}
    +  serverFunctions={serverFunctions}
      >
        {children}
      </RootLayout>
    )

    export default Layout
    ```

2. If you were previously posting to the `/api/form-state` endpoint, it
no longer exists. Instead, you'll need to invoke the `form-state` Server
Function, which can be done through the _new_ `getFormState` utility:

    ```diff
    - import { getFormState } from '@payloadcms/ui'
    - const { state } = await getFormState({
    -   apiRoute: '',
    -   body: {
    -     // ...
    -   },
    -   serverURL: ''
    - })

    + const { getFormState } = useServerFunctions()
    +
    + const { state } = await getFormState({
    +   // ...
    + })
    ```

## Breaking Changes

```diff
- useFieldProps()
- useCellProps()
```

More details coming soon.

---------

Co-authored-by: Alessio Gravili <alessio@gravili.de>
Co-authored-by: Jarrod Flesch <jarrodmflesch@gmail.com>
Co-authored-by: James <james@trbl.design>
2024-11-11 13:59:05 -05:00

161 lines
5.4 KiB
TypeScript

import type { Page } from '@playwright/test'
import { expect, test } from '@playwright/test'
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,
saveDocAndAssert,
} from '../../../helpers.js'
import { AdminUrlUtil } from '../../../helpers/adminUrlUtil.js'
import { initPayloadE2ENoConfig } from '../../../helpers/initPayloadE2ENoConfig.js'
import { reInitializeDB } from '../../../helpers/reInitializeDB.js'
import { RESTClient } from '../../../helpers/rest.js'
import { TEST_TIMEOUT_LONG } from '../../../playwright.config.js'
import { pointFieldsSlug } from '../../slugs.js'
const filename = fileURLToPath(import.meta.url)
const currentFolder = path.dirname(filename)
const dirname = path.resolve(currentFolder, '../../')
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' })
let url: AdminUrlUtil
let filledGroupPoint
let emptyGroupPoint
describe('Point', () => {
beforeAll(async ({ browser }, testInfo) => {
testInfo.setTimeout(TEST_TIMEOUT_LONG)
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,
}))
url = new AdminUrlUtil(serverURL, pointFieldsSlug)
const context = await browser.newContext()
page = await context.newPage()
initPageConsoleErrorCatch(page)
await ensureCompilationIsDone({ page, serverURL })
})
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 ensureCompilationIsDone({ page, serverURL })
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', '')
})
})