perf: remove duplicative deep loops during field sanitization (#12402)

Optimizes the field sanitization process by removing duplicative deep
loops over the config. We were previously iterating over all fields of
each collection potentially multiple times in order validate field
configs, check reserved field names, etc. Now, we perform all necessary
sanitization within a single loop.

Author: jacobsfletch

packages/payload/src/collections/config/reservedFieldNames.ts

@@ -26,7 +26,6 @@ import {
   addDefaultsToCollectionConfig,
   addDefaultsToLoginWithUsernameConfig,
 } from './defaults.js'
-import { sanitizeAuthFields, sanitizeUploadFields } from './reservedFieldNames.js'
 import { sanitizeCompoundIndexes } from './sanitizeCompoundIndexes.js'
 import { validateUseAsTitle } from './useAsTitle.js'
 
@@ -43,7 +42,9 @@ export const sanitizeCollection = async (
   if (collection._sanitized) {
     return collection as SanitizedCollectionConfig
   }
+
   collection._sanitized = true
+
   // /////////////////////////////////
   // Make copy of collection config
   // /////////////////////////////////
@@ -57,7 +58,9 @@ export const sanitizeCollection = async (
   const validRelationships = _validRelationships ?? config.collections.map((c) => c.slug) ?? []
 
   const joins: SanitizedJoins = {}
+
   const polymorphicJoins: SanitizedJoin[] = []
+
   sanitized.fields = await sanitizeFields({
     collectionConfig: sanitized,
     config,
@@ -96,17 +99,21 @@ export const sanitizeCollection = async (
     // add default timestamps fields only as needed
     let hasUpdatedAt: boolean | null = null
     let hasCreatedAt: boolean | null = null
+
     sanitized.fields.some((field) => {
       if (fieldAffectsData(field)) {
         if (field.name === 'updatedAt') {
           hasUpdatedAt = true
         }
+
         if (field.name === 'createdAt') {
           hasCreatedAt = true
         }
       }
+
       return hasCreatedAt && hasUpdatedAt
     })
+
     if (!hasUpdatedAt) {
       sanitized.fields.push({
         name: 'updatedAt',
@@ -119,6 +126,7 @@ export const sanitizeCollection = async (
         label: ({ t }) => t('general:updatedAt'),
       })
     }
+
     if (!hasCreatedAt) {
       sanitized.fields.push({
         name: 'createdAt',
@@ -175,9 +183,6 @@ export const sanitizeCollection = async (
       sanitized.upload = {}
     }
 
-    // sanitize fields for reserved names
-    sanitizeUploadFields(sanitized.fields, sanitized)
-
     sanitized.upload.cacheTags = sanitized.upload?.cacheTags ?? true
     sanitized.upload.bulkUpload = sanitized.upload?.bulkUpload ?? true
     sanitized.upload.staticDir = sanitized.upload.staticDir || sanitized.slug
@@ -195,9 +200,6 @@ export const sanitizeCollection = async (
   }
 
   if (sanitized.auth) {
-    // sanitize fields for reserved names
-    sanitizeAuthFields(sanitized.fields, sanitized)
-
     sanitized.auth = addDefaultsToAuthConfig(
       typeof sanitized.auth === 'boolean' ? {} : sanitized.auth,
     )

packages/payload/src/collections/config/sanitize.ts

@@ -1,7 +1,7 @@
 import type { CollectionConfig } from '../../index.js'
 
 import { InvalidConfiguration } from '../../errors/InvalidConfiguration.js'
-import { fieldAffectsData, fieldIsVirtual } from '../../fields/config/types.js'
+import { fieldAffectsData } from '../../fields/config/types.js'
 import flattenFields from '../../utilities/flattenTopLevelFields.js'
 
 /**

packages/payload/src/collections/config/useAsTitle.ts

@@ -58,6 +58,7 @@ const sanitizeAdminConfig = (configToSanitize: Config): Partial<SanitizedConfig>
   // add default user collection if none provided
   if (!sanitizedConfig?.admin?.user) {
     const firstCollectionWithAuth = sanitizedConfig.collections.find(({ auth }) => Boolean(auth))
+
     if (firstCollectionWithAuth) {
       sanitizedConfig.admin.user = firstCollectionWithAuth.slug
     } else {
@@ -69,6 +70,7 @@ const sanitizeAdminConfig = (configToSanitize: Config): Partial<SanitizedConfig>
   const userCollection = sanitizedConfig.collections.find(
     ({ slug }) => slug === sanitizedConfig.admin.user,
   )
+
   if (!userCollection || !userCollection.auth) {
     throw new InvalidConfiguration(
       `${sanitizedConfig.admin.user} is not a valid admin user collection`,

packages/payload/src/config/sanitize.ts

@@ -2,7 +2,7 @@ import type { Config } from '../../config/types.js'
 import type { CollectionConfig, Field } from '../../index.js'
 
 import { ReservedFieldName } from '../../errors/index.js'
-import { sanitizeCollection } from './sanitize.js'
+import { sanitizeCollection } from '../../collections/config/sanitize.js'
 
 describe('reservedFieldNames - collections -', () => {
   const config = {
@@ -25,6 +25,7 @@ describe('reservedFieldNames - collections -', () => {
           label: 'some-collection',
         },
       ]
+
       await expect(async () => {
         await sanitizeCollection(
           // @ts-expect-error
@@ -53,6 +54,7 @@ describe('reservedFieldNames - collections -', () => {
           label: 'some-collection',
         },
       ]
+
       await expect(async () => {
         await sanitizeCollection(
           // @ts-expect-error
@@ -93,6 +95,7 @@ describe('reservedFieldNames - collections -', () => {
           label: 'some-collection',
         },
       ]
+
       await expect(async () => {
         await sanitizeCollection(
           // @ts-expect-error
@@ -121,6 +124,7 @@ describe('reservedFieldNames - collections -', () => {
           label: 'some-collection',
         },
       ]
+
       await expect(async () => {
         await sanitizeCollection(
           // @ts-expect-error
@@ -149,6 +153,7 @@ describe('reservedFieldNames - collections -', () => {
           label: 'some-collection',
         },
       ]
+
       await expect(async () => {
         await sanitizeCollection(
           // @ts-expect-error

packages/payload/src/collections/config/reservedFieldNames.spec.ts renamed to packages/payload/src/fields/config/reservedFieldNames.spec.ts

@@ -0,0 +1,48 @@
+/**
+ * Reserved field names for collections with auth config enabled
+ */
+export const reservedBaseAuthFieldNames = [
+  /* 'email',
+    'resetPasswordToken',
+    'resetPasswordExpiration', */
+  'salt',
+  'hash',
+]
+
+/**
+ * Reserved field names for auth collections with verify: true
+ */
+export const reservedVerifyFieldNames = [
+  /* '_verified', '_verificationToken' */
+]
+
+/**
+ * Reserved field names for auth collections with useApiKey: true
+ */
+export const reservedAPIKeyFieldNames = [
+  /* 'enableAPIKey', 'apiKeyIndex', 'apiKey' */
+]
+
+/**
+ * Reserved field names for collections with upload config enabled
+ */
+export const reservedBaseUploadFieldNames = [
+  'file',
+  /* 'mimeType',
+    'thumbnailURL',
+    'width',
+    'height',
+    'filesize',
+    'filename',
+    'url',
+    'focalX',
+    'focalY',
+    'sizes', */
+]
+
+/**
+ * Reserved field names for collections with versions enabled
+ */
+export const reservedVersionsFieldNames = [
+  /* '__v', '_status' */
+]