Move breadcrumbTitleLengthRefinement from content.config.ts to own file and add unit tests

Author: webstackdev

.cache/pages.json

@@ -22,16 +22,10 @@
   "contact",
   "offline",
   {
-    "privacy": [
-      "my-data"
-    ]
+    "privacy": ["my-data"]
   },
   {
-    "services": [
-      "consulting",
-      "overview",
-      "web-development"
-    ]
+    "services": ["consulting", "overview", "web-development"]
   },
   {
     "tags": [
@@ -53,4 +47,4 @@
       "typescript"
     ]
   }
-]
+]

src/content.config.ts

@@ -10,40 +10,12 @@
  */
 import { defineCollection, reference, z } from 'astro:content'
 import { glob, file } from 'astro/loaders'
-import { isProd } from '@lib/config/environmentServer'
 import { validTags } from '@content/_tagList'
+/** Wraps a collection schema with a refinement that enforces breadcrumb title length limits */
+import { withBreadcrumbTitleWarning } from '@lib/helpers/breadcrumbTitleLengthRefinement'
 
 const pattern = '**\/[^_]*.{md,mdx}'
 
-const MAX_BREADCRUMB_TITLE_LENGTH = 50
-const loggedBreadcrumbTitleWarnings = new Set<string>()
-
-const warnOnBreadcrumbTitleLength = (title: string, collectionName: string): void => {
-  if (!isProd()) return
-  if (title.length <= MAX_BREADCRUMB_TITLE_LENGTH) return
-
-  const warningKey = `${collectionName}:${title}`
-  if (loggedBreadcrumbTitleWarnings.has(warningKey)) return
-
-  loggedBreadcrumbTitleWarnings.add(warningKey)
-  console.warn(
-    `[Breadcrumb Warning] ${collectionName} title "${title}" is ${title.length} characters long. Titles longer than ${MAX_BREADCRUMB_TITLE_LENGTH} characters will truncate in breadcrumbs.`
-  )
-}
-
-const withBreadcrumbTitleWarning = <T extends z.ZodRawShape>(
-  schema: z.ZodObject<T>,
-  collectionName: string
-) =>
-  schema.superRefine(data => {
-    const candidateTitle = (data as { title?: string }).title
-    if (typeof candidateTitle === 'string') {
-      warnOnBreadcrumbTitleLength(candidateTitle, collectionName)
-    }
-  })
-
-// export type AboutSchema = z.infer<typeof aboutSchema>
-
 /**
  * About
  */
@@ -182,6 +154,36 @@ const contactDataCollection = defineCollection({
   schema: contactDataSchema,
 })
 
+/**
+ * Downloads
+ */
+const downloadsSchema = withBreadcrumbTitleWarning(
+  z.object({
+    title: z.string(),
+    description: z.string(),
+    author: reference('authors').optional(),
+    tags: z.array(z.enum(validTags)),
+    image: z.object({
+      src: z.string(),
+      alt: z.string(),
+    }),
+    publishDate: z.date(),
+    isDraft: z.boolean().default(false),
+    featured: z.boolean().default(false),
+    fileType: z.enum(['PDF', 'eBook', 'Whitepaper', 'Guide', 'Report', 'Template']),
+    fileSize: z.string().optional(),
+    pages: z.number().optional(),
+    readingTime: z.string().optional(),
+    fileName: z.string(), // Filename in public/downloads directory
+  }),
+  'downloads'
+)
+
+const downloadsCollection = defineCollection({
+  loader: glob({ pattern, base: './src/content/downloads' }),
+  schema: () => downloadsSchema,
+})
+
 /**
  * Services
  */
@@ -238,40 +240,6 @@ const testimonialCollection = defineCollection({
  * content system, but there's also a lack of good logical places to add such a data file.
  */
 
-/**
- * Downloads
- */
-const downloadsSchema = withBreadcrumbTitleWarning(
-  z.object({
-    title: z.string(),
-    description: z.string(),
-    author: reference('authors').optional(),
-    tags: z.array(z.enum(validTags)),
-    image: z.object({
-      src: z.string(),
-      alt: z.string(),
-    }),
-    publishDate: z.date(),
-    isDraft: z.boolean().default(false),
-    featured: z.boolean().default(false),
-    fileType: z.enum(['PDF', 'eBook', 'Whitepaper', 'Guide', 'Report', 'Template']),
-    fileSize: z.string().optional(),
-    pages: z.number().optional(),
-    readingTime: z.string().optional(),
-    fileName: z.string(), // Filename in public/downloads directory
-  }),
-  'downloads'
-)
-
-const downloadsCollection = defineCollection({
-  loader: glob({ pattern, base: './src/content/downloads' }),
-  schema: () => downloadsSchema,
-})
-
-/**
- * Contact data
- */
-
 export const collections = {
   about: aboutCollection,
   articles: articlesCollection,

src/lib/helpers/breadcrumbTitleLengthRefinement.ts

@@ -0,0 +1,39 @@
+import { z } from 'astro:content'
+import { isProd } from '@lib/config/environmentServer'
+
+const MAX_BREADCRUMB_TITLE_LENGTH = 50
+const loggedBreadcrumbTitleWarnings = new Set<string>()
+
+export const warnOnBreadcrumbTitleLength = (title: string, collectionName: string): void => {
+  if (!isProd()) return
+  if (title.length <= MAX_BREADCRUMB_TITLE_LENGTH) return
+
+  const warningKey = `${collectionName}:${title}`
+  if (loggedBreadcrumbTitleWarnings.has(warningKey)) return
+
+  loggedBreadcrumbTitleWarnings.add(warningKey)
+  console.warn(
+    `[Breadcrumb Warning] ${collectionName} title "${title}" is ${title.length} characters long. Titles longer than ${MAX_BREADCRUMB_TITLE_LENGTH} characters will truncate in breadcrumbs.`
+  )
+}
+
+/**
+ * Wraps a collection schema with a refinement that enforces breadcrumb title length limits.
+ * When a document provides a `title`, the wrapper invokes `warnOnBreadcrumbTitleLength`, which
+ * emits a console warning in production builds if the title exceeds the global maximum so long
+ * as the warning has not been logged previously for the same collection/title pair.
+ *
+ * @param schema Schema to guard with breadcrumb title validation
+ * @param collectionName Name of the collection, used to scope warning messages
+ * @returns Zod schema augmented with breadcrumb title length validation
+ */
+export const withBreadcrumbTitleWarning = <T extends z.ZodRawShape>(
+  schema: z.ZodObject<T>,
+  collectionName: string
+) =>
+  schema.superRefine(data => {
+    const candidateTitle = (data as { title?: string }).title
+    if (typeof candidateTitle === 'string') {
+      warnOnBreadcrumbTitleLength(candidateTitle, collectionName)
+    }
+  })

test/unit/helpers/__tests__/breadcrumbTitleLengthRefinement.spec.ts

@@ -0,0 +1,69 @@
+import { describe, it, expect, vi, afterEach } from 'vitest'
+import { z } from 'astro:content'
+
+const LONG_TITLE = 'A'.repeat(60)
+const SHORT_TITLE = 'Short title'
+
+const loadHelpersModule = async (isProdValue: boolean) => {
+  vi.resetModules()
+  vi.doMock('@lib/config/environmentServer', () => ({
+    isProd: () => isProdValue,
+  }))
+  return import('@lib/helpers/breadcrumbTitleLengthRefinement')
+}
+
+afterEach(() => {
+  vi.restoreAllMocks()
+})
+
+describe('warnOnBreadcrumbTitleLength', () => {
+  it('does not log warnings outside production', async () => {
+    const warnSpy = vi.spyOn(console, 'warn').mockImplementation(() => {})
+    const { warnOnBreadcrumbTitleLength } = await loadHelpersModule(false)
+
+    warnOnBreadcrumbTitleLength(LONG_TITLE, 'articles')
+
+    expect(warnSpy).not.toHaveBeenCalled()
+  })
+
+  it('does not log warnings for titles within the limit', async () => {
+    const warnSpy = vi.spyOn(console, 'warn').mockImplementation(() => {})
+    const { warnOnBreadcrumbTitleLength } = await loadHelpersModule(true)
+
+    warnOnBreadcrumbTitleLength(SHORT_TITLE, 'services')
+
+    expect(warnSpy).not.toHaveBeenCalled()
+  })
+
+  it('logs only once per unique title and collection combo', async () => {
+    const warnSpy = vi.spyOn(console, 'warn').mockImplementation(() => {})
+    const { warnOnBreadcrumbTitleLength } = await loadHelpersModule(true)
+
+    warnOnBreadcrumbTitleLength(LONG_TITLE, 'services')
+    warnOnBreadcrumbTitleLength(LONG_TITLE, 'services')
+
+    expect(warnSpy).toHaveBeenCalledTimes(1)
+  })
+})
+
+describe('withBreadcrumbTitleWarning', () => {
+  it('wraps schemas to call the warning helper for string titles', async () => {
+    const warnSpy = vi.spyOn(console, 'warn').mockImplementation(() => {})
+    const { withBreadcrumbTitleWarning } = await loadHelpersModule(true)
+
+    const baseSchema = z.object({ title: z.string().optional() })
+    const superRefineSpy = vi.spyOn(baseSchema, 'superRefine')
+
+    const augmentedSchema = withBreadcrumbTitleWarning(baseSchema, 'downloads')
+
+    expect(superRefineSpy).toHaveBeenCalledTimes(1)
+
+    const parseResult = augmentedSchema.safeParse({ title: LONG_TITLE })
+    expect(parseResult.success).toBe(true)
+
+    expect(warnSpy).toHaveBeenCalledTimes(1)
+    const [[message]] = warnSpy.mock.calls as [[string]]
+    expect(message).toContain('Breadcrumb Warning')
+    expect(message).toContain('downloads')
+  })
+})