Skip to content

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

10.5 KB
Raw Blame
import Link from 'next/link'
import { useEffect, useMemo } from 'react'
import { Alert, AlertDescription, AlertTitle, Button, cn, CriticalIcon } from 'ui'
import { InfoTooltip } from 'ui-patterns/info-tooltip'
import { ShimmeringLoader } from 'ui-patterns/ShimmeringLoader'

import { SectionContent } from '../SectionContent'
import { CategoryAttribute } from '../Usage.constants'
import { getInfrastructurePath } from '@/components/interfaces/Settings/Infrastructure/Infrastructure.utils'
import { AlertError } from '@/components/ui/AlertError'
import Panel from '@/components/ui/Panel'
import { PricingMetric } from '@/data/analytics/org-daily-stats-query'
import { useOrgProjectsInfiniteQuery } from '@/data/projects/org-projects-infinite-query'
import type { OrgSubscription } from '@/data/subscriptions/types'
import { OrgUsageResponse } from '@/data/usage/org-usage-query'
import { PROJECT_STATUS } from '@/lib/constants'

export interface DiskUsageProps {
  slug: string
  projectRef?: string | null
  attribute: CategoryAttribute
  subscription?: OrgSubscription
  usage?: OrgUsageResponse

  currentBillingCycleSelected: boolean
}

export const DiskUsage = ({
  slug,
  projectRef,
  attribute,
  subscription,
  usage,
  currentBillingCycleSelected,
}: DiskUsageProps) => {
  const { data, isError, isPending, isFetching, isSuccess, error, hasNextPage, fetchNextPage } =
    useOrgProjectsInfiniteQuery({ slug }, { enabled: currentBillingCycleSelected })
  const projects = useMemo(() => data?.pages.flatMap((page) => page.projects) || [], [data?.pages])
  const shouldFindSelectedProject =
    currentBillingCycleSelected &&
    !!projectRef &&
    !projects.some((project) => project.ref === projectRef) &&
    hasNextPage &&
    !isError
  const isLoading = isPending || shouldFindSelectedProject

  useEffect(() => {
    if (shouldFindSelectedProject && !isFetching) {
      void fetchNextPage()
    }
  }, [shouldFindSelectedProject, isFetching, fetchNextPage])

  const relevantProjects = useMemo(() => {
    return isSuccess
      ? projects
          .filter((project) => {
            // We do want to show branches that are exceeding the 8 GB limit, as people could have persistent or very long-living branches
            const isBranchExceedingFreeQuota =
              project.is_branch && project.databases.some((db) => (db.disk_volume_size_gb ?? 8) > 8)

            const isFilteredBranch = project.is_branch && project.ref === projectRef

            const isActiveProject = project.status !== PROJECT_STATUS.INACTIVE

            const isHostedOnAws = project.databases.every((db) => db.cloud_provider === 'AWS')

            return (
              (!project.is_branch || isBranchExceedingFreeQuota || isFilteredBranch) &&
              isActiveProject &&
              isHostedOnAws
            )
          })
          .filter((it) => it.ref === projectRef || !projectRef)
      : []
  }, [isSuccess, projects, projectRef])

  const hasReplicas = useMemo(
    () => relevantProjects.some((it) => it.databases.some((db) => db.type === 'READ_REPLICA')),
    [relevantProjects]
  )

  const hasProjectsExceedingDiskSize = useMemo(() => {
    return relevantProjects.some((it) =>
      it.databases.some((db) => db.disk_volume_size_gb && db.disk_volume_size_gb > 8)
    )
  }, [relevantProjects])

  const gp3UsageInPeriod = usage?.usages.find(
    (it) => it.metric === PricingMetric.DISK_SIZE_GB_HOURS_GP3
  )
  const io2UsageInPeriod = usage?.usages.find(
    (it) => it.metric === PricingMetric.DISK_SIZE_GB_HOURS_IO2
  )

  return (
    <div id={attribute.anchor} className="scroll-my-12">
      <SectionContent section={attribute}>
        {isLoading && (
          <div className="space-y-2">
            <ShimmeringLoader />
            <ShimmeringLoader className="w-3/4" />
            <ShimmeringLoader className="w-1/2" />
          </div>
        )}
        {isError && <AlertError subject="Failed to retrieve usage data" error={error} />}
        {isSuccess && !isLoading && (
          <div className="space-y-4">
            {currentBillingCycleSelected &&
              subscription?.usage_billing_enabled === false &&
              hasProjectsExceedingDiskSize && (
                <Alert variant="warning">
                  <CriticalIcon />
                  <AlertTitle>Projects exceeding quota</AlertTitle>
                  <AlertDescription>
                    You have projects that are exceeding 8 GB of provisioned disk size, but do not
                    allow any overages with the Spend Cap on. Reduce the disk size or disable the
                    spend cap.
                  </AlertDescription>
                </Alert>
              )}
            {currentBillingCycleSelected &&
              subscription?.usage_billing_enabled === false &&
              !hasProjectsExceedingDiskSize &&
              hasReplicas && (
                <Alert variant="warning">
                  <CriticalIcon />
                  <AlertTitle>
                    Read replicas add disk usage beyond your plan's included quota
                  </AlertTitle>
                  <AlertDescription>
                    You have read replicas in your projects, but do not allow any overages with the
                    Spend Cap on. Remove the read replicas or disable the spend cap.
                  </AlertDescription>
                </Alert>
              )}

            <div>
              <div className="flex items-center justify-between">
                <div className="flex items-center space-x-4">
                  <p className="text-sm">{attribute.name} usage</p>
                </div>
              </div>

              <div className="flex items-center justify-between border-b py-1">
                <p className="text-xs text-foreground-light">
                  Included in {subscription?.plan?.name} Plan
                </p>
                <p className="text-xs">8 GB GP3 disk per project</p>
              </div>

              <div className="flex items-center justify-between py-1">
                <p className="text-xs text-foreground-light">Overage in period</p>
                <p className="text-xs">
                  {(gp3UsageInPeriod?.usage ?? 0).toLocaleString()} GP3 GB-Hrs
                  {io2UsageInPeriod?.usage
                    ? ` / ${io2UsageInPeriod.usage.toLocaleString()} IO2 GB-Hrs`
                    : ``}
                </p>
              </div>
            </div>

            {currentBillingCycleSelected ? (
              <div className="space-y-4">
                <div className="space-y-1">
                  <p className="text-sm">Current disk size per project</p>
                  <p className="text-sm text-foreground-light">
                    Breakdown of disk per project. Head to your project's disk management section to
                    see database size used.
                  </p>
                </div>

                {relevantProjects.length === 0 && (
                  <Panel>
                    <Panel.Content>
                      <div className="flex flex-col items-center justify-center">
                        <p className="text-sm">No active projects</p>
                        <p className="text-sm text-foreground-light">
                          You don't have any active projects in this organization.
                        </p>
                      </div>
                    </Panel.Content>
                  </Panel>
                )}

                <div className="flex flex-col gap-y-2">
                  {relevantProjects.map((project, idx) => {
                    const primaryDiskUsage = project.databases
                      .filter((it) => it.type === 'PRIMARY')
                      .reduce((acc, curr) => acc + (curr.disk_volume_size_gb ?? 8), 0)
                    const replicaDbs = project.databases.filter((it) => it.type !== 'PRIMARY')
                    const replicaDiskUsage = replicaDbs.reduce(
                      (acc, curr) => acc + (curr.disk_volume_size_gb ?? 8),
                      0
                    )

                    const totalDiskUsage = primaryDiskUsage + replicaDiskUsage

                    return (
                      <div
                        key={`usage-project-${project.ref}`}
                        className={cn(
                          'flex items-center justify-between',
                          idx !== relevantProjects.length - 1 && 'border-b pb-2'
                        )}
                      >
                        <div>
                          <p className="text-foreground-light text-sm flex items-center gap-2">
                            {project.name}
                          </p>
                          <div className="flex items-center gap-x-2">
                            <span className="text-foreground-lighter text-sm flex items-center gap-2">
                              {totalDiskUsage} GB Disk provisioned
                            </span>
                            <InfoTooltip side="right">
                              <p>{primaryDiskUsage} GB for Primary Database</p>
                              {replicaDbs.length > 0 && (
                                <>
                                  <p>
                                    {replicaDiskUsage} GB for {replicaDbs.length} Read{' '}
                                    {replicaDbs.length === 1 ? 'Replica' : 'Replicas'}
                                  </p>
                                  <p className="mt-1">
                                    Read replicas have their own disk and use 25% more disk to
                                    account for WAL files.
                                  </p>
                                </>
                              )}
                            </InfoTooltip>
                          </div>
                        </div>

                        <Button asChild size="tiny">
                          <Link href={getInfrastructurePath(project.ref)}>Manage Disk</Link>
                        </Button>
                      </div>
                    )
                  })}
                </div>
              </div>
            ) : (
              <Panel>
                <Panel.Content>
                  <div className="flex flex-col items-center justify-center">
                    <p className="text-sm">Data not available</p>
                    <p className="text-sm text-foreground-light">
                      Switch to current billing cycle to see current disk size per project.
                    </p>
                  </div>
                </Panel.Content>
              </Panel>
            )}
          </div>
        )}
      </SectionContent>
    </div>
  )
}