Skip to content

The Postgres development platform. Supabase gives you a dedicated Postgres database to build your web, mobile, and AI applications.

fix(studio): stop table editor filters leaking across tables on Back (#51391)

Alaister Young4507b20370e3
diff --git a/apps/studio/components/grid/SupabaseGrid.utils.navigation.test.tsx b/apps/studio/components/grid/SupabaseGrid.utils.navigation.test.tsx
new file mode 100644
index 00000000000..48194255485
--- /dev/null
+++ b/apps/studio/components/grid/SupabaseGrid.utils.navigation.test.tsx
@@ -0,0 +1,102 @@
+import {
+ createBrowserHistory,
+ createRootRoute,
+ createRoute,
+ createRouter,
+ Outlet,
+ RouterProvider,
+ useParams,
+ type AnyRouter,
+} from '@tanstack/react-router'
+import { act, render, screen, waitFor } from '@testing-library/react'
+import { afterEach, describe, expect, it, vi } from 'vitest'
+
+import { STORAGE_KEY_PREFIX } from './constants'
+import {
+ loadTableEditorStateFromLocalStorage,
+ useSyncTableEditorStateFromLocalStorageWithUrl,
+} from './SupabaseGrid.utils'
+import { ENTITY_TYPE } from '@/data/entity-types/entity-type-constants'
+import type { ForeignTable } from '@/data/table-editor/table-editor-types'
+import { parseSearch, stringifySearch } from '@/lib/router-search-params'
+
+vi.mock('next/navigation', () => import('@/compat/next/navigation'))
+vi.mock('nuqs', async (importOriginal) => ({
+ ...(await importOriginal<typeof import('nuqs')>()),
+ useQueryStates: () => [{}, vi.fn()],
+}))
+
+const tableA = '/project/default/editor/1?schema=public&filter=id%3Aeq%3A2'
+const tableB = '/project/default/editor/2?schema=public'
+
+// The hook only reads `id`; a foreign table is the smallest complete `Entity`.
+const getTable = (id: number): ForeignTable => ({
+ entity_type: ENTITY_TYPE.FOREIGN_TABLE,
+ id,
+ schema: 'public',
+ name: `table_${id}`,
+ comment: null,
+ foreign_server_name: '',
+ foreign_data_wrapper_name: '',
+ foreign_data_wrapper_handler: '',
+ columns: [],
+})
+
+function TablePage() {
+ const { id } = useParams<AnyRouter, undefined, false>({ strict: false })
+ useSyncTableEditorStateFromLocalStorageWithUrl({
+ projectRef: 'default',
+ table: getTable(Number(id)),
+ })
+ return <output data-testid="table">{id}</output>
+}
+
+afterEach(() => {
+ localStorage.removeItem(`${STORAGE_KEY_PREFIX}_default`)
+ sessionStorage.removeItem(`${STORAGE_KEY_PREFIX}_default`)
+})
+
+describe('useSyncTableEditorStateFromLocalStorageWithUrl', () => {
+ it('saves filters only under the table the URL belongs to while navigation is pending', async () => {
+ window.history.replaceState(null, '', tableA)
+ const history = createBrowserHistory()
+ const root = createRootRoute({ component: Outlet })
+ const table = createRoute({
+ getParentRoute: () => root,
+ path: '/project/$ref/editor/$id',
+ // Keeps the old route params rendered after the location has already moved on.
+ loader: () => new Promise((resolve) => setTimeout(resolve, 50)),
+ component: TablePage,
+ })
+ const router = createRouter({
+ routeTree: root.addChildren([table]),
+ history,
+ parseSearch,
+ stringifySearch,
+ isServer: false,
+ })
+ await router.load()
+ const view = render(<RouterProvider router={router} />)
+
+ try {
+ await waitFor(() =>
+ expect(loadTableEditorStateFromLocalStorage('default', 1)?.filters).toEqual(['id:eq:2'])
+ )
+
+ await act(async () => history.push(tableB))
+ await waitFor(() => expect(screen.getByTestId('table')).toHaveTextContent('2'))
+ await waitFor(() =>
+ expect(loadTableEditorStateFromLocalStorage('default', 2)?.filters).toEqual([])
+ )
+ expect(loadTableEditorStateFromLocalStorage('default', 1)?.filters).toEqual(['id:eq:2'])
+
+ await act(async () => history.back())
+ await waitFor(() => expect(screen.getByTestId('table')).toHaveTextContent('1'))
+ expect(loadTableEditorStateFromLocalStorage('default', 2)?.filters).toEqual([])
+ expect(loadTableEditorStateFromLocalStorage('default', 1)?.filters).toEqual(['id:eq:2'])
+ } finally {
+ view.unmount()
+ history.destroy()
+ }
+ })
+})
diff --git a/apps/studio/components/grid/SupabaseGrid.utils.ts b/apps/studio/components/grid/SupabaseGrid.utils.ts
index 43b8ef31d1a..dd83a996b4a 100644
--- a/apps/studio/components/grid/SupabaseGrid.utils.ts
+++ b/apps/studio/components/grid/SupabaseGrid.utils.ts
@@ -234,11 +234,16 @@ export const saveTableEditorStateToLocalStorageDebounced = AwesomeDebouncePromis
500
)
+export function getTableIdFromPath(path: string) {
+ return path.split(/[?#]/)[0].match(/\/editor\/(\d+)\/?$/)?.[1]
+}
+
function getLatestParams() {
const queryParams = new URLSearchParams(window.location.search)
const sort = queryParams.getAll('sort')
const filter = queryParams.getAll('filter')
- return { sort, filter }
+ const tableId = getTableIdFromPath(window.location.pathname)
+ return { tableId, sort, filter }
}
export function useSyncTableEditorStateFromLocalStorageWithUrl({
@@ -273,6 +278,9 @@ export function useSyncTableEditorStateFromLocalStorageWithUrl({
// `urlParams` from `useQueryStates` can be stale so always get the latest from the URL
const latestUrlParams = getLatestParams()
+ // Under TanStack the URL moves to the next table before `table` does; saving then would
+ // store one table's filters and sorts under another's id.
+ if (latestUrlParams.tableId !== String(table.id)) return
saveTableEditorStateToLocalStorage({
projectRef,
diff --git a/apps/studio/components/grid/hooks/useTableFilter.navigation.test.tsx b/apps/studio/components/grid/hooks/useTableFilter.navigation.test.tsx
new file mode 100644
index 00000000000..6e4f5dbbb56
--- /dev/null
+++ b/apps/studio/components/grid/hooks/useTableFilter.navigation.test.tsx
@@ -0,0 +1,77 @@
+import {
+ createBrowserHistory,
+ createRootRoute,
+ createRoute,
+ createRouter,
+ Outlet,
+ RouterProvider,
+} from '@tanstack/react-router'
+import { act, render, screen, waitFor } from '@testing-library/react'
+import { useRouter } from 'next/router'
+import { describe, expect, it, vi } from 'vitest'
+
+import { useTableFilter, useUrlTableFilters } from './useTableFilter'
+import { parseSearch, stringifySearch } from '@/lib/router-search-params'
+
+vi.mock('next/router', () => import('@/compat/next/router'))
+
+const tableA = '/project/default/editor/1?schema=public&filter=name%3Aeq%3ARed'
+const tableB = '/project/default/editor/2?schema=public'
+
+type RenderedState = { id?: string; urlFilters: unknown[]; tableFilters?: unknown[] }
+
+function SidebarItemProbe({ renders }: { renders: RenderedState[] }) {
+ // Same sources as the sidebar's active entity: route params (`query`, what `useParams` from
+ // 'common' reads) for the id, the URL for filters.
+ const id = useRouter().query.id?.toString()
+ const { filters: urlFilters } = useTableFilter()
+ const tableFilters = useUrlTableFilters(Number(id))
+ renders.push({ id, urlFilters, tableFilters })
+ return <output data-testid="table">{id}</output>
+}
+
+describe('useUrlTableFilters', () => {
+ it("never returns another table's URL filters while navigation is pending", async () => {
+ window.history.replaceState(null, '', tableA)
+ const history = createBrowserHistory()
+ const renders: RenderedState[] = []
+ const root = createRootRoute({ component: Outlet })
+ const table = createRoute({
+ getParentRoute: () => root,
+ path: '/project/$ref/editor/$id',
+ // Keeps the old route params rendered after the location has already moved on.
+ loader: () => new Promise((resolve) => setTimeout(resolve, 50)),
+ component: () => <SidebarItemProbe renders={renders} />,
+ })
+ const router = createRouter({
+ routeTree: root.addChildren([table]),
+ history,
+ parseSearch,
+ stringifySearch,
+ isServer: false,
+ })
+ await router.load()
+ const view = render(<RouterProvider router={router} />)
+
+ try {
+ await act(async () => history.push(tableB))
+ await waitFor(() => expect(screen.getByTestId('table')).toHaveTextContent('2'))
+
+ await act(async () => history.back())
+ await waitFor(() => expect(screen.getByTestId('table')).toHaveTextContent('1'))
+
+ const table2Renders = renders.filter((state) => state.id === '2')
+ // Table 2 was rendered with table 1's URL filters while Back was pending.
+ expect(table2Renders.some((state) => state.urlFilters.length > 0)).toBe(true)
+ for (const state of table2Renders) {
+ // Mismatched renders must be `undefined`, not `[]`, so the sidebar count query stays off.
+ if (state.urlFilters.length > 0) expect(state.tableFilters).toBeUndefined()
+ else expect(state.tableFilters).toEqual([])
+ }
+ expect(renders.at(-1)?.tableFilters).toHaveLength(1)
+ } finally {
+ view.unmount()
+ history.destroy()
+ }
+ })
+})
diff --git a/apps/studio/components/grid/hooks/useTableFilter.ts b/apps/studio/components/grid/hooks/useTableFilter.ts
index 9b82463038b..3674a1ba198 100644
--- a/apps/studio/components/grid/hooks/useTableFilter.ts
+++ b/apps/studio/components/grid/hooks/useTableFilter.ts
@@ -1,4 +1,4 @@
-import { formatFilterURLParams } from '@/components/grid/SupabaseGrid.utils'
+import { formatFilterURLParams, getTableIdFromPath } from '@/components/grid/SupabaseGrid.utils'
import { Filter } from '@/components/grid/types'
import { useTableEditorFiltersSort } from '@/hooks/misc/useTableEditorFiltersSort'
import { useOptionalTableEditorTableStateSnapshot } from '@/state/table-editor-table'
@@ -13,13 +13,16 @@ import { useOptionalTableEditorTableStateSnapshot } from '@/state/table-editor-t
*/
export function useTableFilter() {
const snap = useOptionalTableEditorTableStateSnapshot()
- const { filters: urlFilters } = useTableEditorFiltersSort()
+ const { path, filters: urlFilters } = useTableEditorFiltersSort()
const urlParsedFilters = formatFilterURLParams(urlFilters)
+ const urlTableId = getTableIdFromPath(path)
const filters = snap ? snap.filters : urlParsedFilters
return {
filters,
+ /** Table id in the current URL path, which can lead the rendered table during navigation. */
+ urlTableId,
setFilters: (filters: Filter[]) => {
if (!snap) {
throw new Error('useTableFilter: setFilters requires TableEditorTableStateContextProvider')
@@ -36,3 +39,13 @@ export function useTableFilter() {
},
}
}
+
+/**
+ * URL filters for `tableId`, for callers outside the table state provider (e.g. the sidebar).
+ * `undefined` while the URL belongs to another table: under TanStack the URL moves to the next
+ * table before route params do.
+ */
+export function useUrlTableFilters(tableId: number): Filter[] | undefined {
+ const { filters, urlTableId } = useTableFilter()
+ return urlTableId === String(tableId) ? filters : undefined
+}
diff --git a/apps/studio/components/layouts/TableEditorLayout/EntityListItem.tsx b/apps/studio/components/layouts/TableEditorLayout/EntityListItem.tsx
index 1569685bb8e..5a1b5c05e10 100644
--- a/apps/studio/components/layouts/TableEditorLayout/EntityListItem.tsx
+++ b/apps/studio/components/layouts/TableEditorLayout/EntityListItem.tsx
@@ -31,7 +31,7 @@ import {
} from 'ui'
import { useExportAllRowsAsCsv, useExportAllRowsAsSql } from './ExportAllRows'
-import { useTableFilter } from '@/components/grid/hooks/useTableFilter'
+import { useUrlTableFilters } from '@/components/grid/hooks/useTableFilter'
import { buildTableEditorUrl } from '@/components/grid/SupabaseGrid.utils'
import { getEntityLintDetails } from '@/components/interfaces/TableGridEditor/TableEntity.utils'
import { EntityTypeIcon } from '@/components/ui/EntityTypeIcon'
@@ -96,7 +96,7 @@ export const EntityListItem = ({
const isActive = Number(id) === entity.id
const canEdit = isActive && !isLocked
- const { filters } = useTableFilter()
+ const filters = useUrlTableFilters(entity.id)
const roleImpersonationState = useRoleImpersonationStateSnapshot()
const { data: countData } = useTableRowsCountQuery(
{
@@ -107,7 +107,7 @@ export const EntityListItem = ({
roleImpersonationState: roleImpersonationState as RoleImpersonationState,
},
{
- enabled: isTableLikeEntityListItem(entity) && isActive,
+ enabled: isTableLikeEntityListItem(entity) && isActive && filters !== undefined,
}
)
const rowCount = countData?.count
diff --git a/apps/studio/hooks/misc/useTableEditorFiltersSort.ts b/apps/studio/hooks/misc/useTableEditorFiltersSort.ts
index 5851a8e4d90..e4c18a54ff0 100644
--- a/apps/studio/hooks/misc/useTableEditorFiltersSort.ts
+++ b/apps/studio/hooks/misc/useTableEditorFiltersSort.ts
@@ -4,6 +4,8 @@ import { useCallback, useMemo } from 'react'
export const useTableEditorFiltersSort = () => {
const router = useRouter()
+ const path = router.asPath.split(/[?#]/)[0]
+
const urlParams = useMemo(() => {
return new URLSearchParams(router.asPath.split('?')[1])
}, [router.asPath])
@@ -46,6 +48,7 @@ export const useTableEditorFiltersSort = () => {
)
return {
+ path,
filters,
sorts,
setParams,