templates: improve speed of seed script (#9748)

Improves the speed of the seed script by moving operations to be async
and disabling revalidation on them

Author: paulpopus

templates/website/src/Footer/hooks/revalidateFooter.ts

@@ -2,10 +2,12 @@ import type { GlobalAfterChangeHook } from 'payload'
 
 import { revalidateTag } from 'next/cache'
 
-export const revalidateFooter: GlobalAfterChangeHook = ({ doc, req: { payload } }) => {
-  payload.logger.info(`Revalidating footer`)
+export const revalidateFooter: GlobalAfterChangeHook = ({ doc, req: { payload, context } }) => {
+  if (!context.disableRevalidate) {
+    payload.logger.info(`Revalidating footer`)
 
-  revalidateTag('global_footer')
+    revalidateTag('global_footer')
+  }
 
   return doc
 }

templates/website/src/Header/hooks/revalidateHeader.ts

@@ -2,10 +2,12 @@ import type { GlobalAfterChangeHook } from 'payload'
 
 import { revalidateTag } from 'next/cache'
 
-export const revalidateHeader: GlobalAfterChangeHook = ({ doc, req: { payload } }) => {
-  payload.logger.info(`Revalidating header`)
+export const revalidateHeader: GlobalAfterChangeHook = ({ doc, req: { payload, context } }) => {
+  if (!context.disableRevalidate) {
+    payload.logger.info(`Revalidating header`)
 
-  revalidateTag('global_header')
+    revalidateTag('global_header')
+  }
 
   return doc
 }

templates/website/src/app/(frontend)/next/seed/route.ts

@@ -3,7 +3,6 @@ import { seed } from '@/endpoints/seed'
 import config from '@payload-config'
 import { headers } from 'next/headers'
 
-const payloadToken = 'payload-token'
 export const maxDuration = 60 // This function can run for a maximum of 60 seconds
 
 export async function POST(

templates/website/src/collections/Pages/hooks/revalidatePage.ts

@@ -7,34 +7,37 @@ import type { Page } from '../../../payload-types'
 export const revalidatePage: CollectionAfterChangeHook<Page> = ({
   doc,
   previousDoc,
-  req: { payload },
+  req: { payload, context },
 }) => {
-  if (doc._status === 'published') {
-    const path = doc.slug === 'home' ? '/' : `/${doc.slug}`
+  if (!context.disableRevalidate) {
+    if (doc._status === 'published') {
+      const path = doc.slug === 'home' ? '/' : `/${doc.slug}`
 
-    payload.logger.info(`Revalidating page at path: ${path}`)
+      payload.logger.info(`Revalidating page at path: ${path}`)
 
-    revalidatePath(path)
-    revalidateTag('pages-sitemap')
-  }
+      revalidatePath(path)
+      revalidateTag('pages-sitemap')
+    }
 
-  // If the page was previously published, we need to revalidate the old path
-  if (previousDoc?._status === 'published' && doc._status !== 'published') {
-    const oldPath = previousDoc.slug === 'home' ? '/' : `/${previousDoc.slug}`
+    // If the page was previously published, we need to revalidate the old path
+    if (previousDoc?._status === 'published' && doc._status !== 'published') {
+      const oldPath = previousDoc.slug === 'home' ? '/' : `/${previousDoc.slug}`
 
-    payload.logger.info(`Revalidating old page at path: ${oldPath}`)
+      payload.logger.info(`Revalidating old page at path: ${oldPath}`)
 
-    revalidatePath(oldPath)
-    revalidateTag('pages-sitemap')
+      revalidatePath(oldPath)
+      revalidateTag('pages-sitemap')
+    }
   }
-
   return doc
 }
 
-export const revalidateDelete: CollectionAfterDeleteHook<Page> = ({ doc }) => {
-  const path = doc?.slug === 'home' ? '/' : `/${doc?.slug}`
-  revalidatePath(path)
-  revalidateTag('pages-sitemap')
+export const revalidateDelete: CollectionAfterDeleteHook<Page> = ({ doc, req: { context } }) => {
+  if (!context.disableRevalidate) {
+    const path = doc?.slug === 'home' ? '/' : `/${doc?.slug}`
+    revalidatePath(path)
+    revalidateTag('pages-sitemap')
+  }
 
   return doc
 }

templates/website/src/collections/Posts/hooks/revalidatePost.ts

@@ -7,35 +7,38 @@ import type { Post } from '../../../payload-types'
 export const revalidatePost: CollectionAfterChangeHook<Post> = ({
   doc,
   previousDoc,
-  req: { payload },
+  req: { payload, context },
 }) => {
-  if (doc._status === 'published') {
-    const path = `/posts/${doc.slug}`
+  if (!context.disableRevalidate) {
+    if (doc._status === 'published') {
+      const path = `/posts/${doc.slug}`
 
-    payload.logger.info(`Revalidating post at path: ${path}`)
+      payload.logger.info(`Revalidating post at path: ${path}`)
 
-    revalidatePath(path)
-    revalidateTag('posts-sitemap')
-  }
+      revalidatePath(path)
+      revalidateTag('posts-sitemap')
+    }
 
-  // If the post was previously published, we need to revalidate the old path
-  if (previousDoc._status === 'published' && doc._status !== 'published') {
-    const oldPath = `/posts/${previousDoc.slug}`
+    // If the post was previously published, we need to revalidate the old path
+    if (previousDoc._status === 'published' && doc._status !== 'published') {
+      const oldPath = `/posts/${previousDoc.slug}`
 
-    payload.logger.info(`Revalidating old post at path: ${oldPath}`)
+      payload.logger.info(`Revalidating old post at path: ${oldPath}`)
 
-    revalidatePath(oldPath)
-    revalidateTag('posts-sitemap')
+      revalidatePath(oldPath)
+      revalidateTag('posts-sitemap')
+    }
   }
-
   return doc
 }
 
-export const revalidateDelete: CollectionAfterDeleteHook<Post> = ({ doc }) => {
-  const path = `/posts/${doc?.slug}`
+export const revalidateDelete: CollectionAfterDeleteHook<Post> = ({ doc, req: { context } }) => {
+  if (!context.disableRevalidate) {
+    const path = `/posts/${doc?.slug}`
 
-  revalidatePath(path)
-  revalidateTag('posts-sitemap')
+    revalidatePath(path)
+    revalidateTag('posts-sitemap')
+  }
 
   return doc
 }