Payload CMS Release: Release v2.11.1

TL;DR

Payload CMS v2.11.1 brings significant improvements to the rich text editor with Lexical updates, database enhancements for PostgreSQL and MongoDB, and fixes for transaction handling. The most notable change is the update of Lexical from v0.12.6 to v0.13.1, which is a breaking change requiring attention from developers using custom Lexical implementations.

Highlight of the Release

• Lexical rich text editor updated from v0.12.6 to v0.13.1 with significant improvements
• PostgreSQL database adapter now supports UUID as primary key type
• Automatic reconnection for PostgreSQL database connections
• Text justify alignment added to rich text editor
• Improved transaction handling across multiple plugins

Migration Guide

Migrating to Lexical v0.13.1

1. Update Package Versions: Ensure all installed Lexical packages match v0.13.1 to avoid React context errors:

   npm install @lexical/[email protected] [email protected]
   # or with yarn
   yarn add @lexical/[email protected] [email protected]
   # or with pnpm
   pnpm add @lexical/[email protected] [email protected]
   

2. API Changes: Review your custom Lexical implementations for API changes:

   • The INTERNAL_isPointSelection method has been removed
   • Check the Lexical changelog for other API changes

3. Testing: Thoroughly test your rich text editor implementations after upgrading to ensure compatibility

PostgreSQL UUID Support

If you want to use UUID as primary key type in PostgreSQL:

import { postgresAdapter } from '@payloadcms/db-postgres';

const payload = await buildPayload({
  db: postgresAdapter({
    pool: pgPool,
    idType: 'uuid' // Use 'uuid' instead of default 'serial'
  }),
  // other config
});

Upgrade Recommendations

Priority: Medium-High

This release is recommended for all Payload CMS users, especially those using:

• Rich text editor with Lexical
• PostgreSQL database adapter
• Form builder or search plugins

For Lexical Users: This is a critical update due to the breaking change in Lexical version. You should plan to update all related Lexical packages to v0.13.1 as part of this upgrade.

For PostgreSQL Users: The reconnection feature and UUID support provide significant improvements that enhance reliability and flexibility.

Upgrade Steps:

1. Update Payload CMS to v2.11.1
2. Update any Lexical-related packages to v0.13.1
3. Test your rich text editor implementations thoroughly
4. Review any custom code that interacts with the database or transactions

Bug Fixes

Database Fixes

• MongoDB: Fixed versions pagination in find operations
• PostgreSQL: Fixed querying using blockType in block collections
• Transactions: Fixed issue where filterOptions errors would cause transactions to abort
• MongoDB: Fixed uncaught abortTransaction race condition

Rich Text Editor Fixes

• Node Handling: Fixed issue where adjacent paragraph nodes were being removed when inserting certain nodes in an empty editor

Plugin and Core Fixes

• Form Builder: Fixed hooks not respecting transactions
• Uploads: Fixed external file retrieval to properly account for serverURL
• Core: Removed collection findByID caching to prevent stale data issues

New Features

Rich Text Editor Enhancements

• Lexical Update: Updated from v0.12.6 to v0.13.1 with improvements ported from the Lexical playground
• Justify Alignment: Added text justify alignment option to the AlignFeature component
• Block Handling: Improved AddBlock handle to work with all nodes, not just empty paragraphs

Database Improvements

• PostgreSQL UUID Support: Added idType option to use UUID or serial ID columns in PostgreSQL
• PostgreSQL Reconnection: Automatic reconnection after disconnection from PostgreSQL database
• Transaction Support: Added req parameter to beforeSync args in search plugin for transaction support

Plugin Enhancements

• Search Plugin: Improved transaction handling with req parameter in beforeSync hooks
• Cloud Storage: Added testing support for LocalStack emulator

Security Updates

No specific security fixes were mentioned in this release.

Performance Improvements

Database Performance

• Improved PostgreSQL connection handling with automatic reconnection capability, reducing downtime and connection errors
• Optimized transaction handling across plugins to ensure data consistency

Rich Text Editor Performance

• The update to Lexical v0.13.1 includes performance improvements from the Lexical core library
• Better block handling improves editor responsiveness when working with different node types

Impact Summary

Payload CMS v2.11.1 delivers significant improvements to the rich text editor through the Lexical update, enhances database capabilities with PostgreSQL UUID support and automatic reconnection, and fixes several critical issues related to transaction handling.

The most impactful change is the update to Lexical v0.13.1, which brings improved editor functionality but requires attention from developers using custom Lexical implementations. This update is considered breaking for the rich text editor, requiring matching versions across all Lexical packages.

Database improvements make the system more robust with automatic PostgreSQL reconnection and better transaction handling across plugins. Content editors will appreciate the addition of text justify alignment and improved block handling in the rich text editor.

Overall, this release focuses on stability, feature enhancement, and developer experience improvements while maintaining backward compatibility except for the noted Lexical update.

Full Release Notes