@devp0nt/error0 1.0.0-next.1

package/src/index.test.ts

@@ -0,0 +1,541 @@
+import { describe, expect, it } from 'bun:test'
+import { type AxiosError, isAxiosError } from 'axios'
+import z, { ZodError } from 'zod'
+import { Error0, e0s } from './index.js'
+
+// TODO: test expected
+
+const fixStack = (stack: string | undefined) => {
+  if (!stack) {
+    return stack
+  }
+  // at <anonymous> (/Users/iserdmi/cc/projects/svagatron/modules/lib/error0.test.ts:103:25)
+  // >>
+  // at <anonymous> (...)
+  const lines = stack.split('\n')
+  const fixedLines = lines.map((line) => {
+    const withoutPath = line.replace(/\(.*\)$/, '(...)')
+    return withoutPath
+  })
+  return fixedLines.join('\n')
+}
+
+const toJSON = (error: Error0) => {
+  const result = error.toJSON()
+  result.stack = fixStack(error.stack)
+  return result
+}
+
+describe('error0', () => {
+  it('simple', () => {
+    const error0 = new Error0('test')
+    expect(error0).toBeInstanceOf(Error0)
+    expect(error0).toMatchInlineSnapshot(`[Error0: test]`)
+    expect(toJSON(error0)).toMatchInlineSnapshot(`
+      {
+        "__I_AM_ERROR_0": true,
+        "anyMessage": undefined,
+        "cause": undefined,
+        "clientMessage": undefined,
+        "code": undefined,
+        "expected": false,
+        "httpStatus": undefined,
+        "message": "test",
+        "meta": {},
+        "stack": 
+      "Error0: test
+          at <anonymous> (...)"
+      ,
+        "tag": undefined,
+      }
+    `)
+  })
+
+  it('full', () => {
+    const input = {
+      message: 'my message',
+      tag: 'tag1',
+      code: 'code1',
+      httpStatus: 400,
+      expected: true,
+      clientMessage: 'human message 1',
+      cause: new Error('original message'),
+      meta: {
+        reqDurationMs: 1,
+        userId: 'user1',
+      },
+    }
+    const error1 = new Error0(input)
+    const error2 = new Error0(input.message, input)
+    expect(toJSON(error1)).toMatchObject(toJSON(error2))
+    expect(toJSON(error1)).toMatchInlineSnapshot(`
+      {
+        "__I_AM_ERROR_0": true,
+        "anyMessage": undefined,
+        "cause": [Error: original message],
+        "clientMessage": "human message 1",
+        "code": "code1",
+        "expected": true,
+        "httpStatus": 400,
+        "message": "my message",
+        "meta": {
+          "reqDurationMs": 1,
+          "userId": "user1",
+        },
+        "stack": 
+      "Error0: my message
+          at <anonymous> (...)
+
+      Error: original message
+          at <anonymous> (...)"
+      ,
+        "tag": "tag1",
+      }
+    `)
+  })
+
+  it('cause error default', () => {
+    const errorDefault = new Error('original message')
+    const error0 = new Error0('my message', { cause: errorDefault })
+    expect(error0).toBeInstanceOf(Error0)
+    expect(error0).toMatchInlineSnapshot(`[Error0: my message]`)
+    expect(toJSON(error0)).toMatchInlineSnapshot(`
+      {
+        "__I_AM_ERROR_0": true,
+        "anyMessage": undefined,
+        "cause": [Error: original message],
+        "clientMessage": undefined,
+        "code": undefined,
+        "expected": false,
+        "httpStatus": undefined,
+        "message": "my message",
+        "meta": {},
+        "stack": 
+      "Error0: my message
+          at <anonymous> (...)
+
+      Error: original message
+          at <anonymous> (...)"
+      ,
+        "tag": undefined,
+      }
+    `)
+  })
+
+  it('cause strange thing', () => {
+    const error0 = new Error0('my message', { cause: 'strange thing' })
+    expect(error0).toMatchInlineSnapshot(`[Error0: my message]`)
+    expect(toJSON(error0)).toMatchInlineSnapshot(`
+      {
+        "__I_AM_ERROR_0": true,
+        "anyMessage": undefined,
+        "cause": "strange thing",
+        "clientMessage": undefined,
+        "code": undefined,
+        "expected": false,
+        "httpStatus": undefined,
+        "message": "my message",
+        "meta": {},
+        "stack": 
+      "Error0: my message
+          at <anonymous> (...)"
+      ,
+        "tag": undefined,
+      }
+    `)
+  })
+
+  it('floats and overrides', () => {
+    const error01 = new Error0('first', {
+      tag: 'tag1',
+      clientMessage: 'human message 1',
+      meta: {
+        reqDurationMs: 1,
+        userId: 'user1',
+      },
+    })
+    const error02 = new Error0('second', {
+      tag: 'tag2',
+      code: 'code2',
+      cause: error01,
+      meta: {
+        reqDurationMs: 1,
+        ideaId: 'idea1',
+        other: {
+          x: 1,
+        },
+      },
+    })
+    expect(error01).toBeInstanceOf(Error0)
+    expect(toJSON(error02)).toMatchInlineSnapshot(`
+      {
+        "__I_AM_ERROR_0": true,
+        "anyMessage": undefined,
+        "cause": [Error0: first],
+        "clientMessage": "human message 1",
+        "code": "code2",
+        "expected": false,
+        "httpStatus": undefined,
+        "message": "second",
+        "meta": {
+          "ideaId": "idea1",
+          "other": {
+            "x": 1,
+          },
+          "reqDurationMs": 1,
+          "userId": "user1",
+        },
+        "stack": 
+      "Error0: second
+          at <anonymous> (...)
+
+      Error0: first
+          at <anonymous> (...)"
+      ,
+        "tag": "tag2",
+      }
+    `)
+  })
+
+  it('unknown error', () => {
+    const error0 = new Error0({})
+    expect(toJSON(error0)).toMatchInlineSnapshot(`
+      {
+        "__I_AM_ERROR_0": true,
+        "anyMessage": undefined,
+        "cause": undefined,
+        "clientMessage": undefined,
+        "code": undefined,
+        "expected": false,
+        "httpStatus": undefined,
+        "message": "Unknown error",
+        "meta": {},
+        "stack": 
+      "Error0: Unknown error
+          at <anonymous> (...)"
+      ,
+        "tag": undefined,
+      }
+    `)
+    const error1 = new Error0('test')
+    expect(error1.message).toBe('test')
+    const error2 = new Error0({ cause: error1 })
+    expect(toJSON(error2)).toMatchInlineSnapshot(`
+      {
+        "__I_AM_ERROR_0": true,
+        "anyMessage": undefined,
+        "cause": [Error0: test],
+        "clientMessage": undefined,
+        "code": undefined,
+        "expected": false,
+        "httpStatus": undefined,
+        "message": "Unknown error",
+        "meta": {},
+        "stack": 
+      "Error0: Unknown error
+          at <anonymous> (...)
+
+      Error0: test
+          at <anonymous> (...)"
+      ,
+        "tag": undefined,
+      }
+    `)
+    expect(fixStack(error2.stack)).toMatchInlineSnapshot(`
+      "Error0: Unknown error
+          at <anonymous> (...)
+
+      Error0: test
+          at <anonymous> (...)"
+    `)
+  })
+
+  it('input error default', () => {
+    const errorDefault = new Error('default error')
+    const error0 = new Error0(errorDefault)
+    expect(toJSON(error0)).toMatchInlineSnapshot(`
+      {
+        "__I_AM_ERROR_0": true,
+        "anyMessage": undefined,
+        "cause": [Error: default error],
+        "clientMessage": undefined,
+        "code": undefined,
+        "expected": false,
+        "httpStatus": undefined,
+        "message": "Unknown error",
+        "meta": {},
+        "stack": 
+      "Error0: Unknown error
+          at <anonymous> (...)
+
+      Error: default error
+          at <anonymous> (...)"
+      ,
+        "tag": undefined,
+      }
+    `)
+    expect(fixStack(error0.stack)).toMatchInlineSnapshot(`
+      "Error0: Unknown error
+          at <anonymous> (...)
+
+      Error: default error
+          at <anonymous> (...)"
+    `)
+  })
+
+  it('input error0 itself', () => {
+    const error = new Error0('error0 error')
+    const error0 = new Error0(error)
+    expect(toJSON(error0)).toMatchInlineSnapshot(`
+      {
+        "__I_AM_ERROR_0": true,
+        "anyMessage": undefined,
+        "cause": [Error0: error0 error],
+        "clientMessage": undefined,
+        "code": undefined,
+        "expected": false,
+        "httpStatus": undefined,
+        "message": "Unknown error",
+        "meta": {},
+        "stack": 
+      "Error0: Unknown error
+          at <anonymous> (...)
+
+      Error0: error0 error
+          at <anonymous> (...)"
+      ,
+        "tag": undefined,
+      }
+    `)
+    expect(fixStack(error0.stack)).toMatchInlineSnapshot(`
+      "Error0: Unknown error
+          at <anonymous> (...)
+
+      Error0: error0 error
+          at <anonymous> (...)"
+    `)
+  })
+
+  it('keep stack trace', () => {
+    const errorDefault = new Error('default error')
+    const error01 = new Error0('first', {
+      tag: 'tag1',
+      clientMessage: 'human message 1',
+      cause: errorDefault,
+    })
+    const error02 = new Error0('second', {
+      tag: 'tag2',
+      code: 'code2',
+      cause: error01,
+    })
+    expect(fixStack(errorDefault.stack)).toMatchInlineSnapshot(`
+      "Error: default error
+          at <anonymous> (...)"
+    `)
+    expect(fixStack(error01.stack)).toMatchInlineSnapshot(`
+      "Error0: first
+          at <anonymous> (...)
+
+      Error: default error
+          at <anonymous> (...)"
+    `)
+    expect(fixStack(error02.stack)).toMatchInlineSnapshot(`
+      "Error0: second
+          at <anonymous> (...)
+
+      Error0: first
+          at <anonymous> (...)
+
+      Error: default error
+          at <anonymous> (...)"
+    `)
+  })
+
+  it('expected', () => {
+    const error0 = new Error0({
+      expected: true,
+    })
+    expect(error0.expected).toBe(true)
+
+    const error1 = new Error0({
+      expected: false,
+    })
+    expect(error1.expected).toBe(false)
+
+    const error3 = new Error0({
+      expected: true,
+      cause: error0,
+    })
+    expect(error3.expected).toBe(true)
+
+    const error4 = new Error0({
+      expected: false,
+      cause: error0,
+    })
+    expect(error4.expected).toBe(false)
+
+    const error5 = new Error0({
+      expected: true,
+      cause: error1,
+    })
+    expect(error5.expected).toBe(false)
+
+    const error6 = new Error0({
+      expected: false,
+      cause: error1,
+    })
+    expect(error6.expected).toBe(false)
+  })
+
+  it('extends self', () => {
+    const error7 = new e0s.Expected('expected error')
+    expect(e0s.Expected.defaultExpected).toBe(true)
+    expect(error7.expected).toBe(true)
+    expect(error7).toBeInstanceOf(e0s.Expected)
+    expect(error7).toBeInstanceOf(Error0)
+    expect(toJSON(error7)).toMatchInlineSnapshot(`
+      {
+        "__I_AM_ERROR_0": true,
+        "anyMessage": undefined,
+        "cause": undefined,
+        "clientMessage": undefined,
+        "code": undefined,
+        "expected": true,
+        "httpStatus": undefined,
+        "message": "expected error",
+        "meta": {},
+        "stack": 
+      "Error0: expected error
+          at <anonymous> (...)"
+      ,
+        "tag": undefined,
+      }
+    `)
+  })
+
+  it('extend collection', () => {
+    const e0s1 = Error0.extendCollection(e0s, {
+      defaultMessage: 'nested error',
+      defaultMeta: {
+        tagPrefix: 'nested',
+      },
+    })
+    const error0 = new e0s1.Default('nested error')
+    expect(error0).toBeInstanceOf(e0s1.Default)
+    expect(error0).toBeInstanceOf(e0s.Default)
+    expect(error0).toBeInstanceOf(Error0)
+    expect(toJSON(error0)).toMatchInlineSnapshot(`
+      {
+        "__I_AM_ERROR_0": true,
+        "anyMessage": undefined,
+        "cause": undefined,
+        "clientMessage": undefined,
+        "code": undefined,
+        "expected": false,
+        "httpStatus": undefined,
+        "message": "nested error",
+        "meta": {
+          "tagPrefix": "nested",
+        },
+        "stack": 
+      "Error0: nested error
+          at <anonymous> (...)"
+      ,
+        "tag": "nested:nested",
+      }
+    `)
+
+    const error02 = new e0s1.Expected('nested error 1')
+    expect(error02).toBeInstanceOf(e0s1.Expected)
+    expect(error02).toBeInstanceOf(e0s.Expected)
+    expect(error02).toBeInstanceOf(Error0)
+    expect(error02.expected).toBe(true)
+    expect(toJSON(error02)).toMatchInlineSnapshot(`
+      {
+        "__I_AM_ERROR_0": true,
+        "anyMessage": undefined,
+        "cause": undefined,
+        "clientMessage": undefined,
+        "code": undefined,
+        "expected": true,
+        "httpStatus": undefined,
+        "message": "nested error 1",
+        "meta": {
+          "tagPrefix": "nested",
+        },
+        "stack": 
+      "Error0: nested error 1
+          at <anonymous> (...)"
+      ,
+        "tag": "nested:nested",
+      }
+    `)
+  })
+
+  it('cause zod error', () => {
+    const zodError = z.object({ x: z.number() }).safeParse('test').error
+    if (!zodError) {
+      throw new Error('zodError is undefined')
+    }
+    expect(zodError).toBeInstanceOf(ZodError)
+    const error0 = new Error0(zodError)
+    expect(error0.zodError).toBe(zodError)
+    expect(error0.message).toBe('Unknown error')
+  })
+
+  it('from zod error', () => {
+    const zodError = z.object({ x: z.number() }).safeParse('test').error
+    if (!zodError) {
+      throw new Error('zodError is undefined')
+    }
+    expect(zodError).toBeInstanceOf(ZodError)
+    const error0 = Error0.from(zodError)
+    expect(error0.zodError).toBe(zodError)
+    expect(error0.message).toMatchInlineSnapshot(`
+      "Zod Validation Error: [
+        {
+          "expected": "object",
+          "code": "invalid_type",
+          "path": [],
+          "message": "Invalid input: expected object, received string"
+        }
+      ]"
+    `)
+  })
+
+  it('from axios error', async () => {
+    function makeFakeAxiosError(): AxiosError {
+      return {
+        isAxiosError: true,
+        name: 'AxiosError',
+        message: 'Request failed with status code 400',
+        config: {}, // can be empty for test
+        toJSON: () => ({}),
+        response: {
+          status: 400,
+          statusText: 'Bad Request',
+          headers: {},
+          config: {},
+          data: {
+            error: 'Invalid input',
+            details: ['Field X is required'],
+          },
+        },
+      } as AxiosError
+    }
+    const axiosError = makeFakeAxiosError()
+    if (!axiosError) {
+      throw new Error('axiosError is undefined')
+    }
+    expect(isAxiosError(axiosError)).toBe(true)
+    const error0 = Error0.from(axiosError)
+    expect(error0.axiosError).toBe(axiosError)
+    expect(error0.message).toBe('Axios Error')
+    expect(error0.meta).toMatchInlineSnapshot(`
+      {
+        "axiosData": "{"error":"Invalid input","details":["Field X is required"]}",
+        "axiosStatus": 400,
+      }
+    `)
+  })
+})