@supabase/gotrue-js 1.22.12 → 1.22.15

package/src/GoTrueClient.ts

@@ -1,6 +1,20 @@
 import GoTrueApi from './GoTrueApi'
-import { isBrowser, getParameterByName, uuid } from './lib/helpers'
-import { GOTRUE_URL, DEFAULT_HEADERS, STORAGE_KEY } from './lib/constants'
+import {
+  isBrowser,
+  getParameterByName,
+  uuid,
+  setItemAsync,
+  removeItemAsync,
+  getItemSynchronously,
+  getItemAsync,
+} from './lib/helpers'
+import {
+  GOTRUE_URL,
+  DEFAULT_HEADERS,
+  STORAGE_KEY,
+  EXPIRY_MARGIN,
+  NETWORK_FAILURE,
+} from './lib/constants'
 import { polyfillGlobalThis } from './lib/polyfills'
 import { Fetch } from './lib/fetch'
 
@@ -16,6 +30,7 @@ import type {
   UserCredentials,
   VerifyOTPParams,
   OpenIDConnectCredentials,
+  SupportedStorage,
 } from './lib/types'
 
 polyfillGlobalThis() // Make "globalThis" available
@@ -29,17 +44,6 @@ const DEFAULT_OPTIONS = {
   headers: DEFAULT_HEADERS,
 }
 
-type AnyFunction = (...args: any[]) => any
-type MaybePromisify<T> = T | Promise<T>
-
-type PromisifyMethods<T> = {
-  [K in keyof T]: T[K] extends AnyFunction
-    ? (...args: Parameters<T[K]>) => MaybePromisify<ReturnType<T[K]>>
-    : T[K]
-}
-
-type SupportedStorage = PromisifyMethods<Pick<Storage, 'getItem' | 'setItem' | 'removeItem'>>
-
 export default class GoTrueClient {
   /**
    * Namespace for the GoTrue API methods.
@@ -61,6 +65,7 @@ export default class GoTrueClient {
   protected multiTab: boolean
   protected stateChangeEmitters: Map<string, Subscription> = new Map()
   protected refreshTokenTimer?: ReturnType<typeof setTimeout>
+  protected networkRetries: number = 0
 
   /**
    * Create a new client for use in the browser.
@@ -101,6 +106,7 @@ export default class GoTrueClient {
     this._recoverSession()
     this._recoverAndRefresh()
     this._listenForMultiTabEvents()
+    this._handleVisibilityChange()
 
     if (settings.detectSessionInUrl && isBrowser() && !!getParameterByName('access_token')) {
       // Handle the OAuth redirect
@@ -407,6 +413,8 @@ export default class GoTrueClient {
       user: this.user(),
     }
 
+    this._notifyAllSubscribers('TOKEN_REFRESHED')
+
     return this.currentSession
   }
 
@@ -608,16 +616,12 @@ export default class GoTrueClient {
    */
   private _recoverSession() {
     try {
-      const json = isBrowser() && this.localStorage?.getItem(STORAGE_KEY)
-      if (!json || typeof json !== 'string') {
-        return null
-      }
-
-      const data = JSON.parse(json)
+      const data = getItemSynchronously(this.localStorage, STORAGE_KEY)
+      if (!data) return null
       const { currentSession, expiresAt } = data
       const timeNow = Math.round(Date.now() / 1000)
 
-      if (expiresAt >= timeNow && currentSession?.user) {
+      if (expiresAt >= timeNow + EXPIRY_MARGIN && currentSession?.user) {
         this._saveSession(currentSession)
         this._notifyAllSubscribers('SIGNED_IN')
       }
@@ -632,22 +636,31 @@ export default class GoTrueClient {
    */
   private async _recoverAndRefresh() {
     try {
-      const json = isBrowser() && (await this.localStorage.getItem(STORAGE_KEY))
-      if (!json) {
-        return null
-      }
-
-      const data = JSON.parse(json)
+      const data = await getItemAsync(this.localStorage, STORAGE_KEY)
+      if (!data) return null
       const { currentSession, expiresAt } = data
       const timeNow = Math.round(Date.now() / 1000)
 
-      if (expiresAt < timeNow) {
+      if (expiresAt < timeNow + EXPIRY_MARGIN) {
         if (this.autoRefreshToken && currentSession.refresh_token) {
+          this.networkRetries++
           const { error } = await this._callRefreshToken(currentSession.refresh_token)
           if (error) {
             console.log(error.message)
+            if (
+              error.message === NETWORK_FAILURE.ERROR_MESSAGE &&
+              this.networkRetries < NETWORK_FAILURE.MAX_RETRIES
+            ) {
+              if (this.refreshTokenTimer) clearTimeout(this.refreshTokenTimer)
+              this.refreshTokenTimer = setTimeout(
+                () => this._recoverAndRefresh(),
+                NETWORK_FAILURE.RETRY_INTERVAL ** this.networkRetries * 100 // exponential backoff
+              )
+              return
+            }
             await this._removeSession()
           }
+          this.networkRetries = 0
         } else {
           this._removeSession()
         }
@@ -701,7 +714,7 @@ export default class GoTrueClient {
     if (expiresAt) {
       const timeNow = Math.round(Date.now() / 1000)
       const expiresIn = expiresAt - timeNow
-      const refreshDurationBeforeExpires = expiresIn > 60 ? 60 : 0.5
+      const refreshDurationBeforeExpires = expiresIn > EXPIRY_MARGIN ? EXPIRY_MARGIN : 0.5
       this._startAutoRefreshToken((expiresIn - refreshDurationBeforeExpires) * 1000)
     }
 
@@ -714,14 +727,14 @@ export default class GoTrueClient {
 
   private _persistSession(currentSession: Session) {
     const data = { currentSession, expiresAt: currentSession.expires_at }
-    isBrowser() && this.localStorage.setItem(STORAGE_KEY, JSON.stringify(data))
+    setItemAsync(this.localStorage, STORAGE_KEY, data)
   }
 
   private async _removeSession() {
     this.currentSession = null
     this.currentUser = null
     if (this.refreshTokenTimer) clearTimeout(this.refreshTokenTimer)
-    isBrowser() && (await this.localStorage.removeItem(STORAGE_KEY))
+    removeItemAsync(this.localStorage, STORAGE_KEY)
   }
 
   /**
@@ -732,7 +745,16 @@ export default class GoTrueClient {
     if (this.refreshTokenTimer) clearTimeout(this.refreshTokenTimer)
     if (value <= 0 || !this.autoRefreshToken) return
 
-    this.refreshTokenTimer = setTimeout(() => this._callRefreshToken(), value)
+    this.refreshTokenTimer = setTimeout(async () => {
+      this.networkRetries++
+      const { error } = await this._callRefreshToken()
+      if (!error) this.networkRetries = 0
+      if (
+        error?.message === NETWORK_FAILURE.ERROR_MESSAGE &&
+        this.networkRetries < NETWORK_FAILURE.MAX_RETRIES
+      )
+        this._startAutoRefreshToken(NETWORK_FAILURE.RETRY_INTERVAL ** this.networkRetries * 100) // exponential backoff
+    }, value)
     if (typeof this.refreshTokenTimer.unref === 'function') this.refreshTokenTimer.unref()
   }
 
@@ -741,7 +763,6 @@ export default class GoTrueClient {
    */
   private _listenForMultiTabEvents() {
     if (!this.multiTab || !isBrowser() || !window?.addEventListener) {
-      // console.debug('Auth multi-tab support is disabled.')
       return false
     }
 
@@ -750,7 +771,7 @@ export default class GoTrueClient {
         if (e.key === STORAGE_KEY) {
           const newSession = JSON.parse(String(e.newValue))
           if (newSession?.currentSession?.access_token) {
-            this._recoverAndRefresh()
+            this._saveSession(newSession.currentSession)
             this._notifyAllSubscribers('SIGNED_IN')
           } else {
             this._removeSession()
@@ -762,4 +783,20 @@ export default class GoTrueClient {
       console.error('_listenForMultiTabEvents', error)
     }
   }
+
+  private _handleVisibilityChange() {
+    if (!this.multiTab || !isBrowser() || !window?.addEventListener) {
+      return false
+    }
+
+    try {
+      window?.addEventListener('visibilitychange', () => {
+        if (document.visibilityState === 'visible') {
+          this._recoverAndRefresh()
+        }
+      })
+    } catch (error) {
+      console.error('_handleVisibilityChange', error)
+    }
+  }
 }

package/src/lib/constants.ts

@@ -2,7 +2,12 @@ import { version } from './version'
 export const GOTRUE_URL = 'http://localhost:9999'
 export const AUDIENCE = ''
 export const DEFAULT_HEADERS = { 'X-Client-Info': `gotrue-js/${version}` }
-export const EXPIRY_MARGIN = 60 * 1000
+export const EXPIRY_MARGIN = 10 // in seconds
+export const NETWORK_FAILURE = {
+  ERROR_MESSAGE: 'Request Failed',
+  MAX_RETRIES: 10,
+  RETRY_INTERVAL: 2, // in deciseconds
+}
 export const STORAGE_KEY = 'supabase.auth.token'
 export const COOKIE_OPTIONS = {
   name: 'sb',

package/src/lib/fetch.ts

@@ -1,3 +1,5 @@
+import { NETWORK_FAILURE } from './constants'
+
 export type Fetch = typeof fetch
 
 export interface FetchOptions {
@@ -13,6 +15,9 @@ const _getErrorMessage = (err: any): string =>
   err.msg || err.message || err.error_description || err.error || JSON.stringify(err)
 
 const handleError = (error: any, reject: any) => {
+  if (!error?.status) {
+    return reject({ message: NETWORK_FAILURE.ERROR_MESSAGE })
+  }
   if (typeof error.json !== 'function') {
     return reject(error)
   }

package/src/lib/helpers.ts

@@ -1,4 +1,5 @@
 import crossFetch from 'cross-fetch'
+import { SupportedStorage } from './types'
 
 export function expiresAt(expiresIn: number) {
   const timeNow = Math.round(Date.now() / 1000)
@@ -39,3 +40,38 @@ export const resolveFetch = (customFetch?: Fetch): Fetch => {
   }
   return (...args) => _fetch(...args)
 }
+
+// LocalStorage helpers
+export const setItemAsync = async (
+  storage: SupportedStorage,
+  key: string,
+  data: any
+): Promise<void> => {
+  isBrowser() && (await storage?.setItem(key, JSON.stringify(data)))
+}
+
+export const getItemAsync = async (storage: SupportedStorage, key: string): Promise<any | null> => {
+  const value = isBrowser() && (await storage?.getItem(key))
+  if (!value) return null
+  try {
+    return JSON.parse(value)
+  } catch {
+    return value
+  }
+}
+
+export const getItemSynchronously = (storage: SupportedStorage, key: string): any | null => {
+  const value = isBrowser() && storage?.getItem(key)
+  if (!value || typeof value !== 'string') {
+    return null
+  }
+  try {
+    return JSON.parse(value)
+  } catch {
+    return value
+  }
+}
+
+export const removeItemAsync = async (storage: SupportedStorage, key: string): Promise<void> => {
+  isBrowser() && (await storage?.removeItem(key))
+}

package/src/lib/types.ts

@@ -69,6 +69,8 @@ export interface User {
   aud: string
   confirmation_sent_at?: string
   recovery_sent_at?: string
+  email_change_sent_at?: string
+  new_email?: string
   invited_at?: string
   action_link?: string
   email?: string
@@ -209,3 +211,14 @@ export interface OpenIDConnectCredentials {
   client_id?: string
   issuer?: string
 }
+
+type AnyFunction = (...args: any[]) => any
+type MaybePromisify<T> = T | Promise<T>
+
+type PromisifyMethods<T> = {
+  [K in keyof T]: T[K] extends AnyFunction
+    ? (...args: Parameters<T[K]>) => MaybePromisify<ReturnType<T[K]>>
+    : T[K]
+}
+
+export type SupportedStorage = PromisifyMethods<Pick<Storage, 'getItem' | 'setItem' | 'removeItem'>>

package/src/lib/version.ts

@@ -1,2 +1,2 @@
 // generated by genversion
-export const version = '1.22.12'
+export const version = '1.22.15'