Add custom TestError class, update test files to use it

Author: webstackdev

scripts/build/__tests__/favicon.spec.ts

@@ -2,7 +2,7 @@ import { describe, it, expect, vi, beforeEach, type Mock } from 'vitest'
 import sharp, { type Metadata } from 'sharp'
 import toIco from 'to-ico'
 import { writeFile } from 'fs/promises'
-import { UnitTestError } from '@test/errors'
+import { TestError } from '@test/errors'
 
 // Mock external dependencies
 vi.mock('sharp')
@@ -36,7 +36,7 @@ describe('favicon.ts', () => {
       // Since generateIcoFavicon is not exported, we'll create a local test
       const generateIcoFavicon = ({ width, height, density }: Partial<Metadata>) => {
         if (!width || !height || !density) {
-          throw new UnitTestError(`Required option not passed to generateIcoFavicon`)
+          throw new TestError(`Required option not passed to generateIcoFavicon`)
         }
       }
 
@@ -48,7 +48,7 @@ describe('favicon.ts', () => {
     it('should throw error when height is missing', () => {
       const generateIcoFavicon = ({ width, height, density }: Partial<Metadata>) => {
         if (!width || !height || !density) {
-          throw new UnitTestError(`Required option not passed to generateIcoFavicon`)
+          throw new TestError(`Required option not passed to generateIcoFavicon`)
         }
       }
       const metadata: Partial<Metadata> = { width: 512, density: 72 }
@@ -61,7 +61,7 @@ describe('favicon.ts', () => {
     it('should throw error when density is missing', () => {
       const generateIcoFavicon = ({ width, height, density }: Partial<Metadata>) => {
         if (!width || !height || !density) {
-          throw new UnitTestError(`Required option not passed to generateIcoFavicon`)
+          throw new TestError(`Required option not passed to generateIcoFavicon`)
         }
       }
       const metadata: Partial<Metadata> = { width: 512, height: 512 }
@@ -112,7 +112,7 @@ describe('favicon.ts', () => {
     it('should throw error when required parameters are missing', () => {
       const generatePngFavicon = ({ width, height, density }: Partial<Metadata>) => {
         if (!width || !height || !density) {
-          throw new UnitTestError(`Required option not passed to generatePngFavicon`)
+          throw new TestError(`Required option not passed to generatePngFavicon`)
         }
       }
 

src/components/CallToAction/Newsletter/__tests__/client.spec.ts

@@ -7,6 +7,7 @@ import { experimental_AstroContainer as AstroContainer } from 'astro/container'
 import { NewsletterFormElement } from '@components/CallToAction/Newsletter/client'
 import { getNewsletterElements } from '@components/CallToAction/Newsletter/selectors'
 import NewsletterFixture from '@components/CallToAction/Newsletter/__fixtures__/client.fixture.astro'
+import { TestError } from '@test/errors'
 
 /**
  * Helper function to get form elements after DOM setup
@@ -15,7 +16,7 @@ import NewsletterFixture from '@components/CallToAction/Newsletter/__fixtures__/
 function getFormElements() {
   const customElement = document.querySelector('newsletter-form')
   if (!customElement) {
-    throw new Error('newsletter-form custom element not found')
+    throw new TestError('newsletter-form custom element not found')
   }
   return getNewsletterElements(customElement)
 }

src/components/Carousel/__tests__/client.spec.ts

@@ -4,6 +4,7 @@ import { describe, it, expect, beforeEach, vi } from 'vitest'
 import { experimental_AstroContainer as AstroContainer } from 'astro/container'
 import TestCarousel from '@components/Carousel/__fixtures__/client.fixture.astro'
 import { isButtonElement } from '@components/scripts/assertions/elements'
+import { TestError } from '@test/errors'
 
 // Mock Embla Carousel and Autoplay plugin
 const mockEmblaApi = {
@@ -115,23 +116,23 @@ describe('CarouselManager', () => {
 
     it('should handle previous button click', () => {
       const prevButton = carousel.querySelector('.embla__button--prev')
-      if (!isButtonElement(prevButton)) throw new Error('Prev button not found')
+      if (!isButtonElement(prevButton)) throw new TestError('Prev button not found')
       prevButton.click()
 
       expect(mockEmblaApi.scrollPrev).toHaveBeenCalled()
     })
 
     it('should handle next button click', () => {
       const nextButton = carousel.querySelector('.embla__button--next')
-      if (!isButtonElement(nextButton)) throw new Error('Next button not found')
+      if (!isButtonElement(nextButton)) throw new TestError('Next button not found')
       nextButton.click()
 
       expect(mockEmblaApi.scrollNext).toHaveBeenCalled()
     })
 
     it('should handle dot navigation click', () => {
       const firstDot = carousel.querySelector('.embla__dot')
-      if (!isButtonElement(firstDot)) throw new Error('First dot not found')
+      if (!isButtonElement(firstDot)) throw new TestError('First dot not found')
       firstDot.click()
 
       expect(mockEmblaApi.scrollTo).toHaveBeenCalledWith(0)
@@ -147,9 +148,9 @@ describe('CarouselManager', () => {
       onSelectCallback?.()
 
       const prevButton = carousel.querySelector('.embla__button--prev')
-      if (!isButtonElement(prevButton)) throw new Error('Prev button not found')
+      if (!isButtonElement(prevButton)) throw new TestError('Prev button not found')
       const nextButton = carousel.querySelector('.embla__button--next')
-      if (!isButtonElement(nextButton)) throw new Error('Next button not found')
+      if (!isButtonElement(nextButton)) throw new TestError('Next button not found')
 
       expect(prevButton.disabled).toBe(true)
       expect(prevButton.classList.contains('opacity-30')).toBe(true)
@@ -324,9 +325,9 @@ describe('CarouselManager', () => {
       CarouselManager.init()
 
       const prevButton = carousel.querySelector('.embla__button--prev')
-      if (!isButtonElement(prevButton)) throw new Error('Prev button not found')
+      if (!isButtonElement(prevButton)) throw new TestError('Prev button not found')
       const nextButton = carousel.querySelector('.embla__button--next')
-      if (!isButtonElement(nextButton)) throw new Error('Next button not found')
+      if (!isButtonElement(nextButton)) throw new TestError('Next button not found')
 
       expect(prevButton.type).toBe('button')
       expect(nextButton.type).toBe('button')

src/components/Forms/Download/__tests__/client.spec.ts

@@ -10,6 +10,7 @@ import {
   isInputElement,
 } from '@components/scripts/assertions/elements'
 import DownloadFormComponent from '@components/Forms/Download/index.astro'
+import { TestError } from '@test/errors'
 
 // Mock the logger to suppress error output in tests
 vi.mock('@lib/logger', () => ({
@@ -42,32 +43,32 @@ async function setupDownloadFormDOM() {
 function getDownloadFormElements() {
   const form = document.getElementById('downloadForm')
   if (!isFormElement(form)) {
-    throw new Error('Download form element not found')
+    throw new TestError('Download form element not found')
   }
 
   const firstName = form.querySelector('#firstName')
   if (!isInputElement(firstName)) {
-    throw new Error('firstName input not found')
+    throw new TestError('firstName input not found')
   }
 
   const lastName = form.querySelector('#lastName')
   if (!isInputElement(lastName)) {
-    throw new Error('lastName input not found')
+    throw new TestError('lastName input not found')
   }
 
   const workEmail = form.querySelector('#workEmail')
   if (!isInputElement(workEmail)) {
-    throw new Error('workEmail input not found')
+    throw new TestError('workEmail input not found')
   }
 
   const jobTitle = form.querySelector('#jobTitle')
   if (!isInputElement(jobTitle)) {
-    throw new Error('jobTitle input not found')
+    throw new TestError('jobTitle input not found')
   }
 
   const companyName = form.querySelector('#companyName')
   if (!isInputElement(companyName)) {
-    throw new Error('companyName input not found')
+    throw new TestError('companyName input not found')
   }
 
   return {
@@ -102,7 +103,7 @@ describe('DownloadForm class', () => {
     const formElement = document.getElementById('downloadForm')
 
     if (!isFormElement(formElement)) {
-      throw new Error('Form element not found')
+      throw new TestError('Form element not found')
     }
 
     const submitSpy = vi.fn((e) => e.preventDefault())
@@ -129,7 +130,7 @@ describe('DownloadForm class', () => {
     // Fill out the form
     const formElement = document.getElementById('downloadForm')
     if (!isFormElement(formElement)) {
-      throw new Error('Form element not found')
+      throw new TestError('Form element not found')
     }
 
     const firstNameInput = formElement.querySelector('#firstName')
@@ -141,7 +142,7 @@ describe('DownloadForm class', () => {
     if (!isInputElement(firstNameInput) || !isInputElement(lastNameInput) ||
         !isInputElement(emailInput) || !isInputElement(jobTitleInput) ||
         !isInputElement(companyInput)) {
-      throw new Error('Form inputs not found')
+      throw new TestError('Form inputs not found')
     }
 
     firstNameInput.value = 'John'
@@ -261,7 +262,7 @@ describe('DownloadForm class', () => {
     const { form: formElement, firstName, lastName, workEmail, jobTitle, companyName } = getDownloadFormElements()
     const submitBtn = document.getElementById('downloadSubmitBtn')
     if (!submitBtn || !(submitBtn instanceof HTMLButtonElement)) {
-      throw new Error('Submit button not found')
+      throw new TestError('Submit button not found')
     }
 
     // Fill form

src/components/GDPR/Consent/__tests__/client.spec.ts

@@ -10,6 +10,7 @@ import {
 } from '@components/GDPR/Consent/client'
 import { $formConsent, clearFormConsent, type ConsentPurpose } from '@components/GDPR/Consent/state'
 import { isInputElement, isDivElement } from '@components/scripts/assertions/elements'
+import { TestError } from '@test/errors'
 
 /**
  * Helper to create mock GDPR consent HTML structure in a form
@@ -38,12 +39,12 @@ function setupConsentForm(checkboxId = 'gdpr-consent'): HTMLFormElement {
 function getConsentElements(checkboxId = 'gdpr-consent') {
   const checkbox = document.getElementById(checkboxId)
   if (!isInputElement(checkbox)) {
-    throw new Error(`Checkbox with id "${checkboxId}" not found`)
+    throw new TestError(`Checkbox with id "${checkboxId}" not found`)
   }
 
   const errorElement = document.getElementById(`${checkboxId}-error`)
   if (!isDivElement(errorElement)) {
-    throw new Error(`Error element with id "${checkboxId}-error" not found`)
+    throw new TestError(`Error element with id "${checkboxId}-error" not found`)
   }
 
   return { checkbox, errorElement }

src/components/scripts/bootstrap/__tests__/index.spec.ts

@@ -7,6 +7,7 @@ import { describe, it, expect, beforeEach, vi } from 'vitest'
 import { AppBootstrap } from '@components/scripts/bootstrap'
 import { ClientScriptError } from '@components/scripts/errors/ClientScriptError'
 import { addScriptBreadcrumb } from '@components/scripts/errors'
+import { TestError } from '@test/errors'
 
 // Mock the store initialization functions
 vi.mock('@components/scripts/store', () => ({
@@ -124,7 +125,7 @@ describe('AppBootstrap', () => {
     it('should not call side effects when initConsentFromCookies fails', () => {
       vi.mocked(addViewTransitionThemeInitListener).mockReturnValue(undefined)
       vi.mocked(initConsentFromCookies).mockImplementation(() => {
-        throw new Error('Cookie initialization failed')
+        throw new TestError('Cookie initialization failed')
       })
       vi.mocked(initConsentSideEffects).mockReturnValue(undefined)
 

src/components/scripts/errors/__tests__/ClientScriptError.spec.ts

@@ -3,14 +3,15 @@
  */
 import { describe, expect, test } from 'vitest'
 import type { Constructor } from '@test/unit/matchers/assertions'
+import { TestError } from '@test/errors'
 import { ClientScriptError, isClientScriptError } from '@components/scripts/errors'
 
 describe(`ClientScriptError class is constructible`, () => {
   test(`Class is properly constructed`, () => {
     try {
       throw new ClientScriptError(`It went bad!`)
     } catch (err) {
-      if (!isClientScriptError(err)) throw new Error()
+      if (!isClientScriptError(err)) throw new TestError(`Expected ClientScriptError to be thrown`)
       // The name property should be set to the error`s name
       expect(err.name).toBe(`ClientScriptError`)
 

src/components/scripts/errors/__tests__/converters.spec.ts

@@ -3,6 +3,7 @@
  * Tests for error converters to ClientScriptError
  */
 import { describe, expect, test } from 'vitest'
+import { TestError } from '@test/errors'
 import { ClientScriptError } from '@components/scripts/errors/ClientScriptError'
 import {
   convertFromError,
@@ -20,9 +21,9 @@ const voidFn = () => {}
 
 describe(`extractMetadaFromStackTrace correctly pulls metadata from stack trace`, () => {
   test(`extractMetadaFromStackTrace gets correct metadata`, () => {
-    const err = new Error(`test error`)
+    const err = new TestError(`test error`)
     const stack = err.stack
-    if (!isString(stack)) throw new Error()
+    if (!isString(stack)) throw new TestError(`Expected stack to be a string`)
     const sut = extractMetadaFromStackTrace(stack)
     expect(sut).toEqual(
       expect.objectContaining({

src/integrations/PrivacyPolicyVersion/__tests__/index.spec.ts

@@ -1,5 +1,6 @@
 import { describe, it, expect, beforeEach, afterEach, vi } from 'vitest'
 import { execSync } from 'node:child_process'
+import { TestError } from '@test/errors'
 
 // Mock child_process
 vi.mock('node:child_process', () => ({
@@ -91,7 +92,7 @@ describe('PrivacyPolicyVersion Integration', () => {
     it('should use current date as fallback when git command fails', async () => {
       // Mock git command failure
       vi.mocked(execSync).mockImplementation(() => {
-        throw new Error('Git command failed')
+        throw new TestError('Git command failed')
       })
 
       const { privacyPolicyVersion } = await import('../index')

src/lib/errors/__tests__/BuildError.spec.ts

@@ -2,14 +2,15 @@
  * Tests for error handling routines and custom errors
  */
 import { describe, expect, test } from 'vitest'
+import { TestError } from '@test/errors'
 import { BuildError, isBuildError } from '@lib/errors/BuildError'
 
 describe(`BuildError class is constructible`, () => {
   test(`Class is properly constructed`, () => {
     try {
       throw new BuildError(`Test error`)
     } catch (err) {
-      if (!isBuildError(err)) throw new Error()
+      if (!isBuildError(err)) throw new TestError(`Expected BuildError to be thrown`)
       // The name property should be set to the error`s name
       expect(err.name).toBe(`BuildError`)