Tag Name: v2.29.0
Release Date: 9/25/2024
Payload CMSPayload CMS is a modern, self-hosted headless content management system built with TypeScript, Node.js, and MongoDB. It's designed specifically for developers who want full control over their content management system while maintaining a powerful admin interface for content editors.
This release introduces a new configuration option to disable JOI validation and fixes several important bugs in the PostgreSQL database adapter, including issues with localized arrays, relationship field queries, and table name sanitization. It also improves query handling for empty strings in exists queries and updates dependencies.
exists queriesThis release doesn't require any specific migration steps. All changes are backward compatible.
If you choose to disable JOI validation using the new configuration option, make sure to thoroughly test your application first, as this will bypass schema validation that might catch potential issues with your data.
This release is recommended for all users, especially those using PostgreSQL as their database adapter or those looking for performance optimizations.
To upgrade:
npm install [email protected]
# or
yarn add [email protected]
# or
pnpm add [email protected]
Note that this release includes an update to Express 4.21.0. While this shouldn't cause any issues, it's always a good practice to test thoroughly after upgrading.
Fixed an issue where trying to append a new item to an array containing another array with localized items and enabled versions would lead to a unique _locale and _parent_id error. This fix ensures proper handling of nested arrays with localized content when versioning is enabled.
Resolved an issue with querying on arrays within relationship fields in PostgreSQL. This fix ensures that complex queries involving arrays nested within relationships work correctly.
Fixed an issue where tab and group paths were not properly sanitized for PostgreSQL table names, which could cause errors when using certain characters in field paths.
exists QueriesFixed inconsistent behavior by treating empty strings as null/undefined for exists queries. This ensures that queries like { field: { exists: false } } will correctly match documents where the field is an empty string, null, or undefined.
A new configuration option joiValidation: boolean has been added to the Payload config. When set to false, it bypasses JOI validation for all collections, globals, fields, etc. This feature can significantly improve performance in production environments where validation has already been thoroughly tested.
// In your payload.config.ts
export default buildConfig({
// ...other config
joiValidation: false, // Disable JOI validation
})
This option defaults to true to maintain backward compatibility.
No specific security fixes were included in this release.
The new joiValidation configuration option provides a significant performance improvement opportunity. By disabling JOI validation in production environments (after thorough testing), applications can reduce CPU usage and response times, especially for complex data structures with many fields and validations.
This is particularly beneficial for high-traffic applications or those running on resource-constrained environments.
Payload CMS v2.29.0 brings important improvements for both developers and content editors. The ability to disable JOI validation offers a significant performance optimization opportunity for production environments.
PostgreSQL users will benefit from several critical bug fixes that resolve issues with localized content in nested arrays, relationship field queries, and table name sanitization. These fixes ensure more reliable operation when working with complex data structures and international content.
The improvement to exists query handling ensures more consistent behavior when filtering content, treating empty strings the same as null or undefined values.
Overall, this release enhances stability and performance while maintaining backward compatibility, making it a recommended upgrade for all Payload CMS users.
exists queries (#8336) (31d0b30), closes #7714
