c96fa613bc
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>
110 lines
2.9 KiB
TypeScript
110 lines
2.9 KiB
TypeScript
import chalk from 'chalk'
|
|
import { createServer } from 'http'
|
|
import minimist from 'minimist'
|
|
import nextImport from 'next'
|
|
import fs from 'node:fs'
|
|
import path from 'node:path'
|
|
import { fileURLToPath } from 'node:url'
|
|
import open from 'open'
|
|
import { loadEnv } from 'payload/node'
|
|
import { parse } from 'url'
|
|
|
|
import { getNextRootDir } from './helpers/getNextRootDir.js'
|
|
import startMemoryDB from './helpers/startMemoryDB.js'
|
|
import { runInit } from './runInit.js'
|
|
import { child, safelyRunScriptFunction } from './safelyRunScript.js'
|
|
import { createTestHooks } from './testHooks.js'
|
|
|
|
const prod = process.argv.includes('--prod')
|
|
if (prod) {
|
|
process.argv = process.argv.filter((arg) => arg !== '--prod')
|
|
process.env.PAYLOAD_TEST_PROD = 'true'
|
|
}
|
|
|
|
const shouldStartMemoryDB =
|
|
process.argv.includes('--start-memory-db') || process.env.START_MEMORY_DB === 'true'
|
|
if (shouldStartMemoryDB) {
|
|
process.argv = process.argv.filter((arg) => arg !== '--start-memory-db')
|
|
process.env.START_MEMORY_DB = 'true'
|
|
}
|
|
|
|
loadEnv()
|
|
|
|
const filename = fileURLToPath(import.meta.url)
|
|
const dirname = path.dirname(filename)
|
|
|
|
const {
|
|
_: [testSuiteArg],
|
|
...args
|
|
} = minimist(process.argv.slice(2))
|
|
|
|
if (!fs.existsSync(path.resolve(dirname, testSuiteArg))) {
|
|
console.log(chalk.red(`ERROR: The test folder "${testSuiteArg}" does not exist`))
|
|
process.exit(0)
|
|
}
|
|
|
|
if (args.turbo === true) {
|
|
process.env.TURBOPACK = '1'
|
|
}
|
|
|
|
const { beforeTest } = await createTestHooks(testSuiteArg)
|
|
await beforeTest()
|
|
|
|
const { rootDir, adminRoute } = getNextRootDir(testSuiteArg)
|
|
|
|
await safelyRunScriptFunction(runInit, 4000, testSuiteArg, true)
|
|
|
|
if (shouldStartMemoryDB) {
|
|
await startMemoryDB()
|
|
}
|
|
|
|
// Open the admin if the -o flag is passed
|
|
if (args.o) {
|
|
await open(`http://localhost:3000${adminRoute}`)
|
|
}
|
|
|
|
const port = process.env.PORT ? Number(process.env.PORT) : 3000
|
|
|
|
// @ts-expect-error the same as in test/helpers/initPayloadE2E.ts
|
|
const app = nextImport({
|
|
dev: true,
|
|
hostname: 'localhost',
|
|
port,
|
|
dir: rootDir,
|
|
})
|
|
|
|
const handle = app.getRequestHandler()
|
|
|
|
let resolveServer
|
|
|
|
const serverPromise = new Promise((res) => (resolveServer = res))
|
|
|
|
void app.prepare().then(() => {
|
|
createServer(async (req, res) => {
|
|
const parsedUrl = parse(req.url, true)
|
|
await handle(req, res, parsedUrl)
|
|
}).listen(port, () => {
|
|
resolveServer()
|
|
})
|
|
})
|
|
|
|
await serverPromise
|
|
process.env.PAYLOAD_DROP_DATABASE = process.env.PAYLOAD_DROP_DATABASE === 'false' ? 'false' : 'true'
|
|
|
|
// fetch the admin url to force a render
|
|
void fetch(`http://localhost:${port}${adminRoute}`)
|
|
void fetch(`http://localhost:${port}/api/access`)
|
|
// This ensures that the next-server process is killed when this process is killed and doesn't linger around.
|
|
process.on('SIGINT', () => {
|
|
if (child) {
|
|
child.kill('SIGINT')
|
|
}
|
|
process.exit(0)
|
|
})
|
|
process.on('SIGTERM', () => {
|
|
if (child) {
|
|
child.kill('SIGINT')
|
|
}
|
|
process.exit(0) // Exit the parent process
|
|
})
|