The Postgres development platform. Supabase gives you a dedicated Postgres database to build your web, mobile, and AI applications.
TypeScript aialternativeauthdatabasedenoembeddingsexamplefirebasenextjsoauth2pgvectorpostgispostgrespostgresqlpostgrestrealtimesupabasevectorswebsockets
import { fireEvent, render, screen, waitFor } from '@testing-library/react'
import { LOCAL_STORAGE_KEYS } from 'common'
import { useState, type ReactNode } from 'react'
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'
import { MobileSheetProvider, useMobileSheet } from '../Navigation/NavigationBar/MobileSheetContext'
import { ProjectLayout } from './index'
import type { MobileMenuContentProps } from './LayoutHeader/MobileMenuContent'
import { STUDIO_PAGE_TITLE_SEPARATOR } from '@/lib/page-title'
const { mockRouter, mockSetSelectedDatabaseId, mockSetMobileMenuOpen, mockViewport } = vi.hoisted(
() => ({
mockRouter: {
pathname: '/project/[ref]/observability/query-performance',
asPath: '/project/default/observability/query-performance',
push: vi.fn(),
replace: vi.fn(),
},
mockSetSelectedDatabaseId: vi.fn(),
mockSetMobileMenuOpen: vi.fn(),
mockViewport: { isMobile: false },
})
)
const {
mockAddBanner,
mockDismissBanner,
mockProjectState,
mockResourceWarningsState,
mockBannerDismissedState,
mockUseLocalStorageQuery,
} = vi.hoisted(() => ({
mockAddBanner: vi.fn(),
mockDismissBanner: vi.fn(),
mockProjectState: {
current: {
ref: 'default',
name: 'Project 1',
status: 'ACTIVE_HEALTHY',
postgrestStatus: 'ONLINE',
infra_compute_size: undefined as string | undefined,
integration_source: null as string | null,
},
},
mockResourceWarningsState: { current: undefined as any[] | undefined },
mockBannerDismissedState: { current: false },
mockUseLocalStorageQuery: vi.fn(),
}))
vi.mock('next/router', () => ({
useRouter: () => mockRouter,
}))
vi.mock('next/head', async () => {
const React = await import('react')
const Head = ({ children }: { children?: ReactNode }) => {
React.useEffect(() => {
const titleElement = React.Children.toArray(children).find(
(child) => React.isValidElement(child) && child.type === 'title'
)
if (!React.isValidElement<{ children: ReactNode }>(titleElement)) return
const titleText = React.Children.toArray(titleElement.props.children).join('')
document.title = titleText
}, [children])
return null
}
return { default: Head }
})
vi.mock('common', () => ({
useParams: () => ({ ref: 'default' }),
mergeRefs:
(..._refs: any[]) =>
(_value: unknown) => {},
IS_PLATFORM: false,
LOCAL_STORAGE_KEYS: {
FREE_MICRO_UPGRADE_BANNER_DISMISSED: (ref: string) =>
`free-micro-upgrade-banner-dismissed-${ref}`,
PROJECT_INTEGRATION_BANNER_DISMISSED: (ref: string, integrationSource: string) =>
`project-integration-banner-dismissed-${ref}-${integrationSource}`,
},
isFeatureEnabled: () => false,
useFlag: () => false,
}))
vi.mock('motion/react', () => ({
AnimatePresence: ({ children }: { children: ReactNode }) => <>{children}</>,
motion: {
div: ({ children, ...props }: any) => <div {...props}>{children}</div>,
create: (Component: any) => Component,
},
}))
vi.mock('ui', async () => ({
...(await import('ui/src/components/shadcn/ui/resizable')),
cn: (...classes: Array<string | false | null | undefined>) => classes.filter(Boolean).join(' '),
Alert: ({ children, ...props }: any) => <div {...props}>{children}</div>,
AlertDescription: ({ children, ...props }: any) => <div {...props}>{children}</div>,
AlertTitle: ({ children, ...props }: any) => <div {...props}>{children}</div>,
CommandInput: { displayName: 'CommandInput' },
Command: { displayName: 'Command' },
CommandGroup: { displayName: 'CommandGroup' },
CommandItem: { displayName: 'CommandItem' },
CommandList: { displayName: 'CommandList' },
LogoLoader: () => <div data-testid="logo-loader" />,
Sidebar: ({ children, ...props }: any) => <div {...props}>{children}</div>,
SidebarContent: ({ children, ...props }: any) => <div {...props}>{children}</div>,
SidebarFooter: ({ children, ...props }: any) => <div {...props}>{children}</div>,
SidebarGroup: ({ children, ...props }: any) => <div {...props}>{children}</div>,
SidebarMenu: ({ children, ...props }: any) => <div {...props}>{children}</div>,
SidebarMenuButton: (props: any) => <div {...props} />,
SidebarMenuItem: (props: any) => <div {...props} />,
useIsMobile: () => mockViewport.isMobile,
useSidebar: () => ({ setOpen: vi.fn() }),
}))
vi.mock('ui-patterns/MobileSheetNav/MobileSheetNav', () => ({
default: ({ children }: { children: ReactNode }) => <>{children}</>,
}))
vi.mock('../editors/EditorsLayout.hooks', () => ({
useEditorType: () => undefined,
}))
vi.mock('../MainScrollContainerContext', () => ({
useMainScrollContainer: () => null,
useSetMainScrollContainer: () => () => {},
}))
vi.mock('./BuildingState', () => ({ default: () => null }))
vi.mock('./ConnectingState', () => ({ default: () => null }))
vi.mock('./LoadingState', () => ({ LoadingState: () => null }))
vi.mock('./PausedState/ProjectPausedState', () => ({ ProjectPausedState: () => null }))
vi.mock('./PauseFailedState', () => ({ PauseFailedState: () => null }))
vi.mock('./PausingState', () => ({ PausingState: () => null }))
vi.mock('./ProductMenuBar', () => ({
ProductMenuBar: ({ children }: { children: ReactNode }) => <>{children}</>,
}))
vi.mock('./ResizingState', () => ({ ResizingState: () => null }))
vi.mock('./RestartingState', () => ({ default: () => null }))
vi.mock('./RestoreFailedState', () => ({ RestoreFailedState: () => null }))
vi.mock('./RestoringState', () => ({ RestoringState: () => null }))
vi.mock('./UpgradingState', () => ({ UpgradingState: () => null }))
vi.mock('@/components/interfaces/BranchManagement/CreateBranchModal', () => ({
CreateBranchModal: () => null,
}))
vi.mock('@/components/interfaces/ProjectAPIDocs/ProjectAPIDocs', () => ({
ProjectAPIDocs: () => null,
}))
vi.mock('@/components/ui/ResourceExhaustionWarningBanner/ResourceExhaustionWarningBanner', () => ({
ResourceExhaustionWarningBanner: () => null,
}))
vi.mock('@/components/ui/ButtonTooltip', () => ({
ButtonTooltip: ({ children, ...props }: any) => (
<button tabIndex={0} {...props}>
{children}
</button>
),
}))
vi.mock('@/components/ui/PartnerIcon', () => ({
default: () => <div data-testid="partner-icon" />,
}))
vi.mock('@/hooks/custom-content/useCustomContent', () => ({
useCustomContent: () => ({ appTitle: 'Supabase' }),
}))
vi.mock('@/hooks/misc/useLocalStorage', () => ({
useLocalStorageQuery: (...args: unknown[]) => mockUseLocalStorageQuery(...args),
}))
vi.mock('@/components/ui/BannerStack/BannerStackProvider', () => ({
BANNER_ID: {
FREE_MICRO_UPGRADE: 'free-micro-upgrade-banner',
},
useBannerStack: () => ({
addBanner: mockAddBanner,
dismissBanner: mockDismissBanner,
banners: [],
}),
}))
vi.mock('@/components/ui/BannerStack/Banners/BannerFreeMicroUpgrade', () => ({
BannerFreeMicroUpgrade: () => null,
}))
vi.mock('@/data/usage/resource-warnings-query', () => ({
useResourceWarningsQuery: () => ({ data: mockResourceWarningsState.current }),
}))
vi.mock('@/hooks/misc/useSelectedOrganization', () => ({
useSelectedOrganizationQuery: () => ({
data: { name: 'Organization 1', slug: 'org-1' },
}),
}))
vi.mock('@/hooks/misc/useSelectedProject', () => ({
useSelectedProjectQuery: () => ({ data: mockProjectState.current }),
}))
vi.mock('@/hooks/misc/withAuth', () => ({
withAuth: (Component: any) => Component,
}))
vi.mock('@/hooks/ui/useFlag', () => ({
usePHFlag: () => undefined,
}))
vi.mock('@/state/app-state', () => ({
useAppStateSnapshot: () => ({
mobileMenuOpen: false,
showSidebar: false,
setMobileMenuOpen: mockSetMobileMenuOpen,
}),
}))
vi.mock('@/state/database-selector', () => ({
useDatabaseSelectorStateSnapshot: () => ({
setSelectedDatabaseId: mockSetSelectedDatabaseId,
}),
}))
vi.mock('./LayoutHeader/MobileMenuContent', async (importOriginal) => {
const actual = await importOriginal<typeof import('./LayoutHeader/MobileMenuContent')>()
return {
...actual,
MobileMenuContent: ({
currentProductMenuHeader,
currentProductMenu,
}: MobileMenuContentProps) => (
<div>
{currentProductMenuHeader}
{currentProductMenu}
</div>
),
}
})
vi.mock('../Navigation/ProductMenuBar', () => ({
ProductMenuBar: ({ children }: { children: ReactNode }) => <>{children}</>,
}))
const MobileSheetHarness = () => {
const { content, openMenu, setContent } = useMobileSheet()
return (
<>
<button tabIndex={0} onClick={openMenu}>
Open menu
</button>
<button tabIndex={0} onClick={() => setContent(<span>Other sheet</span>)}>
Open other sheet
</button>
<div data-testid="mobile-sheet">{content}</div>
</>
)
}
const ResourceMenuHarness = () => {
const [section, setSection] = useState('Explorer')
return (
<>
<button tabIndex={0} onClick={() => setSection('Chats')}>
Change section
</button>
<ProjectLayout
product="Explorer"
isBlocking={false}
productMenuHeader={<span>{section} header</span>}
productMenu={
<button
tabIndex={0}
onClick={() => setSection(section === 'Explorer' ? 'Notebooks' : 'Explorer')}
>
{section === 'Explorer' ? 'Open notebooks' : 'Return to Explorer'}
</button>
}
>
<div />
</ProjectLayout>
</>
)
}
const renderLayout = () =>
render(
<MobileSheetProvider>
<ProjectLayout product="Database" isBlocking={false}>
<div />
</ProjectLayout>
</MobileSheetProvider>
)
describe('ProjectLayout title', () => {
beforeEach(() => {
mockViewport.isMobile = false
mockRouter.pathname = '/project/[ref]/observability/query-performance'
mockRouter.asPath = '/project/default/observability/query-performance'
document.title = ''
mockProjectState.current = {
ref: 'default',
name: 'Project 1',
status: 'ACTIVE_HEALTHY',
postgrestStatus: 'ONLINE',
infra_compute_size: undefined,
integration_source: null,
}
mockBannerDismissedState.current = false
mockUseLocalStorageQuery.mockImplementation(() => [
mockBannerDismissedState.current,
vi.fn(),
{ isSuccess: true },
])
})
afterEach(() => {
document.title = ''
})
it('updates the open mobile menu when resource navigation changes without replacing other sheets', () => {
mockViewport.isMobile = true
render(
<MobileSheetProvider>
<ResourceMenuHarness />
<MobileSheetHarness />
</MobileSheetProvider>
)
expect(screen.getByTestId('mobile-sheet')).toBeEmptyDOMElement()
fireEvent.click(screen.getByRole('button', { name: 'Open menu' }))
expect(screen.getByText('Explorer header')).toBeInTheDocument()
fireEvent.click(screen.getByRole('button', { name: 'Open notebooks' }))
expect(screen.getByText('Notebooks header')).toBeInTheDocument()
fireEvent.click(screen.getByRole('button', { name: 'Return to Explorer' }))
expect(screen.getByText('Explorer header')).toBeInTheDocument()
fireEvent.click(screen.getByRole('button', { name: 'Open other sheet' }))
fireEvent.click(screen.getByRole('button', { name: 'Change section' }))
expect(screen.getByTestId('mobile-sheet')).toHaveTextContent('Other sheet')
})
it.each([false, true])(
'keeps sidebar navigation enabled with resizableSidebar=%s and preserves handle availability',
(resizableSidebar) => {
render(
<MobileSheetProvider>
<ProjectLayout
product="Database"
isBlocking={false}
resizableSidebar={resizableSidebar}
productMenu={<a href="/project/default/database/tables">Tables</a>}
>
<div>Page Content</div>
</ProjectLayout>
</MobileSheetProvider>
)
const link = screen.getByRole('link', { name: 'Tables' })
expect(link.closest('[aria-disabled="true"]')).toBeNull()
link.focus()
expect(link).toHaveFocus()
const handle = screen.getByRole('separator')
if (resizableSidebar) {
expect(handle).not.toHaveAttribute('aria-disabled')
expect(handle).toHaveAttribute('tabindex', '0')
} else {
expect(handle).toHaveAttribute('aria-disabled', 'true')
expect(handle).not.toHaveAttribute('tabindex')
}
}
)
it('sets a composed document title and deduplicates identical section/surface labels', async () => {
render(
<MobileSheetProvider>
<ProjectLayout browserTitle={{ section: 'Settings' }} product="Settings" isBlocking={false}>
<div>Page Content</div>
</ProjectLayout>
</MobileSheetProvider>
)
await waitFor(() => {
expect(document.title).toBe(
['Settings', 'Project 1', 'Organization 1', 'Supabase'].join(STUDIO_PAGE_TITLE_SEPARATOR)
)
})
})
it('prefers entity-first browserTitle metadata when provided', async () => {
render(
<MobileSheetProvider>
<ProjectLayout
product="Database"
browserTitle={{ entity: 'users', section: 'Tables' }}
isBlocking={false}
>
<div>Page Content</div>
</ProjectLayout>
</MobileSheetProvider>
)
await waitFor(() => {
expect(document.title).toBe(
['users', 'Tables', 'Database', 'Project 1', 'Organization 1', 'Supabase'].join(
STUDIO_PAGE_TITLE_SEPARATOR
)
)
})
})
it('renders the Stripe project banner with a project-specific dismiss key when the selected project is Stripe-connected', () => {
mockProjectState.current = {
...mockProjectState.current,
integration_source: 'stripe_projects',
}
renderLayout()
expect(screen.getByText('This project is connected to Stripe')).toBeInTheDocument()
expect(
screen.getByText('Changes made here may affect your connected Stripe project.')
).toBeInTheDocument()
expect(screen.getByTestId('partner-icon')).toBeInTheDocument()
expect(mockUseLocalStorageQuery).toHaveBeenCalledWith(
LOCAL_STORAGE_KEYS.PROJECT_INTEGRATION_BANNER_DISMISSED('default', 'stripe_projects'),
false
)
})
})
describe('FREE_MICRO_UPGRADE banner', () => {
beforeEach(() => {
mockRouter.pathname = '/project/[ref]'
mockRouter.asPath = '/project/default'
mockProjectState.current = {
ref: 'default',
name: 'Project 1',
status: 'ACTIVE_HEALTHY',
postgrestStatus: 'ONLINE',
infra_compute_size: 'nano',
integration_source: null,
}
mockResourceWarningsState.current = [
{
project: 'default',
cpu_exhaustion: true,
memory_and_swap_exhaustion: false,
disk_space_exhaustion: false,
},
]
mockBannerDismissedState.current = false
})
afterEach(() => {
mockRouter.pathname = '/project/[ref]/observability/query-performance'
mockRouter.asPath = '/project/default/observability/query-performance'
mockProjectState.current = {
ref: 'default',
name: 'Project 1',
status: 'ACTIVE_HEALTHY',
postgrestStatus: 'ONLINE',
infra_compute_size: undefined,
integration_source: null,
}
mockResourceWarningsState.current = undefined
mockBannerDismissedState.current = false
})
it('calls addBanner when project is nano and compute is near exhaustion', async () => {
renderLayout()
await waitFor(() => {
expect(mockAddBanner).toHaveBeenCalledWith(
expect.objectContaining({ id: 'free-micro-upgrade-banner' })
)
})
})
it.each([
[
'the banner was previously dismissed',
() => {
mockBannerDismissedState.current = true
},
],
[
'compute warnings are cleared',
() => {
mockResourceWarningsState.current = [
{
project: 'default',
cpu_exhaustion: false,
memory_and_swap_exhaustion: false,
disk_space_exhaustion: false,
},
]
},
],
[
'the project is not nano compute',
() => {
mockProjectState.current = { ...mockProjectState.current, infra_compute_size: 'micro' }
},
],
])('calls dismissBanner instead of addBanner when %s', async (_, arrange) => {
arrange()
renderLayout()
await waitFor(() => {
expect(mockDismissBanner).toHaveBeenCalledWith('free-micro-upgrade-banner')
})
expect(mockAddBanner).not.toHaveBeenCalledWith(
expect.objectContaining({ id: 'free-micro-upgrade-banner' })
)
})
})