Skip to content

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

Refactor database publications to use page layout component (#45456)

Joshen Lim89760b26e071
diff --git a/apps/studio/components/interfaces/Database/Publications/PublicationSkeleton.tsx b/apps/studio/components/interfaces/Database/Publications/PublicationSkeleton.tsx
index 853e575b6a5..ed318a5a11f 100644
--- a/apps/studio/components/interfaces/Database/Publications/PublicationSkeleton.tsx
+++ b/apps/studio/components/interfaces/Database/Publications/PublicationSkeleton.tsx
@@ -27,3 +27,21 @@ export const PublicationSkeleton = ({ index }: PublicationSkeletonProps) => {
</TableRow>
)
}
+
+export const PublicationTablesSkeleton = ({ index }: PublicationSkeletonProps) => {
+ return (
+ <TableRow>
+ <TableCell style={{ width: '35%' }}>
+ <ShimmeringLoader className="h-4 w-24 my-0.5 p-0" delayIndex={index} />
+ </TableCell>
+ <TableCell className="hidden lg:table-cell" style={{ width: '15%' }}>
+ <ShimmeringLoader className="h-4 w-14 my-0.5 p-0" delayIndex={index} />
+ </TableCell>
+ <TableCell className="px-4 py-3 pr-2">
+ <div className="flex">
+ <ShimmeringLoader className="h-6 w-12 p-0" delayIndex={index} />
+ </div>
+ </TableCell>
+ </TableRow>
+ )
+}
diff --git a/apps/studio/components/interfaces/Database/Publications/PublicationsList.tsx b/apps/studio/components/interfaces/Database/Publications/PublicationsList.tsx
index f7e2820a335..bf9adf22e6c 100644
--- a/apps/studio/components/interfaces/Database/Publications/PublicationsList.tsx
+++ b/apps/studio/components/interfaces/Database/Publications/PublicationsList.tsx
@@ -112,29 +112,27 @@ export const PublicationsList = () => {
return (
<>
- <div className="mb-4">
- <div className="flex items-center justify-between">
- <div className="flex items-center">
- <Input
- ref={searchInputRef}
- size="tiny"
- icon={<Search />}
- className="w-48"
- placeholder="Search for a publication"
- value={filterString}
- onChange={(e) => setFilterString(e.target.value)}
- onKeyDown={onSearchInputEscape(filterString, setFilterString)}
+ <div className="flex items-center justify-between">
+ <div className="flex items-center">
+ <Input
+ ref={searchInputRef}
+ size="tiny"
+ icon={<Search />}
+ className="w-48"
+ placeholder="Search for a publication"
+ value={filterString}
+ onChange={(e) => setFilterString(e.target.value)}
+ onKeyDown={onSearchInputEscape(filterString, setFilterString)}
+ />
+ </div>
+ {isPermissionsLoaded && !canUpdatePublications && (
+ <div className="w-[500px]">
+ <InformationBox
+ icon={<AlertCircle className="text-foreground-light" strokeWidth={2} />}
+ title="You need additional permissions to update database publications"
/>
</div>
- {isPermissionsLoaded && !canUpdatePublications && (
- <div className="w-[500px]">
- <InformationBox
- icon={<AlertCircle className="text-foreground-light" strokeWidth={2} />}
- title="You need additional permissions to update database publications"
- />
- </div>
- )}
- </div>
+ )}
</div>
<div className="w-full overflow-hidden overflow-x-auto">
@@ -163,6 +161,18 @@ export const PublicationsList = () => {
</TableRow>
)}
+ {!isLoading && publications.length === 0 && (
+ <TableRow>
+ <TableCell colSpan={7}>
+ <NoSearchResults
+ searchString={filterString}
+ onResetFilter={() => setFilterString('')}
+ className="border-none !p-0"
+ />
+ </TableCell>
+ </TableRow>
+ )}
+
{isSuccess &&
publications.map((x) => (
<TableRow key={x.name}>
@@ -223,14 +233,6 @@ export const PublicationsList = () => {
</Card>
</div>
- {!isLoading && publications.length === 0 && (
- <NoSearchResults
- searchString={filterString}
- onResetFilter={() => setFilterString('')}
- className="rounded-t-none border-t-0"
- />
- )}
-
<ConfirmationModal
visible={toggleListenEventValue !== null}
title={`Confirm to toggle sending ${toggleListenEventValue?.event.event.toLowerCase()} events`}
diff --git a/apps/studio/components/interfaces/Database/Publications/PublicationsTables.tsx b/apps/studio/components/interfaces/Database/Publications/PublicationsTables.tsx
index 8c55200cdc6..62b6bc38a47 100644
--- a/apps/studio/components/interfaces/Database/Publications/PublicationsTables.tsx
+++ b/apps/studio/components/interfaces/Database/Publications/PublicationsTables.tsx
@@ -1,31 +1,43 @@
import { PermissionAction } from '@supabase/shared-types/out/constants'
import { useParams } from 'common'
-import { ChevronLeft, Search } from 'lucide-react'
-import Link from 'next/link'
-import { useMemo, useState } from 'react'
-import { Card, LogoLoader, Table, TableBody, TableCell, TableHead, TableHeader, TableRow } from 'ui'
+import { Search } from 'lucide-react'
+import { useMemo, useRef, useState } from 'react'
+import { Card, Table, TableBody, TableCell, TableHead, TableHeader, TableRow } from 'ui'
import { Admonition } from 'ui-patterns'
import { Input } from 'ui-patterns/DataInputs/Input'
+import { PublicationTablesSkeleton } from './PublicationSkeleton'
import { PublicationsTableItem } from './PublicationsTableItem'
-import AlertError from '@/components/ui/AlertError'
-import { ButtonTooltip } from '@/components/ui/ButtonTooltip'
+import { AlertError } from '@/components/ui/AlertError'
import { NoSearchResults } from '@/components/ui/NoSearchResults'
import { useDatabasePublicationsQuery } from '@/data/database-publications/database-publications-query'
import { useTablesQuery } from '@/data/tables/tables-query'
import { useAsyncCheckPermissions } from '@/hooks/misc/useCheckPermissions'
import { useSelectedProjectQuery } from '@/hooks/misc/useSelectedProject'
+import { onSearchInputEscape } from '@/lib/keyboard'
+import { SHORTCUT_IDS } from '@/state/shortcuts/registry'
+import { useShortcut } from '@/state/shortcuts/useShortcut'
export const PublicationsTables = () => {
- const { ref, id } = useParams()
+ const { id } = useParams()
const { data: project } = useSelectedProjectQuery()
const [filterString, setFilterString] = useState<string>('')
+ const searchInputRef = useRef<HTMLInputElement>(null)
const { can: canUpdatePublications, isLoading: isLoadingPermissions } = useAsyncCheckPermissions(
PermissionAction.TENANT_SQL_ADMIN_WRITE,
'publications'
)
+ useShortcut(
+ SHORTCUT_IDS.LIST_PAGE_FOCUS_SEARCH,
+ () => {
+ searchInputRef.current?.focus()
+ searchInputRef.current?.select()
+ },
+ { label: 'Search publications' }
+ )
+
const { data: publications = [] } = useDatabasePublicationsQuery({
projectRef: project?.ref,
connectionString: project?.connectionString,
@@ -53,27 +65,16 @@ export const PublicationsTables = () => {
<>
<div className="mb-4">
<div className="flex items-center justify-between">
- <div className="flex items-center space-x-3">
- <ButtonTooltip
- asChild
- type="outline"
- icon={<ChevronLeft />}
- style={{ padding: '5px' }}
- tooltip={{ content: { side: 'bottom', text: 'Go back to publications list' } }}
- >
- <Link href={`/project/${ref}/database/publications`} />
- </ButtonTooltip>
- <div>
- <Input
- size="tiny"
- placeholder="Search for a table"
- value={filterString}
- onChange={(e) => setFilterString(e.target.value)}
- icon={<Search />}
- className="w-48"
- />
- </div>
- </div>
+ <Input
+ size="tiny"
+ ref={searchInputRef}
+ icon={<Search />}
+ className="w-48"
+ placeholder="Search for a table"
+ value={filterString}
+ onChange={(e) => setFilterString(e.target.value)}
+ onKeyDown={onSearchInputEscape(filterString, setFilterString)}
+ />
{!isLoadingPermissions && !canUpdatePublications && (
<Admonition
type="note"
@@ -84,55 +85,69 @@ export const PublicationsTables = () => {
</div>
</div>
- {(isLoading || isLoadingPermissions) && (
- <div className="mt-8">
- <LogoLoader />
- </div>
- )}
+ <Card>
+ <Table>
+ <TableHeader>
+ <TableRow>
+ <TableHead>Name</TableHead>
+ <TableHead>Schema</TableHead>
+ <TableHead className="hidden lg:table-cell">Description</TableHead>
+ {/*
+ We've disabled All tables toggle for publications.
+ See https://github.com/supabase/supabase/pull/7233.
+ */}
+ <TableHead />
+ </TableRow>
+ </TableHeader>
+ <TableBody>
+ {(isLoading || isLoadingPermissions) &&
+ Array.from({ length: 2 }).map((_, i) => (
+ <PublicationTablesSkeleton key={i} index={i} />
+ ))}
+
+ {isError && (
+ <TableRow>
+ <TableCell colSpan={4}>
+ <AlertError error={error} subject="Failed to retrieve tables" />
+ </TableCell>
+ </TableRow>
+ )}
- {isError && <AlertError error={error} subject="Failed to retrieve tables" />}
+ {!isLoading && !isLoadingPermissions && tables.length === 0 && (
+ <TableRow>
+ <TableCell colSpan={4}>
+ <NoSearchResults
+ className="border-none !p-0"
+ searchString={filterString}
+ onResetFilter={() => setFilterString('')}
+ />
+ </TableCell>
+ </TableRow>
+ )}
- {isSuccess &&
- (tables.length === 0 ? (
- <NoSearchResults searchString={filterString} onResetFilter={() => setFilterString('')} />
- ) : (
- <Card>
- <Table>
- <TableHeader>
+ {isSuccess ? (
+ !!selectedPublication ? (
+ tables.map((table) => (
+ <PublicationsTableItem
+ key={table.id}
+ table={table}
+ selectedPublication={selectedPublication}
+ />
+ ))
+ ) : (
<TableRow>
- <TableHead>Name</TableHead>
- <TableHead>Schema</TableHead>
- <TableHead className="hidden lg:table-cell">Description</TableHead>
- {/*
- We've disabled All tables toggle for publications.
- See https://github.com/supabase/supabase/pull/7233.
- */}
- <TableHead />
+ <TableCell colSpan={4}>
+ <p>The selected publication with ID {id} cannot be found</p>
+ <p className="text-foreground-light">
+ Head back to the list of publications to select one from there
+ </p>
+ </TableCell>
</TableRow>
- </TableHeader>
- <TableBody>
- {!!selectedPublication ? (
- tables.map((table) => (
- <PublicationsTableItem
- key={table.id}
- table={table}
- selectedPublication={selectedPublication}
- />
- ))
- ) : (
- <TableRow>
- <TableCell colSpan={4}>
- <p>The selected publication with ID {id} cannot be found</p>
- <p className="text-foreground-light">
- Head back to the list of publications to select one from there
- </p>
- </TableCell>
- </TableRow>
- )}
- </TableBody>
- </Table>
- </Card>
- ))}
+ )
+ ) : null}
+ </TableBody>
+ </Table>
+ </Card>
</>
)
}
diff --git a/apps/studio/pages/project/[ref]/database/publications/[id].tsx b/apps/studio/pages/project/[ref]/database/publications/[id].tsx
index 13c9134f62f..26ba821eea1 100644
--- a/apps/studio/pages/project/[ref]/database/publications/[id].tsx
+++ b/apps/studio/pages/project/[ref]/database/publications/[id].tsx
@@ -1,29 +1,54 @@
import { PermissionAction } from '@supabase/shared-types/out/constants'
+import { useParams } from 'common'
+import { PageContainer, PageSection, PageSectionContent, ShimmeringLoader } from 'ui-patterns'
import { PublicationsTables } from '@/components/interfaces/Database/Publications/PublicationsTables'
import DatabaseLayout from '@/components/layouts/DatabaseLayout/DatabaseLayout'
-import DefaultLayout from '@/components/layouts/DefaultLayout'
-import { ScaffoldContainer, ScaffoldSection } from '@/components/layouts/Scaffold'
-import NoPermission from '@/components/ui/NoPermission'
+import { DefaultLayout } from '@/components/layouts/DefaultLayout'
+import { PageLayout } from '@/components/layouts/PageLayout/PageLayout'
+import { NoPermission } from '@/components/ui/NoPermission'
+import { useDatabasePublicationsQuery } from '@/data/database-publications/database-publications-query'
import { useAsyncCheckPermissions } from '@/hooks/misc/useCheckPermissions'
+import { useSelectedProjectQuery } from '@/hooks/misc/useSelectedProject'
import type { NextPageWithLayout } from '@/types'
const DatabasePublications: NextPageWithLayout = () => {
+ const { ref, id } = useParams()
+ const { data: project } = useSelectedProjectQuery()
const { can: canViewPublications, isSuccess: isPermissionsLoaded } = useAsyncCheckPermissions(
PermissionAction.TENANT_SQL_ADMIN_READ,
'publications'
)
+ const { data: publications = [], isPending } = useDatabasePublicationsQuery({
+ projectRef: project?.ref,
+ connectionString: project?.connectionString,
+ })
+ const selectedPublication = publications.find((pub) => pub.id === Number(id))
+
if (isPermissionsLoaded && !canViewPublications) {
return <NoPermission isFullPage resourceText="view database publications" />
}
return (
- <ScaffoldContainer>
- <ScaffoldSection isFullWidth>
- <PublicationsTables />
- </ScaffoldSection>
- </ScaffoldContainer>
+ <PageLayout
+ title={isPending ? <ShimmeringLoader className="w-40" /> : (selectedPublication?.name ?? '')}
+ breadcrumbs={[
+ {
+ label: 'Publications',
+ href: `/project/${ref}/database/publications`,
+ },
+ ]}
+ size="large"
+ >
+ <PageContainer size="large">
+ <PageSection>
+ <PageSectionContent>
+ <PublicationsTables />
+ </PageSectionContent>
+ </PageSection>
+ </PageContainer>
+ </PageLayout>
)
}
diff --git a/apps/studio/pages/project/[ref]/database/publications/index.tsx b/apps/studio/pages/project/[ref]/database/publications/index.tsx
index 5fc74efeccd..ded564a278a 100644
--- a/apps/studio/pages/project/[ref]/database/publications/index.tsx
+++ b/apps/studio/pages/project/[ref]/database/publications/index.tsx
@@ -1,17 +1,12 @@
import { PermissionAction } from '@supabase/shared-types/out/constants'
import { PageContainer } from 'ui-patterns/PageContainer'
-import {
- PageHeader,
- PageHeaderMeta,
- PageHeaderSummary,
- PageHeaderTitle,
-} from 'ui-patterns/PageHeader'
-import { PageSection, PageSectionContent } from 'ui-patterns/PageSection'
+import { PageSection } from 'ui-patterns/PageSection'
import { PublicationsList } from '@/components/interfaces/Database/Publications/PublicationsList'
import DatabaseLayout from '@/components/layouts/DatabaseLayout/DatabaseLayout'
-import DefaultLayout from '@/components/layouts/DefaultLayout'
-import NoPermission from '@/components/ui/NoPermission'
+import { DefaultLayout } from '@/components/layouts/DefaultLayout'
+import { PageLayout } from '@/components/layouts/PageLayout/PageLayout'
+import { NoPermission } from '@/components/ui/NoPermission'
import { useAsyncCheckPermissions } from '@/hooks/misc/useCheckPermissions'
import type { NextPageWithLayout } from '@/types'
@@ -26,22 +21,13 @@ const DatabasePublications: NextPageWithLayout = () => {
}
return (
- <>
- <PageHeader size="large">
- <PageHeaderMeta>
- <PageHeaderSummary>
- <PageHeaderTitle>Database Publications</PageHeaderTitle>
- </PageHeaderSummary>
- </PageHeaderMeta>
- </PageHeader>
+ <PageLayout title="Database Publications" size="large">
<PageContainer size="large">
- <PageSection>
- <PageSectionContent>
- <PublicationsList />
- </PageSectionContent>
+ <PageSection className="gap-y-4">
+ <PublicationsList />
</PageSection>
</PageContainer>
- </>
+ </PageLayout>
)
}