Files
supabase/apps/studio/components/interfaces/Storage/StorageMenu.tsx
Danny White 16fa59f127 feat: sticky storage config (#37654)
* feat: move storage settings

* feat: redirect

* feat: database settings in service area

* feat: move data api settings

* fix: revert data API placement

* feat: minor UX touches

* fix: simplify configuration group

* feat: references to database settings

* feat: references to storage settings

* fix: redirects and formatting

* fix: Import StorageMenu dynamically to avoid SSR issues with useLocalStorage

* feat: sticky sidebar footer

* fix: move Data API closer to semantic siblings

* fix: revert smart comma

* Shift bucket sort logic into storage explorer store

* Small fix and clean up

* fix: correct background-color class

---------

Co-authored-by: Joshen Lim <joshenlimek@gmail.com>
2025-08-05 23:47:23 +00:00

226 lines
8.4 KiB
TypeScript

import { PermissionAction } from '@supabase/shared-types/out/constants'
import { Edit } from 'lucide-react'
import Link from 'next/link'
import { useRouter } from 'next/router'
import { useState } from 'react'
import { useParams } from 'common'
import { DeleteBucketModal } from 'components/interfaces/Storage'
import CreateBucketModal from 'components/interfaces/Storage/CreateBucketModal'
import EditBucketModal from 'components/interfaces/Storage/EditBucketModal'
import { EmptyBucketModal } from 'components/interfaces/Storage/EmptyBucketModal'
import { ButtonTooltip } from 'components/ui/ButtonTooltip'
import ShimmeringLoader from 'components/ui/ShimmeringLoader'
import { Bucket, useBucketsQuery } from 'data/storage/buckets-query'
import { useCheckPermissions } from 'hooks/misc/useCheckPermissions'
import { useSelectedProjectQuery } from 'hooks/misc/useSelectedProject'
import { useStorageExplorerStateSnapshot } from 'state/storage-explorer'
import { Alert_Shadcn_, AlertDescription_Shadcn_, AlertTitle_Shadcn_, Menu } from 'ui'
import {
InnerSideBarEmptyPanel,
InnerSideBarFilters,
InnerSideBarFilterSearchInput,
InnerSideBarFilterSortDropdown,
InnerSideBarFilterSortDropdownItem,
} from 'ui-patterns/InnerSideMenu'
import BucketRow from './BucketRow'
const StorageMenu = () => {
const router = useRouter()
const { ref, bucketId } = useParams()
const { data: project } = useSelectedProjectQuery()
const snap = useStorageExplorerStateSnapshot()
const isBranch = project?.parent_project_ref !== undefined
const [searchText, setSearchText] = useState<string>('')
const [showCreateBucketModal, setShowCreateBucketModal] = useState(false)
const [selectedBucketToEdit, setSelectedBucketToEdit] = useState<Bucket>()
const [selectedBucketToEmpty, setSelectedBucketToEmpty] = useState<Bucket>()
const [selectedBucketToDelete, setSelectedBucketToDelete] = useState<Bucket>()
const canCreateBuckets = useCheckPermissions(PermissionAction.STORAGE_WRITE, '*')
const page = router.pathname.split('/')[4] as
| undefined
| 'policies'
| 'settings'
| 'usage'
| 'logs'
const {
data: buckets = [],
error,
isLoading,
isError,
isSuccess,
} = useBucketsQuery({ projectRef: ref })
const sortedBuckets =
snap.sortBucket === 'alphabetical'
? buckets.sort((a, b) =>
a.name.toLowerCase().trim().localeCompare(b.name.toLowerCase().trim())
)
: buckets.sort((a, b) => (new Date(b.created_at) > new Date(a.created_at) ? -1 : 1))
const filteredBuckets =
searchText.length > 1
? sortedBuckets.filter((bucket) => bucket.name.includes(searchText.trim()))
: sortedBuckets
const tempNotSupported = error?.message.includes('Tenant config') && isBranch
return (
<>
<Menu type="pills" className="mt-6 flex flex-grow flex-col">
<div className="mb-6 mx-5 flex flex-col gap-y-1.5">
<ButtonTooltip
block
type="default"
icon={<Edit />}
disabled={!canCreateBuckets}
style={{ justifyContent: 'start' }}
onClick={() => setShowCreateBucketModal(true)}
tooltip={{
content: {
side: 'bottom',
text: !canCreateBuckets
? 'You need additional permissions to create buckets'
: undefined,
},
}}
>
New bucket
</ButtonTooltip>
<InnerSideBarFilters className="px-0">
<InnerSideBarFilterSearchInput
name="search-buckets"
aria-labelledby="Search buckets"
placeholder="Search buckets..."
value={searchText}
onChange={(e) => {
setSearchText(e.target.value)
}}
>
<InnerSideBarFilterSortDropdown
value={snap.sortBucket}
onValueChange={(value: any) => snap.setSortBucket(value)}
>
<InnerSideBarFilterSortDropdownItem
key="alphabetical"
value="alphabetical"
className="flex gap-2"
>
Alphabetical
</InnerSideBarFilterSortDropdownItem>
<InnerSideBarFilterSortDropdownItem key="created-at" value="created-at">
Created at
</InnerSideBarFilterSortDropdownItem>
</InnerSideBarFilterSortDropdown>
</InnerSideBarFilterSearchInput>
</InnerSideBarFilters>
</div>
<div className="space-y-6">
<div className="mx-3">
<Menu.Group title={<span className="uppercase font-mono">All buckets</span>} />
{isLoading && (
<div className="space-y-2 mx-2">
<ShimmeringLoader className="!py-2.5" />
<ShimmeringLoader className="!py-2.5" />
<ShimmeringLoader className="!py-2.5" />
</div>
)}
{isError && (
<div className="px-2">
<Alert_Shadcn_ variant={tempNotSupported ? 'default' : 'warning'}>
<AlertTitle_Shadcn_ className="text-xs tracking-normal">
{tempNotSupported
? 'Storage is not available on preview branches for now'
: 'Failed to fetch buckets'}
</AlertTitle_Shadcn_>
<AlertDescription_Shadcn_ className="text-xs">
{tempNotSupported
? "We're actively looking into making this available on preview branches"
: 'Please refresh to try again'}
</AlertDescription_Shadcn_>
</Alert_Shadcn_>
</div>
)}
{isSuccess && (
<>
{buckets.length === 0 && (
<InnerSideBarEmptyPanel
className="mx-2"
title="No buckets available"
description="Buckets that you create will appear here"
/>
)}
{searchText.length > 0 && filteredBuckets.length === 0 && (
<InnerSideBarEmptyPanel
className="mx-2"
title="No results found"
description={`Your search for "${searchText}" did not return any results`}
/>
)}
{filteredBuckets.map((bucket, idx: number) => {
const isSelected = bucketId === bucket.id
return (
<BucketRow
key={`${idx}_${bucket.id}`}
bucket={bucket}
projectRef={ref}
isSelected={isSelected}
onSelectEmptyBucket={() => setSelectedBucketToEmpty(bucket)}
onSelectDeleteBucket={() => setSelectedBucketToDelete(bucket)}
onSelectEditBucket={() => setSelectedBucketToEdit(bucket)}
/>
)
})}
</>
)}
</div>
<div className="w-full bg-dash-sidebar px-3 py-6 sticky bottom-0 border-t border-border">
<Menu.Group title={<span className="uppercase font-mono">Configuration</span>} />
<Link href={`/project/${ref}/storage/policies`}>
<Menu.Item rounded active={page === 'policies'}>
<p className="truncate">Policies</p>
</Menu.Item>
</Link>
<Link href={`/project/${ref}/storage/settings`}>
<Menu.Item rounded active={page === 'settings'}>
<p className="truncate">Settings</p>
</Menu.Item>
</Link>
</div>
</div>
</Menu>
<CreateBucketModal
visible={showCreateBucketModal}
onClose={() => setShowCreateBucketModal(false)}
/>
<EditBucketModal
visible={selectedBucketToEdit !== undefined}
bucket={selectedBucketToEdit}
onClose={() => setSelectedBucketToEdit(undefined)}
/>
<EmptyBucketModal
visible={selectedBucketToEmpty !== undefined}
bucket={selectedBucketToEmpty}
onClose={() => setSelectedBucketToEmpty(undefined)}
/>
<DeleteBucketModal
visible={selectedBucketToDelete !== undefined}
bucket={selectedBucketToDelete}
onClose={() => setSelectedBucketToDelete(undefined)}
/>
</>
)
}
export default StorageMenu