Skip to content

fix [object Object] on validation errors #118

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

fix [object Object] on validation errors #118

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ebd893c
fix object object on validation errors
remorses Jul 28, 2024
4f04203
handle error objects that don't have a message field
remorses Jul 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 17 additions & 4 deletions src/errors.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,21 @@
export class EdenFetchError<
Status extends number = number,
Value = unknown
Status = number,
Value extends any = any
> extends Error {
constructor(public status: Status, public value: Value) {
super(value + '')
value: Value
constructor(
public status: Status,
public passedValue: Value
) {
let message = String((passedValue as any)?.message || '')
if (!message) {
if (typeof passedValue === 'object') {
message = JSON.stringify(passedValue)
} else {
message = String(passedValue || '')
}
}
super(message)
this.value = passedValue
}
}
14 changes: 6 additions & 8 deletions src/treaty2/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
import type { Elysia } from 'elysia'
import { EdenWS } from './ws'
import type { IsNever, Not, Prettify } from '../types'
import { EdenFetchError } from '../errors'

type Files = File | FileList

Expand Down Expand Up @@ -198,15 +199,12 @@ export namespace Treaty {
| {
data: null
error: Exclude<keyof Res, 200> extends never
? {
status: unknown
value: unknown
}
? EdenFetchError<number, any>
: {
[Status in keyof Res]: {
status: Status
value: Res[Status]
}
[Status in keyof Res]: EdenFetchError<
Status,
Res[Status]
>
}[Exclude<keyof Res, 200>]
response: Response
status: number
Expand Down
17 changes: 17 additions & 0 deletions test/treaty2.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,16 @@ const app = new Elysia()
420: t.Literal('Snoop Dogg')
}
})
// @ts-expect-error
.get('/validationError', () => {
return 'this errors because validation is wrong'
}, {
response: {
200: t.Object({
x: t.String()
}),
}
})
.get(
'/headers',
({ headers: { username, alias } }) => ({ username, alias }),
Expand Down Expand Up @@ -512,6 +522,13 @@ describe('Treaty2', () => {
const data = await Promise.all([client.id.get(), client.id({ id: 'salty' }).get()])
expect(data.map(x => x.data)).toEqual(['unknown', 'salty'])
})
it('error is not [object Object] when there is a validation error', async () => {
const { error } = await client.validationError.get()
expect(error?.message).toBeTypeOf('string')
expect(error?.message).toBe('Expected object')
expect(error?.value).toBeTypeOf('object')
expect(error?.value?.message).toBe('Expected object')
})

})

Expand Down
129 changes: 28 additions & 101 deletions test/types/treaty2.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import { Elysia, t } from 'elysia'
import { treaty } from '../../src'
import { EdenFetchError } from '../../src/errors'
import { expectTypeOf } from 'expect-type'

const plugin = new Elysia({ prefix: '/level' })
Expand Down Expand Up @@ -165,10 +166,7 @@ type Result<T extends Function> = T extends (...args: any[]) => infer R
}
| {
data: null
error: {
status: unknown
value: unknown
}
error: EdenFetchError<number, any>
response: Response
status: number
headers: HeadersInit | undefined
Expand Down Expand Up @@ -203,10 +201,7 @@ type Result<T extends Function> = T extends (...args: any[]) => infer R
}
| {
data: null
error: {
status: unknown
value: unknown
}
error: EdenFetchError<number, any>
response: Response
status: number
headers: HeadersInit | undefined
Expand Down Expand Up @@ -241,10 +236,7 @@ type Result<T extends Function> = T extends (...args: any[]) => infer R
}
| {
data: null
error: {
status: unknown
value: unknown
}
error: EdenFetchError<number, any>
response: Response
status: number
headers: HeadersInit | undefined
Expand Down Expand Up @@ -279,10 +271,7 @@ type Result<T extends Function> = T extends (...args: any[]) => infer R
}
| {
data: null
error: {
status: unknown
value: unknown
}
error: EdenFetchError<number, any>
response: Response
status: number
headers: HeadersInit | undefined
Expand Down Expand Up @@ -317,10 +306,7 @@ type Result<T extends Function> = T extends (...args: any[]) => infer R
}
| {
data: null
error: {
status: unknown
value: unknown
}
error: EdenFetchError<number, any>
response: Response
status: number
headers: HeadersInit | undefined
Expand Down Expand Up @@ -354,10 +340,7 @@ type Result<T extends Function> = T extends (...args: any[]) => infer R
}
| {
data: null
error: {
status: unknown
value: unknown
}
error: EdenFetchError<number, any>
response: Response
status: number
headers: HeadersInit | undefined
Expand Down Expand Up @@ -391,10 +374,7 @@ type Result<T extends Function> = T extends (...args: any[]) => infer R
}
| {
data: null
error: {
status: unknown
value: unknown
}
error: EdenFetchError<number, any>
response: Response
status: number
headers: HeadersInit | undefined
Expand Down Expand Up @@ -434,10 +414,7 @@ type Result<T extends Function> = T extends (...args: any[]) => infer R
}
| {
data: null
error: {
status: unknown
value: unknown
}
error: EdenFetchError<number, any>
response: Response
status: number
headers: HeadersInit | undefined
Expand Down Expand Up @@ -473,10 +450,7 @@ type Result<T extends Function> = T extends (...args: any[]) => infer R
}
| {
data: null
error: {
status: unknown
value: unknown
}
error: EdenFetchError<number, any>
response: Response
status: number
headers: HeadersInit | undefined
Expand Down Expand Up @@ -514,10 +488,7 @@ type Result<T extends Function> = T extends (...args: any[]) => infer R
}
| {
data: null
error: {
status: unknown
value: unknown
}
error: EdenFetchError<number, any>
response: Response
status: number
headers: HeadersInit | undefined
Expand Down Expand Up @@ -555,10 +526,7 @@ type Result<T extends Function> = T extends (...args: any[]) => infer R
}
| {
data: null
error: {
status: unknown
value: unknown
}
error: EdenFetchError<number, any>
response: Response
status: number
headers: HeadersInit | undefined
Expand Down Expand Up @@ -596,10 +564,7 @@ type Result<T extends Function> = T extends (...args: any[]) => infer R
}
| {
data: null
error: {
status: unknown
value: unknown
}
error: EdenFetchError<number, any>
response: Response
status: number
headers: HeadersInit | undefined
Expand Down Expand Up @@ -635,14 +600,9 @@ type Result<T extends Function> = T extends (...args: any[]) => infer R
| {
data: null
error:
| {
status: 418
value: 'Kirifuji Nagisa'
}
| {
status: 420
value: 'Snoop Dogg'
}
| EdenFetchError<418, 'Kirifuji Nagisa'>
| EdenFetchError<420, 'Snoop Dogg'>

response: Response
status: number
headers: HeadersInit | undefined
Expand Down Expand Up @@ -680,10 +640,7 @@ type Result<T extends Function> = T extends (...args: any[]) => infer R
}
| {
data: null
error: {
status: unknown
value: unknown
}
error: EdenFetchError<number, any>
response: Response
status: number
headers: HeadersInit | undefined
Expand Down Expand Up @@ -721,10 +678,7 @@ type Result<T extends Function> = T extends (...args: any[]) => infer R
}
| {
data: null
error: {
status: unknown
value: unknown
}
error: EdenFetchError<number, any>
response: Response
status: number
headers: HeadersInit | undefined
Expand Down Expand Up @@ -765,10 +719,7 @@ type Result<T extends Function> = T extends (...args: any[]) => infer R
}
| {
data: null
error: {
status: unknown
value: unknown
}
error: EdenFetchError<number, any>
response: Response
status: number
headers: HeadersInit | undefined
Expand Down Expand Up @@ -809,10 +760,7 @@ type Result<T extends Function> = T extends (...args: any[]) => infer R
}
| {
data: null
error: {
status: unknown
value: unknown
}
error: EdenFetchError<number, any>
response: Response
status: number
headers: HeadersInit | undefined
Expand Down Expand Up @@ -856,10 +804,7 @@ type Result<T extends Function> = T extends (...args: any[]) => infer R
}
| {
data: null
error: {
status: unknown
value: unknown
}
error: EdenFetchError<number, any>
response: Response
status: number
headers: HeadersInit | undefined
Expand Down Expand Up @@ -895,14 +840,8 @@ type Result<T extends Function> = T extends (...args: any[]) => infer R
| {
data: null
error:
| {
status: 401
value: 'Himari'
}
| {
status: 418
value: 'Nagisa'
}
| EdenFetchError<401, 'Himari'>
| EdenFetchError<418, 'Nagisa'>
response: Response
status: number
headers: HeadersInit | undefined
Expand Down Expand Up @@ -934,10 +873,7 @@ type Result<T extends Function> = T extends (...args: any[]) => infer R
}
| {
data: null
error: {
status: unknown
value: unknown
}
error: EdenFetchError<number, any>
response: Response
status: number
headers: HeadersInit | undefined
Expand All @@ -962,10 +898,7 @@ type Result<T extends Function> = T extends (...args: any[]) => infer R
}
| {
data: null
error: {
status: unknown
value: unknown
}
error: EdenFetchError<number, any>
response: Response
status: number
headers: HeadersInit | undefined
Expand All @@ -992,10 +925,7 @@ type Result<T extends Function> = T extends (...args: any[]) => infer R
}
| {
data: null
error: {
status: unknown
value: unknown
}
error: EdenFetchError<number, any>
response: Response
status: number
headers: HeadersInit | undefined
Expand All @@ -1021,10 +951,7 @@ type Result<T extends Function> = T extends (...args: any[]) => infer R
}
| {
data: null
error: {
status: unknown
value: unknown
}
error: EdenFetchError<number, any>
response: Response
status: number
headers: HeadersInit | undefined
Expand Down Expand Up @@ -1113,7 +1040,7 @@ type Result<T extends Function> = T extends (...args: any[]) => infer R

// ? Return both actual value and generator if yield and return
{
const app = new Elysia().get('', async function* () {
const app = new Elysia().get('', async function* () {
if (Math.random() > 0.5) return 'a'

yield 1
Expand Down