payload 4.0.0-internal.d28e9fb → 4.0.0-internal.e16cf59

package/dist/config/sanitize.js

@@ -16,7 +16,6 @@ import { getDefaultJobsCollection, jobsCollectionSlug } from '../queues/config/c
 import { getJobStatsGlobal } from '../queues/config/global.js';
 import { flattenAllFields, flattenBlock } from '../utilities/flattenAllFields.js';
 import { hasScheduledPublishEnabled } from '../utilities/getVersionsConfig.js';
-import { endSpan, startSpan } from '../utilities/sanitizeProfiler.js';
 import { validateTimezones } from '../utilities/validateTimezones.js';
 import { getSchedulePublishTask } from '../versions/schedule/job.js';
 import { addDefaultsToConfig } from './defaults.js';
@@ -85,283 +84,263 @@ const sanitizeAdminConfig = (configToSanitize)=>{
     return sanitizedConfig;
 };
 export const sanitizeConfig = async (incomingConfig)=>{
-    const __profSpan = startSpan('sanitizeConfig');
-    try {
-        const configWithDefaults = addDefaultsToConfig(incomingConfig);
-        const config = sanitizeAdminConfig(configWithDefaults);
-        if (!config.endpoints) {
-            config.endpoints = [];
-        }
-        for (const endpoint of authRootEndpoints){
-            config.endpoints.push(endpoint);
-        }
-        if (config.localization && config.localization.locales?.length > 0) {
-            // clone localization config so to not break everything
-            const firstLocale = config.localization.locales[0];
-            if (typeof firstLocale === 'string') {
-                config.localization.localeCodes = [
-                    ...config.localization.locales
-                ];
-                // is string[], so convert to Locale[]
-                config.localization.locales = config.localization.locales.map((locale)=>({
-                        code: locale,
-                        label: locale,
-                        rtl: false,
-                        toString: ()=>locale
-                    }));
-            } else {
-                // is Locale[], so convert to string[] for localeCodes
-                config.localization.localeCodes = config.localization.locales.map((locale)=>locale.code);
-                config.localization.locales = config.localization.locales.map((locale)=>({
-                        ...locale,
-                        toString: ()=>locale.code
-                    }));
-            }
-            // Default fallback to true if not provided
-            config.localization.fallback = config.localization?.fallback ?? true;
-        }
-        const i18nConfig = {
-            fallbackLanguage: 'en',
-            supportedLanguages: {
-                en
-            },
-            translations: {}
-        };
-        if (incomingConfig?.i18n) {
-            i18nConfig.supportedLanguages = incomingConfig.i18n?.supportedLanguages || i18nConfig.supportedLanguages;
-            const supportedLangKeys = Object.keys(i18nConfig.supportedLanguages);
-            const fallbackLang = incomingConfig.i18n?.fallbackLanguage || i18nConfig.fallbackLanguage;
-            i18nConfig.fallbackLanguage = supportedLangKeys.includes(fallbackLang) ? fallbackLang : supportedLangKeys[0];
-            i18nConfig.translations = incomingConfig.i18n?.translations || i18nConfig.translations;
+    const configWithDefaults = addDefaultsToConfig(incomingConfig);
+    const config = sanitizeAdminConfig(configWithDefaults);
+    if (!config.endpoints) {
+        config.endpoints = [];
+    }
+    for (const endpoint of authRootEndpoints){
+        config.endpoints.push(endpoint);
+    }
+    if (config.localization && config.localization.locales?.length > 0) {
+        // clone localization config so to not break everything
+        const firstLocale = config.localization.locales[0];
+        if (typeof firstLocale === 'string') {
+            config.localization.localeCodes = [
+                ...config.localization.locales
+            ];
+            // is string[], so convert to Locale[]
+            config.localization.locales = config.localization.locales.map((locale)=>({
+                    code: locale,
+                    label: locale,
+                    rtl: false,
+                    toString: ()=>locale
+                }));
+        } else {
+            // is Locale[], so convert to string[] for localeCodes
+            config.localization.localeCodes = config.localization.locales.map((locale)=>locale.code);
+            config.localization.locales = config.localization.locales.map((locale)=>({
+                    ...locale,
+                    toString: ()=>locale.code
+                }));
         }
-        config.i18n = i18nConfig;
-        const richTextSanitizationPromises = [];
-        const schedulePublishCollections = [];
-        const queryPresetsCollections = [];
-        const schedulePublishGlobals = [];
-        const collectionSlugs = new Set();
-        const validRelationships = [
-            ...config.collections?.map((c)=>c.slug) ?? [],
-            jobsCollectionSlug,
-            lockedDocumentsCollectionSlug,
-            preferencesCollectionSlug
-        ];
-        const dashboardWidgets = config.admin?.dashboard?.widgets ?? [];
-        for (const widget of dashboardWidgets){
-            if (widget.fields?.length) {
-                widget.fields = await sanitizeFields({
-                    config: config,
-                    existingFieldNames: new Set(),
-                    fields: widget.fields,
-                    parentIsLocalized: false,
-                    richTextSanitizationPromises,
-                    validRelationships
-                });
-            }
+        // Default fallback to true if not provided
+        config.localization.fallback = config.localization?.fallback ?? true;
+    }
+    const i18nConfig = {
+        fallbackLanguage: 'en',
+        supportedLanguages: {
+            en
+        },
+        translations: {}
+    };
+    if (incomingConfig?.i18n) {
+        i18nConfig.supportedLanguages = incomingConfig.i18n?.supportedLanguages || i18nConfig.supportedLanguages;
+        const supportedLangKeys = Object.keys(i18nConfig.supportedLanguages);
+        const fallbackLang = incomingConfig.i18n?.fallbackLanguage || i18nConfig.fallbackLanguage;
+        i18nConfig.fallbackLanguage = supportedLangKeys.includes(fallbackLang) ? fallbackLang : supportedLangKeys[0];
+        i18nConfig.translations = incomingConfig.i18n?.translations || i18nConfig.translations;
+    }
+    config.i18n = i18nConfig;
+    const richTextSanitizationPromises = [];
+    const schedulePublishCollections = [];
+    const queryPresetsCollections = [];
+    const schedulePublishGlobals = [];
+    const collectionSlugs = new Set();
+    const validRelationships = [
+        ...config.collections?.map((c)=>c.slug) ?? [],
+        jobsCollectionSlug,
+        lockedDocumentsCollectionSlug,
+        preferencesCollectionSlug
+    ];
+    const dashboardWidgets = config.admin?.dashboard?.widgets ?? [];
+    for (const widget of dashboardWidgets){
+        if (widget.fields?.length) {
+            widget.fields = await sanitizeFields({
+                config: config,
+                existingFieldNames: new Set(),
+                fields: widget.fields,
+                parentIsLocalized: false,
+                richTextSanitizationPromises,
+                validRelationships
+            });
         }
-        /**
+    }
+    /**
    * Blocks sanitization needs to happen before collections, as collection/global join field sanitization needs config.blocks
    * to be populated with the sanitized blocks
    */ config.blocks = [];
-        if (incomingConfig.blocks?.length) {
-            for (const block of incomingConfig.blocks){
-                const sanitizedBlock = block;
-                if (sanitizedBlock._sanitized === true) {
-                    continue;
-                }
-                sanitizedBlock._sanitized = true;
-                sanitizedBlock.fields = sanitizedBlock.fields.concat(baseBlockFields);
-                sanitizedBlock.labels = !sanitizedBlock.labels ? formatLabels(sanitizedBlock.slug) : sanitizedBlock.labels;
-                sanitizedBlock.fields = await sanitizeFields({
-                    config: config,
-                    existingFieldNames: new Set(),
-                    fields: sanitizedBlock.fields,
-                    parentIsLocalized: false,
-                    richTextSanitizationPromises,
-                    validRelationships
-                });
-                const flattenedSanitizedBlock = flattenBlock({
-                    block
-                });
-                config.blocks.push(flattenedSanitizedBlock);
+    if (incomingConfig.blocks?.length) {
+        for (const block of incomingConfig.blocks){
+            const sanitizedBlock = block;
+            if (sanitizedBlock._sanitized === true) {
+                continue;
             }
+            sanitizedBlock._sanitized = true;
+            sanitizedBlock.fields = sanitizedBlock.fields.concat(baseBlockFields);
+            sanitizedBlock.labels = !sanitizedBlock.labels ? formatLabels(sanitizedBlock.slug) : sanitizedBlock.labels;
+            sanitizedBlock.fields = await sanitizeFields({
+                config: config,
+                existingFieldNames: new Set(),
+                fields: sanitizedBlock.fields,
+                parentIsLocalized: false,
+                richTextSanitizationPromises,
+                validRelationships
+            });
+            const flattenedSanitizedBlock = flattenBlock({
+                block
+            });
+            config.blocks.push(flattenedSanitizedBlock);
         }
-        // Track orderable join fields during sanitization
-        const orderableJoins = [];
-        for(let i = 0; i < config.collections.length; i++){
-            if (collectionSlugs.has(config.collections[i].slug)) {
-                throw new DuplicateCollection('slug', config.collections[i].slug);
-            }
-            collectionSlugs.add(config.collections[i].slug);
-            const draftsConfig = config.collections[i]?.versions?.drafts;
-            if (typeof draftsConfig === 'object' && draftsConfig.schedulePublish) {
-                schedulePublishCollections.push(config.collections[i].slug);
-            }
-            if (config.collections[i].enableQueryPresets) {
-                queryPresetsCollections.push(config.collections[i].slug);
-                if (!validRelationships.includes(queryPresetsCollectionSlug)) {
-                    validRelationships.push(queryPresetsCollectionSlug);
-                }
-            }
-            config.collections[i] = await sanitizeCollection(config, config.collections[i], richTextSanitizationPromises, validRelationships, orderableJoins);
+    }
+    // Track orderable join fields during sanitization
+    const orderableJoins = [];
+    for(let i = 0; i < config.collections.length; i++){
+        if (collectionSlugs.has(config.collections[i].slug)) {
+            throw new DuplicateCollection('slug', config.collections[i].slug);
         }
-        // Process orderable features after all collections are sanitized
-        const fieldsToAdd = new Map();
-        const joinFieldPathsByCollection = new Map();
-        // Handle collection.orderable
-        for (const collection of config.collections){
-            if (collection.orderable) {
-                const currentFields = fieldsToAdd.get(collection) || [];
-                fieldsToAdd.set(collection, [
-                    ...currentFields,
-                    '_order'
-                ]);
-                collection.defaultSort = collection.defaultSort ?? '_order';
-            }
+        collectionSlugs.add(config.collections[i].slug);
+        const draftsConfig = config.collections[i]?.versions?.drafts;
+        if (typeof draftsConfig === 'object' && draftsConfig.schedulePublish) {
+            schedulePublishCollections.push(config.collections[i].slug);
         }
-        // Handle orderable join fields (tracked during sanitization)
-        for (const joinInfo of orderableJoins){
-            const targetCollection = config.collections.find((c)=>c.slug === joinInfo.targetCollectionSlug);
-            if (targetCollection) {
-                const currentFields = fieldsToAdd.get(targetCollection) || [];
-                fieldsToAdd.set(targetCollection, [
-                    ...currentFields,
-                    joinInfo.orderFieldName
-                ]);
-                const currentJoinFieldPaths = joinFieldPathsByCollection.get(targetCollection.slug) || new Map();
-                currentJoinFieldPaths.set(joinInfo.orderFieldName, joinInfo.joinFieldOn);
-                joinFieldPathsByCollection.set(targetCollection.slug, currentJoinFieldPaths);
+        if (config.collections[i].enableQueryPresets) {
+            queryPresetsCollections.push(config.collections[i].slug);
+            if (!validRelationships.includes(queryPresetsCollectionSlug)) {
+                validRelationships.push(queryPresetsCollectionSlug);
             }
         }
-        // Add fields, hooks, and update flattenedFields
-        for (const [collection, orderableFields] of fieldsToAdd){
-            await addOrderableFieldsAndHook(collection, config, orderableFields, joinFieldPathsByCollection);
-            // Regenerate flattenedFields since we added new fields
-            collection.flattenedFields = flattenAllFields({
-                fields: collection.fields
-            });
+        config.collections[i] = await sanitizeCollection(config, config.collections[i], richTextSanitizationPromises, validRelationships, orderableJoins);
+    }
+    // Process orderable features after all collections are sanitized
+    const fieldsToAdd = new Map();
+    const joinFieldPathsByCollection = new Map();
+    // Handle collection.orderable
+    for (const collection of config.collections){
+        if (collection.orderable) {
+            const currentFields = fieldsToAdd.get(collection) || [];
+            fieldsToAdd.set(collection, [
+                ...currentFields,
+                '_order'
+            ]);
+            collection.defaultSort = collection.defaultSort ?? '_order';
         }
-        // Add endpoint if any orderable features exist
-        if (fieldsToAdd.size > 0) {
-            addOrderableEndpoint(config, joinFieldPathsByCollection);
+    }
+    // Handle orderable join fields (tracked during sanitization)
+    for (const joinInfo of orderableJoins){
+        const targetCollection = config.collections.find((c)=>c.slug === joinInfo.targetCollectionSlug);
+        if (targetCollection) {
+            const currentFields = fieldsToAdd.get(targetCollection) || [];
+            fieldsToAdd.set(targetCollection, [
+                ...currentFields,
+                joinInfo.orderFieldName
+            ]);
+            const currentJoinFieldPaths = joinFieldPathsByCollection.get(targetCollection.slug) || new Map();
+            currentJoinFieldPaths.set(joinInfo.orderFieldName, joinInfo.joinFieldOn);
+            joinFieldPathsByCollection.set(targetCollection.slug, currentJoinFieldPaths);
         }
-        if (config.globals.length > 0) {
-            for(let i = 0; i < config.globals.length; i++){
-                if (hasScheduledPublishEnabled(config.globals[i])) {
-                    schedulePublishGlobals.push(config.globals[i].slug);
-                }
-                config.globals[i] = await sanitizeGlobal(config, config.globals[i], richTextSanitizationPromises, validRelationships);
+    }
+    // Add fields, hooks, and update flattenedFields
+    for (const [collection, orderableFields] of fieldsToAdd){
+        await addOrderableFieldsAndHook(collection, config, orderableFields, joinFieldPathsByCollection);
+        // Regenerate flattenedFields since we added new fields
+        collection.flattenedFields = flattenAllFields({
+            fields: collection.fields
+        });
+    }
+    // Add endpoint if any orderable features exist
+    if (fieldsToAdd.size > 0) {
+        addOrderableEndpoint(config, joinFieldPathsByCollection);
+    }
+    if (config.globals.length > 0) {
+        for(let i = 0; i < config.globals.length; i++){
+            if (hasScheduledPublishEnabled(config.globals[i])) {
+                schedulePublishGlobals.push(config.globals[i].slug);
             }
+            config.globals[i] = await sanitizeGlobal(config, config.globals[i], richTextSanitizationPromises, validRelationships);
         }
-        // Resolve hierarchy relationships across collections (also adds sidebar tabs)
-        const __hierSpan = startSpan('resolveHierarchyCollections');
-        try {
-            resolveHierarchyCollections(config);
-        } finally{
-            endSpan(__hierSpan);
-        }
-        if (schedulePublishCollections.length || schedulePublishGlobals.length) {
-            ;
-            ((config.jobs ??= {}).tasks ??= []).push(getSchedulePublishTask({
-                adminUserSlug: config.admin.user,
-                collections: schedulePublishCollections,
-                globals: schedulePublishGlobals
-            }));
-        }
+    }
+    // Resolve hierarchy relationships across collections (also adds sidebar tabs)
+    resolveHierarchyCollections(config);
+    if (schedulePublishCollections.length || schedulePublishGlobals.length) {
         ;
-        (config.jobs ??= {}).enabled = Boolean(Array.isArray(configWithDefaults.jobs?.tasks) && configWithDefaults.jobs?.tasks?.length || Array.isArray(configWithDefaults.jobs?.workflows) && configWithDefaults.jobs?.workflows?.length);
-        // Need to add default jobs collection before locked documents collections
-        if (config.jobs.enabled) {
-            // Check for schedule property in both tasks and workflows
-            const hasScheduleProperty = config?.jobs?.tasks?.length && config.jobs.tasks.some((task)=>task.schedule) || config?.jobs?.workflows?.length && config.jobs.workflows.some((workflow)=>workflow.schedule);
-            if (hasScheduleProperty) {
-                config.jobs.scheduling = true;
-                (config.globals ??= []).push(await sanitizeGlobal(config, getJobStatsGlobal(config), richTextSanitizationPromises, validRelationships));
-                config.jobs.stats = true;
-            }
-            let defaultJobsCollection = getDefaultJobsCollection(config.jobs);
-            if (typeof config.jobs.jobsCollectionOverrides === 'function') {
-                defaultJobsCollection = config.jobs.jobsCollectionOverrides({
-                    defaultJobsCollection
-                });
-            }
-            const sanitizedJobsCollection = await sanitizeCollection(config, defaultJobsCollection, richTextSanitizationPromises, validRelationships);
-            (config.collections ??= []).push(sanitizedJobsCollection);
-        }
-        const lockedDocumentsCollection = getLockedDocumentsCollection(config);
-        if (lockedDocumentsCollection) {
-            configWithDefaults.collections.push(await sanitizeCollection(config, lockedDocumentsCollection, richTextSanitizationPromises, validRelationships));
-        }
-        configWithDefaults.collections.push(await sanitizeCollection(config, getPreferencesCollection(config), richTextSanitizationPromises, validRelationships));
-        const migrations = await sanitizeCollection(config, migrationsCollection, richTextSanitizationPromises, validRelationships);
-        // @ts-expect-error indexSortableFields is only valid for @payloadcms/db-mongodb
-        if (config?.db?.indexSortableFields) {
-            migrations.indexes = [
-                {
-                    fields: [
-                        'batch',
-                        'name'
-                    ],
-                    unique: false
-                }
-            ];
-        }
-        configWithDefaults.collections.push(migrations);
-        if (queryPresetsCollections.length > 0) {
-            configWithDefaults.collections.push(await sanitizeCollection(config, getQueryPresetsConfig(config), richTextSanitizationPromises, validRelationships));
+        ((config.jobs ??= {}).tasks ??= []).push(getSchedulePublishTask({
+            adminUserSlug: config.admin.user,
+            collections: schedulePublishCollections,
+            globals: schedulePublishGlobals
+        }));
+    }
+    ;
+    (config.jobs ??= {}).enabled = Boolean(Array.isArray(configWithDefaults.jobs?.tasks) && configWithDefaults.jobs?.tasks?.length || Array.isArray(configWithDefaults.jobs?.workflows) && configWithDefaults.jobs?.workflows?.length);
+    // Need to add default jobs collection before locked documents collections
+    if (config.jobs.enabled) {
+        // Check for schedule property in both tasks and workflows
+        const hasScheduleProperty = config?.jobs?.tasks?.length && config.jobs.tasks.some((task)=>task.schedule) || config?.jobs?.workflows?.length && config.jobs.workflows.some((workflow)=>workflow.schedule);
+        if (hasScheduleProperty) {
+            config.jobs.scheduling = true;
+            (config.globals ??= []).push(await sanitizeGlobal(config, getJobStatsGlobal(config), richTextSanitizationPromises, validRelationships));
+            config.jobs.stats = true;
         }
-        if (config.serverURL !== '') {
-            config.csrf.push(config.serverURL);
+        let defaultJobsCollection = getDefaultJobsCollection(config.jobs);
+        if (typeof config.jobs.jobsCollectionOverrides === 'function') {
+            defaultJobsCollection = config.jobs.jobsCollectionOverrides({
+                defaultJobsCollection
+            });
         }
-        const uploadAdapters = new Set();
-        // interact with all collections
-        for (const collection of config.collections){
-            // deduped upload adapters
-            if (collection.upload?.adapter) {
-                uploadAdapters.add(collection.upload.adapter);
+        const sanitizedJobsCollection = await sanitizeCollection(config, defaultJobsCollection, richTextSanitizationPromises, validRelationships);
+        (config.collections ??= []).push(sanitizedJobsCollection);
+    }
+    const lockedDocumentsCollection = getLockedDocumentsCollection(config);
+    if (lockedDocumentsCollection) {
+        configWithDefaults.collections.push(await sanitizeCollection(config, lockedDocumentsCollection, richTextSanitizationPromises, validRelationships));
+    }
+    configWithDefaults.collections.push(await sanitizeCollection(config, getPreferencesCollection(config), richTextSanitizationPromises, validRelationships));
+    const migrations = await sanitizeCollection(config, migrationsCollection, richTextSanitizationPromises, validRelationships);
+    // @ts-expect-error indexSortableFields is only valid for @payloadcms/db-mongodb
+    if (config?.db?.indexSortableFields) {
+        migrations.indexes = [
+            {
+                fields: [
+                    'batch',
+                    'name'
+                ],
+                unique: false
             }
+        ];
+    }
+    configWithDefaults.collections.push(migrations);
+    if (queryPresetsCollections.length > 0) {
+        configWithDefaults.collections.push(await sanitizeCollection(config, getQueryPresetsConfig(config), richTextSanitizationPromises, validRelationships));
+    }
+    if (config.serverURL !== '') {
+        config.csrf.push(config.serverURL);
+    }
+    const uploadAdapters = new Set();
+    // interact with all collections
+    for (const collection of config.collections){
+        // deduped upload adapters
+        if (collection.upload?.adapter) {
+            uploadAdapters.add(collection.upload.adapter);
         }
-        if (!config.upload) {
-            config.upload = {
-                adapters: []
-            };
-        }
-        config.upload.adapters = Array.from(new Set(config.collections.map((c)=>c.upload?.adapter).filter(Boolean)));
-        // Pass through the email config as is so adapters don't break
-        if (incomingConfig.email) {
-            config.email = incomingConfig.email;
-        }
-        /*
+    }
+    if (!config.upload) {
+        config.upload = {
+            adapters: []
+        };
+    }
+    config.upload.adapters = Array.from(new Set(config.collections.map((c)=>c.upload?.adapter).filter(Boolean)));
+    // Pass through the email config as is so adapters don't break
+    if (incomingConfig.email) {
+        config.email = incomingConfig.email;
+    }
+    /*
     Execute richText sanitization
    */ if (typeof incomingConfig.editor === 'function') {
-            const __editorSpan = startSpan('rootEditorFunction');
-            try {
-                config.editor = await incomingConfig.editor({
-                    config: config,
-                    isRoot: true,
-                    parentIsLocalized: false
-                });
-                if (config.editor.i18n && Object.keys(config.editor.i18n).length >= 0) {
-                    config.i18n.translations = deepMergeSimple(config.i18n.translations, config.editor.i18n);
-                }
-            } finally{
-                endSpan(__editorSpan);
-            }
+        config.editor = await incomingConfig.editor({
+            config: config,
+            isRoot: true,
+            parentIsLocalized: false
+        });
+        if (config.editor.i18n && Object.keys(config.editor.i18n).length >= 0) {
+            config.i18n.translations = deepMergeSimple(config.i18n.translations, config.editor.i18n);
         }
-        const promises = [];
-        for (const sanitizeFunction of richTextSanitizationPromises){
-            promises.push(sanitizeFunction(config));
-        }
-        const __richtextSpan = startSpan('richTextDeferredBatch', String(promises.length));
-        try {
-            await Promise.all(promises);
-        } finally{
-            endSpan(__richtextSpan);
-        }
-        return config;
-    } finally{
-        endSpan(__profSpan);
     }
+    const promises = [];
+    for (const sanitizeFunction of richTextSanitizationPromises){
+        promises.push(sanitizeFunction(config));
+    }
+    await Promise.all(promises);
+    return config;
 };
 
 //# sourceMappingURL=sanitize.js.map