feat: remove client-level throwOnError

Author: soedirgo

src/PostgrestBuilder.ts

@@ -10,7 +10,7 @@ export default abstract class PostgrestBuilder<Result>
   protected headers: Record<string, string>
   protected schema?: string
   protected body?: unknown
-  protected shouldThrowOnError: boolean
+  protected shouldThrowOnError = false
   protected signal?: AbortSignal
   protected fetch: Fetch
   protected allowEmpty: boolean
@@ -39,11 +39,9 @@ export default abstract class PostgrestBuilder<Result>
    * throwing the error instead of returning it as part of a successful response.
    *
    * {@link https://github.com/supabase/supabase-js/issues/92}
-   *
-   * @deprecated Use `throwOnError` in the `PostgrestClient` constructor instead.
    */
-  throwOnError(throwOnError?: boolean): this {
-    this.shouldThrowOnError = throwOnError ?? true
+  throwOnError(): this {
+    this.shouldThrowOnError = true
     return this
   }
 

src/PostgrestClient.ts

@@ -17,8 +17,8 @@ export default class PostgrestClient<
   headers: Record<string, string>
   schema?: SchemaName
   fetch?: Fetch
-  shouldThrowOnError: boolean
 
+  // TODO: Add back shouldThrowOnError once we figure out the typings
   /**
    * Creates a PostgREST client.
    *
@@ -32,19 +32,16 @@ export default class PostgrestClient<
       headers = {},
       schema,
       fetch,
-      throwOnError = false,
     }: {
       headers?: Record<string, string>
       schema?: SchemaName
       fetch?: Fetch
-      throwOnError?: boolean
     } = {}
   ) {
     this.url = url
     this.headers = { ...DEFAULT_HEADERS, ...headers }
     this.schema = schema
     this.fetch = fetch
-    this.shouldThrowOnError = throwOnError
   }
 
   /**
@@ -73,7 +70,6 @@ export default class PostgrestClient<
       headers: { ...this.headers },
       schema: this.schema,
       fetch: this.fetch,
-      shouldThrowOnError: this.shouldThrowOnError,
     })
   }
 
@@ -132,7 +128,6 @@ export default class PostgrestClient<
       schema: this.schema,
       body,
       fetch: this.fetch,
-      shouldThrowOnError: this.shouldThrowOnError,
       allowEmpty: false,
     } as unknown as PostgrestBuilder<Function_['Returns']>)
   }

src/PostgrestQueryBuilder.ts

@@ -7,7 +7,6 @@ export default class PostgrestQueryBuilder<Table extends GenericTable> {
   url: URL
   headers: Record<string, string>
   schema?: string
-  shouldThrowOnError: boolean
   signal?: AbortSignal
   fetch?: Fetch
 
@@ -17,19 +16,16 @@ export default class PostgrestQueryBuilder<Table extends GenericTable> {
       headers = {},
       schema,
       fetch,
-      shouldThrowOnError,
     }: {
       headers?: Record<string, string>
       schema?: string
       fetch?: Fetch
-      shouldThrowOnError: boolean
     }
   ) {
     this.url = url
     this.headers = headers
     this.schema = schema
     this.fetch = fetch
-    this.shouldThrowOnError = shouldThrowOnError
   }
 
   /**
@@ -78,7 +74,6 @@ export default class PostgrestQueryBuilder<Table extends GenericTable> {
       headers: this.headers,
       schema: this.schema,
       fetch: this.fetch,
-      shouldThrowOnError: this.shouldThrowOnError,
       allowEmpty: false,
     } as unknown as PostgrestBuilder<Result>)
   }
@@ -124,7 +119,6 @@ export default class PostgrestQueryBuilder<Table extends GenericTable> {
       schema: this.schema,
       body,
       fetch: this.fetch,
-      shouldThrowOnError: this.shouldThrowOnError,
       allowEmpty: false,
     } as unknown as PostgrestBuilder<undefined>)
   }
@@ -171,7 +165,6 @@ export default class PostgrestQueryBuilder<Table extends GenericTable> {
       schema: this.schema,
       body,
       fetch: this.fetch,
-      shouldThrowOnError: this.shouldThrowOnError,
       allowEmpty: false,
     } as unknown as PostgrestBuilder<undefined>)
   }
@@ -208,7 +201,6 @@ export default class PostgrestQueryBuilder<Table extends GenericTable> {
       schema: this.schema,
       body,
       fetch: this.fetch,
-      shouldThrowOnError: this.shouldThrowOnError,
       allowEmpty: false,
     } as unknown as PostgrestBuilder<undefined>)
   }
@@ -239,7 +231,6 @@ export default class PostgrestQueryBuilder<Table extends GenericTable> {
       headers: this.headers,
       schema: this.schema,
       fetch: this.fetch,
-      shouldThrowOnError: this.shouldThrowOnError,
       allowEmpty: false,
     } as unknown as PostgrestBuilder<undefined>)
   }

test/__snapshots__/index.test.ts.snap

@@ -1393,33 +1393,6 @@ Object {
 }
 `;
 
-exports[`throwOnError can be disabled per call 1`] = `
-Object {
-  "code": "42P01",
-  "details": null,
-  "hint": null,
-  "message": "relation \\"public.missing_table\\" does not exist",
-}
-`;
-
-exports[`throwOnError setting at the client level - query 1`] = `
-Object {
-  "code": "42P01",
-  "details": null,
-  "hint": null,
-  "message": "relation \\"public.missing_table\\" does not exist",
-}
-`;
-
-exports[`throwOnError setting at the client level - rpc 1`] = `
-Object {
-  "code": "PGRST202",
-  "details": null,
-  "hint": "If a new function was created in the database with this name and parameters, try reloading the schema cache.",
-  "message": "Could not find the public.missing_fn() function or the public.missing_fn function with a single unnamed json or jsonb parameter in the schema cache",
-}
-`;
-
 exports[`throwOnError throws errors instead of returning them 1`] = `
 Object {
   "code": "42P01",

test/basic.ts

@@ -173,45 +173,45 @@ test('throwOnError throws errors instead of returning them', async () => {
   expect(isErrorCaught).toBe(true)
 })
 
-test('throwOnError setting at the client level - query', async () => {
-  let isErrorCaught = false
-  const postgrest_ = new PostgrestClient<Database>(REST_URL, { throwOnError: true })
-
-  try {
-    // @ts-expect-error missing table
-    await postgrest_.from('missing_table').select()
-  } catch (error) {
-    expect(error).toMatchSnapshot()
-    isErrorCaught = true
-  }
-
-  expect(isErrorCaught).toBe(true)
-})
-
-test('throwOnError setting at the client level - rpc', async () => {
-  let isErrorCaught = false
-  const postgrest_ = new PostgrestClient<Database>(REST_URL, { throwOnError: true })
-
-  try {
-    // @ts-expect-error missing function
-    await postgrest_.rpc('missing_fn').select()
-  } catch (error) {
-    expect(error).toMatchSnapshot()
-    isErrorCaught = true
-  }
-
-  expect(isErrorCaught).toBe(true)
-})
-
-test('throwOnError can be disabled per call', async () => {
-  let isErrorCaught = false
-  const postgrest_ = new PostgrestClient<Database>(REST_URL, { throwOnError: true })
-  // @ts-expect-error missing table
-  const { error } = await postgrest_.from('missing_table').select().throwOnError(false)
-
-  expect(error).toMatchSnapshot()
-  expect(isErrorCaught).toBe(false)
-})
+// test('throwOnError setting at the client level - query', async () => {
+//   let isErrorCaught = false
+//   const postgrest_ = new PostgrestClient<Database>(REST_URL, { throwOnError: true })
+
+//   try {
+//     // @ts-expect-error missing table
+//     await postgrest_.from('missing_table').select()
+//   } catch (error) {
+//     expect(error).toMatchSnapshot()
+//     isErrorCaught = true
+//   }
+
+//   expect(isErrorCaught).toBe(true)
+// })
+
+// test('throwOnError setting at the client level - rpc', async () => {
+//   let isErrorCaught = false
+//   const postgrest_ = new PostgrestClient<Database>(REST_URL, { throwOnError: true })
+
+//   try {
+//     // @ts-expect-error missing function
+//     await postgrest_.rpc('missing_fn').select()
+//   } catch (error) {
+//     expect(error).toMatchSnapshot()
+//     isErrorCaught = true
+//   }
+
+//   expect(isErrorCaught).toBe(true)
+// })
+
+// test('throwOnError can be disabled per call', async () => {
+//   let isErrorCaught = false
+//   const postgrest_ = new PostgrestClient<Database>(REST_URL, { throwOnError: true })
+//   // @ts-expect-error missing table
+//   const { error } = await postgrest_.from('missing_table').select().throwOnError(false)
+
+//   expect(error).toMatchSnapshot()
+//   expect(isErrorCaught).toBe(false)
+// })
 
 test('connection error w/o throwing', async () => {
   const postgrest = new PostgrestClient<Database>('http://foo.invalid')
@@ -246,7 +246,7 @@ test('maybeSingle w/ throwOnError', async () => {
     .from('messages')
     .select()
     .eq('message', 'i do not exist')
-    .throwOnError(true)
+    .throwOnError()
     .maybeSingle()
     .then(undefined, () => {
       passes = false