ox/src/core/_test/Errors.test.ts

Ethereum Standard Library

import { describe, expect, test } from 'vp/test'
import * as Errors from '../Errors.js'

test('exports', () => {
  expect(Object.keys(Errors)).toMatchInlineSnapshot(`
    [
      "BaseError",
    ]
  `)
})

describe('BaseError', () => {
  test('BaseError', () => {
    expect(new Errors.BaseError('An error occurred.')).toMatchInlineSnapshot(
      `[BaseError: An error occurred.]`,
    )

    expect(new Errors.BaseError('An error occurred.', { details: 'details' }))
      .toMatchInlineSnapshot(`
      [BaseError: An error occurred.

      Details: details]
    `)

    expect(
      new Errors.BaseError('', { details: 'details' }),
    ).toMatchInlineSnapshot(
      `
      [BaseError: An error occurred.

      Details: details]
    `,
    )
  })

  test('BaseError (w/ docsPath)', () => {
    expect(
      new Errors.BaseError('An error occurred.', {
        details: 'details',
        docsPath: '/lol',
      }),
    ).toMatchInlineSnapshot(`
      [BaseError: An error occurred.

      Details: details
      See: https://oxlib.sh/lol]
    `)
    expect(
      new Errors.BaseError('An error occurred.', {
        cause: new Errors.BaseError('error', { docsPath: '/docs' }),
      }),
    ).toMatchInlineSnapshot(`
      [BaseError: An error occurred.

      Details: error
      See: https://oxlib.sh/docs]
    `)
    expect(
      new Errors.BaseError('An error occurred.', {
        cause: new Errors.BaseError('error'),
        docsPath: '/lol',
      }),
    ).toMatchInlineSnapshot(`
      [BaseError: An error occurred.

      Details: error
      See: https://oxlib.sh/lol]
    `)
    expect(
      new Errors.BaseError('An error occurred.', {
        details: 'details',
        docsPath: '/lol',
      }),
    ).toMatchInlineSnapshot(`
      [BaseError: An error occurred.

      Details: details
      See: https://oxlib.sh/lol]
    `)
  })

  test('inherited BaseError', () => {
    const err = new Errors.BaseError('An error occurred.', {
      details: 'details',
      docsPath: '/lol',
    })
    expect(
      new Errors.BaseError('An internal error occurred.', {
        cause: err,
      }),
    ).toMatchInlineSnapshot(`
      [BaseError: An internal error occurred.

      Details: details
      See: https://oxlib.sh/lol]
    `)
  })

  test('inherited Error', () => {
    const err = new Error('details')
    expect(
      new Errors.BaseError('An internal error occurred.', {
        cause: err,
        docsPath: '/lol',
      }),
    ).toMatchInlineSnapshot(`
      [BaseError: An internal error occurred.

      Details: details
      See: https://oxlib.sh/lol]
    `)
  })

  test('inherited Error (w/ details)', () => {
    class Custom extends Error {
      details = 'details'
    }
    const err = new Custom()

    expect(
      new Errors.BaseError('An internal error occurred.', {
        cause: err,
        docsPath: '/lol',
      }),
    ).toMatchInlineSnapshot(`
      [BaseError: An internal error occurred.

      Details: details
      See: https://oxlib.sh/lol]
    `)
  })

  test('metaMessages', () => {
    expect(
      new Errors.BaseError('An internal error occurred.', {
        docsPath: '/lol',
        metaMessages: [
          '- Address must be 20 bytes long',
          '- Address must match its checksum counterpart',
        ],
      }),
    ).toMatchInlineSnapshot(`
      [BaseError: An internal error occurred.

      - Address must be 20 bytes long
      - Address must match its checksum counterpart

      See: https://oxlib.sh/lol]
    `)
  })

  test('walk: no predicate fn (walks to leaf)', () => {
    class FooError<
      cause extends Error | undefined,
    > extends Errors.BaseError<cause> {}
    class BarError extends Errors.BaseError {}

    const err = new Errors.BaseError('test1', {
      cause: new FooError('test2', { cause: new BarError('test3') }),
    })
    expect(err.walk()).toMatchInlineSnapshot(`[BaseError: test3]`)
  })

  test('walk: predicate fn', () => {
    class FooError<
      cause extends Error | undefined,
    > extends Errors.BaseError<cause> {}
    class BarError extends Errors.BaseError {}

    const err = new Errors.BaseError('test1', {
      cause: new FooError('test2', { cause: new BarError('test3') }),
    })
    expect(err.walk((err) => err instanceof FooError)).toMatchInlineSnapshot(
      `
      [BaseError: test2

      Details: test3]
    `,
    )
  })

  test('walk: predicate fn (no match)', () => {
    class FooError extends Errors.BaseError {}
    class BarError extends Errors.BaseError {}

    const err = new Errors.BaseError('test1', {
      cause: new Error('test2', { cause: new BarError('test3') }),
    })
    expect(err.walk((err) => err instanceof FooError)).toBeNull()
  })

  test('behavior: override docsBaseUrl', () => {
    class CustomError extends Errors.BaseError<Error> {
      constructor(message: string, options: Errors.BaseError.Options<Error>) {
        super(message, {
          ...options,
          docsOrigin: 'https://viem.sh',
        })
      }
    }
    const err = new CustomError('test1', {
      cause: new Error('test2'),
      docsPath: '/lol',
    })
    expect(err.message).toMatchInlineSnapshot(`
      "test1

      Details: test2
      See: https://viem.sh/lol"
    `)
  })

  test('behavior: override version', () => {
    class CustomError extends Errors.BaseError<Error> {
      constructor(message: string, options: Errors.BaseError.Options<Error>) {
        super(message, {
          ...options,
          version: 'viem@1.2.3',
        })
      }
    }
    const err = new CustomError('test1', {
      cause: new Error('test2'),
      docsPath: '/lol',
      metaMessages: [
        '- Address must be 20 bytes long',
        '- Address must match its checksum counterpart',
      ],
    })
    expect(err.message).toMatchInlineSnapshot(`
      "test1

      - Address must be 20 bytes long
      - Address must match its checksum counterpart

      Details: test2
      See: https://oxlib.sh/lol
      Version: viem@1.2.3"
    `)
    expect(err.version).toBe('viem@1.2.3')
  })

  test('properties', () => {
    const err = new Errors.BaseError('test1', {
      cause: new Error('test2'),
      docsPath: '/lol',
    })
    expect(
      Object.entries(err).reduce((acc, [key, value]) => {
        acc[key] = value
        return acc
      }, {} as any),
    ).toMatchInlineSnapshot(`
      {
        "cause": [Error: test2],
        "details": "test2",
        "docs": "https://oxlib.sh/lol",
        "docsOrigin": "https://oxlib.sh",
        "docsPath": "/lol",
        "name": "BaseError",
        "shortMessage": "test1",
        "showVersion": false,
        "version": "ox@x.y.z",
      }
    `)
  })

  test('global overrides', () => {
    Errors.BaseError.prototype.docsOrigin = 'https://viem.sh'
    Errors.BaseError.prototype.showVersion = true
    Errors.BaseError.prototype.version = 'viem@1.2.3'
    const err = new Errors.BaseError('test1', {
      cause: new Error('test2'),
      docsPath: '/lol',
    })

    expect(err.message).toMatchInlineSnapshot(`
      "test1

      Details: test2
      See: https://viem.sh/lol
      Version: viem@1.2.3"
    `)
  })
})