refactor: extract applySettingsDefault to helper

Author: [email protected]

src/SupabaseClient.ts

@@ -9,7 +9,7 @@ import { RealtimeChannel, RealtimeClient, RealtimeClientOptions } from '@supabas
 import { StorageClient as SupabaseStorageClient } from '@supabase/storage-js'
 import { DEFAULT_HEADERS } from './lib/constants'
 import { fetchWithAuth } from './lib/fetch'
-import { stripTrailingSlash } from './lib/helpers'
+import { stripTrailingSlash, applySettingDefaults } from './lib/helpers'
 import { SupabaseAuthClient } from './lib/SupabaseAuthClient'
 import { SupabaseRealtimeChannel } from './lib/SupabaseRealtimeChannel'
 import { Fetch, GenericSchema, SupabaseClientOptions, SupabaseAuthClientOptions } from './lib/types'
@@ -105,7 +105,7 @@ export default class SupabaseClient<
       global: DEFAULT_GLOBAL_OPTIONS,
     }
 
-    const settings = this._applySettingDefaults(options || {}, DEFAULTS)
+    const settings = applySettingDefaults(options || {}, DEFAULTS)
 
     this.storageKey = settings.auth?.storageKey ?? ''
     this.headers = settings.global?.headers ?? {}
@@ -336,42 +336,4 @@ export default class SupabaseClient<
       if (source == 'STORAGE') this.auth.signOut()
     }
   }
-
-  // TODO(Joel): Figure out how to properly type this
-  private _applySettingDefaults(
-    options: SupabaseClientOptions<SchemaName>,
-    defaults: any
-  ): SupabaseClientOptions<SchemaName> {
-    const {
-      db: dbOptions,
-      auth: authOptions,
-      realtime: realtimeOptions,
-      global: globalOptions,
-    } = options
-    const {
-      db: DEFAULT_DB_OPTIONS,
-      auth: DEFAULT_AUTH_OPTIONS,
-      realtime: DEFAULT_REALTIME_OPTIONS,
-      global: DEFAULT_GLOBAL_OPTIONS,
-    } = defaults
-
-    return {
-      db: {
-        ...DEFAULT_DB_OPTIONS,
-        ...dbOptions,
-      },
-      auth: {
-        ...DEFAULT_AUTH_OPTIONS,
-        ...authOptions,
-      },
-      realtime: {
-        ...DEFAULT_REALTIME_OPTIONS,
-        ...realtimeOptions,
-      },
-      global: {
-        ...DEFAULT_GLOBAL_OPTIONS,
-        ...globalOptions,
-      },
-    }
-  }
 }

src/lib/helpers.ts

@@ -13,3 +13,40 @@ export function stripTrailingSlash(url: string): string {
 }
 
 export const isBrowser = () => typeof window !== 'undefined'
+
+export function applySettingDefaults(
+  options: SupabaseClientOptions<SchemaName>,
+  defaults: SupabaseClientOptions<any>
+): SupabaseClientOptions<SchemaName> {
+  const {
+    db: dbOptions,
+    auth: authOptions,
+    realtime: realtimeOptions,
+    global: globalOptions,
+  } = options
+  const {
+    db: DEFAULT_DB_OPTIONS,
+    auth: DEFAULT_AUTH_OPTIONS,
+    realtime: DEFAULT_REALTIME_OPTIONS,
+    global: DEFAULT_GLOBAL_OPTIONS,
+  } = defaults
+
+  return {
+    db: {
+      ...DEFAULT_DB_OPTIONS,
+      ...dbOptions,
+    },
+    auth: {
+      ...DEFAULT_AUTH_OPTIONS,
+      ...authOptions,
+    },
+    realtime: {
+      ...DEFAULT_REALTIME_OPTIONS,
+      ...realtimeOptions,
+    },
+    global: {
+      ...DEFAULT_GLOBAL_OPTIONS,
+      ...globalOptions,
+    },
+  }
+}

test/helpers.test.ts

@@ -1,5 +1,39 @@
 import * as helpers from '../src/lib/helpers'
+import { DEFAULT_HEADERS } from '../src/lib/constants'
 
 test('uuid', async () => {
   expect(helpers.uuid()).toMatch(/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/)
 })
+
+test('override setting defaults', async () => {
+  const DEFAULT_GLOBAL_OPTIONS = {
+    headers: DEFAULT_HEADERS,
+  }
+
+  const DEFAULT_DB_OPTIONS = {
+    schema: 'public',
+  }
+
+  const DEFAULT_AUTH_OPTIONS = {
+    autoRefreshToken: true,
+    persistSession: true,
+    detectSessionInUrl: true,
+  }
+
+  let defaults = {
+    db: DEFAULT_DB_OPTIONS,
+    auth: DEFAULT_AUTH_OPTIONS,
+    global: DEFAULT_GLOBAL_OPTIONS,
+  }
+
+  let autoRefreshOption = false
+  let options = {
+    auth: {
+      autoRefreshToken: autoRefreshOption,
+    },
+  }
+  let settings = helpers.applySettingDefaults(options, defaults)
+  expect(settings.auth.autoRefreshToken).toBe(autoRefreshOption)
+  expect(settings.auth.persistSession).not.toBeNull()
+  expect(settings.db.schema).toBe(defaults.db.schema)
+})