4c8cafd6a6
If you have multiple blocks that are used in multiple places, this can quickly blow up the size of your Payload Config. This will incur a performance hit, as more data is
1. sent to the client (=> bloated `ClientConfig` and large initial html) and
2. processed on the server (permissions are calculated every single time you navigate to a page - this iterates through all blocks you have defined, even if they're duplicative)
This can be optimized by defining your block **once** in your Payload Config, and just referencing the block slug whenever it's used, instead of passing the entire block config. To do this, the block can be defined in the `blocks` array of the Payload Config. The slug can then be passed to the `blockReferences` array in the Blocks Field - the `blocks` array has to be empty for compatibility reasons.
```ts
import { buildConfig } from 'payload'
import { lexicalEditor, BlocksFeature } from '@payloadcms/richtext-lexical'
// Payload Config
const config = buildConfig({
// Define the block once
blocks: [
{
slug: 'TextBlock',
fields: [
{
name: 'text',
type: 'text',
},
],
},
],
collections: [
{
slug: 'collection1',
fields: [
{
name: 'content',
type: 'blocks',
// Reference the block by slug
blockReferences: ['TextBlock'],
blocks: [], // Required to be empty, for compatibility reasons
},
],
},
{
slug: 'collection2',
fields: [
{
name: 'editor',
type: 'richText',
editor: lexicalEditor({
BlocksFeature({
// Same reference can be reused anywhere, even in the lexical editor, without incurred performance hit
blocks: ['TextBlock'],
})
})
},
],
},
],
})
```
## v4.0 Plans
In 4.0, we will remove the `blockReferences` property, and allow string block references to be passed directly to the blocks `property`. Essentially, we'd remove the `blocks` property and rename `blockReferences` to `blocks`.
The reason we opted to a new property in this PR is to avoid breaking changes. Allowing strings to be passed to the `blocks` property will prevent plugins that iterate through fields / blocks from compiling.
## PR Changes
- Testing: This PR introduces a plugin that automatically converts blocks to block references. This is done in the fields__blocks test suite, to run our existing test suite using block references.
- Block References support: Most changes are similar. Everywhere we iterate through blocks, we have to now do the following:
1. Check if `field.blockReferences` is provided. If so, only iterate through that.
2. Check if the block is an object (= actual block), or string
3. If it's a string, pull the actual block from the Payload Config or from `payload.blocks`.
The exception is config sanitization and block type generations. This PR optimizes them so that each block is only handled once, instead of every time the block is referenced.
## Benchmarks
60 Block fields, each block field having the same 600 Blocks.
### Before:
**Initial HTML:** 195 kB
**Generated types:** takes 11 minutes, 461,209 lines
https://github.com/user-attachments/assets/11d49a4e-5414-4579-8050-e6346e552f56
### After:
**Initial HTML:** 73.6 kB
**Generated types:** takes 2 seconds, 35,810 lines
https://github.com/user-attachments/assets/3eab1a99-6c29-489d-add5-698df67780a3
### After Permissions Optimization (follow-up PR)
Initial HTML: 73.6 kB
https://github.com/user-attachments/assets/a909202e-45a8-4bf6-9a38-8c85813f1312
## Future Plans
1. This PR does not yet deduplicate block references during permissions calculation. We'll optimize that in a separate PR, as this one is already large enough
2. The same optimization can be done to deduplicate fields. One common use-case would be link field groups that may be referenced in multiple entities, outside of blocks. We might explore adding a new `fieldReferences` property, that allows you to reference those same `config.blocks`.
322 lines
8.7 KiB
TypeScript
322 lines
8.7 KiB
TypeScript
import type {
|
|
SerializedBlockNode,
|
|
SerializedParagraphNode,
|
|
SerializedTextNode,
|
|
SerializedUploadNode,
|
|
TypedEditorState,
|
|
} from '@payloadcms/richtext-lexical'
|
|
|
|
export function generateLexicalRichText(): TypedEditorState<
|
|
SerializedBlockNode | SerializedParagraphNode | SerializedTextNode | SerializedUploadNode
|
|
> {
|
|
return {
|
|
root: {
|
|
type: 'root',
|
|
format: '',
|
|
indent: 0,
|
|
version: 1,
|
|
children: [
|
|
{
|
|
children: [
|
|
{
|
|
detail: 0,
|
|
format: 0,
|
|
mode: 'normal',
|
|
style: '',
|
|
text: 'Upload Node:',
|
|
type: 'text',
|
|
version: 1,
|
|
},
|
|
],
|
|
direction: 'ltr',
|
|
format: '',
|
|
indent: 0,
|
|
type: 'paragraph',
|
|
textFormat: 0,
|
|
version: 1,
|
|
},
|
|
{
|
|
format: '',
|
|
type: 'upload',
|
|
version: 2,
|
|
id: '665d105a91e1c337ba8308dd',
|
|
fields: {
|
|
caption: {
|
|
root: {
|
|
type: 'root',
|
|
format: '',
|
|
indent: 0,
|
|
version: 1,
|
|
children: [
|
|
{
|
|
children: [
|
|
{
|
|
detail: 0,
|
|
format: 0,
|
|
mode: 'normal',
|
|
style: '',
|
|
text: 'Relationship inside Upload Caption:',
|
|
type: 'text',
|
|
version: 1,
|
|
},
|
|
],
|
|
direction: 'ltr',
|
|
format: '',
|
|
indent: 0,
|
|
type: 'paragraph',
|
|
version: 1,
|
|
},
|
|
{
|
|
format: '',
|
|
type: 'relationship',
|
|
version: 2,
|
|
relationTo: 'text-fields',
|
|
value: '{{TEXT_DOC_ID}}',
|
|
},
|
|
],
|
|
direction: 'ltr',
|
|
},
|
|
},
|
|
},
|
|
relationTo: 'uploads',
|
|
value: '{{UPLOAD_DOC_ID}}',
|
|
},
|
|
{
|
|
format: '',
|
|
type: 'block',
|
|
version: 2,
|
|
fields: {
|
|
id: '65298b13db4ef8c744a7faaa',
|
|
rel: '{{UPLOAD_DOC_ID}}',
|
|
blockName: 'Block Node, with Relationship Field',
|
|
blockType: 'relationshipBlock',
|
|
},
|
|
},
|
|
{
|
|
format: '',
|
|
type: 'block',
|
|
version: 2,
|
|
fields: {
|
|
id: '6565c8668294bf824c24d4a4',
|
|
blockName: '',
|
|
blockType: 'relationshipHasManyBlock',
|
|
rel: [
|
|
{
|
|
value: '{{TEXT_DOC_ID}}',
|
|
relationTo: 'text-fields',
|
|
},
|
|
{
|
|
value: '{{UPLOAD_DOC_ID}}',
|
|
relationTo: 'uploads',
|
|
},
|
|
],
|
|
},
|
|
},
|
|
{
|
|
format: '',
|
|
type: 'block',
|
|
version: 2,
|
|
fields: {
|
|
id: '65298b1ddb4ef8c744a7faab',
|
|
richTextField: {
|
|
root: {
|
|
type: 'root',
|
|
format: '',
|
|
indent: 0,
|
|
version: 1,
|
|
children: [
|
|
{
|
|
format: '',
|
|
type: 'relationship',
|
|
version: 2,
|
|
relationTo: 'rich-text-fields',
|
|
value: '{{RICH_TEXT_DOC_ID}}',
|
|
},
|
|
{
|
|
children: [
|
|
{
|
|
detail: 0,
|
|
format: 0,
|
|
mode: 'normal',
|
|
style: '',
|
|
text: 'Some text below relationship node 1',
|
|
type: 'text',
|
|
version: 1,
|
|
},
|
|
],
|
|
direction: 'ltr',
|
|
format: '',
|
|
indent: 0,
|
|
type: 'paragraph',
|
|
version: 1,
|
|
},
|
|
],
|
|
direction: null,
|
|
},
|
|
},
|
|
blockName: 'Block Node, with RichText Field, with Relationship Node',
|
|
blockType: 'richTextBlock',
|
|
},
|
|
},
|
|
{
|
|
format: '',
|
|
type: 'block',
|
|
version: 2,
|
|
fields: {
|
|
id: '65298b2bdb4ef8c744a7faac',
|
|
blockName: 'Block Node, with Blocks Field, With RichText Field, With Relationship Node',
|
|
blockType: 'subBlockLexical',
|
|
subBlocksLexical: [
|
|
{
|
|
id: '65298b2edb4ef8c744a7faad',
|
|
richText: {
|
|
root: {
|
|
type: 'root',
|
|
format: '',
|
|
indent: 0,
|
|
version: 1,
|
|
children: [
|
|
{
|
|
format: '',
|
|
type: 'relationship',
|
|
version: 2,
|
|
relationTo: 'text-fields',
|
|
value: '{{TEXT_DOC_ID}}',
|
|
},
|
|
{
|
|
children: [
|
|
{
|
|
detail: 0,
|
|
format: 0,
|
|
mode: 'normal',
|
|
style: '',
|
|
text: 'Some text below relationship node 2',
|
|
type: 'text',
|
|
version: 1,
|
|
},
|
|
],
|
|
direction: 'ltr',
|
|
format: '',
|
|
indent: 0,
|
|
type: 'paragraph',
|
|
version: 1,
|
|
},
|
|
],
|
|
direction: null,
|
|
},
|
|
},
|
|
blockType: 'contentBlock',
|
|
},
|
|
],
|
|
},
|
|
},
|
|
{
|
|
format: '',
|
|
type: 'block',
|
|
version: 2,
|
|
fields: {
|
|
id: '65298b49db4ef8c744a7faae',
|
|
upload: '{{UPLOAD_DOC_ID}}',
|
|
blockName: 'Block Node, With Upload Field',
|
|
blockType: 'uploadAndRichText',
|
|
},
|
|
},
|
|
{
|
|
children: [],
|
|
direction: null,
|
|
format: '',
|
|
indent: 0,
|
|
type: 'paragraph',
|
|
version: 1,
|
|
textFormat: 0,
|
|
},
|
|
{
|
|
format: '',
|
|
type: 'block',
|
|
version: 2,
|
|
fields: {
|
|
id: '65532e49fe515eb112e605a3',
|
|
blockName: 'Radio Buttons 1',
|
|
blockType: 'radioButtons',
|
|
radioButtons: 'option1',
|
|
},
|
|
},
|
|
{
|
|
format: '',
|
|
type: 'block',
|
|
version: 2,
|
|
fields: {
|
|
id: '65532e50fe515eb112e605a4',
|
|
blockName: 'Radio Buttons 2',
|
|
blockType: 'radioButtons',
|
|
radioButtons: 'option1',
|
|
},
|
|
},
|
|
{
|
|
children: [],
|
|
direction: null,
|
|
format: '',
|
|
indent: 0,
|
|
type: 'paragraph',
|
|
version: 1,
|
|
textFormat: 0,
|
|
},
|
|
{
|
|
format: '',
|
|
type: 'block',
|
|
version: 2,
|
|
fields: {
|
|
id: '65588bfa80fb5a147a378e74',
|
|
blockName: '',
|
|
blockType: 'conditionalLayout',
|
|
layout: '1',
|
|
columns: [
|
|
{
|
|
id: '65588bfb80fb5a147a378e75',
|
|
text: 'text in conditionalLayout block',
|
|
},
|
|
],
|
|
},
|
|
}, // Do not remove this blocks node. It ensures that validation passes when it's created
|
|
{
|
|
children: [],
|
|
direction: null,
|
|
format: '',
|
|
indent: 0,
|
|
type: 'paragraph',
|
|
version: 1,
|
|
textFormat: 0,
|
|
},
|
|
{
|
|
format: '',
|
|
type: 'block',
|
|
version: 2,
|
|
fields: {
|
|
id: '666c9dfd189d72626ea301f9',
|
|
blockName: '',
|
|
tab1: {
|
|
text1: 'Some text1',
|
|
},
|
|
tab2: {
|
|
text2: 'Some text2',
|
|
},
|
|
blockType: 'tabBlock',
|
|
},
|
|
},
|
|
{
|
|
format: '',
|
|
type: 'block',
|
|
version: 2,
|
|
fields: {
|
|
id: '666c9e0b189d72626ea301fa',
|
|
blockName: '',
|
|
blockType: 'code',
|
|
code: 'Some code\nhello\nworld',
|
|
},
|
|
},
|
|
],
|
|
direction: 'ltr',
|
|
},
|
|
}
|
|
}
|