feat(worker/tasks): ✨ Add website revalidation task

Author: Nudelsuppe42

apps/frontend/next-env.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="next" />
 /// <reference types="next/image-types/global" />
-import './.next/types/routes.d.ts'
+import './.next/dev/types/routes.d.ts'
 
 // NOTE: This file should not be edited
 // see https://nextjs.org/docs/app/api-reference/config/typescript for more information.

apps/worker/src/lib/config.ts

@@ -2,8 +2,6 @@
  * Static constant configuration values
  */
 
-import { remove } from 'winston'
-
 export const config = {
 	// The number of worker threads to spawn for processing background jobs
 	workerThreadCount: 5,

apps/worker/src/lib/website.ts

@@ -0,0 +1,23 @@
+export async function revalidateWebsitePage(
+	paths: string[] = [],
+	tags: string[] = [],
+): Promise<{ revalidated: boolean }> {
+	try {
+		const res = await fetch(process.env.FRONTEND_URL + '/api/revalidate', {
+			method: 'POST',
+			headers: {
+				'Content-Type': 'application/json',
+				'User-Agent': 'BuildTheEarth Worker',
+				Accept: 'application/json',
+				Authorization: `Bearer ${process.env.FRONTEND_SECRET}`,
+			},
+			body: JSON.stringify({ paths, tags }),
+		})
+
+		const data = await res.json()
+		return { revalidated: data.revalidated || res.ok }
+	} catch (e: any) {
+		console.error(e)
+		return { revalidated: false }
+	}
+}

apps/worker/src/tasks/index.ts

@@ -8,6 +8,7 @@ import { SyncClaimOsmTask } from './claims/syncClaimOsm.task'
 import { SendDiscordDmTask } from './discord/sendDm.task'
 import { SendDiscordLogTask } from './discord/sendLog.task'
 import { SyncDiscordRolesTask } from './discord/syncDiscordRoles.task'
+import { RevalidateWebsitePageTask } from './website/revalidatePage.task'
 
 export const taskRegistry: Record<string, BaseTask> = {}
 
@@ -24,3 +25,4 @@ register(new PurgeVerificationsTask())
 register(new RemindApplicationsTask())
 register(new SyncClaimOsmTask())
 register(new SyncDiscordRolesTask())
+register(new RevalidateWebsitePageTask())

apps/worker/src/tasks/website/revalidatePage.task.ts

@@ -0,0 +1,34 @@
+import { Job } from 'bullmq'
+import { z } from 'zod'
+import { revalidateWebsitePage } from '../../lib/website'
+import { BaseTask } from '../base.task'
+
+const revalidateWebsitePagePayloadSchema = z.object({
+	paths: z.array(z.string()).optional(),
+	tags: z.array(z.string()).optional(),
+})
+
+type RevalidateWebsitePagePayload = z.infer<typeof revalidateWebsitePagePayloadSchema>
+
+/**
+ * This task sends a revalidation request to the frontend server for specific website pages. It can either revalidate specific paths or whole tags.
+ * @summary Revalidates specific website pages
+ */
+export class RevalidateWebsitePageTask extends BaseTask<typeof revalidateWebsitePagePayloadSchema> {
+	readonly name = 'REVALIDATE_WEBSITE'
+	readonly schema = revalidateWebsitePagePayloadSchema
+
+	async execute(data: RevalidateWebsitePagePayload, job: Job) {
+		const { paths, tags } = data
+
+		if (paths && paths.length < 1 && tags && tags.length < 1) {
+			return
+		}
+
+		const { revalidated } = await revalidateWebsitePage(paths, tags)
+
+		if (!revalidated) {
+			throw new Error('Failed to revalidate website page')
+		}
+	}
+}

packages/shared/src/utils/redis/redisEvents.ts

@@ -7,6 +7,7 @@ export enum RedisEvent {
 	BUILDTEAM_WEBHOOK = 'BUILDTEAM_WEBHOOK',
 	SYNC_CLAIM_OSM = 'SYNC_CLAIM_OSM',
 	SYNC_DISCORD_ROLES = 'SYNC_DISCORD_ROLES',
+	REVALIDATE_WEBSITE = 'REVALIDATE_WEBSITE',
 }
 
 /**