tabshift/payload
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat!: on demand rsc (#8364)

Browse Source 
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>
This commit is contained in:
Jacob Fletcher
2024-11-11 13:59:05 -05:00
committed by GitHub
parent 3e954f45c7
commit c96fa613bc
657 changed files with 34245 additions and 21057 deletions
Download Patch File Download Diff File Expand all files Collapse all files

249
packages/ui/src/forms/fieldSchemasToFormState/renderField.tsx Normal file
View File

@@ -0,0 +1,249 @@
import type {
ClientComponentProps,
ClientField,
FieldPermissions,
PayloadComponent,
ServerComponentProps,
} from 'payload'
import { getTranslation } from '@payloadcms/translations'
import { createClientField, deepCopyObjectSimple, MissingEditorProp } from 'payload'
import { fieldAffectsData } from 'payload/shared'
import type { RenderFieldMethod } from './types.js'
import { RenderServerComponent } from '../../elements/RenderServerComponent/index.js'
import { FieldDescription } from '../../fields/FieldDescription/index.js'
export const renderField: RenderFieldMethod = ({
data,
fieldConfig,
fieldSchemaMap,
fieldState,
formState,
indexPath,
operation,
parentPath,
parentSchemaPath,
path,
permissions: incomingPermissions,
req,
schemaPath,
siblingData,
}) => {
// TODO (ALESSIO): why are we passing the fieldConfig twice?
// and especially, why are we deepCopyObject -here- instead of inside the createClientField func,
// so no one screws this up in the future?
const clientField = createClientField({
clientField: deepCopyObjectSimple(fieldConfig) as ClientField,
defaultIDType: req.payload.config.db.defaultIDType,
field: fieldConfig,
i18n: req.i18n,
})
const permissions = fieldAffectsData(fieldConfig)
? incomingPermissions?.[fieldConfig.name]
: ({} as FieldPermissions)
const clientProps: ClientComponentProps = {
customComponents: fieldState?.customComponents || {},
field: clientField,
indexPath,
parentPath,
parentSchemaPath,
path,
readOnly: permissions?.[operation]?.permission === false,
schemaPath,
}
const serverProps: ServerComponentProps = {
clientField,
data,
field: fieldConfig,
fieldSchemaMap,
permissions,
// TODO: Should we pass explicit values? initialValue, value, valid
// value and initialValue should be typed
formState,
i18n: req.i18n,
payload: req.payload,
siblingData,
user: req.user,
}
if (!fieldState?.customComponents) {
fieldState.customComponents = {}
}
switch (fieldConfig.type) {
// TODO: handle block row labels as well in a similar fashion
case 'array': {
fieldState?.rows?.forEach((row, rowIndex) => {
if (fieldConfig.admin?.components && 'RowLabel' in fieldConfig.admin.components) {
if (!fieldState.customComponents.RowLabels) {
fieldState.customComponents.RowLabels = []
}
fieldState.customComponents.RowLabels[rowIndex] = (
<RenderServerComponent
clientProps={clientProps}
Component={fieldConfig.admin.components.RowLabel}
importMap={req.payload.importMap}
serverProps={{
...serverProps,
rowLabel: `${getTranslation(fieldConfig.labels.singular, req.i18n)} ${String(
rowIndex + 1,
).padStart(2, '0')}`,
rowNumber: rowIndex + 1,
}}
/>
)
}
})
break
}
case 'richText': {
if (!fieldConfig?.editor) {
throw new MissingEditorProp(fieldConfig) // while we allow disabling editor functionality, you should not have any richText fields defined if you do not have an editor
}
if (typeof fieldConfig?.editor === 'function') {
throw new Error('Attempted to access unsanitized rich text editor.')
}
if (!fieldConfig.admin) {
fieldConfig.admin = {}
}
if (!fieldConfig.admin.components) {
fieldConfig.admin.components = {}
}
/**
* We have to deep copy all the props we send to the client (= FieldComponent.clientProps).
* That way, every editor's field / cell props we send to the client have their own object references.
*
* If we send the same object reference to the client twice (e.g. through some configurations where 2 or more fields
* reference the same editor object, like the root editor), the admin panel may hang indefinitely. This has been happening since
* a newer Next.js update that made it break when sending the same object reference to the client twice.
*
* We can use deepCopyObjectSimple as client props should be JSON-serializable.
*/
const FieldComponent: PayloadComponent = fieldConfig.editor.FieldComponent
if (typeof FieldComponent === 'object' && FieldComponent.clientProps) {
FieldComponent.clientProps = deepCopyObjectSimple(FieldComponent.clientProps)
}
fieldState.customComponents.Field = (
<RenderServerComponent
clientProps={clientProps}
Component={FieldComponent}
Fallback={undefined}
importMap={req.payload.importMap}
serverProps={serverProps}
/>
)
break
}
default: {
break
}
}
if (fieldConfig.admin) {
if ('description' in fieldConfig.admin) {
// @TODO move this to client, only render if it is a function
fieldState.customComponents.Description = (
<FieldDescription
description={
typeof fieldConfig.admin?.description === 'string' ||
typeof fieldConfig.admin?.description === 'object'
? fieldConfig.admin.description
: typeof fieldConfig.admin?.description === 'function'
? fieldConfig.admin?.description({ t: req.i18n.t })
: ''
}
path={path}
/>
)
}
if (fieldConfig.admin?.components) {
if ('afterInput' in fieldConfig.admin.components) {
fieldState.customComponents.AfterInput = (
<RenderServerComponent
clientProps={clientProps}
Component={fieldConfig.admin.components.afterInput}
importMap={req.payload.importMap}
key="field.admin.components.afterInput"
serverProps={serverProps}
/>
)
}
if ('beforeInput' in fieldConfig.admin.components) {
fieldState.customComponents.BeforeInput = (
<RenderServerComponent
clientProps={clientProps}
Component={fieldConfig.admin.components.beforeInput}
importMap={req.payload.importMap}
key="field.admin.components.beforeInput"
serverProps={serverProps}
/>
)
}
if ('Description' in fieldConfig.admin.components) {
fieldState.customComponents.Description = (
<RenderServerComponent
clientProps={clientProps}
Component={fieldConfig.admin.components.Description}
importMap={req.payload.importMap}
key="field.admin.components.Description"
serverProps={serverProps}
/>
)
}
if ('Error' in fieldConfig.admin.components) {
fieldState.customComponents.Error = (
<RenderServerComponent
clientProps={clientProps}
Component={fieldConfig.admin.components.Error}
importMap={req.payload.importMap}
key="field.admin.components.Error"
serverProps={serverProps}
/>
)
}
if ('Label' in fieldConfig.admin.components) {
fieldState.customComponents.Label = (
<RenderServerComponent
clientProps={clientProps}
Component={fieldConfig.admin.components.Label}
importMap={req.payload.importMap}
key="field.admin.components.Label"
serverProps={serverProps}
/>
)
}
if ('Field' in fieldConfig.admin.components) {
fieldState.customComponents.Field = (
<RenderServerComponent
clientProps={clientProps}
Component={fieldConfig.admin.components.Field}
importMap={req.payload.importMap}
key="field.admin.components.Field"
serverProps={serverProps}
/>
)
}
}
}
}