Files
supabase/apps/studio/components/interfaces/Settings/Database/DiskSizeConfiguration.tsx
Joshen Lim ae046a12f8 Update CTA for manual disk size increase beyond limit (#23255)
* Update CTA for manual disk size increase beyond limit

* Remove unused imports

* Add error handler for sql editor

* Fix clicking supabase icon button in project not closing the nav bar when entering into another project from the home page

* Update copy
2024-04-25 13:21:46 +07:00

285 lines
12 KiB
TypeScript

import * as Tooltip from '@radix-ui/react-tooltip'
import { PermissionAction, SupportCategories } from '@supabase/shared-types/out/constants'
import dayjs from 'dayjs'
import { Info } from 'lucide-react'
import Link from 'next/link'
import { useState } from 'react'
import toast from 'react-hot-toast'
import { number, object } from 'yup'
import { useParams } from 'common'
import { Markdown } from 'components/interfaces/Markdown'
import { useProjectContext } from 'components/layouts/ProjectLayout/ProjectContext'
import { FormHeader } from 'components/ui/Forms'
import Panel from 'components/ui/Panel'
import { useProjectDiskResizeMutation } from 'data/config/project-disk-resize-mutation'
import { useOrgSubscriptionQuery } from 'data/subscriptions/org-subscription-query'
import { useCheckPermissions, useSelectedOrganization } from 'hooks'
import {
AlertDescription_Shadcn_,
AlertTitle_Shadcn_,
Alert_Shadcn_,
Button,
Form,
InputNumber,
Modal,
} from 'ui'
import { WarningIcon } from 'ui-patterns/Icons/StatusIcons'
export interface DiskSizeConfigurationProps {
disabled?: boolean
}
const DiskSizeConfiguration = ({ disabled = false }: DiskSizeConfigurationProps) => {
const { ref: projectRef } = useParams()
const { project } = useProjectContext()
const { lastDatabaseResizeAt } = project ?? {}
const organization = useSelectedOrganization()
const timeTillNextAvailableDatabaseResize =
lastDatabaseResizeAt === null ? 0 : 6 * 60 - dayjs().diff(lastDatabaseResizeAt, 'minutes')
const isAbleToResizeDatabase = timeTillNextAvailableDatabaseResize <= 0
const formattedTimeTillNextAvailableResize =
timeTillNextAvailableDatabaseResize < 60
? `${timeTillNextAvailableDatabaseResize} minute(s)`
: `${Math.floor(timeTillNextAvailableDatabaseResize / 60)} hours and ${
timeTillNextAvailableDatabaseResize % 60
} minute(s)`
const [showResetDbPass, setShowResetDbPass] = useState<boolean>(false)
const canUpdateDiskSizeConfig = useCheckPermissions(PermissionAction.UPDATE, 'projects', {
resource: {
project_id: project?.id,
},
})
const { data: projectSubscriptionData } = useOrgSubscriptionQuery({ orgSlug: organization?.slug })
const { mutate: updateProjectUsage, isLoading: isUpdatingDiskSize } =
useProjectDiskResizeMutation({
onSuccess: (res, variables) => {
toast.success(`Successfully updated disk size to ${variables.volumeSize} GB`)
setShowResetDbPass(false)
},
})
const confirmResetDbPass = async (values: { [prop: string]: any }) => {
if (!projectRef) return console.error('Project ref is required')
const volumeSize = values['new-disk-size']
updateProjectUsage({ projectRef, volumeSize })
}
const currentDiskSize = project?.volumeSizeGb ?? 0
// to do, update with max_disk_volume_size_gb
const maxDiskSize = 200
const INITIAL_VALUES = {
'new-disk-size': currentDiskSize,
}
const diskSizeValidationSchema = object({
'new-disk-size': number()
.required('Please enter a GB amount you want to resize the disk up to.')
.min(Number(currentDiskSize ?? 0), `Must be more than ${currentDiskSize} GB`)
// to do, update with max_disk_volume_size_gb
.max(Number(maxDiskSize), 'Must not be more than 200 GB'),
})
return (
<div id="diskManagement">
<FormHeader title="Disk management" />
{projectSubscriptionData?.usage_billing_enabled === true ? (
<div className="flex flex-col gap-3">
<Panel className="!m-0">
<Panel.Content>
<div className="grid grid-cols-1 items-center lg:grid-cols-3">
<div className="col-span-2 space-y-1">
{currentDiskSize && (
<span className="text-foreground-light flex gap-2 items-baseline">
<span className="text-foreground">Current Disk Storage Size:</span>
<span className="text-foreground text-xl">
{currentDiskSize}
<span className="text-foreground text-sm">GB</span>
</span>
</span>
)}
<p className="text-sm opacity-50">
Supabase employs auto-scaling storage and allows for manual disk size
adjustments when necessary
</p>
</div>
<div className="flex items-end justify-end">
<Tooltip.Root delayDuration={0}>
<Tooltip.Trigger asChild>
<Button
type="default"
disabled={!canUpdateDiskSizeConfig || disabled}
onClick={() => setShowResetDbPass(true)}
>
Increase disk size
</Button>
</Tooltip.Trigger>
{!canUpdateDiskSizeConfig && (
<Tooltip.Portal>
<Tooltip.Content side="bottom">
<Tooltip.Arrow className="radix-tooltip-arrow" />
<div
className={[
'rounded bg-alternative py-1 px-2 leading-none shadow', // background
'border border-background', //border
].join(' ')}
>
<span className="text-xs text-foreground">
You need additional permissions to increase the disk size
</span>
</div>
</Tooltip.Content>
</Tooltip.Portal>
)}
</Tooltip.Root>
</div>
</div>
</Panel.Content>
</Panel>
<Alert_Shadcn_>
<Info size={16} />
<AlertTitle_Shadcn_>Importing a lot of data?</AlertTitle_Shadcn_>
<AlertDescription_Shadcn_>
<Markdown
className="max-w-full"
content={`
We auto-scale your disk as you need more storage, but can only do this every 6 hours.
If you upload more than 1.5x the current size of your storage, your database will go
into read-only mode. If you know how big your database is going to be, you can
manually increase the size here.
Read more about [disk management](https://supabase.com/docs/guides/platform/database-size#disk-management).
`}
/>
</AlertDescription_Shadcn_>
</Alert_Shadcn_>
</div>
) : (
<Alert_Shadcn_>
<Info size={16} />
<AlertTitle_Shadcn_>
{projectSubscriptionData?.plan?.id === 'free'
? 'Disk size configuration is not available for projects on the Free plan'
: 'Disk size configuration is only available when the spend cap has been disabled'}
</AlertTitle_Shadcn_>
<AlertDescription_Shadcn_>
{projectSubscriptionData?.plan?.id === 'free' ? (
<p>
If you are intending to use more than 500MB of disk space, then you will need to
upgrade to at least the Pro plan.
</p>
) : (
<p>
If you are intending to use more than 8GB of disk space, then you will need to
disable your spend cap.
</p>
)}
<Button asChild type="default" className="mt-3">
<Link
href={`/org/${organization?.slug}/billing?panel=${
projectSubscriptionData?.plan?.id === 'free' ? 'subscriptionPlan' : 'costControl'
}`}
target="_blank"
>
{projectSubscriptionData?.plan?.id === 'free'
? 'Upgrade subscription'
: 'Disable spend cap'}
</Link>
</Button>
</AlertDescription_Shadcn_>
</Alert_Shadcn_>
)}
<Modal
header={<h5 className="text-sm text-foreground">Increase Disk Storage Size</h5>}
size="medium"
visible={showResetDbPass}
loading={isUpdatingDiskSize}
onCancel={() => setShowResetDbPass(false)}
hideFooter
>
<Form
name="disk-resize-form"
initialValues={INITIAL_VALUES}
validationSchema={diskSizeValidationSchema}
onSubmit={confirmResetDbPass}
>
{() =>
currentDiskSize >= maxDiskSize ? (
<Alert_Shadcn_ variant="warning" className="rounded-t-none border-0">
<WarningIcon />
<AlertTitle_Shadcn_>Maximum manual disk size increase reached</AlertTitle_Shadcn_>
<AlertDescription_Shadcn_>
<p>
You cannot manually expand the disk size any more than {maxDiskSize}GB. If you
need more than this, contact us via support for help.
</p>
<Button asChild type="default" className="mt-3">
<Link
href={`/support/new?ref=${projectRef}&category=${SupportCategories.PERFORMANCE_ISSUES}&subject=Increase%20disk%20size%20beyond%20200GB`}
>
Contact support
</Link>
</Button>
</AlertDescription_Shadcn_>
</Alert_Shadcn_>
) : (
<>
<Modal.Content>
<div className="w-full space-y-4 py-6">
<Alert_Shadcn_ variant={isAbleToResizeDatabase ? 'default' : 'warning'}>
<Info size={16} />
<AlertTitle_Shadcn_>
This operation is only possible every 6 hours
</AlertTitle_Shadcn_>
<AlertDescription_Shadcn_>
{isAbleToResizeDatabase
? `Upon updating your disk size, the next disk size update will only be available from ${dayjs().format(
'DD MMM YYYY, HH:mm (ZZ)'
)}`
: `Your database was last resized at ${dayjs(lastDatabaseResizeAt).format(
'DD MMM YYYY, HH:mm (ZZ)'
)}. You can resize your database again in approximately ${formattedTimeTillNextAvailableResize}`}
</AlertDescription_Shadcn_>
</Alert_Shadcn_>
<InputNumber
required
id="new-disk-size"
label="New disk size"
labelOptional="GB"
disabled={!isAbleToResizeDatabase}
/>
</div>
</Modal.Content>
<Modal.Separator />
<Modal.Content>
<div className="flex space-x-2 justify-end pt-1 pb-3">
<Button type="default" onClick={() => setShowResetDbPass(false)}>
Cancel
</Button>
<Button
htmlType="submit"
type="primary"
disabled={!isAbleToResizeDatabase || isUpdatingDiskSize}
loading={isUpdatingDiskSize}
>
Update disk size
</Button>
</div>
</Modal.Content>
</>
)
}
</Form>
</Modal>
</div>
)
}
export default DiskSizeConfiguration