Skip to content

The Postgres development platform. Supabase gives you a dedicated Postgres database to build your web, mobile, and AI applications.

2.8 KB
Raw Blame
import * as Sentry from '@sentry/nextjs'
import { describe, expect, it, vi } from 'vitest'

import { captureCriticalError } from './error-reporting'
import { ResponseError } from '@/types'

vi.mock('@sentry/nextjs', () => ({
  captureException: vi.fn(),
  withScope: vi.fn((cb: (scope: any) => void) => {
    const scope = { setTag: vi.fn() }
    cb(scope)
  }),
}))

describe('captureCriticalError', () => {
  it.each<[string, Parameters<typeof captureCriticalError>[0]]>([
    ['an object with an empty message', { message: '' }],
    ['an Error with an empty message', new Error('')],
    ['an object without a message', { foo: 'bar' } as unknown as { message: string }],
    ['a whitelisted message', new Error('email must be an email')],
    [
      'a message containing a whitelisted message',
      new Error('User error: A user with this email already exists in the system'),
    ],
    [
      'a whitelisted password error',
      new Error('Password is known to be weak and easy to guess, please choose a different one'),
    ],
    ['a whitelisted TOTP error', new Error('Invalid TOTP code entered')],
    ['a whitelisted project name error', new Error('name should not contain a . string')],
    ['a 4XX ResponseError', new ResponseError('Not found', 404, undefined, undefined, '/api/test')],
    [
      'a ResponseError at the 4XX boundary (499)',
      new ResponseError('Client closed request', 499, undefined, undefined, '/api/test'),
    ],
  ])('does not capture %s', (_, error) => {
    captureCriticalError(error, 'context')

    expect(Sentry.captureException).not.toHaveBeenCalled()
  })

  it.each<[string, Parameters<typeof captureCriticalError>[0], string]>([
    ['a regular Error', new Error('Database connection failed'), 'Database connection failed'],
    [
      'a message similar to, but not matching, a whitelisted one',
      new Error('email format is invalid'),
      'email format is invalid',
    ],
    ['an unknown object with a message', { message: 'Custom error object' }, 'Custom error object'],
    [
      'a ResponseError at the 5XX boundary (500)',
      new ResponseError('Internal server error', 500, undefined, undefined, '/api/test'),
      'requestPathname /api/test w/ message: Internal server error',
    ],
    [
      'a 5XX ResponseError',
      new ResponseError('Gateway timeout', 504, undefined, undefined, '/api/gateway'),
      'requestPathname /api/gateway w/ message: Gateway timeout',
    ],
    [
      'a ResponseError without code or requestPathname',
      new ResponseError('Unknown error'),
      'Response Error (no code or requestPathname) w/ message: Unknown error',
    ],
  ])('captures %s', (_, error, message) => {
    captureCriticalError(error, 'context')

    expect(Sentry.captureException).toHaveBeenCalledWith(
      expect.objectContaining({ message, name: 'CriticalError' })
    )
  })
})