mirror of
https://github.com/supabase/supabase.git
synced 2026-10-09 11:25:06 +03:00
## I have read the [CONTRIBUTING.md](https://github.com/supabase/supabase/blob/master/CONTRIBUTING.md) file. YES ## What kind of change does this PR introduce? - Noticing our code we have many patterns of calling localstorage and handling those errors - We should add those in a single well tested file - Handle those errors in the singleton which makes it easier for us to debug customer issues. Logger is outputing local storage warnings for feature we expose - Side effect of this is random crashes on studio when local storage isn't available or handled correctly <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Refactor** * Improved browser storage handling across the app for more reliable persistence and graceful behavior in restricted or non-browser environments (settings, previews, charts, tabs, sign-in/session flows, integrations, and UI state). * **New Features** * Introduced a safe storage layer to standardize and harden local/session persistence. * **Tests** * Added comprehensive tests covering the new safe storage behavior. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
36 lines
1.4 KiB
TypeScript
36 lines
1.4 KiB
TypeScript
// Reference: https://usehooks.com/useLocalStorage/
|
|
import { safeLocalStorage } from 'common'
|
|
import { useCallback, useState } from 'react'
|
|
|
|
export function useLocalStorage<T>(key: string, initialValue: T) {
|
|
// State to store our value
|
|
// Pass initial state function to useState so logic is only executed once
|
|
const [storedValue, setStoredValue] = useState<T>(() => {
|
|
// safeLocalStorage handles SSR and unavailable storage (returns null);
|
|
// the try/catch here only guards JSON.parse against corrupt values.
|
|
const item = safeLocalStorage.getItem(key)
|
|
try {
|
|
return item ? (JSON.parse(item) as T) : initialValue
|
|
} catch (error) {
|
|
console.warn(`Failed to parse localStorage value for "${key}"`, error)
|
|
return initialValue
|
|
}
|
|
})
|
|
|
|
// Return a wrapped version of useState's setter function that ...
|
|
// ... persists the new value to localStorage.
|
|
const setValue = useCallback(
|
|
(value: T | ((val: T) => T)) => {
|
|
// Allow value to be a function so we have same API as useState
|
|
const valueToStore = value instanceof Function ? value(storedValue) : value
|
|
// Save state
|
|
setStoredValue(valueToStore)
|
|
// Persist (safeLocalStorage swallows storage errors internally)
|
|
safeLocalStorage.setItem(key, JSON.stringify(valueToStore))
|
|
},
|
|
[key, storedValue]
|
|
)
|
|
|
|
return [storedValue, setValue] as const
|
|
}
|