fix: Ensure thrown errors have a stack trace (#502)

* Ensure thrown errors have a stack trace

* chore: stricter typing

* chore: update snapshot

---------

Co-authored-by: Bobbie Soedirgo <[email protected]>

src/PostgrestBuilder.ts

@@ -2,6 +2,7 @@
 import nodeFetch from '@supabase/node-fetch'
 
 import type { Fetch, PostgrestSingleResponse } from './types'
+import PostgrestError from './PostgrestError'
 
 export default abstract class PostgrestBuilder<Result>
  implements PromiseLike<PostgrestSingleResponse<Result>>
@@ -156,7 +157,7 @@ export default abstract class PostgrestBuilder<Result>
  }
 
  if (error && this.shouldThrowOnError) {
- throw error
+ throw new PostgrestError(error)
  }
  }
 

src/PostgrestError.ts

@@ -0,0 +1,15 @@
+import type { PostgrestError as IPostgrestError } from './types'
+
+export default class PostgrestError extends Error implements IPostgrestError {
+ details: string
+ hint: string
+ code: string
+
+ constructor(context: IPostgrestError) {
+ super(context.message)
+ this.name = 'PostgrestError'
+ this.details = context.details
+ this.hint = context.hint
+ this.code = context.code
+ }
+}

test/basic.ts

@@ -631,20 +631,24 @@ test('throwOnError throws errors instead of returning them', async () => {
  try {
  await postgrest.from('missing_table').select().throwOnError()
  } catch (error) {
- expect(error).toMatchInlineSnapshot(`
- Object {
- "code": "42P01",
- "details": null,
- "hint": null,
- "message": "relation \\"public.missing_table\\" does not exist",
- }
- `)
+ expect(error).toMatchInlineSnapshot(
+ `[PostgrestError: relation "public.missing_table" does not exist]`
+ )
  isErrorCaught = true
  }
 
  expect(isErrorCaught).toBe(true)
 })
 
+test('throwOnError throws errors which include stack', async () => {
+ try {
+ await postgrest.from('does_not_exist').select().throwOnError()
+ } catch (err) {
+ expect(err instanceof Error).toBe(true)
+ expect((err as Error).stack).not.toBeUndefined()
+ }
+})
+
 // test('throwOnError setting at the client level - query', async () => {
 // let isErrorCaught = false
 // const postgrest_ = new PostgrestClient<Database>(REST_URL, { throwOnError: true })