Files
supabase/apps/studio/hooks/misc/useSchemaQueryState.ts
Ivan Vasilov 24f590e893 fix: Fix the caching of the selected schema (#28999)
* Cache the original schema and ignore the schema changes in the local storage. This is to avoid unwanted changes in the UI.

* Nit refactor to ensure immutability

---------

Co-authored-by: Joshen Lim <joshenlimek@gmail.com>
2024-09-02 14:15:37 +07:00

42 lines
1.6 KiB
TypeScript

import { parseAsString, useQueryState } from 'nuqs'
import { useEffect, useMemo } from 'react'
import { useParams } from 'common'
import { LOCAL_STORAGE_KEYS } from 'lib/constants'
/**
* This hook wraps useQueryState because useQueryState imports app router for some reason which breaks the SSR in
* the playwright tests. I've localized the issue to "NODE_ENV='test'" in the playwright tests.
*/
const useIsomorphicUseQueryState = (defaultSchema: string) => {
if (typeof window === 'undefined') {
return [defaultSchema, () => {}] as const
} else {
// eslint-disable-next-line react-hooks/rules-of-hooks
return useQueryState('schema', parseAsString.withDefault(defaultSchema))
}
}
export const useQuerySchemaState = () => {
const { ref } = useParams()
const defaultSchema =
typeof window !== 'undefined' && ref && ref.length > 0
? window.localStorage.getItem(LOCAL_STORAGE_KEYS.LAST_SELECTED_SCHEMA(ref)) || 'public'
: 'public'
// cache the original default schema so that it's not changed by another tab and cause issues in the app (saving a
// table on the wrong schema)
const originalDefaultSchema = useMemo(() => defaultSchema, [ref])
const [schema, setSelectedSchema] = useIsomorphicUseQueryState(originalDefaultSchema)
useEffect(() => {
// Update the schema in local storage on every change
if (typeof window !== 'undefined' && ref && ref.length > 0) {
window.localStorage.setItem(LOCAL_STORAGE_KEYS.LAST_SELECTED_SCHEMA(ref), schema)
}
}, [schema, ref])
return { selectedSchema: schema, setSelectedSchema }
}