Files
Danny WhiteandJoshen Lim 7d6995bbfe refactor(studio): clean up ProjectLayout title API (#43742)
## What kind of change does this PR introduce?

Refactor, cleanup, and docs update.

## What is the current behavior?

After the page-title rollout, `ProjectLayout` is still in a transitional
state:

- it accepts a deprecated `title` prop
- it still supports a separate `browserTitle.surface`
- wrapper layouts are split between passing `title` directly and passing
`browserTitle.section`

That makes the API harder to reason about than it needs to be, even
though the rendered titles are already correct.

## What is the new behavior?

This cleanup finishes the API simplification that came out of the
stacked PR review:

- wrapper layouts stay `title`-first for DX
- `ProjectLayout` no longer accepts `title`
- `product` is now the single source of truth for the project-surface
title segment
- `browserTitle` is now only used for extra browser-title metadata
(`entity`, `section`, `override`)
- the remaining project-scoped callers now pass `browserTitle.section`
when they need a section label
- docs now reflect the final pattern instead of the transitional one

Rendered page titles stay the same.

## Additional context

Checks run:

- `pnpm --filter studio exec vitest --run lib/page-title.test.ts
components/layouts/ProjectLayout/index.test.tsx`
- `pnpm --filter studio typecheck`
- `pnpm exec prettier --check ...` on touched files

This is intended as the post-rollout cleanup PR based on Joshen's review
feedback across the stacked title changes.

---------

Co-authored-by: Joshen Lim <joshenlimek@gmail.com>
2026-03-16 18:03:10 +11:00

213 lines
6.8 KiB
TypeScript

import { render, waitFor } from '@testing-library/react'
import type { ReactNode } from 'react'
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'
import { MobileSheetProvider } from '../Navigation/NavigationBar/MobileSheetContext'
import { ProjectLayout } from './index'
import { STUDIO_PAGE_TITLE_SEPARATOR } from '@/lib/page-title'
const { mockRouter, mockSetSelectedDatabaseId, mockSetMobileMenuOpen } = 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(),
}))
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(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) => {},
}))
vi.mock('framer-motion', () => ({
AnimatePresence: ({ children }: { children: ReactNode }) => <>{children}</>,
motion: {
div: ({ children, ...props }: any) => <div {...props}>{children}</div>,
create: (Component: any) => Component,
},
}))
vi.mock('ui', () => ({
cn: (...classes: Array<string | false | null | undefined>) => classes.filter(Boolean).join(' '),
CommandInput_Shadcn_: { displayName: 'CommandInput' },
Command_Shadcn_: { displayName: 'Command' },
CommandGroup_Shadcn_: { displayName: 'CommandGroup' },
CommandItem_Shadcn_: { displayName: 'CommandItem' },
CommandList_Shadcn_: { displayName: 'CommandList' },
LogoLoader: () => <div data-testid="logo-loader" />,
ResizableHandle: (props: any) => <div {...props} />,
ResizablePanel: ({ children, ...props }: any) => <div {...props}>{children}</div>,
ResizablePanelGroup: ({ children, ...props }: any) => <div {...props}>{children}</div>,
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: () => false,
usePanelRef: () => undefined,
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', () => ({
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', () => ({ default: () => null }))
vi.mock('./PausingState', () => ({ default: () => null }))
vi.mock('./ProductMenuBar', () => ({
default: ({ children }: { children: ReactNode }) => <>{children}</>,
}))
vi.mock('./ResizingState', () => ({ default: () => null }))
vi.mock('./RestartingState', () => ({ default: () => null }))
vi.mock('./RestoreFailedState', () => ({ default: () => null }))
vi.mock('./RestoringState', () => ({ default: () => 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('@/hooks/custom-content/useCustomContent', () => ({
useCustomContent: () => ({ appTitle: 'Supabase' }),
}))
vi.mock('@/hooks/misc/useSelectedOrganization', () => ({
useSelectedOrganizationQuery: () => ({
data: { name: 'Organization 1', slug: 'org-1' },
}),
}))
vi.mock('@/hooks/misc/useSelectedProject', () => ({
useSelectedProjectQuery: () => ({
data: {
ref: 'default',
name: 'Project 1',
status: 'ACTIVE_HEALTHY',
postgrestStatus: 'ONLINE',
},
}),
}))
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,
}),
}))
describe('ProjectLayout title', () => {
beforeEach(() => {
mockRouter.pathname = '/project/[ref]/observability/query-performance'
mockRouter.asPath = '/project/default/observability/query-performance'
document.title = ''
})
afterEach(() => {
vi.clearAllMocks()
document.title = ''
})
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
)
)
})
})
})