Merge pull request #619 from supabase/avallete/psql-372-postgrest-add-maxaffected-in-client-libraries

feat: postgrest 13 add maxaffected in client libraries

Author: avallete

.github/workflows/ci.yml

@@ -18,7 +18,7 @@ jobs:
 
       - uses: actions/setup-node@v2
         with:
-          node-version: '16'
+          node-version: '20'
 
       - run: |
           npm clean-install

src/PostgrestBuilder.ts

@@ -24,23 +24,33 @@ export default abstract class PostgrestBuilder<
 {
   protected method: 'GET' | 'HEAD' | 'POST' | 'PATCH' | 'DELETE'
   protected url: URL
-  protected headers: Record<string, string>
+  protected headers: Headers
   protected schema?: string
   protected body?: unknown
   protected shouldThrowOnError = false
   protected signal?: AbortSignal
   protected fetch: Fetch
   protected isMaybeSingle: boolean
 
-  constructor(builder: PostgrestBuilder<ClientOptions, Result>) {
+  constructor(builder: {
+    method: 'GET' | 'HEAD' | 'POST' | 'PATCH' | 'DELETE'
+    url: URL
+    headers: HeadersInit
+    schema?: string
+    body?: unknown
+    shouldThrowOnError?: boolean
+    signal?: AbortSignal
+    fetch?: Fetch
+    isMaybeSingle?: boolean
+  }) {
     this.method = builder.method
     this.url = builder.url
-    this.headers = builder.headers
+    this.headers = new Headers(builder.headers)
     this.schema = builder.schema
     this.body = builder.body
-    this.shouldThrowOnError = builder.shouldThrowOnError
+    this.shouldThrowOnError = builder.shouldThrowOnError ?? false
     this.signal = builder.signal
-    this.isMaybeSingle = builder.isMaybeSingle
+    this.isMaybeSingle = builder.isMaybeSingle ?? false
 
     if (builder.fetch) {
       this.fetch = builder.fetch
@@ -66,8 +76,8 @@ export default abstract class PostgrestBuilder<
    * Set an HTTP header for the request.
    */
   setHeader(name: string, value: string): this {
-    this.headers = { ...this.headers }
-    this.headers[name] = value
+    this.headers = new Headers(this.headers)
+    this.headers.set(name, value)
     return this
   }
 
@@ -91,12 +101,12 @@ export default abstract class PostgrestBuilder<
     if (this.schema === undefined) {
       // skip
     } else if (['GET', 'HEAD'].includes(this.method)) {
-      this.headers['Accept-Profile'] = this.schema
+      this.headers.set('Accept-Profile', this.schema)
     } else {
-      this.headers['Content-Profile'] = this.schema
+      this.headers.set('Content-Profile', this.schema)
     }
     if (this.method !== 'GET' && this.method !== 'HEAD') {
-      this.headers['Content-Type'] = 'application/json'
+      this.headers.set('Content-Type', 'application/json')
     }
 
     // NOTE: Invoke w/o `this` to avoid illegal invocation error.
@@ -119,19 +129,19 @@ export default abstract class PostgrestBuilder<
           const body = await res.text()
           if (body === '') {
             // Prefer: return=minimal
-          } else if (this.headers['Accept'] === 'text/csv') {
+          } else if (this.headers.get('Accept') === 'text/csv') {
             data = body
           } else if (
-            this.headers['Accept'] &&
-            this.headers['Accept'].includes('application/vnd.pgrst.plan+text')
+            this.headers.get('Accept') &&
+            this.headers.get('Accept')?.includes('application/vnd.pgrst.plan+text')
           ) {
             data = body
           } else {
             data = JSON.parse(body)
           }
         }
 
-        const countHeader = this.headers['Prefer']?.match(/count=(exact|planned|estimated)/)
+        const countHeader = this.headers.get('Prefer')?.match(/count=(exact|planned|estimated)/)
         const contentRange = res.headers.get('content-range')?.split('/')
         if (countHeader && contentRange && contentRange.length > 1) {
           count = parseInt(contentRange[1])

src/PostgrestClient.ts

@@ -1,7 +1,5 @@
 import PostgrestQueryBuilder from './PostgrestQueryBuilder'
 import PostgrestFilterBuilder from './PostgrestFilterBuilder'
-import PostgrestBuilder from './PostgrestBuilder'
-import { DEFAULT_HEADERS } from './constants'
 import { Fetch, GenericSchema, ClientServerOptions, GetGenericDatabaseWithOptions } from './types'
 
 /**
@@ -29,7 +27,7 @@ export default class PostgrestClient<
     : any
 > {
   url: string
-  headers: Record<string, string>
+  headers: Headers
   schemaName?: SchemaName
   fetch?: Fetch
 
@@ -50,17 +48,16 @@ export default class PostgrestClient<
       schema,
       fetch,
     }: {
-      headers?: Record<string, string>
+      headers?: HeadersInit
       schema?: SchemaName
       fetch?: Fetch
     } = {}
   ) {
     this.url = url
-    this.headers = { ...DEFAULT_HEADERS, ...headers }
+    this.headers = new Headers(headers)
     this.schemaName = schema
     this.fetch = fetch
   }
-
   from<
     TableName extends string & keyof Schema['Tables'],
     Table extends Schema['Tables'][TableName]
@@ -76,7 +73,7 @@ export default class PostgrestClient<
   from(relation: string): PostgrestQueryBuilder<ClientOptions, Schema, any, any> {
     const url = new URL(`${this.url}/${relation}`)
     return new PostgrestQueryBuilder(url, {
-      headers: { ...this.headers },
+      headers: new Headers(this.headers),
       schema: this.schemaName,
       fetch: this.fetch,
     })
@@ -149,7 +146,8 @@ export default class PostgrestClient<
       : never,
     Fn['Returns'],
     FnName,
-    null
+    null,
+    'RPC'
   > {
     let method: 'HEAD' | 'GET' | 'POST'
     const url = new URL(`${this.url}/rpc/${fn}`)
@@ -170,9 +168,9 @@ export default class PostgrestClient<
       body = args
     }
 
-    const headers = { ...this.headers }
+    const headers = new Headers(this.headers)
     if (count) {
-      headers['Prefer'] = `count=${count}`
+      headers.set('Prefer', `count=${count}`)
     }
 
     return new PostgrestFilterBuilder({
@@ -181,8 +179,7 @@ export default class PostgrestClient<
       headers,
       schema: this.schemaName,
       body,
-      fetch: this.fetch,
-      allowEmpty: false,
-    } as unknown as PostgrestBuilder<ClientOptions, Fn['Returns']>)
+      fetch: this.fetch ?? fetch,
+    })
   }
 }

src/PostgrestFilterBuilder.ts

@@ -77,14 +77,16 @@ export default class PostgrestFilterBuilder<
   Row extends Record<string, unknown>,
   Result,
   RelationName = unknown,
-  Relationships = unknown
+  Relationships = unknown,
+  Method = unknown
 > extends PostgrestTransformBuilder<
   ClientOptions,
   Schema,
   Row,
   Result,
   RelationName,
-  Relationships
+  Relationships,
+  Method
 > {
   /**
    * Match only rows where `column` is equal to `value`.