Skip to content

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

feat(studio): sortable projects (#43118)

Danny White487c74f1744a
diff --git a/apps/studio/components/interfaces/Auth/Users/SortDropdown.tsx b/apps/studio/components/interfaces/Auth/Users/SortDropdown.tsx
index 900e42ee314..173d0cdac7e 100644
--- a/apps/studio/components/interfaces/Auth/Users/SortDropdown.tsx
+++ b/apps/studio/components/interfaces/Auth/Users/SortDropdown.tsx
@@ -1,6 +1,5 @@
import { ButtonTooltip } from 'components/ui/ButtonTooltip'
import { ArrowDownNarrowWide, ArrowDownWideNarrow } from 'lucide-react'
-
import {
Button,
DropdownMenu,
@@ -24,6 +23,7 @@ interface SortDropdownProps {
improvedSearchEnabled: boolean
}
+/** [Joshen] To refactor to use the SortDropdown component in components/ui */
export const SortDropdown = ({
specificFilterColumn,
sortColumn,
diff --git a/apps/studio/components/interfaces/Home/ProjectList/ProjectList.tsx b/apps/studio/components/interfaces/Home/ProjectList/ProjectList.tsx
index f3c0c18b0d1..96b9c286896 100644
--- a/apps/studio/components/interfaces/Home/ProjectList/ProjectList.tsx
+++ b/apps/studio/components/interfaces/Home/ProjectList/ProjectList.tsx
@@ -1,5 +1,3 @@
-import { useMemo } from 'react'
-
import { keepPreviousData } from '@tanstack/react-query'
import { useDebounce } from '@uidotdev/usehooks'
import { LOCAL_STORAGE_KEYS, useParams } from 'common'
@@ -13,12 +11,30 @@ import { useResourceWarningsQuery } from 'data/usage/resource-warnings-query'
import { useLocalStorageQuery } from 'hooks/misc/useLocalStorage'
import { useSelectedOrganizationQuery } from 'hooks/misc/useSelectedOrganization'
import { IS_PLATFORM } from 'lib/constants'
-import { parseAsArrayOf, parseAsString, useQueryState } from 'nuqs'
+import { parseAsArrayOf, parseAsString, parseAsStringLiteral, useQueryState } from 'nuqs'
+import { useMemo } from 'react'
import type { Organization } from 'types'
-import { Card, cn, Table, TableBody, TableCell, TableHead, TableHeader, TableRow } from 'ui'
+import {
+ Card,
+ cn,
+ Table,
+ TableBody,
+ TableCell,
+ TableHead,
+ TableHeader,
+ TableHeadSort,
+ TableRow,
+} from 'ui'
+
import { LoadingCardView, LoadingTableView, NoProjectsState } from './EmptyStates'
import { LoadMoreRows } from './LoadMoreRow'
import { ProjectCard } from './ProjectCard'
+import {
+ getNextProjectListSortForColumn,
+ getProjectListAriaSort,
+ PROJECT_LIST_SORT_VALUES,
+ toTableHeadSortValue,
+} from './ProjectListSort.utils'
import { ProjectTableRow } from './ProjectTableRow'
export interface ProjectListProps {
@@ -37,6 +53,10 @@ export const ProjectList = ({ organization: organization_, rewriteHref }: Projec
'status',
parseAsArrayOf(parseAsString, ',').withDefault([])
)
+ const [sort, setSort] = useQueryState(
+ 'sort',
+ parseAsStringLiteral(PROJECT_LIST_SORT_VALUES).withDefault('name_asc')
+ )
const [viewMode] = useLocalStorageQuery(LOCAL_STORAGE_KEYS.PROJECTS_VIEW, 'grid')
const organization = organization_ ?? selectedOrganization
@@ -54,6 +74,7 @@ export const ProjectList = ({ organization: organization_, rewriteHref }: Projec
} = useOrgProjectsInfiniteQuery(
{
slug,
+ sort,
search: search.length === 0 ? search : debouncedSearch,
statuses: filterStatus,
},
@@ -81,7 +102,6 @@ export const ProjectList = ({ organization: organization_, rewriteHref }: Projec
debouncedSearch.length === 0 &&
filterStatus.length === 0 &&
(!orgProjects || orgProjects.length === 0)
- const sortedProjects = [...(orgProjects || [])].sort((a, b) => a.name.localeCompare(b.name))
const noResultsFromSearch =
debouncedSearch.length > 0 && isSuccessProjects && orgProjects.length === 0
@@ -89,6 +109,7 @@ export const ProjectList = ({ organization: organization_, rewriteHref }: Projec
filterStatus.length > 0 && isSuccessProjects && orgProjects.length === 0
const noResults = noResultsFromStatusFilter || noResultsFromSearch
+ const tableHeadSortValue = toTableHeadSortValue(sort)
const githubConnections = connections?.map((connection) => ({
id: String(connection.id),
@@ -143,18 +164,52 @@ export const ProjectList = ({ organization: organization_, rewriteHref }: Projec
{/* [Joshen] Ideally we can figure out sticky table headers here */}
<TableHeader>
<TableRow>
- <TableHead className={cn(noResults && 'text-foreground-muted')}>Project</TableHead>
+ <TableHead
+ className={cn(noResults && 'text-foreground-muted')}
+ aria-sort={getProjectListAriaSort(sort)}
+ >
+ <TableHeadSort
+ column="name"
+ currentSort={tableHeadSortValue}
+ onSortChange={() => {
+ const sortValue = sort.includes('created')
+ ? 'name_asc'
+ : getNextProjectListSortForColumn(sort)
+ setSort(sortValue)
+ }}
+ className={cn(noResults && 'text-foreground-muted')}
+ >
+ Project
+ </TableHeadSort>
+ </TableHead>
<TableHead className={cn(noResults && 'text-foreground-muted')}>Status</TableHead>
<TableHead className={cn(noResults && 'text-foreground-muted')}>Compute</TableHead>
<TableHead className={cn(noResults && 'text-foreground-muted')}>Region</TableHead>
- <TableHead className={cn(noResults && 'text-foreground-muted')}>Created</TableHead>
+ <TableHead
+ className={cn(noResults && 'text-foreground-muted')}
+ aria-sort={getProjectListAriaSort(sort)}
+ >
+ <TableHeadSort
+ column="created"
+ currentSort={tableHeadSortValue}
+ onSortChange={() => {
+ const sortValue = sort.includes('name')
+ ? 'created_asc'
+ : getNextProjectListSortForColumn(sort)
+ setSort(sortValue)
+ }}
+ className={cn(noResults && 'text-foreground-muted')}
+ >
+ Created
+ </TableHeadSort>
+ </TableHead>
<TableHead className={cn(noResults && 'text-foreground-muted')} />
</TableRow>
</TableHeader>
<TableBody>
{noResultsFromStatusFilter ? (
<TableRow className="[&>td]:hover:bg-inherit">
- <TableCell colSpan={5}>
+ <TableCell colSpan={6}>
<NoSearchResults
withinTableCell
label={
@@ -169,13 +224,13 @@ export const ProjectList = ({ organization: organization_, rewriteHref }: Projec
</TableRow>
) : noResultsFromSearch ? (
<TableRow className="[&>td]:hover:bg-inherit">
- <TableCell colSpan={5}>
+ <TableCell colSpan={6}>
<NoSearchResults searchString={search} withinTableCell />
</TableCell>
</TableRow>
) : (
<>
- {sortedProjects?.map((project) => (
+ {orgProjects?.map((project) => (
<ProjectTableRow
key={project.ref}
project={project}
@@ -230,7 +285,7 @@ export const ProjectList = ({ organization: organization_, rewriteHref }: Projec
'sm:grid-cols-1 md:grid-cols-1 lg:grid-cols-2 xl:grid-cols-3'
)}
>
- {sortedProjects?.map((project) => (
+ {orgProjects?.map((project) => (
<ProjectCard
key={project.ref}
slug={slug}
diff --git a/apps/studio/components/interfaces/Home/ProjectList/ProjectListSort.utils.ts b/apps/studio/components/interfaces/Home/ProjectList/ProjectListSort.utils.ts
new file mode 100644
index 00000000000..4175309dfab
--- /dev/null
+++ b/apps/studio/components/interfaces/Home/ProjectList/ProjectListSort.utils.ts
@@ -0,0 +1,24 @@
+export const PROJECT_LIST_SORT_VALUES = [
+ 'name_asc',
+ 'name_desc',
+ 'created_desc',
+ 'created_asc',
+] as const
+
+export type ProjectListSort = (typeof PROJECT_LIST_SORT_VALUES)[number]
+
+export const toTableHeadSortValue = (sort: ProjectListSort) => sort.replace('_', ':')
+
+export const getNextProjectListSortForColumn = (currentSort: ProjectListSort): ProjectListSort => {
+ if (currentSort.includes('asc')) return currentSort.replace('asc', 'desc') as ProjectListSort
+ if (currentSort.includes('desc')) return currentSort.replace('desc', 'asc') as ProjectListSort
+ return 'name_asc'
+}
+
+export const getProjectListAriaSort = (
+ currentSort: ProjectListSort
+): 'ascending' | 'descending' | 'none' => {
+ if (currentSort.includes('asc')) return 'ascending'
+ if (currentSort.includes('desc')) return 'descending'
+ return 'none'
+}
diff --git a/apps/studio/components/interfaces/HomePageActions.tsx b/apps/studio/components/interfaces/HomePageActions.tsx
index 0667f73c2cf..105588fd130 100644
--- a/apps/studio/components/interfaces/HomePageActions.tsx
+++ b/apps/studio/components/interfaces/HomePageActions.tsx
@@ -1,30 +1,30 @@
import { keepPreviousData } from '@tanstack/react-query'
import { useDebounce } from '@uidotdev/usehooks'
import { LOCAL_STORAGE_KEYS, useParams } from 'common'
+import {
+ PROJECT_LIST_SORT_VALUES,
+ type ProjectListSort,
+} from 'components/interfaces/Home/ProjectList/ProjectListSort.utils'
import { useOrgProjectsInfiniteQuery } from 'data/projects/org-projects-infinite-query'
import { useIsFeatureEnabled } from 'hooks/misc/useIsFeatureEnabled'
import { useLocalStorageQuery } from 'hooks/misc/useLocalStorage'
import { PROJECT_STATUS } from 'lib/constants'
import { Grid, List, Loader2, Plus, Search, X } from 'lucide-react'
import Link from 'next/link'
-import { parseAsArrayOf, parseAsString, useQueryState } from 'nuqs'
+import { parseAsArrayOf, parseAsString, parseAsStringLiteral, useQueryState } from 'nuqs'
import { useEffect } from 'react'
import { Button, ToggleGroup, ToggleGroupItem } from 'ui'
import { Input } from 'ui-patterns/DataInputs/Input'
import { FilterPopover } from '../ui/FilterPopover'
+import { SortDropdown } from '../ui/SortDropdown'
interface HomePageActionsProps {
slug?: string
hideNewProject?: boolean
- showViewToggle?: boolean
}
-export const HomePageActions = ({
- slug: _slug,
- hideNewProject = false,
- showViewToggle = false,
-}: HomePageActionsProps) => {
+export const HomePageActions = ({ slug: _slug, hideNewProject = false }: HomePageActionsProps) => {
const { slug: urlSlug } = useParams()
const projectCreationEnabled = useIsFeatureEnabled('projects:create')
@@ -35,15 +35,22 @@ export const HomePageActions = ({
'status',
parseAsArrayOf(parseAsString, ',').withDefault([])
)
+ const [sort, setSort] = useQueryState(
+ 'sort',
+ parseAsStringLiteral(PROJECT_LIST_SORT_VALUES).withDefault('name_asc')
+ )
const [viewMode, setViewMode] = useLocalStorageQuery(LOCAL_STORAGE_KEYS.PROJECTS_VIEW, 'grid')
- const [filterStatusStorage, setFilterStatusStorage, { isSuccess }] = useLocalStorageQuery<
- string[]
- >(LOCAL_STORAGE_KEYS.PROJECTS_FILTER, [])
+ const [filterStatusStorage, setFilterStatusStorage, { isSuccess: isSuccessFilterStatusStorage }] =
+ useLocalStorageQuery<string[]>(LOCAL_STORAGE_KEYS.PROJECTS_FILTER, [])
+
+ const [sortStorage, setSortStorage, { isSuccess: isSuccessSortStorage }] =
+ useLocalStorageQuery<ProjectListSort>(LOCAL_STORAGE_KEYS.PROJECTS_SORT, 'name_asc')
const { isFetching: isFetchingProjects } = useOrgProjectsInfiniteQuery(
{
slug,
+ sort,
search: search.length === 0 ? search : debouncedSearch,
statuses: filterStatus,
},
@@ -51,11 +58,15 @@ export const HomePageActions = ({
)
useEffect(() => {
- if (isSuccess && !!urlSlug) setFilterStatus(filterStatusStorage)
- }, [filterStatusStorage, isSuccess, urlSlug, setFilterStatus])
+ if (isSuccessFilterStatusStorage && !!slug) setFilterStatus(filterStatusStorage)
+ }, [filterStatusStorage, isSuccessFilterStatusStorage, setFilterStatus, slug])
+
+ useEffect(() => {
+ if (isSuccessSortStorage && slug) setSort(sortStorage)
+ }, [sortStorage, isSuccessSortStorage, setSort, slug])
return (
- <div className="flex items-center justify-between">
+ <div className="flex items-center justify-between w-full">
<div className="flex items-center gap-2">
<Input
placeholder="Search for a project"
@@ -91,11 +102,20 @@ export const HomePageActions = ({
onSaveFilters={(options) => setFilterStatusStorage(options)}
/>
+ <SortDropdown
+ options={[
+ { label: 'name', value: 'name' },
+ { label: 'creation date', value: 'created' },
+ ]}
+ value={sort}
+ setValue={(val) => setSortStorage(val as ProjectListSort)}
+ />
+
{isFetchingProjects && <Loader2 className="animate-spin" size={14} />}
</div>
<div className="flex items-center gap-2">
- {showViewToggle && viewMode && setViewMode && (
+ {viewMode && setViewMode && (
<ToggleGroup
type="single"
size="sm"
diff --git a/apps/studio/components/ui/SortDropdown.tsx b/apps/studio/components/ui/SortDropdown.tsx
new file mode 100644
index 00000000000..a47308b87e5
--- /dev/null
+++ b/apps/studio/components/ui/SortDropdown.tsx
@@ -0,0 +1,61 @@
+import { ArrowDownNarrowWide, ArrowDownWideNarrow } from 'lucide-react'
+import {
+ Button,
+ DropdownMenu,
+ DropdownMenuContent,
+ DropdownMenuRadioGroup,
+ DropdownMenuRadioItem,
+ DropdownMenuSub,
+ DropdownMenuSubContent,
+ DropdownMenuSubTrigger,
+ DropdownMenuTrigger,
+} from 'ui'
+
+type SortOption = {
+ label: string
+ value: string
+}
+
+interface SortDropdownProps {
+ options: SortOption[]
+ value: string
+ setValue: (value: string) => void
+}
+
+export const SortDropdown = ({ options, value, setValue }: SortDropdownProps) => {
+ const [sortColumn, sortOrder] = value.split('_')
+ const columnLabel = options.find((x) => x.value === sortColumn)?.label
+
+ return (
+ <DropdownMenu>
+ <DropdownMenuTrigger asChild>
+ <Button
+ type="default"
+ icon={sortOrder === 'desc' ? <ArrowDownWideNarrow /> : <ArrowDownNarrowWide />}
+ >
+ Sorted by {columnLabel ?? sortColumn}
+ </Button>
+ </DropdownMenuTrigger>
+
+ <DropdownMenuContent className="w-44" align="start">
+ <DropdownMenuRadioGroup value={value} onValueChange={setValue}>
+ {options.map((option) => {
+ return (
+ <DropdownMenuSub key={option.value}>
+ <DropdownMenuSubTrigger>Sort by {option.label}</DropdownMenuSubTrigger>
+ <DropdownMenuSubContent>
+ <DropdownMenuRadioItem value={`${option.value}_asc`}>
+ Ascending
+ </DropdownMenuRadioItem>
+ <DropdownMenuRadioItem value={`${option.value}_desc`}>
+ Descending
+ </DropdownMenuRadioItem>
+ </DropdownMenuSubContent>
+ </DropdownMenuSub>
+ )
+ })}
+ </DropdownMenuRadioGroup>
+ </DropdownMenuContent>
+ </DropdownMenu>
+ )
+}
diff --git a/apps/studio/data/auth/auth-config-query.ts b/apps/studio/data/auth/auth-config-query.ts
index 514157b29d1..78629c57d95 100644
--- a/apps/studio/data/auth/auth-config-query.ts
+++ b/apps/studio/data/auth/auth-config-query.ts
@@ -4,6 +4,7 @@ import { get, handleError } from 'data/fetchers'
import { IS_PLATFORM } from 'lib/constants'
import { useCallback } from 'react'
import type { ResponseError, UseCustomQueryOptions } from 'types'
+
import { authKeys } from './keys'
export type AuthConfigVariables = {
@@ -40,7 +41,7 @@ export const useAuthConfigQuery = <TData = ProjectAuthConfigData>(
useQuery<ProjectAuthConfigData, ProjectAuthConfigError, TData>({
queryKey: authKeys.authConfig(projectRef),
queryFn: ({ signal }) => getProjectAuthConfig({ projectRef }, signal),
- enabled: enabled && IS_PLATFORM && typeof projectRef !== 'undefined',
+ enabled: enabled && IS_PLATFORM && typeof projectRef !== 'undefined' && projectRef !== '_',
...options,
})
diff --git a/apps/studio/data/config/project-storage-config-query.ts b/apps/studio/data/config/project-storage-config-query.ts
index 1b4e60bbc9a..49f78d1fdda 100644
--- a/apps/studio/data/config/project-storage-config-query.ts
+++ b/apps/studio/data/config/project-storage-config-query.ts
@@ -1,9 +1,9 @@
import { useQuery } from '@tanstack/react-query'
-
import { components } from 'data/api'
import { get, handleError } from 'data/fetchers'
import { IS_PLATFORM } from 'lib/constants'
import type { ResponseError, UseCustomQueryOptions } from 'types'
+
import { configKeys } from './keys'
export type ProjectStorageConfigVariables = {
@@ -48,7 +48,7 @@ export const useProjectStorageConfigQuery = <TData = ProjectStorageConfigData>(
useQuery<ProjectStorageConfigData, ProjectStorageConfigError, TData>({
queryKey: configKeys.storage(projectRef),
queryFn: ({ signal }) => getProjectStorageConfig({ projectRef }, signal),
- enabled: enabled && IS_PLATFORM && typeof projectRef !== 'undefined',
+ enabled: enabled && IS_PLATFORM && typeof projectRef !== 'undefined' && projectRef !== '_',
...options,
})
diff --git a/apps/studio/pages/org/[slug]/index.tsx b/apps/studio/pages/org/[slug]/index.tsx
index bb42b54ccc1..b223258fe71 100644
--- a/apps/studio/pages/org/[slug]/index.tsx
+++ b/apps/studio/pages/org/[slug]/index.tsx
@@ -1,5 +1,3 @@
-import Link from 'next/link'
-
import { useIsMFAEnabled } from 'common'
import { ProjectList } from 'components/interfaces/Home/ProjectList/ProjectList'
import { HomePageActions } from 'components/interfaces/HomePageActions'
@@ -8,6 +6,7 @@ import OrganizationLayout from 'components/layouts/OrganizationLayout'
import { PageLayout } from 'components/layouts/PageLayout/PageLayout'
import { ScaffoldContainer, ScaffoldSection } from 'components/layouts/Scaffold'
import { useSelectedOrganizationQuery } from 'hooks/misc/useSelectedOrganization'
+import Link from 'next/link'
import type { NextPageWithLayout } from 'types'
import { Button } from 'ui'
import { Admonition } from 'ui-patterns'
@@ -40,7 +39,7 @@ const ProjectsPage: NextPageWithLayout = () => {
/>
) : (
<div className="flex flex-col gap-y-4">
- <HomePageActions showViewToggle={true} />
+ <HomePageActions />
<ProjectList />
</div>
)}
diff --git a/apps/studio/pages/project/_/[[...routeSlug]].tsx b/apps/studio/pages/project/_/[[...routeSlug]].tsx
index e80b6cc3bf7..97fd1241512 100644
--- a/apps/studio/pages/project/_/[[...routeSlug]].tsx
+++ b/apps/studio/pages/project/_/[[...routeSlug]].tsx
@@ -1,8 +1,3 @@
-import { AlertTriangleIcon } from 'lucide-react'
-import { NextPage } from 'next'
-import { useRouter } from 'next/router'
-import { useEffect, useState } from 'react'
-
import { IS_PLATFORM, LOCAL_STORAGE_KEYS, useParams } from 'common'
import {
Header,
@@ -16,6 +11,10 @@ import { ScaffoldContainer, ScaffoldSection } from 'components/layouts/Scaffold'
import { useOrganizationsQuery } from 'data/organizations/organizations-query'
import { useLocalStorageQuery } from 'hooks/misc/useLocalStorage'
import { withAuth } from 'hooks/misc/withAuth'
+import { AlertTriangleIcon } from 'lucide-react'
+import { NextPage } from 'next'
+import { useRouter } from 'next/router'
+import { useEffect, useState } from 'react'
import {
Alert_Shadcn_,
AlertDescription_Shadcn_,
diff --git a/packages/common/constants/local-storage.ts b/packages/common/constants/local-storage.ts
index 55d7e1ecc11..174d43c2450 100644
--- a/packages/common/constants/local-storage.ts
+++ b/packages/common/constants/local-storage.ts
@@ -8,6 +8,7 @@ export const LOCAL_STORAGE_KEYS = {
EDITOR_PANEL_STATE: 'supabase-editor-panel-state',
PROJECTS_VIEW: 'projects-view',
PROJECTS_FILTER: 'projects-filter',
+ PROJECTS_SORT: 'projects-sort',
FEEDBACK_WIDGET_CONTENT: 'feedback-widget-content',
FEEDBACK_WIDGET_SCREENSHOT: 'feedback-widget-screenshot',
INCIDENT_BANNER_DISMISSED: (id: string) => `incident-banner-dismissed-${id}`,